SMARTCARD Exported Macros

Macros
#define	__HAL_SMARTCARD_RESET_HANDLE_STATE(__HANDLE__)
	Reset SMARTCARD handle states.
#define	__HAL_SMARTCARD_FLUSH_DRREGISTER(__HANDLE__)
	Flush the Smartcard Data registers.
#define	__HAL_SMARTCARD_CLEAR_FLAG(__HANDLE__, __FLAG__)   ((__HANDLE__)->Instance->ICR = (__FLAG__))
	Clear the specified SMARTCARD pending flag.
#define	__HAL_SMARTCARD_CLEAR_PEFLAG(__HANDLE__)   __HAL_SMARTCARD_CLEAR_FLAG((__HANDLE__), SMARTCARD_CLEAR_PEF)
	Clear the SMARTCARD PE pending flag.
#define	__HAL_SMARTCARD_CLEAR_FEFLAG(__HANDLE__)   __HAL_SMARTCARD_CLEAR_FLAG((__HANDLE__), SMARTCARD_CLEAR_FEF)
	Clear the SMARTCARD FE pending flag.
#define	__HAL_SMARTCARD_CLEAR_NEFLAG(__HANDLE__)   __HAL_SMARTCARD_CLEAR_FLAG((__HANDLE__), SMARTCARD_CLEAR_NEF)
	Clear the SMARTCARD NE pending flag.
#define	__HAL_SMARTCARD_CLEAR_OREFLAG(__HANDLE__)   __HAL_SMARTCARD_CLEAR_FLAG((__HANDLE__), SMARTCARD_CLEAR_OREF)
	Clear the SMARTCARD ORE pending flag.
#define	__HAL_SMARTCARD_CLEAR_IDLEFLAG(__HANDLE__)   __HAL_SMARTCARD_CLEAR_FLAG((__HANDLE__), SMARTCARD_CLEAR_IDLEF)
	Clear the SMARTCARD IDLE pending flag.
#define	__HAL_SMARTCARD_GET_FLAG(__HANDLE__, __FLAG__)   (((__HANDLE__)->Instance->ISR & (__FLAG__)) == (__FLAG__))
	Check whether the specified Smartcard flag is set or not.
#define	__HAL_SMARTCARD_ENABLE_IT(__HANDLE__, __INTERRUPT__)
	Enable the specified SmartCard interrupt.
#define	__HAL_SMARTCARD_DISABLE_IT(__HANDLE__, __INTERRUPT__)
	Disable the specified SmartCard interrupt.
#define	__HAL_SMARTCARD_GET_IT(__HANDLE__, __INTERRUPT__)
	Check whether the specified SmartCard interrupt has occurred or not.
#define	__HAL_SMARTCARD_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__)
	Check whether the specified SmartCard interrupt source is enabled or not.
#define	__HAL_SMARTCARD_CLEAR_IT(__HANDLE__, __IT_CLEAR__)   ((__HANDLE__)->Instance->ICR |= (uint32_t)(__IT_CLEAR__))
	Clear the specified SMARTCARD ISR flag, in setting the proper ICR register flag.
#define	__HAL_SMARTCARD_SEND_REQ(__HANDLE__, __REQ__)   ((__HANDLE__)->Instance->RQR |= (uint16_t)(__REQ__))
	Set a specific SMARTCARD request flag.
#define	__HAL_SMARTCARD_ONE_BIT_SAMPLE_ENABLE(__HANDLE__)   ((__HANDLE__)->Instance->CR3|= USART_CR3_ONEBIT)
	Enable the SMARTCARD one bit sample method.
#define	__HAL_SMARTCARD_ONE_BIT_SAMPLE_DISABLE(__HANDLE__)
	Disable the SMARTCARD one bit sample method.
#define	__HAL_SMARTCARD_ENABLE(__HANDLE__)   ((__HANDLE__)->Instance->CR1 |= USART_CR1_UE)
	Enable the USART associated to the SMARTCARD Handle.
#define	__HAL_SMARTCARD_DISABLE(__HANDLE__)   ((__HANDLE__)->Instance->CR1 &= ~USART_CR1_UE)
	Disable the USART associated to the SMARTCARD Handle.

Detailed Description

Macro Definition Documentation

__HAL_SMARTCARD_CLEAR_FEFLAG

#define __HAL_SMARTCARD_CLEAR_FEFLAG

(

__HANDLE__

)

__HAL_SMARTCARD_CLEAR_FLAG((__HANDLE__), SMARTCARD_CLEAR_FEF)

