STM32F479xx HAL User Manual: stm32f4xx_hal

Header file of SMARTCARD HAL module. More...

#include "stm32f4xx_hal_def.h"

Data Structures
struct	SMARTCARD_InitTypeDef
	SMARTCARD Init Structure definition. More...
struct	__SMARTCARD_HandleTypeDef
	SMARTCARD handle Structure definition. More...
Defines
#define	HAL_SMARTCARD_ERROR_NONE 0x00000000U
#define	HAL_SMARTCARD_ERROR_PE 0x00000001U
#define	HAL_SMARTCARD_ERROR_NE 0x00000002U
#define	HAL_SMARTCARD_ERROR_FE 0x00000004U
#define	HAL_SMARTCARD_ERROR_ORE 0x00000008U
#define	HAL_SMARTCARD_ERROR_DMA 0x00000010U
#define	HAL_SMARTCARD_ERROR_INVALID_CALLBACK 0x00000020U
#define	SMARTCARD_WORDLENGTH_9B ((uint32_t)USART_CR1_M)
#define	SMARTCARD_STOPBITS_0_5 ((uint32_t)USART_CR2_STOP_0)
#define	SMARTCARD_STOPBITS_1_5 ((uint32_t)(USART_CR2_STOP_0 \| USART_CR2_STOP_1))
#define	SMARTCARD_PARITY_EVEN ((uint32_t)USART_CR1_PCE)
#define	SMARTCARD_PARITY_ODD ((uint32_t)(USART_CR1_PCE \| USART_CR1_PS))
#define	SMARTCARD_MODE_RX ((uint32_t)USART_CR1_RE)
#define	SMARTCARD_MODE_TX ((uint32_t)USART_CR1_TE)
#define	SMARTCARD_MODE_TX_RX ((uint32_t)(USART_CR1_TE \|USART_CR1_RE))
#define	SMARTCARD_POLARITY_LOW 0x00000000U
#define	SMARTCARD_POLARITY_HIGH ((uint32_t)USART_CR2_CPOL)
#define	SMARTCARD_PHASE_1EDGE 0x00000000U
#define	SMARTCARD_PHASE_2EDGE ((uint32_t)USART_CR2_CPHA)
#define	SMARTCARD_LASTBIT_DISABLE 0x00000000U
#define	SMARTCARD_LASTBIT_ENABLE ((uint32_t)USART_CR2_LBCL)
#define	SMARTCARD_NACK_ENABLE ((uint32_t)USART_CR3_NACK)
#define	SMARTCARD_NACK_DISABLE 0x00000000U
#define	SMARTCARD_DMAREQ_TX ((uint32_t)USART_CR3_DMAT)
#define	SMARTCARD_DMAREQ_RX ((uint32_t)USART_CR3_DMAR)
#define	SMARTCARD_PRESCALER_SYSCLK_DIV2 0x00000001U
#define	SMARTCARD_PRESCALER_SYSCLK_DIV4 0x00000002U
#define	SMARTCARD_PRESCALER_SYSCLK_DIV6 0x00000003U
#define	SMARTCARD_PRESCALER_SYSCLK_DIV8 0x00000004U
#define	SMARTCARD_PRESCALER_SYSCLK_DIV10 0x00000005U
#define	SMARTCARD_PRESCALER_SYSCLK_DIV12 0x00000006U
#define	SMARTCARD_PRESCALER_SYSCLK_DIV14 0x00000007U
#define	SMARTCARD_PRESCALER_SYSCLK_DIV16 0x00000008U
#define	SMARTCARD_PRESCALER_SYSCLK_DIV18 0x00000009U
#define	SMARTCARD_PRESCALER_SYSCLK_DIV20 0x0000000AU
#define	SMARTCARD_PRESCALER_SYSCLK_DIV22 0x0000000BU
#define	SMARTCARD_PRESCALER_SYSCLK_DIV24 0x0000000CU
#define	SMARTCARD_PRESCALER_SYSCLK_DIV26 0x0000000DU
#define	SMARTCARD_PRESCALER_SYSCLK_DIV28 0x0000000EU
#define	SMARTCARD_PRESCALER_SYSCLK_DIV30 0x0000000FU
#define	SMARTCARD_PRESCALER_SYSCLK_DIV32 0x00000010U
#define	SMARTCARD_PRESCALER_SYSCLK_DIV34 0x00000011U
#define	SMARTCARD_PRESCALER_SYSCLK_DIV36 0x00000012U
#define	SMARTCARD_PRESCALER_SYSCLK_DIV38 0x00000013U
#define	SMARTCARD_PRESCALER_SYSCLK_DIV40 0x00000014U
#define	SMARTCARD_PRESCALER_SYSCLK_DIV42 0x00000015U
#define	SMARTCARD_PRESCALER_SYSCLK_DIV44 0x00000016U
#define	SMARTCARD_PRESCALER_SYSCLK_DIV46 0x00000017U
#define	SMARTCARD_PRESCALER_SYSCLK_DIV48 0x00000018U
#define	SMARTCARD_PRESCALER_SYSCLK_DIV50 0x00000019U
#define	SMARTCARD_PRESCALER_SYSCLK_DIV52 0x0000001AU
#define	SMARTCARD_PRESCALER_SYSCLK_DIV54 0x0000001BU
#define	SMARTCARD_PRESCALER_SYSCLK_DIV56 0x0000001CU
#define	SMARTCARD_PRESCALER_SYSCLK_DIV58 0x0000001DU
#define	SMARTCARD_PRESCALER_SYSCLK_DIV60 0x0000001EU
#define	SMARTCARD_PRESCALER_SYSCLK_DIV62 0x0000001FU
#define	SMARTCARD_FLAG_TXE ((uint32_t)USART_SR_TXE)
#define	SMARTCARD_FLAG_TC ((uint32_t)USART_SR_TC)
#define	SMARTCARD_FLAG_RXNE ((uint32_t)USART_SR_RXNE)
#define	SMARTCARD_FLAG_IDLE ((uint32_t)USART_SR_IDLE)
#define	SMARTCARD_FLAG_ORE ((uint32_t)USART_SR_ORE)
#define	SMARTCARD_FLAG_NE ((uint32_t)USART_SR_NE)
#define	SMARTCARD_FLAG_FE ((uint32_t)USART_SR_FE)
#define	SMARTCARD_FLAG_PE ((uint32_t)USART_SR_PE)
#define	SMARTCARD_IT_PE ((uint32_t)(SMARTCARD_CR1_REG_INDEX << 28U \| USART_CR1_PEIE))
#define	SMARTCARD_IT_TXE ((uint32_t)(SMARTCARD_CR1_REG_INDEX << 28U \| USART_CR1_TXEIE))
#define	SMARTCARD_IT_TC ((uint32_t)(SMARTCARD_CR1_REG_INDEX << 28U \| USART_CR1_TCIE))
#define	SMARTCARD_IT_RXNE ((uint32_t)(SMARTCARD_CR1_REG_INDEX << 28U \| USART_CR1_RXNEIE))
#define	SMARTCARD_IT_IDLE ((uint32_t)(SMARTCARD_CR1_REG_INDEX << 28U \| USART_CR1_IDLEIE))
#define	SMARTCARD_IT_ERR ((uint32_t)(SMARTCARD_CR3_REG_INDEX << 28U \| USART_CR3_EIE))
#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	SMARTCARD_IT_MASK
	SMARTCARD interruptions flag mask.
