sound/pci/asihpi/hpi.h

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