Errors

Macros
#define	API_ERROR_OK   0
#define	API_ERROR_SPI_SDO   (-EINVAL)
#define	API_ERROR_INVALID_HANDLE_PTR   (-EINVAL)
#define	API_ERROR_INVALID_XFER_PTR   (-EINVAL)
#define	API_ERROR_INVALID_DELAYUS_PTR   (-EINVAL)
#define	API_ERROR_INVALID_PARAM   (-EINVAL)
#define	API_ERROR_NOT_SUPPORTED   (-ENOTSUP)
#define	API_ERROR_VCO_OUT_OF_RANGE   (-EINVAL)
#define	API_ERROR_FTW_LOAD_ACK   (-EFAULT)
#define	API_ERROR_NCO_NOT_ENABLED   (-ENODEV)
#define	API_ERROR_INIT_SEQ_FAIL   (-EFAULT)
#define	API_ERROR_TEST_FAILED   -(ENODEV)
#define	API_ERROR_SPI_XFER   -(ENODEV)
#define	API_ERROR_US_DELAY   -(ENODEV)
#define	API_ERROR_TX_EN_PIN_CTRL   -(ENODEV)
#define	API_ERROR_RESET_PIN_CTRL   -(ENODEV)
#define	API_ERROR_EVENT_HNDL   -(ENODEV)
#define	API_ERROR_HW_OPEN   -(ENODEV)
#define	API_ERROR_HW_CLOSE   -(ENODEV)
#define	API_ERROR_OK   0
#define	API_ERROR_SPI_SDO   (-EINVAL)
#define	API_ERROR_INVALID_HANDLE_PTR   (-EINVAL)
#define	API_ERROR_INVALID_XFER_PTR   (-EINVAL)
#define	API_ERROR_INVALID_DELAYUS_PTR   (-EINVAL)
#define	API_ERROR_INVALID_PARAM   (-EINVAL)
#define	API_ERROR_NOT_SUPPORTED   (-ENOTSUP)
#define	API_ERROR_VCO_OUT_OF_RANGE   (-EINVAL)
#define	API_ERROR_FTW_LOAD_ACK   (-EFAULT)
#define	API_ERROR_NCO_NOT_ENABLED   (-ENODEV)
#define	API_ERROR_INIT_SEQ_FAIL   (-EFAULT)
#define	API_ERROR_TEST_FAILED   -(ENODEV)
#define	API_ERROR_SPI_XFER   -(ENODEV)
#define	API_ERROR_US_DELAY   -(ENODEV)
#define	API_ERROR_TX_EN_PIN_CTRL   -(ENODEV)
#define	API_ERROR_RESET_PIN_CTRL   -(ENODEV)
#define	API_ERROR_EVENT_HNDL   -(ENODEV)
#define	API_ERROR_HW_OPEN   -(ENODEV)
#define	API_ERROR_HW_CLOSE   -(ENODEV)

Functions
char *	adi_api_get_error_string (int error_code)
	Return string representation of the error code.

Detailed Description

Macro Definition Documentation

API_ERROR_EVENT_HNDL [1/2]

#define API_ERROR_EVENT_HNDL   -(ENODEV)

Event handling error

API_ERROR_EVENT_HNDL [2/2]

#define API_ERROR_EVENT_HNDL   -(ENODEV)

Event handling error

API_ERROR_FTW_LOAD_ACK [1/2]

#define API_ERROR_FTW_LOAD_ACK   (-EFAULT)

FTW Acknowledge not received

API_ERROR_FTW_LOAD_ACK [2/2]

#define API_ERROR_FTW_LOAD_ACK   (-EFAULT)

FTW Acknowledge not received

API_ERROR_HW_CLOSE [1/2]

#define API_ERROR_HW_CLOSE   -(ENODEV)

HW Close function error

API_ERROR_HW_CLOSE [2/2]

#define API_ERROR_HW_CLOSE   -(ENODEV)

HW Close function error

API_ERROR_HW_OPEN [1/2]

#define API_ERROR_HW_OPEN   -(ENODEV)

HW Open function error

API_ERROR_HW_OPEN [2/2]

#define API_ERROR_HW_OPEN   -(ENODEV)

HW Open function error

API_ERROR_INIT_SEQ_FAIL [1/2]

#define API_ERROR_INIT_SEQ_FAIL   (-EFAULT)

Initialization sequence failed

API_ERROR_INIT_SEQ_FAIL [2/2]

#define API_ERROR_INIT_SEQ_FAIL   (-EFAULT)

Initialization sequence failed

API_ERROR_INVALID_DELAYUS_PTR [1/2]

