SWPMI Exported Macros

Macros
#define	__HAL_SWPMI_RESET_HANDLE_STATE(__HANDLE__)   ((__HANDLE__)->State = HAL_SWPMI_STATE_RESET)
	Reset SWPMI handle state.
#define	__HAL_SWPMI_ENABLE(__HANDLE__)   SET_BIT((__HANDLE__)->Instance->CR, SWPMI_CR_SWPACT)
	Enable the SWPMI peripheral.
#define	__HAL_SWPMI_DISABLE(__HANDLE__)   CLEAR_BIT((__HANDLE__)->Instance->CR, SWPMI_CR_SWPACT)
	Disable the SWPMI peripheral.
#define	__HAL_SWPMI_TRANSCEIVER_ENABLE(__HANDLE__)   SET_BIT((__HANDLE__)->Instance->CR, SWPMI_CR_SWPEN)
	Enable the SWPMI transceiver.
#define	__HAL_SWPMI_TRANSCEIVER_DISABLE(__HANDLE__)   CLEAR_BIT((__HANDLE__)->Instance->CR, SWPMI_CR_SWPEN)
	Disable the SWPMI transceiver.
#define	__HAL_SWPMI_GET_FLAG(__HANDLE__, __FLAG__)   (READ_BIT((__HANDLE__)->Instance->ISR, (__FLAG__)) == (__FLAG__))
	Check whether the specified SWPMI flag is set or not.
#define	__HAL_SWPMI_CLEAR_FLAG(__HANDLE__, __FLAG__)   WRITE_REG((__HANDLE__)->Instance->ICR, (__FLAG__))
	Clear the specified SWPMI ISR flag.
#define	__HAL_SWPMI_ENABLE_IT(__HANDLE__, __INTERRUPT__)   SET_BIT((__HANDLE__)->Instance->IER, (__INTERRUPT__))
	Enable the specified SWPMI interrupt.
#define	__HAL_SWPMI_DISABLE_IT(__HANDLE__, __INTERRUPT__)   CLEAR_BIT((__HANDLE__)->Instance->IER, (__INTERRUPT__))
	Disable the specified SWPMI interrupt.
#define	__HAL_SWPMI_GET_IT(__HANDLE__, __IT__)   (READ_BIT((__HANDLE__)->Instance->ISR,(__IT__)) == (__IT__))
	Check whether the specified SWPMI interrupt has occurred or not.
#define	__HAL_SWPMI_GET_IT_SOURCE(__HANDLE__, __IT__)   ((READ_BIT((__HANDLE__)->Instance->IER, (__IT__)) == (__IT__)) ? SET : RESET)
	Check whether the specified SWPMI interrupt source is enabled or not.

Detailed Description

Macro Definition Documentation

__HAL_SWPMI_CLEAR_FLAG

#define __HAL_SWPMI_CLEAR_FLAG	(		__HANDLE__,
			__FLAG__
	)		WRITE_REG((__HANDLE__)->Instance->ICR, (__FLAG__))

Clear the specified SWPMI ISR flag.

Parameters

__HANDLE__

specifies the SWPMI Handle.

__FLAG__

specifies the flag to clear. This parameter can be one of the following values: SWPMI_FLAG_RXBFF Receive buffer full flag. SWPMI_FLAG_TXBEF Transmit buffer empty flag. SWPMI_FLAG_RXBERF Receive CRC error flag. SWPMI_FLAG_RXOVRF Receive overrun error flag. SWPMI_FLAG_TXUNRF Transmit underrun error flag. SWPMI_FLAG_TCF Transfer complete flag. SWPMI_FLAG_SRF Slave resume flag. SWPMI_FLAG_RDYF Transceiver ready flag.

Return values

None

__HAL_SWPMI_DISABLE

#define __HAL_SWPMI_DISABLE

(

__HANDLE__

)

CLEAR_BIT((__HANDLE__)->Instance->CR, SWPMI_CR_SWPACT)

Disable the SWPMI peripheral.

Parameters

__HANDLE__

SWPMI handle

Return values

None

__HAL_SWPMI_DISABLE_IT

#define __HAL_SWPMI_DISABLE_IT	(		__HANDLE__,
			__INTERRUPT__
	)		CLEAR_BIT((__HANDLE__)->Instance->IER, (__INTERRUPT__))

Disable the specified SWPMI interrupt.

Parameters

__HANDLE__

specifies the SWPMI Handle.

__INTERRUPT__

specifies the SWPMI interrupt source to disable. This parameter can be one of the following values: SWPMI_IT_RDYIE Transceiver ready interrupt. SWPMI_IT_SRIE Slave resume interrupt. SWPMI_IT_TCIE Transmit complete interrupt. SWPMI_IT_TIE Transmit interrupt. SWPMI_IT_RIE Receive interrupt. SWPMI_IT_TXUNRIE Transmit underrun error interrupt. SWPMI_IT_RXOVRIE Receive overrun error interrupt. SWPMI_IT_RXBEIE Receive CRC error interrupt. SWPMI_IT_TXBEIE Transmit buffer empty interrupt. SWPMI_IT_RXBFIE Receive buffer full interrupt.

Return values

None

__HAL_SWPMI_ENABLE

#define __HAL_SWPMI_ENABLE

(

__HANDLE__

)

SET_BIT((__HANDLE__)->Instance->CR, SWPMI_CR_SWPACT)

Enable the SWPMI peripheral.

Parameters

__HANDLE__

SWPMI handle

Return values

None

__HAL_SWPMI_ENABLE_IT

#define __HAL_SWPMI_ENABLE_IT	(		__HANDLE__,
			__INTERRUPT__
	)		SET_BIT((__HANDLE__)->Instance->IER, (__INTERRUPT__))

