sound/pci/asihpi/hpi_internal.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 HPI internal definitions
  20
  21 (C) Copyright AudioScience Inc. 1996-2009
  22 ******************************************************************************/
  23
  24 #ifndef _HPI_INTERNAL_H_
  25 #define _HPI_INTERNAL_H_
  26
  27 #include "hpi.h"
  28 /** maximum number of memory regions mapped to an adapter */
  29 #define HPI_MAX_ADAPTER_MEM_SPACES (2)
  30
  31 /* Each OS needs its own hpios.h */
  32 #include "hpios.h"
  33
  34 /* physical memory allocation */
  35 void hpios_locked_mem_init(void
  36         );
  37 void hpios_locked_mem_free_all(void
  38         );
  39 #define hpios_locked_mem_prepare(a, b, c, d);
  40 #define hpios_locked_mem_unprepare(a)
  41
  42 /** Allocate and map an area of locked memory for bus master DMA operations.
  43
  44 On success, *pLockedMemeHandle is a valid handle, and 0 is returned
  45 On error *pLockedMemHandle marked invalid, non-zero returned.
  46
  47 If this function succeeds, then HpiOs_LockedMem_GetVirtAddr() and
  48 HpiOs_LockedMem_GetPyhsAddr() will always succed on the returned handle.
  49 */
  50 u16 hpios_locked_mem_alloc(struct consistent_dma_area *p_locked_mem_handle,
  51                                                            /**< memory handle */
  52         u32 size, /**< Size in bytes to allocate */
  53         struct pci_dev *p_os_reference
  54         /**< OS specific data required for memory allocation */
  55         );
  56
  57 /** Free mapping and memory represented by LockedMemHandle
  58
  59 Frees any resources, then invalidates the handle.
  60 Returns 0 on success, 1 if handle is invalid.
  61
  62 */
  63 u16 hpios_locked_mem_free(struct consistent_dma_area *locked_mem_handle);
  64
  65 /** Get the physical PCI address of memory represented by LockedMemHandle.
  66
  67 If handle is invalid *pPhysicalAddr is set to zero and return 1
  68 */
  69 u16 hpios_locked_mem_get_phys_addr(struct consistent_dma_area
  70         *locked_mem_handle, u32 *p_physical_addr);
  71
  72 /** Get the CPU address of of memory represented by LockedMemHandle.
  73
  74 If handle is NULL *ppvVirtualAddr is set to NULL and return 1
  75 */
  76 u16 hpios_locked_mem_get_virt_addr(struct consistent_dma_area
  77         *locked_mem_handle, void **ppv_virtual_addr);
  78
  79 /** Check that handle is valid
  80 i.e it represents a valid memory area
  81 */
  82 u16 hpios_locked_mem_valid(struct consistent_dma_area *locked_mem_handle);
  83
  84 /* timing/delay */
  85 void hpios_delay_micro_seconds(u32 num_micro_sec);
  86
  87 struct hpi_message;
  88 struct hpi_response;
  89
  90 typedef void hpi_handler_func(struct hpi_message *, struct hpi_response *);
  91
  92 /* If the assert fails, compiler complains
  93    something like size of array `msg' is negative.
  94    Unlike linux BUILD_BUG_ON, this works outside function scope.
  95 */
  96 #define compile_time_assert(cond, msg) \
  97     typedef char ASSERT_##msg[(cond) ? 1 : -1]
  98
  99 /******************************************* bus types */
 100 enum HPI_BUSES {
 101         HPI_BUS_ISAPNP = 1,
 102         HPI_BUS_PCI = 2,
 103         HPI_BUS_USB = 3,
 104         HPI_BUS_NET = 4
 105 };
 106
 107 enum HPI_SUBSYS_OPTIONS {
 108         /* 0, 256 are invalid, 1..255 reserved for global options */
 109         HPI_SUBSYS_OPT_NET_ENABLE = 257,
 110         HPI_SUBSYS_OPT_NET_BROADCAST = 258,
 111         HPI_SUBSYS_OPT_NET_UNICAST = 259,
 112         HPI_SUBSYS_OPT_NET_ADDR = 260,
 113         HPI_SUBSYS_OPT_NET_MASK = 261,
 114         HPI_SUBSYS_OPT_NET_ADAPTER_ADDRESS_ADD = 262
 115 };
 116
 117 /******************************************* CONTROL ATTRIBUTES ****/
 118 /* (in order of control type ID */
 119
 120 /* This allows for 255 control types, 256 unique attributes each */
 121 #define HPI_CTL_ATTR(ctl, ai) ((HPI_CONTROL_##ctl << 8) + ai)
 122
 123 /* Get the sub-index of the attribute for a control type */
 124 #define HPI_CTL_ATTR_INDEX(i) (i & 0xff)
 125
 126 /* Extract the control from the control attribute */
 127 #define HPI_CTL_ATTR_CONTROL(i) (i >> 8)
 128
 129 /** Enable event generation for a control.
 130 0=disable, 1=enable
 131 \note generic to all controls that can generate events
 132 */
 133
 134 /** Unique identifiers for every control attribute
 135 */
 136 enum HPI_CONTROL_ATTRIBUTES {
 137         HPI_GENERIC_ENABLE = HPI_CTL_ATTR(GENERIC, 1),
 138         HPI_GENERIC_EVENT_ENABLE = HPI_CTL_ATTR(GENERIC, 2),
 139
 140         HPI_VOLUME_GAIN = HPI_CTL_ATTR(VOLUME, 1),
 141         HPI_VOLUME_AUTOFADE = HPI_CTL_ATTR(VOLUME, 2),
 142         HPI_VOLUME_NUM_CHANNELS = HPI_CTL_ATTR(VOLUME, 6),
 143         HPI_VOLUME_RANGE = HPI_CTL_ATTR(VOLUME, 10),
 144
 145         HPI_METER_RMS = HPI_CTL_ATTR(METER, 1),
 146         HPI_METER_PEAK = HPI_CTL_ATTR(METER, 2),
 147         HPI_METER_RMS_BALLISTICS = HPI_CTL_ATTR(METER, 3),
 148         HPI_METER_PEAK_BALLISTICS = HPI_CTL_ATTR(METER, 4),
 149         HPI_METER_NUM_CHANNELS = HPI_CTL_ATTR(METER, 5),
 150
 151         HPI_MULTIPLEXER_SOURCE = HPI_CTL_ATTR(MULTIPLEXER, 1),
 152         HPI_MULTIPLEXER_QUERYSOURCE = HPI_CTL_ATTR(MULTIPLEXER, 2),
 153
 154         HPI_AESEBUTX_FORMAT = HPI_CTL_ATTR(AESEBUTX, 1),
 155         HPI_AESEBUTX_SAMPLERATE = HPI_CTL_ATTR(AESEBUTX, 3),
 156         HPI_AESEBUTX_CHANNELSTATUS = HPI_CTL_ATTR(AESEBUTX, 4),
 157         HPI_AESEBUTX_USERDATA = HPI_CTL_ATTR(AESEBUTX, 5),
 158
 159         HPI_AESEBURX_FORMAT = HPI_CTL_ATTR(AESEBURX, 1),
 160         HPI_AESEBURX_ERRORSTATUS = HPI_CTL_ATTR(AESEBURX, 2),
 161         HPI_AESEBURX_SAMPLERATE = HPI_CTL_ATTR(AESEBURX, 3),
 162         HPI_AESEBURX_CHANNELSTATUS = HPI_CTL_ATTR(AESEBURX, 4),
 163         HPI_AESEBURX_USERDATA = HPI_CTL_ATTR(AESEBURX, 5),
 164
 165         HPI_LEVEL_GAIN = HPI_CTL_ATTR(LEVEL, 1),
 166         HPI_LEVEL_RANGE = HPI_CTL_ATTR(LEVEL, 10),
 167
 168         HPI_TUNER_BAND = HPI_CTL_ATTR(TUNER, 1),
 169         HPI_TUNER_FREQ = HPI_CTL_ATTR(TUNER, 2),
 170         HPI_TUNER_LEVEL_AVG = HPI_CTL_ATTR(TUNER, 3),
 171         HPI_TUNER_LEVEL_RAW = HPI_CTL_ATTR(TUNER, 4),
 172         HPI_TUNER_SNR = HPI_CTL_ATTR(TUNER, 5),
 173         HPI_TUNER_GAIN = HPI_CTL_ATTR(TUNER, 6),
 174         HPI_TUNER_STATUS = HPI_CTL_ATTR(TUNER, 7),
 175         HPI_TUNER_MODE = HPI_CTL_ATTR(TUNER, 8),
 176         HPI_TUNER_RDS = HPI_CTL_ATTR(TUNER, 9),
 177         HPI_TUNER_DEEMPHASIS = HPI_CTL_ATTR(TUNER, 10),
 178         HPI_TUNER_PROGRAM = HPI_CTL_ATTR(TUNER, 11),
 179         HPI_TUNER_HDRADIO_SIGNAL_QUALITY = HPI_CTL_ATTR(TUNER, 12),
 180         HPI_TUNER_HDRADIO_SDK_VERSION = HPI_CTL_ATTR(TUNER, 13),
 181         HPI_TUNER_HDRADIO_DSP_VERSION = HPI_CTL_ATTR(TUNER, 14),
 182         HPI_TUNER_HDRADIO_BLEND = HPI_CTL_ATTR(TUNER, 15),
 183
 184         HPI_VOX_THRESHOLD = HPI_CTL_ATTR(VOX, 1),
 185
 186         HPI_CHANNEL_MODE_MODE = HPI_CTL_ATTR(CHANNEL_MODE, 1),
 187
 188         HPI_BITSTREAM_DATA_POLARITY = HPI_CTL_ATTR(BITSTREAM, 1),
 189         HPI_BITSTREAM_CLOCK_EDGE = HPI_CTL_ATTR(BITSTREAM, 2),
 190         HPI_BITSTREAM_CLOCK_SOURCE = HPI_CTL_ATTR(BITSTREAM, 3),
 191         HPI_BITSTREAM_ACTIVITY = HPI_CTL_ATTR(BITSTREAM, 4),
 192
 193         HPI_SAMPLECLOCK_SOURCE = HPI_CTL_ATTR(SAMPLECLOCK, 1),
 194         HPI_SAMPLECLOCK_SAMPLERATE = HPI_CTL_ATTR(SAMPLECLOCK, 2),
 195         HPI_SAMPLECLOCK_SOURCE_INDEX = HPI_CTL_ATTR(SAMPLECLOCK, 3),
 196         HPI_SAMPLECLOCK_LOCAL_SAMPLERATE = HPI_CTL_ATTR(SAMPLECLOCK, 4),
 197         HPI_SAMPLECLOCK_AUTO = HPI_CTL_ATTR(SAMPLECLOCK, 5),
 198         HPI_SAMPLECLOCK_LOCAL_LOCK = HPI_CTL_ATTR(SAMPLECLOCK, 6),
 199
 200         HPI_MICROPHONE_PHANTOM_POWER = HPI_CTL_ATTR(MICROPHONE, 1),
 201
 202         HPI_EQUALIZER_NUM_FILTERS = HPI_CTL_ATTR(EQUALIZER, 1),
 203         HPI_EQUALIZER_FILTER = HPI_CTL_ATTR(EQUALIZER, 2),
 204         HPI_EQUALIZER_COEFFICIENTS = HPI_CTL_ATTR(EQUALIZER, 3),
 205
 206         HPI_COMPANDER_PARAMS = HPI_CTL_ATTR(COMPANDER, 1),
 207         HPI_COMPANDER_MAKEUPGAIN = HPI_CTL_ATTR(COMPANDER, 2),
 208         HPI_COMPANDER_THRESHOLD = HPI_CTL_ATTR(COMPANDER, 3),
 209         HPI_COMPANDER_RATIO = HPI_CTL_ATTR(COMPANDER, 4),
 210         HPI_COMPANDER_ATTACK = HPI_CTL_ATTR(COMPANDER, 5),
 211         HPI_COMPANDER_DECAY = HPI_CTL_ATTR(COMPANDER, 6),
 212
 213         HPI_COBRANET_SET = HPI_CTL_ATTR(COBRANET, 1),
 214         HPI_COBRANET_GET = HPI_CTL_ATTR(COBRANET, 2),
 215         HPI_COBRANET_SET_DATA = HPI_CTL_ATTR(COBRANET, 3),
 216         HPI_COBRANET_GET_DATA = HPI_CTL_ATTR(COBRANET, 4),
 217         HPI_COBRANET_GET_STATUS = HPI_CTL_ATTR(COBRANET, 5),
 218         HPI_COBRANET_SEND_PACKET = HPI_CTL_ATTR(COBRANET, 6),
 219         HPI_COBRANET_GET_PACKET = HPI_CTL_ATTR(COBRANET, 7),
 220
 221         HPI_TONEDETECTOR_THRESHOLD = HPI_CTL_ATTR(TONEDETECTOR, 1),
 222         HPI_TONEDETECTOR_STATE = HPI_CTL_ATTR(TONEDETECTOR, 2),
 223         HPI_TONEDETECTOR_FREQUENCY = HPI_CTL_ATTR(TONEDETECTOR, 3),
 224
 225         HPI_SILENCEDETECTOR_THRESHOLD = HPI_CTL_ATTR(SILENCEDETECTOR, 1),
 226         HPI_SILENCEDETECTOR_STATE = HPI_CTL_ATTR(SILENCEDETECTOR, 2),
 227         HPI_SILENCEDETECTOR_DELAY = HPI_CTL_ATTR(SILENCEDETECTOR, 3),
 228
 229         HPI_PAD_CHANNEL_NAME = HPI_CTL_ATTR(PAD, 1),
 230         HPI_PAD_ARTIST = HPI_CTL_ATTR(PAD, 2),
 231         HPI_PAD_TITLE = HPI_CTL_ATTR(PAD, 3),
 232         HPI_PAD_COMMENT = HPI_CTL_ATTR(PAD, 4),
 233         HPI_PAD_PROGRAM_TYPE = HPI_CTL_ATTR(PAD, 5),
 234         HPI_PAD_PROGRAM_ID = HPI_CTL_ATTR(PAD, 6),
 235         HPI_PAD_TA_SUPPORT = HPI_CTL_ATTR(PAD, 7),
 236         HPI_PAD_TA_ACTIVE = HPI_CTL_ATTR(PAD, 8)
 237 };
 238
 239 #define HPI_POLARITY_POSITIVE           0
 240 #define HPI_POLARITY_NEGATIVE           1
 241
 242 /*------------------------------------------------------------
 243  Cobranet Chip Bridge - copied from HMI.H
 244 ------------------------------------------------------------*/
 245 #define  HPI_COBRANET_HMI_cobra_bridge           0x20000
 246 #define  HPI_COBRANET_HMI_cobra_bridge_tx_pkt_buf \
 247         (HPI_COBRANET_HMI_cobra_bridge + 0x1000)
 248 #define  HPI_COBRANET_HMI_cobra_bridge_rx_pkt_buf \
 249         (HPI_COBRANET_HMI_cobra_bridge + 0x2000)
 250 #define  HPI_COBRANET_HMI_cobra_if_table1         0x110000
 251 #define  HPI_COBRANET_HMI_cobra_if_phy_address \
 252         (HPI_COBRANET_HMI_cobra_if_table1 + 0xd)
 253 #define  HPI_COBRANET_HMI_cobra_protocolIP       0x72000
 254 #define  HPI_COBRANET_HMI_cobra_ip_mon_currentIP \
 255         (HPI_COBRANET_HMI_cobra_protocolIP + 0x0)
 256 #define  HPI_COBRANET_HMI_cobra_ip_mon_staticIP \
 257         (HPI_COBRANET_HMI_cobra_protocolIP + 0x2)
 258 #define  HPI_COBRANET_HMI_cobra_sys              0x100000
 259 #define  HPI_COBRANET_HMI_cobra_sys_desc \
 260                 (HPI_COBRANET_HMI_cobra_sys + 0x0)
 261 #define  HPI_COBRANET_HMI_cobra_sys_objectID \
 262         (HPI_COBRANET_HMI_cobra_sys + 0x100)
 263 #define  HPI_COBRANET_HMI_cobra_sys_contact \
 264         (HPI_COBRANET_HMI_cobra_sys + 0x200)
 265 #define  HPI_COBRANET_HMI_cobra_sys_name \
 266                 (HPI_COBRANET_HMI_cobra_sys + 0x300)
 267 #define  HPI_COBRANET_HMI_cobra_sys_location \
 268         (HPI_COBRANET_HMI_cobra_sys + 0x400)
 269
 270 /*------------------------------------------------------------
 271  Cobranet Chip Status bits
 272 ------------------------------------------------------------*/
 273 #define HPI_COBRANET_HMI_STATUS_RXPACKET 2
 274 #define HPI_COBRANET_HMI_STATUS_TXPACKET 3
 275
 276 /*------------------------------------------------------------
 277  Ethernet header size
 278 ------------------------------------------------------------*/
 279 #define HPI_ETHERNET_HEADER_SIZE (16)
 280
 281 /* These defines are used to fill in protocol information for an Ethernet packet
 282     sent using HMI on CS18102 */
 283 /** ID supplied by Cirrius for ASI packets. */
 284 #define HPI_ETHERNET_PACKET_ID                  0x85
 285 /** Simple packet - no special routing required */
 286 #define HPI_ETHERNET_PACKET_V1                  0x01
 287 /** This packet must make its way to the host across the HPI interface */
 288 #define HPI_ETHERNET_PACKET_HOSTED_VIA_HMI      0x20
 289 /** This packet must make its way to the host across the HPI interface */
 290 #define HPI_ETHERNET_PACKET_HOSTED_VIA_HMI_V1   0x21
 291 /** This packet must make its way to the host across the HPI interface */
 292 #define HPI_ETHERNET_PACKET_HOSTED_VIA_HPI      0x40
 293 /** This packet must make its way to the host across the HPI interface */
 294 #define HPI_ETHERNET_PACKET_HOSTED_VIA_HPI_V1   0x41
 295
 296 #define HPI_ETHERNET_UDP_PORT (44600)   /*!< UDP messaging port */
 297
 298 /** Base network time out is set to 100 milli-seconds. */
 299 #define HPI_ETHERNET_TIMEOUT_MS      (100)
 300
 301 /** Locked memory buffer alloc/free phases */
 302 enum HPI_BUFFER_CMDS {
 303         /** use one message to allocate or free physical memory */
 304         HPI_BUFFER_CMD_EXTERNAL = 0,
 305         /** alloc physical memory */
 306         HPI_BUFFER_CMD_INTERNAL_ALLOC = 1,
 307         /** send physical memory address to adapter */
 308         HPI_BUFFER_CMD_INTERNAL_GRANTADAPTER = 2,
 309         /** notify adapter to stop using physical buffer */
 310         HPI_BUFFER_CMD_INTERNAL_REVOKEADAPTER = 3,
 311         /** free physical buffer */
 312         HPI_BUFFER_CMD_INTERNAL_FREE = 4
 313 };
 314
 315 /*****************************************************************************/
 316 /*****************************************************************************/
 317 /********               HPI LOW LEVEL MESSAGES                  *******/
 318 /*****************************************************************************/
 319 /*****************************************************************************/
 320 /** Pnp ids */
 321 /** "ASI"  - actual is "ASX" - need to change */
 322 #define HPI_ID_ISAPNP_AUDIOSCIENCE      0x0669
 323 /** PCI vendor ID that AudioScience uses */
 324 #define HPI_PCI_VENDOR_ID_AUDIOSCIENCE  0x175C
 325 /** PCI vendor ID that the DSP56301 has */
 326 #define HPI_PCI_VENDOR_ID_MOTOROLA      0x1057
 327 /** PCI vendor ID that TI uses */
 328 #define HPI_PCI_VENDOR_ID_TI            0x104C
 329
 330 #define HPI_PCI_DEV_ID_PCI2040          0xAC60
 331 /** TI's C6205 PCI interface has this ID */
 332 #define HPI_PCI_DEV_ID_DSP6205          0xA106
 333
 334 #define HPI_USB_VENDOR_ID_AUDIOSCIENCE  0x1257
 335 #define HPI_USB_W2K_TAG                 0x57495341      /* "ASIW"       */
 336 #define HPI_USB_LINUX_TAG               0x4C495341      /* "ASIL"       */
 337
 338 /** Invalid Adapter index
 339 Used in HPI messages that are not addressed to a specific adapter
 340 Used in DLL to indicate device not present
 341 */
 342 #define HPI_ADAPTER_INDEX_INVALID 0xFFFF
 343
 344 /** First 2 hex digits define the adapter family */
 345 #define HPI_ADAPTER_FAMILY_MASK         0xff00
 346 #define HPI_MODULE_FAMILY_MASK          0xfff0
 347
 348 #define HPI_ADAPTER_FAMILY_ASI(f)   (f & HPI_ADAPTER_FAMILY_MASK)
 349 #define HPI_MODULE_FAMILY_ASI(f)   (f & HPI_MODULE_FAMILY_MASK)
 350 #define HPI_ADAPTER_ASI(f)   (f)
 351
 352 enum HPI_MESSAGE_TYPES {
 353         HPI_TYPE_MESSAGE = 1,
 354         HPI_TYPE_RESPONSE = 2,
 355         HPI_TYPE_DATA = 3,
 356         HPI_TYPE_SSX2BYPASS_MESSAGE = 4
 357 };
 358
 359 enum HPI_OBJECT_TYPES {
 360         HPI_OBJ_SUBSYSTEM = 1,
 361         HPI_OBJ_ADAPTER = 2,
 362         HPI_OBJ_OSTREAM = 3,
 363         HPI_OBJ_ISTREAM = 4,
 364         HPI_OBJ_MIXER = 5,
 365         HPI_OBJ_NODE = 6,
 366         HPI_OBJ_CONTROL = 7,
 367         HPI_OBJ_NVMEMORY = 8,
 368         HPI_OBJ_GPIO = 9,
 369         HPI_OBJ_WATCHDOG = 10,
 370         HPI_OBJ_CLOCK = 11,
 371         HPI_OBJ_PROFILE = 12,
 372         HPI_OBJ_CONTROLEX = 13,
 373         HPI_OBJ_ASYNCEVENT = 14
 374 #define HPI_OBJ_MAXINDEX 14
 375 };
 376
 377 #define HPI_OBJ_FUNCTION_SPACING 0x100
 378 #define HPI_FUNC_ID(obj, index) \
 379         (HPI_OBJ_##obj * HPI_OBJ_FUNCTION_SPACING + index)
 380
 381 #define HPI_EXTRACT_INDEX(fn) (fn & 0xff)
 382
 383 enum HPI_FUNCTION_IDS {
 384         HPI_SUBSYS_OPEN = HPI_FUNC_ID(SUBSYSTEM, 1),
 385         HPI_SUBSYS_GET_VERSION = HPI_FUNC_ID(SUBSYSTEM, 2),
 386         HPI_SUBSYS_GET_INFO = HPI_FUNC_ID(SUBSYSTEM, 3),
 387         HPI_SUBSYS_FIND_ADAPTERS = HPI_FUNC_ID(SUBSYSTEM, 4),
 388         HPI_SUBSYS_CREATE_ADAPTER = HPI_FUNC_ID(SUBSYSTEM, 5),
 389         HPI_SUBSYS_CLOSE = HPI_FUNC_ID(SUBSYSTEM, 6),
 390         HPI_SUBSYS_DELETE_ADAPTER = HPI_FUNC_ID(SUBSYSTEM, 7),
 391         HPI_SUBSYS_DRIVER_LOAD = HPI_FUNC_ID(SUBSYSTEM, 8),
 392         HPI_SUBSYS_DRIVER_UNLOAD = HPI_FUNC_ID(SUBSYSTEM, 9),
 393         HPI_SUBSYS_READ_PORT_8 = HPI_FUNC_ID(SUBSYSTEM, 10),
 394         HPI_SUBSYS_WRITE_PORT_8 = HPI_FUNC_ID(SUBSYSTEM, 11),
 395         HPI_SUBSYS_GET_NUM_ADAPTERS = HPI_FUNC_ID(SUBSYSTEM, 12),
 396         HPI_SUBSYS_GET_ADAPTER = HPI_FUNC_ID(SUBSYSTEM, 13),
 397         HPI_SUBSYS_SET_NETWORK_INTERFACE = HPI_FUNC_ID(SUBSYSTEM, 14),
 398         HPI_SUBSYS_OPTION_INFO = HPI_FUNC_ID(SUBSYSTEM, 15),
 399         HPI_SUBSYS_OPTION_GET = HPI_FUNC_ID(SUBSYSTEM, 16),
 400         HPI_SUBSYS_OPTION_SET = HPI_FUNC_ID(SUBSYSTEM, 17),
 401 #define HPI_SUBSYS_FUNCTION_COUNT 17
 402
 403         HPI_ADAPTER_OPEN = HPI_FUNC_ID(ADAPTER, 1),
 404         HPI_ADAPTER_CLOSE = HPI_FUNC_ID(ADAPTER, 2),
 405         HPI_ADAPTER_GET_INFO = HPI_FUNC_ID(ADAPTER, 3),
 406         HPI_ADAPTER_GET_ASSERT = HPI_FUNC_ID(ADAPTER, 4),
 407         HPI_ADAPTER_TEST_ASSERT = HPI_FUNC_ID(ADAPTER, 5),
 408         HPI_ADAPTER_SET_MODE = HPI_FUNC_ID(ADAPTER, 6),
 409         HPI_ADAPTER_GET_MODE = HPI_FUNC_ID(ADAPTER, 7),
 410         HPI_ADAPTER_ENABLE_CAPABILITY = HPI_FUNC_ID(ADAPTER, 8),
 411         HPI_ADAPTER_SELFTEST = HPI_FUNC_ID(ADAPTER, 9),
 412         HPI_ADAPTER_FIND_OBJECT = HPI_FUNC_ID(ADAPTER, 10),
 413         HPI_ADAPTER_QUERY_FLASH = HPI_FUNC_ID(ADAPTER, 11),
 414         HPI_ADAPTER_START_FLASH = HPI_FUNC_ID(ADAPTER, 12),
 415         HPI_ADAPTER_PROGRAM_FLASH = HPI_FUNC_ID(ADAPTER, 13),
 416         HPI_ADAPTER_SET_PROPERTY = HPI_FUNC_ID(ADAPTER, 14),
 417         HPI_ADAPTER_GET_PROPERTY = HPI_FUNC_ID(ADAPTER, 15),
 418         HPI_ADAPTER_ENUM_PROPERTY = HPI_FUNC_ID(ADAPTER, 16),
 419         HPI_ADAPTER_MODULE_INFO = HPI_FUNC_ID(ADAPTER, 17),
 420         HPI_ADAPTER_DEBUG_READ = HPI_FUNC_ID(ADAPTER, 18),
 421 #define HPI_ADAPTER_FUNCTION_COUNT 18
 422
 423         HPI_OSTREAM_OPEN = HPI_FUNC_ID(OSTREAM, 1),
 424         HPI_OSTREAM_CLOSE = HPI_FUNC_ID(OSTREAM, 2),
 425         HPI_OSTREAM_WRITE = HPI_FUNC_ID(OSTREAM, 3),
 426         HPI_OSTREAM_START = HPI_FUNC_ID(OSTREAM, 4),
 427         HPI_OSTREAM_STOP = HPI_FUNC_ID(OSTREAM, 5),
 428         HPI_OSTREAM_RESET = HPI_FUNC_ID(OSTREAM, 6),
 429         HPI_OSTREAM_GET_INFO = HPI_FUNC_ID(OSTREAM, 7),
 430         HPI_OSTREAM_QUERY_FORMAT = HPI_FUNC_ID(OSTREAM, 8),
 431         HPI_OSTREAM_DATA = HPI_FUNC_ID(OSTREAM, 9),
 432         HPI_OSTREAM_SET_VELOCITY = HPI_FUNC_ID(OSTREAM, 10),
 433         HPI_OSTREAM_SET_PUNCHINOUT = HPI_FUNC_ID(OSTREAM, 11),
 434         HPI_OSTREAM_SINEGEN = HPI_FUNC_ID(OSTREAM, 12),
 435         HPI_OSTREAM_ANC_RESET = HPI_FUNC_ID(OSTREAM, 13),
 436         HPI_OSTREAM_ANC_GET_INFO = HPI_FUNC_ID(OSTREAM, 14),
 437         HPI_OSTREAM_ANC_READ = HPI_FUNC_ID(OSTREAM, 15),
 438         HPI_OSTREAM_SET_TIMESCALE = HPI_FUNC_ID(OSTREAM, 16),
 439         HPI_OSTREAM_SET_FORMAT = HPI_FUNC_ID(OSTREAM, 17),
 440         HPI_OSTREAM_HOSTBUFFER_ALLOC = HPI_FUNC_ID(OSTREAM, 18),
 441         HPI_OSTREAM_HOSTBUFFER_FREE = HPI_FUNC_ID(OSTREAM, 19),
 442         HPI_OSTREAM_GROUP_ADD = HPI_FUNC_ID(OSTREAM, 20),
 443         HPI_OSTREAM_GROUP_GETMAP = HPI_FUNC_ID(OSTREAM, 21),
 444         HPI_OSTREAM_GROUP_RESET = HPI_FUNC_ID(OSTREAM, 22),
 445         HPI_OSTREAM_HOSTBUFFER_GET_INFO = HPI_FUNC_ID(OSTREAM, 23),
 446         HPI_OSTREAM_WAIT_START = HPI_FUNC_ID(OSTREAM, 24),
 447 #define HPI_OSTREAM_FUNCTION_COUNT 24
 448
 449         HPI_ISTREAM_OPEN = HPI_FUNC_ID(ISTREAM, 1),
 450         HPI_ISTREAM_CLOSE = HPI_FUNC_ID(ISTREAM, 2),
 451         HPI_ISTREAM_SET_FORMAT = HPI_FUNC_ID(ISTREAM, 3),
 452         HPI_ISTREAM_READ = HPI_FUNC_ID(ISTREAM, 4),
 453         HPI_ISTREAM_START = HPI_FUNC_ID(ISTREAM, 5),
 454         HPI_ISTREAM_STOP = HPI_FUNC_ID(ISTREAM, 6),
 455         HPI_ISTREAM_RESET = HPI_FUNC_ID(ISTREAM, 7),
 456         HPI_ISTREAM_GET_INFO = HPI_FUNC_ID(ISTREAM, 8),
 457         HPI_ISTREAM_QUERY_FORMAT = HPI_FUNC_ID(ISTREAM, 9),
 458         HPI_ISTREAM_ANC_RESET = HPI_FUNC_ID(ISTREAM, 10),
 459         HPI_ISTREAM_ANC_GET_INFO = HPI_FUNC_ID(ISTREAM, 11),
 460         HPI_ISTREAM_ANC_WRITE = HPI_FUNC_ID(ISTREAM, 12),
 461         HPI_ISTREAM_HOSTBUFFER_ALLOC = HPI_FUNC_ID(ISTREAM, 13),
 462         HPI_ISTREAM_HOSTBUFFER_FREE = HPI_FUNC_ID(ISTREAM, 14),
 463         HPI_ISTREAM_GROUP_ADD = HPI_FUNC_ID(ISTREAM, 15),
 464         HPI_ISTREAM_GROUP_GETMAP = HPI_FUNC_ID(ISTREAM, 16),
 465         HPI_ISTREAM_GROUP_RESET = HPI_FUNC_ID(ISTREAM, 17),
 466         HPI_ISTREAM_HOSTBUFFER_GET_INFO = HPI_FUNC_ID(ISTREAM, 18),
 467         HPI_ISTREAM_WAIT_START = HPI_FUNC_ID(ISTREAM, 19),
 468 #define HPI_ISTREAM_FUNCTION_COUNT 19
 469
 470 /* NOTE:
 471    GET_NODE_INFO, SET_CONNECTION, GET_CONNECTIONS are not currently used */
 472         HPI_MIXER_OPEN = HPI_FUNC_ID(MIXER, 1),
 473         HPI_MIXER_CLOSE = HPI_FUNC_ID(MIXER, 2),
 474         HPI_MIXER_GET_INFO = HPI_FUNC_ID(MIXER, 3),
 475         HPI_MIXER_GET_NODE_INFO = HPI_FUNC_ID(MIXER, 4),
 476         HPI_MIXER_GET_CONTROL = HPI_FUNC_ID(MIXER, 5),
 477         HPI_MIXER_SET_CONNECTION = HPI_FUNC_ID(MIXER, 6),
 478         HPI_MIXER_GET_CONNECTIONS = HPI_FUNC_ID(MIXER, 7),
 479         HPI_MIXER_GET_CONTROL_BY_INDEX = HPI_FUNC_ID(MIXER, 8),
 480         HPI_MIXER_GET_CONTROL_ARRAY_BY_INDEX = HPI_FUNC_ID(MIXER, 9),
 481         HPI_MIXER_GET_CONTROL_MULTIPLE_VALUES = HPI_FUNC_ID(MIXER, 10),
 482         HPI_MIXER_STORE = HPI_FUNC_ID(MIXER, 11),
 483 #define HPI_MIXER_FUNCTION_COUNT 11
 484
 485         HPI_CONTROL_GET_INFO = HPI_FUNC_ID(CONTROL, 1),
 486         HPI_CONTROL_GET_STATE = HPI_FUNC_ID(CONTROL, 2),
 487         HPI_CONTROL_SET_STATE = HPI_FUNC_ID(CONTROL, 3),
 488 #define HPI_CONTROL_FUNCTION_COUNT 3
 489
 490         HPI_NVMEMORY_OPEN = HPI_FUNC_ID(NVMEMORY, 1),
 491         HPI_NVMEMORY_READ_BYTE = HPI_FUNC_ID(NVMEMORY, 2),
 492         HPI_NVMEMORY_WRITE_BYTE = HPI_FUNC_ID(NVMEMORY, 3),
 493 #define HPI_NVMEMORY_FUNCTION_COUNT 3
 494
 495         HPI_GPIO_OPEN = HPI_FUNC_ID(GPIO, 1),
 496         HPI_GPIO_READ_BIT = HPI_FUNC_ID(GPIO, 2),
 497         HPI_GPIO_WRITE_BIT = HPI_FUNC_ID(GPIO, 3),
 498         HPI_GPIO_READ_ALL = HPI_FUNC_ID(GPIO, 4),
 499         HPI_GPIO_WRITE_STATUS = HPI_FUNC_ID(GPIO, 5),
 500 #define HPI_GPIO_FUNCTION_COUNT 5
 501
 502         HPI_ASYNCEVENT_OPEN = HPI_FUNC_ID(ASYNCEVENT, 1),
 503         HPI_ASYNCEVENT_CLOSE = HPI_FUNC_ID(ASYNCEVENT, 2),
 504         HPI_ASYNCEVENT_WAIT = HPI_FUNC_ID(ASYNCEVENT, 3),
 505         HPI_ASYNCEVENT_GETCOUNT = HPI_FUNC_ID(ASYNCEVENT, 4),
 506         HPI_ASYNCEVENT_GET = HPI_FUNC_ID(ASYNCEVENT, 5),
 507         HPI_ASYNCEVENT_SENDEVENTS = HPI_FUNC_ID(ASYNCEVENT, 6),
 508 #define HPI_ASYNCEVENT_FUNCTION_COUNT 6
 509
 510         HPI_WATCHDOG_OPEN = HPI_FUNC_ID(WATCHDOG, 1),
 511         HPI_WATCHDOG_SET_TIME = HPI_FUNC_ID(WATCHDOG, 2),
 512         HPI_WATCHDOG_PING = HPI_FUNC_ID(WATCHDOG, 3),
 513
 514         HPI_CLOCK_OPEN = HPI_FUNC_ID(CLOCK, 1),
 515         HPI_CLOCK_SET_TIME = HPI_FUNC_ID(CLOCK, 2),
 516         HPI_CLOCK_GET_TIME = HPI_FUNC_ID(CLOCK, 3),
 517
 518         HPI_PROFILE_OPEN_ALL = HPI_FUNC_ID(PROFILE, 1),
 519         HPI_PROFILE_START_ALL = HPI_FUNC_ID(PROFILE, 2),
 520         HPI_PROFILE_STOP_ALL = HPI_FUNC_ID(PROFILE, 3),
 521         HPI_PROFILE_GET = HPI_FUNC_ID(PROFILE, 4),
 522         HPI_PROFILE_GET_IDLECOUNT = HPI_FUNC_ID(PROFILE, 5),
 523         HPI_PROFILE_GET_NAME = HPI_FUNC_ID(PROFILE, 6),
 524         HPI_PROFILE_GET_UTILIZATION = HPI_FUNC_ID(PROFILE, 7)
 525 #define HPI_PROFILE_FUNCTION_COUNT 7
 526 };
 527
 528 /* ////////////////////////////////////////////////////////////////////// */
 529 /* STRUCTURES */
 530 #ifndef DISABLE_PRAGMA_PACK1
 531 #pragma pack(push, 1)
 532 #endif
 533
 534 /** PCI bus resource */
 535 struct hpi_pci {
 536         u32 __iomem *ap_mem_base[HPI_MAX_ADAPTER_MEM_SPACES];
 537         struct pci_dev *pci_dev;
 538 };
 539
 540 struct hpi_resource {
 541         union {
 542                 const struct hpi_pci *pci;
 543                 const char *net_if;
 544         } r;
 545 #ifndef HPI64BIT                /* keep structure size constant */
 546         u32 pad_to64;
 547 #endif
 548         u16 bus_type;           /* HPI_BUS_PNPISA, _PCI, _USB etc */
 549         u16 padding;
 550
 551 };
 552
 553 /** Format info used inside struct hpi_message
 554     Not the same as public API struct hpi_format */
 555 struct hpi_msg_format {
 556         u32 sample_rate; /**< 11025, 32000, 44100 etc. */
 557         u32 bit_rate; /**< for MPEG */
 558         u32 attributes; /**< stereo/joint_stereo/mono */
 559         u16 channels; /**< 1,2..., (or ancillary mode or idle bit */
 560         u16 format; /**< HPI_FORMAT_PCM16, _MPEG etc. see \ref HPI_FORMATS. */
 561 };
 562
 563 /**  Buffer+format structure.
 564          Must be kept 7 * 32 bits to match public struct hpi_datastruct */
 565 struct hpi_msg_data {
 566         struct hpi_msg_format format;
 567         u8 *pb_data;
 568 #ifndef HPI64BIT
 569         u32 padding;
 570 #endif
 571         u32 data_size;
 572 };
 573
 574 /** struct hpi_datastructure used up to 3.04 driver */
 575 struct hpi_data_legacy32 {
 576         struct hpi_format format;
 577         u32 pb_data;
 578         u32 data_size;
 579 };
 580
 581 #ifdef HPI64BIT
 582 /* Compatibility version of struct hpi_data*/
 583 struct hpi_data_compat32 {
 584         struct hpi_msg_format format;
 585         u32 pb_data;
 586         u32 padding;
 587         u32 data_size;
 588 };
 589 #endif
 590
 591 struct hpi_buffer {
 592   /** placehoder for backward compatability (see dwBufferSize) */
 593         struct hpi_msg_format reserved;
 594         u32 command; /**< HPI_BUFFER_CMD_xxx*/
 595         u32 pci_address; /**< PCI physical address of buffer for DSP DMA */
 596         u32 buffer_size; /**< must line up with data_size of HPI_DATA*/
 597 };
 598
 599 /*/////////////////////////////////////////////////////////////////////////// */
 600 /* This is used for background buffer bus mastering stream buffers.           */
 601 struct hpi_hostbuffer_status {
 602         u32 samples_processed;
 603         u32 auxiliary_data_available;
 604         u32 stream_state;
 605         /* DSP index in to the host bus master buffer. */
 606         u32 dSP_index;
 607         /* Host index in to the host bus master buffer. */
 608         u32 host_index;
 609         u32 size_in_bytes;
 610 };
 611
 612 struct hpi_streamid {
 613         u16 object_type;
 614                     /**< Type of object, HPI_OBJ_OSTREAM or HPI_OBJ_ISTREAM. */
 615         u16 stream_index; /**< outstream or instream index. */
 616 };
 617
 618 struct hpi_punchinout {
 619         u32 punch_in_sample;
 620         u32 punch_out_sample;
 621 };
 622
 623 struct hpi_subsys_msg {
 624         struct hpi_resource resource;
 625 };
 626
 627 struct hpi_subsys_res {
 628         u32 version;
 629         u32 data;               /* used to return extended version */
 630         u16 num_adapters;       /* number of adapters */
 631         u16 adapter_index;
 632         u16 aw_adapter_list[HPI_MAX_ADAPTERS];
 633 };
 634
 635 union hpi_adapterx_msg {
 636         struct {
 637                 u32 dsp_address;
 638                 u32 count_bytes;
 639         } debug_read;
 640         struct {
 641                 u32 adapter_mode;
 642                 u16 query_or_set;
 643         } mode;
 644         struct {
 645                 u16 index;
 646         } module_info;
 647         struct {
 648                 u32 checksum;
 649                 u16 sequence;
 650                 u16 length;
 651                 u16 offset; /**< offset from start of msg to data */
 652                 u16 unused;
 653         } program_flash;
 654         struct {
 655                 u16 index;
 656                 u16 what;
 657                 u16 property_index;
 658         } property_enum;
 659         struct {
 660                 u16 property;
 661                 u16 parameter1;
 662                 u16 parameter2;
 663         } property_set;
 664         struct {
 665                 u32 offset;
 666         } query_flash;
 667         struct {
 668                 u32 pad32;
 669                 u16 key1;
 670                 u16 key2;
 671         } restart;
 672         struct {
 673                 u32 offset;
 674                 u32 length;
 675                 u32 key;
 676         } start_flash;
 677         struct {
 678                 u32 pad32;
 679                 u16 value;
 680         } test_assert;
 681 };
 682
 683 struct hpi_adapter_res {
 684         u32 serial_number;
 685         u16 adapter_type;
 686         u16 adapter_index;
 687         u16 num_instreams;
 688         u16 num_outstreams;
 689         u16 num_mixers;
 690         u16 version;
 691         u8 sz_adapter_assert[HPI_STRING_LEN];
 692 };
 693
 694 union hpi_adapterx_res {
 695         struct hpi_adapter_res info;
 696         struct {
 697                 u32 p1;
 698                 u16 count;
 699                 u16 dsp_index;
 700                 u32 p2;
 701                 u32 dsp_msg_addr;
 702                 char sz_message[HPI_STRING_LEN];
 703         } assert;
 704         struct {
 705                 u32 adapter_mode;
 706         } mode;
 707         struct {
 708                 u16 sequence;
 709         } program_flash;
 710         struct {
 711                 u16 parameter1;
 712                 u16 parameter2;
 713         } property_get;
 714         struct {
 715                 u32 checksum;
 716                 u32 length;
 717                 u32 version;
 718         } query_flash;
 719 };
 720
 721 struct hpi_stream_msg {
 722         union {
 723                 struct hpi_msg_data data;
 724                 struct hpi_data_legacy32 data32;
 725                 u16 velocity;
 726                 struct hpi_punchinout pio;
 727                 u32 time_scale;
 728                 struct hpi_buffer buffer;
 729                 struct hpi_streamid stream;
 730         } u;
 731 };
 732
 733 struct hpi_stream_res {
 734         union {
 735                 struct {
 736                         /* size of hardware buffer */
 737                         u32 buffer_size;
 738                         /* OutStream - data to play,
 739                            InStream - data recorded */
 740                         u32 data_available;
 741                         /* OutStream - samples played,
 742                            InStream - samples recorded */
 743                         u32 samples_transferred;
 744                         /* Adapter - OutStream - data to play,
 745                            InStream - data recorded */
 746                         u32 auxiliary_data_available;
 747                         u16 state;      /* HPI_STATE_PLAYING, _STATE_STOPPED */
 748                         u16 padding;
 749                 } stream_info;
 750                 struct {
 751                         u32 buffer_size;
 752                         u32 data_available;
 753                         u32 samples_transfered;
 754                         u16 state;
 755                         u16 outstream_index;
 756                         u16 instream_index;
 757                         u16 padding;
 758                         u32 auxiliary_data_available;
 759                 } legacy_stream_info;
 760                 struct {
 761                         /* bitmap of grouped OutStreams */
 762                         u32 outstream_group_map;
 763                         /* bitmap of grouped InStreams */
 764                         u32 instream_group_map;
 765                 } group_info;
 766                 struct {
 767                         /* pointer to the buffer */
 768                         u8 *p_buffer;
 769                         /* pointer to the hostbuffer status */
 770                         struct hpi_hostbuffer_status *p_status;
 771                 } hostbuffer_info;
 772         } u;
 773 };
 774
 775 struct hpi_mixer_msg {
 776         u16 control_index;
 777         u16 control_type;       /* = HPI_CONTROL_METER _VOLUME etc */
 778         u16 padding1;           /* Maintain alignment of subsequent fields */
 779         u16 node_type1;         /* = HPI_SOURCENODE_LINEIN etc */
 780         u16 node_index1;        /* = 0..N */
 781         u16 node_type2;
 782         u16 node_index2;
 783         u16 padding2;           /* round to 4 bytes */
 784 };
 785
 786 struct hpi_mixer_res {
 787         u16 src_node_type;      /* = HPI_SOURCENODE_LINEIN etc */
 788         u16 src_node_index;     /* = 0..N */
 789         u16 dst_node_type;
 790         u16 dst_node_index;
 791         /* Also controlType for MixerGetControlByIndex */
 792         u16 control_index;
 793         /* may indicate which DSP the control is located on */
 794         u16 dsp_index;
 795 };
 796
 797 union hpi_mixerx_msg {
 798         struct {
 799                 u16 starting_index;
 800                 u16 flags;
 801                 u32 length_in_bytes;    /* length in bytes of p_data */
 802                 u32 p_data;     /* pointer to a data array */
 803         } gcabi;
 804         struct {
 805                 u16 command;
 806                 u16 index;
 807         } store;                /* for HPI_MIXER_STORE message */
 808 };
 809
 810 union hpi_mixerx_res {
 811         struct {
 812                 u32 bytes_returned;     /* size of items returned */
 813                 u32 p_data;     /* pointer to data array */
 814                 u16 more_to_do; /* indicates if there is more to do */
 815         } gcabi;
 816 };
 817
 818 struct hpi_control_msg {
 819         u16 attribute;          /* control attribute or property */
 820         u16 saved_index;
 821         u32 param1;             /* generic parameter 1 */
 822         u32 param2;             /* generic parameter 2 */
 823         short an_log_value[HPI_MAX_CHANNELS];
 824 };
 825
 826 struct hpi_control_union_msg {
 827         u16 attribute;          /* control attribute or property */
 828         u16 saved_index;        /* only used in ctrl save/restore */
 829         union {
 830                 struct {
 831                         u32 param1;     /* generic parameter 1 */
 832                         u32 param2;     /* generic parameter 2 */
 833                         short an_log_value[HPI_MAX_CHANNELS];
 834                 } old;
 835                 union {
 836                         u32 frequency;
 837                         u32 gain;
 838                         u32 band;
 839                         u32 deemphasis;
 840                         u32 program;
 841                         struct {
 842                                 u32 mode;
 843                                 u32 value;
 844                         } mode;
 845                         u32 blend;
 846                 } tuner;
 847         } u;
 848 };
 849
 850 struct hpi_control_res {
 851         /* Could make union. dwParam, anLogValue never used in same response */
 852         u32 param1;
 853         u32 param2;
 854         short an_log_value[HPI_MAX_CHANNELS];
 855 };
 856
 857 union hpi_control_union_res {
 858         struct {
 859                 u32 param1;
 860                 u32 param2;
 861                 short an_log_value[HPI_MAX_CHANNELS];
 862         } old;
 863         union {
 864                 u32 band;
 865                 u32 frequency;
 866                 u32 gain;
 867                 u32 deemphasis;
 868                 struct {
 869                         u32 data[2];
 870                         u32 bLER;
 871                 } rds;
 872                 short s_level;
 873                 struct {
 874                         u16 value;
 875                         u16 mask;
 876                 } status;
 877         } tuner;
 878         struct {
 879                 char sz_data[8];
 880                 u32 remaining_chars;
 881         } chars8;
 882         char c_data12[12];
 883 };
 884
 885 /* HPI_CONTROLX_STRUCTURES */
 886
 887 /* Message */
 888
 889 /** Used for all HMI variables where max length <= 8 bytes
 890 */
 891 struct hpi_controlx_msg_cobranet_data {
 892         u32 hmi_address;
 893         u32 byte_count;
 894         u32 data[2];
 895 };
 896
 897 /** Used for string data, and for packet bridge
 898 */
 899 struct hpi_controlx_msg_cobranet_bigdata {
 900         u32 hmi_address;
 901         u32 byte_count;
 902         u8 *pb_data;
 903 #ifndef HPI64BIT
 904         u32 padding;
 905 #endif
 906 };
 907
 908 /** Used for PADS control reading of string fields.
 909 */
 910 struct hpi_controlx_msg_pad_data {
 911         u32 field;
 912         u32 byte_count;
 913         u8 *pb_data;
 914 #ifndef HPI64BIT
 915         u32 padding;
 916 #endif
 917 };
 918
 919 /** Used for generic data
 920 */
 921
 922 struct hpi_controlx_msg_generic {
 923         u32 param1;
 924         u32 param2;
 925 };
 926
 927 struct hpi_controlx_msg {
 928         u16 attribute;          /* control attribute or property */
 929         u16 saved_index;
 930         union {
 931                 struct hpi_controlx_msg_cobranet_data cobranet_data;
 932                 struct hpi_controlx_msg_cobranet_bigdata cobranet_bigdata;
 933                 struct hpi_controlx_msg_generic generic;
 934                 struct hpi_controlx_msg_pad_data pad_data;
 935                 /*struct param_value universal_value; */
 936                 /* nothing extra to send for status read */
 937         } u;
 938 };
 939
 940 /* Response */
 941 /**
 942 */
 943 struct hpi_controlx_res_cobranet_data {
 944         u32 byte_count;
 945         u32 data[2];
 946 };
 947
 948 struct hpi_controlx_res_cobranet_bigdata {
 949         u32 byte_count;
 950 };
 951
 952 struct hpi_controlx_res_cobranet_status {
 953         u32 status;
 954         u32 readable_size;
 955         u32 writeable_size;
 956 };
 957
 958 struct hpi_controlx_res_generic {
 959         u32 param1;
 960         u32 param2;
 961 };
 962
 963 struct hpi_controlx_res {
 964         union {
 965                 struct hpi_controlx_res_cobranet_bigdata cobranet_bigdata;
 966                 struct hpi_controlx_res_cobranet_data cobranet_data;
 967                 struct hpi_controlx_res_cobranet_status cobranet_status;
 968                 struct hpi_controlx_res_generic generic;
 969                 /*struct param_info universal_info; */
 970                 /*struct param_value universal_value; */
 971         } u;
 972 };
 973
 974 struct hpi_nvmemory_msg {
 975         u16 address;
 976         u16 data;
 977 };
 978
 979 struct hpi_nvmemory_res {
 980         u16 size_in_bytes;
 981         u16 data;
 982 };
 983
 984 struct hpi_gpio_msg {
 985         u16 bit_index;
 986         u16 bit_data;
 987 };
 988
 989 struct hpi_gpio_res {
 990         u16 number_input_bits;
 991         u16 number_output_bits;
 992         u16 bit_data[4];
 993 };
 994
 995 struct hpi_async_msg {
 996         u32 events;
 997         u16 maximum_events;
 998         u16 padding;
 999 };
1000
1001 struct hpi_async_res {
1002         union {
1003                 struct {
1004                         u16 count;
1005                 } count;
1006                 struct {
1007                         u32 events;
1008                         u16 number_returned;
1009                         u16 padding;
1010                 } get;
1011                 struct hpi_async_event event;
1012         } u;
1013 };
1014
1015 struct hpi_watchdog_msg {
1016         u32 time_ms;
1017 };
1018
1019 struct hpi_watchdog_res {
1020         u32 time_ms;
1021 };
1022
1023 struct hpi_clock_msg {
1024         u16 hours;
1025         u16 minutes;
1026         u16 seconds;
1027         u16 milli_seconds;
1028 };
1029
1030 struct hpi_clock_res {
1031         u16 size_in_bytes;
1032         u16 hours;
1033         u16 minutes;
1034         u16 seconds;
1035         u16 milli_seconds;
1036         u16 padding;
1037 };
1038
1039 struct hpi_profile_msg {
1040         u16 bin_index;
1041         u16 padding;
1042 };
1043
1044 struct hpi_profile_res_open {
1045         u16 max_profiles;
1046 };
1047
1048 struct hpi_profile_res_time {
1049         u32 total_tick_count;
1050         u32 call_count;
1051         u32 max_tick_count;
1052         u32 ticks_per_millisecond;
1053         u16 profile_interval;
1054 };
1055
1056 struct hpi_profile_res_name {
1057         u8 sz_name[32];
1058 };
1059
1060 struct hpi_profile_res {
1061         union {
1062                 struct hpi_profile_res_open o;
1063                 struct hpi_profile_res_time t;
1064                 struct hpi_profile_res_name n;
1065         } u;
1066 };
1067
1068 struct hpi_message_header {
1069         u16 size;               /* total size in bytes */
1070         u8 type;                /* HPI_TYPE_MESSAGE  */
1071         u8 version;             /* message version */
1072         u16 object;             /* HPI_OBJ_* */
1073         u16 function;           /* HPI_SUBSYS_xxx, HPI_ADAPTER_xxx */
1074         u16 adapter_index;      /* the adapter index */
1075         u16 obj_index;          /* */
1076 };
1077
1078 struct hpi_message {
1079         /* following fields must match HPI_MESSAGE_HEADER */
1080         u16 size;               /* total size in bytes */
1081         u8 type;                /* HPI_TYPE_MESSAGE  */
1082         u8 version;             /* message version */
1083         u16 object;             /* HPI_OBJ_* */
1084         u16 function;           /* HPI_SUBSYS_xxx, HPI_ADAPTER_xxx */
1085         u16 adapter_index;      /* the adapter index */
1086         u16 obj_index;          /*  */
1087         union {
1088                 struct hpi_subsys_msg s;
1089                 union hpi_adapterx_msg ax;
1090                 struct hpi_stream_msg d;
1091                 struct hpi_mixer_msg m;
1092                 union hpi_mixerx_msg mx;        /* extended mixer; */
1093                 struct hpi_control_msg c;       /* mixer control; */
1094                 /* identical to struct hpi_control_msg,
1095                    but field naming is improved */
1096                 struct hpi_control_union_msg cu;
1097                 struct hpi_controlx_msg cx;     /* extended mixer control; */
1098                 struct hpi_nvmemory_msg n;
1099                 struct hpi_gpio_msg l;  /* digital i/o */
1100                 struct hpi_watchdog_msg w;
1101                 struct hpi_clock_msg t; /* dsp time */
1102                 struct hpi_profile_msg p;
1103                 struct hpi_async_msg as;
1104                 char fixed_size[32];
1105         } u;
1106 };
1107
1108 #define HPI_MESSAGE_SIZE_BY_OBJECT { \
1109         sizeof(struct hpi_message_header) ,   /* Default, no object type 0 */ \
1110         sizeof(struct hpi_message_header) + sizeof(struct hpi_subsys_msg),\
1111         sizeof(struct hpi_message_header) + sizeof(union hpi_adapterx_msg),\
1112         sizeof(struct hpi_message_header) + sizeof(struct hpi_stream_msg),\
1113         sizeof(struct hpi_message_header) + sizeof(struct hpi_stream_msg),\
1114         sizeof(struct hpi_message_header) + sizeof(struct hpi_mixer_msg),\
1115         sizeof(struct hpi_message_header) ,   /* no node message */ \
1116         sizeof(struct hpi_message_header) + sizeof(struct hpi_control_msg),\
1117         sizeof(struct hpi_message_header) + sizeof(struct hpi_nvmemory_msg),\
1118         sizeof(struct hpi_message_header) + sizeof(struct hpi_gpio_msg),\
1119         sizeof(struct hpi_message_header) + sizeof(struct hpi_watchdog_msg),\
1120         sizeof(struct hpi_message_header) + sizeof(struct hpi_clock_msg),\
1121         sizeof(struct hpi_message_header) + sizeof(struct hpi_profile_msg),\
1122         sizeof(struct hpi_message_header) + sizeof(struct hpi_controlx_msg),\
1123         sizeof(struct hpi_message_header) + sizeof(struct hpi_async_msg) \
1124 }
1125
1126 /*
1127 Note that the wSpecificError error field should be inspected and potentially
1128 reported whenever HPI_ERROR_DSP_COMMUNICATION or HPI_ERROR_DSP_BOOTLOAD is
1129 returned in wError.
1130 */
1131 struct hpi_response_header {
1132         u16 size;
1133         u8 type;                /* HPI_TYPE_RESPONSE  */
1134         u8 version;             /* response version */
1135         u16 object;             /* HPI_OBJ_* */
1136         u16 function;           /* HPI_SUBSYS_xxx, HPI_ADAPTER_xxx */
1137         u16 error;              /* HPI_ERROR_xxx */
1138         u16 specific_error;     /* adapter specific error */
1139 };
1140
1141 struct hpi_response {
1142 /* following fields must match HPI_RESPONSE_HEADER */
1143         u16 size;
1144         u8 type;                /* HPI_TYPE_RESPONSE  */
1145         u8 version;             /* response version */
1146         u16 object;             /* HPI_OBJ_* */
1147         u16 function;           /* HPI_SUBSYS_xxx, HPI_ADAPTER_xxx */
1148         u16 error;              /* HPI_ERROR_xxx */
1149         u16 specific_error;     /* adapter specific error */
1150         union {
1151                 struct hpi_subsys_res s;
1152                 union hpi_adapterx_res ax;
1153                 struct hpi_stream_res d;
1154                 struct hpi_mixer_res m;
1155                 union hpi_mixerx_res mx;        /* extended mixer; */
1156                 struct hpi_control_res c;       /* mixer control; */
1157                 /* identical to hpi_control_res, but field naming is improved */
1158                 union hpi_control_union_res cu;
1159                 struct hpi_controlx_res cx;     /* extended mixer control; */
1160                 struct hpi_nvmemory_res n;
1161                 struct hpi_gpio_res l;  /* digital i/o */
1162                 struct hpi_watchdog_res w;
1163                 struct hpi_clock_res t; /* dsp time */
1164                 struct hpi_profile_res p;
1165                 struct hpi_async_res as;
1166                 u8 bytes[52];
1167         } u;
1168 };
1169
1170 #define HPI_RESPONSE_SIZE_BY_OBJECT { \
1171         sizeof(struct hpi_response_header) ,/* Default, no object type 0 */ \
1172         sizeof(struct hpi_response_header) + sizeof(struct hpi_subsys_res),\
1173         sizeof(struct hpi_response_header) + sizeof(union  hpi_adapterx_res),\
1174         sizeof(struct hpi_response_header) + sizeof(struct hpi_stream_res),\
1175         sizeof(struct hpi_response_header) + sizeof(struct hpi_stream_res),\
1176         sizeof(struct hpi_response_header) + sizeof(struct hpi_mixer_res),\
1177         sizeof(struct hpi_response_header) , /* no node response */ \
1178         sizeof(struct hpi_response_header) + sizeof(struct hpi_control_res),\
1179         sizeof(struct hpi_response_header) + sizeof(struct hpi_nvmemory_res),\
1180         sizeof(struct hpi_response_header) + sizeof(struct hpi_gpio_res),\
1181         sizeof(struct hpi_response_header) + sizeof(struct hpi_watchdog_res),\
1182         sizeof(struct hpi_response_header) + sizeof(struct hpi_clock_res),\
1183         sizeof(struct hpi_response_header) + sizeof(struct hpi_profile_res),\
1184         sizeof(struct hpi_response_header) + sizeof(struct hpi_controlx_res),\
1185         sizeof(struct hpi_response_header) + sizeof(struct hpi_async_res) \
1186 }
1187
1188 /*********************** version 1 message/response **************************/
1189 #define HPINET_ETHERNET_DATA_SIZE (1500)
1190 #define HPINET_IP_HDR_SIZE (20)
1191 #define HPINET_IP_DATA_SIZE (HPINET_ETHERNET_DATA_SIZE - HPINET_IP_HDR_SIZE)
1192 #define HPINET_UDP_HDR_SIZE (8)
1193 #define HPINET_UDP_DATA_SIZE (HPINET_IP_DATA_SIZE - HPINET_UDP_HDR_SIZE)
1194 #define HPINET_ASI_HDR_SIZE (2)
1195 #define HPINET_ASI_DATA_SIZE (HPINET_UDP_DATA_SIZE - HPINET_ASI_HDR_SIZE)
1196
1197 #define HPI_MAX_PAYLOAD_SIZE (HPINET_ASI_DATA_SIZE - 2)
1198
1199 /* New style message/response, but still V0 compatible */
1200 struct hpi_msg_adapter_get_info {
1201         struct hpi_message_header h;
1202 };
1203
1204 struct hpi_res_adapter_get_info {
1205         struct hpi_response_header h;   /*v0 */
1206         struct hpi_adapter_res p;
1207 };
1208
1209 /* padding is so these are same size as v0 hpi_message */
1210 struct hpi_msg_adapter_query_flash {
1211         struct hpi_message_header h;
1212         u32 offset;
1213         u8 pad_to_version0_size[sizeof(struct hpi_message) -    /* V0 res */
1214                 sizeof(struct hpi_message_header) - 1 * sizeof(u32)];
1215 };
1216
1217 /* padding is so these are same size as v0 hpi_response */
1218 struct hpi_res_adapter_query_flash {
1219         struct hpi_response_header h;
1220         u32 checksum;
1221         u32 length;
1222         u32 version;
1223         u8 pad_to_version0_size[sizeof(struct hpi_response) -   /* V0 res */
1224                 sizeof(struct hpi_response_header) - 3 * sizeof(u32)];
1225 };
1226
1227 struct hpi_msg_adapter_start_flash {
1228         struct hpi_message_header h;
1229         u32 offset;
1230         u32 length;
1231         u32 key;
1232         u8 pad_to_version0_size[sizeof(struct hpi_message) -    /* V0 res */
1233                 sizeof(struct hpi_message_header) - 3 * sizeof(u32)];
1234 };
1235
1236 struct hpi_res_adapter_start_flash {
1237         struct hpi_response_header h;
1238         u8 pad_to_version0_size[sizeof(struct hpi_response) -   /* V0 res */
1239                 sizeof(struct hpi_response_header)];
1240 };
1241
1242 struct hpi_msg_adapter_program_flash_payload {
1243         u32 checksum;
1244         u16 sequence;
1245         u16 length;
1246         u16 offset; /**< offset from start of msg to data */
1247         u16 unused;
1248         /* ensure sizeof(header + payload) == sizeof(hpi_message_V0)
1249            because old firmware expects data after message of this size */
1250         u8 pad_to_version0_size[sizeof(struct hpi_message) -    /* V0 message */
1251                 sizeof(struct hpi_message_header) - sizeof(u32) -
1252                 4 * sizeof(u16)];
1253 };
1254
1255 struct hpi_msg_adapter_program_flash {
1256         struct hpi_message_header h;
1257         struct hpi_msg_adapter_program_flash_payload p;
1258         u32 data[256];
1259 };
1260
1261 struct hpi_res_adapter_program_flash {
1262         struct hpi_response_header h;
1263         u16 sequence;
1264         u8 pad_to_version0_size[sizeof(struct hpi_response) -   /* V0 res */
1265                 sizeof(struct hpi_response_header) - sizeof(u16)];
1266 };
1267
1268 struct hpi_msg_adapter_debug_read {
1269         struct hpi_message_header h;
1270         u32 dsp_address;
1271         u32 count_bytes;
1272 };
1273
1274 struct hpi_res_adapter_debug_read {
1275         struct hpi_response_header h;
1276         u8 bytes[256];
1277 };
1278
1279 #if 1
1280 #define hpi_message_header_v1 hpi_message_header
1281 #define hpi_response_header_v1 hpi_response_header
1282 #else
1283 /* V1 headers in Addition to v0 headers */
1284 struct hpi_message_header_v1 {
1285         struct hpi_message_header h0;
1286 /* struct {
1287 } h1; */
1288 };
1289
1290 struct hpi_response_header_v1 {
1291         struct hpi_response_header h0;
1292         struct {
1293                 u16 adapter_index;      /* the adapter index */
1294                 u16 obj_index;  /* object index */
1295         } h1;
1296 };
1297 #endif
1298
1299 struct hpi_msg_payload_v0 {
1300         struct hpi_message_header h;
1301         union {
1302                 struct hpi_subsys_msg s;
1303                 union hpi_adapterx_msg ax;
1304                 struct hpi_stream_msg d;
1305                 struct hpi_mixer_msg m;
1306                 union hpi_mixerx_msg mx;
1307                 struct hpi_control_msg c;
1308                 struct hpi_control_union_msg cu;
1309                 struct hpi_controlx_msg cx;
1310                 struct hpi_nvmemory_msg n;
1311                 struct hpi_gpio_msg l;
1312                 struct hpi_watchdog_msg w;
1313                 struct hpi_clock_msg t;
1314                 struct hpi_profile_msg p;
1315                 struct hpi_async_msg as;
1316         } u;
1317 };
1318
1319 struct hpi_res_payload_v0 {
1320         struct hpi_response_header h;
1321         union {
1322                 struct hpi_subsys_res s;
1323                 union hpi_adapterx_res ax;
1324                 struct hpi_stream_res d;
1325                 struct hpi_mixer_res m;
1326                 union hpi_mixerx_res mx;
1327                 struct hpi_control_res c;
1328                 union hpi_control_union_res cu;
1329                 struct hpi_controlx_res cx;
1330                 struct hpi_nvmemory_res n;
1331                 struct hpi_gpio_res l;
1332                 struct hpi_watchdog_res w;
1333                 struct hpi_clock_res t;
1334                 struct hpi_profile_res p;
1335                 struct hpi_async_res as;
1336         } u;
1337 };
1338
1339 union hpi_message_buffer_v1 {
1340         struct hpi_message m0;  /* version 0 */
1341         struct hpi_message_header_v1 h;
1342         u8 buf[HPI_MAX_PAYLOAD_SIZE];
1343 };
1344
1345 union hpi_response_buffer_v1 {
1346         struct hpi_response r0; /* version 0 */
1347         struct hpi_response_header_v1 h;
1348         u8 buf[HPI_MAX_PAYLOAD_SIZE];
1349 };
1350
1351 compile_time_assert((sizeof(union hpi_message_buffer_v1) <=
1352                 HPI_MAX_PAYLOAD_SIZE), message_buffer_ok);
1353 compile_time_assert((sizeof(union hpi_response_buffer_v1) <=
1354                 HPI_MAX_PAYLOAD_SIZE), response_buffer_ok);
1355
1356 /*////////////////////////////////////////////////////////////////////////// */
1357 /* declarations for compact control calls  */
1358 struct hpi_control_defn {
1359         u8 type;
1360         u8 channels;
1361         u8 src_node_type;
1362         u8 src_node_index;
1363         u8 dest_node_type;
1364         u8 dest_node_index;
1365 };
1366
1367 /*////////////////////////////////////////////////////////////////////////// */
1368 /* declarations for control caching (internal to HPI<->DSP interaction)      */
1369
1370 /** indicates a cached u16 value is invalid. */
1371 #define HPI_CACHE_INVALID_UINT16 0xFFFF
1372 /** indicates a cached short value is invalid. */
1373 #define HPI_CACHE_INVALID_SHORT -32768
1374
1375 /** A compact representation of (part of) a controls state.
1376 Used for efficient transfer of the control state
1377 between DSP and host or across a network
1378 */
1379 struct hpi_control_cache_info {
1380         /** one of HPI_CONTROL_* */
1381         u8 control_type;
1382         /** The total size of cached information in 32-bit words. */
1383         u8 size_in32bit_words;
1384         /** The original index of the control on the DSP */
1385         u16 control_index;
1386 };
1387
1388 struct hpi_control_cache_vol {
1389         struct hpi_control_cache_info i;
1390         short an_log[2];
1391         char temp_padding[4];
1392 };
1393
1394 struct hpi_control_cache_meter {
1395         struct hpi_control_cache_info i;
1396         short an_log_peak[2];
1397         short an_logRMS[2];
1398 };
1399
1400 struct hpi_control_cache_channelmode {
1401         struct hpi_control_cache_info i;
1402         u16 mode;
1403         char temp_padding[6];
1404 };
1405
1406 struct hpi_control_cache_mux {
1407         struct hpi_control_cache_info i;
1408         u16 source_node_type;
1409         u16 source_node_index;
1410         char temp_padding[4];
1411 };
1412
1413 struct hpi_control_cache_level {
1414         struct hpi_control_cache_info i;
1415         short an_log[2];
1416         char temp_padding[4];
1417 };
1418
1419 struct hpi_control_cache_tuner {
1420         struct hpi_control_cache_info i;
1421         u32 freq_ink_hz;
1422         u16 band;
1423         short s_level_avg;
1424 };
1425
1426 struct hpi_control_cache_aes3rx {
1427         struct hpi_control_cache_info i;
1428         u32 error_status;
1429         u32 format;
1430 };
1431
1432 struct hpi_control_cache_aes3tx {
1433         struct hpi_control_cache_info i;
1434         u32 format;
1435         char temp_padding[4];
1436 };
1437
1438 struct hpi_control_cache_tonedetector {
1439         struct hpi_control_cache_info i;
1440         u16 state;
1441         char temp_padding[6];
1442 };
1443
1444 struct hpi_control_cache_silencedetector {
1445         struct hpi_control_cache_info i;
1446         u32 state;
1447         char temp_padding[4];
1448 };
1449
1450 struct hpi_control_cache_sampleclock {
1451         struct hpi_control_cache_info i;
1452         u16 source;
1453         u16 source_index;
1454         u32 sample_rate;
1455 };
1456
1457 struct hpi_control_cache_microphone {
1458         struct hpi_control_cache_info i;
1459         u16 phantom_state;
1460         char temp_padding[6];
1461 };
1462
1463 struct hpi_control_cache_generic {
1464         struct hpi_control_cache_info i;
1465         u32 dw1;
1466         u32 dw2;
1467 };
1468
1469 struct hpi_control_cache_single {
1470         union {
1471                 struct hpi_control_cache_info i;
1472                 struct hpi_control_cache_vol vol;
1473                 struct hpi_control_cache_meter meter;
1474                 struct hpi_control_cache_channelmode mode;
1475                 struct hpi_control_cache_mux mux;
1476                 struct hpi_control_cache_level level;
1477                 struct hpi_control_cache_tuner tuner;
1478                 struct hpi_control_cache_aes3rx aes3rx;
1479                 struct hpi_control_cache_aes3tx aes3tx;
1480                 struct hpi_control_cache_tonedetector tone;
1481                 struct hpi_control_cache_silencedetector silence;
1482                 struct hpi_control_cache_sampleclock clk;
1483                 struct hpi_control_cache_microphone microphone;
1484                 struct hpi_control_cache_generic generic;
1485         } u;
1486 };
1487
1488 struct hpi_control_cache_pad {
1489         struct hpi_control_cache_info i;
1490         u32 field_valid_flags;
1491         u8 c_channel[8];
1492         u8 c_artist[40];
1493         u8 c_title[40];
1494         u8 c_comment[200];
1495         u32 pTY;
1496         u32 pI;
1497         u32 traffic_supported;
1498         u32 traffic_anouncement;
1499 };
1500
1501 /* 2^N sized FIFO buffer (internal to HPI<->DSP interaction) */
1502 struct hpi_fifo_buffer {
1503         u32 size;
1504         u32 dSP_index;
1505         u32 host_index;
1506 };
1507
1508 #ifndef DISABLE_PRAGMA_PACK1
1509 #pragma pack(pop)
1510 #endif
1511
1512 /* skip host side function declarations for DSP
1513    compile and documentation extraction */
1514
1515 char hpi_handle_object(const u32 handle);
1516
1517 void hpi_handle_to_indexes(const u32 handle, u16 *pw_adapter_index,
1518         u16 *pw_object_index);
1519
1520 u32 hpi_indexes_to_handle(const char c_object, const u16 adapter_index,
1521         const u16 object_index);
1522
1523 /*////////////////////////////////////////////////////////////////////////// */
1524
1525 /* main HPI entry point */
1526 void hpi_send_recv(struct hpi_message *phm, struct hpi_response *phr);
1527
1528 /* UDP message */
1529 void hpi_send_recvUDP(struct hpi_message *phm, struct hpi_response *phr,
1530         const unsigned int timeout);
1531
1532 /* used in PnP OS/driver */
1533 u16 hpi_subsys_create_adapter(const struct hpi_resource *p_resource,
1534         u16 *pw_adapter_index);
1535
1536 u16 hpi_subsys_delete_adapter(u16 adapter_index);
1537
1538 u16 hpi_outstream_host_buffer_get_info(u32 h_outstream, u8 **pp_buffer,
1539         struct hpi_hostbuffer_status **pp_status);
1540
1541 u16 hpi_instream_host_buffer_get_info(u32 h_instream, u8 **pp_buffer,
1542         struct hpi_hostbuffer_status **pp_status);
1543
1544 u16 hpi_adapter_restart(u16 adapter_index);
1545
1546 /*
1547 The following 3 functions were last declared in header files for
1548 driver 3.10. HPI_ControlQuery() used to be the recommended way
1549 of getting a volume range. Declared here for binary asihpi32.dll
1550 compatibility.
1551 */
1552
1553 void hpi_format_to_msg(struct hpi_msg_format *pMF,
1554         const struct hpi_format *pF);
1555 void hpi_stream_response_to_legacy(struct hpi_stream_res *pSR);
1556
1557 /*////////////////////////////////////////////////////////////////////////// */
1558 /* declarations for individual HPI entry points */
1559 hpi_handler_func HPI_1000;
1560 hpi_handler_func HPI_6000;
1561 hpi_handler_func HPI_6205;
1562 hpi_handler_func HPI_COMMON;
1563
1564 #endif                          /* _HPI_INTERNAL_H_ */