HPI Error codes
[HPI constant definitions]

Almost all HPI functions return an error code A return value of zero means there was no error. More...

Defines

#define HPI_ERROR_INVALID_TYPE   100
 Message type does not exist.
#define HPI_ERROR_INVALID_OBJ   101
 Object type does not exist.
#define HPI_ERROR_INVALID_FUNC   102
 Function does not exist.
#define HPI_ERROR_INVALID_OBJ_INDEX   103
 The specified object (adapter/Stream) does not exist.
#define HPI_ERROR_OBJ_NOT_OPEN   104
 Trying to access an object that has not been opened yet.
#define HPI_ERROR_OBJ_ALREADY_OPEN   105
 Trying to open an already open object.
#define HPI_ERROR_INVALID_RESOURCE   106
 PCI, ISA resource not valid.
#define HPI_ERROR_SUBSYSFINDADAPTERS_GETINFO   107
 GetInfo call from SubSysFindAdapters failed.
#define HPI_ERROR_INVALID_RESPONSE   108
 Default response was never updated with actual error code.
#define HPI_ERROR_PROCESSING_MESSAGE   109
 wSize field of response was not updated, indicating that the message was not processed.
#define HPI_ERROR_NETWORK_TIMEOUT   110
 The network did not respond in a timely manner.
#define HPI_ERROR_INVALID_HANDLE   111
 An HPI handle is invalid (uninitialised?).
#define HPI_ERROR_UNIMPLEMENTED   112
 A function or attribute has not been implemented yet.
#define HPI_ERROR_NETWORK_TOO_MANY_CLIENTS   113
 There are too many clients attempting to access a network resource.
#define HPI_ERROR_TOO_MANY_ADAPTERS   200
 Too many adapters.
#define HPI_ERROR_BAD_ADAPTER   201
 Bad adpater.
#define HPI_ERROR_BAD_ADAPTER_NUMBER   202
 Adapter number out of range or not set properly.
#define HPI_DUPLICATE_ADAPTER_NUMBER   203
 2 adapters with the same adapter number.
#define HPI_ERROR_DSP_BOOTLOAD   204
 DSP code failed to bootload.
#define HPI_ERROR_DSP_SELFTEST   205
 Adapter failed DSP code self test.
#define HPI_ERROR_DSP_FILE_NOT_FOUND   206
 Couldn't find or open the DSP code file.
#define HPI_ERROR_DSP_HARDWARE   207
 Internal DSP hardware error.
#define HPI_ERROR_DOS_MEMORY_ALLOC   208
 Could not allocate memory in DOS.
#define HPI_ERROR_MEMORY_ALLOC   208
 Could not allocate memory.
#define HPI_ERROR_PLD_LOAD   209
 Failed to correctly load/config PLD .
#define HPI_ERROR_DSP_FILE_FORMAT   210
 Unexpected end of file, block length too big etc.
#define HPI_ERROR_DSP_FILE_ACCESS_DENIED   211
 Found but could not open DSP code file.
#define HPI_ERROR_DSP_FILE_NO_HEADER   212
 First DSP code section header not found in DSP file.
#define HPI_ERROR_DSP_FILE_READ_ERROR   213
 File read operation on DSP code file failed.
#define HPI_ERROR_DSP_SECTION_NOT_FOUND   214
 DSP code for adapter family not found.
#define HPI_ERROR_DSP_FILE_OTHER_ERROR   215
 Other OS specific error opening DSP file.
#define HPI_ERROR_DSP_FILE_SHARING_VIOLATION   216
 Sharing violation opening DSP code file.
#define HPI_ERROR_DSP_FILE_NULL_HEADER   217
 DSP code section header had size == 0.
#define HPI_ERROR_FLASH   220
 Base number for flash errors.
#define HPI_ERROR_BAD_CHECKSUM   (HPI_ERROR_FLASH+1)
 Flash has bad checksum.
#define HPI_ERROR_RESERVED_1   290
 Reserved for OEMs.
#define HPI_ERROR_INVALID_STREAM   300
 Stream does not exist.
#define HPI_ERROR_INVALID_FORMAT   301
 Invalid compression format.
#define HPI_ERROR_INVALID_SAMPLERATE   302
 Invalid format samplerate.
#define HPI_ERROR_INVALID_CHANNELS   303
 Invalid format number of channels.
#define HPI_ERROR_INVALID_BITRATE   304
 Invalid format bitrate.
#define HPI_ERROR_INVALID_DATASIZE   305
 Invalid datasize used for stream read/write.
#define HPI_ERROR_BUFFER_FULL   306
 Stream buffer is full during stream write.
#define HPI_ERROR_BUFFER_EMPTY   307
 Stream buffer is empty during stream read.
#define HPI_ERROR_INVALID_DATA_TRANSFER   308
 Invalid datasize used for stream read/write.
#define HPI_ERROR_INVALID_OPERATION   310
 Object can't do requested operation in its current state, e.g.
