projects / deliverable / linux.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
ALSA: asihpi - Remove unused subsys pointer from all HPI functions.
[deliverable/linux.git] / sound / pci / asihpi / hpi_internal.h
CommitLineData
719f82d3
EB		 1/******************************************************************************
2
3 AudioScience HPI driver
4 Copyright (C) 1997-2010 AudioScience Inc. <support@audioscience.com>
5
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;
9
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.
14
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
18
19HPI internal definitions
20
21(C) Copyright AudioScience Inc. 1996-2009
22******************************************************************************/
23
24#ifndef _HPI_INTERNAL_H_
25#define _HPI_INTERNAL_H_
26
27#include "hpi.h"
28/** maximum number of memory regions mapped to an adapter */
29#define HPI_MAX_ADAPTER_MEM_SPACES (2)
30
3285ea10 31/* Each OS needs its own hpios.h */
719f82d3
EB		 32#include "hpios.h"
33
34/* physical memory allocation */
35void hpios_locked_mem_init(void
36 );
37void hpios_locked_mem_free_all(void
38 );
39#define hpios_locked_mem_prepare(a, b, c, d);
40#define hpios_locked_mem_unprepare(a)
41
42/** Allocate and map an area of locked memory for bus master DMA operations.
43
44On success, *pLockedMemeHandle is a valid handle, and 0 is returned
45On error *pLockedMemHandle marked invalid, non-zero returned.
46
47If this function succeeds, then HpiOs_LockedMem_GetVirtAddr() and
48HpiOs_LockedMem_GetPyhsAddr() will always succed on the returned handle.
49*/
50u16 hpios_locked_mem_alloc(struct consistent_dma_area *p_locked_mem_handle,
51 /**< memory handle */
3285ea10 52 u32 size, /**< Size in bytes to allocate */
719f82d3
EB		 53 struct pci_dev *p_os_reference
54 /**< OS specific data required for memory allocation */
55 );
56
57/** Free mapping and memory represented by LockedMemHandle
58
59Frees any resources, then invalidates the handle.
60Returns 0 on success, 1 if handle is invalid.
61
62*/
63u16 hpios_locked_mem_free(struct consistent_dma_area *locked_mem_handle);
64
65/** Get the physical PCI address of memory represented by LockedMemHandle.
66
67If handle is invalid *pPhysicalAddr is set to zero and return 1
68*/
69u16 hpios_locked_mem_get_phys_addr(struct consistent_dma_area
70 *locked_mem_handle, u32 *p_physical_addr);
71
72/** Get the CPU address of of memory represented by LockedMemHandle.
73
74If handle is NULL *ppvVirtualAddr is set to NULL and return 1
75*/
76u16 hpios_locked_mem_get_virt_addr(struct consistent_dma_area
77 *locked_mem_handle, void **ppv_virtual_addr);
78
79/** Check that handle is valid
80i.e it represents a valid memory area
81*/
82u16 hpios_locked_mem_valid(struct consistent_dma_area *locked_mem_handle);
83
84/* timing/delay */
85void hpios_delay_micro_seconds(u32 num_micro_sec);
86
87struct hpi_message;
88struct hpi_response;
89
90typedef void hpi_handler_func(struct hpi_message *, struct hpi_response *);
91
92/* If the assert fails, compiler complains
93 something like size of array `msg' is negative.
94 Unlike linux BUILD_BUG_ON, this works outside function scope.
95*/
96#define compile_time_assert(cond, msg) \
97 typedef char ASSERT_##msg[(cond) ? 1 : -1]
98
719f82d3
EB		 99/******************************************* bus types */
100enum HPI_BUSES {
101 HPI_BUS_ISAPNP = 1,
102 HPI_BUS_PCI = 2,
103 HPI_BUS_USB = 3,
104 HPI_BUS_NET = 4
105};
106
ba94455c
EB		 107enum HPI_SUBSYS_OPTIONS {
108 /* 0, 256 are invalid, 1..255 reserved for global options */
109 HPI_SUBSYS_OPT_NET_ENABLE = 257,
110 HPI_SUBSYS_OPT_NET_BROADCAST = 258,
111 HPI_SUBSYS_OPT_NET_UNICAST = 259,
112 HPI_SUBSYS_OPT_NET_ADDR = 260,
113 HPI_SUBSYS_OPT_NET_MASK = 261,
114 HPI_SUBSYS_OPT_NET_ADAPTER_ADDRESS_ADD = 262
115};
116
719f82d3
EB		 117/******************************************* CONTROL ATTRIBUTES ****/
118/* (in order of control type ID */
119
108ccb3f 120/* This allows for 255 control types, 256 unique attributes each */
3285ea10 121#define HPI_CTL_ATTR(ctl, ai) ((HPI_CONTROL_##ctl << 8) + ai)
719f82d3
EB		 122
123/* Get the sub-index of the attribute for a control type */
3285ea10 124#define HPI_CTL_ATTR_INDEX(i) (i & 0xff)
719f82d3 125
108ccb3f 126/* Extract the control from the control attribute */
3285ea10 127#define HPI_CTL_ATTR_CONTROL(i) (i >> 8)
719f82d3
EB		 128
129/** Enable event generation for a control.
1300=disable, 1=enable
131\note generic to all controls that can generate events
132*/
3285ea10
EB		 133
134/** Unique identifiers for every control attribute
719f82d3 135*/
3285ea10
EB		 136enum HPI_CONTROL_ATTRIBUTES {
137 HPI_GENERIC_ENABLE = HPI_CTL_ATTR(GENERIC, 1),
138 HPI_GENERIC_EVENT_ENABLE = HPI_CTL_ATTR(GENERIC, 2),
139
140 HPI_VOLUME_GAIN = HPI_CTL_ATTR(VOLUME, 1),
141 HPI_VOLUME_AUTOFADE = HPI_CTL_ATTR(VOLUME, 2),
142 HPI_VOLUME_NUM_CHANNELS = HPI_CTL_ATTR(VOLUME, 6),
143 HPI_VOLUME_RANGE = HPI_CTL_ATTR(VOLUME, 10),
144
145 HPI_METER_RMS = HPI_CTL_ATTR(METER, 1),
146 HPI_METER_PEAK = HPI_CTL_ATTR(METER, 2),
147 HPI_METER_RMS_BALLISTICS = HPI_CTL_ATTR(METER, 3),
148 HPI_METER_PEAK_BALLISTICS = HPI_CTL_ATTR(METER, 4),
149 HPI_METER_NUM_CHANNELS = HPI_CTL_ATTR(METER, 5),
150
151 HPI_MULTIPLEXER_SOURCE = HPI_CTL_ATTR(MULTIPLEXER, 1),
152 HPI_MULTIPLEXER_QUERYSOURCE = HPI_CTL_ATTR(MULTIPLEXER, 2),
153
154 HPI_AESEBUTX_FORMAT = HPI_CTL_ATTR(AESEBUTX, 1),
155 HPI_AESEBUTX_SAMPLERATE = HPI_CTL_ATTR(AESEBUTX, 3),
156 HPI_AESEBUTX_CHANNELSTATUS = HPI_CTL_ATTR(AESEBUTX, 4),
157 HPI_AESEBUTX_USERDATA = HPI_CTL_ATTR(AESEBUTX, 5),
158
159 HPI_AESEBURX_FORMAT = HPI_CTL_ATTR(AESEBURX, 1),
160 HPI_AESEBURX_ERRORSTATUS = HPI_CTL_ATTR(AESEBURX, 2),
161 HPI_AESEBURX_SAMPLERATE = HPI_CTL_ATTR(AESEBURX, 3),
162 HPI_AESEBURX_CHANNELSTATUS = HPI_CTL_ATTR(AESEBURX, 4),
163 HPI_AESEBURX_USERDATA = HPI_CTL_ATTR(AESEBURX, 5),
164
165 HPI_LEVEL_GAIN = HPI_CTL_ATTR(LEVEL, 1),
166 HPI_LEVEL_RANGE = HPI_CTL_ATTR(LEVEL, 10),
167
168 HPI_TUNER_BAND = HPI_CTL_ATTR(TUNER, 1),
169 HPI_TUNER_FREQ = HPI_CTL_ATTR(TUNER, 2),
170 HPI_TUNER_LEVEL_AVG = HPI_CTL_ATTR(TUNER, 3),
171 HPI_TUNER_LEVEL_RAW = HPI_CTL_ATTR(TUNER, 4),
172 HPI_TUNER_SNR = HPI_CTL_ATTR(TUNER, 5),
173 HPI_TUNER_GAIN = HPI_CTL_ATTR(TUNER, 6),
174 HPI_TUNER_STATUS = HPI_CTL_ATTR(TUNER, 7),
175 HPI_TUNER_MODE = HPI_CTL_ATTR(TUNER, 8),
176 HPI_TUNER_RDS = HPI_CTL_ATTR(TUNER, 9),
177 HPI_TUNER_DEEMPHASIS = HPI_CTL_ATTR(TUNER, 10),
178 HPI_TUNER_PROGRAM = HPI_CTL_ATTR(TUNER, 11),
179 HPI_TUNER_HDRADIO_SIGNAL_QUALITY = HPI_CTL_ATTR(TUNER, 12),
180 HPI_TUNER_HDRADIO_SDK_VERSION = HPI_CTL_ATTR(TUNER, 13),
181 HPI_TUNER_HDRADIO_DSP_VERSION = HPI_CTL_ATTR(TUNER, 14),
182 HPI_TUNER_HDRADIO_BLEND = HPI_CTL_ATTR(TUNER, 15),
183
184 HPI_VOX_THRESHOLD = HPI_CTL_ATTR(VOX, 1),
185
186 HPI_CHANNEL_MODE_MODE = HPI_CTL_ATTR(CHANNEL_MODE, 1),
187
188 HPI_BITSTREAM_DATA_POLARITY = HPI_CTL_ATTR(BITSTREAM, 1),
189 HPI_BITSTREAM_CLOCK_EDGE = HPI_CTL_ATTR(BITSTREAM, 2),
190 HPI_BITSTREAM_CLOCK_SOURCE = HPI_CTL_ATTR(BITSTREAM, 3),
191 HPI_BITSTREAM_ACTIVITY = HPI_CTL_ATTR(BITSTREAM, 4),
192
193 HPI_SAMPLECLOCK_SOURCE = HPI_CTL_ATTR(SAMPLECLOCK, 1),
194 HPI_SAMPLECLOCK_SAMPLERATE = HPI_CTL_ATTR(SAMPLECLOCK, 2),
195 HPI_SAMPLECLOCK_SOURCE_INDEX = HPI_CTL_ATTR(SAMPLECLOCK, 3),
196 HPI_SAMPLECLOCK_LOCAL_SAMPLERATE = HPI_CTL_ATTR(SAMPLECLOCK, 4),
197 HPI_SAMPLECLOCK_AUTO = HPI_CTL_ATTR(SAMPLECLOCK, 5),
198 HPI_SAMPLECLOCK_LOCAL_LOCK = HPI_CTL_ATTR(SAMPLECLOCK, 6),
199
200 HPI_MICROPHONE_PHANTOM_POWER = HPI_CTL_ATTR(MICROPHONE, 1),
201
202 HPI_EQUALIZER_NUM_FILTERS = HPI_CTL_ATTR(EQUALIZER, 1),
203 HPI_EQUALIZER_FILTER = HPI_CTL_ATTR(EQUALIZER, 2),
204 HPI_EQUALIZER_COEFFICIENTS = HPI_CTL_ATTR(EQUALIZER, 3),
205
206 HPI_COMPANDER_PARAMS = HPI_CTL_ATTR(COMPANDER, 1),
207 HPI_COMPANDER_MAKEUPGAIN = HPI_CTL_ATTR(COMPANDER, 2),
208 HPI_COMPANDER_THRESHOLD = HPI_CTL_ATTR(COMPANDER, 3),
209 HPI_COMPANDER_RATIO = HPI_CTL_ATTR(COMPANDER, 4),
210 HPI_COMPANDER_ATTACK = HPI_CTL_ATTR(COMPANDER, 5),
211 HPI_COMPANDER_DECAY = HPI_CTL_ATTR(COMPANDER, 6),
212
213 HPI_COBRANET_SET = HPI_CTL_ATTR(COBRANET, 1),
214 HPI_COBRANET_GET = HPI_CTL_ATTR(COBRANET, 2),
215 HPI_COBRANET_SET_DATA = HPI_CTL_ATTR(COBRANET, 3),
216 HPI_COBRANET_GET_DATA = HPI_CTL_ATTR(COBRANET, 4),
217 HPI_COBRANET_GET_STATUS = HPI_CTL_ATTR(COBRANET, 5),
218 HPI_COBRANET_SEND_PACKET = HPI_CTL_ATTR(COBRANET, 6),
219 HPI_COBRANET_GET_PACKET = HPI_CTL_ATTR(COBRANET, 7),
220
221 HPI_TONEDETECTOR_THRESHOLD = HPI_CTL_ATTR(TONEDETECTOR, 1),
222 HPI_TONEDETECTOR_STATE = HPI_CTL_ATTR(TONEDETECTOR, 2),
223 HPI_TONEDETECTOR_FREQUENCY = HPI_CTL_ATTR(TONEDETECTOR, 3),
224
225 HPI_SILENCEDETECTOR_THRESHOLD = HPI_CTL_ATTR(SILENCEDETECTOR, 1),
226 HPI_SILENCEDETECTOR_STATE = HPI_CTL_ATTR(SILENCEDETECTOR, 2),
227 HPI_SILENCEDETECTOR_DELAY = HPI_CTL_ATTR(SILENCEDETECTOR, 3),
228
229 HPI_PAD_CHANNEL_NAME = HPI_CTL_ATTR(PAD, 1),
230 HPI_PAD_ARTIST = HPI_CTL_ATTR(PAD, 2),
231 HPI_PAD_TITLE = HPI_CTL_ATTR(PAD, 3),
232 HPI_PAD_COMMENT = HPI_CTL_ATTR(PAD, 4),
233 HPI_PAD_PROGRAM_TYPE = HPI_CTL_ATTR(PAD, 5),
234 HPI_PAD_PROGRAM_ID = HPI_CTL_ATTR(PAD, 6),
235 HPI_PAD_TA_SUPPORT = HPI_CTL_ATTR(PAD, 7),
236 HPI_PAD_TA_ACTIVE = HPI_CTL_ATTR(PAD, 8)
237};
719f82d3
EB		 238
239#define HPI_POLARITY_POSITIVE 0
240#define HPI_POLARITY_NEGATIVE 1
241
719f82d3
EB		 242/*------------------------------------------------------------
243 Cobranet Chip Bridge - copied from HMI.H
244------------------------------------------------------------*/
245#define HPI_COBRANET_HMI_cobra_bridge 0x20000
246#define HPI_COBRANET_HMI_cobra_bridge_tx_pkt_buf \
247 (HPI_COBRANET_HMI_cobra_bridge + 0x1000)
248#define HPI_COBRANET_HMI_cobra_bridge_rx_pkt_buf \
249 (HPI_COBRANET_HMI_cobra_bridge + 0x2000)
250#define HPI_COBRANET_HMI_cobra_if_table1 0x110000
251#define HPI_COBRANET_HMI_cobra_if_phy_address \
252 (HPI_COBRANET_HMI_cobra_if_table1 + 0xd)
253#define HPI_COBRANET_HMI_cobra_protocolIP 0x72000
254#define HPI_COBRANET_HMI_cobra_ip_mon_currentIP \
255 (HPI_COBRANET_HMI_cobra_protocolIP + 0x0)
256#define HPI_COBRANET_HMI_cobra_ip_mon_staticIP \
257 (HPI_COBRANET_HMI_cobra_protocolIP + 0x2)
258#define HPI_COBRANET_HMI_cobra_sys 0x100000
259#define HPI_COBRANET_HMI_cobra_sys_desc \
260 (HPI_COBRANET_HMI_cobra_sys + 0x0)
261#define HPI_COBRANET_HMI_cobra_sys_objectID \
262 (HPI_COBRANET_HMI_cobra_sys + 0x100)
263#define HPI_COBRANET_HMI_cobra_sys_contact \
264 (HPI_COBRANET_HMI_cobra_sys + 0x200)
265#define HPI_COBRANET_HMI_cobra_sys_name \
266 (HPI_COBRANET_HMI_cobra_sys + 0x300)
267#define HPI_COBRANET_HMI_cobra_sys_location \
268 (HPI_COBRANET_HMI_cobra_sys + 0x400)
269
270/*------------------------------------------------------------
271 Cobranet Chip Status bits
272------------------------------------------------------------*/
273#define HPI_COBRANET_HMI_STATUS_RXPACKET 2
274#define HPI_COBRANET_HMI_STATUS_TXPACKET 3
275
276/*------------------------------------------------------------
277 Ethernet header size
278------------------------------------------------------------*/
279#define HPI_ETHERNET_HEADER_SIZE (16)
280
281/* These defines are used to fill in protocol information for an Ethernet packet
282 sent using HMI on CS18102 */
283/** ID supplied by Cirrius for ASI packets. */
284#define HPI_ETHERNET_PACKET_ID 0x85
285/** Simple packet - no special routing required */
286#define HPI_ETHERNET_PACKET_V1 0x01
287/** This packet must make its way to the host across the HPI interface */
288#define HPI_ETHERNET_PACKET_HOSTED_VIA_HMI 0x20
289/** This packet must make its way to the host across the HPI interface */
290#define HPI_ETHERNET_PACKET_HOSTED_VIA_HMI_V1 0x21
291/** This packet must make its way to the host across the HPI interface */
292#define HPI_ETHERNET_PACKET_HOSTED_VIA_HPI 0x40
293/** This packet must make its way to the host across the HPI interface */
294#define HPI_ETHERNET_PACKET_HOSTED_VIA_HPI_V1 0x41
295
296#define HPI_ETHERNET_UDP_PORT (44600) /*!< UDP messaging port */
297
298/** Base network time out is set to 100 milli-seconds. */
299#define HPI_ETHERNET_TIMEOUT_MS (100)
300
3285ea10
EB		 301/** Locked memory buffer alloc/free phases */
302enum HPI_BUFFER_CMDS {
303 /** use one message to allocate or free physical memory */
304 HPI_BUFFER_CMD_EXTERNAL = 0,
305 /** alloc physical memory */
306 HPI_BUFFER_CMD_INTERNAL_ALLOC = 1,
307 /** send physical memory address to adapter */
308 HPI_BUFFER_CMD_INTERNAL_GRANTADAPTER = 2,
309 /** notify adapter to stop using physical buffer */
310 HPI_BUFFER_CMD_INTERNAL_REVOKEADAPTER = 3,
311 /** free physical buffer */
312 HPI_BUFFER_CMD_INTERNAL_FREE = 4
313};
719f82d3
EB		 314
315/*****************************************************************************/
316/*****************************************************************************/
317/******** HPI LOW LEVEL MESSAGES *******/
318/*****************************************************************************/
319/*****************************************************************************/
320/** Pnp ids */
321/** "ASI" - actual is "ASX" - need to change */
322#define HPI_ID_ISAPNP_AUDIOSCIENCE 0x0669
323/** PCI vendor ID that AudioScience uses */
324#define HPI_PCI_VENDOR_ID_AUDIOSCIENCE 0x175C
325/** PCI vendor ID that the DSP56301 has */
326#define HPI_PCI_VENDOR_ID_MOTOROLA 0x1057
327/** PCI vendor ID that TI uses */
328#define HPI_PCI_VENDOR_ID_TI 0x104C
329
330#define HPI_PCI_DEV_ID_PCI2040 0xAC60
331/** TI's C6205 PCI interface has this ID */
332#define HPI_PCI_DEV_ID_DSP6205 0xA106
333
334#define HPI_USB_VENDOR_ID_AUDIOSCIENCE 0x1257
335#define HPI_USB_W2K_TAG 0x57495341 /* "ASIW" */
336#define HPI_USB_LINUX_TAG 0x4C495341 /* "ASIL" */
337
3285ea10
EB		 338/** Invalid Adapter index
339Used in HPI messages that are not addressed to a specific adapter
340Used in DLL to indicate device not present
341*/
342#define HPI_ADAPTER_INDEX_INVALID 0xFFFF
343
719f82d3
EB		 344/** First 2 hex digits define the adapter family */
345#define HPI_ADAPTER_FAMILY_MASK 0xff00
5a498ef1 346#define HPI_MODULE_FAMILY_MASK 0xfff0
719f82d3
EB		 347
348#define HPI_ADAPTER_FAMILY_ASI(f) (f & HPI_ADAPTER_FAMILY_MASK)
5a498ef1 349#define HPI_MODULE_FAMILY_ASI(f) (f & HPI_MODULE_FAMILY_MASK)
719f82d3
EB		 350#define HPI_ADAPTER_ASI(f) (f)
351
3285ea10
EB		 352enum HPI_MESSAGE_TYPES {
353 HPI_TYPE_MESSAGE = 1,
354 HPI_TYPE_RESPONSE = 2,
355 HPI_TYPE_DATA = 3,
356 HPI_TYPE_SSX2BYPASS_MESSAGE = 4
357};
358
359enum HPI_OBJECT_TYPES {
360 HPI_OBJ_SUBSYSTEM = 1,
361 HPI_OBJ_ADAPTER = 2,
362 HPI_OBJ_OSTREAM = 3,
363 HPI_OBJ_ISTREAM = 4,
364 HPI_OBJ_MIXER = 5,
365 HPI_OBJ_NODE = 6,
366 HPI_OBJ_CONTROL = 7,
367 HPI_OBJ_NVMEMORY = 8,
368 HPI_OBJ_GPIO = 9,
369 HPI_OBJ_WATCHDOG = 10,
370 HPI_OBJ_CLOCK = 11,
371 HPI_OBJ_PROFILE = 12,
372 HPI_OBJ_CONTROLEX = 13,
373 HPI_OBJ_ASYNCEVENT = 14
374#define HPI_OBJ_MAXINDEX 14
375};
376
377#define HPI_OBJ_FUNCTION_SPACING 0x100
ba94455c
EB		 378#define HPI_FUNC_ID(obj, index) \
379 (HPI_OBJ_##obj * HPI_OBJ_FUNCTION_SPACING + index)
3285ea10 380
719f82d3
EB		 381#define HPI_EXTRACT_INDEX(fn) (fn & 0xff)
382
3285ea10
EB		 383enum HPI_FUNCTION_IDS {
384 HPI_SUBSYS_OPEN = HPI_FUNC_ID(SUBSYSTEM, 1),
385 HPI_SUBSYS_GET_VERSION = HPI_FUNC_ID(SUBSYSTEM, 2),
386 HPI_SUBSYS_GET_INFO = HPI_FUNC_ID(SUBSYSTEM, 3),
387 HPI_SUBSYS_FIND_ADAPTERS = HPI_FUNC_ID(SUBSYSTEM, 4),
388 HPI_SUBSYS_CREATE_ADAPTER = HPI_FUNC_ID(SUBSYSTEM, 5),
389 HPI_SUBSYS_CLOSE = HPI_FUNC_ID(SUBSYSTEM, 6),
390 HPI_SUBSYS_DELETE_ADAPTER = HPI_FUNC_ID(SUBSYSTEM, 7),
391 HPI_SUBSYS_DRIVER_LOAD = HPI_FUNC_ID(SUBSYSTEM, 8),
392 HPI_SUBSYS_DRIVER_UNLOAD = HPI_FUNC_ID(SUBSYSTEM, 9),
393 HPI_SUBSYS_READ_PORT_8 = HPI_FUNC_ID(SUBSYSTEM, 10),
394 HPI_SUBSYS_WRITE_PORT_8 = HPI_FUNC_ID(SUBSYSTEM, 11),
395 HPI_SUBSYS_GET_NUM_ADAPTERS = HPI_FUNC_ID(SUBSYSTEM, 12),
396 HPI_SUBSYS_GET_ADAPTER = HPI_FUNC_ID(SUBSYSTEM, 13),
397 HPI_SUBSYS_SET_NETWORK_INTERFACE = HPI_FUNC_ID(SUBSYSTEM, 14),
398 HPI_SUBSYS_OPTION_INFO = HPI_FUNC_ID(SUBSYSTEM, 15),
399 HPI_SUBSYS_OPTION_GET = HPI_FUNC_ID(SUBSYSTEM, 16),
400 HPI_SUBSYS_OPTION_SET = HPI_FUNC_ID(SUBSYSTEM, 17),
401#define HPI_SUBSYS_FUNCTION_COUNT 17
402
403 HPI_ADAPTER_OPEN = HPI_FUNC_ID(ADAPTER, 1),
404 HPI_ADAPTER_CLOSE = HPI_FUNC_ID(ADAPTER, 2),
405 HPI_ADAPTER_GET_INFO = HPI_FUNC_ID(ADAPTER, 3),
406 HPI_ADAPTER_GET_ASSERT = HPI_FUNC_ID(ADAPTER, 4),
407 HPI_ADAPTER_TEST_ASSERT = HPI_FUNC_ID(ADAPTER, 5),
408 HPI_ADAPTER_SET_MODE = HPI_FUNC_ID(ADAPTER, 6),
409 HPI_ADAPTER_GET_MODE = HPI_FUNC_ID(ADAPTER, 7),
410 HPI_ADAPTER_ENABLE_CAPABILITY = HPI_FUNC_ID(ADAPTER, 8),
411 HPI_ADAPTER_SELFTEST = HPI_FUNC_ID(ADAPTER, 9),
412 HPI_ADAPTER_FIND_OBJECT = HPI_FUNC_ID(ADAPTER, 10),
413 HPI_ADAPTER_QUERY_FLASH = HPI_FUNC_ID(ADAPTER, 11),
414 HPI_ADAPTER_START_FLASH = HPI_FUNC_ID(ADAPTER, 12),
415 HPI_ADAPTER_PROGRAM_FLASH = HPI_FUNC_ID(ADAPTER, 13),
416 HPI_ADAPTER_SET_PROPERTY = HPI_FUNC_ID(ADAPTER, 14),
417 HPI_ADAPTER_GET_PROPERTY = HPI_FUNC_ID(ADAPTER, 15),
418 HPI_ADAPTER_ENUM_PROPERTY = HPI_FUNC_ID(ADAPTER, 16),
419 HPI_ADAPTER_MODULE_INFO = HPI_FUNC_ID(ADAPTER, 17),
420 HPI_ADAPTER_DEBUG_READ = HPI_FUNC_ID(ADAPTER, 18),
719f82d3 421#define HPI_ADAPTER_FUNCTION_COUNT 18
3285ea10
EB		 422
423 HPI_OSTREAM_OPEN = HPI_FUNC_ID(OSTREAM, 1),
424 HPI_OSTREAM_CLOSE = HPI_FUNC_ID(OSTREAM, 2),
425 HPI_OSTREAM_WRITE = HPI_FUNC_ID(OSTREAM, 3),
426 HPI_OSTREAM_START = HPI_FUNC_ID(OSTREAM, 4),
427 HPI_OSTREAM_STOP = HPI_FUNC_ID(OSTREAM, 5),
428 HPI_OSTREAM_RESET = HPI_FUNC_ID(OSTREAM, 6),
429 HPI_OSTREAM_GET_INFO = HPI_FUNC_ID(OSTREAM, 7),
430 HPI_OSTREAM_QUERY_FORMAT = HPI_FUNC_ID(OSTREAM, 8),
431 HPI_OSTREAM_DATA = HPI_FUNC_ID(OSTREAM, 9),
432 HPI_OSTREAM_SET_VELOCITY = HPI_FUNC_ID(OSTREAM, 10),
433 HPI_OSTREAM_SET_PUNCHINOUT = HPI_FUNC_ID(OSTREAM, 11),
434 HPI_OSTREAM_SINEGEN = HPI_FUNC_ID(OSTREAM, 12),
435 HPI_OSTREAM_ANC_RESET = HPI_FUNC_ID(OSTREAM, 13),
436 HPI_OSTREAM_ANC_GET_INFO = HPI_FUNC_ID(OSTREAM, 14),
437 HPI_OSTREAM_ANC_READ = HPI_FUNC_ID(OSTREAM, 15),
438 HPI_OSTREAM_SET_TIMESCALE = HPI_FUNC_ID(OSTREAM, 16),
439 HPI_OSTREAM_SET_FORMAT = HPI_FUNC_ID(OSTREAM, 17),
440 HPI_OSTREAM_HOSTBUFFER_ALLOC = HPI_FUNC_ID(OSTREAM, 18),
441 HPI_OSTREAM_HOSTBUFFER_FREE = HPI_FUNC_ID(OSTREAM, 19),
442 HPI_OSTREAM_GROUP_ADD = HPI_FUNC_ID(OSTREAM, 20),
443 HPI_OSTREAM_GROUP_GETMAP = HPI_FUNC_ID(OSTREAM, 21),
444 HPI_OSTREAM_GROUP_RESET = HPI_FUNC_ID(OSTREAM, 22),
445 HPI_OSTREAM_HOSTBUFFER_GET_INFO = HPI_FUNC_ID(OSTREAM, 23),
446 HPI_OSTREAM_WAIT_START = HPI_FUNC_ID(OSTREAM, 24),
447#define HPI_OSTREAM_FUNCTION_COUNT 24
448
449 HPI_ISTREAM_OPEN = HPI_FUNC_ID(ISTREAM, 1),
450 HPI_ISTREAM_CLOSE = HPI_FUNC_ID(ISTREAM, 2),
451 HPI_ISTREAM_SET_FORMAT = HPI_FUNC_ID(ISTREAM, 3),
452 HPI_ISTREAM_READ = HPI_FUNC_ID(ISTREAM, 4),
453 HPI_ISTREAM_START = HPI_FUNC_ID(ISTREAM, 5),
454 HPI_ISTREAM_STOP = HPI_FUNC_ID(ISTREAM, 6),
455 HPI_ISTREAM_RESET = HPI_FUNC_ID(ISTREAM, 7),
456 HPI_ISTREAM_GET_INFO = HPI_FUNC_ID(ISTREAM, 8),
457 HPI_ISTREAM_QUERY_FORMAT = HPI_FUNC_ID(ISTREAM, 9),
458 HPI_ISTREAM_ANC_RESET = HPI_FUNC_ID(ISTREAM, 10),
459 HPI_ISTREAM_ANC_GET_INFO = HPI_FUNC_ID(ISTREAM, 11),
460 HPI_ISTREAM_ANC_WRITE = HPI_FUNC_ID(ISTREAM, 12),
461 HPI_ISTREAM_HOSTBUFFER_ALLOC = HPI_FUNC_ID(ISTREAM, 13),
462 HPI_ISTREAM_HOSTBUFFER_FREE = HPI_FUNC_ID(ISTREAM, 14),
463 HPI_ISTREAM_GROUP_ADD = HPI_FUNC_ID(ISTREAM, 15),
464 HPI_ISTREAM_GROUP_GETMAP = HPI_FUNC_ID(ISTREAM, 16),
465 HPI_ISTREAM_GROUP_RESET = HPI_FUNC_ID(ISTREAM, 17),
466 HPI_ISTREAM_HOSTBUFFER_GET_INFO = HPI_FUNC_ID(ISTREAM, 18),
467 HPI_ISTREAM_WAIT_START = HPI_FUNC_ID(ISTREAM, 19),
468#define HPI_ISTREAM_FUNCTION_COUNT 19
469
719f82d3
EB		 470/* NOTE:
471 GET_NODE_INFO, SET_CONNECTION, GET_CONNECTIONS are not currently used */
3285ea10
EB		 472 HPI_MIXER_OPEN = HPI_FUNC_ID(MIXER, 1),
473 HPI_MIXER_CLOSE = HPI_FUNC_ID(MIXER, 2),
474 HPI_MIXER_GET_INFO = HPI_FUNC_ID(MIXER, 3),
475 HPI_MIXER_GET_NODE_INFO = HPI_FUNC_ID(MIXER, 4),
476 HPI_MIXER_GET_CONTROL = HPI_FUNC_ID(MIXER, 5),
477 HPI_MIXER_SET_CONNECTION = HPI_FUNC_ID(MIXER, 6),
478 HPI_MIXER_GET_CONNECTIONS = HPI_FUNC_ID(MIXER, 7),
479 HPI_MIXER_GET_CONTROL_BY_INDEX = HPI_FUNC_ID(MIXER, 8),
480 HPI_MIXER_GET_CONTROL_ARRAY_BY_INDEX = HPI_FUNC_ID(MIXER, 9),
481 HPI_MIXER_GET_CONTROL_MULTIPLE_VALUES = HPI_FUNC_ID(MIXER, 10),
482 HPI_MIXER_STORE = HPI_FUNC_ID(MIXER, 11),
483#define HPI_MIXER_FUNCTION_COUNT 11
484
485 HPI_CONTROL_GET_INFO = HPI_FUNC_ID(CONTROL, 1),
486 HPI_CONTROL_GET_STATE = HPI_FUNC_ID(CONTROL, 2),
487 HPI_CONTROL_SET_STATE = HPI_FUNC_ID(CONTROL, 3),
719f82d3 488#define HPI_CONTROL_FUNCTION_COUNT 3
3285ea10
EB		 489
490 HPI_NVMEMORY_OPEN = HPI_FUNC_ID(NVMEMORY, 1),
491 HPI_NVMEMORY_READ_BYTE = HPI_FUNC_ID(NVMEMORY, 2),
492 HPI_NVMEMORY_WRITE_BYTE = HPI_FUNC_ID(NVMEMORY, 3),
719f82d3 493#define HPI_NVMEMORY_FUNCTION_COUNT 3
3285ea10
EB		 494
495 HPI_GPIO_OPEN = HPI_FUNC_ID(GPIO, 1),
496 HPI_GPIO_READ_BIT = HPI_FUNC_ID(GPIO, 2),
497 HPI_GPIO_WRITE_BIT = HPI_FUNC_ID(GPIO, 3),
498 HPI_GPIO_READ_ALL = HPI_FUNC_ID(GPIO, 4),
499 HPI_GPIO_WRITE_STATUS = HPI_FUNC_ID(GPIO, 5),
719f82d3 500#define HPI_GPIO_FUNCTION_COUNT 5
3285ea10
EB		 501
502 HPI_ASYNCEVENT_OPEN = HPI_FUNC_ID(ASYNCEVENT, 1),
503 HPI_ASYNCEVENT_CLOSE = HPI_FUNC_ID(ASYNCEVENT, 2),
504 HPI_ASYNCEVENT_WAIT = HPI_FUNC_ID(ASYNCEVENT, 3),
505 HPI_ASYNCEVENT_GETCOUNT = HPI_FUNC_ID(ASYNCEVENT, 4),
506 HPI_ASYNCEVENT_GET = HPI_FUNC_ID(ASYNCEVENT, 5),
507 HPI_ASYNCEVENT_SENDEVENTS = HPI_FUNC_ID(ASYNCEVENT, 6),
719f82d3 508#define HPI_ASYNCEVENT_FUNCTION_COUNT 6
3285ea10
EB		 509
510 HPI_WATCHDOG_OPEN = HPI_FUNC_ID(WATCHDOG, 1),
511 HPI_WATCHDOG_SET_TIME = HPI_FUNC_ID(WATCHDOG, 2),
512 HPI_WATCHDOG_PING = HPI_FUNC_ID(WATCHDOG, 3),
513
514 HPI_CLOCK_OPEN = HPI_FUNC_ID(CLOCK, 1),
515 HPI_CLOCK_SET_TIME = HPI_FUNC_ID(CLOCK, 2),
516 HPI_CLOCK_GET_TIME = HPI_FUNC_ID(CLOCK, 3),
517
518 HPI_PROFILE_OPEN_ALL = HPI_FUNC_ID(PROFILE, 1),
519 HPI_PROFILE_START_ALL = HPI_FUNC_ID(PROFILE, 2),
520 HPI_PROFILE_STOP_ALL = HPI_FUNC_ID(PROFILE, 3),
521 HPI_PROFILE_GET = HPI_FUNC_ID(PROFILE, 4),
522 HPI_PROFILE_GET_IDLECOUNT = HPI_FUNC_ID(PROFILE, 5),
523 HPI_PROFILE_GET_NAME = HPI_FUNC_ID(PROFILE, 6),
524 HPI_PROFILE_GET_UTILIZATION = HPI_FUNC_ID(PROFILE, 7)
719f82d3 525#define HPI_PROFILE_FUNCTION_COUNT 7
3285ea10 526};
719f82d3
EB		 527
528/* ////////////////////////////////////////////////////////////////////// */
529/* STRUCTURES */
530#ifndef DISABLE_PRAGMA_PACK1
531#pragma pack(push, 1)
532#endif
533
534/** PCI bus resource */
535struct hpi_pci {
536 u32 __iomem *ap_mem_base[HPI_MAX_ADAPTER_MEM_SPACES];
3285ea10 537 struct pci_dev *pci_dev;
719f82d3
EB		 538};
539
540struct hpi_resource {
541 union {
542 const struct hpi_pci *pci;
543 const char *net_if;
544 } r;
545#ifndef HPI64BIT /* keep structure size constant */
546 u32 pad_to64;
547#endif
548 u16 bus_type; /* HPI_BUS_PNPISA, _PCI, _USB etc */
549 u16 padding;
550
551};
552
553/** Format info used inside struct hpi_message
554 Not the same as public API struct hpi_format */
555struct hpi_msg_format {
556 u32 sample_rate;
557 /**< 11025, 32000, 44100 ... */
558 u32 bit_rate; /**< for MPEG */
559 u32 attributes;
560 /**< Stereo/JointStereo/Mono */
561 u16 channels; /**< 1,2..., (or ancillary mode or idle bit */
562 u16 format; /**< HPI_FORMAT_PCM16, _MPEG etc. see \ref HPI_FORMATS. */
563};
564
565/** Buffer+format structure.
566 Must be kept 7 * 32 bits to match public struct hpi_datastruct */
567struct hpi_msg_data {
568 struct hpi_msg_format format;
569 u8 *pb_data;
570#ifndef HPI64BIT
571 u32 padding;
572#endif
573 u32 data_size;
574};
575
576/** struct hpi_datastructure used up to 3.04 driver */
577struct hpi_data_legacy32 {
578 struct hpi_format format;
579 u32 pb_data;
580 u32 data_size;
581};
582
583#ifdef HPI64BIT
584/* Compatibility version of struct hpi_data*/
585struct hpi_data_compat32 {
586 struct hpi_msg_format format;
587 u32 pb_data;
588 u32 padding;
589 u32 data_size;
590};
591#endif
592
593struct hpi_buffer {
594 /** placehoder for backward compatability (see dwBufferSize) */
595 struct hpi_msg_format reserved;
596 u32 command; /**< HPI_BUFFER_CMD_xxx*/
597 u32 pci_address; /**< PCI physical address of buffer for DSP DMA */
598 u32 buffer_size; /**< must line up with data_size of HPI_DATA*/
599};
600
601/*/////////////////////////////////////////////////////////////////////////// */
602/* This is used for background buffer bus mastering stream buffers. */
603struct hpi_hostbuffer_status {
604 u32 samples_processed;
605 u32 auxiliary_data_available;
606 u32 stream_state;
607 /* DSP index in to the host bus master buffer. */
608 u32 dSP_index;
609 /* Host index in to the host bus master buffer. */
610 u32 host_index;
611 u32 size_in_bytes;
612};
613
614struct hpi_streamid {
615 u16 object_type;
616 /**< Type of object, HPI_OBJ_OSTREAM or HPI_OBJ_ISTREAM. */
617 u16 stream_index; /**< outstream or instream index. */
618};
619
620struct hpi_punchinout {
621 u32 punch_in_sample;
622 u32 punch_out_sample;
623};
624
625struct hpi_subsys_msg {
626 struct hpi_resource resource;
627};
628
629struct hpi_subsys_res {
630 u32 version;
631 u32 data; /* used to return extended version */
632 u16 num_adapters; /* number of adapters */
633 u16 adapter_index;
634 u16 aw_adapter_list[HPI_MAX_ADAPTERS];
635};
636
719f82d3 637union hpi_adapterx_msg {
719f82d3 638 struct {
3285ea10
EB		 639 u32 dsp_address;
640 u32 count_bytes;
641 } debug_read;
719f82d3 642 struct {
3285ea10
EB		 643 u32 adapter_mode;
644 u16 query_or_set;
645 } mode;
646 struct {
647 u16 index;
648 } module_info;
719f82d3
EB		 649 struct {
650 u32 checksum;
651 u16 sequence;
652 u16 length;
653 u16 offset; /**< offset from start of msg to data */
654 u16 unused;
655 } program_flash;
3285ea10
EB		 656 struct {
657 u16 index;
658 u16 what;
659 u16 property_index;
660 } property_enum;
719f82d3
EB		 661 struct {
662 u16 property;
663 u16 parameter1;
664 u16 parameter2;
665 } property_set;
666 struct {
3285ea10
EB		 667 u32 offset;
668 } query_flash;
719f82d3 669 struct {
3285ea10
EB		 670 u32 pad32;
671 u16 key1;
672 u16 key2;
673 } restart;
719f82d3 674 struct {
3285ea10
EB		 675 u32 offset;
676 u32 length;
677 u32 key;
678 } start_flash;
679 struct {
680 u32 pad32;
681 u16 value;
682 } test_assert;
719f82d3
EB		 683};
684
685struct hpi_adapter_res {
686 u32 serial_number;
687 u16 adapter_type;
3285ea10 688 u16 adapter_index;
719f82d3
EB		 689 u16 num_instreams;
690 u16 num_outstreams;
691 u16 num_mixers;
692 u16 version;
693 u8 sz_adapter_assert[HPI_STRING_LEN];
694};
695
696union hpi_adapterx_res {
3285ea10 697 struct hpi_adapter_res info;
719f82d3 698 struct {
3285ea10
EB		 699 u32 p1;
700 u16 count;
701 u16 dsp_index;
702 u32 p2;
703 u32 dsp_msg_addr;
704 char sz_message[HPI_STRING_LEN];
705 } assert;
706 struct {
707 u32 adapter_mode;
708 } mode;
719f82d3
EB		 709 struct {
710 u16 sequence;
711 } program_flash;
712 struct {
713 u16 parameter1;
714 u16 parameter2;
715 } property_get;
3285ea10
EB		 716 struct {
717 u32 checksum;
718 u32 length;
719 u32 version;
720 } query_flash;
719f82d3
EB		 721};
722
723struct hpi_stream_msg {
724 union {
725 struct hpi_msg_data data;
726 struct hpi_data_legacy32 data32;
727 u16 velocity;
728 struct hpi_punchinout pio;
729 u32 time_scale;
730 struct hpi_buffer buffer;
731 struct hpi_streamid stream;
732 } u;
733};
734
735struct hpi_stream_res {
736 union {
737 struct {
738 /* size of hardware buffer */
739 u32 buffer_size;
740 /* OutStream - data to play,
741 InStream - data recorded */
742 u32 data_available;
743 /* OutStream - samples played,
744 InStream - samples recorded */
745 u32 samples_transferred;
746 /* Adapter - OutStream - data to play,
747 InStream - data recorded */
748 u32 auxiliary_data_available;
749 u16 state; /* HPI_STATE_PLAYING, _STATE_STOPPED */
750 u16 padding;
751 } stream_info;
752 struct {
753 u32 buffer_size;
754 u32 data_available;
755 u32 samples_transfered;
756 u16 state;
757 u16 outstream_index;
758 u16 instream_index;
759 u16 padding;
760 u32 auxiliary_data_available;
761 } legacy_stream_info;
762 struct {
763 /* bitmap of grouped OutStreams */
764 u32 outstream_group_map;
765 /* bitmap of grouped InStreams */
766 u32 instream_group_map;
767 } group_info;
768 struct {
769 /* pointer to the buffer */
770 u8 *p_buffer;
771 /* pointer to the hostbuffer status */
772 struct hpi_hostbuffer_status *p_status;
773 } hostbuffer_info;
774 } u;
775};
776
777struct hpi_mixer_msg {
778 u16 control_index;
779 u16 control_type; /* = HPI_CONTROL_METER _VOLUME etc */
3285ea10 780 u16 padding1; /* Maintain alignment of subsequent fields */
719f82d3
EB		 781 u16 node_type1; /* = HPI_SOURCENODE_LINEIN etc */
782 u16 node_index1; /* = 0..N */
783 u16 node_type2;
784 u16 node_index2;
785 u16 padding2; /* round to 4 bytes */
786};
787
788struct hpi_mixer_res {
789 u16 src_node_type; /* = HPI_SOURCENODE_LINEIN etc */
790 u16 src_node_index; /* = 0..N */
791 u16 dst_node_type;
792 u16 dst_node_index;
793 /* Also controlType for MixerGetControlByIndex */
794 u16 control_index;
795 /* may indicate which DSP the control is located on */
796 u16 dsp_index;
797};
798
799union hpi_mixerx_msg {
800 struct {
801 u16 starting_index;
802 u16 flags;
803 u32 length_in_bytes; /* length in bytes of p_data */
804 u32 p_data; /* pointer to a data array */
805 } gcabi;
806 struct {
807 u16 command;
808 u16 index;
809 } store; /* for HPI_MIXER_STORE message */
810};
811
812union hpi_mixerx_res {
813 struct {
814 u32 bytes_returned; /* size of items returned */
815 u32 p_data; /* pointer to data array */
816 u16 more_to_do; /* indicates if there is more to do */
817 } gcabi;
818};
819
820struct hpi_control_msg {
821 u16 attribute; /* control attribute or property */
822 u16 saved_index;
823 u32 param1; /* generic parameter 1 */
824 u32 param2; /* generic parameter 2 */
825 short an_log_value[HPI_MAX_CHANNELS];
826};
827
828struct hpi_control_union_msg {
829 u16 attribute; /* control attribute or property */
830 u16 saved_index; /* only used in ctrl save/restore */
831 union {
832 struct {
833 u32 param1; /* generic parameter 1 */
834 u32 param2; /* generic parameter 2 */
835 short an_log_value[HPI_MAX_CHANNELS];
836 } old;
837 union {
838 u32 frequency;
839 u32 gain;
840 u32 band;
841 u32 deemphasis;
842 u32 program;
843 struct {
844 u32 mode;
845 u32 value;
846 } mode;
5a498ef1 847 u32 blend;
719f82d3
EB		 848 } tuner;
849 } u;
850};
851
852struct hpi_control_res {
853 /* Could make union. dwParam, anLogValue never used in same response */
854 u32 param1;
855 u32 param2;
856 short an_log_value[HPI_MAX_CHANNELS];
857};
858
859union hpi_control_union_res {
860 struct {
861 u32 param1;
862 u32 param2;
863 short an_log_value[HPI_MAX_CHANNELS];
864 } old;
865 union {
866 u32 band;
867 u32 frequency;
868 u32 gain;
719f82d3
EB		 869 u32 deemphasis;
870 struct {
871 u32 data[2];
872 u32 bLER;
873 } rds;
3285ea10
EB		 874 short s_level;
875 struct {
876 u16 value;
877 u16 mask;
878 } status;
719f82d3
EB		 879 } tuner;
880 struct {
881 char sz_data[8];
882 u32 remaining_chars;
883 } chars8;
884 char c_data12[12];
885};
886
887/* HPI_CONTROLX_STRUCTURES */
888
889/* Message */
890
891/** Used for all HMI variables where max length <= 8 bytes
892*/
893struct hpi_controlx_msg_cobranet_data {
894 u32 hmi_address;
895 u32 byte_count;
896 u32 data[2];
897};
898
899/** Used for string data, and for packet bridge
900*/
901struct hpi_controlx_msg_cobranet_bigdata {
902 u32 hmi_address;
903 u32 byte_count;
904 u8 *pb_data;
905#ifndef HPI64BIT
906 u32 padding;
907#endif
908};
909
910/** Used for PADS control reading of string fields.
911*/
912struct hpi_controlx_msg_pad_data {
913 u32 field;
914 u32 byte_count;
915 u8 *pb_data;
916#ifndef HPI64BIT
917 u32 padding;
918#endif
919};
920
921/** Used for generic data
922*/
923
924struct hpi_controlx_msg_generic {
925 u32 param1;
926 u32 param2;
927};
928
929struct hpi_controlx_msg {
930 u16 attribute; /* control attribute or property */
931 u16 saved_index;
932 union {
933 struct hpi_controlx_msg_cobranet_data cobranet_data;
934 struct hpi_controlx_msg_cobranet_bigdata cobranet_bigdata;
935 struct hpi_controlx_msg_generic generic;
936 struct hpi_controlx_msg_pad_data pad_data;
937 /*struct param_value universal_value; */
938 /* nothing extra to send for status read */
939 } u;
940};
941
942/* Response */
943/**
944*/
945struct hpi_controlx_res_cobranet_data {
946 u32 byte_count;
947 u32 data[2];
948};
949
950struct hpi_controlx_res_cobranet_bigdata {
951 u32 byte_count;
952};
953
954struct hpi_controlx_res_cobranet_status {
955 u32 status;
956 u32 readable_size;
957 u32 writeable_size;
958};
959
960struct hpi_controlx_res_generic {
961 u32 param1;
962 u32 param2;
963};
964
965struct hpi_controlx_res {
966 union {
967 struct hpi_controlx_res_cobranet_bigdata cobranet_bigdata;
968 struct hpi_controlx_res_cobranet_data cobranet_data;
969 struct hpi_controlx_res_cobranet_status cobranet_status;
970 struct hpi_controlx_res_generic generic;
971 /*struct param_info universal_info; */
972 /*struct param_value universal_value; */
973 } u;
974};
975
976struct hpi_nvmemory_msg {
977 u16 address;
978 u16 data;
979};
980
981struct hpi_nvmemory_res {
982 u16 size_in_bytes;
983 u16 data;
984};
985
986struct hpi_gpio_msg {
987 u16 bit_index;
988 u16 bit_data;
989};
990
991struct hpi_gpio_res {
992 u16 number_input_bits;
993 u16 number_output_bits;
994 u16 bit_data[4];
995};
996
997struct hpi_async_msg {
998 u32 events;
999 u16 maximum_events;
1000 u16 padding;
1001};
1002
1003struct hpi_async_res {
1004 union {
1005 struct {
1006 u16 count;
1007 } count;
1008 struct {
1009 u32 events;
1010 u16 number_returned;
1011 u16 padding;
1012 } get;
1013 struct hpi_async_event event;
1014 } u;
1015};
1016
1017struct hpi_watchdog_msg {
1018 u32 time_ms;
1019};
1020
1021struct hpi_watchdog_res {
1022 u32 time_ms;
1023};
1024
1025struct hpi_clock_msg {
1026 u16 hours;
1027 u16 minutes;
1028 u16 seconds;
1029 u16 milli_seconds;
1030};
1031
1032struct hpi_clock_res {
1033 u16 size_in_bytes;
1034 u16 hours;
1035 u16 minutes;
1036 u16 seconds;
1037 u16 milli_seconds;
1038 u16 padding;
1039};
1040
1041struct hpi_profile_msg {
1042 u16 bin_index;
1043 u16 padding;
1044};
1045
1046struct hpi_profile_res_open {
1047 u16 max_profiles;
1048};
1049
1050struct hpi_profile_res_time {
3285ea10 1051 u32 total_tick_count;
719f82d3 1052 u32 call_count;
3285ea10
EB		 1053 u32 max_tick_count;
1054 u32 ticks_per_millisecond;
1055 u16 profile_interval;
719f82d3
EB		 1056};
1057
1058struct hpi_profile_res_name {
1059 u8 sz_name[32];
1060};
1061
1062struct hpi_profile_res {
1063 union {
1064 struct hpi_profile_res_open o;
1065 struct hpi_profile_res_time t;
1066 struct hpi_profile_res_name n;
1067 } u;
1068};
1069
1070struct hpi_message_header {
1071 u16 size; /* total size in bytes */
1072 u8 type; /* HPI_TYPE_MESSAGE */
1073 u8 version; /* message version */
1074 u16 object; /* HPI_OBJ_* */
1075 u16 function; /* HPI_SUBSYS_xxx, HPI_ADAPTER_xxx */
1076 u16 adapter_index; /* the adapter index */
1077 u16 obj_index; /* */
1078};
1079
1080struct hpi_message {
1081 /* following fields must match HPI_MESSAGE_HEADER */
1082 u16 size; /* total size in bytes */
1083 u8 type; /* HPI_TYPE_MESSAGE */
1084 u8 version; /* message version */
1085 u16 object; /* HPI_OBJ_* */
1086 u16 function; /* HPI_SUBSYS_xxx, HPI_ADAPTER_xxx */
1087 u16 adapter_index; /* the adapter index */
1088 u16 obj_index; /* */
1089 union {
1090 struct hpi_subsys_msg s;
719f82d3
EB		 1091 union hpi_adapterx_msg ax;
1092 struct hpi_stream_msg d;
1093 struct hpi_mixer_msg m;
1094 union hpi_mixerx_msg mx; /* extended mixer; */
1095 struct hpi_control_msg c; /* mixer control; */
1096 /* identical to struct hpi_control_msg,
1097 but field naming is improved */
1098 struct hpi_control_union_msg cu;
1099 struct hpi_controlx_msg cx; /* extended mixer control; */
1100 struct hpi_nvmemory_msg n;
1101 struct hpi_gpio_msg l; /* digital i/o */
1102 struct hpi_watchdog_msg w;
1103 struct hpi_clock_msg t; /* dsp time */
1104 struct hpi_profile_msg p;
1105 struct hpi_async_msg as;
1106 char fixed_size[32];
1107 } u;
1108};
1109
1110#define HPI_MESSAGE_SIZE_BY_OBJECT { \
3285ea10 1111 sizeof(struct hpi_message_header) , /* Default, no object type 0 */ \
719f82d3
EB		 1112 sizeof(struct hpi_message_header) + sizeof(struct hpi_subsys_msg),\
1113 sizeof(struct hpi_message_header) + sizeof(union hpi_adapterx_msg),\
1114 sizeof(struct hpi_message_header) + sizeof(struct hpi_stream_msg),\
1115 sizeof(struct hpi_message_header) + sizeof(struct hpi_stream_msg),\
1116 sizeof(struct hpi_message_header) + sizeof(struct hpi_mixer_msg),\
1117 sizeof(struct hpi_message_header) , /* no node message */ \
1118 sizeof(struct hpi_message_header) + sizeof(struct hpi_control_msg),\
1119 sizeof(struct hpi_message_header) + sizeof(struct hpi_nvmemory_msg),\
1120 sizeof(struct hpi_message_header) + sizeof(struct hpi_gpio_msg),\
1121 sizeof(struct hpi_message_header) + sizeof(struct hpi_watchdog_msg),\
1122 sizeof(struct hpi_message_header) + sizeof(struct hpi_clock_msg),\
1123 sizeof(struct hpi_message_header) + sizeof(struct hpi_profile_msg),\
1124 sizeof(struct hpi_message_header) + sizeof(struct hpi_controlx_msg),\
1125 sizeof(struct hpi_message_header) + sizeof(struct hpi_async_msg) \
1126}
1127
1128struct hpi_response_header {
1129 u16 size;
1130 u8 type; /* HPI_TYPE_RESPONSE */
1131 u8 version; /* response version */
1132 u16 object; /* HPI_OBJ_* */
1133 u16 function; /* HPI_SUBSYS_xxx, HPI_ADAPTER_xxx */
1134 u16 error; /* HPI_ERROR_xxx */
1135 u16 specific_error; /* adapter specific error */
1136};
1137
1138struct hpi_response {
1139/* following fields must match HPI_RESPONSE_HEADER */
1140 u16 size;
1141 u8 type; /* HPI_TYPE_RESPONSE */
1142 u8 version; /* response version */
1143 u16 object; /* HPI_OBJ_* */
1144 u16 function; /* HPI_SUBSYS_xxx, HPI_ADAPTER_xxx */
1145 u16 error; /* HPI_ERROR_xxx */
1146 u16 specific_error; /* adapter specific error */
1147 union {
1148 struct hpi_subsys_res s;
719f82d3
EB		 1149 union hpi_adapterx_res ax;
1150 struct hpi_stream_res d;
1151 struct hpi_mixer_res m;
1152 union hpi_mixerx_res mx; /* extended mixer; */
1153 struct hpi_control_res c; /* mixer control; */
1154 /* identical to hpi_control_res, but field naming is improved */
1155 union hpi_control_union_res cu;
1156 struct hpi_controlx_res cx; /* extended mixer control; */
1157 struct hpi_nvmemory_res n;
1158 struct hpi_gpio_res l; /* digital i/o */
1159 struct hpi_watchdog_res w;
1160 struct hpi_clock_res t; /* dsp time */
1161 struct hpi_profile_res p;
1162 struct hpi_async_res as;
1163 u8 bytes[52];
1164 } u;
1165};
1166
1167#define HPI_RESPONSE_SIZE_BY_OBJECT { \
3285ea10 1168 sizeof(struct hpi_response_header) ,/* Default, no object type 0 */ \
719f82d3
EB		 1169 sizeof(struct hpi_response_header) + sizeof(struct hpi_subsys_res),\
1170 sizeof(struct hpi_response_header) + sizeof(union hpi_adapterx_res),\
1171 sizeof(struct hpi_response_header) + sizeof(struct hpi_stream_res),\
1172 sizeof(struct hpi_response_header) + sizeof(struct hpi_stream_res),\
1173 sizeof(struct hpi_response_header) + sizeof(struct hpi_mixer_res),\
1174 sizeof(struct hpi_response_header) , /* no node response */ \
1175 sizeof(struct hpi_response_header) + sizeof(struct hpi_control_res),\
1176 sizeof(struct hpi_response_header) + sizeof(struct hpi_nvmemory_res),\
1177 sizeof(struct hpi_response_header) + sizeof(struct hpi_gpio_res),\
1178 sizeof(struct hpi_response_header) + sizeof(struct hpi_watchdog_res),\
1179 sizeof(struct hpi_response_header) + sizeof(struct hpi_clock_res),\
1180 sizeof(struct hpi_response_header) + sizeof(struct hpi_profile_res),\
1181 sizeof(struct hpi_response_header) + sizeof(struct hpi_controlx_res),\
1182 sizeof(struct hpi_response_header) + sizeof(struct hpi_async_res) \
1183}
1184
ba94455c 1185/*********************** version 1 message/response **************************/
719f82d3
EB		 1186#define HPINET_ETHERNET_DATA_SIZE (1500)
1187#define HPINET_IP_HDR_SIZE (20)
1188#define HPINET_IP_DATA_SIZE (HPINET_ETHERNET_DATA_SIZE - HPINET_IP_HDR_SIZE)
1189#define HPINET_UDP_HDR_SIZE (8)
1190#define HPINET_UDP_DATA_SIZE (HPINET_IP_DATA_SIZE - HPINET_UDP_HDR_SIZE)
1191#define HPINET_ASI_HDR_SIZE (2)
1192#define HPINET_ASI_DATA_SIZE (HPINET_UDP_DATA_SIZE - HPINET_ASI_HDR_SIZE)
1193
1194#define HPI_MAX_PAYLOAD_SIZE (HPINET_ASI_DATA_SIZE - 2)
1195
1196/* New style message/response, but still V0 compatible */
1197struct hpi_msg_adapter_get_info {
1198 struct hpi_message_header h;
1199};
1200
1201struct hpi_res_adapter_get_info {
1202 struct hpi_response_header h; /*v0 */
1203 struct hpi_adapter_res p;
1204};
1205
1206/* padding is so these are same size as v0 hpi_message */
1207struct hpi_msg_adapter_query_flash {
1208 struct hpi_message_header h;
1209 u32 offset;
1210 u8 pad_to_version0_size[sizeof(struct hpi_message) - /* V0 res */
1211 sizeof(struct hpi_message_header) - 1 * sizeof(u32)];
1212};
1213
1214/* padding is so these are same size as v0 hpi_response */
1215struct hpi_res_adapter_query_flash {
1216 struct hpi_response_header h;
1217 u32 checksum;
1218 u32 length;
1219 u32 version;
1220 u8 pad_to_version0_size[sizeof(struct hpi_response) - /* V0 res */
1221 sizeof(struct hpi_response_header) - 3 * sizeof(u32)];
1222};
1223
1224struct hpi_msg_adapter_start_flash {
1225 struct hpi_message_header h;
1226 u32 offset;
1227 u32 length;
1228 u32 key;
1229 u8 pad_to_version0_size[sizeof(struct hpi_message) - /* V0 res */
1230 sizeof(struct hpi_message_header) - 3 * sizeof(u32)];
1231};
1232
1233struct hpi_res_adapter_start_flash {
1234 struct hpi_response_header h;
1235 u8 pad_to_version0_size[sizeof(struct hpi_response) - /* V0 res */
1236 sizeof(struct hpi_response_header)];
1237};
1238
1239struct hpi_msg_adapter_program_flash_payload {
1240 u32 checksum;
1241 u16 sequence;
1242 u16 length;
1243 u16 offset; /**< offset from start of msg to data */
1244 u16 unused;
1245 /* ensure sizeof(header + payload) == sizeof(hpi_message_V0)
1246 because old firmware expects data after message of this size */
1247 u8 pad_to_version0_size[sizeof(struct hpi_message) - /* V0 message */
1248 sizeof(struct hpi_message_header) - sizeof(u32) -
1249 4 * sizeof(u16)];
1250};
1251
1252struct hpi_msg_adapter_program_flash {
1253 struct hpi_message_header h;
1254 struct hpi_msg_adapter_program_flash_payload p;
1255 u32 data[256];
1256};
1257
1258struct hpi_res_adapter_program_flash {
1259 struct hpi_response_header h;
1260 u16 sequence;
1261 u8 pad_to_version0_size[sizeof(struct hpi_response) - /* V0 res */
1262 sizeof(struct hpi_response_header) - sizeof(u16)];
1263};
1264
3285ea10
EB		 1265struct hpi_msg_adapter_debug_read {
1266 struct hpi_message_header h;
1267 u32 dsp_address;
1268 u32 count_bytes;
1269};
1270
1271struct hpi_res_adapter_debug_read {
1272 struct hpi_response_header h;
1273 u8 bytes[256];
1274};
1275
719f82d3
EB		 1276#if 1
1277#define hpi_message_header_v1 hpi_message_header
1278#define hpi_response_header_v1 hpi_response_header
1279#else
1280/* V1 headers in Addition to v0 headers */
1281struct hpi_message_header_v1 {
1282 struct hpi_message_header h0;
1283/* struct {
1284} h1; */
1285};
1286
1287struct hpi_response_header_v1 {
1288 struct hpi_response_header h0;
1289 struct {
1290 u16 adapter_index; /* the adapter index */
1291 u16 obj_index; /* object index */
1292 } h1;
1293};
1294#endif
1295
719f82d3
EB		 1296struct hpi_msg_payload_v0 {
1297 struct hpi_message_header h;
1298 union {
1299 struct hpi_subsys_msg s;
719f82d3
EB		 1300 union hpi_adapterx_msg ax;
1301 struct hpi_stream_msg d;
1302 struct hpi_mixer_msg m;
1303 union hpi_mixerx_msg mx;
1304 struct hpi_control_msg c;
1305 struct hpi_control_union_msg cu;
1306 struct hpi_controlx_msg cx;
1307 struct hpi_nvmemory_msg n;
1308 struct hpi_gpio_msg l;
1309 struct hpi_watchdog_msg w;
1310 struct hpi_clock_msg t;
1311 struct hpi_profile_msg p;
1312 struct hpi_async_msg as;
1313 } u;
1314};
1315
1316struct hpi_res_payload_v0 {
1317 struct hpi_response_header h;
1318 union {
1319 struct hpi_subsys_res s;
719f82d3
EB		 1320 union hpi_adapterx_res ax;
1321 struct hpi_stream_res d;
1322 struct hpi_mixer_res m;
1323 union hpi_mixerx_res mx;
1324 struct hpi_control_res c;
1325 union hpi_control_union_res cu;
1326 struct hpi_controlx_res cx;
1327 struct hpi_nvmemory_res n;
1328 struct hpi_gpio_res l;
1329 struct hpi_watchdog_res w;
1330 struct hpi_clock_res t;
1331 struct hpi_profile_res p;
1332 struct hpi_async_res as;
1333 } u;
1334};
1335
1336union hpi_message_buffer_v1 {
1337 struct hpi_message m0; /* version 0 */
1338 struct hpi_message_header_v1 h;
3285ea10 1339 u8 buf[HPI_MAX_PAYLOAD_SIZE];
719f82d3
EB		 1340};
1341
1342union hpi_response_buffer_v1 {
1343 struct hpi_response r0; /* version 0 */
1344 struct hpi_response_header_v1 h;
3285ea10 1345 u8 buf[HPI_MAX_PAYLOAD_SIZE];
719f82d3
EB		 1346};
1347
1348compile_time_assert((sizeof(union hpi_message_buffer_v1) <=
1349 HPI_MAX_PAYLOAD_SIZE), message_buffer_ok);
1350compile_time_assert((sizeof(union hpi_response_buffer_v1) <=
1351 HPI_MAX_PAYLOAD_SIZE), response_buffer_ok);
1352
1353/*////////////////////////////////////////////////////////////////////////// */
1354/* declarations for compact control calls */
1355struct hpi_control_defn {
1356 u8 type;
1357 u8 channels;
1358 u8 src_node_type;
1359 u8 src_node_index;
1360 u8 dest_node_type;
1361 u8 dest_node_index;
1362};
1363
1364/*////////////////////////////////////////////////////////////////////////// */
1365/* declarations for control caching (internal to HPI<->DSP interaction) */
1366
3285ea10
EB		 1367/** indicates a cached u16 value is invalid. */
1368#define HPI_CACHE_INVALID_UINT16 0xFFFF
1369/** indicates a cached short value is invalid. */
1370#define HPI_CACHE_INVALID_SHORT -32768
1371
719f82d3
EB		 1372/** A compact representation of (part of) a controls state.
1373Used for efficient transfer of the control state
1374between DSP and host or across a network
1375*/
1376struct hpi_control_cache_info {
1377 /** one of HPI_CONTROL_* */
1378 u8 control_type;
1379 /** The total size of cached information in 32-bit words. */
1380 u8 size_in32bit_words;
1381 /** The original index of the control on the DSP */
1382 u16 control_index;
1383};
1384
3285ea10
EB		 1385struct hpi_control_cache_vol {
1386 struct hpi_control_cache_info i;
1387 short an_log[2];
1388 char temp_padding[4];
1389};
1390
1391struct hpi_control_cache_meter {
1392 struct hpi_control_cache_info i;
1393 short an_log_peak[2];
1394 short an_logRMS[2];
1395};
1396
1397struct hpi_control_cache_channelmode {
1398 struct hpi_control_cache_info i;
1399 u16 mode;
1400 char temp_padding[6];
1401};
1402
1403struct hpi_control_cache_mux {
1404 struct hpi_control_cache_info i;
1405 u16 source_node_type;
1406 u16 source_node_index;
1407 char temp_padding[4];
1408};
1409
1410struct hpi_control_cache_level {
1411 struct hpi_control_cache_info i;
1412 short an_log[2];
1413 char temp_padding[4];
1414};
1415
1416struct hpi_control_cache_tuner {
1417 struct hpi_control_cache_info i;
1418 u32 freq_ink_hz;
1419 u16 band;
1420 short s_level_avg;
1421};
1422
1423struct hpi_control_cache_aes3rx {
1424 struct hpi_control_cache_info i;
1425 u32 error_status;
1426 u32 format;
1427};
1428
1429struct hpi_control_cache_aes3tx {
1430 struct hpi_control_cache_info i;
1431 u32 format;
1432 char temp_padding[4];
1433};
1434
1435struct hpi_control_cache_tonedetector {
1436 struct hpi_control_cache_info i;
1437 u16 state;
1438 char temp_padding[6];
1439};
1440
1441struct hpi_control_cache_silencedetector {
1442 struct hpi_control_cache_info i;
1443 u32 state;
1444 char temp_padding[4];
1445};
1446
1447struct hpi_control_cache_sampleclock {
1448 struct hpi_control_cache_info i;
1449 u16 source;
1450 u16 source_index;
1451 u32 sample_rate;
1452};
1453
1454struct hpi_control_cache_microphone {
1455 struct hpi_control_cache_info i;
1456 u16 phantom_state;
1457 char temp_padding[6];
1458};
1459
1460struct hpi_control_cache_generic {
719f82d3 1461 struct hpi_control_cache_info i;
3285ea10
EB		 1462 u32 dw1;
1463 u32 dw2;
1464};
1465
1466struct hpi_control_cache_single {
719f82d3 1467 union {
3285ea10
EB		 1468 struct hpi_control_cache_info i;
1469 struct hpi_control_cache_vol vol;
1470 struct hpi_control_cache_meter meter;
1471 struct hpi_control_cache_channelmode mode;
1472 struct hpi_control_cache_mux mux;
1473 struct hpi_control_cache_level level;
1474 struct hpi_control_cache_tuner tuner;
1475 struct hpi_control_cache_aes3rx aes3rx;
1476 struct hpi_control_cache_aes3tx aes3tx;
1477 struct hpi_control_cache_tonedetector tone;
1478 struct hpi_control_cache_silencedetector silence;
1479 struct hpi_control_cache_sampleclock clk;
1480 struct hpi_control_cache_microphone microphone;
1481 struct hpi_control_cache_generic generic;
719f82d3
EB		 1482 } u;
1483};
1484
1485struct hpi_control_cache_pad {
1486 struct hpi_control_cache_info i;
1487 u32 field_valid_flags;
1488 u8 c_channel[8];
1489 u8 c_artist[40];
1490 u8 c_title[40];
1491 u8 c_comment[200];
1492 u32 pTY;
1493 u32 pI;
1494 u32 traffic_supported;
1495 u32 traffic_anouncement;
1496};
1497
ba94455c 1498/* 2^N sized FIFO buffer (internal to HPI<->DSP interaction) */
719f82d3
EB		 1499struct hpi_fifo_buffer {
1500 u32 size;
1501 u32 dSP_index;
1502 u32 host_index;
1503};
1504
1505#ifndef DISABLE_PRAGMA_PACK1
1506#pragma pack(pop)
1507#endif
1508
1509/* skip host side function declarations for DSP
1510 compile and documentation extraction */
1511
1512char hpi_handle_object(const u32 handle);
1513
1514void hpi_handle_to_indexes(const u32 handle, u16 *pw_adapter_index,
1515 u16 *pw_object_index);
1516
1517u32 hpi_indexes_to_handle(const char c_object, const u16 adapter_index,
1518 const u16 object_index);
1519
1520/*////////////////////////////////////////////////////////////////////////// */
1521
1522/* main HPI entry point */
ba94455c 1523void hpi_send_recv(struct hpi_message *phm, struct hpi_response *phr);
719f82d3
EB		 1524
1525/* UDP message */
1526void hpi_send_recvUDP(struct hpi_message *phm, struct hpi_response *phr,
1527 const unsigned int timeout);
1528
1529/* used in PnP OS/driver */
ba94455c
EB		 1530u16 hpi_subsys_create_adapter(const struct hpi_resource *p_resource,
1531 u16 *pw_adapter_index);
719f82d3 1532
ba94455c 1533u16 hpi_subsys_delete_adapter(u16 adapter_index);
719f82d3 1534
ba94455c 1535u16 hpi_outstream_host_buffer_get_info(u32 h_outstream, u8 **pp_buffer,
719f82d3
EB		 1536 struct hpi_hostbuffer_status **pp_status);
1537
ba94455c 1538u16 hpi_instream_host_buffer_get_info(u32 h_instream, u8 **pp_buffer,
719f82d3
EB		 1539 struct hpi_hostbuffer_status **pp_status);
1540
1541u16 hpi_adapter_restart(u16 adapter_index);
1542
1543/*
1544The following 3 functions were last declared in header files for
1545driver 3.10. HPI_ControlQuery() used to be the recommended way
1546of getting a volume range. Declared here for binary asihpi32.dll
1547compatibility.
1548*/
1549
1550void hpi_format_to_msg(struct hpi_msg_format *pMF,
1551 const struct hpi_format *pF);
1552void hpi_stream_response_to_legacy(struct hpi_stream_res *pSR);
1553
1554/*////////////////////////////////////////////////////////////////////////// */
1555/* declarations for individual HPI entry points */
1556hpi_handler_func HPI_1000;
1557hpi_handler_func HPI_6000;
1558hpi_handler_func HPI_6205;
1559hpi_handler_func HPI_COMMON;
1560
1561#endif /* _HPI_INTERNAL_H_ */
Linux kernel - Deliverables
This page took 0.211104 seconds and 5 git commands to generate.