Extended Peripheral Control functions

Extended control functions. More...

Functions
void	HAL_SMARTCARDEx_BlockLength_Config (SMARTCARD_HandleTypeDef *hsmartcard, uint8_t BlockLength)
	Update on the fly the SMARTCARD block length in RTOR register. More...
void	HAL_SMARTCARDEx_TimeOut_Config (SMARTCARD_HandleTypeDef *hsmartcard, uint32_t TimeOutValue)
	Update on the fly the receiver timeout value in RTOR register. More...
HAL_StatusTypeDef	HAL_SMARTCARDEx_EnableReceiverTimeOut (SMARTCARD_HandleTypeDef *hsmartcard)
	Enable the SMARTCARD receiver timeout feature. More...
HAL_StatusTypeDef	HAL_SMARTCARDEx_DisableReceiverTimeOut (SMARTCARD_HandleTypeDef *hsmartcard)
	Disable the SMARTCARD receiver timeout feature. More...

Detailed Description

Extended control functions.

  ===============================================================================
                      ##### Peripheral Control functions #####
  ===============================================================================
  [..]
  This subsection provides a set of functions allowing to initialize the SMARTCARD.
     (+) HAL_SMARTCARDEx_BlockLength_Config() API allows to configure the Block Length on the fly
     (+) HAL_SMARTCARDEx_TimeOut_Config() API allows to configure the receiver timeout value on the fly
     (+) HAL_SMARTCARDEx_EnableReceiverTimeOut() API enables the receiver timeout feature
     (+) HAL_SMARTCARDEx_DisableReceiverTimeOut() API disables the receiver timeout feature

Function Documentation

HAL_SMARTCARDEx_BlockLength_Config()

void HAL_SMARTCARDEx_BlockLength_Config	(	SMARTCARD_HandleTypeDef *	hsmartcard,
		uint8_t	BlockLength
	)

Update on the fly the SMARTCARD block length in RTOR register.

Parameters

hsmartcard	Pointer to a SMARTCARD_HandleTypeDef structure that contains the configuration information for the specified SMARTCARD module.
BlockLength	SMARTCARD block length (8-bit long at most)

Return values

None

Definition at line 100 of file stm32l4xx_hal_smartcard_ex.c.

{
  MODIFY_REG(hsmartcard->Instance->RTOR, USART_RTOR_BLEN, ((uint32_t)BlockLength << USART_RTOR_BLEN_Pos));
}

HAL_SMARTCARDEx_DisableReceiverTimeOut()

HAL_StatusTypeDef HAL_SMARTCARDEx_DisableReceiverTimeOut

(

SMARTCARD_HandleTypeDef *

hsmartcard

)

Disable the SMARTCARD receiver timeout feature.

Parameters

hsmartcard

Pointer to a SMARTCARD_HandleTypeDef structure that contains the configuration information for the specified SMARTCARD module.

Return values

HAL

status

Definition at line 153 of file stm32l4xx_hal_smartcard_ex.c.

{
  if (hsmartcard->gState == HAL_SMARTCARD_STATE_READY)
  {
    /* Process Locked */
    __HAL_LOCK(hsmartcard);

    hsmartcard->gState = HAL_SMARTCARD_STATE_BUSY;

    /* Clear the USART RTOEN bit */
    CLEAR_BIT(hsmartcard->Instance->CR2, USART_CR2_RTOEN);

    hsmartcard->gState = HAL_SMARTCARD_STATE_READY;

    /* Process Unlocked */
    __HAL_UNLOCK(hsmartcard);

    return HAL_OK;
  }
  else
  {
    return HAL_BUSY;
  }
}

HAL_SMARTCARDEx_EnableReceiverTimeOut()

HAL_StatusTypeDef HAL_SMARTCARDEx_EnableReceiverTimeOut

(

SMARTCARD_HandleTypeDef *

hsmartcard

)

Enable the SMARTCARD receiver timeout feature.

Parameters

hsmartcard

Pointer to a SMARTCARD_HandleTypeDef structure that contains the configuration information for the specified SMARTCARD module.

Return values

HAL

status

Definition at line 123 of file stm32l4xx_hal_smartcard_ex.c.

{
  if (hsmartcard->gState == HAL_SMARTCARD_STATE_READY)
  {
    /* Process Locked */
    __HAL_LOCK(hsmartcard);

    hsmartcard->gState = HAL_SMARTCARD_STATE_BUSY;

    /* Set the USART RTOEN bit */
    SET_BIT(hsmartcard->Instance->CR2, USART_CR2_RTOEN);

    hsmartcard->gState = HAL_SMARTCARD_STATE_READY;

    /* Process Unlocked */
    __HAL_UNLOCK(hsmartcard);

    return HAL_OK;
  }
  else
  {
    return HAL_BUSY;
  }
}

HAL_SMARTCARDEx_TimeOut_Config()

void HAL_SMARTCARDEx_TimeOut_Config	(	SMARTCARD_HandleTypeDef *	hsmartcard,
		uint32_t	TimeOutValue
	)

Update on the fly the receiver timeout value in RTOR register.

Parameters

hsmartcard	Pointer to a SMARTCARD_HandleTypeDef structure that contains the configuration information for the specified SMARTCARD module.
TimeOutValue	receiver timeout value in number of baud blocks. The timeout value must be less or equal to 0x0FFFFFFFF.

Return values

None

Definition at line 112 of file stm32l4xx_hal_smartcard_ex.c.

{
  assert_param(IS_SMARTCARD_TIMEOUT_VALUE(hsmartcard->Init.TimeOutValue));
  MODIFY_REG(hsmartcard->Instance->RTOR, USART_RTOR_RTO, TimeOutValue);
}