Enable the specified SWPMI interrupt.

Parameters

__HANDLE__

specifies the SWPMI Handle.

__INTERRUPT__

specifies the SWPMI interrupt source to enable. This parameter can be one of the following values: SWPMI_IT_RDYIE Transceiver ready interrupt. SWPMI_IT_SRIE Slave resume interrupt. SWPMI_IT_TCIE Transmit complete interrupt. SWPMI_IT_TIE Transmit interrupt. SWPMI_IT_RIE Receive interrupt. SWPMI_IT_TXUNRIE Transmit underrun error interrupt. SWPMI_IT_RXOVRIE Receive overrun error interrupt. SWPMI_IT_RXBEIE Receive CRC error interrupt. SWPMI_IT_TXBEIE Transmit buffer empty interrupt. SWPMI_IT_RXBFIE Receive buffer full interrupt.

Return values

None

__HAL_SWPMI_GET_FLAG

#define __HAL_SWPMI_GET_FLAG	(		__HANDLE__,
			__FLAG__
	)		(READ_BIT((__HANDLE__)->Instance->ISR, (__FLAG__)) == (__FLAG__))

Check whether the specified SWPMI flag is set or not.

Parameters

__HANDLE__

specifies the SWPMI Handle.

__FLAG__

specifies the flag to check. This parameter can be one of the following values: SWPMI_FLAG_RXBFF Receive buffer full flag. SWPMI_FLAG_TXBEF Transmit buffer empty flag. SWPMI_FLAG_RXBERF Receive CRC error flag. SWPMI_FLAG_RXOVRF Receive overrun error flag. SWPMI_FLAG_TXUNRF Transmit underrun error flag. SWPMI_FLAG_RXNE Receive data register not empty. SWPMI_FLAG_TXE Transmit data register empty. SWPMI_FLAG_TCF Transfer complete flag. SWPMI_FLAG_SRF Slave resume flag. SWPMI_FLAG_SUSP SUSPEND flag. SWPMI_FLAG_DEACTF DEACTIVATED flag. SWPMI_FLAG_RDYF Transceiver ready flag.

Return values

The	new state of FLAG (TRUE or FALSE).

__HAL_SWPMI_GET_IT

#define __HAL_SWPMI_GET_IT	(		__HANDLE__,
			__IT__
	)		(READ_BIT((__HANDLE__)->Instance->ISR,(__IT__)) == (__IT__))

Check whether the specified SWPMI interrupt has occurred or not.

Parameters

__HANDLE__

specifies the SWPMI Handle.

__IT__

specifies the SWPMI interrupt to check. This parameter can be one of the following values: SWPMI_IT_RDYIE Transceiver ready interrupt. SWPMI_IT_SRIE Slave resume interrupt. SWPMI_IT_TCIE Transmit complete interrupt. SWPMI_IT_TIE Transmit interrupt. SWPMI_IT_RIE Receive interrupt. SWPMI_IT_TXUNRIE Transmit underrun error interrupt. SWPMI_IT_RXOVRIE Receive overrun error interrupt. SWPMI_IT_RXBERIE Receive CRC error interrupt. SWPMI_IT_TXBEIE Transmit buffer empty interrupt. SWPMI_IT_RXBFIE Receive buffer full interrupt.

Return values

The	new state of IT (TRUE or FALSE).

__HAL_SWPMI_GET_IT_SOURCE

#define __HAL_SWPMI_GET_IT_SOURCE	(		__HANDLE__,
			__IT__
	)		((READ_BIT((__HANDLE__)->Instance->IER, (__IT__)) == (__IT__)) ? SET : RESET)

Check whether the specified SWPMI interrupt source is enabled or not.

Parameters

__HANDLE__

specifies the SWPMI Handle.

__IT__

specifies the SWPMI interrupt source to check. This parameter can be one of the following values: SWPMI_IT_RDYIE Transceiver ready interrupt. SWPMI_IT_SRIE Slave resume interrupt. SWPMI_IT_TCIE Transmit complete interrupt. SWPMI_IT_TIE Transmit interrupt. SWPMI_IT_RIE Receive interrupt. SWPMI_IT_TXUNRIE Transmit underrun error interrupt. SWPMI_IT_RXOVRIE Receive overrun error interrupt. SWPMI_IT_RXBERIE Receive CRC error interrupt. SWPMI_IT_TXBEIE Transmit buffer empty interrupt. SWPMI_IT_RXBFIE Receive buffer full interrupt.

Return values

The	new state of IT (TRUE or FALSE).

__HAL_SWPMI_RESET_HANDLE_STATE

#define __HAL_SWPMI_RESET_HANDLE_STATE

(

__HANDLE__

)

((__HANDLE__)->State = HAL_SWPMI_STATE_RESET)

Reset SWPMI handle state.

Parameters

__HANDLE__

specifies the SWPMI Handle.

Return values

None

__HAL_SWPMI_TRANSCEIVER_DISABLE

#define __HAL_SWPMI_TRANSCEIVER_DISABLE

(

__HANDLE__

)

CLEAR_BIT((__HANDLE__)->Instance->CR, SWPMI_CR_SWPEN)

Disable the SWPMI transceiver.

Parameters

__HANDLE__

SWPMI handle

Return values

None

__HAL_SWPMI_TRANSCEIVER_ENABLE

#define __HAL_SWPMI_TRANSCEIVER_ENABLE

(

__HANDLE__

)

SET_BIT((__HANDLE__)->Instance->CR, SWPMI_CR_SWPEN)

Enable the SWPMI transceiver.

Parameters

__HANDLE__

SWPMI handle

Return values

None