Clear the SMARTCARD FE pending flag.

Parameters

__HANDLE__

specifies the SMARTCARD Handle.

Return values

None

__HAL_SMARTCARD_CLEAR_FLAG

#define __HAL_SMARTCARD_CLEAR_FLAG	(		__HANDLE__,
			__FLAG__
	)		((__HANDLE__)->Instance->ICR = (__FLAG__))

Clear the specified SMARTCARD pending flag.

Parameters

__HANDLE__

specifies the SMARTCARD Handle.

__FLAG__

specifies the flag to check. This parameter can be any combination of the following values: SMARTCARD_CLEAR_PEF Parity error clear flag SMARTCARD_CLEAR_FEF Framing error clear flag SMARTCARD_CLEAR_NEF Noise detected clear flag SMARTCARD_CLEAR_OREF OverRun error clear flag SMARTCARD_CLEAR_IDLEF Idle line detected clear flag SMARTCARD_CLEAR_TCF Transmission complete clear flag SMARTCARD_CLEAR_TCBGTF Transmission complete before guard time clear flag SMARTCARD_CLEAR_RTOF Receiver timeout clear flag SMARTCARD_CLEAR_EOBF End of block clear flag SMARTCARD_CLEAR_TXFECF TXFIFO empty Clear flag

Return values

None

__HAL_SMARTCARD_CLEAR_IDLEFLAG

#define __HAL_SMARTCARD_CLEAR_IDLEFLAG

(

__HANDLE__

)

__HAL_SMARTCARD_CLEAR_FLAG((__HANDLE__), SMARTCARD_CLEAR_IDLEF)

Clear the SMARTCARD IDLE pending flag.

Parameters

__HANDLE__

specifies the SMARTCARD Handle.

Return values

None

__HAL_SMARTCARD_CLEAR_IT

#define __HAL_SMARTCARD_CLEAR_IT	(		__HANDLE__,
			__IT_CLEAR__
	)		((__HANDLE__)->Instance->ICR |= (uint32_t)(__IT_CLEAR__))

Clear the specified SMARTCARD ISR flag, in setting the proper ICR register flag.

Parameters

__HANDLE__

specifies the SMARTCARD Handle.

__IT_CLEAR__

specifies the interrupt clear register flag that needs to be set to clear the corresponding interrupt. This parameter can be one of the following values: SMARTCARD_CLEAR_PEF Parity error clear flag SMARTCARD_CLEAR_FEF Framing error clear flag SMARTCARD_CLEAR_NEF Noise detected clear flag SMARTCARD_CLEAR_OREF OverRun error clear flag SMARTCARD_CLEAR_IDLEF Idle line detection clear flag SMARTCARD_CLEAR_TXFECF TXFIFO empty Clear Flag SMARTCARD_CLEAR_TCF Transmission complete clear flag SMARTCARD_CLEAR_TCBGTF Transmission complete before guard time clear flag (when flag available) SMARTCARD_CLEAR_RTOF Receiver timeout clear flag SMARTCARD_CLEAR_EOBF End of block clear flag

Return values

None

__HAL_SMARTCARD_CLEAR_NEFLAG

#define __HAL_SMARTCARD_CLEAR_NEFLAG

(

__HANDLE__

)

__HAL_SMARTCARD_CLEAR_FLAG((__HANDLE__), SMARTCARD_CLEAR_NEF)

Clear the SMARTCARD NE pending flag.

Parameters

__HANDLE__

specifies the SMARTCARD Handle.

Return values

None

__HAL_SMARTCARD_CLEAR_OREFLAG

#define __HAL_SMARTCARD_CLEAR_OREFLAG

(

__HANDLE__

)

__HAL_SMARTCARD_CLEAR_FLAG((__HANDLE__), SMARTCARD_CLEAR_OREF)

Clear the SMARTCARD ORE pending flag.

Parameters

__HANDLE__

specifies the SMARTCARD Handle.

Return values

None

__HAL_SMARTCARD_CLEAR_PEFLAG

#define __HAL_SMARTCARD_CLEAR_PEFLAG

(

__HANDLE__

)

__HAL_SMARTCARD_CLEAR_FLAG((__HANDLE__), SMARTCARD_CLEAR_PEF)

Clear the SMARTCARD PE pending flag.

Parameters

__HANDLE__

specifies the SMARTCARD Handle.

Return values

None

__HAL_SMARTCARD_DISABLE

#define __HAL_SMARTCARD_DISABLE

(

__HANDLE__

)

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

