STM32L486xx HAL User Manual
Data Structures | Typedefs | Enumerations
SMARTCARD Exported Types
SMARTCARD

Data Structures

struct  SMARTCARD_InitTypeDef
 SMARTCARD Init Structure definition. More...
struct  SMARTCARD_AdvFeatureInitTypeDef
 SMARTCARD advanced features initalization structure definition. More...
struct  __SMARTCARD_HandleTypeDef
 SMARTCARD handle Structure definition. More...

Typedefs

typedef struct
__SMARTCARD_HandleTypeDef 
SMARTCARD_HandleTypeDef
 SMARTCARD handle Structure definition.
typedef void(* pSMARTCARD_CallbackTypeDef )(SMARTCARD_HandleTypeDef *hsmartcard)
 HAL SMARTCARD Callback pointer definition.

Enumerations

enum  HAL_SMARTCARD_StateTypeDef {
  HAL_SMARTCARD_STATE_RESET = 0x00U, HAL_SMARTCARD_STATE_READY = 0x20U, HAL_SMARTCARD_STATE_BUSY = 0x24U, HAL_SMARTCARD_STATE_BUSY_TX = 0x21U,
  HAL_SMARTCARD_STATE_BUSY_RX = 0x22U, HAL_SMARTCARD_STATE_BUSY_TX_RX = 0x23U, HAL_SMARTCARD_STATE_TIMEOUT = 0xA0U, HAL_SMARTCARD_STATE_ERROR = 0xE0U
}
 HAL SMARTCARD State structures definition. More...
enum  HAL_SMARTCARD_CallbackIDTypeDef {
  HAL_SMARTCARD_TX_COMPLETE_CB_ID = 0x00U, HAL_SMARTCARD_RX_COMPLETE_CB_ID = 0x01U, HAL_SMARTCARD_ERROR_CB_ID = 0x02U, HAL_SMARTCARD_ABORT_COMPLETE_CB_ID = 0x03U,
  HAL_SMARTCARD_ABORT_TRANSMIT_COMPLETE_CB_ID = 0x04U, HAL_SMARTCARD_ABORT_RECEIVE_COMPLETE_CB_ID = 0x05U, HAL_SMARTCARD_RX_FIFO_FULL_CB_ID = 0x06U, HAL_SMARTCARD_TX_FIFO_EMPTY_CB_ID = 0x07U,
  HAL_SMARTCARD_MSPINIT_CB_ID = 0x08U, HAL_SMARTCARD_MSPDEINIT_CB_ID = 0x09U
}
 HAL SMARTCARD Callback ID enumeration definition. More...
enum  SMARTCARD_ClockSourceTypeDef {
  SMARTCARD_CLOCKSOURCE_PCLK1 = 0x00, SMARTCARD_CLOCKSOURCE_PCLK2 = 0x01, SMARTCARD_CLOCKSOURCE_HSI = 0x02, SMARTCARD_CLOCKSOURCE_SYSCLK = 0x04,
  SMARTCARD_CLOCKSOURCE_LSE = 0x08, SMARTCARD_CLOCKSOURCE_UNDEFINED = 0x10
}
 SMARTCARD clock sources. More...

Typedef Documentation

HAL SMARTCARD Callback pointer definition.

pointer to an SMARTCARD callback function

Definition at line 326 of file stm32l4xx_hal_smartcard.h.

SMARTCARD handle Structure definition.


Enumeration Type Documentation

HAL SMARTCARD Callback ID enumeration definition.

Enumerator:
HAL_SMARTCARD_TX_COMPLETE_CB_ID 

SMARTCARD Tx Complete Callback ID

HAL_SMARTCARD_RX_COMPLETE_CB_ID 

SMARTCARD Rx Complete Callback ID

HAL_SMARTCARD_ERROR_CB_ID 

SMARTCARD Error Callback ID

HAL_SMARTCARD_ABORT_COMPLETE_CB_ID 