#define HPI_ERROR_INCOMPATIBLE_SAMPLERATE   311
 Where an SRG is shared amongst streams, an incompatible samplerate is one that is different to any currently playing or recording stream.
#define HPI_ERROR_BAD_ADAPTER_MODE   312
 Adapter mode is illegal.
#define HPI_ERROR_TOO_MANY_CAPABILITY_CHANGE_ATTEMPTS   313
 There have been too many attempts to set the adapter's capabilities (using bad keys).
#define HPI_ERROR_NO_INTERADAPTER_GROUPS   314
 Streams on different adapters cannot be grouped.
#define HPI_ERROR_NO_INTERDSP_GROUPS   315
 Streams on different DSPs cannot be grouped.
#define HPI_ERROR_INVALID_NODE   400
 Invalid mixer node for this adapter.
#define HPI_ERROR_INVALID_CONTROL   401
 Invalid control.
#define HPI_ERROR_INVALID_CONTROL_VALUE   402
 Invalid control value was passed.
#define HPI_ERROR_INVALID_CONTROL_ATTRIBUTE   403
 Control attribute not supported by this control.
#define HPI_ERROR_CONTROL_DISABLED   404
 Control is disabled.
#define HPI_ERROR_CONTROL_I2C_MISSING_ACK   405
 I2C transaction failed due to a missing ACK.
#define HPI_ERROR_UNSUPPORTED_CONTROL_ATTRIBUTE   406
 Control attribute is valid, but not supported by this hardware.
#define HPI_ERROR_CONTROL_NOT_READY   407
 Control is busy, or coming out of reset and cannot be accessed at this time.
#define HPI_ERROR_NVMEM_BUSY   450
 Non volatile memory.
#define HPI_ERROR_I2C_MISSING_ACK   HPI_ERROR_CONTROL_I2C_MISSING_ACK
 I2C.
#define HPI_ERROR_CUSTOM   600
 custom error to use for debugging
#define HPI_ERROR_MUTEX_TIMEOUT   700
 hpioct32.c can't obtain mutex
#define HPI_ERROR_BACKEND_BASE   900
 errors from HPI backends have values >= this
#define HPI_ERROR_ILLEGAL_CACHE_VALUE   0xffff
 indicates a cached HW16 value is invalid.

Detailed Description

Almost all HPI functions return an error code A return value of zero means there was no error.

Otherwise one of these error codes is returned. Error codes can be converted to a descriptive string using HPI_GetErrorText()

Note:
When a new error code is added HPI_GetErrorText() MUST be updated.

codes 1-100 are reserved for driver use

Define Documentation

#define HPI_ERROR_INVALID_TYPE   100
 

Message type does not exist.

#define HPI_ERROR_INVALID_OBJ   101
 

Object type does not exist.

#define HPI_ERROR_INVALID_FUNC   102
 

Function does not exist.

#define HPI_ERROR_INVALID_OBJ_INDEX   103
 

The specified object (adapter/Stream) does not exist.

#define HPI_ERROR_OBJ_NOT_OPEN   104
 

Trying to access an object that has not been opened yet.

#define HPI_ERROR_OBJ_ALREADY_OPEN   105
 

Trying to open an already open object.

#define HPI_ERROR_INVALID_RESOURCE   106
 

PCI, ISA resource not valid.

#define HPI_ERROR_SUBSYSFINDADAPTERS_GETINFO   107
 

GetInfo call from SubSysFindAdapters failed.

#define HPI_ERROR_INVALID_RESPONSE   108
 

Default response was never updated with actual error code.

#define HPI_ERROR_PROCESSING_MESSAGE   109
 

wSize field of response was not updated, indicating that the message was not processed.

#define HPI_ERROR_NETWORK_TIMEOUT   110
 

The network did not respond in a timely manner.

#define HPI_ERROR_INVALID_HANDLE   111
 

An HPI handle is invalid (uninitialised?).

#define HPI_ERROR_UNIMPLEMENTED   112
 

A function or attribute has not been implemented yet.

#define HPI_ERROR_NETWORK_TOO_MANY_CLIENTS   113
 

There are too many clients attempting to access a network resource.

#define HPI_ERROR_TOO_MANY_ADAPTERS   200
 

Too many adapters.

#define HPI_ERROR_BAD_ADAPTER   201
 

Bad adpater.

#define HPI_ERROR_BAD_ADAPTER_NUMBER   202
 

Adapter number out of range or not set properly.

#define HPI_DUPLICATE_ADAPTER_NUMBER   203
 

2 adapters with the same adapter number.

#define HPI_ERROR_DSP_BOOTLOAD   204
 

DSP code failed to bootload.

#define HPI_ERROR_DSP_SELFTEST   205
 

Adapter failed DSP code self test.

#define HPI_ERROR_DSP_FILE_NOT_FOUND   206
 

Couldn't find or open the DSP code file.

#define HPI_ERROR_DSP_HARDWARE   207
 

Internal DSP hardware error.

#define HPI_ERROR_DOS_MEMORY_ALLOC   208
 