Disable the USART associated to the SMARTCARD Handle.

Parameters

__HANDLE__

specifies the SMARTCARD Handle.

Return values

None

__HAL_SMARTCARD_DISABLE_IT

#define __HAL_SMARTCARD_DISABLE_IT	(		__HANDLE__,
			__INTERRUPT__
	)

Value:

                                                                  (((((__INTERRUPT__) & SMARTCARD_CR_MASK) >>\
                                                                  SMARTCARD_CR_POS) == 1U)?\
                                                                ((__HANDLE__)->Instance->CR1 &= ~ (1U <<\
                                                                    ((__INTERRUPT__) & SMARTCARD_IT_MASK))): \
                                                                ((((__INTERRUPT__) & SMARTCARD_CR_MASK) >>\
                                                                  SMARTCARD_CR_POS) == 2U)?\
                                                                ((__HANDLE__)->Instance->CR2 &= ~ (1U <<\
                                                                    ((__INTERRUPT__) & SMARTCARD_IT_MASK))): \
                                                                ((__HANDLE__)->Instance->CR3 &= ~ (1U <<\
                                                                    ((__INTERRUPT__) & SMARTCARD_IT_MASK))))

Disable the specified SmartCard interrupt.

Parameters

__HANDLE__

specifies the SMARTCARD Handle.

__INTERRUPT__

specifies the SMARTCARD interrupt to disable. This parameter can be one of the following values: SMARTCARD_IT_EOB End of block interrupt SMARTCARD_IT_RTO Receive timeout interrupt SMARTCARD_IT_TXE Transmit data register empty interrupt SMARTCARD_IT_TC Transmission complete interrupt SMARTCARD_IT_TCBGT Transmission complete before guard time interrupt (when interruption available) SMARTCARD_IT_RXNE Receive data register not empty interrupt SMARTCARD_IT_IDLE Idle line detection interrupt SMARTCARD_IT_PE Parity error interrupt SMARTCARD_IT_ERR Error interrupt(frame error, noise error, overrun error) SMARTCARD_IT_TXFNF TX FIFO not full interruption SMARTCARD_IT_RXFNE RXFIFO not empty interruption SMARTCARD_IT_RXFF RXFIFO full interruption SMARTCARD_IT_TXFE TXFIFO empty interruption SMARTCARD_IT_RXFT RXFIFO threshold reached interruption SMARTCARD_IT_TXFT TXFIFO threshold reached interruption

Return values

None

__HAL_SMARTCARD_ENABLE

#define __HAL_SMARTCARD_ENABLE

(

__HANDLE__

)

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

Enable the USART associated to the SMARTCARD Handle.

Parameters

__HANDLE__

specifies the SMARTCARD Handle.

Return values

None

__HAL_SMARTCARD_ENABLE_IT

#define __HAL_SMARTCARD_ENABLE_IT	(		__HANDLE__,
			__INTERRUPT__
	)

Value:

                                                                  (((((__INTERRUPT__) & SMARTCARD_CR_MASK) >>\
                                                                  SMARTCARD_CR_POS) == 1U)?\
                                                                ((__HANDLE__)->Instance->CR1 |= (1UL <<\
                                                                    ((__INTERRUPT__) & SMARTCARD_IT_MASK))):\
                                                                ((((__INTERRUPT__) & SMARTCARD_CR_MASK) >>\
                                                                  SMARTCARD_CR_POS) == 2U)?\
                                                                ((__HANDLE__)->Instance->CR2 |= (1UL <<\
                                                                    ((__INTERRUPT__) & SMARTCARD_IT_MASK))): \
                                                                ((__HANDLE__)->Instance->CR3 |= (1UL <<\
                                                                    ((__INTERRUPT__) & SMARTCARD_IT_MASK))))

Enable the specified SmartCard interrupt.

Parameters

__HANDLE__

specifies the SMARTCARD Handle.

__INTERRUPT__

specifies the SMARTCARD interrupt to enable. This parameter can be one of the following values: SMARTCARD_IT_EOB End of block interrupt SMARTCARD_IT_RTO Receive timeout interrupt SMARTCARD_IT_TXE Transmit data register empty interrupt SMARTCARD_IT_TC Transmission complete interrupt SMARTCARD_IT_TCBGT Transmission complete before guard time interrupt (when interruption available) SMARTCARD_IT_RXNE Receive data register not empty interrupt SMARTCARD_IT_IDLE Idle line detection interrupt SMARTCARD_IT_PE Parity error interrupt SMARTCARD_IT_ERR Error interrupt(frame error, noise error, overrun error) SMARTCARD_IT_TXFNF TX FIFO not full interruption SMARTCARD_IT_RXFNE RXFIFO not empty interruption SMARTCARD_IT_RXFF RXFIFO full interruption SMARTCARD_IT_TXFE TXFIFO empty interruption SMARTCARD_IT_RXFT RXFIFO threshold reached interruption SMARTCARD_IT_TXFT TXFIFO threshold reached interruption

