Status Codes

Collaboration diagram for Status Codes:

Macros
#define	SPI_STATUS_SUCCESS   0
	Successful status code returned by SPI_control(). More...
#define	SPI_STATUS_ERROR   -1
	Generic error status code returned by SPI_control(). More...
#define	SPI_STATUS_UNDEFINEDCMD   -2
	An error status code returned by SPI_control() for undefined command codes. More...

Detailed Description

SPI_STATUS_* macros are general status codes returned by SPI_control()

SPICC26XXDMA_STATUS_* macros are command codes only defined in the SPICC26XXDMA.h driver implementation and need to:

#include <ti/drivers/sdspi/SPICC26XXDMA.h>

SPICC3200DMA_STATUS_* macros are command codes only defined in the SPICC3200DMA.h driver implementation and need to:

#include <ti/drivers/sdspi/SPICC3200DMA.h>

SPIEUSCIADMA_STATUS_* macros are command codes only defined in the SPIEUSCIADMA.h driver implementation and need to:

#include <ti/drivers/spi/SPIEUSCIADMA.h>

SPIEUSCIBDMA_STATUS_* macros are command codes only defined in the SPIEUSCIBDMA.h driver implementation and need to:

#include <ti/drivers/spi/SPIEUSCIBDMA.h>

SPIMSP432DMA_STATUS_* macros are command codes only defined in the SPIMSP432DMA.h driver implementation and need to:

#include <ti/drivers/spi/SPIMSP432DMA.h>

SPITivaDMA_STATUS_* macros are command codes only defined in the SPITivaDMA.h driver implementation and need to:

#include <ti/drivers/spi/SPITivaDMA.h>

SPIUSCIADMA_STATUS_* macros are command codes only defined in the SPIUSCIADMA.h driver implementation and need to:

#include <ti/drivers/spi/SPIUSCIADMA.h>

SPIUSCIBDMA_STATUS_* macros are command codes only defined in the SPIUSCIBDMA.h driver implementation and need to:

#include <ti/drivers/spi/SPIUSCIBDMA.h>

Macro Definition Documentation

#define SPI_STATUS_SUCCESS   0

Successful status code returned by SPI_control().

SPI_control() returns SPI_STATUS_SUCCESS if the control code was executed successfully.

#define SPI_STATUS_ERROR   -1

Generic error status code returned by SPI_control().

SPI_control() returns SPI_STATUS_ERROR if the control code was not executed successfully.

#define SPI_STATUS_UNDEFINEDCMD   -2

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

SPI_control() returns SPI_STATUS_UNDEFINEDCMD if the control code is not recognized by the driver implementation.