STM32F479xx HAL User Manual
Defines
SMARTCARD Exported Macros
SMARTCARD

Defines

#define __HAL_SMARTCARD_RESET_HANDLE_STATE(__HANDLE__)
 Reset SMARTCARD handle gstate & RxState.
#define __HAL_SMARTCARD_FLUSH_DRREGISTER(__HANDLE__)   ((__HANDLE__)->Instance->DR)
 Flush the Smartcard DR register.
#define __HAL_SMARTCARD_GET_FLAG(__HANDLE__, __FLAG__)   (((__HANDLE__)->Instance->SR & (__FLAG__)) == (__FLAG__))
 Check whether the specified Smartcard flag is set or not.
#define __HAL_SMARTCARD_CLEAR_FLAG(__HANDLE__, __FLAG__)   ((__HANDLE__)->Instance->SR = ~(__FLAG__))
 Clear the specified Smartcard pending flags.
#define __HAL_SMARTCARD_CLEAR_PEFLAG(__HANDLE__)
 Clear the SMARTCARD PE pending flag.
#define __HAL_SMARTCARD_CLEAR_FEFLAG(__HANDLE__)   __HAL_SMARTCARD_CLEAR_PEFLAG(__HANDLE__)
 Clear the SMARTCARD FE pending flag.
#define __HAL_SMARTCARD_CLEAR_NEFLAG(__HANDLE__)   __HAL_SMARTCARD_CLEAR_PEFLAG(__HANDLE__)
 Clear the SMARTCARD NE pending flag.
#define __HAL_SMARTCARD_CLEAR_OREFLAG(__HANDLE__)   __HAL_SMARTCARD_CLEAR_PEFLAG(__HANDLE__)
 Clear the SMARTCARD ORE pending flag.
#define __HAL_SMARTCARD_CLEAR_IDLEFLAG(__HANDLE__)   __HAL_SMARTCARD_CLEAR_PEFLAG(__HANDLE__)
 Clear the SMARTCARD IDLE pending flag.
#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_SOURCE(__HANDLE__, __IT__)   (((((__IT__) >> 28U) == SMARTCARD_CR1_REG_INDEX)? (__HANDLE__)->Instance->CR1: (__HANDLE__)->Instance->CR3) & (((uint32_t)(__IT__)) & SMARTCARD_IT_MASK))
 Checks whether the specified SmartCard interrupt has occurred or not.
#define __HAL_SMARTCARD_ONE_BIT_SAMPLE_ENABLE(__HANDLE__)   ((__HANDLE__)->Instance->CR3|= USART_CR3_ONEBIT)
 Macro to enable the SMARTCARD's one bit sample method.
#define __HAL_SMARTCARD_ONE_BIT_SAMPLE_DISABLE(__HANDLE__)   ((__HANDLE__)->Instance->CR3 &= (uint16_t)~((uint16_t)USART_CR3_ONEBIT))
 Macro to disable the SMARTCARD's 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.
#define __HAL_SMARTCARD_DMA_REQUEST_ENABLE(__HANDLE__, __REQUEST__)   ((__HANDLE__)->Instance->CR3 |= (__REQUEST__))
 Macros to enable the SmartCard DMA request.
#define __HAL_SMARTCARD_DMA_REQUEST_DISABLE(__HANDLE__, __REQUEST__)   ((__HANDLE__)->Instance->CR3 &= ~(__REQUEST__))
 Macros to disable the SmartCard DMA request.

Define Documentation

#define __HAL_SMARTCARD_CLEAR_FEFLAG (   __HANDLE__)    __HAL_SMARTCARD_CLEAR_PEFLAG(__HANDLE__)

Clear the SMARTCARD FE pending flag.

Parameters:
__HANDLE__specifies the USART Handle. SMARTCARD Handle selects the USARTx peripheral (USART availability and x value depending on device).
Return values:
None

Definition at line 500 of file stm32f4xx_hal_smartcard.h.

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

Clear the specified Smartcard pending flags.

Parameters:
__HANDLE__specifies the SMARTCARD Handle. SMARTCARD Handle selects the USARTx peripheral (USART availability and x value depending on device).
__FLAG__specifies the flag to check. This parameter can be any combination of the following values:
  • SMARTCARD_FLAG_TC: Transmission Complete flag.
  • SMARTCARD_FLAG_RXNE: Receive data register not empty flag.
Note:
PE (Parity error), FE (Framing error), NE (Noise error) and ORE (Overrun error) flags are cleared by software sequence: a read operation to USART_SR register followed by a read operation to USART_DR register.
RXNE flag can be also cleared by a read to the USART_DR register.
TC flag can be also cleared by software sequence: a read operation to USART_SR register followed by a write operation to USART_DR register.
TXE flag is cleared only by a write to the USART_DR register.
Return values:
None

Definition at line 480 of file stm32f4xx_hal_smartcard.h.

Referenced by HAL_SMARTCARD_Transmit_DMA().