Return values

None

__HAL_SMARTCARD_FLUSH_DRREGISTER

#define __HAL_SMARTCARD_FLUSH_DRREGISTER

(

__HANDLE__

)

Value:

  do{                                                                     \
    SET_BIT((__HANDLE__)->Instance->RQR, SMARTCARD_RXDATA_FLUSH_REQUEST); \
    SET_BIT((__HANDLE__)->Instance->RQR, SMARTCARD_TXDATA_FLUSH_REQUEST); \
  } while(0U)

Flush the Smartcard Data registers.

Parameters

__HANDLE__

specifies the SMARTCARD Handle.

Return values

None

__HAL_SMARTCARD_GET_FLAG

#define __HAL_SMARTCARD_GET_FLAG	(		__HANDLE__,
			__FLAG__
	)		(((__HANDLE__)->Instance->ISR & (__FLAG__)) == (__FLAG__))

Check whether the specified Smartcard flag is set or not.

Parameters

__HANDLE__

specifies the SMARTCARD Handle.

__FLAG__

specifies the flag to check. This parameter can be one of the following values: SMARTCARD_FLAG_TCBGT Transmission complete before guard time flag (when flag available) SMARTCARD_FLAG_REACK Receive enable acknowledge flag SMARTCARD_FLAG_TEACK Transmit enable acknowledge flag SMARTCARD_FLAG_BUSY Busy flag SMARTCARD_FLAG_EOBF End of block flag SMARTCARD_FLAG_RTOF Receiver timeout flag SMARTCARD_FLAG_TXE Transmit data register empty flag SMARTCARD_FLAG_TC Transmission complete flag SMARTCARD_FLAG_RXNE Receive data register not empty flag SMARTCARD_FLAG_IDLE Idle line detection flag SMARTCARD_FLAG_ORE Overrun error flag SMARTCARD_FLAG_NE Noise error flag SMARTCARD_FLAG_FE Framing error flag SMARTCARD_FLAG_PE Parity error flag SMARTCARD_FLAG_TXFNF TXFIFO not full flag SMARTCARD_FLAG_RXFNE RXFIFO not empty flag SMARTCARD_FLAG_TXFE TXFIFO Empty flag SMARTCARD_FLAG_RXFF RXFIFO Full flag SMARTCARD_FLAG_RXFT SMARTCARD RXFIFO threshold flag SMARTCARD_FLAG_TXFT SMARTCARD TXFIFO threshold flag

Return values

The	new state of FLAG (TRUE or FALSE).

__HAL_SMARTCARD_GET_IT

#define __HAL_SMARTCARD_GET_IT	(		__HANDLE__,
			__INTERRUPT__
	)

Value:

                                                           (\
                                                           (((__HANDLE__)->Instance->ISR & (0x01UL << (((__INTERRUPT__)\
                                                               & SMARTCARD_ISR_MASK)>> SMARTCARD_ISR_POS)))!= 0U)\
                                                           ? SET : RESET)

Check whether the specified SmartCard interrupt has occurred or not.

Parameters

__HANDLE__

specifies the SMARTCARD Handle.

__INTERRUPT__

specifies the SMARTCARD interrupt to check. This parameter can be one of the following values: SMARTCARD_IT_EOB End of block interrupt SMARTCARD_IT_RTO Receive timeout interrupt SMARTCARD_IT_TXE Transmit data register empty interrupt SMARTCARD_IT_TC Transmission complete interrupt SMARTCARD_IT_TCBGT Transmission complete before guard time interrupt (when interruption available) SMARTCARD_IT_RXNE Receive data register not empty interrupt SMARTCARD_IT_IDLE Idle line detection interrupt SMARTCARD_IT_PE Parity error interrupt SMARTCARD_IT_ERR Error interrupt(frame error, noise error, overrun error) SMARTCARD_IT_TXFNF TX FIFO not full interruption SMARTCARD_IT_RXFNE RXFIFO not empty interruption SMARTCARD_IT_RXFF RXFIFO full interruption SMARTCARD_IT_TXFE TXFIFO empty interruption SMARTCARD_IT_RXFT RXFIFO threshold reached interruption SMARTCARD_IT_TXFT TXFIFO threshold reached interruption