#define	SMARTCARD_CR1_REG_INDEX 1U
#define	SMARTCARD_CR3_REG_INDEX 3U
#define	IS_SMARTCARD_WORD_LENGTH(LENGTH) ((LENGTH) == SMARTCARD_WORDLENGTH_9B)
#define	IS_SMARTCARD_STOPBITS(STOPBITS)
#define	IS_SMARTCARD_PARITY(PARITY)
#define	IS_SMARTCARD_MODE(MODE) ((((MODE) & 0x0000FFF3U) == 0x00U) && ((MODE) != 0x000000U))
#define	IS_SMARTCARD_POLARITY(CPOL) (((CPOL) == SMARTCARD_POLARITY_LOW) \|\| ((CPOL) == SMARTCARD_POLARITY_HIGH))
#define	IS_SMARTCARD_PHASE(CPHA) (((CPHA) == SMARTCARD_PHASE_1EDGE) \|\| ((CPHA) == SMARTCARD_PHASE_2EDGE))
#define	IS_SMARTCARD_LASTBIT(LASTBIT)
#define	IS_SMARTCARD_NACK_STATE(NACK)
#define	IS_SMARTCARD_BAUDRATE(BAUDRATE) ((BAUDRATE) < 10500001U)
#define	SMARTCARD_DIV(__PCLK__, __BAUD__) ((uint32_t)((((uint64_t)(__PCLK__))25U)/(4U((uint64_t)(__BAUD__)))))
#define	SMARTCARD_DIVMANT(__PCLK__, __BAUD__) (SMARTCARD_DIV((__PCLK__), (__BAUD__))/100U)
#define	SMARTCARD_DIVFRAQ(__PCLK__, __BAUD__) ((((SMARTCARD_DIV((__PCLK__), (__BAUD__)) - (SMARTCARD_DIVMANT((__PCLK__), (__BAUD__)) * 100U)) * 16U) + 50U) / 100U)
#define	SMARTCARD_BRR(__PCLK__, __BAUD__)
Typedefs
typedef struct __SMARTCARD_HandleTypeDef	SMARTCARD_HandleTypeDef
	SMARTCARD handle Structure definition.
