ADC_control command and status codes

Collaboration diagram for ADC_control command and status codes:

Modules
	Command Codes

Macros
#define	ADC_CMD_RESERVED   (32)
#define	ADC_STATUS_RESERVED   (-32)
#define	ADC_STATUS_SUCCESS   (0)
	Successful status code returned by ADC_control(). More...
#define	ADC_STATUS_ERROR   (-1)
	Generic error status code returned by ADC_control(). More...
#define	ADC_STATUS_UNDEFINEDCMD   (-2)
	An error status code returned by ADC_control() for undefined command codes. More...

Detailed Description

These ADC macros are reservations for ADC.h

Macro Definition Documentation

#define ADC_CMD_RESERVED   (32)

Common ADC_control command code reservation offset. ADC driver implementations should offset command codes with ADC_CMD_RESERVED growing positively

Example implementation specific command codes:

#define ADCXYZ_CMD_COMMAND0      ADC_CMD_RESERVED + 0
#define ADCXYZ_CMD_COMMAND1      ADC_CMD_RESERVED + 1

#define ADC_STATUS_RESERVED   (-32)

Common ADC_control status code reservation offset. ADC driver implementations should offset status codes with ADC_STATUS_RESERVED growing negatively.

Example implementation specific status codes:

#define ADCXYZ_STATUS_ERROR0     ADC_STATUS_RESERVED - 0
#define ADCXYZ_STATUS_ERROR1     ADC_STATUS_RESERVED - 1
#define ADCXYZ_STATUS_ERROR2     ADC_STATUS_RESERVED - 2

#define ADC_STATUS_SUCCESS   (0)

Successful status code returned by ADC_control().

ADC_control() returns ADC_STATUS_SUCCESS if the control code was executed successfully.

#define ADC_STATUS_ERROR   (-1)

Generic error status code returned by ADC_control().

ADC_control() returns ADC_STATUS_ERROR if the control code was not executed successfully.

#define ADC_STATUS_UNDEFINEDCMD   (-2)

An error status code returned by ADC_control() for undefined command codes.

ADC_control() returns ADC_STATUS_UNDEFINEDCMD if the control code is not recognized by the driver implementation.