Appendix A

CDI Service Errors

This appendix provides a summary of error codes returned by the CDI service.
The CDI service error codes are presented in two tables: Alphabetically by error code name, including a description. Numerically by hex number, decimal number, and error name.
All CDI service functions return either SUCCESS or an error code. If the return code is not SUCCESS (0), it is an error code indicating that the function has failed and the reason for the failure.
All CDI service error codes are CT Access codes, defined in the include file ctaerr.h. The error codes are prefixed with CTAERR_.
For a complete listing of CT Access error codes, refer to the CT Access Developer's Reference Manual.
All CDI service functions are synchronous. A SUCCESS return code indicates that the action has been executed at the board level (DSP).

The following table is an alphabetical listing of CDI service errors: Error Name Hex Decimal Description CTAERR_BAD_ARGUMENT 0x07 7 Problem: A function argument had an invalid value, or a required pointer argument was NULL. Solution: Check all arguments for valid types and ranges. CTAERR_BOARD_ERROR 0x03 3 An unexpected error occurred on the board. This function-dependent error is either due to board overheating or temperature sensor malfunction. CTAERR_FUNCTION_ACTIVE 0x0F 15 An attempt was made to start a function that is already started. CTAERR_FUNCTION_NOT_ACTIVE 0x0E 14 An attempt was made to stop a function that was not running. CTAERR_INVALID_CTAHD 0x05 5 An invalid CTA context handle was passed as an argument to a function, or the context was destroyed by another thread. CTAERR_INVALID_STATE 0x0C 12 This function is not valid in the current state. CTAERR_OUT_OF_RESOURCES 0x08 8 Problem: Unable to find free DTMF detector resource. Solution: Stop unused DTMF detector (if any) or retry later.

Error Name	Hex	Decimal	Description
CTAERR_BAD_ARGUMENT	0x07	7	Problem: A function argument had an invalid value, or a required pointer argument was NULL. Solution: Check all arguments for valid types and ranges.
CTAERR_BOARD_ERROR	0x03	3	An unexpected error occurred on the board. This function-dependent error is either due to board overheating or temperature sensor malfunction.
CTAERR_FUNCTION_ACTIVE	0x0F	15	An attempt was made to start a function that is already started.
CTAERR_FUNCTION_NOT_ACTIVE	0x0E	14	An attempt was made to stop a function that was not running.
CTAERR_INVALID_CTAHD	0x05	5	An invalid CTA context handle was passed as an argument to a function, or the context was destroyed by another thread.
CTAERR_INVALID_STATE	0x0C	12	This function is not valid in the current state.
CTAERR_OUT_OF_RESOURCES	0x08	8	Problem: Unable to find free DTMF detector resource. Solution: Stop unused DTMF detector (if any) or retry later.

The following table is a list of CDI service errors in numerical order: Hex Decimal Error Name 0x03 3 CTAERR_BOARD_ERROR 0x05 5 CTAERR_INVALID_CTAHD 0x07 7 CTAERR_BAD_ARGUMENT 0x08 8 CTAERR_OUT_OF_RESOURCES 0x0C 12 CTAERR_INVALID_STATE 0x0E 14 CTAERR_FUNCTION_NOT_ACTIVE 0x0F 15 CTAERR_FUNCTION_ACTIVE

Want to send us feedback on our documentation? Email: Tech_Pubs@nmss.com