typedef void(*	pSMARTCARD_CallbackTypeDef )(SMARTCARD_HandleTypeDef *hsc)
	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_MSPINIT_CB_ID = 0x08U, HAL_SMARTCARD_MSPDEINIT_CB_ID = 0x09U }
	HAL SMARTCARD Callback ID enumeration definition. More...
Functions
HAL_StatusTypeDef	HAL_SMARTCARD_Init (SMARTCARD_HandleTypeDef *hsc)
	Initializes the SmartCard mode according to the specified parameters in the SMARTCARD_InitTypeDef and create the associated handle.
HAL_StatusTypeDef	HAL_SMARTCARD_ReInit (SMARTCARD_HandleTypeDef *hsc)
HAL_StatusTypeDef	HAL_SMARTCARD_DeInit (SMARTCARD_HandleTypeDef *hsc)
	DeInitializes the USART SmartCard peripheral.
__weak void	HAL_SMARTCARD_MspInit (SMARTCARD_HandleTypeDef *hsc)
	SMARTCARD MSP Init.
__weak void	HAL_SMARTCARD_MspDeInit (SMARTCARD_HandleTypeDef *hsc)
	SMARTCARD MSP DeInit.
HAL_StatusTypeDef	HAL_SMARTCARD_RegisterCallback (SMARTCARD_HandleTypeDef *hsc, HAL_SMARTCARD_CallbackIDTypeDef CallbackID, pSMARTCARD_CallbackTypeDef pCallback)
	Register a User SMARTCARD Callback To be used instead of the weak predefined callback.
HAL_StatusTypeDef	HAL_SMARTCARD_UnRegisterCallback (SMARTCARD_HandleTypeDef *hsc, HAL_SMARTCARD_CallbackIDTypeDef CallbackID)
	Unregister an SMARTCARD callback SMARTCARD callback is redirected to the weak predefined callback.
HAL_StatusTypeDef	HAL_SMARTCARD_Transmit (SMARTCARD_HandleTypeDef hsc, uint8_t pData, uint16_t Size, uint32_t Timeout)
	Send an amount of data in blocking mode.
HAL_StatusTypeDef	HAL_SMARTCARD_Receive (SMARTCARD_HandleTypeDef hsc, uint8_t pData, uint16_t Size, uint32_t Timeout)
	Receive an amount of data in blocking mode.
