SPI Private Macros

Collaboration diagram for SPI Private Macros:

Macros
#define	SPI_1LINE_TX(__HANDLE__)
	Set the SPI transmit-only mode.
#define	SPI_1LINE_RX(__HANDLE__)
	Set the SPI receive-only mode.
#define	SPI_RESET_CRC(__HANDLE__)
	Reset the CRC calculation of the SPI.
#define	SPI_CHECK_FLAG(__SR__, __FLAG__)
	Check whether the specified SPI flag is set or not.
#define	SPI_CHECK_IT_SOURCE(__CR2__, __INTERRUPT__)
	Check whether the specified SPI Interrupt is set or not.
#define	IS_SPI_MODE(__MODE__)
	Checks if SPI Mode parameter is in allowed range.
#define	IS_SPI_DIRECTION(__MODE__)
	Checks if SPI Direction Mode parameter is in allowed range.
#define	IS_SPI_DIRECTION_2LINES(__MODE__)
	Checks if SPI Direction Mode parameter is 2 lines.
#define	IS_SPI_DIRECTION_2LINES_OR_1LINE(__MODE__)
	Checks if SPI Direction Mode parameter is 1 or 2 lines.
#define	IS_SPI_DATASIZE(__DATASIZE__)
	Checks if SPI Data Size parameter is in allowed range.
#define	IS_SPI_CPOL(__CPOL__)
	Checks if SPI Serial clock steady state parameter is in allowed range.
#define	IS_SPI_CPHA(__CPHA__)
	Checks if SPI Clock Phase parameter is in allowed range.
#define	IS_SPI_NSS(__NSS__)
	Checks if SPI Slave Select parameter is in allowed range.
#define	IS_SPI_BAUDRATE_PRESCALER(__PRESCALER__)
	Checks if SPI Baudrate prescaler parameter is in allowed range.
#define	IS_SPI_FIRST_BIT(__BIT__)
	Checks if SPI MSB LSB transmission parameter is in allowed range.
#define	IS_SPI_TIMODE(__MODE__)
	Checks if SPI TI mode parameter is in allowed range.
#define	IS_SPI_CRC_CALCULATION(__CALCULATION__)
	Checks if SPI CRC calculation enabled state is in allowed range.
#define	IS_SPI_CRC_POLYNOMIAL(__POLYNOMIAL__)
	Checks if SPI polynomial value to be used for the CRC calculation, is in allowed range.
#define	IS_SPI_DMA_HANDLE(__HANDLE__)
	Checks if DMA handle is valid.

Detailed Description

Macro Definition Documentation

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))

Checks if SPI Baudrate prescaler parameter is in allowed range.

Parameters

__PRESCALER__

specifies the SPI Baudrate prescaler. This parameter can be a value of SPI BaudRate Prescaler

Return values

None

Definition at line 594 of file stm32f4xx_hal_spi.h.

IS_SPI_CPHA

#define IS_SPI_CPHA

(

__CPHA__

)

Value:

(((__CPHA__) == SPI_PHASE_1EDGE) || \
((__CPHA__) == SPI_PHASE_2EDGE))

Checks if SPI Clock Phase parameter is in allowed range.

Parameters

__CPHA__

specifies the SPI Clock Phase. This parameter can be a value of SPI Clock Phase

Return values

None

Definition at line 577 of file stm32f4xx_hal_spi.h.

IS_SPI_CPOL

#define IS_SPI_CPOL

(

__CPOL__

)

Value:

(((__CPOL__) == SPI_POLARITY_LOW) || \
((__CPOL__) == SPI_POLARITY_HIGH))

Checks if SPI Serial clock steady state parameter is in allowed range.

Parameters

__CPOL__

specifies the SPI serial clock steady state. This parameter can be a value of SPI Clock Polarity

Return values

None

Definition at line 569 of file stm32f4xx_hal_spi.h.

IS_SPI_CRC_CALCULATION

#define IS_SPI_CRC_CALCULATION

(

__CALCULATION__

)

Value:

(((__CALCULATION__) == SPI_CRCCALCULATION_DISABLE) || \
((__CALCULATION__) == SPI_CRCCALCULATION_ENABLE))

Checks if SPI CRC calculation enabled state is in allowed range.

Parameters

__CALCULATION__

specifies the SPI CRC calculation enable state. This parameter can be a value of SPI CRC Calculation

Return values

None

Definition at line 624 of file stm32f4xx_hal_spi.h.

IS_SPI_CRC_POLYNOMIAL

#define IS_SPI_CRC_POLYNOMIAL

(

__POLYNOMIAL__

)

Value:

(((__POLYNOMIAL__) >= 0x1U)    && \
((__POLYNOMIAL__) <= 0xFFFFU) && \
(((__POLYNOMIAL__)&0x1U) != 0U))

Checks if SPI polynomial value to be used for the CRC calculation, is in allowed range.

Parameters

__POLYNOMIAL__

specifies the SPI polynomial value to be used for the CRC calculation. This parameter must be a number between Min_Data = 0 and Max_Data = 65535

Return values

None

Definition at line 632 of file stm32f4xx_hal_spi.h.

IS_SPI_DATASIZE

#define IS_SPI_DATASIZE

(

__DATASIZE__

)

Value:

(((__DATASIZE__) == SPI_DATASIZE_16BIT) || \
((__DATASIZE__) == SPI_DATASIZE_8BIT))

Checks if SPI Data Size parameter is in allowed range.

Parameters

__DATASIZE__

specifies the SPI Data Size. This parameter can be a value of SPI Data Size

Return values

None

Definition at line 561 of file stm32f4xx_hal_spi.h.

IS_SPI_DIRECTION

#define IS_SPI_DIRECTION

(

__MODE__

)

Value:

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

Checks if SPI Direction Mode parameter is in allowed range.

Parameters

__MODE__

specifies the SPI Direction Mode. This parameter can be a value of SPI Direction Mode

Return values

None

Definition at line 539 of file stm32f4xx_hal_spi.h.

IS_SPI_DIRECTION_2LINES

#define IS_SPI_DIRECTION_2LINES

(

__MODE__

)

Value:

((__MODE__) == SPI_DIRECTION_2LINES)

Checks if SPI Direction Mode parameter is 2 lines.

Parameters

__MODE__

specifies the SPI Direction Mode.

Return values

None

Definition at line 547 of file stm32f4xx_hal_spi.h.

IS_SPI_DIRECTION_2LINES_OR_1LINE

#define IS_SPI_DIRECTION_2LINES_OR_1LINE

(

__MODE__

)

Value:

(((__MODE__) == SPI_DIRECTION_2LINES) || \
((__MODE__) == SPI_DIRECTION_1LINE))

Checks if SPI Direction Mode parameter is 1 or 2 lines.

Parameters

__MODE__

specifies the SPI Direction Mode.

Return values

None

Definition at line 553 of file stm32f4xx_hal_spi.h.

IS_SPI_DMA_HANDLE

#define IS_SPI_DMA_HANDLE

(

__HANDLE__

)

Value:

((__HANDLE__) != NULL)

Checks if DMA handle is valid.

Parameters

__HANDLE__

specifies a DMA Handle.

Return values

None

Definition at line 640 of file stm32f4xx_hal_spi.h.

IS_SPI_FIRST_BIT

#define IS_SPI_FIRST_BIT

(

__BIT__

)

Value:

(((__BIT__) == SPI_FIRSTBIT_MSB) || \
((__BIT__) == SPI_FIRSTBIT_LSB))

Checks if SPI MSB LSB transmission parameter is in allowed range.

Parameters

__BIT__

specifies the SPI MSB LSB transmission (whether data transfer starts from MSB or LSB bit). This parameter can be a value of SPI MSB LSB Transmission

Return values

None

Definition at line 608 of file stm32f4xx_hal_spi.h.

IS_SPI_MODE

#define IS_SPI_MODE

(

__MODE__

)

Value:

(((__MODE__) == SPI_MODE_SLAVE)   || \
((__MODE__) == SPI_MODE_MASTER))

