Bumped Mbed FW version to 01.20.0080

Embed: (wiki syntax)

« Back to documentation index

admw_types.h File Reference

admw_types.h File Reference

: Type definitions for ADMW API. ----------------------------------------------------------------------------- More...

Go to the source code of this file.

Enumerations

enum  ADMW_RESULT {
  ADMW_SUCCESS, ADMW_FAILURE, ADMW_INCOMPLETE, ADMW_IN_USE,
  ADMW_INVALID_HANDLE, ADMW_INVALID_DEVICE_NUM, ADMW_ERR_NOT_INITIALIZED, ADMW_INVALID_POINTER,
  ADMW_INVALID_PARAM, ADMW_UNSUPPORTED_MODE, ADMW_INVALID_OPERATION, ADMW_NO_DATA,
  ADMW_NO_SPACE, ADMW_NEGATIVE_SQRT, ADMW_DIVIDE_BY_ZERO, ADMW_INVALID_SIGNATURE,
  ADMW_WRONG_SIZE, ADMW_OUT_OF_RANGE, ADMW_NAN_FOUND, ADMW_TIMEOUT,
  ADMW_NO_MEM, ADMW_CRC_ERROR
}

Detailed Description

: Type definitions for ADMW API. -----------------------------------------------------------------------------

Definition in file admw_types.h.


Enumeration Type Documentation

ADMW API Error Codes. ADMW_SUCCESS is always zero The return value of all ADMW APIs returning ADMW_RESULT should always be tested at the application level for success or failure.

Enumerator:
ADMW_SUCCESS 

Generic success.

ADMW_FAILURE 

Generic Failure.

ADMW_INCOMPLETE 

Operation incomplete, call again

ADMW_IN_USE 

Device is already initialized.

ADMW_INVALID_HANDLE 

Invalid device handle.

ADMW_INVALID_DEVICE_NUM 

Invalid device ID.

ADMW_ERR_NOT_INITIALIZED 

Device is uninitialized.

ADMW_INVALID_POINTER 

NULL data pointer not allowed.

ADMW_INVALID_PARAM 

Parameter is out of range.

ADMW_UNSUPPORTED_MODE 

Unsupported mode of operation.

ADMW_INVALID_OPERATION 

Invalid operation

ADMW_NO_DATA 

No data available, or buffer full

ADMW_NO_SPACE 

No buffer space available

ADMW_NEGATIVE_SQRT 

Square root of a negative number

ADMW_DIVIDE_BY_ZERO 

Division by 0 or 0.0

ADMW_INVALID_SIGNATURE 

Invalid signature

ADMW_WRONG_SIZE 

Wrong size

ADMW_OUT_OF_RANGE 

Sample Out of the dsp data limits

ADMW_NAN_FOUND 

Unable to operate with not a number

ADMW_TIMEOUT 

Timeout error

ADMW_NO_MEM 

Memory allocation error

ADMW_CRC_ERROR 

CRC validation error

Definition at line 57 of file admw_types.h.