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