Checks if SPI Mode parameter is in allowed range.

Parameters

__MODE__

specifies the SPI Mode. This parameter can be a value of SPI Mode

Return values

None

Definition at line 531 of file stm32f4xx_hal_spi.h.

IS_SPI_NSS

#define IS_SPI_NSS

(

__NSS__

)

Value:

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

Checks if SPI Slave Select parameter is in allowed range.

Parameters

__NSS__

specifies the SPI Slave Select management parameter. This parameter can be a value of SPI Slave Select Management

Return values

None

Definition at line 585 of file stm32f4xx_hal_spi.h.

IS_SPI_TIMODE

#define IS_SPI_TIMODE

(

__MODE__

)

Value:

(((__MODE__) == SPI_TIMODE_DISABLE) || \
((__MODE__) == SPI_TIMODE_ENABLE))

Checks if SPI TI mode parameter is in allowed range.

Parameters

__MODE__

specifies the SPI TI mode. This parameter can be a value of SPI TI Mode

Return values

None

Definition at line 616 of file stm32f4xx_hal_spi.h.

SPI_1LINE_RX

#define SPI_1LINE_RX

(

__HANDLE__

)

Value:

CLEAR_BIT((__HANDLE__)->Instance->CR1, SPI_CR1_BIDIOE)

Set the SPI receive-only mode.

Parameters

__HANDLE__

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

Return values

None

Definition at line 485 of file stm32f4xx_hal_spi.h.

SPI_1LINE_TX

#define SPI_1LINE_TX

(

__HANDLE__

)

Value:

SET_BIT((__HANDLE__)->Instance->CR1, SPI_CR1_BIDIOE)

Set the SPI transmit-only mode.

Parameters

__HANDLE__

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

Return values

None

Definition at line 478 of file stm32f4xx_hal_spi.h.

SPI_CHECK_FLAG

#define SPI_CHECK_FLAG	(		__SR__,
			__FLAG__ )

Value:

((((__SR__) & ((__FLAG__) & SPI_FLAG_MASK)) == \
((__FLAG__) & SPI_FLAG_MASK)) ? SET : RESET)

Check whether the specified SPI flag is set or not.

Parameters

__SR__	copy of SPI SR register.
__FLAG__	specifies the flag to check. This parameter can be one of the following values: SPI_FLAG_RXNE: Receive buffer not empty flag SPI_FLAG_TXE: Transmit buffer empty flag SPI_FLAG_CRCERR: CRC error flag SPI_FLAG_MODF: Mode fault flag SPI_FLAG_OVR: Overrun flag SPI_FLAG_BSY: Busy flag SPI_FLAG_FRE: Frame format error flag

Return values

SET

or RESET.

Definition at line 511 of file stm32f4xx_hal_spi.h.

SPI_CHECK_IT_SOURCE

#define SPI_CHECK_IT_SOURCE	(		__CR2__,
			__INTERRUPT__ )

Value:

((((__CR2__) & (__INTERRUPT__)) == \
(__INTERRUPT__)) ? SET : RESET)

Check whether the specified SPI Interrupt is set or not.

Parameters

__CR2__	copy of SPI CR2 register.
__INTERRUPT__	specifies the SPI interrupt source to check. This parameter can be one of the following values: SPI_IT_TXE: Tx buffer empty interrupt enable SPI_IT_RXNE: RX buffer not empty interrupt enable SPI_IT_ERR: Error interrupt enable

Return values

SET

or RESET.

Definition at line 523 of file stm32f4xx_hal_spi.h.

SPI_RESET_CRC

#define SPI_RESET_CRC

(

__HANDLE__

)

Value:

do{                                                       \
  CLEAR_BIT((__HANDLE__)->Instance->CR1, SPI_CR1_CRCEN);  \
  SET_BIT((__HANDLE__)->Instance->CR1, SPI_CR1_CRCEN);    \
} while(0U)

Reset the CRC calculation of the SPI.

Parameters

__HANDLE__

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

Return values

None

Definition at line 492 of file stm32f4xx_hal_spi.h.