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