Status Codes

Macros
#define	UART_STATUS_SUCCESS   (0)
	Successful status code returned by UART_control(). More...
#define	UART_STATUS_ERROR   (-1)
	Generic error status code returned by UART_control(). More...
#define	UART_STATUS_UNDEFINEDCMD   (-2)
	An error status code returned by UART_control() for undefined command codes. More...

Detailed Description

UART_STATUS_* macros are general status codes returned by UART_control()

Macro Definition Documentation

UART_STATUS_SUCCESS

#define UART_STATUS_SUCCESS   (0)

Successful status code returned by UART_control().

UART_control() returns UART_STATUS_SUCCESS if the control code was executed successfully.

UART_STATUS_ERROR

#define UART_STATUS_ERROR   (-1)

Generic error status code returned by UART_control().

UART_control() returns UART_STATUS_ERROR if the control code was not executed successfully.

UART_STATUS_UNDEFINEDCMD

#define UART_STATUS_UNDEFINEDCMD   (-2)

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

UART_control() returns UART_STATUS_UNDEFINEDCMD if the control code is not recognized by the driver implementation.