SMARTCARD Abort Complete Callback ID

HAL_SMARTCARD_ABORT_TRANSMIT_COMPLETE_CB_ID 

SMARTCARD Abort Transmit Complete Callback ID

HAL_SMARTCARD_ABORT_RECEIVE_COMPLETE_CB_ID 

SMARTCARD Abort Receive Complete Callback ID

HAL_SMARTCARD_RX_FIFO_FULL_CB_ID 

SMARTCARD Rx Fifo Full Callback ID

HAL_SMARTCARD_TX_FIFO_EMPTY_CB_ID 

SMARTCARD Tx Fifo Empty Callback ID

HAL_SMARTCARD_MSPINIT_CB_ID 

SMARTCARD MspInit callback ID

HAL_SMARTCARD_MSPDEINIT_CB_ID 

SMARTCARD MspDeInit callback ID

Definition at line 307 of file stm32l4xx_hal_smartcard.h.

HAL SMARTCARD State structures definition.

Note:
HAL SMARTCARD State value is a combination of 2 different substates: gState and RxState.
  • gState contains SMARTCARD state information related to global Handle management and also information related to Tx operations. gState value coding follow below described bitmap : b7-b6 Error information 00 : No Error 01 : (Not Used) 10 : Timeout 11 : Error b5 IP initilisation status 0 : Reset (IP not initialized) 1 : Init done (IP not initialized. HAL SMARTCARD Init function already called) b4-b3 (not used) xx : Should be set to 00 b2 Intrinsic process state 0 : Ready 1 : Busy (IP busy with some configuration or internal operations) b1 (not used) x : Should be set to 0 b0 Tx state 0 : Ready (no Tx operation ongoing) 1 : Busy (Tx operation ongoing)
  • RxState contains information related to Rx operations. RxState value coding follow below described bitmap : b7-b6 (not used) xx : Should be set to 00 b5 IP initilisation status 0 : Reset (IP not initialized) 1 : Init done (IP not initialized) b4-b2 (not used) xxx : Should be set to 000 b1 Rx state 0 : Ready (no Rx operation ongoing) 1 : Busy (Rx operation ongoing) b0 (not used) x : Should be set to 0.
Enumerator:
HAL_SMARTCARD_STATE_RESET 

Peripheral is not initialized Value is allowed for gState and RxState

HAL_SMARTCARD_STATE_READY 

Peripheral Initialized and ready for use Value is allowed for gState and RxState

HAL_SMARTCARD_STATE_BUSY 

an internal process is ongoing Value is allowed for gState only

HAL_SMARTCARD_STATE_BUSY_TX 

Data Transmission process is ongoing Value is allowed for gState only

HAL_SMARTCARD_STATE_BUSY_RX 

Data Reception process is ongoing Value is allowed for RxState only

HAL_SMARTCARD_STATE_BUSY_TX_RX 

Data Transmission and Reception process is ongoing Not to be used for neither gState nor RxState. Value is result of combination (Or) between gState and RxState values

HAL_SMARTCARD_STATE_TIMEOUT 

Timeout state Value is allowed for gState only

HAL_SMARTCARD_STATE_ERROR 

Error Value is allowed for gState only

Definition at line 206 of file stm32l4xx_hal_smartcard.h.

SMARTCARD clock sources.

Enumerator:
SMARTCARD_CLOCKSOURCE_PCLK1 

PCLK1 clock source

SMARTCARD_CLOCKSOURCE_PCLK2 

PCLK2 clock source

SMARTCARD_CLOCKSOURCE_HSI 

HSI clock source

SMARTCARD_CLOCKSOURCE_SYSCLK 

SYSCLK clock source

SMARTCARD_CLOCKSOURCE_LSE 

LSE clock source

SMARTCARD_CLOCKSOURCE_UNDEFINED 

undefined clock source

Definition at line 333 of file stm32l4xx_hal_smartcard.h.