Commit | Line | Data |
---|---|---|
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 | ||
19 | */ | |
20 | /** \file hpi.h | |
21 | ||
22 | AudioScience Hardware Programming Interface (HPI) | |
23 | public API definition. | |
24 | ||
25 | The HPI is a low-level hardware abstraction layer to all | |
26 | AudioScience digital audio adapters | |
719f82d3 EB |
27 | |
28 | (C) Copyright AudioScience Inc. 1998-2010 | |
ba94455c EB |
29 | */ |
30 | ||
719f82d3 EB |
31 | #ifndef _HPI_H_ |
32 | #define _HPI_H_ | |
33 | /* HPI Version | |
34 | If HPI_VER_MINOR is odd then its a development release not intended for the | |
35 | public. If HPI_VER_MINOR is even then is a release version | |
36 | i.e 3.05.02 is a development version | |
37 | */ | |
38 | #define HPI_VERSION_CONSTRUCTOR(maj, min, rel) \ | |
39 | ((maj << 16) + (min << 8) + rel) | |
40 | ||
41 | #define HPI_VER_MAJOR(v) ((int)(v >> 16)) | |
42 | #define HPI_VER_MINOR(v) ((int)((v >> 8) & 0xFF)) | |
43 | #define HPI_VER_RELEASE(v) ((int)(v & 0xFF)) | |
44 | ||
45 | /* Use single digits for versions less that 10 to avoid octal. */ | |
0a00044d EB |
46 | #define HPI_VER HPI_VERSION_CONSTRUCTOR(4L, 5, 19) |
47 | #define HPI_VER_STRING "4.05.19" | |
719f82d3 EB |
48 | |
49 | /* Library version as documented in hpi-api-versions.txt */ | |
50 | #define HPI_LIB_VER HPI_VERSION_CONSTRUCTOR(9, 0, 0) | |
51 | ||
52 | #include <linux/types.h> | |
53 | #define HPI_EXCLUDE_DEPRECATED | |
54 | ||
719f82d3 EB |
55 | /******************************************************************************/ |
56 | /******** HPI API DEFINITIONS *****/ | |
57 | /******************************************************************************/ | |
ad210ad1 | 58 | |
719f82d3 EB |
59 | /*******************************************/ |
60 | /** Audio format types | |
61 | \ingroup stream | |
62 | */ | |
63 | enum HPI_FORMATS { | |
64 | /** Used internally on adapter. */ | |
65 | HPI_FORMAT_MIXER_NATIVE = 0, | |
66 | /** 8-bit unsigned PCM. Windows equivalent is WAVE_FORMAT_PCM. */ | |
67 | HPI_FORMAT_PCM8_UNSIGNED = 1, | |
68 | /** 16-bit signed PCM. Windows equivalent is WAVE_FORMAT_PCM. */ | |
69 | HPI_FORMAT_PCM16_SIGNED = 2, | |
70 | /** MPEG-1 Layer-1. */ | |
71 | HPI_FORMAT_MPEG_L1 = 3, | |
72 | /** MPEG-1 Layer-2. | |
73 | ||
74 | Windows equivalent is WAVE_FORMAT_MPEG. | |
75 | ||
76 | The following table shows what combinations of mode and bitrate are possible: | |
77 | ||
78 | <table border=1 cellspacing=0 cellpadding=5> | |
79 | <tr> | |
80 | <td><p><b>Bitrate (kbs)</b></p> | |
81 | <td><p><b>Mono</b></p> | |
82 | <td><p><b>Stereo,<br>Joint Stereo or<br>Dual Channel</b></p> | |
83 | ||
84 | <tr><td>32<td>X<td>_ | |
85 | <tr><td>40<td>_<td>_ | |
86 | <tr><td>48<td>X<td>_ | |
87 | <tr><td>56<td>X<td>_ | |
88 | <tr><td>64<td>X<td>X | |
89 | <tr><td>80<td>X<td>_ | |
90 | <tr><td>96<td>X<td>X | |
91 | <tr><td>112<td>X<td>X | |
92 | <tr><td>128<td>X<td>X | |
93 | <tr><td>160<td>X<td>X | |
94 | <tr><td>192<td>X<td>X | |
95 | <tr><td>224<td>_<td>X | |
96 | <tr><td>256<td>-<td>X | |
97 | <tr><td>320<td>-<td>X | |
98 | <tr><td>384<td>_<td>X | |
99 | </table> | |
100 | */ | |
101 | HPI_FORMAT_MPEG_L2 = 4, | |
102 | /** MPEG-1 Layer-3. | |
103 | Windows equivalent is WAVE_FORMAT_MPEG. | |
104 | ||
105 | The following table shows what combinations of mode and bitrate are possible: | |
106 | ||
107 | <table border=1 cellspacing=0 cellpadding=5> | |
108 | <tr> | |
109 | <td><p><b>Bitrate (kbs)</b></p> | |
110 | <td><p><b>Mono<br>Stereo @ 8,<br>11.025 and<br>12kHz*</b></p> | |
111 | <td><p><b>Mono<br>Stereo @ 16,<br>22.050 and<br>24kHz*</b></p> | |
112 | <td><p><b>Mono<br>Stereo @ 32,<br>44.1 and<br>48kHz</b></p> | |
113 | ||
114 | <tr><td>16<td>X<td>X<td>_ | |
115 | <tr><td>24<td>X<td>X<td>_ | |
116 | <tr><td>32<td>X<td>X<td>X | |
117 | <tr><td>40<td>X<td>X<td>X | |
118 | <tr><td>48<td>X<td>X<td>X | |
119 | <tr><td>56<td>X<td>X<td>X | |
120 | <tr><td>64<td>X<td>X<td>X | |
121 | <tr><td>80<td>_<td>X<td>X | |
122 | <tr><td>96<td>_<td>X<td>X | |
123 | <tr><td>112<td>_<td>X<td>X | |
124 | <tr><td>128<td>_<td>X<td>X | |
125 | <tr><td>144<td>_<td>X<td>_ | |
126 | <tr><td>160<td>_<td>X<td>X | |
127 | <tr><td>192<td>_<td>_<td>X | |
128 | <tr><td>224<td>_<td>_<td>X | |
129 | <tr><td>256<td>-<td>_<td>X | |
130 | <tr><td>320<td>-<td>_<td>X | |
131 | </table> | |
132 | \b * Available on the ASI6000 series only | |
133 | */ | |
134 | HPI_FORMAT_MPEG_L3 = 5, | |
135 | /** Dolby AC-2. */ | |
136 | HPI_FORMAT_DOLBY_AC2 = 6, | |
137 | /** Dolbt AC-3. */ | |
138 | HPI_FORMAT_DOLBY_AC3 = 7, | |
139 | /** 16-bit PCM big-endian. */ | |
140 | HPI_FORMAT_PCM16_BIGENDIAN = 8, | |
141 | /** TAGIT-1 algorithm - hits. */ | |
142 | HPI_FORMAT_AA_TAGIT1_HITS = 9, | |
143 | /** TAGIT-1 algorithm - inserts. */ | |
144 | HPI_FORMAT_AA_TAGIT1_INSERTS = 10, | |
145 | /** 32-bit signed PCM. Windows equivalent is WAVE_FORMAT_PCM. | |
146 | Each sample is a 32bit word. The most significant 24 bits contain a 24-bit | |
147 | sample and the least significant 8 bits are set to 0. | |
148 | */ | |
149 | HPI_FORMAT_PCM32_SIGNED = 11, | |
150 | /** Raw bitstream - unknown format. */ | |
151 | HPI_FORMAT_RAW_BITSTREAM = 12, | |
152 | /** TAGIT-1 algorithm hits - extended. */ | |
153 | HPI_FORMAT_AA_TAGIT1_HITS_EX1 = 13, | |
154 | /** 32-bit PCM as an IEEE float. Windows equivalent is WAVE_FORMAT_IEEE_FLOAT. | |
155 | Each sample is a 32bit word in IEEE754 floating point format. | |
156 | The range is +1.0 to -1.0, which corresponds to digital fullscale. | |
157 | */ | |
158 | HPI_FORMAT_PCM32_FLOAT = 14, | |
159 | /** 24-bit PCM signed. Windows equivalent is WAVE_FORMAT_PCM. */ | |
160 | HPI_FORMAT_PCM24_SIGNED = 15, | |
161 | /** OEM format 1 - private. */ | |
162 | HPI_FORMAT_OEM1 = 16, | |
163 | /** OEM format 2 - private. */ | |
164 | HPI_FORMAT_OEM2 = 17, | |
165 | /** Undefined format. */ | |
166 | HPI_FORMAT_UNDEFINED = 0xffff | |
167 | }; | |
168 | ||
719f82d3 EB |
169 | /*******************************************/ |
170 | /** Stream States | |
171 | \ingroup stream | |
172 | */ | |
173 | enum HPI_STREAM_STATES { | |
174 | /** State stopped - stream is stopped. */ | |
175 | HPI_STATE_STOPPED = 1, | |
176 | /** State playing - stream is playing audio. */ | |
177 | HPI_STATE_PLAYING = 2, | |
178 | /** State recording - stream is recording. */ | |
179 | HPI_STATE_RECORDING = 3, | |
180 | /** State drained - playing stream ran out of data to play. */ | |
181 | HPI_STATE_DRAINED = 4, | |
182 | /** State generate sine - to be implemented. */ | |
183 | HPI_STATE_SINEGEN = 5, | |
184 | /** State wait - used for inter-card sync to mean waiting for all | |
185 | cards to be ready. */ | |
186 | HPI_STATE_WAIT = 6 | |
187 | }; | |
ba94455c | 188 | /*******************************************/ |
719f82d3 EB |
189 | /** Source node types |
190 | \ingroup mixer | |
191 | */ | |
192 | enum HPI_SOURCENODES { | |
193 | /** This define can be used instead of 0 to indicate | |
194 | that there is no valid source node. A control that | |
195 | exists on a destination node can be searched for using a source | |
196 | node value of either 0, or HPI_SOURCENODE_NONE */ | |
197 | HPI_SOURCENODE_NONE = 100, | |
719f82d3 EB |
198 | /** Out Stream (Play) node. */ |
199 | HPI_SOURCENODE_OSTREAM = 101, | |
200 | /** Line in node - could be analog, AES/EBU or network. */ | |
201 | HPI_SOURCENODE_LINEIN = 102, | |
202 | HPI_SOURCENODE_AESEBU_IN = 103, /**< AES/EBU input node. */ | |
203 | HPI_SOURCENODE_TUNER = 104, /**< tuner node. */ | |
204 | HPI_SOURCENODE_RF = 105, /**< RF input node. */ | |
205 | HPI_SOURCENODE_CLOCK_SOURCE = 106, /**< clock source node. */ | |
206 | HPI_SOURCENODE_RAW_BITSTREAM = 107, /**< raw bitstream node. */ | |
207 | HPI_SOURCENODE_MICROPHONE = 108, /**< microphone node. */ | |
208 | /** Cobranet input node - | |
209 | Audio samples come from the Cobranet network and into the device. */ | |
210 | HPI_SOURCENODE_COBRANET = 109, | |
211 | HPI_SOURCENODE_ANALOG = 110, /**< analog input node. */ | |
212 | HPI_SOURCENODE_ADAPTER = 111, /**< adapter node. */ | |
213 | /* !!!Update this AND hpidebug.h if you add a new sourcenode type!!! */ | |
214 | HPI_SOURCENODE_LAST_INDEX = 111 /**< largest ID */ | |
215 | /* AX6 max sourcenode types = 15 */ | |
216 | }; | |
217 | ||
ba94455c | 218 | /*******************************************/ |
719f82d3 EB |
219 | /** Destination node types |
220 | \ingroup mixer | |
221 | */ | |
222 | enum HPI_DESTNODES { | |
223 | /** This define can be used instead of 0 to indicate | |
224 | that there is no valid destination node. A control that | |
225 | exists on a source node can be searched for using a destination | |
226 | node value of either 0, or HPI_DESTNODE_NONE */ | |
227 | HPI_DESTNODE_NONE = 200, | |
719f82d3 EB |
228 | /** In Stream (Record) node. */ |
229 | HPI_DESTNODE_ISTREAM = 201, | |
230 | HPI_DESTNODE_LINEOUT = 202, /**< line out node. */ | |
231 | HPI_DESTNODE_AESEBU_OUT = 203, /**< AES/EBU output node. */ | |
232 | HPI_DESTNODE_RF = 204, /**< RF output node. */ | |
233 | HPI_DESTNODE_SPEAKER = 205, /**< speaker output node. */ | |
234 | /** Cobranet output node - | |
235 | Audio samples from the device are sent out on the Cobranet network.*/ | |
236 | HPI_DESTNODE_COBRANET = 206, | |
237 | HPI_DESTNODE_ANALOG = 207, /**< analog output node. */ | |
238 | ||
239 | /* !!!Update this AND hpidebug.h if you add a new destnode type!!! */ | |
240 | HPI_DESTNODE_LAST_INDEX = 207 /**< largest ID */ | |
241 | /* AX6 max destnode types = 15 */ | |
242 | }; | |
243 | ||
244 | /*******************************************/ | |
245 | /** Mixer control types | |
246 | \ingroup mixer | |
247 | */ | |
248 | enum HPI_CONTROLS { | |
249 | HPI_CONTROL_GENERIC = 0, /**< generic control. */ | |
250 | HPI_CONTROL_CONNECTION = 1, /**< A connection between nodes. */ | |
251 | HPI_CONTROL_VOLUME = 2, /**< volume control - works in dB_fs. */ | |
252 | HPI_CONTROL_METER = 3, /**< peak meter control. */ | |
253 | HPI_CONTROL_MUTE = 4, /*mute control - not used at present. */ | |
254 | HPI_CONTROL_MULTIPLEXER = 5, /**< multiplexer control. */ | |
255 | ||
ba94455c | 256 | HPI_CONTROL_AESEBU_TRANSMITTER = 6, /**< AES/EBU transmitter control */ |
ad210ad1 | 257 | HPI_CONTROL_AESEBUTX = 6, /* HPI_CONTROL_AESEBU_TRANSMITTER */ |
719f82d3 EB |
258 | |
259 | HPI_CONTROL_AESEBU_RECEIVER = 7, /**< AES/EBU receiver control. */ | |
ad210ad1 | 260 | HPI_CONTROL_AESEBURX = 7, /* HPI_CONTROL_AESEBU_RECEIVER */ |
719f82d3 EB |
261 | |
262 | HPI_CONTROL_LEVEL = 8, /**< level/trim control - works in d_bu. */ | |
263 | HPI_CONTROL_TUNER = 9, /**< tuner control. */ | |
264 | /* HPI_CONTROL_ONOFFSWITCH = 10 */ | |
265 | HPI_CONTROL_VOX = 11, /**< vox control. */ | |
266 | /* HPI_CONTROL_AES18_TRANSMITTER = 12 */ | |
267 | /* HPI_CONTROL_AES18_RECEIVER = 13 */ | |
268 | /* HPI_CONTROL_AES18_BLOCKGENERATOR = 14 */ | |
269 | HPI_CONTROL_CHANNEL_MODE = 15, /**< channel mode control. */ | |
270 | ||
271 | HPI_CONTROL_BITSTREAM = 16, /**< bitstream control. */ | |
272 | HPI_CONTROL_SAMPLECLOCK = 17, /**< sample clock control. */ | |
273 | HPI_CONTROL_MICROPHONE = 18, /**< microphone control. */ | |
274 | HPI_CONTROL_PARAMETRIC_EQ = 19, /**< parametric EQ control. */ | |
ad210ad1 | 275 | HPI_CONTROL_EQUALIZER = 19, /*HPI_CONTROL_PARAMETRIC_EQ */ |
719f82d3 EB |
276 | |
277 | HPI_CONTROL_COMPANDER = 20, /**< compander control. */ | |
278 | HPI_CONTROL_COBRANET = 21, /**< cobranet control. */ | |
279 | HPI_CONTROL_TONEDETECTOR = 22, /**< tone detector control. */ | |
280 | HPI_CONTROL_SILENCEDETECTOR = 23, /**< silence detector control. */ | |
281 | HPI_CONTROL_PAD = 24, /**< tuner PAD control. */ | |
282 | HPI_CONTROL_SRC = 25, /**< samplerate converter control. */ | |
283 | HPI_CONTROL_UNIVERSAL = 26, /**< universal control. */ | |
284 | ||
285 | /* !!! Update this AND hpidebug.h if you add a new control type!!!*/ | |
286 | HPI_CONTROL_LAST_INDEX = 26 /**<highest control type ID */ | |
287 | /* WARNING types 256 or greater impact bit packing in all AX6 DSP code */ | |
288 | }; | |
289 | ||
ba94455c | 290 | /*******************************************/ |
719f82d3 EB |
291 | /** Adapter properties |
292 | These are used in HPI_AdapterSetProperty() and HPI_AdapterGetProperty() | |
293 | \ingroup adapter | |
294 | */ | |
295 | enum HPI_ADAPTER_PROPERTIES { | |
296 | /** \internal Used in dwProperty field of HPI_AdapterSetProperty() and | |
297 | HPI_AdapterGetProperty(). This errata applies to all ASI6000 cards with both | |
298 | analog and digital outputs. The CS4224 A/D+D/A has a one sample delay between | |
299 | left and right channels on both its input (ADC) and output (DAC). | |
300 | More details are available in Cirrus Logic errata ER284B2. | |
301 | PDF available from www.cirrus.com, released by Cirrus in 2001. | |
302 | */ | |
303 | HPI_ADAPTER_PROPERTY_ERRATA_1 = 1, | |
304 | ||
305 | /** Adapter grouping property | |
306 | Indicates whether the adapter supports the grouping API (for ASIO and SSX2) | |
307 | */ | |
308 | HPI_ADAPTER_PROPERTY_GROUPING = 2, | |
309 | ||
310 | /** Driver SSX2 property | |
311 | Tells the kernel driver to turn on SSX2 stream mapping. | |
312 | This feature is not used by the DSP. In fact the call is completely processed | |
313 | by the driver and is not passed on to the DSP at all. | |
314 | */ | |
315 | HPI_ADAPTER_PROPERTY_ENABLE_SSX2 = 3, | |
316 | ||
317 | /** Adapter SSX2 property | |
318 | Indicates the state of the adapter's SSX2 setting. This setting is stored in | |
319 | non-volatile memory on the adapter. A typical call sequence would be to use | |
320 | HPI_ADAPTER_PROPERTY_SSX2_SETTING to set SSX2 on the adapter and then to reload | |
ba94455c EB |
321 | the driver. The driver would query HPI_ADAPTER_PROPERTY_SSX2_SETTING during |
322 | startup and if SSX2 is set, it would then call HPI_ADAPTER_PROPERTY_ENABLE_SSX2 | |
323 | to enable SSX2 stream mapping within the kernel level of the driver. | |
719f82d3 EB |
324 | */ |
325 | HPI_ADAPTER_PROPERTY_SSX2_SETTING = 4, | |
326 | ||
327 | /** Base number for readonly properties */ | |
328 | HPI_ADAPTER_PROPERTY_READONLYBASE = 256, | |
329 | ||
330 | /** Readonly adapter latency property. | |
331 | This property returns in the input and output latency in samples. | |
332 | Property 1 is the estimated input latency | |
333 | in samples, while Property 2 is that output latency in samples. | |
334 | */ | |
335 | HPI_ADAPTER_PROPERTY_LATENCY = 256, | |
336 | ||
337 | /** Readonly adapter granularity property. | |
338 | The granulariy is the smallest size chunk of stereo samples that is processed by | |
339 | the adapter. | |
340 | This property returns the record granularity in samples in Property 1. | |
341 | Property 2 returns the play granularity. | |
342 | */ | |
343 | HPI_ADAPTER_PROPERTY_GRANULARITY = 257, | |
344 | ||
345 | /** Readonly adapter number of current channels property. | |
346 | Property 1 is the number of record channels per record device. | |
347 | Property 2 is the number of play channels per playback device.*/ | |
348 | HPI_ADAPTER_PROPERTY_CURCHANNELS = 258, | |
349 | ||
350 | /** Readonly adapter software version. | |
351 | The SOFTWARE_VERSION property returns the version of the software running | |
352 | on the adapter as Major.Minor.Release. | |
353 | Property 1 contains Major in bits 15..8 and Minor in bits 7..0. | |
354 | Property 2 contains Release in bits 7..0. */ | |
355 | HPI_ADAPTER_PROPERTY_SOFTWARE_VERSION = 259, | |
356 | ||
357 | /** Readonly adapter MAC address MSBs. | |
358 | The MAC_ADDRESS_MSB property returns | |
359 | the most significant 32 bits of the MAC address. | |
360 | Property 1 contains bits 47..32 of the MAC address. | |
361 | Property 2 contains bits 31..16 of the MAC address. */ | |
362 | HPI_ADAPTER_PROPERTY_MAC_ADDRESS_MSB = 260, | |
363 | ||
364 | /** Readonly adapter MAC address LSBs | |
365 | The MAC_ADDRESS_LSB property returns | |
366 | the least significant 16 bits of the MAC address. | |
367 | Property 1 contains bits 15..0 of the MAC address. */ | |
368 | HPI_ADAPTER_PROPERTY_MAC_ADDRESS_LSB = 261, | |
369 | ||
370 | /** Readonly extended adapter type number | |
371 | The EXTENDED_ADAPTER_TYPE property returns the 4 digits of an extended | |
372 | adapter type, i.e ASI8920-0022, 0022 is the extended type. | |
373 | The digits are returned as ASCII characters rather than the hex digits that | |
374 | are returned for the main type | |
375 | Property 1 returns the 1st two (left most) digits, i.e "00" | |
376 | in the example above, the upper byte being the left most digit. | |
377 | Property 2 returns the 2nd two digits, i.e "22" in the example above*/ | |
378 | HPI_ADAPTER_PROPERTY_EXTENDED_ADAPTER_TYPE = 262, | |
379 | ||
380 | /** Readonly debug log buffer information */ | |
381 | HPI_ADAPTER_PROPERTY_LOGTABLEN = 263, | |
382 | HPI_ADAPTER_PROPERTY_LOGTABBEG = 264, | |
383 | ||
384 | /** Readonly adapter IP address | |
385 | For 192.168.1.101 | |
386 | Property 1 returns the 1st two (left most) digits, i.e 192*256 + 168 | |
387 | in the example above, the upper byte being the left most digit. | |
388 | Property 2 returns the 2nd two digits, i.e 1*256 + 101 in the example above, */ | |
389 | HPI_ADAPTER_PROPERTY_IP_ADDRESS = 265, | |
390 | ||
391 | /** Readonly adapter buffer processed count. Returns a buffer processed count | |
392 | that is incremented every time all buffers for all streams are updated. This | |
393 | is useful for checking completion of all stream operations across the adapter | |
394 | when using grouped streams. | |
395 | */ | |
396 | HPI_ADAPTER_PROPERTY_BUFFER_UPDATE_COUNT = 266, | |
397 | ||
398 | /** Readonly mixer and stream intervals | |
399 | ||
400 | These intervals are measured in mixer frames. | |
401 | To convert to time, divide by the adapter samplerate. | |
402 | ||
403 | The mixer interval is the number of frames processed in one mixer iteration. | |
404 | The stream update interval is the interval at which streams check for and | |
405 | process data, and BBM host buffer counters are updated. | |
406 | ||
407 | Property 1 is the mixer interval in mixer frames. | |
408 | Property 2 is the stream update interval in mixer frames. | |
409 | */ | |
410 | HPI_ADAPTER_PROPERTY_INTERVAL = 267, | |
411 | /** Adapter capabilities 1 | |
412 | Property 1 - adapter can do multichannel (SSX1) | |
413 | Property 2 - adapter can do stream grouping (supports SSX2) | |
414 | */ | |
415 | HPI_ADAPTER_PROPERTY_CAPS1 = 268, | |
416 | /** Adapter capabilities 2 | |
417 | Property 1 - adapter can do samplerate conversion (MRX) | |
418 | Property 2 - adapter can do timestretch (TSX) | |
419 | */ | |
168f1b07 EB |
420 | HPI_ADAPTER_PROPERTY_CAPS2 = 269, |
421 | ||
422 | /** Readonly adapter sync header connection count. | |
423 | */ | |
424 | HPI_ADAPTER_PROPERTY_SYNC_HEADER_CONNECTIONS = 270, | |
425 | /** Readonly supports SSX2 property. | |
426 | Indicates the adapter supports SSX2 in some mode setting. The | |
427 | return value is true (1) or false (0). If the current adapter | |
428 | mode is MONO SSX2 is disabled, even though this property will | |
429 | return true. | |
430 | */ | |
431 | HPI_ADAPTER_PROPERTY_SUPPORTS_SSX2 = 271 | |
719f82d3 EB |
432 | }; |
433 | ||
434 | /** Adapter mode commands | |
435 | ||
0a00044d | 436 | Used in wQueryOrSet parameter of HPI_AdapterSetModeEx(). |
719f82d3 EB |
437 | \ingroup adapter |
438 | */ | |
439 | enum HPI_ADAPTER_MODE_CMDS { | |
0a00044d | 440 | /** Set the mode to the given parameter */ |
719f82d3 | 441 | HPI_ADAPTER_MODE_SET = 0, |
0a00044d EB |
442 | /** Return 0 or error depending whether mode is valid, |
443 | but don't set the mode */ | |
719f82d3 EB |
444 | HPI_ADAPTER_MODE_QUERY = 1 |
445 | }; | |
446 | ||
447 | /** Adapter Modes | |
ba94455c | 448 | These are used by HPI_AdapterSetModeEx() |
719f82d3 EB |
449 | |
450 | \warning - more than 16 possible modes breaks | |
451 | a bitmask in the Windows WAVE DLL | |
452 | \ingroup adapter | |
453 | */ | |
454 | enum HPI_ADAPTER_MODES { | |
455 | /** 4 outstream mode. | |
456 | - ASI6114: 1 instream | |
457 | - ASI6044: 4 instreams | |
458 | - ASI6012: 1 instream | |
459 | - ASI6102: no instreams | |
460 | - ASI6022, ASI6122: 2 instreams | |
461 | - ASI5111, ASI5101: 2 instreams | |
462 | - ASI652x, ASI662x: 2 instreams | |
463 | - ASI654x, ASI664x: 4 instreams | |
464 | */ | |
465 | HPI_ADAPTER_MODE_4OSTREAM = 1, | |
466 | ||
467 | /** 6 outstream mode. | |
468 | - ASI6012: 1 instream, | |
469 | - ASI6022, ASI6122: 2 instreams | |
470 | - ASI652x, ASI662x: 4 instreams | |
471 | */ | |
472 | HPI_ADAPTER_MODE_6OSTREAM = 2, | |
473 | ||
474 | /** 8 outstream mode. | |
475 | - ASI6114: 8 instreams | |
476 | - ASI6118: 8 instreams | |
477 | - ASI6585: 8 instreams | |
478 | */ | |
479 | HPI_ADAPTER_MODE_8OSTREAM = 3, | |
480 | ||
481 | /** 16 outstream mode. | |
482 | - ASI6416 16 instreams | |
483 | - ASI6518, ASI6618 16 instreams | |
484 | - ASI6118 16 mono out and in streams | |
485 | */ | |
486 | HPI_ADAPTER_MODE_16OSTREAM = 4, | |
487 | ||
488 | /** one outstream mode. | |
489 | - ASI5111 1 outstream, 1 instream | |
490 | */ | |
491 | HPI_ADAPTER_MODE_1OSTREAM = 5, | |
492 | ||
493 | /** ASI504X mode 1. 12 outstream, 4 instream 0 to 48kHz sample rates | |
494 | (see ASI504X datasheet for more info). | |
495 | */ | |
496 | HPI_ADAPTER_MODE_1 = 6, | |
497 | ||
498 | /** ASI504X mode 2. 4 outstreams, 4 instreams at 0 to 192kHz sample rates | |
499 | (see ASI504X datasheet for more info). | |
500 | */ | |
501 | HPI_ADAPTER_MODE_2 = 7, | |
502 | ||
503 | /** ASI504X mode 3. 4 outstreams, 4 instreams at 0 to 192kHz sample rates | |
504 | (see ASI504X datasheet for more info). | |
505 | */ | |
506 | HPI_ADAPTER_MODE_3 = 8, | |
507 | ||
508 | /** ASI504X multichannel mode. | |
509 | 2 outstreams -> 4 line outs = 1 to 8 channel streams), | |
510 | 4 lineins -> 1 instream (1 to 8 channel streams) at 0-48kHz. | |
511 | For more info see the SSX Specification. | |
512 | */ | |
513 | HPI_ADAPTER_MODE_MULTICHANNEL = 9, | |
514 | ||
515 | /** 12 outstream mode. | |
516 | - ASI6514, ASI6614: 2 instreams | |
517 | - ASI6540,ASI6544: 8 instreams | |
518 | - ASI6640,ASI6644: 8 instreams | |
519 | */ | |
520 | HPI_ADAPTER_MODE_12OSTREAM = 10, | |
521 | ||
522 | /** 9 outstream mode. | |
523 | - ASI6044: 8 instreams | |
524 | */ | |
525 | HPI_ADAPTER_MODE_9OSTREAM = 11, | |
526 | ||
527 | /** mono mode. | |
528 | - ASI6416: 16 outstreams/instreams | |
529 | - ASI5402: 2 outstreams/instreams | |
530 | */ | |
531 | HPI_ADAPTER_MODE_MONO = 12, | |
532 | ||
533 | /** Low latency mode. | |
534 | - ASI6416/ASI6316: 1 16 channel outstream and instream | |
535 | */ | |
536 | HPI_ADAPTER_MODE_LOW_LATENCY = 13 | |
537 | }; | |
538 | ||
539 | /* Note, adapters can have more than one capability - | |
540 | encoding as bitfield is recommended. */ | |
541 | #define HPI_CAPABILITY_NONE (0) | |
542 | #define HPI_CAPABILITY_MPEG_LAYER3 (1) | |
543 | ||
544 | /* Set this equal to maximum capability index, | |
545 | Must not be greater than 32 - see axnvdef.h */ | |
546 | #define HPI_CAPABILITY_MAX 1 | |
547 | /* #define HPI_CAPABILITY_AAC 2 */ | |
548 | ||
549 | /******************************************* STREAM ATTRIBUTES ****/ | |
550 | ||
551 | /** MPEG Ancillary Data modes | |
552 | ||
553 | The mode for the ancillary data insertion or extraction to operate in. | |
554 | \ingroup stream | |
555 | */ | |
556 | enum HPI_MPEG_ANC_MODES { | |
557 | /** the MPEG frames have energy information stored in them (5 bytes per stereo frame, 3 per mono) */ | |
558 | HPI_MPEG_ANC_HASENERGY = 0, | |
559 | /** the entire ancillary data field is taken up by data from the Anc data buffer | |
560 | On encode, the encoder will insert the energy bytes before filling the remainder | |
561 | of the ancillary data space with data from the ancillary data buffer. | |
562 | */ | |
563 | HPI_MPEG_ANC_RAW = 1 | |
564 | }; | |
565 | ||
566 | /** Ancillary Data Alignment | |
567 | \ingroup instream | |
568 | */ | |
569 | enum HPI_ISTREAM_MPEG_ANC_ALIGNS { | |
570 | /** data is packed against the end of data, then padded to the end of frame */ | |
571 | HPI_MPEG_ANC_ALIGN_LEFT = 0, | |
572 | /** data is packed against the end of the frame */ | |
573 | HPI_MPEG_ANC_ALIGN_RIGHT = 1 | |
574 | }; | |
575 | ||
576 | /** MPEG modes | |
577 | MPEG modes - can be used optionally for HPI_FormatCreate() | |
578 | parameter dwAttributes. | |
579 | ||
580 | Using any mode setting other than HPI_MPEG_MODE_DEFAULT | |
581 | with single channel format will return an error. | |
582 | \ingroup stream | |
583 | */ | |
584 | enum HPI_MPEG_MODES { | |
585 | /** Causes the MPEG-1 Layer II bitstream to be recorded | |
586 | in single_channel mode when the number of channels is 1 and in stereo when the | |
587 | number of channels is 2. */ | |
588 | HPI_MPEG_MODE_DEFAULT = 0, | |
589 | /** Standard stereo without joint-stereo compression */ | |
590 | HPI_MPEG_MODE_STEREO = 1, | |
591 | /** Joint stereo */ | |
592 | HPI_MPEG_MODE_JOINTSTEREO = 2, | |
593 | /** Left and Right channels are completely independent */ | |
594 | HPI_MPEG_MODE_DUALCHANNEL = 3 | |
595 | }; | |
596 | /******************************************* MIXER ATTRIBUTES ****/ | |
597 | ||
598 | /* \defgroup mixer_flags Mixer flags for HPI_MIXER_GET_CONTROL_MULTIPLE_VALUES | |
599 | { | |
600 | */ | |
601 | #define HPI_MIXER_GET_CONTROL_MULTIPLE_CHANGED (0) | |
602 | #define HPI_MIXER_GET_CONTROL_MULTIPLE_RESET (1) | |
603 | /*}*/ | |
604 | ||
605 | /** Commands used by HPI_MixerStore() | |
606 | \ingroup mixer | |
607 | */ | |
608 | enum HPI_MIXER_STORE_COMMAND { | |
609 | /** Save all mixer control settings. */ | |
610 | HPI_MIXER_STORE_SAVE = 1, | |
611 | /** Restore all controls from saved. */ | |
612 | HPI_MIXER_STORE_RESTORE = 2, | |
613 | /** Delete saved control settings. */ | |
614 | HPI_MIXER_STORE_DELETE = 3, | |
615 | /** Enable auto storage of some control settings. */ | |
616 | HPI_MIXER_STORE_ENABLE = 4, | |
617 | /** Disable auto storage of some control settings. */ | |
618 | HPI_MIXER_STORE_DISABLE = 5, | |
619 | /** Save the attributes of a single control. */ | |
620 | HPI_MIXER_STORE_SAVE_SINGLE = 6 | |
621 | }; | |
622 | ||
ba94455c EB |
623 | /****************************/ |
624 | /* CONTROL ATTRIBUTE VALUES */ | |
625 | /****************************/ | |
626 | ||
719f82d3 EB |
627 | /** Used by mixer plugin enable functions |
628 | ||
ba94455c | 629 | E.g. HPI_ParametricEq_SetState() |
719f82d3 EB |
630 | \ingroup mixer |
631 | */ | |
632 | enum HPI_SWITCH_STATES { | |
633 | HPI_SWITCH_OFF = 0, /**< turn the mixer plugin on. */ | |
634 | HPI_SWITCH_ON = 1 /**< turn the mixer plugin off. */ | |
635 | }; | |
636 | ||
637 | /* Volume control special gain values */ | |
ba94455c | 638 | |
719f82d3 EB |
639 | /** volumes units are 100ths of a dB |
640 | \ingroup volume | |
641 | */ | |
642 | #define HPI_UNITS_PER_dB 100 | |
643 | /** turns volume control OFF or MUTE | |
644 | \ingroup volume | |
645 | */ | |
646 | #define HPI_GAIN_OFF (-100 * HPI_UNITS_PER_dB) | |
647 | ||
fc3a3990 EB |
648 | /** channel mask specifying all channels |
649 | \ingroup volume | |
650 | */ | |
651 | #define HPI_BITMASK_ALL_CHANNELS (0xFFFFFFFF) | |
652 | ||
719f82d3 EB |
653 | /** value returned for no signal |
654 | \ingroup meter | |
655 | */ | |
656 | #define HPI_METER_MINIMUM (-150 * HPI_UNITS_PER_dB) | |
657 | ||
658 | /** autofade profiles | |
659 | \ingroup volume | |
660 | */ | |
661 | enum HPI_VOLUME_AUTOFADES { | |
662 | /** log fade - dB attenuation changes linearly over time */ | |
663 | HPI_VOLUME_AUTOFADE_LOG = 2, | |
664 | /** linear fade - amplitude changes linearly */ | |
665 | HPI_VOLUME_AUTOFADE_LINEAR = 3 | |
666 | }; | |
667 | ||
668 | /** The physical encoding format of the AESEBU I/O. | |
669 | ||
ba94455c | 670 | Used in HPI_Aesebu_Transmitter_SetFormat(), HPI_Aesebu_Receiver_SetFormat() |
719f82d3 EB |
671 | along with related Get and Query functions |
672 | \ingroup aestx | |
673 | */ | |
674 | enum HPI_AESEBU_FORMATS { | |
675 | /** AES/EBU physical format - AES/EBU balanced "professional" */ | |
676 | HPI_AESEBU_FORMAT_AESEBU = 1, | |
677 | /** AES/EBU physical format - S/PDIF unbalanced "consumer" */ | |
678 | HPI_AESEBU_FORMAT_SPDIF = 2 | |
679 | }; | |
680 | ||
681 | /** AES/EBU error status bits | |
682 | ||
ba94455c | 683 | Returned by HPI_Aesebu_Receiver_GetErrorStatus() |
719f82d3 EB |
684 | \ingroup aesrx |
685 | */ | |
686 | enum HPI_AESEBU_ERRORS { | |
687 | /** bit0: 1 when PLL is not locked */ | |
688 | HPI_AESEBU_ERROR_NOT_LOCKED = 0x01, | |
689 | /** bit1: 1 when signal quality is poor */ | |
690 | HPI_AESEBU_ERROR_POOR_QUALITY = 0x02, | |
691 | /** bit2: 1 when there is a parity error */ | |
692 | HPI_AESEBU_ERROR_PARITY_ERROR = 0x04, | |
693 | /** bit3: 1 when there is a bi-phase coding violation */ | |
694 | HPI_AESEBU_ERROR_BIPHASE_VIOLATION = 0x08, | |
695 | /** bit4: 1 when the validity bit is high */ | |
696 | HPI_AESEBU_ERROR_VALIDITY = 0x10, | |
697 | /** bit5: 1 when the CRC error bit is high */ | |
698 | HPI_AESEBU_ERROR_CRC = 0x20 | |
699 | }; | |
700 | ||
701 | /** \addtogroup pad | |
702 | \{ | |
703 | */ | |
704 | /** The text string containing the station/channel combination. */ | |
705 | #define HPI_PAD_CHANNEL_NAME_LEN 16 | |
706 | /** The text string containing the artist. */ | |
707 | #define HPI_PAD_ARTIST_LEN 64 | |
708 | /** The text string containing the title. */ | |
709 | #define HPI_PAD_TITLE_LEN 64 | |
710 | /** The text string containing the comment. */ | |
711 | #define HPI_PAD_COMMENT_LEN 256 | |
712 | /** The PTY when the tuner has not recieved any PTY. */ | |
713 | #define HPI_PAD_PROGRAM_TYPE_INVALID 0xffff | |
714 | /** \} */ | |
715 | ||
716 | /** Data types for PTY string translation. | |
717 | \ingroup rds | |
718 | */ | |
719 | enum eHPI_RDS_type { | |
720 | HPI_RDS_DATATYPE_RDS = 0, /**< RDS bitstream.*/ | |
721 | HPI_RDS_DATATYPE_RBDS = 1 /**< RBDS bitstream.*/ | |
722 | }; | |
723 | ||
724 | /** Tuner bands | |
725 | ||
726 | Used for HPI_Tuner_SetBand(),HPI_Tuner_GetBand() | |
727 | \ingroup tuner | |
728 | */ | |
729 | enum HPI_TUNER_BAND { | |
730 | HPI_TUNER_BAND_AM = 1, /**< AM band */ | |
731 | HPI_TUNER_BAND_FM = 2, /**< FM band (mono) */ | |
732 | HPI_TUNER_BAND_TV_NTSC_M = 3, /**< NTSC-M TV band*/ | |
733 | HPI_TUNER_BAND_TV = 3, /* use TV_NTSC_M */ | |
734 | HPI_TUNER_BAND_FM_STEREO = 4, /**< FM band (stereo) */ | |
735 | HPI_TUNER_BAND_AUX = 5, /**< auxiliary input */ | |
736 | HPI_TUNER_BAND_TV_PAL_BG = 6, /**< PAL-B/G TV band*/ | |
737 | HPI_TUNER_BAND_TV_PAL_I = 7, /**< PAL-I TV band*/ | |
738 | HPI_TUNER_BAND_TV_PAL_DK = 8, /**< PAL-D/K TV band*/ | |
739 | HPI_TUNER_BAND_TV_SECAM_L = 9, /**< SECAM-L TV band*/ | |
740 | HPI_TUNER_BAND_LAST = 9 /**< the index of the last tuner band. */ | |
741 | }; | |
742 | ||
743 | /** Tuner mode attributes | |
744 | ||
745 | Used by HPI_Tuner_SetMode(), HPI_Tuner_GetMode() | |
746 | \ingroup tuner | |
747 | ||
748 | */ | |
749 | enum HPI_TUNER_MODES { | |
750 | HPI_TUNER_MODE_RSS = 1, /**< control RSS */ | |
751 | HPI_TUNER_MODE_RDS = 2 /**< control RBDS/RDS */ | |
752 | }; | |
753 | ||
754 | /** Tuner mode attribute values | |
755 | ||
756 | Used by HPI_Tuner_SetMode(), HPI_Tuner_GetMode() | |
757 | \ingroup tuner | |
758 | */ | |
759 | enum HPI_TUNER_MODE_VALUES { | |
760 | /* RSS attribute values */ | |
761 | HPI_TUNER_MODE_RSS_DISABLE = 0, /**< RSS disable */ | |
762 | HPI_TUNER_MODE_RSS_ENABLE = 1, /**< RSS enable */ | |
763 | ||
764 | /* RDS mode attributes */ | |
765 | HPI_TUNER_MODE_RDS_DISABLE = 0, /**< RDS - disabled */ | |
766 | HPI_TUNER_MODE_RDS_RDS = 1, /**< RDS - RDS mode */ | |
767 | HPI_TUNER_MODE_RDS_RBDS = 2 /**< RDS - RBDS mode */ | |
768 | }; | |
769 | ||
719f82d3 EB |
770 | /** Tuner Status Bits |
771 | ||
772 | These bitfield values are returned by a call to HPI_Tuner_GetStatus(). | |
773 | Multiple fields are returned from a single call. | |
774 | \ingroup tuner | |
775 | */ | |
776 | enum HPI_TUNER_STATUS_BITS { | |
777 | HPI_TUNER_VIDEO_COLOR_PRESENT = 0x0001, /**< video color is present. */ | |
ad210ad1 EB |
778 | HPI_TUNER_VIDEO_IS_60HZ = 0x0020, /**< 60 hz video detected. */ |
779 | HPI_TUNER_VIDEO_HORZ_SYNC_MISSING = 0x0040, /**< video HSYNC is missing. */ | |
780 | HPI_TUNER_VIDEO_STATUS_VALID = 0x0100, /**< video status is valid. */ | |
781 | HPI_TUNER_DIGITAL = 0x0200, /**< tuner reports digital programming. */ | |
782 | HPI_TUNER_MULTIPROGRAM = 0x0400, /**< tuner reports multiple programs. */ | |
783 | HPI_TUNER_PLL_LOCKED = 0x1000, /**< the tuner's PLL is locked. */ | |
784 | HPI_TUNER_FM_STEREO = 0x2000 /**< tuner reports back FM stereo. */ | |
719f82d3 EB |
785 | }; |
786 | ||
787 | /** Channel Modes | |
788 | Used for HPI_ChannelModeSet/Get() | |
789 | \ingroup channelmode | |
790 | */ | |
791 | enum HPI_CHANNEL_MODES { | |
792 | /** Left channel out = left channel in, Right channel out = right channel in. */ | |
793 | HPI_CHANNEL_MODE_NORMAL = 1, | |
794 | /** Left channel out = right channel in, Right channel out = left channel in. */ | |
795 | HPI_CHANNEL_MODE_SWAP = 2, | |
796 | /** Left channel out = left channel in, Right channel out = left channel in. */ | |
797 | HPI_CHANNEL_MODE_LEFT_TO_STEREO = 3, | |
798 | /** Left channel out = right channel in, Right channel out = right channel in.*/ | |
799 | HPI_CHANNEL_MODE_RIGHT_TO_STEREO = 4, | |
800 | /** Left channel out = (left channel in + right channel in)/2, | |
801 | Right channel out = mute. */ | |
802 | HPI_CHANNEL_MODE_STEREO_TO_LEFT = 5, | |
803 | /** Left channel out = mute, | |
804 | Right channel out = (right channel in + left channel in)/2. */ | |
805 | HPI_CHANNEL_MODE_STEREO_TO_RIGHT = 6, | |
806 | HPI_CHANNEL_MODE_LAST = 6 | |
807 | }; | |
808 | ||
809 | /** SampleClock source values | |
810 | \ingroup sampleclock | |
811 | */ | |
812 | enum HPI_SAMPLECLOCK_SOURCES { | |
813 | /** The sampleclock output is derived from its local samplerate generator. | |
814 | The local samplerate may be set using HPI_SampleClock_SetLocalRate(). */ | |
815 | HPI_SAMPLECLOCK_SOURCE_LOCAL = 1, | |
719f82d3 EB |
816 | /** The adapter is clocked from a dedicated AES/EBU SampleClock input.*/ |
817 | HPI_SAMPLECLOCK_SOURCE_AESEBU_SYNC = 2, | |
818 | /** From external wordclock connector */ | |
819 | HPI_SAMPLECLOCK_SOURCE_WORD = 3, | |
820 | /** Board-to-board header */ | |
821 | HPI_SAMPLECLOCK_SOURCE_WORD_HEADER = 4, | |
822 | /** FUTURE - SMPTE clock. */ | |
823 | HPI_SAMPLECLOCK_SOURCE_SMPTE = 5, | |
824 | /** One of the aesebu inputs */ | |
825 | HPI_SAMPLECLOCK_SOURCE_AESEBU_INPUT = 6, | |
719f82d3 EB |
826 | /** From a network interface e.g. Cobranet or Livewire at either 48 or 96kHz */ |
827 | HPI_SAMPLECLOCK_SOURCE_NETWORK = 8, | |
828 | /** From previous adjacent module (ASI2416 only)*/ | |
829 | HPI_SAMPLECLOCK_SOURCE_PREV_MODULE = 10, | |
830 | /*! Update this if you add a new clock source.*/ | |
831 | HPI_SAMPLECLOCK_SOURCE_LAST = 10 | |
832 | }; | |
833 | ||
ba94455c | 834 | /** Equalizer filter types. Used by HPI_ParametricEq_SetBand() |
719f82d3 EB |
835 | \ingroup parmeq |
836 | */ | |
837 | enum HPI_FILTER_TYPE { | |
838 | HPI_FILTER_TYPE_BYPASS = 0, /**< filter is turned off */ | |
839 | ||
840 | HPI_FILTER_TYPE_LOWSHELF = 1, /**< EQ low shelf */ | |
841 | HPI_FILTER_TYPE_HIGHSHELF = 2, /**< EQ high shelf */ | |
842 | HPI_FILTER_TYPE_EQ_BAND = 3, /**< EQ gain */ | |
843 | ||
844 | HPI_FILTER_TYPE_LOWPASS = 4, /**< standard low pass */ | |
845 | HPI_FILTER_TYPE_HIGHPASS = 5, /**< standard high pass */ | |
846 | HPI_FILTER_TYPE_BANDPASS = 6, /**< standard band pass */ | |
847 | HPI_FILTER_TYPE_BANDSTOP = 7 /**< standard band stop/notch */ | |
848 | }; | |
849 | ||
850 | /** Async Event sources | |
851 | \ingroup async | |
852 | */ | |
853 | enum ASYNC_EVENT_SOURCES { | |
854 | HPI_ASYNC_EVENT_GPIO = 1, /**< GPIO event. */ | |
855 | HPI_ASYNC_EVENT_SILENCE = 2, /**< silence event detected. */ | |
856 | HPI_ASYNC_EVENT_TONE = 3 /**< tone event detected. */ | |
857 | }; | |
858 | /*******************************************/ | |
859 | /** HPI Error codes | |
860 | ||
861 | Almost all HPI functions return an error code | |
862 | A return value of zero means there was no error. | |
863 | Otherwise one of these error codes is returned. | |
864 | Error codes can be converted to a descriptive string using HPI_GetErrorText() | |
865 | ||
866 | \note When a new error code is added HPI_GetErrorText() MUST be updated. | |
867 | \note Codes 1-100 are reserved for driver use | |
868 | \ingroup utility | |
869 | */ | |
870 | enum HPI_ERROR_CODES { | |
871 | /** Message type does not exist. */ | |
872 | HPI_ERROR_INVALID_TYPE = 100, | |
873 | /** Object type does not exist. */ | |
874 | HPI_ERROR_INVALID_OBJ = 101, | |
875 | /** Function does not exist. */ | |
876 | HPI_ERROR_INVALID_FUNC = 102, | |
ba94455c | 877 | /** The specified object does not exist. */ |
719f82d3 EB |
878 | HPI_ERROR_INVALID_OBJ_INDEX = 103, |
879 | /** Trying to access an object that has not been opened yet. */ | |
880 | HPI_ERROR_OBJ_NOT_OPEN = 104, | |
881 | /** Trying to open an already open object. */ | |
882 | HPI_ERROR_OBJ_ALREADY_OPEN = 105, | |
883 | /** PCI, ISA resource not valid. */ | |
884 | HPI_ERROR_INVALID_RESOURCE = 106, | |
0a00044d | 885 | /* HPI_ERROR_SUBSYSFINDADAPTERS_GETINFO= 107 */ |
719f82d3 EB |
886 | /** Default response was never updated with actual error code. */ |
887 | HPI_ERROR_INVALID_RESPONSE = 108, | |
888 | /** wSize field of response was not updated, | |
889 | indicating that the message was not processed. */ | |
890 | HPI_ERROR_PROCESSING_MESSAGE = 109, | |
891 | /** The network did not respond in a timely manner. */ | |
892 | HPI_ERROR_NETWORK_TIMEOUT = 110, | |
ba94455c | 893 | /* An HPI handle is invalid (uninitialised?). */ |
719f82d3 EB |
894 | HPI_ERROR_INVALID_HANDLE = 111, |
895 | /** A function or attribute has not been implemented yet. */ | |
896 | HPI_ERROR_UNIMPLEMENTED = 112, | |
ba94455c EB |
897 | /** There are too many clients attempting |
898 | to access a network resource. */ | |
719f82d3 | 899 | HPI_ERROR_NETWORK_TOO_MANY_CLIENTS = 113, |
ba94455c EB |
900 | /** Response buffer passed to HPI_Message |
901 | was smaller than returned response. | |
902 | wSpecificError field of hpi response contains the required size. | |
903 | */ | |
719f82d3 EB |
904 | HPI_ERROR_RESPONSE_BUFFER_TOO_SMALL = 114, |
905 | /** The returned response did not match the sent message */ | |
906 | HPI_ERROR_RESPONSE_MISMATCH = 115, | |
ad210ad1 EB |
907 | /** A control setting that should have been cached was not. */ |
908 | HPI_ERROR_CONTROL_CACHING = 116, | |
ba94455c EB |
909 | /** A message buffer in the path to the adapter was smaller |
910 | than the message size. | |
911 | wSpecificError field of hpi response contains the actual size. | |
912 | */ | |
913 | HPI_ERROR_MESSAGE_BUFFER_TOO_SMALL = 117, | |
719f82d3 | 914 | |
0a00044d | 915 | /* HPI_ERROR_TOO_MANY_ADAPTERS= 200 */ |
719f82d3 EB |
916 | /** Bad adpater. */ |
917 | HPI_ERROR_BAD_ADAPTER = 201, | |
918 | /** Adapter number out of range or not set properly. */ | |
919 | HPI_ERROR_BAD_ADAPTER_NUMBER = 202, | |
920 | /** 2 adapters with the same adapter number. */ | |
921 | HPI_DUPLICATE_ADAPTER_NUMBER = 203, | |
ba94455c | 922 | /** DSP code failed to bootload. (unused?) */ |
719f82d3 | 923 | HPI_ERROR_DSP_BOOTLOAD = 204, |
0a00044d EB |
924 | /** Communication with DSP failed */ |
925 | HPI_ERROR_DSP_COMMUNICATION = 205, | |
719f82d3 EB |
926 | /** Couldn't find or open the DSP code file. */ |
927 | HPI_ERROR_DSP_FILE_NOT_FOUND = 206, | |
928 | /** Internal DSP hardware error. */ | |
929 | HPI_ERROR_DSP_HARDWARE = 207, | |
719f82d3 EB |
930 | /** Could not allocate memory */ |
931 | HPI_ERROR_MEMORY_ALLOC = 208, | |
0a00044d | 932 | /** Failed to correctly load/config PLD. (unused) */ |
719f82d3 EB |
933 | HPI_ERROR_PLD_LOAD = 209, |
934 | /** Unexpected end of file, block length too big etc. */ | |
935 | HPI_ERROR_DSP_FILE_FORMAT = 210, | |
936 | ||
937 | /** Found but could not open DSP code file. */ | |
938 | HPI_ERROR_DSP_FILE_ACCESS_DENIED = 211, | |
939 | /** First DSP code section header not found in DSP file. */ | |
940 | HPI_ERROR_DSP_FILE_NO_HEADER = 212, | |
0a00044d | 941 | /* HPI_ERROR_DSP_FILE_READ_ERROR= 213, */ |
719f82d3 EB |
942 | /** DSP code for adapter family not found. */ |
943 | HPI_ERROR_DSP_SECTION_NOT_FOUND = 214, | |
944 | /** Other OS specific error opening DSP file. */ | |
945 | HPI_ERROR_DSP_FILE_OTHER_ERROR = 215, | |
946 | /** Sharing violation opening DSP code file. */ | |
947 | HPI_ERROR_DSP_FILE_SHARING_VIOLATION = 216, | |
948 | /** DSP code section header had size == 0. */ | |
949 | HPI_ERROR_DSP_FILE_NULL_HEADER = 217, | |
950 | ||
0a00044d | 951 | /* HPI_ERROR_FLASH = 220, */ |
719f82d3 EB |
952 | |
953 | /** Flash has bad checksum */ | |
ad210ad1 EB |
954 | HPI_ERROR_BAD_CHECKSUM = 221, |
955 | HPI_ERROR_BAD_SEQUENCE = 222, | |
956 | HPI_ERROR_FLASH_ERASE = 223, | |
957 | HPI_ERROR_FLASH_PROGRAM = 224, | |
958 | HPI_ERROR_FLASH_VERIFY = 225, | |
959 | HPI_ERROR_FLASH_TYPE = 226, | |
960 | HPI_ERROR_FLASH_START = 227, | |
719f82d3 EB |
961 | |
962 | /** Reserved for OEMs. */ | |
963 | HPI_ERROR_RESERVED_1 = 290, | |
964 | ||
1d595d2a | 965 | /* HPI_ERROR_INVALID_STREAM = 300 use HPI_ERROR_INVALID_OBJ_INDEX */ |
719f82d3 EB |
966 | /** Invalid compression format. */ |
967 | HPI_ERROR_INVALID_FORMAT = 301, | |
968 | /** Invalid format samplerate */ | |
969 | HPI_ERROR_INVALID_SAMPLERATE = 302, | |
970 | /** Invalid format number of channels. */ | |
971 | HPI_ERROR_INVALID_CHANNELS = 303, | |
972 | /** Invalid format bitrate. */ | |
973 | HPI_ERROR_INVALID_BITRATE = 304, | |
974 | /** Invalid datasize used for stream read/write. */ | |
975 | HPI_ERROR_INVALID_DATASIZE = 305, | |
1d595d2a EB |
976 | /* HPI_ERROR_BUFFER_FULL = 306 use HPI_ERROR_INVALID_DATASIZE */ |
977 | /* HPI_ERROR_BUFFER_EMPTY = 307 use HPI_ERROR_INVALID_DATASIZE */ | |
ba94455c EB |
978 | /** Null data pointer used for stream read/write. */ |
979 | HPI_ERROR_INVALID_DATA_POINTER = 308, | |
719f82d3 EB |
980 | /** Packet ordering error for stream read/write. */ |
981 | HPI_ERROR_INVALID_PACKET_ORDER = 309, | |
982 | ||
983 | /** Object can't do requested operation in its current | |
ba94455c | 984 | state, eg set format, change rec mux state while recording.*/ |
719f82d3 EB |
985 | HPI_ERROR_INVALID_OPERATION = 310, |
986 | ||
ba94455c EB |
987 | /** Where a SRG is shared amongst streams, an incompatible samplerate |
988 | is one that is different to any currently active stream. */ | |
719f82d3 EB |
989 | HPI_ERROR_INCOMPATIBLE_SAMPLERATE = 311, |
990 | /** Adapter mode is illegal.*/ | |
991 | HPI_ERROR_BAD_ADAPTER_MODE = 312, | |
992 | ||
993 | /** There have been too many attempts to set the adapter's | |
994 | capabilities (using bad keys), the card should be returned | |
995 | to ASI if further capabilities updates are required */ | |
996 | HPI_ERROR_TOO_MANY_CAPABILITY_CHANGE_ATTEMPTS = 313, | |
997 | /** Streams on different adapters cannot be grouped. */ | |
998 | HPI_ERROR_NO_INTERADAPTER_GROUPS = 314, | |
999 | /** Streams on different DSPs cannot be grouped. */ | |
1000 | HPI_ERROR_NO_INTERDSP_GROUPS = 315, | |
1001 | ||
1002 | /** Invalid mixer node for this adapter. */ | |
1003 | HPI_ERROR_INVALID_NODE = 400, | |
1004 | /** Invalid control. */ | |
1005 | HPI_ERROR_INVALID_CONTROL = 401, | |
1006 | /** Invalid control value was passed. */ | |
1007 | HPI_ERROR_INVALID_CONTROL_VALUE = 402, | |
1008 | /** Control attribute not supported by this control. */ | |
1009 | HPI_ERROR_INVALID_CONTROL_ATTRIBUTE = 403, | |
1010 | /** Control is disabled. */ | |
1011 | HPI_ERROR_CONTROL_DISABLED = 404, | |
1012 | /** I2C transaction failed due to a missing ACK. */ | |
1013 | HPI_ERROR_CONTROL_I2C_MISSING_ACK = 405, | |
0a00044d | 1014 | HPI_ERROR_I2C_MISSING_ACK = 405, |
719f82d3 EB |
1015 | /** Control is busy, or coming out of |
1016 | reset and cannot be accessed at this time. */ | |
1017 | HPI_ERROR_CONTROL_NOT_READY = 407, | |
1018 | ||
1019 | /** Non volatile memory */ | |
1020 | HPI_ERROR_NVMEM_BUSY = 450, | |
1021 | HPI_ERROR_NVMEM_FULL = 451, | |
1022 | HPI_ERROR_NVMEM_FAIL = 452, | |
1023 | ||
1024 | /** I2C */ | |
719f82d3 EB |
1025 | HPI_ERROR_I2C_BAD_ADR = 460, |
1026 | ||
1027 | /** Entity errors */ | |
1028 | HPI_ERROR_ENTITY_TYPE_MISMATCH = 470, | |
1029 | HPI_ERROR_ENTITY_ITEM_COUNT = 471, | |
1030 | HPI_ERROR_ENTITY_TYPE_INVALID = 472, | |
1031 | HPI_ERROR_ENTITY_ROLE_INVALID = 473, | |
ad210ad1 | 1032 | HPI_ERROR_ENTITY_SIZE_MISMATCH = 474, |
719f82d3 EB |
1033 | |
1034 | /* AES18 specific errors were 500..507 */ | |
1035 | ||
1036 | /** custom error to use for debugging */ | |
1037 | HPI_ERROR_CUSTOM = 600, | |
1038 | ||
1039 | /** hpioct32.c can't obtain mutex */ | |
1040 | HPI_ERROR_MUTEX_TIMEOUT = 700, | |
1041 | ||
1042 | /** errors from HPI backends have values >= this */ | |
ad210ad1 | 1043 | HPI_ERROR_BACKEND_BASE = 900 |
719f82d3 EB |
1044 | }; |
1045 | ||
1046 | /** \defgroup maximums HPI maximum values | |
1047 | \{ | |
1048 | */ | |
1049 | /** Maximum number of adapters per HPI sub-system | |
1050 | WARNING: modifying this value changes the response structure size.*/ | |
1051 | #define HPI_MAX_ADAPTERS 20 | |
1052 | /** Maximum number of in or out streams per adapter */ | |
1053 | #define HPI_MAX_STREAMS 16 | |
1054 | #define HPI_MAX_CHANNELS 2 /* per stream */ | |
1055 | #define HPI_MAX_NODES 8 /* per mixer ? */ | |
1056 | #define HPI_MAX_CONTROLS 4 /* per node ? */ | |
1057 | /** maximum number of ancillary bytes per MPEG frame */ | |
1058 | #define HPI_MAX_ANC_BYTES_PER_FRAME (64) | |
1059 | #define HPI_STRING_LEN 16 | |
1060 | ||
1061 | /** Velocity units */ | |
1062 | #define HPI_OSTREAM_VELOCITY_UNITS 4096 | |
1063 | /** OutStream timescale units */ | |
1064 | #define HPI_OSTREAM_TIMESCALE_UNITS 10000 | |
1065 | /** OutStream timescale passthrough - turns timescaling on in passthough mode */ | |
1066 | #define HPI_OSTREAM_TIMESCALE_PASSTHROUGH 99999 | |
1067 | ||
1068 | /**\}*/ | |
1069 | ||
ba94455c | 1070 | /**************/ |
719f82d3 EB |
1071 | /* STRUCTURES */ |
1072 | #ifndef DISABLE_PRAGMA_PACK1 | |
1073 | #pragma pack(push, 1) | |
1074 | #endif | |
1075 | ||
1076 | /** Structure containing sample format information. | |
1077 | See also HPI_FormatCreate(). | |
1078 | */ | |
1079 | struct hpi_format { | |
1080 | u32 sample_rate; | |
1081 | /**< 11025, 32000, 44100 ... */ | |
1082 | u32 bit_rate; /**< for MPEG */ | |
1083 | u32 attributes; | |
1084 | /**< Stereo/JointStereo/Mono */ | |
1085 | u16 mode_legacy; | |
1086 | /**< Legacy ancillary mode or idle bit */ | |
ad210ad1 | 1087 | u16 unused; /**< Unused */ |
719f82d3 EB |
1088 | u16 channels; /**< 1,2..., (or ancillary mode or idle bit */ |
1089 | u16 format; /**< HPI_FORMAT_PCM16, _MPEG etc. see #HPI_FORMATS. */ | |
1090 | }; | |
1091 | ||
1092 | struct hpi_anc_frame { | |
1093 | u32 valid_bits_in_this_frame; | |
1094 | u8 b_data[HPI_MAX_ANC_BYTES_PER_FRAME]; | |
1095 | }; | |
1096 | ||
1097 | /** An object for containing a single async event. | |
1098 | */ | |
1099 | struct hpi_async_event { | |
1100 | u16 event_type; /**< type of event. \sa async_event */ | |
1d595d2a EB |
1101 | u16 sequence; /**< Sequence number, allows lost event detection */ |
1102 | u32 state; /**< New state */ | |
1103 | u32 h_object; /**< handle to the object returning the event. */ | |
719f82d3 EB |
1104 | union { |
1105 | struct { | |
1106 | u16 index; /**< GPIO bit index. */ | |
1107 | } gpio; | |
1108 | struct { | |
1109 | u16 node_index; /**< what node is the control on ? */ | |
1d595d2a | 1110 | u16 node_type; /**< what type of node is the control on ? */ |
719f82d3 EB |
1111 | } control; |
1112 | } u; | |
1113 | }; | |
1114 | ||
719f82d3 EB |
1115 | /* skip host side function declarations for |
1116 | DSP compile and documentation extraction */ | |
1117 | ||
719f82d3 EB |
1118 | #ifndef DISABLE_PRAGMA_PACK1 |
1119 | #pragma pack(pop) | |
1120 | #endif | |
1121 | ||
ba94455c | 1122 | /*****************/ |
719f82d3 | 1123 | /* HPI FUNCTIONS */ |
ba94455c | 1124 | /*****************/ |
719f82d3 | 1125 | |
ba94455c | 1126 | /* Stream */ |
719f82d3 EB |
1127 | u16 hpi_stream_estimate_buffer_size(struct hpi_format *pF, |
1128 | u32 host_polling_rate_in_milli_seconds, u32 *recommended_buffer_size); | |
1129 | ||
ba94455c EB |
1130 | /*************/ |
1131 | /* SubSystem */ | |
1132 | /*************/ | |
719f82d3 | 1133 | |
ba94455c | 1134 | u16 hpi_subsys_get_version_ex(u32 *pversion_ex); |
719f82d3 | 1135 | |
ba94455c | 1136 | u16 hpi_subsys_get_num_adapters(int *pn_num_adapters); |
719f82d3 | 1137 | |
ba94455c EB |
1138 | u16 hpi_subsys_get_adapter(int iterator, u32 *padapter_index, |
1139 | u16 *pw_adapter_type); | |
719f82d3 | 1140 | |
ba94455c EB |
1141 | /***********/ |
1142 | /* Adapter */ | |
1143 | /***********/ | |
719f82d3 | 1144 | |
ba94455c | 1145 | u16 hpi_adapter_open(u16 adapter_index); |
719f82d3 | 1146 | |
ba94455c | 1147 | u16 hpi_adapter_close(u16 adapter_index); |
719f82d3 | 1148 | |
ba94455c EB |
1149 | u16 hpi_adapter_get_info(u16 adapter_index, u16 *pw_num_outstreams, |
1150 | u16 *pw_num_instreams, u16 *pw_version, u32 *pserial_number, | |
1151 | u16 *pw_adapter_type); | |
719f82d3 | 1152 | |
ba94455c EB |
1153 | u16 hpi_adapter_get_module_by_index(u16 adapter_index, u16 module_index, |
1154 | u16 *pw_num_outputs, u16 *pw_num_inputs, u16 *pw_version, | |
1155 | u32 *pserial_number, u16 *pw_module_type, u32 *ph_module); | |
719f82d3 | 1156 | |
ba94455c | 1157 | u16 hpi_adapter_set_mode(u16 adapter_index, u32 adapter_mode); |
719f82d3 | 1158 | |
ba94455c EB |
1159 | u16 hpi_adapter_set_mode_ex(u16 adapter_index, u32 adapter_mode, |
1160 | u16 query_or_set); | |
719f82d3 | 1161 | |
ba94455c | 1162 | u16 hpi_adapter_get_mode(u16 adapter_index, u32 *padapter_mode); |
719f82d3 | 1163 | |
ba94455c EB |
1164 | u16 hpi_adapter_get_assert2(u16 adapter_index, u16 *p_assert_count, |
1165 | char *psz_assert, u32 *p_param1, u32 *p_param2, | |
1166 | u32 *p_dsp_string_addr, u16 *p_processor_id); | |
719f82d3 | 1167 | |
ba94455c | 1168 | u16 hpi_adapter_test_assert(u16 adapter_index, u16 assert_id); |
719f82d3 | 1169 | |
ba94455c | 1170 | u16 hpi_adapter_enable_capability(u16 adapter_index, u16 capability, u32 key); |
719f82d3 | 1171 | |
ba94455c | 1172 | u16 hpi_adapter_self_test(u16 adapter_index); |
719f82d3 | 1173 | |
ba94455c EB |
1174 | u16 hpi_adapter_debug_read(u16 adapter_index, u32 dsp_address, char *p_bytes, |
1175 | int *count_bytes); | |
719f82d3 | 1176 | |
ba94455c EB |
1177 | u16 hpi_adapter_set_property(u16 adapter_index, u16 property, u16 paramter1, |
1178 | u16 paramter2); | |
719f82d3 | 1179 | |
ba94455c EB |
1180 | u16 hpi_adapter_get_property(u16 adapter_index, u16 property, |
1181 | u16 *pw_paramter1, u16 *pw_paramter2); | |
719f82d3 | 1182 | |
ba94455c EB |
1183 | u16 hpi_adapter_enumerate_property(u16 adapter_index, u16 index, |
1184 | u16 what_to_enumerate, u16 property_index, u32 *psetting); | |
1185 | /*************/ | |
1186 | /* OutStream */ | |
1187 | /*************/ | |
1188 | u16 hpi_outstream_open(u16 adapter_index, u16 outstream_index, | |
1189 | u32 *ph_outstream); | |
719f82d3 | 1190 | |
ba94455c | 1191 | u16 hpi_outstream_close(u32 h_outstream); |
719f82d3 | 1192 | |
ba94455c EB |
1193 | u16 hpi_outstream_get_info_ex(u32 h_outstream, u16 *pw_state, |
1194 | u32 *pbuffer_size, u32 *pdata_to_play, u32 *psamples_played, | |
1195 | u32 *pauxiliary_data_to_play); | |
719f82d3 | 1196 | |
ba94455c EB |
1197 | u16 hpi_outstream_write_buf(u32 h_outstream, const u8 *pb_write_buf, |
1198 | u32 bytes_to_write, const struct hpi_format *p_format); | |
719f82d3 | 1199 | |
ba94455c | 1200 | u16 hpi_outstream_start(u32 h_outstream); |
719f82d3 | 1201 | |
ba94455c | 1202 | u16 hpi_outstream_wait_start(u32 h_outstream); |
719f82d3 | 1203 | |
ba94455c | 1204 | u16 hpi_outstream_stop(u32 h_outstream); |
719f82d3 | 1205 | |
ba94455c | 1206 | u16 hpi_outstream_sinegen(u32 h_outstream); |
719f82d3 | 1207 | |
ba94455c | 1208 | u16 hpi_outstream_reset(u32 h_outstream); |
719f82d3 | 1209 | |
ba94455c | 1210 | u16 hpi_outstream_query_format(u32 h_outstream, struct hpi_format *p_format); |
719f82d3 | 1211 | |
ba94455c | 1212 | u16 hpi_outstream_set_format(u32 h_outstream, struct hpi_format *p_format); |
719f82d3 | 1213 | |
ba94455c EB |
1214 | u16 hpi_outstream_set_punch_in_out(u32 h_outstream, u32 punch_in_sample, |
1215 | u32 punch_out_sample); | |
719f82d3 | 1216 | |
ba94455c | 1217 | u16 hpi_outstream_set_velocity(u32 h_outstream, short velocity); |
719f82d3 | 1218 | |
ba94455c | 1219 | u16 hpi_outstream_ancillary_reset(u32 h_outstream, u16 mode); |
719f82d3 | 1220 | |
ba94455c | 1221 | u16 hpi_outstream_ancillary_get_info(u32 h_outstream, u32 *pframes_available); |
719f82d3 | 1222 | |
ba94455c EB |
1223 | u16 hpi_outstream_ancillary_read(u32 h_outstream, |
1224 | struct hpi_anc_frame *p_anc_frame_buffer, | |
719f82d3 EB |
1225 | u32 anc_frame_buffer_size_in_bytes, |
1226 | u32 number_of_ancillary_frames_to_read); | |
1227 | ||
ba94455c | 1228 | u16 hpi_outstream_set_time_scale(u32 h_outstream, u32 time_scaleX10000); |
719f82d3 | 1229 | |
ba94455c | 1230 | u16 hpi_outstream_host_buffer_allocate(u32 h_outstream, u32 size_in_bytes); |
719f82d3 | 1231 | |
ba94455c | 1232 | u16 hpi_outstream_host_buffer_free(u32 h_outstream); |
719f82d3 | 1233 | |
ba94455c | 1234 | u16 hpi_outstream_group_add(u32 h_outstream, u32 h_stream); |
719f82d3 | 1235 | |
ba94455c EB |
1236 | u16 hpi_outstream_group_get_map(u32 h_outstream, u32 *poutstream_map, |
1237 | u32 *pinstream_map); | |
719f82d3 | 1238 | |
ba94455c | 1239 | u16 hpi_outstream_group_reset(u32 h_outstream); |
719f82d3 | 1240 | |
ba94455c EB |
1241 | /************/ |
1242 | /* InStream */ | |
1243 | /************/ | |
1244 | u16 hpi_instream_open(u16 adapter_index, u16 instream_index, | |
1245 | u32 *ph_instream); | |
719f82d3 | 1246 | |
ba94455c | 1247 | u16 hpi_instream_close(u32 h_instream); |
719f82d3 | 1248 | |
ba94455c EB |
1249 | u16 hpi_instream_query_format(u32 h_instream, |
1250 | const struct hpi_format *p_format); | |
719f82d3 | 1251 | |
ba94455c EB |
1252 | u16 hpi_instream_set_format(u32 h_instream, |
1253 | const struct hpi_format *p_format); | |
719f82d3 | 1254 | |
ba94455c | 1255 | u16 hpi_instream_read_buf(u32 h_instream, u8 *pb_read_buf, u32 bytes_to_read); |
719f82d3 | 1256 | |
ba94455c | 1257 | u16 hpi_instream_start(u32 h_instream); |
719f82d3 | 1258 | |
ba94455c | 1259 | u16 hpi_instream_wait_start(u32 h_instream); |
719f82d3 | 1260 | |
ba94455c | 1261 | u16 hpi_instream_stop(u32 h_instream); |
719f82d3 | 1262 | |
ba94455c | 1263 | u16 hpi_instream_reset(u32 h_instream); |
719f82d3 | 1264 | |
ba94455c EB |
1265 | u16 hpi_instream_get_info_ex(u32 h_instream, u16 *pw_state, u32 *pbuffer_size, |
1266 | u32 *pdata_recorded, u32 *psamples_recorded, | |
1267 | u32 *pauxiliary_data_recorded); | |
719f82d3 | 1268 | |
ba94455c EB |
1269 | u16 hpi_instream_ancillary_reset(u32 h_instream, u16 bytes_per_frame, |
1270 | u16 mode, u16 alignment, u16 idle_bit); | |
719f82d3 | 1271 | |
ba94455c | 1272 | u16 hpi_instream_ancillary_get_info(u32 h_instream, u32 *pframe_space); |
719f82d3 | 1273 | |
ba94455c EB |
1274 | u16 hpi_instream_ancillary_write(u32 h_instream, |
1275 | const struct hpi_anc_frame *p_anc_frame_buffer, | |
719f82d3 EB |
1276 | u32 anc_frame_buffer_size_in_bytes, |
1277 | u32 number_of_ancillary_frames_to_write); | |
1278 | ||
ba94455c | 1279 | u16 hpi_instream_host_buffer_allocate(u32 h_instream, u32 size_in_bytes); |
719f82d3 | 1280 | |
ba94455c | 1281 | u16 hpi_instream_host_buffer_free(u32 h_instream); |
719f82d3 | 1282 | |
ba94455c | 1283 | u16 hpi_instream_group_add(u32 h_instream, u32 h_stream); |
719f82d3 | 1284 | |
ba94455c EB |
1285 | u16 hpi_instream_group_get_map(u32 h_instream, u32 *poutstream_map, |
1286 | u32 *pinstream_map); | |
719f82d3 | 1287 | |
ba94455c | 1288 | u16 hpi_instream_group_reset(u32 h_instream); |
719f82d3 EB |
1289 | |
1290 | /*********/ | |
ba94455c | 1291 | /* Mixer */ |
719f82d3 | 1292 | /*********/ |
ba94455c EB |
1293 | u16 hpi_mixer_open(u16 adapter_index, u32 *ph_mixer); |
1294 | ||
1295 | u16 hpi_mixer_close(u32 h_mixer); | |
1296 | ||
1297 | u16 hpi_mixer_get_control(u32 h_mixer, u16 src_node_type, | |
1298 | u16 src_node_type_index, u16 dst_node_type, u16 dst_node_type_index, | |
1299 | u16 control_type, u32 *ph_control); | |
1300 | ||
1301 | u16 hpi_mixer_get_control_by_index(u32 h_mixer, u16 control_index, | |
1302 | u16 *pw_src_node_type, u16 *pw_src_node_index, u16 *pw_dst_node_type, | |
1303 | u16 *pw_dst_node_index, u16 *pw_control_type, u32 *ph_control); | |
1304 | ||
1305 | u16 hpi_mixer_store(u32 h_mixer, enum HPI_MIXER_STORE_COMMAND command, | |
1306 | u16 index); | |
1307 | /************/ | |
1308 | /* Controls */ | |
1309 | /************/ | |
1310 | /******************/ | |
1311 | /* Volume control */ | |
1312 | /******************/ | |
1313 | u16 hpi_volume_set_gain(u32 h_control, short an_gain0_01dB[HPI_MAX_CHANNELS] | |
719f82d3 EB |
1314 | ); |
1315 | ||
ba94455c | 1316 | u16 hpi_volume_get_gain(u32 h_control, |
719f82d3 EB |
1317 | short an_gain0_01dB_out[HPI_MAX_CHANNELS] |
1318 | ); | |
1319 | ||
fc3a3990 EB |
1320 | u16 hpi_volume_set_mute(u32 h_control, u32 mute); |
1321 | ||
1322 | u16 hpi_volume_get_mute(u32 h_control, u32 *mute); | |
1323 | ||
719f82d3 | 1324 | #define hpi_volume_get_range hpi_volume_query_range |
ba94455c EB |
1325 | u16 hpi_volume_query_range(u32 h_control, short *min_gain_01dB, |
1326 | short *max_gain_01dB, short *step_gain_01dB); | |
719f82d3 | 1327 | |
ba94455c | 1328 | u16 hpi_volume_query_channels(const u32 h_volume, u32 *p_channels); |
719f82d3 | 1329 | |
ba94455c | 1330 | u16 hpi_volume_auto_fade(u32 h_control, |
719f82d3 EB |
1331 | short an_stop_gain0_01dB[HPI_MAX_CHANNELS], u32 duration_ms); |
1332 | ||
ba94455c EB |
1333 | u16 hpi_volume_auto_fade_profile(u32 h_control, |
1334 | short an_stop_gain0_01dB[HPI_MAX_CHANNELS], u32 duration_ms, | |
1335 | u16 profile); | |
719f82d3 | 1336 | |
ba94455c EB |
1337 | /*****************/ |
1338 | /* Level control */ | |
1339 | /*****************/ | |
1340 | u16 hpi_level_query_range(u32 h_control, short *min_gain_01dB, | |
1341 | short *max_gain_01dB, short *step_gain_01dB); | |
719f82d3 | 1342 | |
ba94455c | 1343 | u16 hpi_level_set_gain(u32 h_control, short an_gain0_01dB[HPI_MAX_CHANNELS] |
719f82d3 EB |
1344 | ); |
1345 | ||
ba94455c | 1346 | u16 hpi_level_get_gain(u32 h_control, |
719f82d3 EB |
1347 | short an_gain0_01dB_out[HPI_MAX_CHANNELS] |
1348 | ); | |
1349 | ||
ba94455c EB |
1350 | /*****************/ |
1351 | /* Meter control */ | |
1352 | /*****************/ | |
1353 | u16 hpi_meter_query_channels(const u32 h_meter, u32 *p_channels); | |
719f82d3 | 1354 | |
ba94455c | 1355 | u16 hpi_meter_get_peak(u32 h_control, |
719f82d3 EB |
1356 | short an_peak0_01dB_out[HPI_MAX_CHANNELS] |
1357 | ); | |
1358 | ||
ba94455c | 1359 | u16 hpi_meter_get_rms(u32 h_control, short an_peak0_01dB_out[HPI_MAX_CHANNELS] |
719f82d3 EB |
1360 | ); |
1361 | ||
ba94455c | 1362 | u16 hpi_meter_set_peak_ballistics(u32 h_control, u16 attack, u16 decay); |
719f82d3 | 1363 | |
ba94455c | 1364 | u16 hpi_meter_set_rms_ballistics(u32 h_control, u16 attack, u16 decay); |
719f82d3 | 1365 | |
ba94455c | 1366 | u16 hpi_meter_get_peak_ballistics(u32 h_control, u16 *attack, u16 *decay); |
719f82d3 | 1367 | |
ba94455c | 1368 | u16 hpi_meter_get_rms_ballistics(u32 h_control, u16 *attack, u16 *decay); |
719f82d3 | 1369 | |
ba94455c EB |
1370 | /************************/ |
1371 | /* ChannelMode control */ | |
1372 | /************************/ | |
1373 | u16 hpi_channel_mode_query_mode(const u32 h_mode, const u32 index, | |
1374 | u16 *pw_mode); | |
719f82d3 | 1375 | |
ba94455c | 1376 | u16 hpi_channel_mode_set(u32 h_control, u16 mode); |
719f82d3 | 1377 | |
ba94455c | 1378 | u16 hpi_channel_mode_get(u32 h_control, u16 *mode); |
719f82d3 | 1379 | |
ba94455c EB |
1380 | /*****************/ |
1381 | /* Tuner control */ | |
1382 | /*****************/ | |
1383 | u16 hpi_tuner_query_band(const u32 h_tuner, const u32 index, u16 *pw_band); | |
719f82d3 | 1384 | |
ba94455c | 1385 | u16 hpi_tuner_set_band(u32 h_control, u16 band); |
719f82d3 | 1386 | |
ba94455c | 1387 | u16 hpi_tuner_get_band(u32 h_control, u16 *pw_band); |
719f82d3 | 1388 | |
ba94455c EB |
1389 | u16 hpi_tuner_query_frequency(const u32 h_tuner, const u32 index, |
1390 | const u16 band, u32 *pfreq); | |
719f82d3 | 1391 | |
ba94455c | 1392 | u16 hpi_tuner_set_frequency(u32 h_control, u32 freq_ink_hz); |
719f82d3 | 1393 | |
ba94455c | 1394 | u16 hpi_tuner_get_frequency(u32 h_control, u32 *pw_freq_ink_hz); |
719f82d3 | 1395 | |
ba94455c | 1396 | u16 hpi_tuner_get_rf_level(u32 h_control, short *pw_level); |
719f82d3 | 1397 | |
ba94455c | 1398 | u16 hpi_tuner_get_raw_rf_level(u32 h_control, short *pw_level); |
719f82d3 | 1399 | |
ba94455c | 1400 | u16 hpi_tuner_query_gain(const u32 h_tuner, const u32 index, u16 *pw_gain); |
719f82d3 | 1401 | |
ba94455c | 1402 | u16 hpi_tuner_set_gain(u32 h_control, short gain); |
719f82d3 | 1403 | |
ba94455c | 1404 | u16 hpi_tuner_get_gain(u32 h_control, short *pn_gain); |
719f82d3 | 1405 | |
ba94455c | 1406 | u16 hpi_tuner_get_status(u32 h_control, u16 *pw_status_mask, u16 *pw_status); |
719f82d3 | 1407 | |
ba94455c | 1408 | u16 hpi_tuner_set_mode(u32 h_control, u32 mode, u32 value); |
719f82d3 | 1409 | |
ba94455c | 1410 | u16 hpi_tuner_get_mode(u32 h_control, u32 mode, u32 *pn_value); |
719f82d3 | 1411 | |
ba94455c | 1412 | u16 hpi_tuner_get_rds(u32 h_control, char *p_rds_data); |
719f82d3 | 1413 | |
ba94455c EB |
1414 | u16 hpi_tuner_query_deemphasis(const u32 h_tuner, const u32 index, |
1415 | const u16 band, u32 *pdeemphasis); | |
719f82d3 | 1416 | |
ba94455c EB |
1417 | u16 hpi_tuner_set_deemphasis(u32 h_control, u32 deemphasis); |
1418 | u16 hpi_tuner_get_deemphasis(u32 h_control, u32 *pdeemphasis); | |
719f82d3 | 1419 | |
ba94455c | 1420 | u16 hpi_tuner_query_program(const u32 h_tuner, u32 *pbitmap_program); |
719f82d3 | 1421 | |
ba94455c | 1422 | u16 hpi_tuner_set_program(u32 h_control, u32 program); |
719f82d3 | 1423 | |
ba94455c | 1424 | u16 hpi_tuner_get_program(u32 h_control, u32 *pprogram); |
719f82d3 | 1425 | |
ba94455c EB |
1426 | u16 hpi_tuner_get_hd_radio_dsp_version(u32 h_control, char *psz_dsp_version, |
1427 | const u32 string_size); | |
719f82d3 | 1428 | |
ba94455c EB |
1429 | u16 hpi_tuner_get_hd_radio_sdk_version(u32 h_control, char *psz_sdk_version, |
1430 | const u32 string_size); | |
719f82d3 | 1431 | |
ba94455c | 1432 | u16 hpi_tuner_get_hd_radio_signal_quality(u32 h_control, u32 *pquality); |
719f82d3 | 1433 | |
ba94455c | 1434 | u16 hpi_tuner_get_hd_radio_signal_blend(u32 h_control, u32 *pblend); |
5a498ef1 | 1435 | |
ba94455c | 1436 | u16 hpi_tuner_set_hd_radio_signal_blend(u32 h_control, const u32 blend); |
5a498ef1 | 1437 | |
ba94455c EB |
1438 | /***************/ |
1439 | /* PAD control */ | |
1440 | /***************/ | |
719f82d3 | 1441 | |
ba94455c EB |
1442 | u16 hpi_pad_get_channel_name(u32 h_control, char *psz_string, |
1443 | const u32 string_length); | |
719f82d3 | 1444 | |
ba94455c EB |
1445 | u16 hpi_pad_get_artist(u32 h_control, char *psz_string, |
1446 | const u32 string_length); | |
719f82d3 | 1447 | |
ba94455c EB |
1448 | u16 hpi_pad_get_title(u32 h_control, char *psz_string, |
1449 | const u32 string_length); | |
719f82d3 | 1450 | |
ba94455c EB |
1451 | u16 hpi_pad_get_comment(u32 h_control, char *psz_string, |
1452 | const u32 string_length); | |
719f82d3 | 1453 | |
ba94455c | 1454 | u16 hpi_pad_get_program_type(u32 h_control, u32 *ppTY); |
719f82d3 | 1455 | |
ba94455c | 1456 | u16 hpi_pad_get_rdsPI(u32 h_control, u32 *ppI); |
719f82d3 | 1457 | |
ba94455c EB |
1458 | u16 hpi_pad_get_program_type_string(u32 h_control, const u32 data_type, |
1459 | const u32 pTY, char *psz_string, const u32 string_length); | |
719f82d3 EB |
1460 | |
1461 | /****************************/ | |
1462 | /* AES/EBU Receiver control */ | |
1463 | /****************************/ | |
ba94455c EB |
1464 | u16 hpi_aesebu_receiver_query_format(const u32 h_aes_rx, const u32 index, |
1465 | u16 *pw_format); | |
719f82d3 | 1466 | |
ba94455c | 1467 | u16 hpi_aesebu_receiver_set_format(u32 h_control, u16 source); |
719f82d3 | 1468 | |
ba94455c | 1469 | u16 hpi_aesebu_receiver_get_format(u32 h_control, u16 *pw_source); |
719f82d3 | 1470 | |
ba94455c | 1471 | u16 hpi_aesebu_receiver_get_sample_rate(u32 h_control, u32 *psample_rate); |
719f82d3 | 1472 | |
ba94455c | 1473 | u16 hpi_aesebu_receiver_get_user_data(u32 h_control, u16 index, u16 *pw_data); |
719f82d3 | 1474 | |
ba94455c EB |
1475 | u16 hpi_aesebu_receiver_get_channel_status(u32 h_control, u16 index, |
1476 | u16 *pw_data); | |
719f82d3 | 1477 | |
ba94455c | 1478 | u16 hpi_aesebu_receiver_get_error_status(u32 h_control, u16 *pw_error_data); |
719f82d3 EB |
1479 | |
1480 | /*******************************/ | |
1481 | /* AES/EBU Transmitter control */ | |
1482 | /*******************************/ | |
ba94455c | 1483 | u16 hpi_aesebu_transmitter_set_sample_rate(u32 h_control, u32 sample_rate); |
719f82d3 | 1484 | |
ba94455c | 1485 | u16 hpi_aesebu_transmitter_set_user_data(u32 h_control, u16 index, u16 data); |
719f82d3 | 1486 | |
ba94455c EB |
1487 | u16 hpi_aesebu_transmitter_set_channel_status(u32 h_control, u16 index, |
1488 | u16 data); | |
719f82d3 | 1489 | |
ba94455c EB |
1490 | u16 hpi_aesebu_transmitter_get_channel_status(u32 h_control, u16 index, |
1491 | u16 *pw_data); | |
719f82d3 | 1492 | |
ba94455c EB |
1493 | u16 hpi_aesebu_transmitter_query_format(const u32 h_aes_tx, const u32 index, |
1494 | u16 *pw_format); | |
719f82d3 | 1495 | |
ba94455c | 1496 | u16 hpi_aesebu_transmitter_set_format(u32 h_control, u16 output_format); |
719f82d3 | 1497 | |
ba94455c | 1498 | u16 hpi_aesebu_transmitter_get_format(u32 h_control, u16 *pw_output_format); |
719f82d3 EB |
1499 | |
1500 | /***********************/ | |
ba94455c | 1501 | /* Multiplexer control */ |
719f82d3 | 1502 | /***********************/ |
ba94455c EB |
1503 | u16 hpi_multiplexer_set_source(u32 h_control, u16 source_node_type, |
1504 | u16 source_node_index); | |
719f82d3 | 1505 | |
ba94455c | 1506 | u16 hpi_multiplexer_get_source(u32 h_control, u16 *source_node_type, |
719f82d3 EB |
1507 | u16 *source_node_index); |
1508 | ||
ba94455c EB |
1509 | u16 hpi_multiplexer_query_source(u32 h_control, u16 index, |
1510 | u16 *source_node_type, u16 *source_node_index); | |
1511 | ||
719f82d3 | 1512 | /***************/ |
ba94455c | 1513 | /* Vox control */ |
719f82d3 | 1514 | /***************/ |
ba94455c | 1515 | u16 hpi_vox_set_threshold(u32 h_control, short an_gain0_01dB); |
719f82d3 | 1516 | |
ba94455c | 1517 | u16 hpi_vox_get_threshold(u32 h_control, short *an_gain0_01dB); |
719f82d3 EB |
1518 | |
1519 | /*********************/ | |
1520 | /* Bitstream control */ | |
1521 | /*********************/ | |
ba94455c | 1522 | u16 hpi_bitstream_set_clock_edge(u32 h_control, u16 edge_type); |
719f82d3 | 1523 | |
ba94455c | 1524 | u16 hpi_bitstream_set_data_polarity(u32 h_control, u16 polarity); |
719f82d3 | 1525 | |
ba94455c EB |
1526 | u16 hpi_bitstream_get_activity(u32 h_control, u16 *pw_clk_activity, |
1527 | u16 *pw_data_activity); | |
719f82d3 EB |
1528 | |
1529 | /***********************/ | |
1530 | /* SampleClock control */ | |
1531 | /***********************/ | |
1532 | ||
ba94455c EB |
1533 | u16 hpi_sample_clock_query_source(const u32 h_clock, const u32 index, |
1534 | u16 *pw_source); | |
719f82d3 | 1535 | |
ba94455c | 1536 | u16 hpi_sample_clock_set_source(u32 h_control, u16 source); |
719f82d3 | 1537 | |
ba94455c | 1538 | u16 hpi_sample_clock_get_source(u32 h_control, u16 *pw_source); |
719f82d3 | 1539 | |
ba94455c EB |
1540 | u16 hpi_sample_clock_query_source_index(const u32 h_clock, const u32 index, |
1541 | const u32 source, u16 *pw_source_index); | |
719f82d3 | 1542 | |
ba94455c | 1543 | u16 hpi_sample_clock_set_source_index(u32 h_control, u16 source_index); |
719f82d3 | 1544 | |
ba94455c | 1545 | u16 hpi_sample_clock_get_source_index(u32 h_control, u16 *pw_source_index); |
719f82d3 | 1546 | |
ba94455c | 1547 | u16 hpi_sample_clock_get_sample_rate(u32 h_control, u32 *psample_rate); |
719f82d3 | 1548 | |
ba94455c EB |
1549 | u16 hpi_sample_clock_query_local_rate(const u32 h_clock, const u32 index, |
1550 | u32 *psource); | |
719f82d3 | 1551 | |
ba94455c | 1552 | u16 hpi_sample_clock_set_local_rate(u32 h_control, u32 sample_rate); |
719f82d3 | 1553 | |
ba94455c | 1554 | u16 hpi_sample_clock_get_local_rate(u32 h_control, u32 *psample_rate); |
719f82d3 | 1555 | |
ba94455c | 1556 | u16 hpi_sample_clock_set_auto(u32 h_control, u32 enable); |
719f82d3 | 1557 | |
ba94455c | 1558 | u16 hpi_sample_clock_get_auto(u32 h_control, u32 *penable); |
719f82d3 | 1559 | |
ba94455c | 1560 | u16 hpi_sample_clock_set_local_rate_lock(u32 h_control, u32 lock); |
719f82d3 | 1561 | |
ba94455c | 1562 | u16 hpi_sample_clock_get_local_rate_lock(u32 h_control, u32 *plock); |
719f82d3 EB |
1563 | |
1564 | /***********************/ | |
1565 | /* Microphone control */ | |
1566 | /***********************/ | |
ba94455c | 1567 | u16 hpi_microphone_set_phantom_power(u32 h_control, u16 on_off); |
719f82d3 | 1568 | |
ba94455c | 1569 | u16 hpi_microphone_get_phantom_power(u32 h_control, u16 *pw_on_off); |
719f82d3 | 1570 | |
ba94455c EB |
1571 | /********************************/ |
1572 | /* Parametric Equalizer control */ | |
1573 | /********************************/ | |
1574 | u16 hpi_parametric_eq_get_info(u32 h_control, u16 *pw_number_of_bands, | |
1575 | u16 *pw_enabled); | |
719f82d3 | 1576 | |
ba94455c | 1577 | u16 hpi_parametric_eq_set_state(u32 h_control, u16 on_off); |
719f82d3 | 1578 | |
ba94455c EB |
1579 | u16 hpi_parametric_eq_set_band(u32 h_control, u16 index, u16 type, |
1580 | u32 frequency_hz, short q100, short gain0_01dB); | |
719f82d3 | 1581 | |
ba94455c EB |
1582 | u16 hpi_parametric_eq_get_band(u32 h_control, u16 index, u16 *pn_type, |
1583 | u32 *pfrequency_hz, short *pnQ100, short *pn_gain0_01dB); | |
719f82d3 | 1584 | |
ba94455c | 1585 | u16 hpi_parametric_eq_get_coeffs(u32 h_control, u16 index, short coeffs[5] |
719f82d3 EB |
1586 | ); |
1587 | ||
ba94455c EB |
1588 | /*******************************/ |
1589 | /* Compressor Expander control */ | |
1590 | /*******************************/ | |
719f82d3 | 1591 | |
ba94455c | 1592 | u16 hpi_compander_set_enable(u32 h_control, u32 on); |
168f1b07 | 1593 | |
ba94455c | 1594 | u16 hpi_compander_get_enable(u32 h_control, u32 *pon); |
168f1b07 | 1595 | |
ba94455c | 1596 | u16 hpi_compander_set_makeup_gain(u32 h_control, short makeup_gain0_01dB); |
168f1b07 | 1597 | |
ba94455c | 1598 | u16 hpi_compander_get_makeup_gain(u32 h_control, short *pn_makeup_gain0_01dB); |
168f1b07 | 1599 | |
ba94455c EB |
1600 | u16 hpi_compander_set_attack_time_constant(u32 h_control, u32 index, |
1601 | u32 attack); | |
168f1b07 | 1602 | |
ba94455c EB |
1603 | u16 hpi_compander_get_attack_time_constant(u32 h_control, u32 index, |
1604 | u32 *pw_attack); | |
168f1b07 | 1605 | |
ba94455c EB |
1606 | u16 hpi_compander_set_decay_time_constant(u32 h_control, u32 index, |
1607 | u32 decay); | |
168f1b07 | 1608 | |
ba94455c EB |
1609 | u16 hpi_compander_get_decay_time_constant(u32 h_control, u32 index, |
1610 | u32 *pw_decay); | |
168f1b07 | 1611 | |
ba94455c EB |
1612 | u16 hpi_compander_set_threshold(u32 h_control, u32 index, |
1613 | short threshold0_01dB); | |
168f1b07 | 1614 | |
ba94455c EB |
1615 | u16 hpi_compander_get_threshold(u32 h_control, u32 index, |
1616 | short *pn_threshold0_01dB); | |
168f1b07 | 1617 | |
ba94455c | 1618 | u16 hpi_compander_set_ratio(u32 h_control, u32 index, u32 ratio100); |
719f82d3 | 1619 | |
ba94455c | 1620 | u16 hpi_compander_get_ratio(u32 h_control, u32 index, u32 *pw_ratio100); |
719f82d3 | 1621 | |
ba94455c EB |
1622 | /********************/ |
1623 | /* Cobranet control */ | |
1624 | /********************/ | |
1625 | u16 hpi_cobranet_hmi_write(u32 h_control, u32 hmi_address, u32 byte_count, | |
1626 | u8 *pb_data); | |
719f82d3 | 1627 | |
ba94455c EB |
1628 | u16 hpi_cobranet_hmi_read(u32 h_control, u32 hmi_address, u32 max_byte_count, |
1629 | u32 *pbyte_count, u8 *pb_data); | |
719f82d3 | 1630 | |
ba94455c EB |
1631 | u16 hpi_cobranet_hmi_get_status(u32 h_control, u32 *pstatus, |
1632 | u32 *preadable_size, u32 *pwriteable_size); | |
719f82d3 | 1633 | |
ba94455c | 1634 | u16 hpi_cobranet_get_ip_address(u32 h_control, u32 *pdw_ip_address); |
719f82d3 | 1635 | |
ba94455c | 1636 | u16 hpi_cobranet_set_ip_address(u32 h_control, u32 dw_ip_address); |
719f82d3 | 1637 | |
ba94455c | 1638 | u16 hpi_cobranet_get_static_ip_address(u32 h_control, u32 *pdw_ip_address); |
719f82d3 | 1639 | |
ba94455c | 1640 | u16 hpi_cobranet_set_static_ip_address(u32 h_control, u32 dw_ip_address); |
719f82d3 | 1641 | |
1d595d2a EB |
1642 | u16 hpi_cobranet_get_macaddress(u32 h_control, u32 *p_mac_msbs, |
1643 | u32 *p_mac_lsbs); | |
719f82d3 | 1644 | |
ba94455c EB |
1645 | /*************************/ |
1646 | /* Tone Detector control */ | |
1647 | /*************************/ | |
1648 | u16 hpi_tone_detector_get_state(u32 hC, u32 *state); | |
719f82d3 | 1649 | |
ba94455c | 1650 | u16 hpi_tone_detector_set_enable(u32 hC, u32 enable); |
719f82d3 | 1651 | |
ba94455c | 1652 | u16 hpi_tone_detector_get_enable(u32 hC, u32 *enable); |
719f82d3 | 1653 | |
ba94455c | 1654 | u16 hpi_tone_detector_set_event_enable(u32 hC, u32 event_enable); |
719f82d3 | 1655 | |
ba94455c | 1656 | u16 hpi_tone_detector_get_event_enable(u32 hC, u32 *event_enable); |
719f82d3 | 1657 | |
ba94455c | 1658 | u16 hpi_tone_detector_set_threshold(u32 hC, int threshold); |
719f82d3 | 1659 | |
ba94455c | 1660 | u16 hpi_tone_detector_get_threshold(u32 hC, int *threshold); |
719f82d3 | 1661 | |
ba94455c | 1662 | u16 hpi_tone_detector_get_frequency(u32 hC, u32 index, u32 *frequency); |
719f82d3 | 1663 | |
ba94455c EB |
1664 | /****************************/ |
1665 | /* Silence Detector control */ | |
1666 | /****************************/ | |
1667 | u16 hpi_silence_detector_get_state(u32 hC, u32 *state); | |
719f82d3 | 1668 | |
ba94455c | 1669 | u16 hpi_silence_detector_set_enable(u32 hC, u32 enable); |
719f82d3 | 1670 | |
ba94455c | 1671 | u16 hpi_silence_detector_get_enable(u32 hC, u32 *enable); |
719f82d3 | 1672 | |
ba94455c | 1673 | u16 hpi_silence_detector_set_event_enable(u32 hC, u32 event_enable); |
719f82d3 | 1674 | |
ba94455c | 1675 | u16 hpi_silence_detector_get_event_enable(u32 hC, u32 *event_enable); |
719f82d3 | 1676 | |
ba94455c | 1677 | u16 hpi_silence_detector_set_delay(u32 hC, u32 delay); |
719f82d3 | 1678 | |
ba94455c | 1679 | u16 hpi_silence_detector_get_delay(u32 hC, u32 *delay); |
719f82d3 | 1680 | |
ba94455c | 1681 | u16 hpi_silence_detector_set_threshold(u32 hC, int threshold); |
719f82d3 | 1682 | |
ba94455c EB |
1683 | u16 hpi_silence_detector_get_threshold(u32 hC, int *threshold); |
1684 | /*********************/ | |
1685 | /* Utility functions */ | |
1686 | /*********************/ | |
719f82d3 EB |
1687 | |
1688 | u16 hpi_format_create(struct hpi_format *p_format, u16 channels, u16 format, | |
1689 | u32 sample_rate, u32 bit_rate, u32 attributes); | |
1690 | ||
ba94455c | 1691 | #endif /*_HPI_H_ */ |