HAL_StatusTypeDef	HAL_SMARTCARD_Transmit_IT (SMARTCARD_HandleTypeDef hsc, uint8_t pData, uint16_t Size)
	Send an amount of data in non blocking mode.
HAL_StatusTypeDef	HAL_SMARTCARD_Receive_IT (SMARTCARD_HandleTypeDef hsc, uint8_t pData, uint16_t Size)
	Receive an amount of data in non blocking mode.
HAL_StatusTypeDef	HAL_SMARTCARD_Transmit_DMA (SMARTCARD_HandleTypeDef hsc, uint8_t pData, uint16_t Size)
	Send an amount of data in non blocking mode.
HAL_StatusTypeDef	HAL_SMARTCARD_Receive_DMA (SMARTCARD_HandleTypeDef hsc, uint8_t pData, uint16_t Size)
	Receive an amount of data in non blocking mode.
HAL_StatusTypeDef	HAL_SMARTCARD_Abort (SMARTCARD_HandleTypeDef *hsc)
	Abort ongoing transfers (blocking mode).
HAL_StatusTypeDef	HAL_SMARTCARD_AbortTransmit (SMARTCARD_HandleTypeDef *hsc)
	Abort ongoing Transmit transfer (blocking mode).
HAL_StatusTypeDef	HAL_SMARTCARD_AbortReceive (SMARTCARD_HandleTypeDef *hsc)
	Abort ongoing Receive transfer (blocking mode).
HAL_StatusTypeDef	HAL_SMARTCARD_Abort_IT (SMARTCARD_HandleTypeDef *hsc)
	Abort ongoing transfers (Interrupt mode).
HAL_StatusTypeDef	HAL_SMARTCARD_AbortTransmit_IT (SMARTCARD_HandleTypeDef *hsc)
	Abort ongoing Transmit transfer (Interrupt mode).
HAL_StatusTypeDef	HAL_SMARTCARD_AbortReceive_IT (SMARTCARD_HandleTypeDef *hsc)
	Abort ongoing Receive transfer (Interrupt mode).
void	HAL_SMARTCARD_IRQHandler (SMARTCARD_HandleTypeDef *hsc)
	This function handles SMARTCARD interrupt request.
__weak void	HAL_SMARTCARD_TxCpltCallback (SMARTCARD_HandleTypeDef *hsc)
	Tx Transfer completed callbacks.
__weak void	HAL_SMARTCARD_RxCpltCallback (SMARTCARD_HandleTypeDef *hsc)
	Rx Transfer completed callback.
__weak void	HAL_SMARTCARD_ErrorCallback (SMARTCARD_HandleTypeDef *hsc)
	SMARTCARD error callback.
__weak void	HAL_SMARTCARD_AbortCpltCallback (SMARTCARD_HandleTypeDef *hsc)
	SMARTCARD Abort Complete callback.
__weak void	HAL_SMARTCARD_AbortTransmitCpltCallback (SMARTCARD_HandleTypeDef *hsc)
	SMARTCARD Abort Transmit Complete callback.
__weak void	HAL_SMARTCARD_AbortReceiveCpltCallback (SMARTCARD_HandleTypeDef *hsc)
	SMARTCARD Abort Receive Complete callback.
HAL_SMARTCARD_StateTypeDef	HAL_SMARTCARD_GetState (SMARTCARD_HandleTypeDef *hsc)
	Return the SMARTCARD handle state.
uint32_t	HAL_SMARTCARD_GetError (SMARTCARD_HandleTypeDef *hsc)
	Return the SMARTCARD error code.

Detailed Description

Header file of SMARTCARD HAL module.

Author:: MCD Application Team

Attention:

This software component is licensed by ST under BSD 3-Clause license, the "License"; You may not use this file except in compliance with the License. You may obtain a copy of the License at: opensource.org/licenses/BSD-3-Clause

Definition in file stm32f4xx_hal_smartcard.h.

Data Structures

Defines

Typedefs

Enumerations

Functions

Detailed Description

© Copyright (c) 2016 STMicroelectronics. All rights reserved.