#define __HAL_SMARTCARD_CLEAR_IDLEFLAG (   __HANDLE__)    __HAL_SMARTCARD_CLEAR_PEFLAG(__HANDLE__)

Clear the SMARTCARD IDLE pending flag.

Parameters:
__HANDLE__specifies the USART Handle. SMARTCARD Handle selects the USARTx peripheral (USART availability and x value depending on device).
Return values:
None

Definition at line 521 of file stm32f4xx_hal_smartcard.h.

#define __HAL_SMARTCARD_CLEAR_NEFLAG (   __HANDLE__)    __HAL_SMARTCARD_CLEAR_PEFLAG(__HANDLE__)

Clear the SMARTCARD NE pending flag.

Parameters:
__HANDLE__specifies the USART Handle. SMARTCARD Handle selects the USARTx peripheral (USART availability and x value depending on device).
Return values:
None

Definition at line 507 of file stm32f4xx_hal_smartcard.h.

#define __HAL_SMARTCARD_CLEAR_OREFLAG (   __HANDLE__)    __HAL_SMARTCARD_CLEAR_PEFLAG(__HANDLE__)

Clear the SMARTCARD ORE pending flag.

Parameters:
__HANDLE__specifies the USART Handle. SMARTCARD Handle selects the USARTx peripheral (USART availability and x value depending on device).
Return values:
None

Definition at line 514 of file stm32f4xx_hal_smartcard.h.

Referenced by HAL_SMARTCARD_Receive_DMA().

#define __HAL_SMARTCARD_CLEAR_PEFLAG (   __HANDLE__)
Value:
do{                                           \
      __IO uint32_t tmpreg = 0x00U;               \
      tmpreg = (__HANDLE__)->Instance->SR;        \
      tmpreg = (__HANDLE__)->Instance->DR;        \
      UNUSED(tmpreg);                             \
    } while(0U)

Clear the SMARTCARD PE pending flag.

Parameters:
__HANDLE__specifies the USART Handle. SMARTCARD Handle selects the USARTx peripheral (USART availability and x value depending on device).
Return values:
None

Definition at line 487 of file stm32f4xx_hal_smartcard.h.

#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. SMARTCARD Handle selects the USARTx peripheral (USART availability and x value depending on device).
Return values:
None

Definition at line 593 of file stm32f4xx_hal_smartcard.h.

Referenced by HAL_SMARTCARD_DeInit().

#define __HAL_SMARTCARD_DISABLE_IT (   __HANDLE__,
  __INTERRUPT__ 
)
Value:
((((__INTERRUPT__) >> 28U) == SMARTCARD_CR1_REG_INDEX)? ((__HANDLE__)->Instance->CR1 &= ~((__INTERRUPT__) & SMARTCARD_IT_MASK)): \
                                                                 ((__HANDLE__)->Instance->CR3 &= ~ ((__INTERRUPT__) & SMARTCARD_IT_MASK)))

Disable the specified SmartCard interrupt.

Parameters:
__HANDLE__specifies the SMARTCARD Handle. SMARTCARD Handle selects the USARTx peripheral (USART availability and x value depending on device).
__INTERRUPT__specifies the SMARTCARD interrupt to disable. This parameter can be one of the following values:
  • SMARTCARD_IT_TXE: Transmit Data Register empty interrupt
  • SMARTCARD_IT_TC: Transmission complete interrupt
  • 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)
Return values:
None

Definition at line 552 of file stm32f4xx_hal_smartcard.h.

#define __HAL_SMARTCARD_DMA_REQUEST_DISABLE (   __HANDLE__,
  __REQUEST__ 
)    ((__HANDLE__)->Instance->CR3 &= ~(__REQUEST__))

Macros to disable the SmartCard DMA request.

Parameters:
__HANDLE__specifies the SmartCard Handle.
__REQUEST__specifies the SmartCard DMA request. This parameter can be one of the following values:
  • SMARTCARD_DMAREQ_TX: SmartCard DMA transmit request
  • SMARTCARD_DMAREQ_RX: SmartCard DMA receive request
Return values:
None

Definition at line 613 of file stm32f4xx_hal_smartcard.h.

#define __HAL_SMARTCARD_DMA_REQUEST_ENABLE (   __HANDLE__,
  __REQUEST__ 
)    ((__HANDLE__)->Instance->CR3 |= (__REQUEST__))

Macros to enable the SmartCard DMA request.

Parameters:
__HANDLE__specifies the SmartCard Handle.
__REQUEST__specifies the SmartCard DMA request. This parameter can be one of the following values:
  • SMARTCARD_DMAREQ_TX: SmartCard DMA transmit request
  • SMARTCARD_DMAREQ_RX: SmartCard DMA receive request
Return values:
None

Definition at line 603 of file stm32f4xx_hal_smartcard.h.

#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. SMARTCARD Handle selects the USARTx peripheral (USART availability and x value depending on device).
Return values:
None

Definition at line 586 of file stm32f4xx_hal_smartcard.h.

Referenced by HAL_SMARTCARD_Init().

