blob: ec19df50c1834027d5a7ddf2514f21f4fd87c6fe [file] [log] [blame]
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001/******************************************************************************
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
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +020027
28(C) Copyright AudioScience Inc. 1998-2010
Eliot Blennerhassettba944552011-02-10 17:26:04 +130029*/
30
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +020031#ifndef _HPI_H_
32#define _HPI_H_
33/* HPI Version
34If HPI_VER_MINOR is odd then its a development release not intended for the
35public. If HPI_VER_MINOR is even then is a release version
36i.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. */
Eliot Blennerhassett0a000442011-02-10 17:26:05 +130046#define HPI_VER HPI_VERSION_CONSTRUCTOR(4L, 5, 19)
47#define HPI_VER_STRING "4.05.19"
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +020048
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
55/******************************************************************************/
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +020056/******** HPI API DEFINITIONS *****/
57/******************************************************************************/
Eliot Blennerhassettad210ad2011-02-10 17:25:57 +130058
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +020059/*******************************************/
60/** Audio format types
61\ingroup stream
62*/
63enum 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
74Windows equivalent is WAVE_FORMAT_MPEG.
75
76The 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.
103Windows equivalent is WAVE_FORMAT_MPEG.
104
105The 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.
146Each sample is a 32bit word. The most significant 24 bits contain a 24-bit
147sample 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.
155Each sample is a 32bit word in IEEE754 floating point format.
156The 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
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +0200169/*******************************************/
170/** Stream States
171\ingroup stream
172*/
173enum 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};
Eliot Blennerhassettba944552011-02-10 17:26:04 +1300188/*******************************************/
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +0200189/** Source node types
190\ingroup mixer
191*/
192enum 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,
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +0200198 /** 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
Eliot Blennerhassettba944552011-02-10 17:26:04 +1300218/*******************************************/
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +0200219/** Destination node types
220\ingroup mixer
221*/
222enum 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,
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +0200228 /** 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*/
248enum 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
Eliot Blennerhassettba944552011-02-10 17:26:04 +1300256 HPI_CONTROL_AESEBU_TRANSMITTER = 6, /**< AES/EBU transmitter control */
Eliot Blennerhassettad210ad2011-02-10 17:25:57 +1300257 HPI_CONTROL_AESEBUTX = 6, /* HPI_CONTROL_AESEBU_TRANSMITTER */
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +0200258
259 HPI_CONTROL_AESEBU_RECEIVER = 7, /**< AES/EBU receiver control. */
Eliot Blennerhassettad210ad2011-02-10 17:25:57 +1300260 HPI_CONTROL_AESEBURX = 7, /* HPI_CONTROL_AESEBU_RECEIVER */
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +0200261
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. */
Eliot Blennerhassettad210ad2011-02-10 17:25:57 +1300275 HPI_CONTROL_EQUALIZER = 19, /*HPI_CONTROL_PARAMETRIC_EQ */
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +0200276
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
Eliot Blennerhassettba944552011-02-10 17:26:04 +1300290/*******************************************/
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +0200291/** Adapter properties
292These are used in HPI_AdapterSetProperty() and HPI_AdapterGetProperty()
293\ingroup adapter
294*/
295enum HPI_ADAPTER_PROPERTIES {
296/** \internal Used in dwProperty field of HPI_AdapterSetProperty() and
297HPI_AdapterGetProperty(). This errata applies to all ASI6000 cards with both
298analog and digital outputs. The CS4224 A/D+D/A has a one sample delay between
299left and right channels on both its input (ADC) and output (DAC).
300More details are available in Cirrus Logic errata ER284B2.
301PDF available from www.cirrus.com, released by Cirrus in 2001.
302*/
303 HPI_ADAPTER_PROPERTY_ERRATA_1 = 1,
304
305/** Adapter grouping property
306Indicates whether the adapter supports the grouping API (for ASIO and SSX2)
307*/
308 HPI_ADAPTER_PROPERTY_GROUPING = 2,
309
310/** Driver SSX2 property
311Tells the kernel driver to turn on SSX2 stream mapping.
312This feature is not used by the DSP. In fact the call is completely processed
313by 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
318Indicates the state of the adapter's SSX2 setting. This setting is stored in
319non-volatile memory on the adapter. A typical call sequence would be to use
320HPI_ADAPTER_PROPERTY_SSX2_SETTING to set SSX2 on the adapter and then to reload
Eliot Blennerhassettba944552011-02-10 17:26:04 +1300321the driver. The driver would query HPI_ADAPTER_PROPERTY_SSX2_SETTING during
322startup and if SSX2 is set, it would then call HPI_ADAPTER_PROPERTY_ENABLE_SSX2
323to enable SSX2 stream mapping within the kernel level of the driver.
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +0200324*/
325 HPI_ADAPTER_PROPERTY_SSX2_SETTING = 4,
326
Eliot Blennerhassettbd33c1c2011-02-10 17:26:16 +1300327/** Enables/disables PCI(e) IRQ.
328A setting of 0 indicates that no interrupts are being generated. A DSP boot
329this property is set to 0. Setting to a non-zero value specifies the number
330of frames of audio that should be processed between interrupts. This property
331should be set to multiple of the mixer interval as read back from the
332HPI_ADAPTER_PROPERTY_INTERVAL property.
333*/
334 HPI_ADAPTER_PROPERTY_IRQ_RATE = 5,
335
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +0200336/** Base number for readonly properties */
337 HPI_ADAPTER_PROPERTY_READONLYBASE = 256,
338
339/** Readonly adapter latency property.
340This property returns in the input and output latency in samples.
341Property 1 is the estimated input latency
342in samples, while Property 2 is that output latency in samples.
343*/
344 HPI_ADAPTER_PROPERTY_LATENCY = 256,
345
346/** Readonly adapter granularity property.
347The granulariy is the smallest size chunk of stereo samples that is processed by
348the adapter.
349This property returns the record granularity in samples in Property 1.
350Property 2 returns the play granularity.
351*/
352 HPI_ADAPTER_PROPERTY_GRANULARITY = 257,
353
354/** Readonly adapter number of current channels property.
355Property 1 is the number of record channels per record device.
356Property 2 is the number of play channels per playback device.*/
357 HPI_ADAPTER_PROPERTY_CURCHANNELS = 258,
358
359/** Readonly adapter software version.
360The SOFTWARE_VERSION property returns the version of the software running
361on the adapter as Major.Minor.Release.
362Property 1 contains Major in bits 15..8 and Minor in bits 7..0.
363Property 2 contains Release in bits 7..0. */
364 HPI_ADAPTER_PROPERTY_SOFTWARE_VERSION = 259,
365
366/** Readonly adapter MAC address MSBs.
367The MAC_ADDRESS_MSB property returns
368the most significant 32 bits of the MAC address.
369Property 1 contains bits 47..32 of the MAC address.
370Property 2 contains bits 31..16 of the MAC address. */
371 HPI_ADAPTER_PROPERTY_MAC_ADDRESS_MSB = 260,
372
373/** Readonly adapter MAC address LSBs
374The MAC_ADDRESS_LSB property returns
375the least significant 16 bits of the MAC address.
376Property 1 contains bits 15..0 of the MAC address. */
377 HPI_ADAPTER_PROPERTY_MAC_ADDRESS_LSB = 261,
378
379/** Readonly extended adapter type number
380The EXTENDED_ADAPTER_TYPE property returns the 4 digits of an extended
381adapter type, i.e ASI8920-0022, 0022 is the extended type.
382The digits are returned as ASCII characters rather than the hex digits that
383are returned for the main type
384Property 1 returns the 1st two (left most) digits, i.e "00"
385in the example above, the upper byte being the left most digit.
386Property 2 returns the 2nd two digits, i.e "22" in the example above*/
387 HPI_ADAPTER_PROPERTY_EXTENDED_ADAPTER_TYPE = 262,
388
389/** Readonly debug log buffer information */
390 HPI_ADAPTER_PROPERTY_LOGTABLEN = 263,
391 HPI_ADAPTER_PROPERTY_LOGTABBEG = 264,
392
393/** Readonly adapter IP address
394For 192.168.1.101
395Property 1 returns the 1st two (left most) digits, i.e 192*256 + 168
396in the example above, the upper byte being the left most digit.
397Property 2 returns the 2nd two digits, i.e 1*256 + 101 in the example above, */
398 HPI_ADAPTER_PROPERTY_IP_ADDRESS = 265,
399
400/** Readonly adapter buffer processed count. Returns a buffer processed count
401that is incremented every time all buffers for all streams are updated. This
402is useful for checking completion of all stream operations across the adapter
403when using grouped streams.
404*/
405 HPI_ADAPTER_PROPERTY_BUFFER_UPDATE_COUNT = 266,
406
407/** Readonly mixer and stream intervals
408
409These intervals are measured in mixer frames.
410To convert to time, divide by the adapter samplerate.
411
412The mixer interval is the number of frames processed in one mixer iteration.
413The stream update interval is the interval at which streams check for and
414process data, and BBM host buffer counters are updated.
415
416Property 1 is the mixer interval in mixer frames.
417Property 2 is the stream update interval in mixer frames.
418*/
419 HPI_ADAPTER_PROPERTY_INTERVAL = 267,
420/** Adapter capabilities 1
421Property 1 - adapter can do multichannel (SSX1)
422Property 2 - adapter can do stream grouping (supports SSX2)
423*/
424 HPI_ADAPTER_PROPERTY_CAPS1 = 268,
425/** Adapter capabilities 2
426Property 1 - adapter can do samplerate conversion (MRX)
427Property 2 - adapter can do timestretch (TSX)
428*/
Eliot Blennerhassett168f1b02010-07-06 08:37:06 +1200429 HPI_ADAPTER_PROPERTY_CAPS2 = 269,
430
431/** Readonly adapter sync header connection count.
432*/
433 HPI_ADAPTER_PROPERTY_SYNC_HEADER_CONNECTIONS = 270,
434/** Readonly supports SSX2 property.
435Indicates the adapter supports SSX2 in some mode setting. The
436return value is true (1) or false (0). If the current adapter
437mode is MONO SSX2 is disabled, even though this property will
438return true.
439*/
Eliot Blennerhassettbd33c1c2011-02-10 17:26:16 +1300440 HPI_ADAPTER_PROPERTY_SUPPORTS_SSX2 = 271,
441/** Readonly supports PCI(e) IRQ.
442Indicates that the adapter in it's current mode supports interrupts
443across the host bus. Note, this does not imply that interrupts are
444enabled. Instead it indicates that they can be enabled.
445*/
446 HPI_ADAPTER_PROPERTY_SUPPORTS_IRQ = 272
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +0200447};
448
449/** Adapter mode commands
450
Eliot Blennerhassett0a000442011-02-10 17:26:05 +1300451Used in wQueryOrSet parameter of HPI_AdapterSetModeEx().
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +0200452\ingroup adapter
453*/
454enum HPI_ADAPTER_MODE_CMDS {
Eliot Blennerhassett0a000442011-02-10 17:26:05 +1300455 /** Set the mode to the given parameter */
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +0200456 HPI_ADAPTER_MODE_SET = 0,
Eliot Blennerhassett0a000442011-02-10 17:26:05 +1300457 /** Return 0 or error depending whether mode is valid,
458 but don't set the mode */
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +0200459 HPI_ADAPTER_MODE_QUERY = 1
460};
461
462/** Adapter Modes
Eliot Blennerhassettba944552011-02-10 17:26:04 +1300463 These are used by HPI_AdapterSetModeEx()
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +0200464
465\warning - more than 16 possible modes breaks
466a bitmask in the Windows WAVE DLL
467\ingroup adapter
468*/
469enum HPI_ADAPTER_MODES {
470/** 4 outstream mode.
471- ASI6114: 1 instream
472- ASI6044: 4 instreams
473- ASI6012: 1 instream
474- ASI6102: no instreams
475- ASI6022, ASI6122: 2 instreams
476- ASI5111, ASI5101: 2 instreams
477- ASI652x, ASI662x: 2 instreams
478- ASI654x, ASI664x: 4 instreams
479*/
480 HPI_ADAPTER_MODE_4OSTREAM = 1,
481
482/** 6 outstream mode.
483- ASI6012: 1 instream,
484- ASI6022, ASI6122: 2 instreams
485- ASI652x, ASI662x: 4 instreams
486*/
487 HPI_ADAPTER_MODE_6OSTREAM = 2,
488
489/** 8 outstream mode.
490- ASI6114: 8 instreams
491- ASI6118: 8 instreams
492- ASI6585: 8 instreams
493*/
494 HPI_ADAPTER_MODE_8OSTREAM = 3,
495
496/** 16 outstream mode.
497- ASI6416 16 instreams
498- ASI6518, ASI6618 16 instreams
499- ASI6118 16 mono out and in streams
500*/
501 HPI_ADAPTER_MODE_16OSTREAM = 4,
502
503/** one outstream mode.
504- ASI5111 1 outstream, 1 instream
505*/
506 HPI_ADAPTER_MODE_1OSTREAM = 5,
507
508/** ASI504X mode 1. 12 outstream, 4 instream 0 to 48kHz sample rates
509 (see ASI504X datasheet for more info).
510*/
511 HPI_ADAPTER_MODE_1 = 6,
512
513/** ASI504X mode 2. 4 outstreams, 4 instreams at 0 to 192kHz sample rates
514 (see ASI504X datasheet for more info).
515*/
516 HPI_ADAPTER_MODE_2 = 7,
517
518/** ASI504X mode 3. 4 outstreams, 4 instreams at 0 to 192kHz sample rates
519 (see ASI504X datasheet for more info).
520*/
521 HPI_ADAPTER_MODE_3 = 8,
522
523/** ASI504X multichannel mode.
524 2 outstreams -> 4 line outs = 1 to 8 channel streams),
525 4 lineins -> 1 instream (1 to 8 channel streams) at 0-48kHz.
526 For more info see the SSX Specification.
527*/
528 HPI_ADAPTER_MODE_MULTICHANNEL = 9,
529
530/** 12 outstream mode.
531- ASI6514, ASI6614: 2 instreams
532- ASI6540,ASI6544: 8 instreams
533- ASI6640,ASI6644: 8 instreams
534*/
535 HPI_ADAPTER_MODE_12OSTREAM = 10,
536
537/** 9 outstream mode.
538- ASI6044: 8 instreams
539*/
540 HPI_ADAPTER_MODE_9OSTREAM = 11,
541
542/** mono mode.
543- ASI6416: 16 outstreams/instreams
544- ASI5402: 2 outstreams/instreams
545*/
546 HPI_ADAPTER_MODE_MONO = 12,
547
548/** Low latency mode.
549- ASI6416/ASI6316: 1 16 channel outstream and instream
550*/
551 HPI_ADAPTER_MODE_LOW_LATENCY = 13
552};
553
554/* Note, adapters can have more than one capability -
555encoding as bitfield is recommended. */
556#define HPI_CAPABILITY_NONE (0)
557#define HPI_CAPABILITY_MPEG_LAYER3 (1)
558
559/* Set this equal to maximum capability index,
560Must not be greater than 32 - see axnvdef.h */
561#define HPI_CAPABILITY_MAX 1
562/* #define HPI_CAPABILITY_AAC 2 */
563
564/******************************************* STREAM ATTRIBUTES ****/
565
566/** MPEG Ancillary Data modes
567
568The mode for the ancillary data insertion or extraction to operate in.
569\ingroup stream
570*/
571enum HPI_MPEG_ANC_MODES {
572 /** the MPEG frames have energy information stored in them (5 bytes per stereo frame, 3 per mono) */
573 HPI_MPEG_ANC_HASENERGY = 0,
574 /** the entire ancillary data field is taken up by data from the Anc data buffer
575 On encode, the encoder will insert the energy bytes before filling the remainder
576 of the ancillary data space with data from the ancillary data buffer.
577 */
578 HPI_MPEG_ANC_RAW = 1
579};
580
581/** Ancillary Data Alignment
582\ingroup instream
583*/
584enum HPI_ISTREAM_MPEG_ANC_ALIGNS {
585 /** data is packed against the end of data, then padded to the end of frame */
586 HPI_MPEG_ANC_ALIGN_LEFT = 0,
587 /** data is packed against the end of the frame */
588 HPI_MPEG_ANC_ALIGN_RIGHT = 1
589};
590
591/** MPEG modes
592MPEG modes - can be used optionally for HPI_FormatCreate()
593parameter dwAttributes.
594
595Using any mode setting other than HPI_MPEG_MODE_DEFAULT
596with single channel format will return an error.
597\ingroup stream
598*/
599enum HPI_MPEG_MODES {
600/** Causes the MPEG-1 Layer II bitstream to be recorded
601in single_channel mode when the number of channels is 1 and in stereo when the
602number of channels is 2. */
603 HPI_MPEG_MODE_DEFAULT = 0,
604 /** Standard stereo without joint-stereo compression */
605 HPI_MPEG_MODE_STEREO = 1,
606 /** Joint stereo */
607 HPI_MPEG_MODE_JOINTSTEREO = 2,
608 /** Left and Right channels are completely independent */
609 HPI_MPEG_MODE_DUALCHANNEL = 3
610};
611/******************************************* MIXER ATTRIBUTES ****/
612
613/* \defgroup mixer_flags Mixer flags for HPI_MIXER_GET_CONTROL_MULTIPLE_VALUES
614{
615*/
616#define HPI_MIXER_GET_CONTROL_MULTIPLE_CHANGED (0)
617#define HPI_MIXER_GET_CONTROL_MULTIPLE_RESET (1)
618/*}*/
619
620/** Commands used by HPI_MixerStore()
621\ingroup mixer
622*/
623enum HPI_MIXER_STORE_COMMAND {
624/** Save all mixer control settings. */
625 HPI_MIXER_STORE_SAVE = 1,
626/** Restore all controls from saved. */
627 HPI_MIXER_STORE_RESTORE = 2,
628/** Delete saved control settings. */
629 HPI_MIXER_STORE_DELETE = 3,
630/** Enable auto storage of some control settings. */
631 HPI_MIXER_STORE_ENABLE = 4,
632/** Disable auto storage of some control settings. */
633 HPI_MIXER_STORE_DISABLE = 5,
634/** Save the attributes of a single control. */
635 HPI_MIXER_STORE_SAVE_SINGLE = 6
636};
637
Eliot Blennerhassettba944552011-02-10 17:26:04 +1300638/****************************/
639/* CONTROL ATTRIBUTE VALUES */
640/****************************/
641
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +0200642/** Used by mixer plugin enable functions
643
Eliot Blennerhassettba944552011-02-10 17:26:04 +1300644E.g. HPI_ParametricEq_SetState()
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +0200645\ingroup mixer
646*/
647enum HPI_SWITCH_STATES {
648 HPI_SWITCH_OFF = 0, /**< turn the mixer plugin on. */
649 HPI_SWITCH_ON = 1 /**< turn the mixer plugin off. */
650};
651
652/* Volume control special gain values */
Eliot Blennerhassettba944552011-02-10 17:26:04 +1300653
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +0200654/** volumes units are 100ths of a dB
655\ingroup volume
656*/
657#define HPI_UNITS_PER_dB 100
658/** turns volume control OFF or MUTE
659\ingroup volume
660*/
661#define HPI_GAIN_OFF (-100 * HPI_UNITS_PER_dB)
662
Eliot Blennerhassettfc3a3992011-02-10 17:26:11 +1300663/** channel mask specifying all channels
664\ingroup volume
665*/
666#define HPI_BITMASK_ALL_CHANNELS (0xFFFFFFFF)
667
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +0200668/** value returned for no signal
669\ingroup meter
670*/
671#define HPI_METER_MINIMUM (-150 * HPI_UNITS_PER_dB)
672
673/** autofade profiles
674\ingroup volume
675*/
676enum HPI_VOLUME_AUTOFADES {
677/** log fade - dB attenuation changes linearly over time */
678 HPI_VOLUME_AUTOFADE_LOG = 2,
679/** linear fade - amplitude changes linearly */
680 HPI_VOLUME_AUTOFADE_LINEAR = 3
681};
682
683/** The physical encoding format of the AESEBU I/O.
684
Eliot Blennerhassettba944552011-02-10 17:26:04 +1300685Used in HPI_Aesebu_Transmitter_SetFormat(), HPI_Aesebu_Receiver_SetFormat()
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +0200686along with related Get and Query functions
687\ingroup aestx
688*/
689enum HPI_AESEBU_FORMATS {
690/** AES/EBU physical format - AES/EBU balanced "professional" */
691 HPI_AESEBU_FORMAT_AESEBU = 1,
692/** AES/EBU physical format - S/PDIF unbalanced "consumer" */
693 HPI_AESEBU_FORMAT_SPDIF = 2
694};
695
696/** AES/EBU error status bits
697
Eliot Blennerhassettba944552011-02-10 17:26:04 +1300698Returned by HPI_Aesebu_Receiver_GetErrorStatus()
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +0200699\ingroup aesrx
700*/
701enum HPI_AESEBU_ERRORS {
702/** bit0: 1 when PLL is not locked */
703 HPI_AESEBU_ERROR_NOT_LOCKED = 0x01,
704/** bit1: 1 when signal quality is poor */
705 HPI_AESEBU_ERROR_POOR_QUALITY = 0x02,
706/** bit2: 1 when there is a parity error */
707 HPI_AESEBU_ERROR_PARITY_ERROR = 0x04,
708/** bit3: 1 when there is a bi-phase coding violation */
709 HPI_AESEBU_ERROR_BIPHASE_VIOLATION = 0x08,
710/** bit4: 1 when the validity bit is high */
711 HPI_AESEBU_ERROR_VALIDITY = 0x10,
712/** bit5: 1 when the CRC error bit is high */
713 HPI_AESEBU_ERROR_CRC = 0x20
714};
715
716/** \addtogroup pad
717\{
718*/
719/** The text string containing the station/channel combination. */
720#define HPI_PAD_CHANNEL_NAME_LEN 16
721/** The text string containing the artist. */
722#define HPI_PAD_ARTIST_LEN 64
723/** The text string containing the title. */
724#define HPI_PAD_TITLE_LEN 64
725/** The text string containing the comment. */
726#define HPI_PAD_COMMENT_LEN 256
727/** The PTY when the tuner has not recieved any PTY. */
728#define HPI_PAD_PROGRAM_TYPE_INVALID 0xffff
729/** \} */
730
731/** Data types for PTY string translation.
732\ingroup rds
733*/
734enum eHPI_RDS_type {
735 HPI_RDS_DATATYPE_RDS = 0, /**< RDS bitstream.*/
736 HPI_RDS_DATATYPE_RBDS = 1 /**< RBDS bitstream.*/
737};
738
739/** Tuner bands
740
741Used for HPI_Tuner_SetBand(),HPI_Tuner_GetBand()
742\ingroup tuner
743*/
744enum HPI_TUNER_BAND {
745 HPI_TUNER_BAND_AM = 1, /**< AM band */
746 HPI_TUNER_BAND_FM = 2, /**< FM band (mono) */
747 HPI_TUNER_BAND_TV_NTSC_M = 3, /**< NTSC-M TV band*/
748 HPI_TUNER_BAND_TV = 3, /* use TV_NTSC_M */
749 HPI_TUNER_BAND_FM_STEREO = 4, /**< FM band (stereo) */
750 HPI_TUNER_BAND_AUX = 5, /**< auxiliary input */
751 HPI_TUNER_BAND_TV_PAL_BG = 6, /**< PAL-B/G TV band*/
752 HPI_TUNER_BAND_TV_PAL_I = 7, /**< PAL-I TV band*/
753 HPI_TUNER_BAND_TV_PAL_DK = 8, /**< PAL-D/K TV band*/
754 HPI_TUNER_BAND_TV_SECAM_L = 9, /**< SECAM-L TV band*/
755 HPI_TUNER_BAND_LAST = 9 /**< the index of the last tuner band. */
756};
757
758/** Tuner mode attributes
759
760Used by HPI_Tuner_SetMode(), HPI_Tuner_GetMode()
761\ingroup tuner
762
763*/
764enum HPI_TUNER_MODES {
765 HPI_TUNER_MODE_RSS = 1, /**< control RSS */
766 HPI_TUNER_MODE_RDS = 2 /**< control RBDS/RDS */
767};
768
769/** Tuner mode attribute values
770
771Used by HPI_Tuner_SetMode(), HPI_Tuner_GetMode()
772\ingroup tuner
773*/
774enum HPI_TUNER_MODE_VALUES {
775/* RSS attribute values */
776 HPI_TUNER_MODE_RSS_DISABLE = 0, /**< RSS disable */
777 HPI_TUNER_MODE_RSS_ENABLE = 1, /**< RSS enable */
778
779/* RDS mode attributes */
780 HPI_TUNER_MODE_RDS_DISABLE = 0, /**< RDS - disabled */
781 HPI_TUNER_MODE_RDS_RDS = 1, /**< RDS - RDS mode */
782 HPI_TUNER_MODE_RDS_RBDS = 2 /**< RDS - RBDS mode */
783};
784
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +0200785/** Tuner Status Bits
786
787These bitfield values are returned by a call to HPI_Tuner_GetStatus().
788Multiple fields are returned from a single call.
789\ingroup tuner
790*/
791enum HPI_TUNER_STATUS_BITS {
792 HPI_TUNER_VIDEO_COLOR_PRESENT = 0x0001, /**< video color is present. */
Eliot Blennerhassettad210ad2011-02-10 17:25:57 +1300793 HPI_TUNER_VIDEO_IS_60HZ = 0x0020, /**< 60 hz video detected. */
794 HPI_TUNER_VIDEO_HORZ_SYNC_MISSING = 0x0040, /**< video HSYNC is missing. */
795 HPI_TUNER_VIDEO_STATUS_VALID = 0x0100, /**< video status is valid. */
796 HPI_TUNER_DIGITAL = 0x0200, /**< tuner reports digital programming. */
797 HPI_TUNER_MULTIPROGRAM = 0x0400, /**< tuner reports multiple programs. */
798 HPI_TUNER_PLL_LOCKED = 0x1000, /**< the tuner's PLL is locked. */
799 HPI_TUNER_FM_STEREO = 0x2000 /**< tuner reports back FM stereo. */
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +0200800};
801
802/** Channel Modes
803Used for HPI_ChannelModeSet/Get()
804\ingroup channelmode
805*/
806enum HPI_CHANNEL_MODES {
807/** Left channel out = left channel in, Right channel out = right channel in. */
808 HPI_CHANNEL_MODE_NORMAL = 1,
809/** Left channel out = right channel in, Right channel out = left channel in. */
810 HPI_CHANNEL_MODE_SWAP = 2,
811/** Left channel out = left channel in, Right channel out = left channel in. */
812 HPI_CHANNEL_MODE_LEFT_TO_STEREO = 3,
813/** Left channel out = right channel in, Right channel out = right channel in.*/
814 HPI_CHANNEL_MODE_RIGHT_TO_STEREO = 4,
815/** Left channel out = (left channel in + right channel in)/2,
816 Right channel out = mute. */
817 HPI_CHANNEL_MODE_STEREO_TO_LEFT = 5,
818/** Left channel out = mute,
819 Right channel out = (right channel in + left channel in)/2. */
820 HPI_CHANNEL_MODE_STEREO_TO_RIGHT = 6,
821 HPI_CHANNEL_MODE_LAST = 6
822};
823
824/** SampleClock source values
825\ingroup sampleclock
826*/
827enum HPI_SAMPLECLOCK_SOURCES {
828/** The sampleclock output is derived from its local samplerate generator.
829 The local samplerate may be set using HPI_SampleClock_SetLocalRate(). */
830 HPI_SAMPLECLOCK_SOURCE_LOCAL = 1,
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +0200831/** The adapter is clocked from a dedicated AES/EBU SampleClock input.*/
832 HPI_SAMPLECLOCK_SOURCE_AESEBU_SYNC = 2,
833/** From external wordclock connector */
834 HPI_SAMPLECLOCK_SOURCE_WORD = 3,
835/** Board-to-board header */
836 HPI_SAMPLECLOCK_SOURCE_WORD_HEADER = 4,
837/** FUTURE - SMPTE clock. */
838 HPI_SAMPLECLOCK_SOURCE_SMPTE = 5,
839/** One of the aesebu inputs */
840 HPI_SAMPLECLOCK_SOURCE_AESEBU_INPUT = 6,
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +0200841/** From a network interface e.g. Cobranet or Livewire at either 48 or 96kHz */
842 HPI_SAMPLECLOCK_SOURCE_NETWORK = 8,
843/** From previous adjacent module (ASI2416 only)*/
844 HPI_SAMPLECLOCK_SOURCE_PREV_MODULE = 10,
845/*! Update this if you add a new clock source.*/
846 HPI_SAMPLECLOCK_SOURCE_LAST = 10
847};
848
Eliot Blennerhassettba944552011-02-10 17:26:04 +1300849/** Equalizer filter types. Used by HPI_ParametricEq_SetBand()
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +0200850\ingroup parmeq
851*/
852enum HPI_FILTER_TYPE {
853 HPI_FILTER_TYPE_BYPASS = 0, /**< filter is turned off */
854
855 HPI_FILTER_TYPE_LOWSHELF = 1, /**< EQ low shelf */
856 HPI_FILTER_TYPE_HIGHSHELF = 2, /**< EQ high shelf */
857 HPI_FILTER_TYPE_EQ_BAND = 3, /**< EQ gain */
858
859 HPI_FILTER_TYPE_LOWPASS = 4, /**< standard low pass */
860 HPI_FILTER_TYPE_HIGHPASS = 5, /**< standard high pass */
861 HPI_FILTER_TYPE_BANDPASS = 6, /**< standard band pass */
862 HPI_FILTER_TYPE_BANDSTOP = 7 /**< standard band stop/notch */
863};
864
865/** Async Event sources
866\ingroup async
867*/
868enum ASYNC_EVENT_SOURCES {
869 HPI_ASYNC_EVENT_GPIO = 1, /**< GPIO event. */
870 HPI_ASYNC_EVENT_SILENCE = 2, /**< silence event detected. */
871 HPI_ASYNC_EVENT_TONE = 3 /**< tone event detected. */
872};
873/*******************************************/
874/** HPI Error codes
875
876Almost all HPI functions return an error code
877A return value of zero means there was no error.
878Otherwise one of these error codes is returned.
879Error codes can be converted to a descriptive string using HPI_GetErrorText()
880
881\note When a new error code is added HPI_GetErrorText() MUST be updated.
882\note Codes 1-100 are reserved for driver use
883\ingroup utility
884*/
885enum HPI_ERROR_CODES {
886 /** Message type does not exist. */
887 HPI_ERROR_INVALID_TYPE = 100,
888 /** Object type does not exist. */
889 HPI_ERROR_INVALID_OBJ = 101,
890 /** Function does not exist. */
891 HPI_ERROR_INVALID_FUNC = 102,
Eliot Blennerhassettba944552011-02-10 17:26:04 +1300892 /** The specified object does not exist. */
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +0200893 HPI_ERROR_INVALID_OBJ_INDEX = 103,
894 /** Trying to access an object that has not been opened yet. */
895 HPI_ERROR_OBJ_NOT_OPEN = 104,
896 /** Trying to open an already open object. */
897 HPI_ERROR_OBJ_ALREADY_OPEN = 105,
898 /** PCI, ISA resource not valid. */
899 HPI_ERROR_INVALID_RESOURCE = 106,
Eliot Blennerhassett0a000442011-02-10 17:26:05 +1300900 /* HPI_ERROR_SUBSYSFINDADAPTERS_GETINFO= 107 */
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +0200901 /** Default response was never updated with actual error code. */
902 HPI_ERROR_INVALID_RESPONSE = 108,
903 /** wSize field of response was not updated,
904 indicating that the message was not processed. */
905 HPI_ERROR_PROCESSING_MESSAGE = 109,
906 /** The network did not respond in a timely manner. */
907 HPI_ERROR_NETWORK_TIMEOUT = 110,
Eliot Blennerhassettba944552011-02-10 17:26:04 +1300908 /* An HPI handle is invalid (uninitialised?). */
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +0200909 HPI_ERROR_INVALID_HANDLE = 111,
910 /** A function or attribute has not been implemented yet. */
911 HPI_ERROR_UNIMPLEMENTED = 112,
Eliot Blennerhassettba944552011-02-10 17:26:04 +1300912 /** There are too many clients attempting
913 to access a network resource. */
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +0200914 HPI_ERROR_NETWORK_TOO_MANY_CLIENTS = 113,
Eliot Blennerhassettba944552011-02-10 17:26:04 +1300915 /** Response buffer passed to HPI_Message
916 was smaller than returned response.
917 wSpecificError field of hpi response contains the required size.
918 */
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +0200919 HPI_ERROR_RESPONSE_BUFFER_TOO_SMALL = 114,
920 /** The returned response did not match the sent message */
921 HPI_ERROR_RESPONSE_MISMATCH = 115,
Eliot Blennerhassettad210ad2011-02-10 17:25:57 +1300922 /** A control setting that should have been cached was not. */
923 HPI_ERROR_CONTROL_CACHING = 116,
Eliot Blennerhassettba944552011-02-10 17:26:04 +1300924 /** A message buffer in the path to the adapter was smaller
925 than the message size.
926 wSpecificError field of hpi response contains the actual size.
927 */
928 HPI_ERROR_MESSAGE_BUFFER_TOO_SMALL = 117,
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +0200929
Eliot Blennerhassett0a000442011-02-10 17:26:05 +1300930 /* HPI_ERROR_TOO_MANY_ADAPTERS= 200 */
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +0200931 /** Bad adpater. */
932 HPI_ERROR_BAD_ADAPTER = 201,
933 /** Adapter number out of range or not set properly. */
934 HPI_ERROR_BAD_ADAPTER_NUMBER = 202,
935 /** 2 adapters with the same adapter number. */
936 HPI_DUPLICATE_ADAPTER_NUMBER = 203,
Eliot Blennerhassettba944552011-02-10 17:26:04 +1300937 /** DSP code failed to bootload. (unused?) */
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +0200938 HPI_ERROR_DSP_BOOTLOAD = 204,
Eliot Blennerhassett0a000442011-02-10 17:26:05 +1300939 /** Communication with DSP failed */
940 HPI_ERROR_DSP_COMMUNICATION = 205,
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +0200941 /** Couldn't find or open the DSP code file. */
942 HPI_ERROR_DSP_FILE_NOT_FOUND = 206,
943 /** Internal DSP hardware error. */
944 HPI_ERROR_DSP_HARDWARE = 207,
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +0200945 /** Could not allocate memory */
946 HPI_ERROR_MEMORY_ALLOC = 208,
Eliot Blennerhassett0a000442011-02-10 17:26:05 +1300947 /** Failed to correctly load/config PLD. (unused) */
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +0200948 HPI_ERROR_PLD_LOAD = 209,
949 /** Unexpected end of file, block length too big etc. */
950 HPI_ERROR_DSP_FILE_FORMAT = 210,
951
952 /** Found but could not open DSP code file. */
953 HPI_ERROR_DSP_FILE_ACCESS_DENIED = 211,
954 /** First DSP code section header not found in DSP file. */
955 HPI_ERROR_DSP_FILE_NO_HEADER = 212,
Eliot Blennerhassett0a000442011-02-10 17:26:05 +1300956 /* HPI_ERROR_DSP_FILE_READ_ERROR= 213, */
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +0200957 /** DSP code for adapter family not found. */
958 HPI_ERROR_DSP_SECTION_NOT_FOUND = 214,
959 /** Other OS specific error opening DSP file. */
960 HPI_ERROR_DSP_FILE_OTHER_ERROR = 215,
961 /** Sharing violation opening DSP code file. */
962 HPI_ERROR_DSP_FILE_SHARING_VIOLATION = 216,
963 /** DSP code section header had size == 0. */
964 HPI_ERROR_DSP_FILE_NULL_HEADER = 217,
965
Eliot Blennerhassett0a000442011-02-10 17:26:05 +1300966 /* HPI_ERROR_FLASH = 220, */
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +0200967
968 /** Flash has bad checksum */
Eliot Blennerhassettad210ad2011-02-10 17:25:57 +1300969 HPI_ERROR_BAD_CHECKSUM = 221,
970 HPI_ERROR_BAD_SEQUENCE = 222,
971 HPI_ERROR_FLASH_ERASE = 223,
972 HPI_ERROR_FLASH_PROGRAM = 224,
973 HPI_ERROR_FLASH_VERIFY = 225,
974 HPI_ERROR_FLASH_TYPE = 226,
975 HPI_ERROR_FLASH_START = 227,
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +0200976
977 /** Reserved for OEMs. */
978 HPI_ERROR_RESERVED_1 = 290,
979
Eliot Blennerhassett1d595d22011-02-10 17:26:08 +1300980 /* HPI_ERROR_INVALID_STREAM = 300 use HPI_ERROR_INVALID_OBJ_INDEX */
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +0200981 /** Invalid compression format. */
982 HPI_ERROR_INVALID_FORMAT = 301,
983 /** Invalid format samplerate */
984 HPI_ERROR_INVALID_SAMPLERATE = 302,
985 /** Invalid format number of channels. */
986 HPI_ERROR_INVALID_CHANNELS = 303,
987 /** Invalid format bitrate. */
988 HPI_ERROR_INVALID_BITRATE = 304,
989 /** Invalid datasize used for stream read/write. */
990 HPI_ERROR_INVALID_DATASIZE = 305,
Eliot Blennerhassett1d595d22011-02-10 17:26:08 +1300991 /* HPI_ERROR_BUFFER_FULL = 306 use HPI_ERROR_INVALID_DATASIZE */
992 /* HPI_ERROR_BUFFER_EMPTY = 307 use HPI_ERROR_INVALID_DATASIZE */
Eliot Blennerhassettba944552011-02-10 17:26:04 +1300993 /** Null data pointer used for stream read/write. */
994 HPI_ERROR_INVALID_DATA_POINTER = 308,
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +0200995 /** Packet ordering error for stream read/write. */
996 HPI_ERROR_INVALID_PACKET_ORDER = 309,
997
998 /** Object can't do requested operation in its current
Eliot Blennerhassettba944552011-02-10 17:26:04 +1300999 state, eg set format, change rec mux state while recording.*/
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001000 HPI_ERROR_INVALID_OPERATION = 310,
1001
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001002 /** Where a SRG is shared amongst streams, an incompatible samplerate
1003 is one that is different to any currently active stream. */
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001004 HPI_ERROR_INCOMPATIBLE_SAMPLERATE = 311,
1005 /** Adapter mode is illegal.*/
1006 HPI_ERROR_BAD_ADAPTER_MODE = 312,
1007
1008 /** There have been too many attempts to set the adapter's
1009 capabilities (using bad keys), the card should be returned
1010 to ASI if further capabilities updates are required */
1011 HPI_ERROR_TOO_MANY_CAPABILITY_CHANGE_ATTEMPTS = 313,
1012 /** Streams on different adapters cannot be grouped. */
1013 HPI_ERROR_NO_INTERADAPTER_GROUPS = 314,
1014 /** Streams on different DSPs cannot be grouped. */
1015 HPI_ERROR_NO_INTERDSP_GROUPS = 315,
Eliot Blennerhassettbd33c1c2011-02-10 17:26:16 +13001016 /** Stream wait cancelled before threshold reached. */
1017 HPI_ERROR_WAIT_CANCELLED = 316,
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001018
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,
Eliot Blennerhassett0a000442011-02-10 17:26:05 +13001031 HPI_ERROR_I2C_MISSING_ACK = 405,
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001032 /** 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 */
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001042 HPI_ERROR_I2C_BAD_ADR = 460,
1043
1044 /** Entity errors */
1045 HPI_ERROR_ENTITY_TYPE_MISMATCH = 470,
1046 HPI_ERROR_ENTITY_ITEM_COUNT = 471,
1047 HPI_ERROR_ENTITY_TYPE_INVALID = 472,
1048 HPI_ERROR_ENTITY_ROLE_INVALID = 473,
Eliot Blennerhassettad210ad2011-02-10 17:25:57 +13001049 HPI_ERROR_ENTITY_SIZE_MISMATCH = 474,
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001050
1051 /* AES18 specific errors were 500..507 */
1052
1053 /** custom error to use for debugging */
1054 HPI_ERROR_CUSTOM = 600,
1055
1056 /** hpioct32.c can't obtain mutex */
1057 HPI_ERROR_MUTEX_TIMEOUT = 700,
1058
1059 /** errors from HPI backends have values >= this */
Eliot Blennerhassettad210ad2011-02-10 17:25:57 +13001060 HPI_ERROR_BACKEND_BASE = 900
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001061};
1062
1063/** \defgroup maximums HPI maximum values
1064\{
1065*/
1066/** Maximum number of adapters per HPI sub-system
1067 WARNING: modifying this value changes the response structure size.*/
1068#define HPI_MAX_ADAPTERS 20
1069/** Maximum number of in or out streams per adapter */
1070#define HPI_MAX_STREAMS 16
1071#define HPI_MAX_CHANNELS 2 /* per stream */
1072#define HPI_MAX_NODES 8 /* per mixer ? */
1073#define HPI_MAX_CONTROLS 4 /* per node ? */
1074/** maximum number of ancillary bytes per MPEG frame */
1075#define HPI_MAX_ANC_BYTES_PER_FRAME (64)
1076#define HPI_STRING_LEN 16
1077
1078/** Velocity units */
1079#define HPI_OSTREAM_VELOCITY_UNITS 4096
1080/** OutStream timescale units */
1081#define HPI_OSTREAM_TIMESCALE_UNITS 10000
1082/** OutStream timescale passthrough - turns timescaling on in passthough mode */
1083#define HPI_OSTREAM_TIMESCALE_PASSTHROUGH 99999
1084
1085/**\}*/
1086
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001087/**************/
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001088/* STRUCTURES */
1089#ifndef DISABLE_PRAGMA_PACK1
1090#pragma pack(push, 1)
1091#endif
1092
1093/** Structure containing sample format information.
1094 See also HPI_FormatCreate().
1095 */
1096struct hpi_format {
1097 u32 sample_rate;
1098 /**< 11025, 32000, 44100 ... */
1099 u32 bit_rate; /**< for MPEG */
1100 u32 attributes;
1101 /**< Stereo/JointStereo/Mono */
1102 u16 mode_legacy;
1103 /**< Legacy ancillary mode or idle bit */
Eliot Blennerhassettad210ad2011-02-10 17:25:57 +13001104 u16 unused; /**< Unused */
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001105 u16 channels; /**< 1,2..., (or ancillary mode or idle bit */
1106 u16 format; /**< HPI_FORMAT_PCM16, _MPEG etc. see #HPI_FORMATS. */
1107};
1108
1109struct hpi_anc_frame {
1110 u32 valid_bits_in_this_frame;
1111 u8 b_data[HPI_MAX_ANC_BYTES_PER_FRAME];
1112};
1113
1114/** An object for containing a single async event.
1115*/
1116struct hpi_async_event {
1117 u16 event_type; /**< type of event. \sa async_event */
Eliot Blennerhassett1d595d22011-02-10 17:26:08 +13001118 u16 sequence; /**< Sequence number, allows lost event detection */
1119 u32 state; /**< New state */
1120 u32 h_object; /**< handle to the object returning the event. */
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001121 union {
1122 struct {
1123 u16 index; /**< GPIO bit index. */
1124 } gpio;
1125 struct {
1126 u16 node_index; /**< what node is the control on ? */
Eliot Blennerhassett1d595d22011-02-10 17:26:08 +13001127 u16 node_type; /**< what type of node is the control on ? */
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001128 } control;
1129 } u;
1130};
1131
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001132/* skip host side function declarations for
1133 DSP compile and documentation extraction */
1134
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001135#ifndef DISABLE_PRAGMA_PACK1
1136#pragma pack(pop)
1137#endif
1138
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001139/*****************/
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001140/* HPI FUNCTIONS */
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001141/*****************/
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001142
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001143/* Stream */
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001144u16 hpi_stream_estimate_buffer_size(struct hpi_format *pF,
1145 u32 host_polling_rate_in_milli_seconds, u32 *recommended_buffer_size);
1146
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001147/*************/
1148/* SubSystem */
1149/*************/
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001150
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001151u16 hpi_subsys_get_version_ex(u32 *pversion_ex);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001152
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001153u16 hpi_subsys_get_num_adapters(int *pn_num_adapters);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001154
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001155u16 hpi_subsys_get_adapter(int iterator, u32 *padapter_index,
1156 u16 *pw_adapter_type);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001157
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001158/***********/
1159/* Adapter */
1160/***********/
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001161
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001162u16 hpi_adapter_open(u16 adapter_index);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001163
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001164u16 hpi_adapter_close(u16 adapter_index);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001165
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001166u16 hpi_adapter_get_info(u16 adapter_index, u16 *pw_num_outstreams,
1167 u16 *pw_num_instreams, u16 *pw_version, u32 *pserial_number,
1168 u16 *pw_adapter_type);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001169
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001170u16 hpi_adapter_get_module_by_index(u16 adapter_index, u16 module_index,
1171 u16 *pw_num_outputs, u16 *pw_num_inputs, u16 *pw_version,
1172 u32 *pserial_number, u16 *pw_module_type, u32 *ph_module);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001173
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001174u16 hpi_adapter_set_mode(u16 adapter_index, u32 adapter_mode);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001175
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001176u16 hpi_adapter_set_mode_ex(u16 adapter_index, u32 adapter_mode,
1177 u16 query_or_set);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001178
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001179u16 hpi_adapter_get_mode(u16 adapter_index, u32 *padapter_mode);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001180
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001181u16 hpi_adapter_get_assert2(u16 adapter_index, u16 *p_assert_count,
1182 char *psz_assert, u32 *p_param1, u32 *p_param2,
1183 u32 *p_dsp_string_addr, u16 *p_processor_id);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001184
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001185u16 hpi_adapter_test_assert(u16 adapter_index, u16 assert_id);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001186
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001187u16 hpi_adapter_enable_capability(u16 adapter_index, u16 capability, u32 key);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001188
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001189u16 hpi_adapter_self_test(u16 adapter_index);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001190
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001191u16 hpi_adapter_debug_read(u16 adapter_index, u32 dsp_address, char *p_bytes,
1192 int *count_bytes);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001193
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001194u16 hpi_adapter_set_property(u16 adapter_index, u16 property, u16 paramter1,
1195 u16 paramter2);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001196
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001197u16 hpi_adapter_get_property(u16 adapter_index, u16 property,
1198 u16 *pw_paramter1, u16 *pw_paramter2);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001199
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001200u16 hpi_adapter_enumerate_property(u16 adapter_index, u16 index,
1201 u16 what_to_enumerate, u16 property_index, u32 *psetting);
1202/*************/
1203/* OutStream */
1204/*************/
1205u16 hpi_outstream_open(u16 adapter_index, u16 outstream_index,
1206 u32 *ph_outstream);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001207
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001208u16 hpi_outstream_close(u32 h_outstream);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001209
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001210u16 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);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001213
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001214u16 hpi_outstream_write_buf(u32 h_outstream, const u8 *pb_write_buf,
1215 u32 bytes_to_write, const struct hpi_format *p_format);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001216
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001217u16 hpi_outstream_start(u32 h_outstream);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001218
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001219u16 hpi_outstream_wait_start(u32 h_outstream);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001220
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001221u16 hpi_outstream_stop(u32 h_outstream);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001222
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001223u16 hpi_outstream_sinegen(u32 h_outstream);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001224
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001225u16 hpi_outstream_reset(u32 h_outstream);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001226
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001227u16 hpi_outstream_query_format(u32 h_outstream, struct hpi_format *p_format);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001228
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001229u16 hpi_outstream_set_format(u32 h_outstream, struct hpi_format *p_format);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001230
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001231u16 hpi_outstream_set_punch_in_out(u32 h_outstream, u32 punch_in_sample,
1232 u32 punch_out_sample);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001233
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001234u16 hpi_outstream_set_velocity(u32 h_outstream, short velocity);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001235
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001236u16 hpi_outstream_ancillary_reset(u32 h_outstream, u16 mode);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001237
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001238u16 hpi_outstream_ancillary_get_info(u32 h_outstream, u32 *pframes_available);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001239
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001240u16 hpi_outstream_ancillary_read(u32 h_outstream,
1241 struct hpi_anc_frame *p_anc_frame_buffer,
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001242 u32 anc_frame_buffer_size_in_bytes,
1243 u32 number_of_ancillary_frames_to_read);
1244
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001245u16 hpi_outstream_set_time_scale(u32 h_outstream, u32 time_scaleX10000);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001246
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001247u16 hpi_outstream_host_buffer_allocate(u32 h_outstream, u32 size_in_bytes);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001248
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001249u16 hpi_outstream_host_buffer_free(u32 h_outstream);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001250
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001251u16 hpi_outstream_group_add(u32 h_outstream, u32 h_stream);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001252
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001253u16 hpi_outstream_group_get_map(u32 h_outstream, u32 *poutstream_map,
1254 u32 *pinstream_map);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001255
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001256u16 hpi_outstream_group_reset(u32 h_outstream);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001257
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001258/************/
1259/* InStream */
1260/************/
1261u16 hpi_instream_open(u16 adapter_index, u16 instream_index,
1262 u32 *ph_instream);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001263
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001264u16 hpi_instream_close(u32 h_instream);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001265
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001266u16 hpi_instream_query_format(u32 h_instream,
1267 const struct hpi_format *p_format);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001268
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001269u16 hpi_instream_set_format(u32 h_instream,
1270 const struct hpi_format *p_format);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001271
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001272u16 hpi_instream_read_buf(u32 h_instream, u8 *pb_read_buf, u32 bytes_to_read);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001273
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001274u16 hpi_instream_start(u32 h_instream);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001275
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001276u16 hpi_instream_wait_start(u32 h_instream);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001277
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001278u16 hpi_instream_stop(u32 h_instream);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001279
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001280u16 hpi_instream_reset(u32 h_instream);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001281
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001282u16 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);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001285
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001286u16 hpi_instream_ancillary_reset(u32 h_instream, u16 bytes_per_frame,
1287 u16 mode, u16 alignment, u16 idle_bit);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001288
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001289u16 hpi_instream_ancillary_get_info(u32 h_instream, u32 *pframe_space);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001290
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001291u16 hpi_instream_ancillary_write(u32 h_instream,
1292 const struct hpi_anc_frame *p_anc_frame_buffer,
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001293 u32 anc_frame_buffer_size_in_bytes,
1294 u32 number_of_ancillary_frames_to_write);
1295
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001296u16 hpi_instream_host_buffer_allocate(u32 h_instream, u32 size_in_bytes);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001297
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001298u16 hpi_instream_host_buffer_free(u32 h_instream);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001299
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001300u16 hpi_instream_group_add(u32 h_instream, u32 h_stream);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001301
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001302u16 hpi_instream_group_get_map(u32 h_instream, u32 *poutstream_map,
1303 u32 *pinstream_map);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001304
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001305u16 hpi_instream_group_reset(u32 h_instream);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001306
1307/*********/
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001308/* Mixer */
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001309/*********/
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001310u16 hpi_mixer_open(u16 adapter_index, u32 *ph_mixer);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001311
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001312u16 hpi_mixer_close(u32 h_mixer);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001313
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001314u16 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);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001317
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001318u16 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);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001321
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001322u16 hpi_mixer_store(u32 h_mixer, enum HPI_MIXER_STORE_COMMAND command,
1323 u16 index);
1324/************/
1325/* Controls */
1326/************/
1327/******************/
1328/* Volume control */
1329/******************/
1330u16 hpi_volume_set_gain(u32 h_control, short an_gain0_01dB[HPI_MAX_CHANNELS]
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001331 );
1332
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001333u16 hpi_volume_get_gain(u32 h_control,
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001334 short an_gain0_01dB_out[HPI_MAX_CHANNELS]
1335 );
1336
Eliot Blennerhassettfc3a3992011-02-10 17:26:11 +13001337u16 hpi_volume_set_mute(u32 h_control, u32 mute);
1338
1339u16 hpi_volume_get_mute(u32 h_control, u32 *mute);
1340
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001341#define hpi_volume_get_range hpi_volume_query_range
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001342u16 hpi_volume_query_range(u32 h_control, short *min_gain_01dB,
1343 short *max_gain_01dB, short *step_gain_01dB);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001344
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001345u16 hpi_volume_query_channels(const u32 h_volume, u32 *p_channels);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001346
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001347u16 hpi_volume_auto_fade(u32 h_control,
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001348 short an_stop_gain0_01dB[HPI_MAX_CHANNELS], u32 duration_ms);
1349
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001350u16 hpi_volume_auto_fade_profile(u32 h_control,
1351 short an_stop_gain0_01dB[HPI_MAX_CHANNELS], u32 duration_ms,
1352 u16 profile);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001353
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001354/*****************/
1355/* Level control */
1356/*****************/
1357u16 hpi_level_query_range(u32 h_control, short *min_gain_01dB,
1358 short *max_gain_01dB, short *step_gain_01dB);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001359
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001360u16 hpi_level_set_gain(u32 h_control, short an_gain0_01dB[HPI_MAX_CHANNELS]
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001361 );
1362
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001363u16 hpi_level_get_gain(u32 h_control,
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001364 short an_gain0_01dB_out[HPI_MAX_CHANNELS]
1365 );
1366
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001367/*****************/
1368/* Meter control */
1369/*****************/
1370u16 hpi_meter_query_channels(const u32 h_meter, u32 *p_channels);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001371
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001372u16 hpi_meter_get_peak(u32 h_control,
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001373 short an_peak0_01dB_out[HPI_MAX_CHANNELS]
1374 );
1375
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001376u16 hpi_meter_get_rms(u32 h_control, short an_peak0_01dB_out[HPI_MAX_CHANNELS]
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001377 );
1378
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001379u16 hpi_meter_set_peak_ballistics(u32 h_control, u16 attack, u16 decay);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001380
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001381u16 hpi_meter_set_rms_ballistics(u32 h_control, u16 attack, u16 decay);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001382
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001383u16 hpi_meter_get_peak_ballistics(u32 h_control, u16 *attack, u16 *decay);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001384
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001385u16 hpi_meter_get_rms_ballistics(u32 h_control, u16 *attack, u16 *decay);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001386
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001387/************************/
1388/* ChannelMode control */
1389/************************/
1390u16 hpi_channel_mode_query_mode(const u32 h_mode, const u32 index,
1391 u16 *pw_mode);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001392
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001393u16 hpi_channel_mode_set(u32 h_control, u16 mode);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001394
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001395u16 hpi_channel_mode_get(u32 h_control, u16 *mode);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001396
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001397/*****************/
1398/* Tuner control */
1399/*****************/
1400u16 hpi_tuner_query_band(const u32 h_tuner, const u32 index, u16 *pw_band);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001401
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001402u16 hpi_tuner_set_band(u32 h_control, u16 band);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001403
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001404u16 hpi_tuner_get_band(u32 h_control, u16 *pw_band);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001405
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001406u16 hpi_tuner_query_frequency(const u32 h_tuner, const u32 index,
1407 const u16 band, u32 *pfreq);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001408
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001409u16 hpi_tuner_set_frequency(u32 h_control, u32 freq_ink_hz);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001410
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001411u16 hpi_tuner_get_frequency(u32 h_control, u32 *pw_freq_ink_hz);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001412
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001413u16 hpi_tuner_get_rf_level(u32 h_control, short *pw_level);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001414
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001415u16 hpi_tuner_get_raw_rf_level(u32 h_control, short *pw_level);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001416
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001417u16 hpi_tuner_query_gain(const u32 h_tuner, const u32 index, u16 *pw_gain);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001418
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001419u16 hpi_tuner_set_gain(u32 h_control, short gain);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001420
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001421u16 hpi_tuner_get_gain(u32 h_control, short *pn_gain);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001422
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001423u16 hpi_tuner_get_status(u32 h_control, u16 *pw_status_mask, u16 *pw_status);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001424
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001425u16 hpi_tuner_set_mode(u32 h_control, u32 mode, u32 value);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001426
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001427u16 hpi_tuner_get_mode(u32 h_control, u32 mode, u32 *pn_value);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001428
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001429u16 hpi_tuner_get_rds(u32 h_control, char *p_rds_data);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001430
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001431u16 hpi_tuner_query_deemphasis(const u32 h_tuner, const u32 index,
1432 const u16 band, u32 *pdeemphasis);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001433
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001434u16 hpi_tuner_set_deemphasis(u32 h_control, u32 deemphasis);
1435u16 hpi_tuner_get_deemphasis(u32 h_control, u32 *pdeemphasis);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001436
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001437u16 hpi_tuner_query_program(const u32 h_tuner, u32 *pbitmap_program);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001438
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001439u16 hpi_tuner_set_program(u32 h_control, u32 program);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001440
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001441u16 hpi_tuner_get_program(u32 h_control, u32 *pprogram);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001442
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001443u16 hpi_tuner_get_hd_radio_dsp_version(u32 h_control, char *psz_dsp_version,
1444 const u32 string_size);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001445
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001446u16 hpi_tuner_get_hd_radio_sdk_version(u32 h_control, char *psz_sdk_version,
1447 const u32 string_size);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001448
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001449u16 hpi_tuner_get_hd_radio_signal_quality(u32 h_control, u32 *pquality);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001450
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001451u16 hpi_tuner_get_hd_radio_signal_blend(u32 h_control, u32 *pblend);
Eliot Blennerhassett5a498ef2010-05-27 17:53:52 +12001452
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001453u16 hpi_tuner_set_hd_radio_signal_blend(u32 h_control, const u32 blend);
Eliot Blennerhassett5a498ef2010-05-27 17:53:52 +12001454
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001455/***************/
1456/* PAD control */
1457/***************/
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001458
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001459u16 hpi_pad_get_channel_name(u32 h_control, char *psz_string,
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001460 const u32 string_length);
1461
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001462u16 hpi_pad_get_artist(u32 h_control, char *psz_string,
1463 const u32 string_length);
1464
1465u16 hpi_pad_get_title(u32 h_control, char *psz_string,
1466 const u32 string_length);
1467
1468u16 hpi_pad_get_comment(u32 h_control, char *psz_string,
1469 const u32 string_length);
1470
1471u16 hpi_pad_get_program_type(u32 h_control, u32 *ppTY);
1472
1473u16 hpi_pad_get_rdsPI(u32 h_control, u32 *ppI);
1474
1475u16 hpi_pad_get_program_type_string(u32 h_control, const u32 data_type,
1476 const u32 pTY, char *psz_string, const u32 string_length);
1477
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001478/****************************/
1479/* AES/EBU Receiver control */
1480/****************************/
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001481u16 hpi_aesebu_receiver_query_format(const u32 h_aes_rx, const u32 index,
1482 u16 *pw_format);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001483
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001484u16 hpi_aesebu_receiver_set_format(u32 h_control, u16 source);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001485
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001486u16 hpi_aesebu_receiver_get_format(u32 h_control, u16 *pw_source);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001487
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001488u16 hpi_aesebu_receiver_get_sample_rate(u32 h_control, u32 *psample_rate);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001489
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001490u16 hpi_aesebu_receiver_get_user_data(u32 h_control, u16 index, u16 *pw_data);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001491
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001492u16 hpi_aesebu_receiver_get_channel_status(u32 h_control, u16 index,
1493 u16 *pw_data);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001494
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001495u16 hpi_aesebu_receiver_get_error_status(u32 h_control, u16 *pw_error_data);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001496
1497/*******************************/
1498/* AES/EBU Transmitter control */
1499/*******************************/
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001500u16 hpi_aesebu_transmitter_set_sample_rate(u32 h_control, u32 sample_rate);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001501
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001502u16 hpi_aesebu_transmitter_set_user_data(u32 h_control, u16 index, u16 data);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001503
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001504u16 hpi_aesebu_transmitter_set_channel_status(u32 h_control, u16 index,
1505 u16 data);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001506
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001507u16 hpi_aesebu_transmitter_get_channel_status(u32 h_control, u16 index,
1508 u16 *pw_data);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001509
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001510u16 hpi_aesebu_transmitter_query_format(const u32 h_aes_tx, const u32 index,
1511 u16 *pw_format);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001512
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001513u16 hpi_aesebu_transmitter_set_format(u32 h_control, u16 output_format);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001514
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001515u16 hpi_aesebu_transmitter_get_format(u32 h_control, u16 *pw_output_format);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001516
1517/***********************/
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001518/* Multiplexer control */
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001519/***********************/
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001520u16 hpi_multiplexer_set_source(u32 h_control, u16 source_node_type,
1521 u16 source_node_index);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001522
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001523u16 hpi_multiplexer_get_source(u32 h_control, u16 *source_node_type,
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001524 u16 *source_node_index);
1525
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001526u16 hpi_multiplexer_query_source(u32 h_control, u16 index,
1527 u16 *source_node_type, u16 *source_node_index);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001528
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001529/***************/
1530/* Vox control */
1531/***************/
1532u16 hpi_vox_set_threshold(u32 h_control, short an_gain0_01dB);
1533
1534u16 hpi_vox_get_threshold(u32 h_control, short *an_gain0_01dB);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001535
1536/*********************/
1537/* Bitstream control */
1538/*********************/
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001539u16 hpi_bitstream_set_clock_edge(u32 h_control, u16 edge_type);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001540
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001541u16 hpi_bitstream_set_data_polarity(u32 h_control, u16 polarity);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001542
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001543u16 hpi_bitstream_get_activity(u32 h_control, u16 *pw_clk_activity,
1544 u16 *pw_data_activity);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001545
1546/***********************/
1547/* SampleClock control */
1548/***********************/
1549
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001550u16 hpi_sample_clock_query_source(const u32 h_clock, const u32 index,
1551 u16 *pw_source);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001552
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001553u16 hpi_sample_clock_set_source(u32 h_control, u16 source);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001554
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001555u16 hpi_sample_clock_get_source(u32 h_control, u16 *pw_source);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001556
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001557u16 hpi_sample_clock_query_source_index(const u32 h_clock, const u32 index,
1558 const u32 source, u16 *pw_source_index);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001559
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001560u16 hpi_sample_clock_set_source_index(u32 h_control, u16 source_index);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001561
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001562u16 hpi_sample_clock_get_source_index(u32 h_control, u16 *pw_source_index);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001563
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001564u16 hpi_sample_clock_get_sample_rate(u32 h_control, u32 *psample_rate);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001565
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001566u16 hpi_sample_clock_query_local_rate(const u32 h_clock, const u32 index,
1567 u32 *psource);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001568
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001569u16 hpi_sample_clock_set_local_rate(u32 h_control, u32 sample_rate);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001570
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001571u16 hpi_sample_clock_get_local_rate(u32 h_control, u32 *psample_rate);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001572
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001573u16 hpi_sample_clock_set_auto(u32 h_control, u32 enable);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001574
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001575u16 hpi_sample_clock_get_auto(u32 h_control, u32 *penable);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001576
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001577u16 hpi_sample_clock_set_local_rate_lock(u32 h_control, u32 lock);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001578
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001579u16 hpi_sample_clock_get_local_rate_lock(u32 h_control, u32 *plock);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001580
1581/***********************/
1582/* Microphone control */
1583/***********************/
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001584u16 hpi_microphone_set_phantom_power(u32 h_control, u16 on_off);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001585
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001586u16 hpi_microphone_get_phantom_power(u32 h_control, u16 *pw_on_off);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001587
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001588/********************************/
1589/* Parametric Equalizer control */
1590/********************************/
1591u16 hpi_parametric_eq_get_info(u32 h_control, u16 *pw_number_of_bands,
1592 u16 *pw_enabled);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001593
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001594u16 hpi_parametric_eq_set_state(u32 h_control, u16 on_off);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001595
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001596u16 hpi_parametric_eq_set_band(u32 h_control, u16 index, u16 type,
1597 u32 frequency_hz, short q100, short gain0_01dB);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001598
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001599u16 hpi_parametric_eq_get_band(u32 h_control, u16 index, u16 *pn_type,
1600 u32 *pfrequency_hz, short *pnQ100, short *pn_gain0_01dB);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001601
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001602u16 hpi_parametric_eq_get_coeffs(u32 h_control, u16 index, short coeffs[5]
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001603 );
1604
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001605/*******************************/
1606/* Compressor Expander control */
1607/*******************************/
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001608
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001609u16 hpi_compander_set_enable(u32 h_control, u32 on);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001610
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001611u16 hpi_compander_get_enable(u32 h_control, u32 *pon);
Eliot Blennerhassett168f1b02010-07-06 08:37:06 +12001612
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001613u16 hpi_compander_set_makeup_gain(u32 h_control, short makeup_gain0_01dB);
Eliot Blennerhassett168f1b02010-07-06 08:37:06 +12001614
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001615u16 hpi_compander_get_makeup_gain(u32 h_control, short *pn_makeup_gain0_01dB);
Eliot Blennerhassett168f1b02010-07-06 08:37:06 +12001616
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001617u16 hpi_compander_set_attack_time_constant(u32 h_control, u32 index,
1618 u32 attack);
Eliot Blennerhassett168f1b02010-07-06 08:37:06 +12001619
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001620u16 hpi_compander_get_attack_time_constant(u32 h_control, u32 index,
1621 u32 *pw_attack);
Eliot Blennerhassett168f1b02010-07-06 08:37:06 +12001622
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001623u16 hpi_compander_set_decay_time_constant(u32 h_control, u32 index,
1624 u32 decay);
Eliot Blennerhassett168f1b02010-07-06 08:37:06 +12001625
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001626u16 hpi_compander_get_decay_time_constant(u32 h_control, u32 index,
1627 u32 *pw_decay);
Eliot Blennerhassett168f1b02010-07-06 08:37:06 +12001628
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001629u16 hpi_compander_set_threshold(u32 h_control, u32 index,
1630 short threshold0_01dB);
Eliot Blennerhassett168f1b02010-07-06 08:37:06 +12001631
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001632u16 hpi_compander_get_threshold(u32 h_control, u32 index,
1633 short *pn_threshold0_01dB);
Eliot Blennerhassett168f1b02010-07-06 08:37:06 +12001634
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001635u16 hpi_compander_set_ratio(u32 h_control, u32 index, u32 ratio100);
Eliot Blennerhassett168f1b02010-07-06 08:37:06 +12001636
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001637u16 hpi_compander_get_ratio(u32 h_control, u32 index, u32 *pw_ratio100);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001638
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001639/********************/
1640/* Cobranet control */
1641/********************/
1642u16 hpi_cobranet_hmi_write(u32 h_control, u32 hmi_address, u32 byte_count,
1643 u8 *pb_data);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001644
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001645u16 hpi_cobranet_hmi_read(u32 h_control, u32 hmi_address, u32 max_byte_count,
1646 u32 *pbyte_count, u8 *pb_data);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001647
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001648u16 hpi_cobranet_hmi_get_status(u32 h_control, u32 *pstatus,
1649 u32 *preadable_size, u32 *pwriteable_size);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001650
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001651u16 hpi_cobranet_get_ip_address(u32 h_control, u32 *pdw_ip_address);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001652
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001653u16 hpi_cobranet_set_ip_address(u32 h_control, u32 dw_ip_address);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001654
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001655u16 hpi_cobranet_get_static_ip_address(u32 h_control, u32 *pdw_ip_address);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001656
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001657u16 hpi_cobranet_set_static_ip_address(u32 h_control, u32 dw_ip_address);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001658
Eliot Blennerhassett1d595d22011-02-10 17:26:08 +13001659u16 hpi_cobranet_get_macaddress(u32 h_control, u32 *p_mac_msbs,
1660 u32 *p_mac_lsbs);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001661
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001662/*************************/
1663/* Tone Detector control */
1664/*************************/
1665u16 hpi_tone_detector_get_state(u32 hC, u32 *state);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001666
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001667u16 hpi_tone_detector_set_enable(u32 hC, u32 enable);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001668
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001669u16 hpi_tone_detector_get_enable(u32 hC, u32 *enable);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001670
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001671u16 hpi_tone_detector_set_event_enable(u32 hC, u32 event_enable);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001672
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001673u16 hpi_tone_detector_get_event_enable(u32 hC, u32 *event_enable);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001674
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001675u16 hpi_tone_detector_set_threshold(u32 hC, int threshold);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001676
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001677u16 hpi_tone_detector_get_threshold(u32 hC, int *threshold);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001678
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001679u16 hpi_tone_detector_get_frequency(u32 hC, u32 index, u32 *frequency);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001680
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001681/****************************/
1682/* Silence Detector control */
1683/****************************/
1684u16 hpi_silence_detector_get_state(u32 hC, u32 *state);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001685
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001686u16 hpi_silence_detector_set_enable(u32 hC, u32 enable);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001687
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001688u16 hpi_silence_detector_get_enable(u32 hC, u32 *enable);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001689
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001690u16 hpi_silence_detector_set_event_enable(u32 hC, u32 event_enable);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001691
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001692u16 hpi_silence_detector_get_event_enable(u32 hC, u32 *event_enable);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001693
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001694u16 hpi_silence_detector_set_delay(u32 hC, u32 delay);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001695
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001696u16 hpi_silence_detector_get_delay(u32 hC, u32 *delay);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001697
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001698u16 hpi_silence_detector_set_threshold(u32 hC, int threshold);
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001699
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001700u16 hpi_silence_detector_get_threshold(u32 hC, int *threshold);
1701/*********************/
1702/* Utility functions */
1703/*********************/
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +02001704
1705u16 hpi_format_create(struct hpi_format *p_format, u16 channels, u16 format,
1706 u32 sample_rate, u32 bit_rate, u32 attributes);
1707
Eliot Blennerhassettba944552011-02-10 17:26:04 +13001708#endif /*_HPI_H_ */