Could not allocate memory in DOS.

#define HPI_ERROR_MEMORY_ALLOC   208
 

Could not allocate memory.

#define HPI_ERROR_PLD_LOAD   209
 

Failed to correctly load/config PLD .

#define HPI_ERROR_DSP_FILE_FORMAT   210
 

Unexpected end of file, block length too big etc.

#define HPI_ERROR_DSP_FILE_ACCESS_DENIED   211
 

Found but could not open DSP code file.

#define HPI_ERROR_DSP_FILE_NO_HEADER   212
 

First DSP code section header not found in DSP file.

#define HPI_ERROR_DSP_FILE_READ_ERROR   213
 

File read operation on DSP code file failed.

#define HPI_ERROR_DSP_SECTION_NOT_FOUND   214
 

DSP code for adapter family not found.

#define HPI_ERROR_DSP_FILE_OTHER_ERROR   215
 

Other OS specific error opening DSP file.

#define HPI_ERROR_DSP_FILE_SHARING_VIOLATION   216
 

Sharing violation opening DSP code file.

#define HPI_ERROR_DSP_FILE_NULL_HEADER   217
 

DSP code section header had size == 0.

#define HPI_ERROR_FLASH   220
 

Base number for flash errors.

#define HPI_ERROR_BAD_CHECKSUM   (HPI_ERROR_FLASH+1)
 

Flash has bad checksum.

#define HPI_ERROR_RESERVED_1   290
 

Reserved for OEMs.

#define HPI_ERROR_INVALID_STREAM   300
 

Stream does not exist.

#define HPI_ERROR_INVALID_FORMAT   301
 

Invalid compression format.

#define HPI_ERROR_INVALID_SAMPLERATE   302
 

Invalid format samplerate.

#define HPI_ERROR_INVALID_CHANNELS   303
 

Invalid format number of channels.

#define HPI_ERROR_INVALID_BITRATE   304
 

Invalid format bitrate.

#define HPI_ERROR_INVALID_DATASIZE   305
 

Invalid datasize used for stream read/write.

#define HPI_ERROR_BUFFER_FULL   306
 

Stream buffer is full during stream write.

#define HPI_ERROR_BUFFER_EMPTY   307
 

Stream buffer is empty during stream read.

#define HPI_ERROR_INVALID_DATA_TRANSFER   308
 

Invalid datasize used for stream read/write.

#define HPI_ERROR_INVALID_OPERATION   310
 

Object can't do requested operation in its current state, e.g.

set format, change rec mux state while recording.

#define HPI_ERROR_INCOMPATIBLE_SAMPLERATE   311
 

Where an SRG is shared amongst streams, an incompatible samplerate is one that is different to any currently playing or recording stream.

#define HPI_ERROR_BAD_ADAPTER_MODE   312
 

Adapter mode is illegal.

#define HPI_ERROR_TOO_MANY_CAPABILITY_CHANGE_ATTEMPTS   313
 

There have been too many attempts to set the adapter's capabilities (using bad keys).

The card should be returned to ASI if further capabilities updates are required

#define HPI_ERROR_NO_INTERADAPTER_GROUPS   314
 

Streams on different adapters cannot be grouped.

#define HPI_ERROR_NO_INTERDSP_GROUPS   315
 

Streams on different DSPs cannot be grouped.

#define HPI_ERROR_INVALID_NODE   400
 

Invalid mixer node for this adapter.

#define HPI_ERROR_INVALID_CONTROL   401
 

Invalid control.

#define HPI_ERROR_INVALID_CONTROL_VALUE   402
 

Invalid control value was passed.

#define HPI_ERROR_INVALID_CONTROL_ATTRIBUTE   403
 

Control attribute not supported by this control.

#define HPI_ERROR_CONTROL_DISABLED   404
 

Control is disabled.

#define HPI_ERROR_CONTROL_I2C_MISSING_ACK   405
 

I2C transaction failed due to a missing ACK.

#define HPI_ERROR_UNSUPPORTED_CONTROL_ATTRIBUTE   406
 

Control attribute is valid, but not supported by this hardware.

#define HPI_ERROR_CONTROL_NOT_READY   407
 

Control is busy, or coming out of reset and cannot be accessed at this time.

#define HPI_ERROR_NVMEM_BUSY   450
 

Non volatile memory.

#define HPI_ERROR_I2C_MISSING_ACK   HPI_ERROR_CONTROL_I2C_MISSING_ACK
 

I2C.

#define HPI_ERROR_CUSTOM   600
 

custom error to use for debugging

#define HPI_ERROR_MUTEX_TIMEOUT   700
 

hpioct32.c can't obtain mutex

#define HPI_ERROR_BACKEND_BASE   900
 

errors from HPI backends have values >= this

#define HPI_ERROR_ILLEGAL_CACHE_VALUE   0xffff
 

indicates a cached HW16 value is invalid.

Generated on Tue Jun 15 10:08:53 2010 for AudioScience HPI by  doxygen 1.4.6-NO