Google Git
Sign in
coral / linux-mtk / 719f82d3987aad4cc9f46d19c35f362672545cad / . / sound / pci / asihpi / hpi_internal.h
blob: f1cd6f1a0d44230fff3239e97b18bc575374beb4 [file] [log] [blame]
/******************************************************************************
AudioScience HPI driver
Copyright (C) 1997-2010 AudioScience Inc. <support@audioscience.com>
This program is free software; you can redistribute it and/or modify
it under the terms of version 2 of the GNU General Public License as
published by the Free Software Foundation;
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
HPI internal definitions
(C) Copyright AudioScience Inc. 1996-2009
******************************************************************************/
#ifndef _HPI_INTERNAL_H_
#define _HPI_INTERNAL_H_
#include "hpi.h"
/** maximum number of memory regions mapped to an adapter */
#define HPI_MAX_ADAPTER_MEM_SPACES (2)
/* Each OS needs its own hpios.h, or specific define as above */
#include "hpios.h"
/* physical memory allocation */
void hpios_locked_mem_init(void
);
void hpios_locked_mem_free_all(void
);
#define hpios_locked_mem_prepare(a, b, c, d);
#define hpios_locked_mem_unprepare(a)
/** Allocate and map an area of locked memory for bus master DMA operations.
On success, *pLockedMemeHandle is a valid handle, and 0 is returned
On error *pLockedMemHandle marked invalid, non-zero returned.
If this function succeeds, then HpiOs_LockedMem_GetVirtAddr() and
HpiOs_LockedMem_GetPyhsAddr() will always succed on the returned handle.
*/
u16 hpios_locked_mem_alloc(struct consistent_dma_area *p_locked_mem_handle,
/**< memory handle */
u32 size, /**< size in bytes to allocate */
struct pci_dev *p_os_reference
/**< OS specific data required for memory allocation */
);
/** Free mapping and memory represented by LockedMemHandle
Frees any resources, then invalidates the handle.
Returns 0 on success, 1 if handle is invalid.
*/
u16 hpios_locked_mem_free(struct consistent_dma_area *locked_mem_handle);
/** Get the physical PCI address of memory represented by LockedMemHandle.
If handle is invalid *pPhysicalAddr is set to zero and return 1
*/
u16 hpios_locked_mem_get_phys_addr(struct consistent_dma_area
*locked_mem_handle, u32 *p_physical_addr);
/** Get the CPU address of of memory represented by LockedMemHandle.
If handle is NULL *ppvVirtualAddr is set to NULL and return 1
*/
u16 hpios_locked_mem_get_virt_addr(struct consistent_dma_area
*locked_mem_handle, void **ppv_virtual_addr);
/** Check that handle is valid
i.e it represents a valid memory area
*/
u16 hpios_locked_mem_valid(struct consistent_dma_area *locked_mem_handle);
/* timing/delay */
void hpios_delay_micro_seconds(u32 num_micro_sec);
struct hpi_message;
struct hpi_response;
typedef void hpi_handler_func(struct hpi_message *, struct hpi_response *);
/* If the assert fails, compiler complains
something like size of array `msg' is negative.
Unlike linux BUILD_BUG_ON, this works outside function scope.
*/
#define compile_time_assert(cond, msg) \
typedef char ASSERT_##msg[(cond) ? 1 : -1]
/*/////////////////////////////////////////////////////////////////////////// */
/* Private HPI Entity related definitions */
#define STR_SIZE_FIELD_MAX 65535U
#define STR_TYPE_FIELD_MAX 255U
#define STR_ROLE_FIELD_MAX 255U
struct hpi_entity_str {
uint16_t size;
uint8_t type;
uint8_t role;
};
#if defined(_MSC_VER)
#pragma warning(push)
#pragma warning(disable : 4200)
#endif
struct hpi_entity {
struct hpi_entity_str header;
#if ! defined(HPI_OS_DSP_C6000) || (defined(HPI_OS_DSP_C6000) && (__TI_COMPILER_VERSION__ > 6000008))
/* DSP C6000 compiler v6.0.8 and lower
do not support flexible array member */
uint8_t value[];
#else
/* NOTE! Using sizeof(struct hpi_entity) will give erroneous results */
#define HPI_INTERNAL_WARN_ABOUT_ENTITY_VALUE
uint8_t value[1];
#endif
};
#if defined(_MSC_VER)
#pragma warning(pop)
#endif
/******************************************* bus types */
enum HPI_BUSES {
HPI_BUS_ISAPNP = 1,
HPI_BUS_PCI = 2,
HPI_BUS_USB = 3,
HPI_BUS_NET = 4
};
/******************************************* CONTROL ATTRIBUTES ****/
/* (in order of control type ID */
/* This allows for 255 control types, 256 unique attributes each */
#define HPI_CTL_ATTR(ctl, ai) (HPI_CONTROL_##ctl * 0x100 + ai)
/* Get the sub-index of the attribute for a control type */
#define HPI_CTL_ATTR_INDEX(i) (i&0xff)
/* Generic control attributes. */
/** Enable a control.
0=disable, 1=enable
\note generic to all mixer plugins?
*/
#define HPI_GENERIC_ENABLE HPI_CTL_ATTR(GENERIC, 1)
/** Enable event generation for a control.
0=disable, 1=enable
\note generic to all controls that can generate events
*/
#define HPI_GENERIC_EVENT_ENABLE HPI_CTL_ATTR(GENERIC, 2)
/* Volume Control attributes */
#define HPI_VOLUME_GAIN HPI_CTL_ATTR(VOLUME, 1)
#define HPI_VOLUME_AUTOFADE HPI_CTL_ATTR(VOLUME, 2)
/** For HPI_ControlQuery() to get the number of channels of a volume control*/
#define HPI_VOLUME_NUM_CHANNELS HPI_CTL_ATTR(VOLUME, 6)
#define HPI_VOLUME_RANGE HPI_CTL_ATTR(VOLUME, 10)
/** Level Control attributes */
#define HPI_LEVEL_GAIN HPI_CTL_ATTR(LEVEL, 1)
#define HPI_LEVEL_RANGE HPI_CTL_ATTR(LEVEL, 10)
/* Meter Control attributes */
/** return RMS signal level */
#define HPI_METER_RMS HPI_CTL_ATTR(METER, 1)
/** return peak signal level */
#define HPI_METER_PEAK HPI_CTL_ATTR(METER, 2)
/** ballistics for ALL rms meters on adapter */
#define HPI_METER_RMS_BALLISTICS HPI_CTL_ATTR(METER, 3)
/** ballistics for ALL peak meters on adapter */
#define HPI_METER_PEAK_BALLISTICS HPI_CTL_ATTR(METER, 4)
/** For HPI_ControlQuery() to get the number of channels of a meter control*/
#define HPI_METER_NUM_CHANNELS HPI_CTL_ATTR(METER, 5)
/* Multiplexer control attributes */
#define HPI_MULTIPLEXER_SOURCE HPI_CTL_ATTR(MULTIPLEXER, 1)
#define HPI_MULTIPLEXER_QUERYSOURCE HPI_CTL_ATTR(MULTIPLEXER, 2)
/** AES/EBU transmitter control attributes */
/** AESEBU or SPDIF */
#define HPI_AESEBUTX_FORMAT HPI_CTL_ATTR(AESEBUTX, 1)
#define HPI_AESEBUTX_SAMPLERATE HPI_CTL_ATTR(AESEBUTX, 3)
#define HPI_AESEBUTX_CHANNELSTATUS HPI_CTL_ATTR(AESEBUTX, 4)
#define HPI_AESEBUTX_USERDATA HPI_CTL_ATTR(AESEBUTX, 5)
/** AES/EBU receiver control attributes */
#define HPI_AESEBURX_FORMAT HPI_CTL_ATTR(AESEBURX, 1)
#define HPI_AESEBURX_ERRORSTATUS HPI_CTL_ATTR(AESEBURX, 2)
#define HPI_AESEBURX_SAMPLERATE HPI_CTL_ATTR(AESEBURX, 3)
#define HPI_AESEBURX_CHANNELSTATUS HPI_CTL_ATTR(AESEBURX, 4)
#define HPI_AESEBURX_USERDATA HPI_CTL_ATTR(AESEBURX, 5)
/** \defgroup tuner_defs Tuners
\{
*/
/** \defgroup tuner_attrs Tuner control attributes
\{
*/
#define HPI_TUNER_BAND HPI_CTL_ATTR(TUNER, 1)
#define HPI_TUNER_FREQ HPI_CTL_ATTR(TUNER, 2)
#define HPI_TUNER_LEVEL HPI_CTL_ATTR(TUNER, 3)
#define HPI_TUNER_AUDIOMUTE HPI_CTL_ATTR(TUNER, 4)
/* use TUNER_STATUS instead */
#define HPI_TUNER_VIDEO_STATUS HPI_CTL_ATTR(TUNER, 5)
#define HPI_TUNER_GAIN HPI_CTL_ATTR(TUNER, 6)
#define HPI_TUNER_STATUS HPI_CTL_ATTR(TUNER, 7)
#define HPI_TUNER_MODE HPI_CTL_ATTR(TUNER, 8)
/** RDS data. */
#define HPI_TUNER_RDS HPI_CTL_ATTR(TUNER, 9)
/** Audio pre-emphasis. */
#define HPI_TUNER_DEEMPHASIS HPI_CTL_ATTR(TUNER, 10)
/** HD Radio tuner program control. */
#define HPI_TUNER_PROGRAM HPI_CTL_ATTR(TUNER, 11)
/** HD Radio tuner digital signal quality. */
#define HPI_TUNER_HDRADIO_SIGNAL_QUALITY HPI_CTL_ATTR(TUNER, 12)
/** HD Radio SDK firmware version. */
#define HPI_TUNER_HDRADIO_SDK_VERSION HPI_CTL_ATTR(TUNER, 13)
/** HD Radio DSP firmware version. */
#define HPI_TUNER_HDRADIO_DSP_VERSION HPI_CTL_ATTR(TUNER, 14)
/** \} */
/** \defgroup pads_attrs Tuner PADs control attributes
\{
*/
/** The text string containing the station/channel combination. */
#define HPI_PAD_CHANNEL_NAME HPI_CTL_ATTR(PAD, 1)
/** The text string containing the artist. */
#define HPI_PAD_ARTIST HPI_CTL_ATTR(PAD, 2)
/** The text string containing the title. */
#define HPI_PAD_TITLE HPI_CTL_ATTR(PAD, 3)
/** The text string containing the comment. */
#define HPI_PAD_COMMENT HPI_CTL_ATTR(PAD, 4)
/** The integer containing the PTY code. */
#define HPI_PAD_PROGRAM_TYPE HPI_CTL_ATTR(PAD, 5)
/** The integer containing the program identification. */
#define HPI_PAD_PROGRAM_ID HPI_CTL_ATTR(PAD, 6)
/** The integer containing whether traffic information is supported.
Contains either 1 or 0. */
#define HPI_PAD_TA_SUPPORT HPI_CTL_ATTR(PAD, 7)
/** The integer containing whether traffic announcement is in progress.
Contains either 1 or 0. */
#define HPI_PAD_TA_ACTIVE HPI_CTL_ATTR(PAD, 8)
/** \} */
/** \} */
/* VOX control attributes */
#define HPI_VOX_THRESHOLD HPI_CTL_ATTR(VOX, 1)
/*?? channel mode used hpi_multiplexer_source attribute == 1 */
#define HPI_CHANNEL_MODE_MODE HPI_CTL_ATTR(CHANNEL_MODE, 1)
/** \defgroup channel_modes Channel Modes
Used for HPI_ChannelModeSet/Get()
\{
*/
/** Left channel out = left channel in, Right channel out = right channel in. */
#define HPI_CHANNEL_MODE_NORMAL 1
/** Left channel out = right channel in, Right channel out = left channel in. */
#define HPI_CHANNEL_MODE_SWAP 2
/** Left channel out = left channel in, Right channel out = left channel in. */
#define HPI_CHANNEL_MODE_LEFT_TO_STEREO 3
/** Left channel out = right channel in, Right channel out = right channel in.*/
#define HPI_CHANNEL_MODE_RIGHT_TO_STEREO 4
/** Left channel out = (left channel in + right channel in)/2,
Right channel out = mute. */
#define HPI_CHANNEL_MODE_STEREO_TO_LEFT 5
/** Left channel out = mute,
Right channel out = (right channel in + left channel in)/2. */
#define HPI_CHANNEL_MODE_STEREO_TO_RIGHT 6
#define HPI_CHANNEL_MODE_LAST 6
/** \} */
/* Bitstream control set attributes */
#define HPI_BITSTREAM_DATA_POLARITY HPI_CTL_ATTR(BITSTREAM, 1)
#define HPI_BITSTREAM_CLOCK_EDGE HPI_CTL_ATTR(BITSTREAM, 2)
#define HPI_BITSTREAM_CLOCK_SOURCE HPI_CTL_ATTR(BITSTREAM, 3)
#define HPI_POLARITY_POSITIVE 0
#define HPI_POLARITY_NEGATIVE 1
/* Bitstream control get attributes */
#define HPI_BITSTREAM_ACTIVITY 1
/* SampleClock control attributes */
#define HPI_SAMPLECLOCK_SOURCE HPI_CTL_ATTR(SAMPLECLOCK, 1)
#define HPI_SAMPLECLOCK_SAMPLERATE HPI_CTL_ATTR(SAMPLECLOCK, 2)
#define HPI_SAMPLECLOCK_SOURCE_INDEX HPI_CTL_ATTR(SAMPLECLOCK, 3)
#define HPI_SAMPLECLOCK_LOCAL_SAMPLERATE\
HPI_CTL_ATTR(SAMPLECLOCK, 4)
#define HPI_SAMPLECLOCK_AUTO HPI_CTL_ATTR(SAMPLECLOCK, 5)
#define HPI_SAMPLECLOCK_LOCAL_LOCK HPI_CTL_ATTR(SAMPLECLOCK, 6)
/* Microphone control attributes */
#define HPI_MICROPHONE_PHANTOM_POWER HPI_CTL_ATTR(MICROPHONE, 1)
/** Equalizer control attributes
*/
/** Used to get number of filters in an EQ. (Can't set) */
#define HPI_EQUALIZER_NUM_FILTERS HPI_CTL_ATTR(EQUALIZER, 1)
/** Set/get the filter by type, freq, Q, gain */
#define HPI_EQUALIZER_FILTER HPI_CTL_ATTR(EQUALIZER, 2)
/** Get the biquad coefficients */
#define HPI_EQUALIZER_COEFFICIENTS HPI_CTL_ATTR(EQUALIZER, 3)
#define HPI_COMPANDER_PARAMS HPI_CTL_ATTR(COMPANDER, 1)
/* Cobranet control attributes.
MUST be distinct from all other control attributes.
This is so that host side processing can easily identify a Cobranet control
and apply additional host side operations (like copying data) as required.
*/
#define HPI_COBRANET_SET HPI_CTL_ATTR(COBRANET, 1)
#define HPI_COBRANET_GET HPI_CTL_ATTR(COBRANET, 2)
#define HPI_COBRANET_SET_DATA HPI_CTL_ATTR(COBRANET, 3)
#define HPI_COBRANET_GET_DATA HPI_CTL_ATTR(COBRANET, 4)
#define HPI_COBRANET_GET_STATUS HPI_CTL_ATTR(COBRANET, 5)
#define HPI_COBRANET_SEND_PACKET HPI_CTL_ATTR(COBRANET, 6)
#define HPI_COBRANET_GET_PACKET HPI_CTL_ATTR(COBRANET, 7)
/*------------------------------------------------------------
Cobranet Chip Bridge - copied from HMI.H
------------------------------------------------------------*/
#define HPI_COBRANET_HMI_cobra_bridge 0x20000
#define HPI_COBRANET_HMI_cobra_bridge_tx_pkt_buf \
(HPI_COBRANET_HMI_cobra_bridge + 0x1000)
#define HPI_COBRANET_HMI_cobra_bridge_rx_pkt_buf \
(HPI_COBRANET_HMI_cobra_bridge + 0x2000)
#define HPI_COBRANET_HMI_cobra_if_table1 0x110000
#define HPI_COBRANET_HMI_cobra_if_phy_address \
(HPI_COBRANET_HMI_cobra_if_table1 + 0xd)
#define HPI_COBRANET_HMI_cobra_protocolIP 0x72000
#define HPI_COBRANET_HMI_cobra_ip_mon_currentIP \
(HPI_COBRANET_HMI_cobra_protocolIP + 0x0)
#define HPI_COBRANET_HMI_cobra_ip_mon_staticIP \
(HPI_COBRANET_HMI_cobra_protocolIP + 0x2)
#define HPI_COBRANET_HMI_cobra_sys 0x100000
#define HPI_COBRANET_HMI_cobra_sys_desc \
(HPI_COBRANET_HMI_cobra_sys + 0x0)
#define HPI_COBRANET_HMI_cobra_sys_objectID \
(HPI_COBRANET_HMI_cobra_sys + 0x100)
#define HPI_COBRANET_HMI_cobra_sys_contact \
(HPI_COBRANET_HMI_cobra_sys + 0x200)
#define HPI_COBRANET_HMI_cobra_sys_name \
(HPI_COBRANET_HMI_cobra_sys + 0x300)
#define HPI_COBRANET_HMI_cobra_sys_location \
(HPI_COBRANET_HMI_cobra_sys + 0x400)
/*------------------------------------------------------------
Cobranet Chip Status bits
------------------------------------------------------------*/
#define HPI_COBRANET_HMI_STATUS_RXPACKET 2
#define HPI_COBRANET_HMI_STATUS_TXPACKET 3
/*------------------------------------------------------------
Ethernet header size
------------------------------------------------------------*/
#define HPI_ETHERNET_HEADER_SIZE (16)
/* These defines are used to fill in protocol information for an Ethernet packet
sent using HMI on CS18102 */
/** ID supplied by Cirrius for ASI packets. */
#define HPI_ETHERNET_PACKET_ID 0x85
/** Simple packet - no special routing required */
#define HPI_ETHERNET_PACKET_V1 0x01
/** This packet must make its way to the host across the HPI interface */
#define HPI_ETHERNET_PACKET_HOSTED_VIA_HMI 0x20
/** This packet must make its way to the host across the HPI interface */
#define HPI_ETHERNET_PACKET_HOSTED_VIA_HMI_V1 0x21
/** This packet must make its way to the host across the HPI interface */
#define HPI_ETHERNET_PACKET_HOSTED_VIA_HPI 0x40
/** This packet must make its way to the host across the HPI interface */
#define HPI_ETHERNET_PACKET_HOSTED_VIA_HPI_V1 0x41
#define HPI_ETHERNET_UDP_PORT (44600) /*!< UDP messaging port */
/** Base network time out is set to 100 milli-seconds. */
#define HPI_ETHERNET_TIMEOUT_MS (100)
/** \defgroup tonedet_attr Tonedetector attributes
\{
Used by HPI_ToneDetector_Set() and HPI_ToneDetector_Get()
*/
/** Set the threshold level of a tonedetector,
Threshold is a -ve number in units of dB/100,
*/
#define HPI_TONEDETECTOR_THRESHOLD HPI_CTL_ATTR(TONEDETECTOR, 1)
/** Get the current state of tonedetection
The result is a bitmap of detected tones. pairs of bits represent the left
and right channels, with left channel in LSB.
The lowest frequency detector state is in the LSB
*/
#define HPI_TONEDETECTOR_STATE HPI_CTL_ATTR(TONEDETECTOR, 2)
/** Get the frequency of a tonedetector band.
*/
#define HPI_TONEDETECTOR_FREQUENCY HPI_CTL_ATTR(TONEDETECTOR, 3)
/**\}*/
/** \defgroup silencedet_attr SilenceDetector attributes
\{
*/
/** Get the current state of tonedetection
The result is a bitmap with 1s for silent channels. Left channel is in LSB
*/
#define HPI_SILENCEDETECTOR_STATE \
HPI_CTL_ATTR(SILENCEDETECTOR, 2)
/** Set the threshold level of a SilenceDetector,
Threshold is a -ve number in units of dB/100,
*/
#define HPI_SILENCEDETECTOR_THRESHOLD \
HPI_CTL_ATTR(SILENCEDETECTOR, 1)
/** get/set the silence time before the detector triggers
*/
#define HPI_SILENCEDETECTOR_DELAY \
HPI_CTL_ATTR(SILENCEDETECTOR, 3)
/**\}*/
/* Locked memory buffer alloc/free phases */
/** use one message to allocate or free physical memory */
#define HPI_BUFFER_CMD_EXTERNAL 0
/** alloc physical memory */
#define HPI_BUFFER_CMD_INTERNAL_ALLOC 1
/** send physical memory address to adapter */
#define HPI_BUFFER_CMD_INTERNAL_GRANTADAPTER 2
/** notify adapter to stop using physical buffer */
#define HPI_BUFFER_CMD_INTERNAL_REVOKEADAPTER 3
/** free physical buffer */
#define HPI_BUFFER_CMD_INTERNAL_FREE 4
/******************************************* CONTROLX ATTRIBUTES ****/
/* NOTE: All controlx attributes must be unique, unlike control attributes */
/*****************************************************************************/
/*****************************************************************************/
/******** HPI LOW LEVEL MESSAGES *******/
/*****************************************************************************/
/*****************************************************************************/
/** Pnp ids */
/** "ASI" - actual is "ASX" - need to change */
#define HPI_ID_ISAPNP_AUDIOSCIENCE 0x0669
/** PCI vendor ID that AudioScience uses */
#define HPI_PCI_VENDOR_ID_AUDIOSCIENCE 0x175C
/** PCI vendor ID that the DSP56301 has */
#define HPI_PCI_VENDOR_ID_MOTOROLA 0x1057
/** PCI vendor ID that TI uses */
#define HPI_PCI_VENDOR_ID_TI 0x104C
#define HPI_PCI_DEV_ID_PCI2040 0xAC60
/** TI's C6205 PCI interface has this ID */
#define HPI_PCI_DEV_ID_DSP6205 0xA106
#define HPI_USB_VENDOR_ID_AUDIOSCIENCE 0x1257
#define HPI_USB_W2K_TAG 0x57495341 /* "ASIW" */
#define HPI_USB_LINUX_TAG 0x4C495341 /* "ASIL" */
/** First 2 hex digits define the adapter family */
#define HPI_ADAPTER_FAMILY_MASK 0xff00
#define HPI_ADAPTER_FAMILY_ASI(f) (f & HPI_ADAPTER_FAMILY_MASK)
#define HPI_ADAPTER_ASI(f) (f)
/******************************************* message types */
#define HPI_TYPE_MESSAGE 1
#define HPI_TYPE_RESPONSE 2
#define HPI_TYPE_DATA 3
#define HPI_TYPE_SSX2BYPASS_MESSAGE 4
/******************************************* object types */
#define HPI_OBJ_SUBSYSTEM 1
#define HPI_OBJ_ADAPTER 2
#define HPI_OBJ_OSTREAM 3
#define HPI_OBJ_ISTREAM 4
#define HPI_OBJ_MIXER 5
#define HPI_OBJ_NODE 6
#define HPI_OBJ_CONTROL 7
#define HPI_OBJ_NVMEMORY 8
#define HPI_OBJ_GPIO 9
#define HPI_OBJ_WATCHDOG 10
#define HPI_OBJ_CLOCK 11
#define HPI_OBJ_PROFILE 12
#define HPI_OBJ_CONTROLEX 13
#define HPI_OBJ_ASYNCEVENT 14
#define HPI_OBJ_MAXINDEX 14
/******************************************* methods/functions */
#define HPI_OBJ_FUNCTION_SPACING 0x100
#define HPI_MAKE_INDEX(obj, index) (obj * HPI_OBJ_FUNCTION_SPACING + index)
#define HPI_EXTRACT_INDEX(fn) (fn & 0xff)
/* SUB-SYSTEM */
#define HPI_SUBSYS_OPEN HPI_MAKE_INDEX(HPI_OBJ_SUBSYSTEM, 1)
#define HPI_SUBSYS_GET_VERSION HPI_MAKE_INDEX(HPI_OBJ_SUBSYSTEM, 2)
#define HPI_SUBSYS_GET_INFO HPI_MAKE_INDEX(HPI_OBJ_SUBSYSTEM, 3)
#define HPI_SUBSYS_FIND_ADAPTERS HPI_MAKE_INDEX(HPI_OBJ_SUBSYSTEM, 4)
#define HPI_SUBSYS_CREATE_ADAPTER HPI_MAKE_INDEX(HPI_OBJ_SUBSYSTEM, 5)
#define HPI_SUBSYS_CLOSE HPI_MAKE_INDEX(HPI_OBJ_SUBSYSTEM, 6)
#define HPI_SUBSYS_DELETE_ADAPTER HPI_MAKE_INDEX(HPI_OBJ_SUBSYSTEM, 7)
#define HPI_SUBSYS_DRIVER_LOAD HPI_MAKE_INDEX(HPI_OBJ_SUBSYSTEM, 8)
#define HPI_SUBSYS_DRIVER_UNLOAD HPI_MAKE_INDEX(HPI_OBJ_SUBSYSTEM, 9)
#define HPI_SUBSYS_READ_PORT_8 HPI_MAKE_INDEX(HPI_OBJ_SUBSYSTEM, 10)
#define HPI_SUBSYS_WRITE_PORT_8 HPI_MAKE_INDEX(HPI_OBJ_SUBSYSTEM, 11)
#define HPI_SUBSYS_GET_NUM_ADAPTERS HPI_MAKE_INDEX(HPI_OBJ_SUBSYSTEM, 12)
#define HPI_SUBSYS_GET_ADAPTER HPI_MAKE_INDEX(HPI_OBJ_SUBSYSTEM, 13)
#define HPI_SUBSYS_SET_NETWORK_INTERFACE HPI_MAKE_INDEX(HPI_OBJ_SUBSYSTEM, 14)
#define HPI_SUBSYS_FUNCTION_COUNT 14
/* ADAPTER */
#define HPI_ADAPTER_OPEN HPI_MAKE_INDEX(HPI_OBJ_ADAPTER, 1)
#define HPI_ADAPTER_CLOSE HPI_MAKE_INDEX(HPI_OBJ_ADAPTER, 2)
#define HPI_ADAPTER_GET_INFO HPI_MAKE_INDEX(HPI_OBJ_ADAPTER, 3)
#define HPI_ADAPTER_GET_ASSERT HPI_MAKE_INDEX(HPI_OBJ_ADAPTER, 4)
#define HPI_ADAPTER_TEST_ASSERT HPI_MAKE_INDEX(HPI_OBJ_ADAPTER, 5)
#define HPI_ADAPTER_SET_MODE HPI_MAKE_INDEX(HPI_OBJ_ADAPTER, 6)
#define HPI_ADAPTER_GET_MODE HPI_MAKE_INDEX(HPI_OBJ_ADAPTER, 7)
#define HPI_ADAPTER_ENABLE_CAPABILITY HPI_MAKE_INDEX(HPI_OBJ_ADAPTER, 8)
#define HPI_ADAPTER_SELFTEST HPI_MAKE_INDEX(HPI_OBJ_ADAPTER, 9)
#define HPI_ADAPTER_FIND_OBJECT HPI_MAKE_INDEX(HPI_OBJ_ADAPTER, 10)
#define HPI_ADAPTER_QUERY_FLASH HPI_MAKE_INDEX(HPI_OBJ_ADAPTER, 11)
#define HPI_ADAPTER_START_FLASH HPI_MAKE_INDEX(HPI_OBJ_ADAPTER, 12)
#define HPI_ADAPTER_PROGRAM_FLASH HPI_MAKE_INDEX(HPI_OBJ_ADAPTER, 13)
#define HPI_ADAPTER_SET_PROPERTY HPI_MAKE_INDEX(HPI_OBJ_ADAPTER, 14)
#define HPI_ADAPTER_GET_PROPERTY HPI_MAKE_INDEX(HPI_OBJ_ADAPTER, 15)
#define HPI_ADAPTER_ENUM_PROPERTY HPI_MAKE_INDEX(HPI_OBJ_ADAPTER, 16)
#define HPI_ADAPTER_MODULE_INFO HPI_MAKE_INDEX(HPI_OBJ_ADAPTER, 17)
#define HPI_ADAPTER_DEBUG_READ HPI_MAKE_INDEX(HPI_OBJ_ADAPTER, 18)
#define HPI_ADAPTER_FUNCTION_COUNT 18
/* OUTPUT STREAM */
#define HPI_OSTREAM_OPEN HPI_MAKE_INDEX(HPI_OBJ_OSTREAM, 1)
#define HPI_OSTREAM_CLOSE HPI_MAKE_INDEX(HPI_OBJ_OSTREAM, 2)
#define HPI_OSTREAM_WRITE HPI_MAKE_INDEX(HPI_OBJ_OSTREAM, 3)
#define HPI_OSTREAM_START HPI_MAKE_INDEX(HPI_OBJ_OSTREAM, 4)
#define HPI_OSTREAM_STOP HPI_MAKE_INDEX(HPI_OBJ_OSTREAM, 5)
#define HPI_OSTREAM_RESET HPI_MAKE_INDEX(HPI_OBJ_OSTREAM, 6)
#define HPI_OSTREAM_GET_INFO HPI_MAKE_INDEX(HPI_OBJ_OSTREAM, 7)
#define HPI_OSTREAM_QUERY_FORMAT HPI_MAKE_INDEX(HPI_OBJ_OSTREAM, 8)
#define HPI_OSTREAM_DATA HPI_MAKE_INDEX(HPI_OBJ_OSTREAM, 9)
#define HPI_OSTREAM_SET_VELOCITY HPI_MAKE_INDEX(HPI_OBJ_OSTREAM, 10)
#define HPI_OSTREAM_SET_PUNCHINOUT HPI_MAKE_INDEX(HPI_OBJ_OSTREAM, 11)
#define HPI_OSTREAM_SINEGEN HPI_MAKE_INDEX(HPI_OBJ_OSTREAM, 12)
#define HPI_OSTREAM_ANC_RESET HPI_MAKE_INDEX(HPI_OBJ_OSTREAM, 13)
#define HPI_OSTREAM_ANC_GET_INFO HPI_MAKE_INDEX(HPI_OBJ_OSTREAM, 14)
#define HPI_OSTREAM_ANC_READ HPI_MAKE_INDEX(HPI_OBJ_OSTREAM, 15)
#define HPI_OSTREAM_SET_TIMESCALE HPI_MAKE_INDEX(HPI_OBJ_OSTREAM, 16)
#define HPI_OSTREAM_SET_FORMAT HPI_MAKE_INDEX(HPI_OBJ_OSTREAM, 17)
#define HPI_OSTREAM_HOSTBUFFER_ALLOC HPI_MAKE_INDEX(HPI_OBJ_OSTREAM, 18)
#define HPI_OSTREAM_HOSTBUFFER_FREE HPI_MAKE_INDEX(HPI_OBJ_OSTREAM, 19)
#define HPI_OSTREAM_GROUP_ADD HPI_MAKE_INDEX(HPI_OBJ_OSTREAM, 20)
#define HPI_OSTREAM_GROUP_GETMAP HPI_MAKE_INDEX(HPI_OBJ_OSTREAM, 21)
#define HPI_OSTREAM_GROUP_RESET HPI_MAKE_INDEX(HPI_OBJ_OSTREAM, 22)
#define HPI_OSTREAM_HOSTBUFFER_GET_INFO HPI_MAKE_INDEX(HPI_OBJ_OSTREAM, 23)
#define HPI_OSTREAM_WAIT_START HPI_MAKE_INDEX(HPI_OBJ_OSTREAM, 24)
#define HPI_OSTREAM_FUNCTION_COUNT 24
/* INPUT STREAM */
#define HPI_ISTREAM_OPEN HPI_MAKE_INDEX(HPI_OBJ_ISTREAM, 1)
#define HPI_ISTREAM_CLOSE HPI_MAKE_INDEX(HPI_OBJ_ISTREAM, 2)
#define HPI_ISTREAM_SET_FORMAT HPI_MAKE_INDEX(HPI_OBJ_ISTREAM, 3)
#define HPI_ISTREAM_READ HPI_MAKE_INDEX(HPI_OBJ_ISTREAM, 4)
#define HPI_ISTREAM_START HPI_MAKE_INDEX(HPI_OBJ_ISTREAM, 5)
#define HPI_ISTREAM_STOP HPI_MAKE_INDEX(HPI_OBJ_ISTREAM, 6)
#define HPI_ISTREAM_RESET HPI_MAKE_INDEX(HPI_OBJ_ISTREAM, 7)
#define HPI_ISTREAM_GET_INFO HPI_MAKE_INDEX(HPI_OBJ_ISTREAM, 8)
#define HPI_ISTREAM_QUERY_FORMAT HPI_MAKE_INDEX(HPI_OBJ_ISTREAM, 9)
#define HPI_ISTREAM_ANC_RESET HPI_MAKE_INDEX(HPI_OBJ_ISTREAM, 10)
#define HPI_ISTREAM_ANC_GET_INFO HPI_MAKE_INDEX(HPI_OBJ_ISTREAM, 11)
#define HPI_ISTREAM_ANC_WRITE HPI_MAKE_INDEX(HPI_OBJ_ISTREAM, 12)
#define HPI_ISTREAM_HOSTBUFFER_ALLOC HPI_MAKE_INDEX(HPI_OBJ_ISTREAM, 13)
#define HPI_ISTREAM_HOSTBUFFER_FREE HPI_MAKE_INDEX(HPI_OBJ_ISTREAM, 14)
#define HPI_ISTREAM_GROUP_ADD HPI_MAKE_INDEX(HPI_OBJ_ISTREAM, 15)
#define HPI_ISTREAM_GROUP_GETMAP HPI_MAKE_INDEX(HPI_OBJ_ISTREAM, 16)
#define HPI_ISTREAM_GROUP_RESET HPI_MAKE_INDEX(HPI_OBJ_ISTREAM, 17)
#define HPI_ISTREAM_HOSTBUFFER_GET_INFO HPI_MAKE_INDEX(HPI_OBJ_ISTREAM, 18)
#define HPI_ISTREAM_WAIT_START HPI_MAKE_INDEX(HPI_OBJ_ISTREAM, 19)
#define HPI_ISTREAM_FUNCTION_COUNT 19
/* MIXER */
/* NOTE:
GET_NODE_INFO, SET_CONNECTION, GET_CONNECTIONS are not currently used */
#define HPI_MIXER_OPEN HPI_MAKE_INDEX(HPI_OBJ_MIXER, 1)
#define HPI_MIXER_CLOSE HPI_MAKE_INDEX(HPI_OBJ_MIXER, 2)
#define HPI_MIXER_GET_INFO HPI_MAKE_INDEX(HPI_OBJ_MIXER, 3)
#define HPI_MIXER_GET_NODE_INFO HPI_MAKE_INDEX(HPI_OBJ_MIXER, 4)
#define HPI_MIXER_GET_CONTROL HPI_MAKE_INDEX(HPI_OBJ_MIXER, 5)
#define HPI_MIXER_SET_CONNECTION HPI_MAKE_INDEX(HPI_OBJ_MIXER, 6)
#define HPI_MIXER_GET_CONNECTIONS HPI_MAKE_INDEX(HPI_OBJ_MIXER, 7)
#define HPI_MIXER_GET_CONTROL_BY_INDEX HPI_MAKE_INDEX(HPI_OBJ_MIXER, 8)
#define HPI_MIXER_GET_CONTROL_ARRAY_BY_INDEX HPI_MAKE_INDEX(HPI_OBJ_MIXER, 9)
#define HPI_MIXER_GET_CONTROL_MULTIPLE_VALUES HPI_MAKE_INDEX(HPI_OBJ_MIXER, 10)
#define HPI_MIXER_STORE HPI_MAKE_INDEX(HPI_OBJ_MIXER, 11)
#define HPI_MIXER_FUNCTION_COUNT 11
/* MIXER CONTROLS */
#define HPI_CONTROL_GET_INFO HPI_MAKE_INDEX(HPI_OBJ_CONTROL, 1)
#define HPI_CONTROL_GET_STATE HPI_MAKE_INDEX(HPI_OBJ_CONTROL, 2)
#define HPI_CONTROL_SET_STATE HPI_MAKE_INDEX(HPI_OBJ_CONTROL, 3)
#define HPI_CONTROL_FUNCTION_COUNT 3
/* NONVOL MEMORY */
#define HPI_NVMEMORY_OPEN HPI_MAKE_INDEX(HPI_OBJ_NVMEMORY, 1)
#define HPI_NVMEMORY_READ_BYTE HPI_MAKE_INDEX(HPI_OBJ_NVMEMORY, 2)
#define HPI_NVMEMORY_WRITE_BYTE HPI_MAKE_INDEX(HPI_OBJ_NVMEMORY, 3)
#define HPI_NVMEMORY_FUNCTION_COUNT 3
/* GPIO */
#define HPI_GPIO_OPEN HPI_MAKE_INDEX(HPI_OBJ_GPIO, 1)
#define HPI_GPIO_READ_BIT HPI_MAKE_INDEX(HPI_OBJ_GPIO, 2)
#define HPI_GPIO_WRITE_BIT HPI_MAKE_INDEX(HPI_OBJ_GPIO, 3)
#define HPI_GPIO_READ_ALL HPI_MAKE_INDEX(HPI_OBJ_GPIO, 4)
#define HPI_GPIO_WRITE_STATUS HPI_MAKE_INDEX(HPI_OBJ_GPIO, 5)
#define HPI_GPIO_FUNCTION_COUNT 5
/* ASYNC EVENT */
#define HPI_ASYNCEVENT_OPEN HPI_MAKE_INDEX(HPI_OBJ_ASYNCEVENT, 1)
#define HPI_ASYNCEVENT_CLOSE HPI_MAKE_INDEX(HPI_OBJ_ASYNCEVENT, 2)
#define HPI_ASYNCEVENT_WAIT HPI_MAKE_INDEX(HPI_OBJ_ASYNCEVENT, 3)
#define HPI_ASYNCEVENT_GETCOUNT HPI_MAKE_INDEX(HPI_OBJ_ASYNCEVENT, 4)
#define HPI_ASYNCEVENT_GET HPI_MAKE_INDEX(HPI_OBJ_ASYNCEVENT, 5)
#define HPI_ASYNCEVENT_SENDEVENTS HPI_MAKE_INDEX(HPI_OBJ_ASYNCEVENT, 6)
#define HPI_ASYNCEVENT_FUNCTION_COUNT 6
/* WATCH-DOG */
#define HPI_WATCHDOG_OPEN HPI_MAKE_INDEX(HPI_OBJ_WATCHDOG, 1)
#define HPI_WATCHDOG_SET_TIME HPI_MAKE_INDEX(HPI_OBJ_WATCHDOG, 2)
#define HPI_WATCHDOG_PING HPI_MAKE_INDEX(HPI_OBJ_WATCHDOG, 3)
/* CLOCK */
#define HPI_CLOCK_OPEN HPI_MAKE_INDEX(HPI_OBJ_CLOCK, 1)
#define HPI_CLOCK_SET_TIME HPI_MAKE_INDEX(HPI_OBJ_CLOCK, 2)
#define HPI_CLOCK_GET_TIME HPI_MAKE_INDEX(HPI_OBJ_CLOCK, 3)
/* PROFILE */
#define HPI_PROFILE_OPEN_ALL HPI_MAKE_INDEX(HPI_OBJ_PROFILE, 1)
#define HPI_PROFILE_START_ALL HPI_MAKE_INDEX(HPI_OBJ_PROFILE, 2)
#define HPI_PROFILE_STOP_ALL HPI_MAKE_INDEX(HPI_OBJ_PROFILE, 3)
#define HPI_PROFILE_GET HPI_MAKE_INDEX(HPI_OBJ_PROFILE, 4)
#define HPI_PROFILE_GET_IDLECOUNT HPI_MAKE_INDEX(HPI_OBJ_PROFILE, 5)
#define HPI_PROFILE_GET_NAME HPI_MAKE_INDEX(HPI_OBJ_PROFILE, 6)
#define HPI_PROFILE_GET_UTILIZATION HPI_MAKE_INDEX(HPI_OBJ_PROFILE, 7)
#define HPI_PROFILE_FUNCTION_COUNT 7
/* ////////////////////////////////////////////////////////////////////// */
/* PRIVATE ATTRIBUTES */
/* ////////////////////////////////////////////////////////////////////// */
/* STRUCTURES */
#ifndef DISABLE_PRAGMA_PACK1
#pragma pack(push, 1)
#endif
/** PCI bus resource */
struct hpi_pci {
u32 __iomem *ap_mem_base[HPI_MAX_ADAPTER_MEM_SPACES];
struct pci_dev *p_os_data;
#ifndef HPI64BIT /* keep structure size constant */
u32 padding[HPI_MAX_ADAPTER_MEM_SPACES + 1];
#endif
u16 vendor_id;
u16 device_id;
u16 subsys_vendor_id;
u16 subsys_device_id;
u16 bus_number;
u16 device_number;
u32 interrupt;
};
struct hpi_resource {
union {
const struct hpi_pci *pci;
const char *net_if;
} r;
#ifndef HPI64BIT /* keep structure size constant */
u32 pad_to64;
#endif
u16 bus_type; /* HPI_BUS_PNPISA, _PCI, _USB etc */
u16 padding;
};
/** Format info used inside struct hpi_message
Not the same as public API struct hpi_format */
struct hpi_msg_format {
u32 sample_rate;
/**< 11025, 32000, 44100 ... */
u32 bit_rate; /**< for MPEG */
u32 attributes;
/**< Stereo/JointStereo/Mono */
u16 channels; /**< 1,2..., (or ancillary mode or idle bit */
u16 format; /**< HPI_FORMAT_PCM16, _MPEG etc. see \ref HPI_FORMATS. */
};
/** Buffer+format structure.
Must be kept 7 * 32 bits to match public struct hpi_datastruct */
struct hpi_msg_data {
struct hpi_msg_format format;
u8 *pb_data;
#ifndef HPI64BIT
u32 padding;
#endif
u32 data_size;
};
/** struct hpi_datastructure used up to 3.04 driver */
struct hpi_data_legacy32 {
struct hpi_format format;
u32 pb_data;
u32 data_size;
};
#ifdef HPI64BIT
/* Compatibility version of struct hpi_data*/
struct hpi_data_compat32 {
struct hpi_msg_format format;
u32 pb_data;
u32 padding;
u32 data_size;
};
#endif
struct hpi_buffer {
/** placehoder for backward compatability (see dwBufferSize) */
struct hpi_msg_format reserved;
u32 command; /**< HPI_BUFFER_CMD_xxx*/
u32 pci_address; /**< PCI physical address of buffer for DSP DMA */
u32 buffer_size; /**< must line up with data_size of HPI_DATA*/
};
/*/////////////////////////////////////////////////////////////////////////// */
/* This is used for background buffer bus mastering stream buffers. */
struct hpi_hostbuffer_status {
u32 samples_processed;
u32 auxiliary_data_available;
u32 stream_state;
/* DSP index in to the host bus master buffer. */
u32 dSP_index;
/* Host index in to the host bus master buffer. */
u32 host_index;
u32 size_in_bytes;
};
struct hpi_streamid {
u16 object_type;
/**< Type of object, HPI_OBJ_OSTREAM or HPI_OBJ_ISTREAM. */
u16 stream_index; /**< outstream or instream index. */
};
struct hpi_punchinout {
u32 punch_in_sample;
u32 punch_out_sample;
};
struct hpi_subsys_msg {
struct hpi_resource resource;
};
struct hpi_subsys_res {
u32 version;
u32 data; /* used to return extended version */
u16 num_adapters; /* number of adapters */
u16 adapter_index;
u16 aw_adapter_list[HPI_MAX_ADAPTERS];
};
struct hpi_adapter_msg {
u32 adapter_mode; /* adapter mode */
u16 assert_id; /* assert number for "test assert" call
object_index for find object call
query_or_set for hpi_adapter_set_mode_ex() */
u16 object_type; /* for adapter find object call */
};
union hpi_adapterx_msg {
struct hpi_adapter_msg adapter;
struct {
u32 offset;
} query_flash;
struct {
u32 offset;
u32 length;
u32 key;
} start_flash;
struct {
u32 checksum;
u16 sequence;
u16 length;
u16 offset; /**< offset from start of msg to data */
u16 unused;
} program_flash;
struct {
u16 property;
u16 parameter1;
u16 parameter2;
} property_set;
struct {
u16 index;
u16 what;
u16 property_index;
} property_enum;
struct {
u16 index;
} module_info;
struct {
u32 dsp_address;
u32 count_bytes;
} debug_read;
};
struct hpi_adapter_res {
u32 serial_number;
u16 adapter_type;
u16 adapter_index; /* is this needed? also used for dsp_index */
u16 num_instreams;
u16 num_outstreams;
u16 num_mixers;
u16 version;
u8 sz_adapter_assert[HPI_STRING_LEN];
};
union hpi_adapterx_res {
struct hpi_adapter_res adapter;
struct {
u32 checksum;
u32 length;
u32 version;
} query_flash;
struct {
u16 sequence;
} program_flash;
struct {
u16 parameter1;
u16 parameter2;
} property_get;
};
struct hpi_stream_msg {
union {
struct hpi_msg_data data;
struct hpi_data_legacy32 data32;
u16 velocity;
struct hpi_punchinout pio;
u32 time_scale;
struct hpi_buffer buffer;
struct hpi_streamid stream;
} u;
};
struct hpi_stream_res {
union {
struct {
/* size of hardware buffer */
u32 buffer_size;
/* OutStream - data to play,
InStream - data recorded */
u32 data_available;
/* OutStream - samples played,
InStream - samples recorded */
u32 samples_transferred;
/* Adapter - OutStream - data to play,
InStream - data recorded */
u32 auxiliary_data_available;
u16 state; /* HPI_STATE_PLAYING, _STATE_STOPPED */
u16 padding;
} stream_info;
struct {
u32 buffer_size;
u32 data_available;
u32 samples_transfered;
u16 state;
u16 outstream_index;
u16 instream_index;
u16 padding;
u32 auxiliary_data_available;
} legacy_stream_info;
struct {
/* bitmap of grouped OutStreams */
u32 outstream_group_map;
/* bitmap of grouped InStreams */
u32 instream_group_map;
} group_info;
struct {
/* pointer to the buffer */
u8 *p_buffer;
/* pointer to the hostbuffer status */
struct hpi_hostbuffer_status *p_status;
} hostbuffer_info;
} u;
};
struct hpi_mixer_msg {
u16 control_index;
u16 control_type; /* = HPI_CONTROL_METER _VOLUME etc */
u16 padding1; /* maintain alignment of subsequent fields */
u16 node_type1; /* = HPI_SOURCENODE_LINEIN etc */
u16 node_index1; /* = 0..N */
u16 node_type2;
u16 node_index2;
u16 padding2; /* round to 4 bytes */
};
struct hpi_mixer_res {
u16 src_node_type; /* = HPI_SOURCENODE_LINEIN etc */
u16 src_node_index; /* = 0..N */
u16 dst_node_type;
u16 dst_node_index;
/* Also controlType for MixerGetControlByIndex */
u16 control_index;
/* may indicate which DSP the control is located on */
u16 dsp_index;
};
union hpi_mixerx_msg {
struct {
u16 starting_index;
u16 flags;
u32 length_in_bytes; /* length in bytes of p_data */
u32 p_data; /* pointer to a data array */
} gcabi;
struct {
u16 command;
u16 index;
} store; /* for HPI_MIXER_STORE message */
};
union hpi_mixerx_res {
struct {
u32 bytes_returned; /* size of items returned */
u32 p_data; /* pointer to data array */
u16 more_to_do; /* indicates if there is more to do */
} gcabi;
};
struct hpi_control_msg {
u16 attribute; /* control attribute or property */
u16 saved_index;
u32 param1; /* generic parameter 1 */
u32 param2; /* generic parameter 2 */
short an_log_value[HPI_MAX_CHANNELS];
};
struct hpi_control_union_msg {
u16 attribute; /* control attribute or property */
u16 saved_index; /* only used in ctrl save/restore */
union {
struct {
u32 param1; /* generic parameter 1 */
u32 param2; /* generic parameter 2 */
short an_log_value[HPI_MAX_CHANNELS];
} old;
union {
u32 frequency;
u32 gain;
u32 band;
u32 deemphasis;
u32 program;
struct {
u32 mode;
u32 value;
} mode;
} tuner;
} u;
};
struct hpi_control_res {
/* Could make union. dwParam, anLogValue never used in same response */
u32 param1;
u32 param2;
short an_log_value[HPI_MAX_CHANNELS];
};
union hpi_control_union_res {
struct {
u32 param1;
u32 param2;
short an_log_value[HPI_MAX_CHANNELS];
} old;
union {
u32 band;
u32 frequency;
u32 gain;
u32 level;
u32 deemphasis;
struct {
u32 data[2];
u32 bLER;
} rds;
} tuner;
struct {
char sz_data[8];
u32 remaining_chars;
} chars8;
char c_data12[12];
};
/* HPI_CONTROLX_STRUCTURES */
/* Message */
/** Used for all HMI variables where max length <= 8 bytes
*/
struct hpi_controlx_msg_cobranet_data {
u32 hmi_address;
u32 byte_count;
u32 data[2];
};
/** Used for string data, and for packet bridge
*/
struct hpi_controlx_msg_cobranet_bigdata {
u32 hmi_address;
u32 byte_count;
u8 *pb_data;
#ifndef HPI64BIT
u32 padding;
#endif
};
/** Used for PADS control reading of string fields.
*/
struct hpi_controlx_msg_pad_data {
u32 field;
u32 byte_count;
u8 *pb_data;
#ifndef HPI64BIT
u32 padding;
#endif
};
/** Used for generic data
*/
struct hpi_controlx_msg_generic {
u32 param1;
u32 param2;
};
struct hpi_controlx_msg {
u16 attribute; /* control attribute or property */
u16 saved_index;
union {
struct hpi_controlx_msg_cobranet_data cobranet_data;
struct hpi_controlx_msg_cobranet_bigdata cobranet_bigdata;
struct hpi_controlx_msg_generic generic;
struct hpi_controlx_msg_pad_data pad_data;
/*struct param_value universal_value; */
/* nothing extra to send for status read */
} u;
};
/* Response */
/**
*/
struct hpi_controlx_res_cobranet_data {
u32 byte_count;
u32 data[2];
};
struct hpi_controlx_res_cobranet_bigdata {
u32 byte_count;
};
struct hpi_controlx_res_cobranet_status {
u32 status;
u32 readable_size;
u32 writeable_size;
};
struct hpi_controlx_res_generic {
u32 param1;
u32 param2;
};
struct hpi_controlx_res {
union {
struct hpi_controlx_res_cobranet_bigdata cobranet_bigdata;
struct hpi_controlx_res_cobranet_data cobranet_data;
struct hpi_controlx_res_cobranet_status cobranet_status;
struct hpi_controlx_res_generic generic;
/*struct param_info universal_info; */
/*struct param_value universal_value; */
} u;
};
struct hpi_nvmemory_msg {
u16 address;
u16 data;
};
struct hpi_nvmemory_res {
u16 size_in_bytes;
u16 data;
};
struct hpi_gpio_msg {
u16 bit_index;
u16 bit_data;
};
struct hpi_gpio_res {
u16 number_input_bits;
u16 number_output_bits;
u16 bit_data[4];
};
struct hpi_async_msg {
u32 events;
u16 maximum_events;
u16 padding;
};
struct hpi_async_res {
union {
struct {
u16 count;
} count;
struct {
u32 events;
u16 number_returned;
u16 padding;
} get;
struct hpi_async_event event;
} u;
};
struct hpi_watchdog_msg {
u32 time_ms;
};
struct hpi_watchdog_res {
u32 time_ms;
};
struct hpi_clock_msg {
u16 hours;
u16 minutes;
u16 seconds;
u16 milli_seconds;
};
struct hpi_clock_res {
u16 size_in_bytes;
u16 hours;
u16 minutes;
u16 seconds;
u16 milli_seconds;
u16 padding;
};
struct hpi_profile_msg {
u16 bin_index;
u16 padding;
};
struct hpi_profile_res_open {
u16 max_profiles;
};
struct hpi_profile_res_time {
u32 micro_seconds;
u32 call_count;
u32 max_micro_seconds;
u32 min_micro_seconds;
u16 seconds;
};
struct hpi_profile_res_name {
u8 sz_name[32];
};
struct hpi_profile_res {
union {
struct hpi_profile_res_open o;
struct hpi_profile_res_time t;
struct hpi_profile_res_name n;
} u;
};
struct hpi_message_header {
u16 size; /* total size in bytes */
u8 type; /* HPI_TYPE_MESSAGE */
u8 version; /* message version */
u16 object; /* HPI_OBJ_* */
u16 function; /* HPI_SUBSYS_xxx, HPI_ADAPTER_xxx */
u16 adapter_index; /* the adapter index */
u16 obj_index; /* */
};
struct hpi_message {
/* following fields must match HPI_MESSAGE_HEADER */
u16 size; /* total size in bytes */
u8 type; /* HPI_TYPE_MESSAGE */
u8 version; /* message version */
u16 object; /* HPI_OBJ_* */
u16 function; /* HPI_SUBSYS_xxx, HPI_ADAPTER_xxx */
u16 adapter_index; /* the adapter index */
u16 obj_index; /* */
union {
struct hpi_subsys_msg s;
struct hpi_adapter_msg a;
union hpi_adapterx_msg ax;
struct hpi_stream_msg d;
struct hpi_mixer_msg m;
union hpi_mixerx_msg mx; /* extended mixer; */
struct hpi_control_msg c; /* mixer control; */
/* identical to struct hpi_control_msg,
but field naming is improved */
struct hpi_control_union_msg cu;
struct hpi_controlx_msg cx; /* extended mixer control; */
struct hpi_nvmemory_msg n;
struct hpi_gpio_msg l; /* digital i/o */
struct hpi_watchdog_msg w;
struct hpi_clock_msg t; /* dsp time */
struct hpi_profile_msg p;
struct hpi_async_msg as;
char fixed_size[32];
} u;
};
#define HPI_MESSAGE_SIZE_BY_OBJECT { \
sizeof(struct hpi_message_header) , /* default, no object type 0 */ \
sizeof(struct hpi_message_header) + sizeof(struct hpi_subsys_msg),\
sizeof(struct hpi_message_header) + sizeof(union hpi_adapterx_msg),\
sizeof(struct hpi_message_header) + sizeof(struct hpi_stream_msg),\
sizeof(struct hpi_message_header) + sizeof(struct hpi_stream_msg),\
sizeof(struct hpi_message_header) + sizeof(struct hpi_mixer_msg),\
sizeof(struct hpi_message_header) , /* no node message */ \
sizeof(struct hpi_message_header) + sizeof(struct hpi_control_msg),\
sizeof(struct hpi_message_header) + sizeof(struct hpi_nvmemory_msg),\
sizeof(struct hpi_message_header) + sizeof(struct hpi_gpio_msg),\
sizeof(struct hpi_message_header) + sizeof(struct hpi_watchdog_msg),\
sizeof(struct hpi_message_header) + sizeof(struct hpi_clock_msg),\
sizeof(struct hpi_message_header) + sizeof(struct hpi_profile_msg),\
sizeof(struct hpi_message_header) + sizeof(struct hpi_controlx_msg),\
sizeof(struct hpi_message_header) + sizeof(struct hpi_async_msg) \
}
struct hpi_response_header {
u16 size;
u8 type; /* HPI_TYPE_RESPONSE */
u8 version; /* response version */
u16 object; /* HPI_OBJ_* */
u16 function; /* HPI_SUBSYS_xxx, HPI_ADAPTER_xxx */
u16 error; /* HPI_ERROR_xxx */
u16 specific_error; /* adapter specific error */
};
struct hpi_response {
/* following fields must match HPI_RESPONSE_HEADER */
u16 size;
u8 type; /* HPI_TYPE_RESPONSE */
u8 version; /* response version */
u16 object; /* HPI_OBJ_* */
u16 function; /* HPI_SUBSYS_xxx, HPI_ADAPTER_xxx */
u16 error; /* HPI_ERROR_xxx */
u16 specific_error; /* adapter specific error */
union {
struct hpi_subsys_res s;
struct hpi_adapter_res a;
union hpi_adapterx_res ax;
struct hpi_stream_res d;
struct hpi_mixer_res m;
union hpi_mixerx_res mx; /* extended mixer; */
struct hpi_control_res c; /* mixer control; */
/* identical to hpi_control_res, but field naming is improved */
union hpi_control_union_res cu;
struct hpi_controlx_res cx; /* extended mixer control; */
struct hpi_nvmemory_res n;
struct hpi_gpio_res l; /* digital i/o */
struct hpi_watchdog_res w;
struct hpi_clock_res t; /* dsp time */
struct hpi_profile_res p;
struct hpi_async_res as;
u8 bytes[52];
} u;
};
#define HPI_RESPONSE_SIZE_BY_OBJECT { \
sizeof(struct hpi_response_header) ,/* default, no object type 0 */ \
sizeof(struct hpi_response_header) + sizeof(struct hpi_subsys_res),\
sizeof(struct hpi_response_header) + sizeof(union hpi_adapterx_res),\
sizeof(struct hpi_response_header) + sizeof(struct hpi_stream_res),\
sizeof(struct hpi_response_header) + sizeof(struct hpi_stream_res),\
sizeof(struct hpi_response_header) + sizeof(struct hpi_mixer_res),\
sizeof(struct hpi_response_header) , /* no node response */ \
sizeof(struct hpi_response_header) + sizeof(struct hpi_control_res),\
sizeof(struct hpi_response_header) + sizeof(struct hpi_nvmemory_res),\
sizeof(struct hpi_response_header) + sizeof(struct hpi_gpio_res),\
sizeof(struct hpi_response_header) + sizeof(struct hpi_watchdog_res),\
sizeof(struct hpi_response_header) + sizeof(struct hpi_clock_res),\
sizeof(struct hpi_response_header) + sizeof(struct hpi_profile_res),\
sizeof(struct hpi_response_header) + sizeof(struct hpi_controlx_res),\
sizeof(struct hpi_response_header) + sizeof(struct hpi_async_res) \
}
/*********************** version 1 message/response *****************************/
#define HPINET_ETHERNET_DATA_SIZE (1500)
#define HPINET_IP_HDR_SIZE (20)
#define HPINET_IP_DATA_SIZE (HPINET_ETHERNET_DATA_SIZE - HPINET_IP_HDR_SIZE)
#define HPINET_UDP_HDR_SIZE (8)
#define HPINET_UDP_DATA_SIZE (HPINET_IP_DATA_SIZE - HPINET_UDP_HDR_SIZE)
#define HPINET_ASI_HDR_SIZE (2)
#define HPINET_ASI_DATA_SIZE (HPINET_UDP_DATA_SIZE - HPINET_ASI_HDR_SIZE)
#define HPI_MAX_PAYLOAD_SIZE (HPINET_ASI_DATA_SIZE - 2)
/* New style message/response, but still V0 compatible */
struct hpi_msg_adapter_get_info {
struct hpi_message_header h;
};
struct hpi_res_adapter_get_info {
struct hpi_response_header h; /*v0 */
struct hpi_adapter_res p;
};
/* padding is so these are same size as v0 hpi_message */
struct hpi_msg_adapter_query_flash {
struct hpi_message_header h;
u32 offset;
u8 pad_to_version0_size[sizeof(struct hpi_message) - /* V0 res */
sizeof(struct hpi_message_header) - 1 * sizeof(u32)];
};
/* padding is so these are same size as v0 hpi_response */
struct hpi_res_adapter_query_flash {
struct hpi_response_header h;
u32 checksum;
u32 length;
u32 version;
u8 pad_to_version0_size[sizeof(struct hpi_response) - /* V0 res */
sizeof(struct hpi_response_header) - 3 * sizeof(u32)];
};
struct hpi_msg_adapter_start_flash {
struct hpi_message_header h;
u32 offset;
u32 length;
u32 key;
u8 pad_to_version0_size[sizeof(struct hpi_message) - /* V0 res */
sizeof(struct hpi_message_header) - 3 * sizeof(u32)];
};
struct hpi_res_adapter_start_flash {
struct hpi_response_header h;
u8 pad_to_version0_size[sizeof(struct hpi_response) - /* V0 res */
sizeof(struct hpi_response_header)];
};
struct hpi_msg_adapter_program_flash_payload {
u32 checksum;
u16 sequence;
u16 length;
u16 offset; /**< offset from start of msg to data */
u16 unused;
/* ensure sizeof(header + payload) == sizeof(hpi_message_V0)
because old firmware expects data after message of this size */
u8 pad_to_version0_size[sizeof(struct hpi_message) - /* V0 message */
sizeof(struct hpi_message_header) - sizeof(u32) -
4 * sizeof(u16)];
};
struct hpi_msg_adapter_program_flash {
struct hpi_message_header h;
struct hpi_msg_adapter_program_flash_payload p;
u32 data[256];
};
struct hpi_res_adapter_program_flash {
struct hpi_response_header h;
u16 sequence;
u8 pad_to_version0_size[sizeof(struct hpi_response) - /* V0 res */
sizeof(struct hpi_response_header) - sizeof(u16)];
};
#if 1
#define hpi_message_header_v1 hpi_message_header
#define hpi_response_header_v1 hpi_response_header
#else
/* V1 headers in Addition to v0 headers */
struct hpi_message_header_v1 {
struct hpi_message_header h0;
/* struct {
} h1; */
};
struct hpi_response_header_v1 {
struct hpi_response_header h0;
struct {
u16 adapter_index; /* the adapter index */
u16 obj_index; /* object index */
} h1;
};
#endif
/* STRV HPI Packet */
struct hpi_msg_strv {
struct hpi_message_header h;
struct hpi_entity strv;
};
struct hpi_res_strv {
struct hpi_response_header h;
struct hpi_entity strv;
};
#define MIN_STRV_PACKET_SIZE sizeof(struct hpi_res_strv)
struct hpi_msg_payload_v0 {
struct hpi_message_header h;
union {
struct hpi_subsys_msg s;
struct hpi_adapter_msg a;
union hpi_adapterx_msg ax;
struct hpi_stream_msg d;
struct hpi_mixer_msg m;
union hpi_mixerx_msg mx;
struct hpi_control_msg c;
struct hpi_control_union_msg cu;
struct hpi_controlx_msg cx;
struct hpi_nvmemory_msg n;
struct hpi_gpio_msg l;
struct hpi_watchdog_msg w;
struct hpi_clock_msg t;
struct hpi_profile_msg p;
struct hpi_async_msg as;
} u;
};
struct hpi_res_payload_v0 {
struct hpi_response_header h;
union {
struct hpi_subsys_res s;
struct hpi_adapter_res a;
union hpi_adapterx_res ax;
struct hpi_stream_res d;
struct hpi_mixer_res m;
union hpi_mixerx_res mx;
struct hpi_control_res c;
union hpi_control_union_res cu;
struct hpi_controlx_res cx;
struct hpi_nvmemory_res n;
struct hpi_gpio_res l;
struct hpi_watchdog_res w;
struct hpi_clock_res t;
struct hpi_profile_res p;
struct hpi_async_res as;
} u;
};
union hpi_message_buffer_v1 {
struct hpi_message m0; /* version 0 */
struct hpi_message_header_v1 h;
unsigned char buf[HPI_MAX_PAYLOAD_SIZE];
};
union hpi_response_buffer_v1 {
struct hpi_response r0; /* version 0 */
struct hpi_response_header_v1 h;
unsigned char buf[HPI_MAX_PAYLOAD_SIZE];
};
compile_time_assert((sizeof(union hpi_message_buffer_v1) <=
HPI_MAX_PAYLOAD_SIZE), message_buffer_ok);
compile_time_assert((sizeof(union hpi_response_buffer_v1) <=
HPI_MAX_PAYLOAD_SIZE), response_buffer_ok);
/*////////////////////////////////////////////////////////////////////////// */
/* declarations for compact control calls */
struct hpi_control_defn {
u8 type;
u8 channels;
u8 src_node_type;
u8 src_node_index;
u8 dest_node_type;
u8 dest_node_index;
};
/*////////////////////////////////////////////////////////////////////////// */
/* declarations for control caching (internal to HPI<->DSP interaction) */
/** A compact representation of (part of) a controls state.
Used for efficient transfer of the control state
between DSP and host or across a network
*/
struct hpi_control_cache_info {
/** one of HPI_CONTROL_* */
u8 control_type;
/** The total size of cached information in 32-bit words. */
u8 size_in32bit_words;
/** The original index of the control on the DSP */
u16 control_index;
};
struct hpi_control_cache_single {
struct hpi_control_cache_info i;
union {
struct { /* volume */
u16 an_log[2];
} v;
struct { /* peak meter */
u16 an_log_peak[2];
u16 an_logRMS[2];
} p;
struct { /* channel mode */
u16 mode;
} m;
struct { /* multiplexer */
u16 source_node_type;
u16 source_node_index;
} x;
struct { /* level/trim */
u16 an_log[2];
} l;
struct { /* tuner - partial caching.
some attributes go to the DSP. */
u32 freq_ink_hz;
u16 band;
u16 level;
} t;
struct { /* AESEBU rx status */
u32 error_status;
u32 source;
} aes3rx;
struct { /* AESEBU tx */
u32 format;
} aes3tx;
struct { /* tone detector */
u16 state;
} tone;
struct { /* silence detector */
u32 state;
u32 count;
} silence;
struct { /* sample clock */
u16 source;
u16 source_index;
u32 sample_rate;
} clk;
struct { /* microphone control */
u16 state;
} phantom_power;
struct { /* generic control */
u32 dw1;
u32 dw2;
} g;
} u;
};
struct hpi_control_cache_pad {
struct hpi_control_cache_info i;
u32 field_valid_flags;
u8 c_channel[8];
u8 c_artist[40];
u8 c_title[40];
u8 c_comment[200];
u32 pTY;
u32 pI;
u32 traffic_supported;
u32 traffic_anouncement;
};
/*/////////////////////////////////////////////////////////////////////////// */
/* declarations for 2^N sized FIFO buffer (internal to HPI<->DSP interaction) */
struct hpi_fifo_buffer {
u32 size;
u32 dSP_index;
u32 host_index;
};
#ifndef DISABLE_PRAGMA_PACK1
#pragma pack(pop)
#endif
/* skip host side function declarations for DSP
compile and documentation extraction */
char hpi_handle_object(const u32 handle);
void hpi_handle_to_indexes(const u32 handle, u16 *pw_adapter_index,
u16 *pw_object_index);
u32 hpi_indexes_to_handle(const char c_object, const u16 adapter_index,
const u16 object_index);
/*////////////////////////////////////////////////////////////////////////// */
/* main HPI entry point */
hpi_handler_func hpi_send_recv;
/* UDP message */
void hpi_send_recvUDP(struct hpi_message *phm, struct hpi_response *phr,
const unsigned int timeout);
/* used in PnP OS/driver */
u16 hpi_subsys_create_adapter(const struct hpi_hsubsys *ph_subsys,
const struct hpi_resource *p_resource, u16 *pw_adapter_index);
u16 hpi_subsys_delete_adapter(const struct hpi_hsubsys *ph_subsys,
u16 adapter_index);
u16 hpi_outstream_host_buffer_get_info(const struct hpi_hsubsys *ph_subsys,
u32 h_outstream, u8 **pp_buffer,
struct hpi_hostbuffer_status **pp_status);
u16 hpi_instream_host_buffer_get_info(const struct hpi_hsubsys *ph_subsys,
u32 h_instream, u8 **pp_buffer,
struct hpi_hostbuffer_status **pp_status);
u16 hpi_adapter_restart(u16 adapter_index);
/*
The following 3 functions were last declared in header files for
driver 3.10. HPI_ControlQuery() used to be the recommended way
of getting a volume range. Declared here for binary asihpi32.dll
compatibility.
*/
void hpi_format_to_msg(struct hpi_msg_format *pMF,
const struct hpi_format *pF);
void hpi_stream_response_to_legacy(struct hpi_stream_res *pSR);
/*////////////////////////////////////////////////////////////////////////// */
/* declarations for individual HPI entry points */
hpi_handler_func HPI_1000;
hpi_handler_func HPI_6000;
hpi_handler_func HPI_6205;
hpi_handler_func HPI_COMMON;
#endif /* _HPI_INTERNAL_H_ */