Modules | Macros
ADCBuf_control command and status codes
Collaboration diagram for ADCBuf_control command and status codes:

Modules

 Command Codes
 

Macros

#define ADCBuf_CMD_RESERVED   (32)
 
#define ADCBuf_STATUS_RESERVED   (-32)
 
#define ADCBuf_STATUS_SUCCESS   (0)
 Success status code returned by: ADCBuf_control() More...
 
#define ADCBuf_STATUS_ERROR   (-1)
 Generic error status code returned by ADCBuf_control(). More...
 
#define ADCBuf_STATUS_UNDEFINEDCMD   (-2)
 An error status code returned by ADCBuf_control() for undefined command codes. More...
 
#define ADCBuf_STATUS_UNSUPPORTED   (-3)
 An error status code returned if the function is not supported by a particular driver implementation. More...
 

Detailed Description

These ADCBuf macros are reservations for ADCBuf.h

Macro Definition Documentation

§ ADCBuf_CMD_RESERVED

#define ADCBuf_CMD_RESERVED   (32)

Common ADCBuf_control command code reservation offset. ADC driver implementations should offset command codes with ADCBuf_CMD_RESERVED growing positively

Example implementation specific command codes:

#define ADCXYZ_COMMAND0 ADCBuf_CMD_RESERVED + 0
#define ADCXYZ_COMMAND1 ADCBuf_CMD_RESERVED + 1

§ ADCBuf_STATUS_RESERVED

#define ADCBuf_STATUS_RESERVED   (-32)

Common ADCBuf_control status code reservation offset. ADC driver implementations should offset status codes with ADCBuf_STATUS_RESERVED growing negatively.

Example implementation specific status codes:

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

§ ADCBuf_STATUS_SUCCESS

#define ADCBuf_STATUS_SUCCESS   (0)

Success status code returned by: ADCBuf_control()

Functions return ADCBuf_STATUS_SUCCESS if the call was executed successfully.

§ ADCBuf_STATUS_ERROR

#define ADCBuf_STATUS_ERROR   (-1)

Generic error status code returned by ADCBuf_control().

ADCBuf_control() returns ADCBuf_STATUS_ERROR if the control code was not executed successfully.

§ ADCBuf_STATUS_UNDEFINEDCMD

#define ADCBuf_STATUS_UNDEFINEDCMD   (-2)

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

ADCBuf_control() returns ADCBuf_STATUS_UNDEFINEDCMD if the control code is not recognized by the driver implementation.

§ ADCBuf_STATUS_UNSUPPORTED

#define ADCBuf_STATUS_UNSUPPORTED   (-3)

An error status code returned if the function is not supported by a particular driver implementation.

© Copyright 1995-2019, Texas Instruments Incorporated. All rights reserved.
Trademarks | Privacy policy | Terms of use | Terms of sale