sound/pci/asihpi/hpi.h

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