1 /******************************************************************************
3 AudioScience HPI driver
4 Copyright (C) 1997-2010 AudioScience Inc. <support@audioscience.com>
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of version 2 of the GNU General Public License as
8 published by the Free Software Foundation;
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program; if not, write to the Free Software
17 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19 HPI internal definitions
21 (C) Copyright AudioScience Inc. 1996-2009
22 ******************************************************************************/
24 #ifndef _HPI_INTERNAL_H_
25 #define _HPI_INTERNAL_H_
28 /** maximum number of memory regions mapped to an adapter */
29 #define HPI_MAX_ADAPTER_MEM_SPACES (2)
31 /* Each OS needs its own hpios.h */
34 /* physical memory allocation */
36 /** Allocate and map an area of locked memory for bus master DMA operations.
38 On success, *pLockedMemeHandle is a valid handle, and 0 is returned
39 On error *pLockedMemHandle marked invalid, non-zero returned.
41 If this function succeeds, then HpiOs_LockedMem_GetVirtAddr() and
42 HpiOs_LockedMem_GetPyhsAddr() will always succed on the returned handle.
44 u16
hpios_locked_mem_alloc(struct consistent_dma_area
*p_locked_mem_handle
,
46 u32 size
, /**< Size in bytes to allocate */
47 struct pci_dev
*p_os_reference
48 /**< OS specific data required for memory allocation */
51 /** Free mapping and memory represented by LockedMemHandle
53 Frees any resources, then invalidates the handle.
54 Returns 0 on success, 1 if handle is invalid.
57 u16
hpios_locked_mem_free(struct consistent_dma_area
*locked_mem_handle
);
59 /** Get the physical PCI address of memory represented by LockedMemHandle.
61 If handle is invalid *pPhysicalAddr is set to zero and return 1
63 u16
hpios_locked_mem_get_phys_addr(struct consistent_dma_area
64 *locked_mem_handle
, u32
*p_physical_addr
);
66 /** Get the CPU address of of memory represented by LockedMemHandle.
68 If handle is NULL *ppvVirtualAddr is set to NULL and return 1
70 u16
hpios_locked_mem_get_virt_addr(struct consistent_dma_area
71 *locked_mem_handle
, void **ppv_virtual_addr
);
73 /** Check that handle is valid
74 i.e it represents a valid memory area
76 u16
hpios_locked_mem_valid(struct consistent_dma_area
*locked_mem_handle
);
79 void hpios_delay_micro_seconds(u32 num_micro_sec
);
84 typedef void hpi_handler_func(struct hpi_message
*, struct hpi_response
*);
86 /* If the assert fails, compiler complains
87 something like size of array `msg' is negative.
88 Unlike linux BUILD_BUG_ON, this works outside function scope.
90 #define compile_time_assert(cond, msg) \
91 typedef char ASSERT_##msg[(cond) ? 1 : -1]
93 /******************************************* bus types */
101 enum HPI_SUBSYS_OPTIONS
{
102 /* 0, 256 are invalid, 1..255 reserved for global options */
103 HPI_SUBSYS_OPT_NET_ENABLE
= 257,
104 HPI_SUBSYS_OPT_NET_BROADCAST
= 258,
105 HPI_SUBSYS_OPT_NET_UNICAST
= 259,
106 HPI_SUBSYS_OPT_NET_ADDR
= 260,
107 HPI_SUBSYS_OPT_NET_MASK
= 261,
108 HPI_SUBSYS_OPT_NET_ADAPTER_ADDRESS_ADD
= 262
113 enum HPI_VOLUME_FLAGS
{
114 /** Set if the volume control is muted */
115 HPI_VOLUME_FLAG_MUTED
= (1 << 0),
116 /** Set if the volume control has a mute function */
117 HPI_VOLUME_FLAG_HAS_MUTE
= (1 << 1),
118 /** Set if volume control can do autofading */
119 HPI_VOLUME_FLAG_HAS_AUTOFADE
= (1 << 2)
120 /* Note Flags >= (1<<8) are for DSP internal use only */
123 /******************************************* CONTROL ATTRIBUTES ****/
124 /* (in order of control type ID */
126 /* This allows for 255 control types, 256 unique attributes each */
127 #define HPI_CTL_ATTR(ctl, ai) ((HPI_CONTROL_##ctl << 8) + ai)
129 /* Get the sub-index of the attribute for a control type */
130 #define HPI_CTL_ATTR_INDEX(i) (i & 0xff)
132 /* Extract the control from the control attribute */
133 #define HPI_CTL_ATTR_CONTROL(i) (i >> 8)
135 /** Enable event generation for a control.
137 \note generic to all controls that can generate events
140 /** Unique identifiers for every control attribute
142 enum HPI_CONTROL_ATTRIBUTES
{
143 HPI_GENERIC_ENABLE
= HPI_CTL_ATTR(GENERIC
, 1),
144 HPI_GENERIC_EVENT_ENABLE
= HPI_CTL_ATTR(GENERIC
, 2),
146 HPI_VOLUME_GAIN
= HPI_CTL_ATTR(VOLUME
, 1),
147 HPI_VOLUME_AUTOFADE
= HPI_CTL_ATTR(VOLUME
, 2),
148 HPI_VOLUME_MUTE
= HPI_CTL_ATTR(VOLUME
, 3),
149 HPI_VOLUME_GAIN_AND_FLAGS
= HPI_CTL_ATTR(VOLUME
, 4),
150 HPI_VOLUME_NUM_CHANNELS
= HPI_CTL_ATTR(VOLUME
, 6),
151 HPI_VOLUME_RANGE
= HPI_CTL_ATTR(VOLUME
, 10),
153 HPI_METER_RMS
= HPI_CTL_ATTR(METER
, 1),
154 HPI_METER_PEAK
= HPI_CTL_ATTR(METER
, 2),
155 HPI_METER_RMS_BALLISTICS
= HPI_CTL_ATTR(METER
, 3),
156 HPI_METER_PEAK_BALLISTICS
= HPI_CTL_ATTR(METER
, 4),
157 HPI_METER_NUM_CHANNELS
= HPI_CTL_ATTR(METER
, 5),
159 HPI_MULTIPLEXER_SOURCE
= HPI_CTL_ATTR(MULTIPLEXER
, 1),
160 HPI_MULTIPLEXER_QUERYSOURCE
= HPI_CTL_ATTR(MULTIPLEXER
, 2),
162 HPI_AESEBUTX_FORMAT
= HPI_CTL_ATTR(AESEBUTX
, 1),
163 HPI_AESEBUTX_SAMPLERATE
= HPI_CTL_ATTR(AESEBUTX
, 3),
164 HPI_AESEBUTX_CHANNELSTATUS
= HPI_CTL_ATTR(AESEBUTX
, 4),
165 HPI_AESEBUTX_USERDATA
= HPI_CTL_ATTR(AESEBUTX
, 5),
167 HPI_AESEBURX_FORMAT
= HPI_CTL_ATTR(AESEBURX
, 1),
168 HPI_AESEBURX_ERRORSTATUS
= HPI_CTL_ATTR(AESEBURX
, 2),
169 HPI_AESEBURX_SAMPLERATE
= HPI_CTL_ATTR(AESEBURX
, 3),
170 HPI_AESEBURX_CHANNELSTATUS
= HPI_CTL_ATTR(AESEBURX
, 4),
171 HPI_AESEBURX_USERDATA
= HPI_CTL_ATTR(AESEBURX
, 5),
173 HPI_LEVEL_GAIN
= HPI_CTL_ATTR(LEVEL
, 1),
174 HPI_LEVEL_RANGE
= HPI_CTL_ATTR(LEVEL
, 10),
176 HPI_TUNER_BAND
= HPI_CTL_ATTR(TUNER
, 1),
177 HPI_TUNER_FREQ
= HPI_CTL_ATTR(TUNER
, 2),
178 HPI_TUNER_LEVEL_AVG
= HPI_CTL_ATTR(TUNER
, 3),
179 HPI_TUNER_LEVEL_RAW
= HPI_CTL_ATTR(TUNER
, 4),
180 HPI_TUNER_SNR
= HPI_CTL_ATTR(TUNER
, 5),
181 HPI_TUNER_GAIN
= HPI_CTL_ATTR(TUNER
, 6),
182 HPI_TUNER_STATUS
= HPI_CTL_ATTR(TUNER
, 7),
183 HPI_TUNER_MODE
= HPI_CTL_ATTR(TUNER
, 8),
184 HPI_TUNER_RDS
= HPI_CTL_ATTR(TUNER
, 9),
185 HPI_TUNER_DEEMPHASIS
= HPI_CTL_ATTR(TUNER
, 10),
186 HPI_TUNER_PROGRAM
= HPI_CTL_ATTR(TUNER
, 11),
187 HPI_TUNER_HDRADIO_SIGNAL_QUALITY
= HPI_CTL_ATTR(TUNER
, 12),
188 HPI_TUNER_HDRADIO_SDK_VERSION
= HPI_CTL_ATTR(TUNER
, 13),
189 HPI_TUNER_HDRADIO_DSP_VERSION
= HPI_CTL_ATTR(TUNER
, 14),
190 HPI_TUNER_HDRADIO_BLEND
= HPI_CTL_ATTR(TUNER
, 15),
192 HPI_VOX_THRESHOLD
= HPI_CTL_ATTR(VOX
, 1),
194 HPI_CHANNEL_MODE_MODE
= HPI_CTL_ATTR(CHANNEL_MODE
, 1),
196 HPI_BITSTREAM_DATA_POLARITY
= HPI_CTL_ATTR(BITSTREAM
, 1),
197 HPI_BITSTREAM_CLOCK_EDGE
= HPI_CTL_ATTR(BITSTREAM
, 2),
198 HPI_BITSTREAM_CLOCK_SOURCE
= HPI_CTL_ATTR(BITSTREAM
, 3),
199 HPI_BITSTREAM_ACTIVITY
= HPI_CTL_ATTR(BITSTREAM
, 4),
201 HPI_SAMPLECLOCK_SOURCE
= HPI_CTL_ATTR(SAMPLECLOCK
, 1),
202 HPI_SAMPLECLOCK_SAMPLERATE
= HPI_CTL_ATTR(SAMPLECLOCK
, 2),
203 HPI_SAMPLECLOCK_SOURCE_INDEX
= HPI_CTL_ATTR(SAMPLECLOCK
, 3),
204 HPI_SAMPLECLOCK_LOCAL_SAMPLERATE
= HPI_CTL_ATTR(SAMPLECLOCK
, 4),
205 HPI_SAMPLECLOCK_AUTO
= HPI_CTL_ATTR(SAMPLECLOCK
, 5),
206 HPI_SAMPLECLOCK_LOCAL_LOCK
= HPI_CTL_ATTR(SAMPLECLOCK
, 6),
208 HPI_MICROPHONE_PHANTOM_POWER
= HPI_CTL_ATTR(MICROPHONE
, 1),
210 HPI_EQUALIZER_NUM_FILTERS
= HPI_CTL_ATTR(EQUALIZER
, 1),
211 HPI_EQUALIZER_FILTER
= HPI_CTL_ATTR(EQUALIZER
, 2),
212 HPI_EQUALIZER_COEFFICIENTS
= HPI_CTL_ATTR(EQUALIZER
, 3),
214 HPI_COMPANDER_PARAMS
= HPI_CTL_ATTR(COMPANDER
, 1),
215 HPI_COMPANDER_MAKEUPGAIN
= HPI_CTL_ATTR(COMPANDER
, 2),
216 HPI_COMPANDER_THRESHOLD
= HPI_CTL_ATTR(COMPANDER
, 3),
217 HPI_COMPANDER_RATIO
= HPI_CTL_ATTR(COMPANDER
, 4),
218 HPI_COMPANDER_ATTACK
= HPI_CTL_ATTR(COMPANDER
, 5),
219 HPI_COMPANDER_DECAY
= HPI_CTL_ATTR(COMPANDER
, 6),
221 HPI_COBRANET_SET
= HPI_CTL_ATTR(COBRANET
, 1),
222 HPI_COBRANET_GET
= HPI_CTL_ATTR(COBRANET
, 2),
223 /*HPI_COBRANET_SET_DATA = HPI_CTL_ATTR(COBRANET, 3), */
224 /*HPI_COBRANET_GET_DATA = HPI_CTL_ATTR(COBRANET, 4), */
225 HPI_COBRANET_GET_STATUS
= HPI_CTL_ATTR(COBRANET
, 5),
226 HPI_COBRANET_SEND_PACKET
= HPI_CTL_ATTR(COBRANET
, 6),
227 HPI_COBRANET_GET_PACKET
= HPI_CTL_ATTR(COBRANET
, 7),
229 HPI_TONEDETECTOR_THRESHOLD
= HPI_CTL_ATTR(TONEDETECTOR
, 1),
230 HPI_TONEDETECTOR_STATE
= HPI_CTL_ATTR(TONEDETECTOR
, 2),
231 HPI_TONEDETECTOR_FREQUENCY
= HPI_CTL_ATTR(TONEDETECTOR
, 3),
233 HPI_SILENCEDETECTOR_THRESHOLD
= HPI_CTL_ATTR(SILENCEDETECTOR
, 1),
234 HPI_SILENCEDETECTOR_STATE
= HPI_CTL_ATTR(SILENCEDETECTOR
, 2),
235 HPI_SILENCEDETECTOR_DELAY
= HPI_CTL_ATTR(SILENCEDETECTOR
, 3),
237 HPI_PAD_CHANNEL_NAME
= HPI_CTL_ATTR(PAD
, 1),
238 HPI_PAD_ARTIST
= HPI_CTL_ATTR(PAD
, 2),
239 HPI_PAD_TITLE
= HPI_CTL_ATTR(PAD
, 3),
240 HPI_PAD_COMMENT
= HPI_CTL_ATTR(PAD
, 4),
241 HPI_PAD_PROGRAM_TYPE
= HPI_CTL_ATTR(PAD
, 5),
242 HPI_PAD_PROGRAM_ID
= HPI_CTL_ATTR(PAD
, 6),
243 HPI_PAD_TA_SUPPORT
= HPI_CTL_ATTR(PAD
, 7),
244 HPI_PAD_TA_ACTIVE
= HPI_CTL_ATTR(PAD
, 8)
247 #define HPI_POLARITY_POSITIVE 0
248 #define HPI_POLARITY_NEGATIVE 1
250 /*------------------------------------------------------------
251 Cobranet Chip Bridge - copied from HMI.H
252 ------------------------------------------------------------*/
253 #define HPI_COBRANET_HMI_cobra_bridge 0x20000
254 #define HPI_COBRANET_HMI_cobra_bridge_tx_pkt_buf \
255 (HPI_COBRANET_HMI_cobra_bridge + 0x1000)
256 #define HPI_COBRANET_HMI_cobra_bridge_rx_pkt_buf \
257 (HPI_COBRANET_HMI_cobra_bridge + 0x2000)
258 #define HPI_COBRANET_HMI_cobra_if_table1 0x110000
259 #define HPI_COBRANET_HMI_cobra_if_phy_address \
260 (HPI_COBRANET_HMI_cobra_if_table1 + 0xd)
261 #define HPI_COBRANET_HMI_cobra_protocolIP 0x72000
262 #define HPI_COBRANET_HMI_cobra_ip_mon_currentIP \
263 (HPI_COBRANET_HMI_cobra_protocolIP + 0x0)
264 #define HPI_COBRANET_HMI_cobra_ip_mon_staticIP \
265 (HPI_COBRANET_HMI_cobra_protocolIP + 0x2)
266 #define HPI_COBRANET_HMI_cobra_sys 0x100000
267 #define HPI_COBRANET_HMI_cobra_sys_desc \
268 (HPI_COBRANET_HMI_cobra_sys + 0x0)
269 #define HPI_COBRANET_HMI_cobra_sys_objectID \
270 (HPI_COBRANET_HMI_cobra_sys + 0x100)
271 #define HPI_COBRANET_HMI_cobra_sys_contact \
272 (HPI_COBRANET_HMI_cobra_sys + 0x200)
273 #define HPI_COBRANET_HMI_cobra_sys_name \
274 (HPI_COBRANET_HMI_cobra_sys + 0x300)
275 #define HPI_COBRANET_HMI_cobra_sys_location \
276 (HPI_COBRANET_HMI_cobra_sys + 0x400)
278 /*------------------------------------------------------------
279 Cobranet Chip Status bits
280 ------------------------------------------------------------*/
281 #define HPI_COBRANET_HMI_STATUS_RXPACKET 2
282 #define HPI_COBRANET_HMI_STATUS_TXPACKET 3
284 /*------------------------------------------------------------
286 ------------------------------------------------------------*/
287 #define HPI_ETHERNET_HEADER_SIZE (16)
289 /* These defines are used to fill in protocol information for an Ethernet packet
290 sent using HMI on CS18102 */
291 /** ID supplied by Cirrus for ASI packets. */
292 #define HPI_ETHERNET_PACKET_ID 0x85
293 /** Simple packet - no special routing required */
294 #define HPI_ETHERNET_PACKET_V1 0x01
295 /** This packet must make its way to the host across the HPI interface */
296 #define HPI_ETHERNET_PACKET_HOSTED_VIA_HMI 0x20
297 /** This packet must make its way to the host across the HPI interface */
298 #define HPI_ETHERNET_PACKET_HOSTED_VIA_HMI_V1 0x21
299 /** This packet must make its way to the host across the HPI interface */
300 #define HPI_ETHERNET_PACKET_HOSTED_VIA_HPI 0x40
301 /** This packet must make its way to the host across the HPI interface */
302 #define HPI_ETHERNET_PACKET_HOSTED_VIA_HPI_V1 0x41
304 #define HPI_ETHERNET_UDP_PORT 44600 /**< HPI UDP service */
306 /** Default network timeout in milli-seconds. */
307 #define HPI_ETHERNET_TIMEOUT_MS 500
309 /** Locked memory buffer alloc/free phases */
310 enum HPI_BUFFER_CMDS
{
311 /** use one message to allocate or free physical memory */
312 HPI_BUFFER_CMD_EXTERNAL
= 0,
313 /** alloc physical memory */
314 HPI_BUFFER_CMD_INTERNAL_ALLOC
= 1,
315 /** send physical memory address to adapter */
316 HPI_BUFFER_CMD_INTERNAL_GRANTADAPTER
= 2,
317 /** notify adapter to stop using physical buffer */
318 HPI_BUFFER_CMD_INTERNAL_REVOKEADAPTER
= 3,
319 /** free physical buffer */
320 HPI_BUFFER_CMD_INTERNAL_FREE
= 4
323 /*****************************************************************************/
324 /*****************************************************************************/
325 /******** HPI LOW LEVEL MESSAGES *******/
326 /*****************************************************************************/
327 /*****************************************************************************/
329 /** "ASI" - actual is "ASX" - need to change */
330 #define HPI_ID_ISAPNP_AUDIOSCIENCE 0x0669
331 /** PCI vendor ID that AudioScience uses */
332 #define HPI_PCI_VENDOR_ID_AUDIOSCIENCE 0x175C
333 /** PCI vendor ID that the DSP56301 has */
334 #define HPI_PCI_VENDOR_ID_MOTOROLA 0x1057
335 /** PCI vendor ID that TI uses */
336 #define HPI_PCI_VENDOR_ID_TI 0x104C
338 #define HPI_PCI_DEV_ID_PCI2040 0xAC60
339 /** TI's C6205 PCI interface has this ID */
340 #define HPI_PCI_DEV_ID_DSP6205 0xA106
342 #define HPI_USB_VENDOR_ID_AUDIOSCIENCE 0x1257
343 #define HPI_USB_W2K_TAG 0x57495341 /* "ASIW" */
344 #define HPI_USB_LINUX_TAG 0x4C495341 /* "ASIL" */
346 /** Invalid Adapter index
347 Used in HPI messages that are not addressed to a specific adapter
348 Used in DLL to indicate device not present
350 #define HPI_ADAPTER_INDEX_INVALID 0xFFFF
352 /** First 2 hex digits define the adapter family */
353 #define HPI_ADAPTER_FAMILY_MASK 0xff00
354 #define HPI_MODULE_FAMILY_MASK 0xfff0
356 #define HPI_ADAPTER_FAMILY_ASI(f) (f & HPI_ADAPTER_FAMILY_MASK)
357 #define HPI_MODULE_FAMILY_ASI(f) (f & HPI_MODULE_FAMILY_MASK)
358 #define HPI_ADAPTER_ASI(f) (f)
360 enum HPI_MESSAGE_TYPES
{
361 HPI_TYPE_REQUEST
= 1,
362 HPI_TYPE_RESPONSE
= 2,
364 HPI_TYPE_SSX2BYPASS_MESSAGE
= 4
367 enum HPI_OBJECT_TYPES
{
368 HPI_OBJ_SUBSYSTEM
= 1,
375 HPI_OBJ_NVMEMORY
= 8,
377 HPI_OBJ_WATCHDOG
= 10,
379 HPI_OBJ_PROFILE
= 12,
380 /* HPI_ OBJ_ CONTROLEX = 13, */
381 HPI_OBJ_ASYNCEVENT
= 14
382 #define HPI_OBJ_MAXINDEX 14
385 #define HPI_OBJ_FUNCTION_SPACING 0x100
386 #define HPI_FUNC_ID(obj, i) (HPI_OBJ_##obj * HPI_OBJ_FUNCTION_SPACING + i)
388 #define HPI_EXTRACT_INDEX(fn) (fn & 0xff)
390 enum HPI_FUNCTION_IDS
{
391 HPI_SUBSYS_OPEN
= HPI_FUNC_ID(SUBSYSTEM
, 1),
392 HPI_SUBSYS_GET_VERSION
= HPI_FUNC_ID(SUBSYSTEM
, 2),
393 HPI_SUBSYS_GET_INFO
= HPI_FUNC_ID(SUBSYSTEM
, 3),
394 /* HPI_SUBSYS_FIND_ADAPTERS = HPI_FUNC_ID(SUBSYSTEM, 4), */
395 HPI_SUBSYS_CREATE_ADAPTER
= HPI_FUNC_ID(SUBSYSTEM
, 5),
396 HPI_SUBSYS_CLOSE
= HPI_FUNC_ID(SUBSYSTEM
, 6),
397 /* HPI_SUBSYS_DELETE_ADAPTER = HPI_FUNC_ID(SUBSYSTEM, 7), */
398 HPI_SUBSYS_DRIVER_LOAD
= HPI_FUNC_ID(SUBSYSTEM
, 8),
399 HPI_SUBSYS_DRIVER_UNLOAD
= HPI_FUNC_ID(SUBSYSTEM
, 9),
400 /* HPI_SUBSYS_READ_PORT_8 = HPI_FUNC_ID(SUBSYSTEM, 10), */
401 /* HPI_SUBSYS_WRITE_PORT_8 = HPI_FUNC_ID(SUBSYSTEM, 11), */
402 HPI_SUBSYS_GET_NUM_ADAPTERS
= HPI_FUNC_ID(SUBSYSTEM
, 12),
403 HPI_SUBSYS_GET_ADAPTER
= HPI_FUNC_ID(SUBSYSTEM
, 13),
404 HPI_SUBSYS_SET_NETWORK_INTERFACE
= HPI_FUNC_ID(SUBSYSTEM
, 14),
405 HPI_SUBSYS_OPTION_INFO
= HPI_FUNC_ID(SUBSYSTEM
, 15),
406 HPI_SUBSYS_OPTION_GET
= HPI_FUNC_ID(SUBSYSTEM
, 16),
407 HPI_SUBSYS_OPTION_SET
= HPI_FUNC_ID(SUBSYSTEM
, 17),
408 #define HPI_SUBSYS_FUNCTION_COUNT 17
410 HPI_ADAPTER_OPEN
= HPI_FUNC_ID(ADAPTER
, 1),
411 HPI_ADAPTER_CLOSE
= HPI_FUNC_ID(ADAPTER
, 2),
412 HPI_ADAPTER_GET_INFO
= HPI_FUNC_ID(ADAPTER
, 3),
413 HPI_ADAPTER_GET_ASSERT
= HPI_FUNC_ID(ADAPTER
, 4),
414 HPI_ADAPTER_TEST_ASSERT
= HPI_FUNC_ID(ADAPTER
, 5),
415 HPI_ADAPTER_SET_MODE
= HPI_FUNC_ID(ADAPTER
, 6),
416 HPI_ADAPTER_GET_MODE
= HPI_FUNC_ID(ADAPTER
, 7),
417 HPI_ADAPTER_ENABLE_CAPABILITY
= HPI_FUNC_ID(ADAPTER
, 8),
418 HPI_ADAPTER_SELFTEST
= HPI_FUNC_ID(ADAPTER
, 9),
419 HPI_ADAPTER_FIND_OBJECT
= HPI_FUNC_ID(ADAPTER
, 10),
420 HPI_ADAPTER_QUERY_FLASH
= HPI_FUNC_ID(ADAPTER
, 11),
421 HPI_ADAPTER_START_FLASH
= HPI_FUNC_ID(ADAPTER
, 12),
422 HPI_ADAPTER_PROGRAM_FLASH
= HPI_FUNC_ID(ADAPTER
, 13),
423 HPI_ADAPTER_SET_PROPERTY
= HPI_FUNC_ID(ADAPTER
, 14),
424 HPI_ADAPTER_GET_PROPERTY
= HPI_FUNC_ID(ADAPTER
, 15),
425 HPI_ADAPTER_ENUM_PROPERTY
= HPI_FUNC_ID(ADAPTER
, 16),
426 HPI_ADAPTER_MODULE_INFO
= HPI_FUNC_ID(ADAPTER
, 17),
427 HPI_ADAPTER_DEBUG_READ
= HPI_FUNC_ID(ADAPTER
, 18),
428 HPI_ADAPTER_IRQ_QUERY_AND_CLEAR
= HPI_FUNC_ID(ADAPTER
, 19),
429 HPI_ADAPTER_IRQ_CALLBACK
= HPI_FUNC_ID(ADAPTER
, 20),
430 HPI_ADAPTER_DELETE
= HPI_FUNC_ID(ADAPTER
, 21),
431 #define HPI_ADAPTER_FUNCTION_COUNT 21
433 HPI_OSTREAM_OPEN
= HPI_FUNC_ID(OSTREAM
, 1),
434 HPI_OSTREAM_CLOSE
= HPI_FUNC_ID(OSTREAM
, 2),
435 HPI_OSTREAM_WRITE
= HPI_FUNC_ID(OSTREAM
, 3),
436 HPI_OSTREAM_START
= HPI_FUNC_ID(OSTREAM
, 4),
437 HPI_OSTREAM_STOP
= HPI_FUNC_ID(OSTREAM
, 5),
438 HPI_OSTREAM_RESET
= HPI_FUNC_ID(OSTREAM
, 6),
439 HPI_OSTREAM_GET_INFO
= HPI_FUNC_ID(OSTREAM
, 7),
440 HPI_OSTREAM_QUERY_FORMAT
= HPI_FUNC_ID(OSTREAM
, 8),
441 HPI_OSTREAM_DATA
= HPI_FUNC_ID(OSTREAM
, 9),
442 HPI_OSTREAM_SET_VELOCITY
= HPI_FUNC_ID(OSTREAM
, 10),
443 HPI_OSTREAM_SET_PUNCHINOUT
= HPI_FUNC_ID(OSTREAM
, 11),
444 HPI_OSTREAM_SINEGEN
= HPI_FUNC_ID(OSTREAM
, 12),
445 HPI_OSTREAM_ANC_RESET
= HPI_FUNC_ID(OSTREAM
, 13),
446 HPI_OSTREAM_ANC_GET_INFO
= HPI_FUNC_ID(OSTREAM
, 14),
447 HPI_OSTREAM_ANC_READ
= HPI_FUNC_ID(OSTREAM
, 15),
448 HPI_OSTREAM_SET_TIMESCALE
= HPI_FUNC_ID(OSTREAM
, 16),
449 HPI_OSTREAM_SET_FORMAT
= HPI_FUNC_ID(OSTREAM
, 17),
450 HPI_OSTREAM_HOSTBUFFER_ALLOC
= HPI_FUNC_ID(OSTREAM
, 18),
451 HPI_OSTREAM_HOSTBUFFER_FREE
= HPI_FUNC_ID(OSTREAM
, 19),
452 HPI_OSTREAM_GROUP_ADD
= HPI_FUNC_ID(OSTREAM
, 20),
453 HPI_OSTREAM_GROUP_GETMAP
= HPI_FUNC_ID(OSTREAM
, 21),
454 HPI_OSTREAM_GROUP_RESET
= HPI_FUNC_ID(OSTREAM
, 22),
455 HPI_OSTREAM_HOSTBUFFER_GET_INFO
= HPI_FUNC_ID(OSTREAM
, 23),
456 HPI_OSTREAM_WAIT_START
= HPI_FUNC_ID(OSTREAM
, 24),
457 HPI_OSTREAM_WAIT
= HPI_FUNC_ID(OSTREAM
, 25),
458 #define HPI_OSTREAM_FUNCTION_COUNT 25
460 HPI_ISTREAM_OPEN
= HPI_FUNC_ID(ISTREAM
, 1),
461 HPI_ISTREAM_CLOSE
= HPI_FUNC_ID(ISTREAM
, 2),
462 HPI_ISTREAM_SET_FORMAT
= HPI_FUNC_ID(ISTREAM
, 3),
463 HPI_ISTREAM_READ
= HPI_FUNC_ID(ISTREAM
, 4),
464 HPI_ISTREAM_START
= HPI_FUNC_ID(ISTREAM
, 5),
465 HPI_ISTREAM_STOP
= HPI_FUNC_ID(ISTREAM
, 6),
466 HPI_ISTREAM_RESET
= HPI_FUNC_ID(ISTREAM
, 7),
467 HPI_ISTREAM_GET_INFO
= HPI_FUNC_ID(ISTREAM
, 8),
468 HPI_ISTREAM_QUERY_FORMAT
= HPI_FUNC_ID(ISTREAM
, 9),
469 HPI_ISTREAM_ANC_RESET
= HPI_FUNC_ID(ISTREAM
, 10),
470 HPI_ISTREAM_ANC_GET_INFO
= HPI_FUNC_ID(ISTREAM
, 11),
471 HPI_ISTREAM_ANC_WRITE
= HPI_FUNC_ID(ISTREAM
, 12),
472 HPI_ISTREAM_HOSTBUFFER_ALLOC
= HPI_FUNC_ID(ISTREAM
, 13),
473 HPI_ISTREAM_HOSTBUFFER_FREE
= HPI_FUNC_ID(ISTREAM
, 14),
474 HPI_ISTREAM_GROUP_ADD
= HPI_FUNC_ID(ISTREAM
, 15),
475 HPI_ISTREAM_GROUP_GETMAP
= HPI_FUNC_ID(ISTREAM
, 16),
476 HPI_ISTREAM_GROUP_RESET
= HPI_FUNC_ID(ISTREAM
, 17),
477 HPI_ISTREAM_HOSTBUFFER_GET_INFO
= HPI_FUNC_ID(ISTREAM
, 18),
478 HPI_ISTREAM_WAIT_START
= HPI_FUNC_ID(ISTREAM
, 19),
479 HPI_ISTREAM_WAIT
= HPI_FUNC_ID(ISTREAM
, 20),
480 #define HPI_ISTREAM_FUNCTION_COUNT 20
483 GET_NODE_INFO, SET_CONNECTION, GET_CONNECTIONS are not currently used */
484 HPI_MIXER_OPEN
= HPI_FUNC_ID(MIXER
, 1),
485 HPI_MIXER_CLOSE
= HPI_FUNC_ID(MIXER
, 2),
486 HPI_MIXER_GET_INFO
= HPI_FUNC_ID(MIXER
, 3),
487 HPI_MIXER_GET_NODE_INFO
= HPI_FUNC_ID(MIXER
, 4),
488 HPI_MIXER_GET_CONTROL
= HPI_FUNC_ID(MIXER
, 5),
489 HPI_MIXER_SET_CONNECTION
= HPI_FUNC_ID(MIXER
, 6),
490 HPI_MIXER_GET_CONNECTIONS
= HPI_FUNC_ID(MIXER
, 7),
491 HPI_MIXER_GET_CONTROL_BY_INDEX
= HPI_FUNC_ID(MIXER
, 8),
492 HPI_MIXER_GET_CONTROL_ARRAY_BY_INDEX
= HPI_FUNC_ID(MIXER
, 9),
493 HPI_MIXER_GET_CONTROL_MULTIPLE_VALUES
= HPI_FUNC_ID(MIXER
, 10),
494 HPI_MIXER_STORE
= HPI_FUNC_ID(MIXER
, 11),
495 HPI_MIXER_GET_CACHE_INFO
= HPI_FUNC_ID(MIXER
, 12),
496 #define HPI_MIXER_FUNCTION_COUNT 12
498 HPI_CONTROL_GET_INFO
= HPI_FUNC_ID(CONTROL
, 1),
499 HPI_CONTROL_GET_STATE
= HPI_FUNC_ID(CONTROL
, 2),
500 HPI_CONTROL_SET_STATE
= HPI_FUNC_ID(CONTROL
, 3),
501 #define HPI_CONTROL_FUNCTION_COUNT 3
503 HPI_NVMEMORY_OPEN
= HPI_FUNC_ID(NVMEMORY
, 1),
504 HPI_NVMEMORY_READ_BYTE
= HPI_FUNC_ID(NVMEMORY
, 2),
505 HPI_NVMEMORY_WRITE_BYTE
= HPI_FUNC_ID(NVMEMORY
, 3),
506 #define HPI_NVMEMORY_FUNCTION_COUNT 3
508 HPI_GPIO_OPEN
= HPI_FUNC_ID(GPIO
, 1),
509 HPI_GPIO_READ_BIT
= HPI_FUNC_ID(GPIO
, 2),
510 HPI_GPIO_WRITE_BIT
= HPI_FUNC_ID(GPIO
, 3),
511 HPI_GPIO_READ_ALL
= HPI_FUNC_ID(GPIO
, 4),
512 HPI_GPIO_WRITE_STATUS
= HPI_FUNC_ID(GPIO
, 5),
513 #define HPI_GPIO_FUNCTION_COUNT 5
515 HPI_ASYNCEVENT_OPEN
= HPI_FUNC_ID(ASYNCEVENT
, 1),
516 HPI_ASYNCEVENT_CLOSE
= HPI_FUNC_ID(ASYNCEVENT
, 2),
517 HPI_ASYNCEVENT_WAIT
= HPI_FUNC_ID(ASYNCEVENT
, 3),
518 HPI_ASYNCEVENT_GETCOUNT
= HPI_FUNC_ID(ASYNCEVENT
, 4),
519 HPI_ASYNCEVENT_GET
= HPI_FUNC_ID(ASYNCEVENT
, 5),
520 HPI_ASYNCEVENT_SENDEVENTS
= HPI_FUNC_ID(ASYNCEVENT
, 6),
521 #define HPI_ASYNCEVENT_FUNCTION_COUNT 6
523 HPI_WATCHDOG_OPEN
= HPI_FUNC_ID(WATCHDOG
, 1),
524 HPI_WATCHDOG_SET_TIME
= HPI_FUNC_ID(WATCHDOG
, 2),
525 HPI_WATCHDOG_PING
= HPI_FUNC_ID(WATCHDOG
, 3),
527 HPI_CLOCK_OPEN
= HPI_FUNC_ID(CLOCK
, 1),
528 HPI_CLOCK_SET_TIME
= HPI_FUNC_ID(CLOCK
, 2),
529 HPI_CLOCK_GET_TIME
= HPI_FUNC_ID(CLOCK
, 3),
531 HPI_PROFILE_OPEN_ALL
= HPI_FUNC_ID(PROFILE
, 1),
532 HPI_PROFILE_START_ALL
= HPI_FUNC_ID(PROFILE
, 2),
533 HPI_PROFILE_STOP_ALL
= HPI_FUNC_ID(PROFILE
, 3),
534 HPI_PROFILE_GET
= HPI_FUNC_ID(PROFILE
, 4),
535 HPI_PROFILE_GET_IDLECOUNT
= HPI_FUNC_ID(PROFILE
, 5),
536 HPI_PROFILE_GET_NAME
= HPI_FUNC_ID(PROFILE
, 6),
537 HPI_PROFILE_GET_UTILIZATION
= HPI_FUNC_ID(PROFILE
, 7)
538 #define HPI_PROFILE_FUNCTION_COUNT 7
541 /* ////////////////////////////////////////////////////////////////////// */
543 #ifndef DISABLE_PRAGMA_PACK1
544 #pragma pack(push, 1)
547 /** PCI bus resource */
549 u32 __iomem
*ap_mem_base
[HPI_MAX_ADAPTER_MEM_SPACES
];
550 struct pci_dev
*pci_dev
;
553 struct hpi_resource
{
555 const struct hpi_pci
*pci
;
558 #ifndef HPI64BIT /* keep structure size constant */
561 u16 bus_type
; /* HPI_BUS_PNPISA, _PCI, _USB etc */
566 /** Format info used inside struct hpi_message
567 Not the same as public API struct hpi_format */
568 struct hpi_msg_format
{
569 u32 sample_rate
; /**< 11025, 32000, 44100 etc. */
570 u32 bit_rate
; /**< for MPEG */
571 u32 attributes
; /**< stereo/joint_stereo/mono */
572 u16 channels
; /**< 1,2..., (or ancillary mode or idle bit */
573 u16 format
; /**< HPI_FORMAT_PCM16, _MPEG etc. see \ref HPI_FORMATS. */
576 /** Buffer+format structure.
577 Must be kept 7 * 32 bits to match public struct hpi_datastruct */
578 struct hpi_msg_data
{
579 struct hpi_msg_format format
;
587 /** struct hpi_datastructure used up to 3.04 driver */
588 struct hpi_data_legacy32
{
589 struct hpi_format format
;
595 /* Compatibility version of struct hpi_data*/
596 struct hpi_data_compat32
{
597 struct hpi_msg_format format
;
605 /** placeholder for backward compatibility (see dwBufferSize) */
606 struct hpi_msg_format reserved
;
607 u32 command
; /**< HPI_BUFFER_CMD_xxx*/
608 u32 pci_address
; /**< PCI physical address of buffer for DSP DMA */
609 u32 buffer_size
; /**< must line up with data_size of HPI_DATA*/
612 /*/////////////////////////////////////////////////////////////////////////// */
613 /* This is used for background buffer bus mastering stream buffers. */
614 struct hpi_hostbuffer_status
{
615 u32 samples_processed
;
616 u32 auxiliary_data_available
;
618 /* DSP index in to the host bus master buffer. */
620 /* Host index in to the host bus master buffer. */
625 struct hpi_streamid
{
627 /**< Type of object, HPI_OBJ_OSTREAM or HPI_OBJ_ISTREAM. */
628 u16 stream_index
; /**< outstream or instream index. */
631 struct hpi_punchinout
{
633 u32 punch_out_sample
;
636 struct hpi_subsys_msg
{
637 struct hpi_resource resource
;
640 struct hpi_subsys_res
{
642 u32 data
; /* extended version */
649 union hpi_adapterx_msg
{
665 u16 offset
; /**< offset from start of msg to data */
700 struct hpi_adapter_res
{
708 u8 sz_adapter_assert
[HPI_STRING_LEN
];
711 union hpi_adapterx_res
{
712 struct hpi_adapter_res info
;
719 char sz_message
[HPI_STRING_LEN
];
741 struct hpi_stream_msg
{
743 struct hpi_msg_data data
;
744 struct hpi_data_legacy32 data32
;
746 struct hpi_punchinout pio
;
748 struct hpi_buffer buffer
;
749 struct hpi_streamid stream
;
754 struct hpi_stream_res
{
757 /* size of hardware buffer */
759 /* OutStream - data to play,
760 InStream - data recorded */
762 /* OutStream - samples played,
763 InStream - samples recorded */
764 u32 samples_transferred
;
765 /* Adapter - OutStream - data to play,
766 InStream - data recorded */
767 u32 auxiliary_data_available
;
768 u16 state
; /* HPI_STATE_PLAYING, _STATE_STOPPED */
774 u32 samples_transfered
;
779 u32 auxiliary_data_available
;
780 } legacy_stream_info
;
782 /* bitmap of grouped OutStreams */
783 u32 outstream_group_map
;
784 /* bitmap of grouped InStreams */
785 u32 instream_group_map
;
788 /* pointer to the buffer */
790 /* pointer to the hostbuffer status */
791 struct hpi_hostbuffer_status
*p_status
;
796 struct hpi_mixer_msg
{
798 u16 control_type
; /* = HPI_CONTROL_METER _VOLUME etc */
799 u16 padding1
; /* Maintain alignment of subsequent fields */
800 u16 node_type1
; /* = HPI_SOURCENODE_LINEIN etc */
801 u16 node_index1
; /* = 0..N */
804 u16 padding2
; /* round to 4 bytes */
807 struct hpi_mixer_res
{
808 u16 src_node_type
; /* = HPI_SOURCENODE_LINEIN etc */
809 u16 src_node_index
; /* = 0..N */
812 /* Also controlType for MixerGetControlByIndex */
814 /* may indicate which DSP the control is located on */
818 union hpi_mixerx_msg
{
822 u32 length_in_bytes
; /* length in bytes of p_data */
823 u32 p_data
; /* pointer to a data array */
828 } store
; /* for HPI_MIXER_STORE message */
831 union hpi_mixerx_res
{
833 u32 bytes_returned
; /* size of items returned */
834 u32 p_data
; /* pointer to data array */
835 u16 more_to_do
; /* indicates if there is more to do */
838 u32 total_controls
; /* count of controls in the mixer */
839 u32 cache_controls
; /* count of controls in the cac */
840 u32 cache_bytes
; /* size of cache */
844 struct hpi_control_msg
{
845 u16 attribute
; /* control attribute or property */
847 u32 param1
; /* generic parameter 1 */
848 u32 param2
; /* generic parameter 2 */
849 short an_log_value
[HPI_MAX_CHANNELS
];
852 struct hpi_control_union_msg
{
853 u16 attribute
; /* control attribute or property */
854 u16 saved_index
; /* only used in ctrl save/restore */
857 u32 param1
; /* generic parameter 1 */
858 u32 param2
; /* generic parameter 2 */
859 short an_log_value
[HPI_MAX_CHANNELS
];
876 struct hpi_control_res
{
877 /* Could make union. dwParam, anLogValue never used in same response */
880 short an_log_value
[HPI_MAX_CHANNELS
];
883 union hpi_control_union_res
{
887 short an_log_value
[HPI_MAX_CHANNELS
];
918 struct hpi_nvmemory_msg
{
923 struct hpi_nvmemory_res
{
928 struct hpi_gpio_msg
{
933 struct hpi_gpio_res
{
934 u16 number_input_bits
;
935 u16 number_output_bits
;
939 struct hpi_async_msg
{
945 struct hpi_async_res
{
955 struct hpi_async_event event
;
959 struct hpi_watchdog_msg
{
963 struct hpi_watchdog_res
{
967 struct hpi_clock_msg
{
974 struct hpi_clock_res
{
983 struct hpi_profile_msg
{
988 struct hpi_profile_res_open
{
992 struct hpi_profile_res_time
{
993 u32 total_tick_count
;
996 u32 ticks_per_millisecond
;
997 u16 profile_interval
;
1000 struct hpi_profile_res_name
{
1004 struct hpi_profile_res
{
1006 struct hpi_profile_res_open o
;
1007 struct hpi_profile_res_time t
;
1008 struct hpi_profile_res_name n
;
1012 struct hpi_message_header
{
1013 u16 size
; /* total size in bytes */
1014 u8 type
; /* HPI_TYPE_MESSAGE */
1015 u8 version
; /* message version */
1016 u16 object
; /* HPI_OBJ_* */
1017 u16 function
; /* HPI_SUBSYS_xxx, HPI_ADAPTER_xxx */
1018 u16 adapter_index
; /* the adapter index */
1019 u16 obj_index
; /* */
1022 struct hpi_message
{
1023 /* following fields must match HPI_MESSAGE_HEADER */
1024 u16 size
; /* total size in bytes */
1025 u8 type
; /* HPI_TYPE_MESSAGE */
1026 u8 version
; /* message version */
1027 u16 object
; /* HPI_OBJ_* */
1028 u16 function
; /* HPI_SUBSYS_xxx, HPI_ADAPTER_xxx */
1029 u16 adapter_index
; /* the adapter index */
1030 u16 obj_index
; /* */
1032 struct hpi_subsys_msg s
;
1033 union hpi_adapterx_msg ax
;
1034 struct hpi_stream_msg d
;
1035 struct hpi_mixer_msg m
;
1036 union hpi_mixerx_msg mx
; /* extended mixer; */
1037 struct hpi_control_msg c
; /* mixer control; */
1038 /* identical to struct hpi_control_msg,
1039 but field naming is improved */
1040 struct hpi_control_union_msg cu
;
1041 struct hpi_nvmemory_msg n
;
1042 struct hpi_gpio_msg l
; /* digital i/o */
1043 struct hpi_watchdog_msg w
;
1044 struct hpi_clock_msg t
; /* dsp time */
1045 struct hpi_profile_msg p
;
1046 struct hpi_async_msg as
;
1047 char fixed_size
[32];
1051 #define HPI_MESSAGE_SIZE_BY_OBJECT { \
1052 sizeof(struct hpi_message_header) , /* Default, no object type 0 */ \
1053 sizeof(struct hpi_message_header) + sizeof(struct hpi_subsys_msg),\
1054 sizeof(struct hpi_message_header) + sizeof(union hpi_adapterx_msg),\
1055 sizeof(struct hpi_message_header) + sizeof(struct hpi_stream_msg),\
1056 sizeof(struct hpi_message_header) + sizeof(struct hpi_stream_msg),\
1057 sizeof(struct hpi_message_header) + sizeof(struct hpi_mixer_msg),\
1058 sizeof(struct hpi_message_header) , /* no node message */ \
1059 sizeof(struct hpi_message_header) + sizeof(struct hpi_control_msg),\
1060 sizeof(struct hpi_message_header) + sizeof(struct hpi_nvmemory_msg),\
1061 sizeof(struct hpi_message_header) + sizeof(struct hpi_gpio_msg),\
1062 sizeof(struct hpi_message_header) + sizeof(struct hpi_watchdog_msg),\
1063 sizeof(struct hpi_message_header) + sizeof(struct hpi_clock_msg),\
1064 sizeof(struct hpi_message_header) + sizeof(struct hpi_profile_msg),\
1065 sizeof(struct hpi_message_header), /* controlx obj removed */ \
1066 sizeof(struct hpi_message_header) + sizeof(struct hpi_async_msg) \
1070 Note that the wSpecificError error field should be inspected and potentially
1071 reported whenever HPI_ERROR_DSP_COMMUNICATION or HPI_ERROR_DSP_BOOTLOAD is
1074 struct hpi_response_header
{
1076 u8 type
; /* HPI_TYPE_RESPONSE */
1077 u8 version
; /* response version */
1078 u16 object
; /* HPI_OBJ_* */
1079 u16 function
; /* HPI_SUBSYS_xxx, HPI_ADAPTER_xxx */
1080 u16 error
; /* HPI_ERROR_xxx */
1081 u16 specific_error
; /* adapter specific error */
1084 struct hpi_response
{
1085 /* following fields must match HPI_RESPONSE_HEADER */
1087 u8 type
; /* HPI_TYPE_RESPONSE */
1088 u8 version
; /* response version */
1089 u16 object
; /* HPI_OBJ_* */
1090 u16 function
; /* HPI_SUBSYS_xxx, HPI_ADAPTER_xxx */
1091 u16 error
; /* HPI_ERROR_xxx */
1092 u16 specific_error
; /* adapter specific error */
1094 struct hpi_subsys_res s
;
1095 union hpi_adapterx_res ax
;
1096 struct hpi_stream_res d
;
1097 struct hpi_mixer_res m
;
1098 union hpi_mixerx_res mx
; /* extended mixer; */
1099 struct hpi_control_res c
; /* mixer control; */
1100 /* identical to hpi_control_res, but field naming is improved */
1101 union hpi_control_union_res cu
;
1102 struct hpi_nvmemory_res n
;
1103 struct hpi_gpio_res l
; /* digital i/o */
1104 struct hpi_watchdog_res w
;
1105 struct hpi_clock_res t
; /* dsp time */
1106 struct hpi_profile_res p
;
1107 struct hpi_async_res as
;
1112 #define HPI_RESPONSE_SIZE_BY_OBJECT { \
1113 sizeof(struct hpi_response_header) ,/* Default, no object type 0 */ \
1114 sizeof(struct hpi_response_header) + sizeof(struct hpi_subsys_res),\
1115 sizeof(struct hpi_response_header) + sizeof(union hpi_adapterx_res),\
1116 sizeof(struct hpi_response_header) + sizeof(struct hpi_stream_res),\
1117 sizeof(struct hpi_response_header) + sizeof(struct hpi_stream_res),\
1118 sizeof(struct hpi_response_header) + sizeof(struct hpi_mixer_res),\
1119 sizeof(struct hpi_response_header) , /* no node response */ \
1120 sizeof(struct hpi_response_header) + sizeof(struct hpi_control_res),\
1121 sizeof(struct hpi_response_header) + sizeof(struct hpi_nvmemory_res),\
1122 sizeof(struct hpi_response_header) + sizeof(struct hpi_gpio_res),\
1123 sizeof(struct hpi_response_header) + sizeof(struct hpi_watchdog_res),\
1124 sizeof(struct hpi_response_header) + sizeof(struct hpi_clock_res),\
1125 sizeof(struct hpi_response_header) + sizeof(struct hpi_profile_res),\
1126 sizeof(struct hpi_response_header), /* controlx obj removed */ \
1127 sizeof(struct hpi_response_header) + sizeof(struct hpi_async_res) \
1130 /*********************** version 1 message/response **************************/
1131 #define HPINET_ETHERNET_DATA_SIZE (1500)
1132 #define HPINET_IP_HDR_SIZE (20)
1133 #define HPINET_IP_DATA_SIZE (HPINET_ETHERNET_DATA_SIZE - HPINET_IP_HDR_SIZE)
1134 #define HPINET_UDP_HDR_SIZE (8)
1135 #define HPINET_UDP_DATA_SIZE (HPINET_IP_DATA_SIZE - HPINET_UDP_HDR_SIZE)
1136 #define HPINET_ASI_HDR_SIZE (2)
1137 #define HPINET_ASI_DATA_SIZE (HPINET_UDP_DATA_SIZE - HPINET_ASI_HDR_SIZE)
1139 #define HPI_MAX_PAYLOAD_SIZE (HPINET_ASI_DATA_SIZE - 2)
1141 /* New style message/response, but still V0 compatible */
1142 struct hpi_msg_adapter_get_info
{
1143 struct hpi_message_header h
;
1146 struct hpi_res_adapter_get_info
{
1147 struct hpi_response_header h
; /*v0 */
1148 struct hpi_adapter_res p
;
1151 /* padding is so these are same size as v0 hpi_message */
1152 struct hpi_msg_adapter_query_flash
{
1153 struct hpi_message_header h
;
1155 u8 pad_to_version0_size
[sizeof(struct hpi_message
) - /* V0 res */
1156 sizeof(struct hpi_message_header
) - 1 * sizeof(u32
)];
1159 /* padding is so these are same size as v0 hpi_response */
1160 struct hpi_res_adapter_query_flash
{
1161 struct hpi_response_header h
;
1165 u8 pad_to_version0_size
[sizeof(struct hpi_response
) - /* V0 res */
1166 sizeof(struct hpi_response_header
) - 3 * sizeof(u32
)];
1169 struct hpi_msg_adapter_start_flash
{
1170 struct hpi_message_header h
;
1174 u8 pad_to_version0_size
[sizeof(struct hpi_message
) - /* V0 res */
1175 sizeof(struct hpi_message_header
) - 3 * sizeof(u32
)];
1178 struct hpi_res_adapter_start_flash
{
1179 struct hpi_response_header h
;
1180 u8 pad_to_version0_size
[sizeof(struct hpi_response
) - /* V0 res */
1181 sizeof(struct hpi_response_header
)];
1184 struct hpi_msg_adapter_program_flash_payload
{
1188 u16 offset
; /**< offset from start of msg to data */
1190 /* ensure sizeof(header + payload) == sizeof(hpi_message_V0)
1191 because old firmware expects data after message of this size */
1192 u8 pad_to_version0_size
[sizeof(struct hpi_message
) - /* V0 message */
1193 sizeof(struct hpi_message_header
) - sizeof(u32
) -
1197 struct hpi_msg_adapter_program_flash
{
1198 struct hpi_message_header h
;
1199 struct hpi_msg_adapter_program_flash_payload p
;
1203 struct hpi_res_adapter_program_flash
{
1204 struct hpi_response_header h
;
1206 u8 pad_to_version0_size
[sizeof(struct hpi_response
) - /* V0 res */
1207 sizeof(struct hpi_response_header
) - sizeof(u16
)];
1210 struct hpi_msg_adapter_debug_read
{
1211 struct hpi_message_header h
;
1216 struct hpi_res_adapter_debug_read
{
1217 struct hpi_response_header h
;
1221 struct hpi_msg_cobranet_hmi
{
1228 struct hpi_msg_cobranet_hmiwrite
{
1229 struct hpi_message_header h
;
1230 struct hpi_msg_cobranet_hmi p
;
1234 struct hpi_msg_cobranet_hmiread
{
1235 struct hpi_message_header h
;
1236 struct hpi_msg_cobranet_hmi p
;
1239 struct hpi_res_cobranet_hmiread
{
1240 struct hpi_response_header h
;
1246 #define hpi_message_header_v1 hpi_message_header
1247 #define hpi_response_header_v1 hpi_response_header
1249 /* V1 headers in Addition to v0 headers */
1250 struct hpi_message_header_v1
{
1251 struct hpi_message_header h0
;
1256 struct hpi_response_header_v1
{
1257 struct hpi_response_header h0
;
1259 u16 adapter_index
; /* the adapter index */
1260 u16 obj_index
; /* object index */
1265 struct hpi_msg_payload_v0
{
1266 struct hpi_message_header h
;
1268 struct hpi_subsys_msg s
;
1269 union hpi_adapterx_msg ax
;
1270 struct hpi_stream_msg d
;
1271 struct hpi_mixer_msg m
;
1272 union hpi_mixerx_msg mx
;
1273 struct hpi_control_msg c
;
1274 struct hpi_control_union_msg cu
;
1275 struct hpi_nvmemory_msg n
;
1276 struct hpi_gpio_msg l
;
1277 struct hpi_watchdog_msg w
;
1278 struct hpi_clock_msg t
;
1279 struct hpi_profile_msg p
;
1280 struct hpi_async_msg as
;
1284 struct hpi_res_payload_v0
{
1285 struct hpi_response_header h
;
1287 struct hpi_subsys_res s
;
1288 union hpi_adapterx_res ax
;
1289 struct hpi_stream_res d
;
1290 struct hpi_mixer_res m
;
1291 union hpi_mixerx_res mx
;
1292 struct hpi_control_res c
;
1293 union hpi_control_union_res cu
;
1294 struct hpi_nvmemory_res n
;
1295 struct hpi_gpio_res l
;
1296 struct hpi_watchdog_res w
;
1297 struct hpi_clock_res t
;
1298 struct hpi_profile_res p
;
1299 struct hpi_async_res as
;
1303 union hpi_message_buffer_v1
{
1304 struct hpi_message m0
; /* version 0 */
1305 struct hpi_message_header_v1 h
;
1306 u8 buf
[HPI_MAX_PAYLOAD_SIZE
];
1309 union hpi_response_buffer_v1
{
1310 struct hpi_response r0
; /* version 0 */
1311 struct hpi_response_header_v1 h
;
1312 u8 buf
[HPI_MAX_PAYLOAD_SIZE
];
1315 compile_time_assert((sizeof(union hpi_message_buffer_v1
) <=
1316 HPI_MAX_PAYLOAD_SIZE
), message_buffer_ok
);
1317 compile_time_assert((sizeof(union hpi_response_buffer_v1
) <=
1318 HPI_MAX_PAYLOAD_SIZE
), response_buffer_ok
);
1320 /*////////////////////////////////////////////////////////////////////////// */
1321 /* declarations for compact control calls */
1322 struct hpi_control_defn
{
1331 /*////////////////////////////////////////////////////////////////////////// */
1332 /* declarations for control caching (internal to HPI<->DSP interaction) */
1334 /** indicates a cached u16 value is invalid. */
1335 #define HPI_CACHE_INVALID_UINT16 0xFFFF
1336 /** indicates a cached short value is invalid. */
1337 #define HPI_CACHE_INVALID_SHORT -32768
1339 /** A compact representation of (part of) a controls state.
1340 Used for efficient transfer of the control state
1341 between DSP and host or across a network
1343 struct hpi_control_cache_info
{
1344 /** one of HPI_CONTROL_* */
1346 /** The total size of cached information in 32-bit words. */
1347 u8 size_in32bit_words
;
1348 /** The original index of the control on the DSP */
1352 struct hpi_control_cache_vol
{
1353 struct hpi_control_cache_info i
;
1355 unsigned short flags
;
1359 struct hpi_control_cache_meter
{
1360 struct hpi_control_cache_info i
;
1361 short an_log_peak
[2];
1365 struct hpi_control_cache_channelmode
{
1366 struct hpi_control_cache_info i
;
1368 char temp_padding
[6];
1371 struct hpi_control_cache_mux
{
1372 struct hpi_control_cache_info i
;
1373 u16 source_node_type
;
1374 u16 source_node_index
;
1375 char temp_padding
[4];
1378 struct hpi_control_cache_level
{
1379 struct hpi_control_cache_info i
;
1381 char temp_padding
[4];
1384 struct hpi_control_cache_tuner
{
1385 struct hpi_control_cache_info i
;
1391 struct hpi_control_cache_aes3rx
{
1392 struct hpi_control_cache_info i
;
1397 struct hpi_control_cache_aes3tx
{
1398 struct hpi_control_cache_info i
;
1400 char temp_padding
[4];
1403 struct hpi_control_cache_tonedetector
{
1404 struct hpi_control_cache_info i
;
1406 char temp_padding
[6];
1409 struct hpi_control_cache_silencedetector
{
1410 struct hpi_control_cache_info i
;
1412 char temp_padding
[4];
1415 struct hpi_control_cache_sampleclock
{
1416 struct hpi_control_cache_info i
;
1422 struct hpi_control_cache_microphone
{
1423 struct hpi_control_cache_info i
;
1425 char temp_padding
[6];
1428 struct hpi_control_cache_single
{
1430 struct hpi_control_cache_info i
;
1431 struct hpi_control_cache_vol vol
;
1432 struct hpi_control_cache_meter meter
;
1433 struct hpi_control_cache_channelmode mode
;
1434 struct hpi_control_cache_mux mux
;
1435 struct hpi_control_cache_level level
;
1436 struct hpi_control_cache_tuner tuner
;
1437 struct hpi_control_cache_aes3rx aes3rx
;
1438 struct hpi_control_cache_aes3tx aes3tx
;
1439 struct hpi_control_cache_tonedetector tone
;
1440 struct hpi_control_cache_silencedetector silence
;
1441 struct hpi_control_cache_sampleclock clk
;
1442 struct hpi_control_cache_microphone microphone
;
1446 struct hpi_control_cache_pad
{
1447 struct hpi_control_cache_info i
;
1448 u32 field_valid_flags
;
1455 u32 traffic_supported
;
1456 u32 traffic_anouncement
;
1459 /* 2^N sized FIFO buffer (internal to HPI<->DSP interaction) */
1460 struct hpi_fifo_buffer
{
1466 #ifndef DISABLE_PRAGMA_PACK1
1470 /* skip host side function declarations for DSP
1471 compile and documentation extraction */
1473 char hpi_handle_object(const u32 handle
);
1475 void hpi_handle_to_indexes(const u32 handle
, u16
*pw_adapter_index
,
1476 u16
*pw_object_index
);
1478 u32
hpi_indexes_to_handle(const char c_object
, const u16 adapter_index
,
1479 const u16 object_index
);
1481 /*////////////////////////////////////////////////////////////////////////// */
1483 /* main HPI entry point */
1484 void hpi_send_recv(struct hpi_message
*phm
, struct hpi_response
*phr
);
1486 /* used in PnP OS/driver */
1487 u16
hpi_subsys_create_adapter(const struct hpi_resource
*p_resource
,
1488 u16
*pw_adapter_index
);
1490 u16
hpi_outstream_host_buffer_get_info(u32 h_outstream
, u8
**pp_buffer
,
1491 struct hpi_hostbuffer_status
**pp_status
);
1493 u16
hpi_instream_host_buffer_get_info(u32 h_instream
, u8
**pp_buffer
,
1494 struct hpi_hostbuffer_status
**pp_status
);
1496 u16
hpi_adapter_restart(u16 adapter_index
);
1499 The following 3 functions were last declared in header files for
1500 driver 3.10. HPI_ControlQuery() used to be the recommended way
1501 of getting a volume range. Declared here for binary asihpi32.dll
1505 void hpi_format_to_msg(struct hpi_msg_format
*pMF
,
1506 const struct hpi_format
*pF
);
1507 void hpi_stream_response_to_legacy(struct hpi_stream_res
*pSR
);
1509 /*////////////////////////////////////////////////////////////////////////// */
1510 /* declarations for individual HPI entry points */
1511 hpi_handler_func HPI_6000
;
1512 hpi_handler_func HPI_6205
;
1514 #endif /* _HPI_INTERNAL_H_ */