Return values

The	new state of INTERRUPT (SET or RESET).

__HAL_SMARTCARD_GET_IT_SOURCE

#define __HAL_SMARTCARD_GET_IT_SOURCE	(		__HANDLE__,
			__INTERRUPT__
	)

Value:

                                                                       ((((((((__INTERRUPT__) & SMARTCARD_CR_MASK) >>\
                                                                       SMARTCARD_CR_POS) == 0x01U)?\
                                                                     (__HANDLE__)->Instance->CR1 : \
                                                                     (((((__INTERRUPT__) & SMARTCARD_CR_MASK) >>\
                                                                        SMARTCARD_CR_POS) == 0x02U)?\
                                                                      (__HANDLE__)->Instance->CR2 : \
                                                                      (__HANDLE__)->Instance->CR3)) &\
                                                                    (0x01UL << (((uint16_t)(__INTERRUPT__))\
                                                                                & SMARTCARD_IT_MASK)))  != 0U)\
                                                                  ? SET : RESET)

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

Parameters

__HANDLE__

specifies the SMARTCARD Handle.

__INTERRUPT__

specifies the SMARTCARD interrupt source to check. This parameter can be one of the following values: SMARTCARD_IT_EOB End of block interrupt SMARTCARD_IT_RTO Receive timeout interrupt SMARTCARD_IT_TXE Transmit data register empty interrupt SMARTCARD_IT_TC Transmission complete interrupt SMARTCARD_IT_TCBGT Transmission complete before guard time interrupt (when interruption available) SMARTCARD_IT_RXNE Receive data register not empty interrupt SMARTCARD_IT_IDLE Idle line detection interrupt SMARTCARD_IT_PE Parity error interrupt SMARTCARD_IT_ERR Error interrupt(frame error, noise error, overrun error) SMARTCARD_IT_TXFNF TX FIFO not full interruption SMARTCARD_IT_RXFNE RXFIFO not empty interruption SMARTCARD_IT_RXFF RXFIFO full interruption SMARTCARD_IT_TXFE TXFIFO empty interruption SMARTCARD_IT_RXFT RXFIFO threshold reached interruption SMARTCARD_IT_TXFT TXFIFO threshold reached interruption

Return values

The	new state of INTERRUPT (SET or RESET).

__HAL_SMARTCARD_ONE_BIT_SAMPLE_DISABLE

#define __HAL_SMARTCARD_ONE_BIT_SAMPLE_DISABLE

(

__HANDLE__

)

Value:

                                                            ((__HANDLE__)->Instance->CR3\
                                                            &= (uint32_t)~((uint32_t)USART_CR3_ONEBIT))

Disable the SMARTCARD one bit sample method.

Parameters

__HANDLE__

specifies the SMARTCARD Handle.

Return values

None

__HAL_SMARTCARD_ONE_BIT_SAMPLE_ENABLE

#define __HAL_SMARTCARD_ONE_BIT_SAMPLE_ENABLE

(

__HANDLE__

)

((__HANDLE__)->Instance->CR3|= USART_CR3_ONEBIT)

Enable the SMARTCARD one bit sample method.

Parameters

__HANDLE__

specifies the SMARTCARD Handle.

Return values

None

__HAL_SMARTCARD_RESET_HANDLE_STATE

#define __HAL_SMARTCARD_RESET_HANDLE_STATE

(

__HANDLE__

)

Value:

                                                            do{                                                       \
                                                            (__HANDLE__)->gState = HAL_SMARTCARD_STATE_RESET;     \
                                                            (__HANDLE__)->RxState = HAL_SMARTCARD_STATE_RESET;    \
                                                          } while(0U)

Reset SMARTCARD handle states.

Parameters

__HANDLE__

SMARTCARD handle.

Return values

None

__HAL_SMARTCARD_SEND_REQ

#define __HAL_SMARTCARD_SEND_REQ	(		__HANDLE__,
			__REQ__
	)		((__HANDLE__)->Instance->RQR |= (uint16_t)(__REQ__))

Set a specific SMARTCARD request flag.

Parameters

__HANDLE__	specifies the SMARTCARD Handle.
__REQ__	specifies the request flag to set This parameter can be one of the following values: SMARTCARD_RXDATA_FLUSH_REQUEST Receive data flush Request SMARTCARD_TXDATA_FLUSH_REQUEST Transmit data flush Request

Return values

None