#define __HAL_SMARTCARD_ENABLE_IT (   __HANDLE__,
  __INTERRUPT__ 
)
Value:
((((__INTERRUPT__) >> 28U) == SMARTCARD_CR1_REG_INDEX)? ((__HANDLE__)->Instance->CR1 |= ((__INTERRUPT__) & SMARTCARD_IT_MASK)): \
                                                                 ((__HANDLE__)->Instance->CR3 |= ((__INTERRUPT__) & SMARTCARD_IT_MASK)))

Enable the specified SmartCard interrupt.

Parameters:
__HANDLE__specifies the SMARTCARD Handle. SMARTCARD Handle selects the USARTx peripheral (USART availability and x value depending on device).
__INTERRUPT__specifies the SMARTCARD interrupt to enable. This parameter can be one of the following values:
  • SMARTCARD_IT_TXE: Transmit Data Register empty interrupt
  • SMARTCARD_IT_TC: Transmission complete interrupt
  • 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)
Return values:
None

Definition at line 536 of file stm32f4xx_hal_smartcard.h.

#define __HAL_SMARTCARD_FLUSH_DRREGISTER (   __HANDLE__)    ((__HANDLE__)->Instance->DR)

Flush the Smartcard DR register.

Parameters:
__HANDLE__specifies the SMARTCARD Handle. SMARTCARD Handle selects the USARTx peripheral (USART availability and x value depending on device).
Return values:
None

Definition at line 444 of file stm32f4xx_hal_smartcard.h.

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

Check whether the specified Smartcard flag is set or not.

Parameters:
__HANDLE__specifies the SMARTCARD Handle. SMARTCARD Handle selects the USARTx peripheral (USART availability and x value depending on device).
__FLAG__specifies the flag to check. This parameter can be one of the following values:
  • 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
Return values:
Thenew state of __FLAG__ (TRUE or FALSE).

Definition at line 461 of file stm32f4xx_hal_smartcard.h.

Referenced by SMARTCARD_WaitOnFlagUntilTimeout().

#define __HAL_SMARTCARD_GET_IT_SOURCE (   __HANDLE__,
  __IT__ 
)    (((((__IT__) >> 28U) == SMARTCARD_CR1_REG_INDEX)? (__HANDLE__)->Instance->CR1: (__HANDLE__)->Instance->CR3) & (((uint32_t)(__IT__)) & SMARTCARD_IT_MASK))

Checks whether the specified SmartCard interrupt has occurred or not.

Parameters:
__HANDLE__specifies the SmartCard Handle.
__IT__specifies the SMARTCARD interrupt source to check. This parameter can be one of the following values:
  • SMARTCARD_IT_TXE: Transmit Data Register empty interrupt
  • SMARTCARD_IT_TC: Transmission complete interrupt
  • SMARTCARD_IT_RXNE: Receive Data register not empty interrupt
  • SMARTCARD_IT_IDLE: Idle line detection interrupt
  • SMARTCARD_IT_ERR: Error interrupt
  • SMARTCARD_IT_PE: Parity Error interrupt
Return values:
Thenew state of __IT__ (TRUE or FALSE).

Definition at line 567 of file stm32f4xx_hal_smartcard.h.

#define __HAL_SMARTCARD_ONE_BIT_SAMPLE_DISABLE (   __HANDLE__)    ((__HANDLE__)->Instance->CR3 &= (uint16_t)~((uint16_t)USART_CR3_ONEBIT))

Macro to disable the SMARTCARD's one bit sample method.

Parameters:
__HANDLE__specifies the SMARTCARD Handle.
Return values:
None

Definition at line 579 of file stm32f4xx_hal_smartcard.h.

#define __HAL_SMARTCARD_ONE_BIT_SAMPLE_ENABLE (   __HANDLE__)    ((__HANDLE__)->Instance->CR3|= USART_CR3_ONEBIT)

Macro to enable the SMARTCARD's one bit sample method.

Parameters:
__HANDLE__specifies the SMARTCARD Handle.
Return values:
None

Definition at line 573 of file stm32f4xx_hal_smartcard.h.

#define __HAL_SMARTCARD_RESET_HANDLE_STATE (   __HANDLE__)
Value:
do{                                                       \
                                                           (__HANDLE__)->gState = HAL_SMARTCARD_STATE_RESET;      \
                                                           (__HANDLE__)->RxState = HAL_SMARTCARD_STATE_RESET;     \
                                                           (__HANDLE__)->MspInitCallback = NULL;                  \
                                                           (__HANDLE__)->MspDeInitCallback = NULL;                \
                                                          } while(0U)

Reset SMARTCARD handle gstate & RxState.

Parameters:
__HANDLE__specifies the SMARTCARD Handle. SMARTCARD Handle selects the USARTx peripheral (USART availability and x value depending on device).
Return values:
None

Definition at line 426 of file stm32f4xx_hal_smartcard.h.

Generated on Fri Jul 16 2021 16:03:58 for STM32F479xx HAL User Manual by   doxygen 1.7.6.1