SPI Private Macros

Collaboration diagram for SPI Private Macros:

Macros
#define	SPI_1LINE_TX(__HANDLE__)   ((__HANDLE__)->Instance->CR1 |= SPI_CR1_BIDIOE)
	Set the SPI transmit-only mode. More...
#define	SPI_1LINE_RX(__HANDLE__)   ((__HANDLE__)->Instance->CR1 &= (~SPI_CR1_BIDIOE))
	Set the SPI receive-only mode. More...
#define	SPI_RESET_CRC(__HANDLE__)
	Reset the CRC calculation of the SPI. More...
#define	IS_SPI_MODE(MODE)
#define	IS_SPI_DIRECTION(MODE)
#define	IS_SPI_DIRECTION_2LINES(MODE)   ((MODE) == SPI_DIRECTION_2LINES)
#define	IS_SPI_DIRECTION_2LINES_OR_1LINE(MODE)
#define	IS_SPI_DATASIZE(DATASIZE)
#define	IS_SPI_CPOL(CPOL)
#define	IS_SPI_CPHA(CPHA)
#define	IS_SPI_NSS(NSS)
#define	IS_SPI_BAUDRATE_PRESCALER(PRESCALER)
#define	IS_SPI_FIRST_BIT(BIT)
#define	IS_SPI_TIMODE(MODE)
#define	IS_SPI_CRC_CALCULATION(CALCULATION)
#define	IS_SPI_CRC_POLYNOMIAL(POLYNOMIAL)   (((POLYNOMIAL) >= 0x01U) && ((POLYNOMIAL) <= 0xFFFFU))

Detailed Description

Macro Definition Documentation

SPI_1LINE_TX

#define SPI_1LINE_TX

(

__HANDLE__

)

((__HANDLE__)->Instance->CR1 |= SPI_CR1_BIDIOE)

Set the SPI transmit-only mode.

Parameters

<strong>HANDLE</strong>

specifies the SPI Handle. This parameter can be SPI where x: 1, 2, or 3 to select the SPI peripheral.

Return values

None

SPI_1LINE_RX

#define SPI_1LINE_RX

(

__HANDLE__

)

((__HANDLE__)->Instance->CR1 &= (~SPI_CR1_BIDIOE))

Set the SPI receive-only mode.

Parameters

<strong>HANDLE</strong>

specifies the SPI Handle. This parameter can be SPI where x: 1, 2, or 3 to select the SPI peripheral.

Return values

None

SPI_RESET_CRC

#define SPI_RESET_CRC

(

__HANDLE__

)

Value:

do{(__HANDLE__)->Instance->CR1 &= (uint16_t)(~SPI_CR1_CRCEN);\
                                     (__HANDLE__)->Instance->CR1 |= SPI_CR1_CRCEN;}while(0U)

Reset the CRC calculation of the SPI.

Parameters

<strong>HANDLE</strong>

specifies the SPI Handle. This parameter can be SPI where x: 1, 2, or 3 to select the SPI peripheral.

Return values

None

IS_SPI_MODE

#define IS_SPI_MODE

(

MODE

)

Value:

(((MODE) == SPI_MODE_SLAVE) || \
                           ((MODE) == SPI_MODE_MASTER))

IS_SPI_DIRECTION

#define IS_SPI_DIRECTION

(

MODE

)

Value:

(((MODE) == SPI_DIRECTION_2LINES)        || \
                                ((MODE) == SPI_DIRECTION_2LINES_RXONLY) || \
                                ((MODE) == SPI_DIRECTION_1LINE))

IS_SPI_DIRECTION_2LINES

#define IS_SPI_DIRECTION_2LINES

(

MODE

)

((MODE) == SPI_DIRECTION_2LINES)

IS_SPI_DIRECTION_2LINES_OR_1LINE

#define IS_SPI_DIRECTION_2LINES_OR_1LINE

(

MODE

)

Value:

(((MODE) == SPI_DIRECTION_2LINES)  || \
                                                ((MODE) == SPI_DIRECTION_1LINE))

IS_SPI_DATASIZE

#define IS_SPI_DATASIZE

(

DATASIZE

)

Value:

(((DATASIZE) == SPI_DATASIZE_16BIT) || \
                                   ((DATASIZE) == SPI_DATASIZE_8BIT))

IS_SPI_CPOL

#define IS_SPI_CPOL

(

CPOL

)

Value:

(((CPOL) == SPI_POLARITY_LOW) || \
                           ((CPOL) == SPI_POLARITY_HIGH))

IS_SPI_CPHA

#define IS_SPI_CPHA

(

CPHA

)

Value:

(((CPHA) == SPI_PHASE_1EDGE) || \
                           ((CPHA) == SPI_PHASE_2EDGE))

IS_SPI_NSS

#define IS_SPI_NSS

(

NSS

)

Value:

(((NSS) == SPI_NSS_SOFT)       || \
                         ((NSS) == SPI_NSS_HARD_INPUT) || \
                         ((NSS) == SPI_NSS_HARD_OUTPUT))

IS_SPI_BAUDRATE_PRESCALER

#define IS_SPI_BAUDRATE_PRESCALER

(

PRESCALER

)

Value:

(((PRESCALER) == SPI_BAUDRATEPRESCALER_2)   || \
                                              ((PRESCALER) == SPI_BAUDRATEPRESCALER_4)   || \
                                              ((PRESCALER) == SPI_BAUDRATEPRESCALER_8)   || \
                                              ((PRESCALER) == SPI_BAUDRATEPRESCALER_16)  || \
                                              ((PRESCALER) == SPI_BAUDRATEPRESCALER_32)  || \
                                              ((PRESCALER) == SPI_BAUDRATEPRESCALER_64)  || \
                                              ((PRESCALER) == SPI_BAUDRATEPRESCALER_128) || \
                                              ((PRESCALER) == SPI_BAUDRATEPRESCALER_256))

IS_SPI_FIRST_BIT

#define IS_SPI_FIRST_BIT

(

BIT

)

Value:

(((BIT) == SPI_FIRSTBIT_MSB) || \
                               ((BIT) == SPI_FIRSTBIT_LSB))

IS_SPI_TIMODE

#define IS_SPI_TIMODE

(

MODE

)

Value:

(((MODE) == SPI_TIMODE_DISABLE) || \
                             ((MODE) == SPI_TIMODE_ENABLE))

IS_SPI_CRC_CALCULATION

#define IS_SPI_CRC_CALCULATION

(

CALCULATION

)

Value:

(((CALCULATION) == SPI_CRCCALCULATION_DISABLE) || \
                                             ((CALCULATION) == SPI_CRCCALCULATION_ENABLE))

IS_SPI_CRC_POLYNOMIAL

#define IS_SPI_CRC_POLYNOMIAL

(

POLYNOMIAL

)

(((POLYNOMIAL) >= 0x01U) && ((POLYNOMIAL) <= 0xFFFFU))