#define API_ERROR_INVALID_DELAYUS_PTR   (-EINVAL)

Invalid pointer to the delayus function assigned

API_ERROR_INVALID_DELAYUS_PTR [2/2]

#define API_ERROR_INVALID_DELAYUS_PTR   (-EINVAL)

Invalid pointer to the delayus function assigned

API_ERROR_INVALID_HANDLE_PTR [1/2]

#define API_ERROR_INVALID_HANDLE_PTR   (-EINVAL)

Handler pointer is invalid

API_ERROR_INVALID_HANDLE_PTR [2/2]

#define API_ERROR_INVALID_HANDLE_PTR   (-EINVAL)

Handler pointer is invalid

API_ERROR_INVALID_PARAM [1/2]

#define API_ERROR_INVALID_PARAM   (-EINVAL)

Invalid parameter passed

API_ERROR_INVALID_PARAM [2/2]

#define API_ERROR_INVALID_PARAM   (-EINVAL)

Invalid parameter passed

API_ERROR_INVALID_XFER_PTR [1/2]

#define API_ERROR_INVALID_XFER_PTR   (-EINVAL)

Invalid pointer to the SPI xfer function assigned

API_ERROR_INVALID_XFER_PTR [2/2]

#define API_ERROR_INVALID_XFER_PTR   (-EINVAL)

Invalid pointer to the SPI xfer function assigned

API_ERROR_NCO_NOT_ENABLED [1/2]

#define API_ERROR_NCO_NOT_ENABLED   (-ENODEV)

The NCO is not enabled

API_ERROR_NCO_NOT_ENABLED [2/2]

#define API_ERROR_NCO_NOT_ENABLED   (-ENODEV)

The NCO is not enabled

API_ERROR_NOT_SUPPORTED [1/2]

#define API_ERROR_NOT_SUPPORTED   (-ENOTSUP)

Not supported

API_ERROR_NOT_SUPPORTED [2/2]

#define API_ERROR_NOT_SUPPORTED   (-ENOTSUP)

Not supported

API_ERROR_OK [1/2]

#define API_ERROR_OK   0

No Error

API_ERROR_OK [2/2]

#define API_ERROR_OK   0

No Error

API_ERROR_RESET_PIN_CTRL [1/2]

#define API_ERROR_RESET_PIN_CTRL   -(ENODEV)

HW reset function error

API_ERROR_RESET_PIN_CTRL [2/2]

#define API_ERROR_RESET_PIN_CTRL   -(ENODEV)

HW reset function error

API_ERROR_SPI_SDO [1/2]

#define API_ERROR_SPI_SDO   (-EINVAL)

Wrong value assigned to the ref ad9172_handle_t.sdo

API_ERROR_SPI_SDO [2/2]

#define API_ERROR_SPI_SDO   (-EINVAL)

Wrong value assigned to the ref ad9172_handle_t.sdo

API_ERROR_SPI_XFER [1/2]

#define API_ERROR_SPI_XFER   -(ENODEV)

SPI transfer error

API_ERROR_SPI_XFER [2/2]

#define API_ERROR_SPI_XFER   -(ENODEV)

SPI transfer error

API_ERROR_TEST_FAILED [1/2]

#define API_ERROR_TEST_FAILED   -(ENODEV)

Test failed

API_ERROR_TEST_FAILED [2/2]

#define API_ERROR_TEST_FAILED   -(ENODEV)

Test failed

API_ERROR_TX_EN_PIN_CTRL [1/2]

#define API_ERROR_TX_EN_PIN_CTRL   -(ENODEV)

TX enable function error

API_ERROR_TX_EN_PIN_CTRL [2/2]

#define API_ERROR_TX_EN_PIN_CTRL   -(ENODEV)

TX enable function error

API_ERROR_US_DELAY [1/2]

#define API_ERROR_US_DELAY   -(ENODEV)

delay function error

API_ERROR_US_DELAY [2/2]

#define API_ERROR_US_DELAY   -(ENODEV)

delay function error

API_ERROR_VCO_OUT_OF_RANGE [1/2]

#define API_ERROR_VCO_OUT_OF_RANGE   (-EINVAL)

The VCO is out of range

API_ERROR_VCO_OUT_OF_RANGE [2/2]

#define API_ERROR_VCO_OUT_OF_RANGE   (-EINVAL)

The VCO is out of range

Function Documentation

adi_api_get_error_string()

char * adi_api_get_error_string

(

int

error_code

)

Return string representation of the error code.

Parameters

error_code

Error code.

Return values

char*

Pointer to a null terminated string