mbed official / mbed-dev

mbed library sources. Supersedes mbed-src.

Dependents:   Nucleo_Hello_Encoder BLE_iBeaconScan AM1805_DEMO DISCO-F429ZI_ExportTemplate1 ... more

targets/TARGET_STM/TARGET_STM32L0/device/stm32l0xx_hal_smartcard_ex.c@186:707f6e361f3e, 2018-06-22 (annotated)

Committer:
Anna Bridge
Date:
Fri Jun 22 16:45:37 2018 +0100
Revision:
186:707f6e361f3e
Parent:
151:5eaa88a5bcc7 
mbed-dev library. Release version 162

Who changed what in which revision?

UserRevisionLine numberNew contents of line
<> 144:ef7eb2e8f9f7 1 /**
<> 144:ef7eb2e8f9f7 2 ******************************************************************************
<> 144:ef7eb2e8f9f7 3 * @file stm32l0xx_hal_smartcard_ex.c
<> 144:ef7eb2e8f9f7 4 * @author MCD Application Team
<> 144:ef7eb2e8f9f7 5 * @brief SMARTCARD HAL module driver.
Anna Bridge 186:707f6e361f3e 6 * This file provides extended firmware functions to manage the following
<> 144:ef7eb2e8f9f7 7 * functionalities of the SmartCard.
<> 144:ef7eb2e8f9f7 8 * + Initialization and de-initialization functions
<> 144:ef7eb2e8f9f7 9 * + Peripheral Control functions
Anna Bridge 186:707f6e361f3e 10 *
Anna Bridge 186:707f6e361f3e 11 *
<> 144:ef7eb2e8f9f7 12 @verbatim
Anna Bridge 186:707f6e361f3e 13 =============================================================================
Anna Bridge 186:707f6e361f3e 14 ##### SMARTCARD peripheral extended features #####
Anna Bridge 186:707f6e361f3e 15 =============================================================================
Anna Bridge 186:707f6e361f3e 16 [..]
Anna Bridge 186:707f6e361f3e 17 The Extended SMARTCARD HAL driver can be used as follows:
<> 144:ef7eb2e8f9f7 18
Anna Bridge 186:707f6e361f3e 19 (#) After having configured the SMARTCARD basic features with HAL_SMARTCARD_Init(),
Anna Bridge 186:707f6e361f3e 20 then program SMARTCARD advanced features if required (TX/RX pins swap, TimeOut,
Anna Bridge 186:707f6e361f3e 21 auto-retry counter,...) in the hsmartcard AdvancedInit structure.
Anna Bridge 186:707f6e361f3e 22
Anna Bridge 186:707f6e361f3e 23
<> 144:ef7eb2e8f9f7 24
<> 144:ef7eb2e8f9f7 25 @endverbatim
<> 144:ef7eb2e8f9f7 26 ******************************************************************************
<> 144:ef7eb2e8f9f7 27 * @attention
<> 144:ef7eb2e8f9f7 28 *
<> 144:ef7eb2e8f9f7 29 * <h2><center>&copy; COPYRIGHT(c) 2016 STMicroelectronics</center></h2>
<> 144:ef7eb2e8f9f7 30 *
<> 144:ef7eb2e8f9f7 31 * Redistribution and use in source and binary forms, with or without modification,
<> 144:ef7eb2e8f9f7 32 * are permitted provided that the following conditions are met:
<> 144:ef7eb2e8f9f7 33 * 1. Redistributions of source code must retain the above copyright notice,
<> 144:ef7eb2e8f9f7 34 * this list of conditions and the following disclaimer.
<> 144:ef7eb2e8f9f7 35 * 2. Redistributions in binary form must reproduce the above copyright notice,
<> 144:ef7eb2e8f9f7 36 * this list of conditions and the following disclaimer in the documentation
<> 144:ef7eb2e8f9f7 37 * and/or other materials provided with the distribution.
<> 144:ef7eb2e8f9f7 38 * 3. Neither the name of STMicroelectronics nor the names of its contributors
<> 144:ef7eb2e8f9f7 39 * may be used to endorse or promote products derived from this software
<> 144:ef7eb2e8f9f7 40 * without specific prior written permission.
<> 144:ef7eb2e8f9f7 41 *
<> 144:ef7eb2e8f9f7 42 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
<> 144:ef7eb2e8f9f7 43 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
<> 144:ef7eb2e8f9f7 44 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
<> 144:ef7eb2e8f9f7 45 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
<> 144:ef7eb2e8f9f7 46 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
<> 144:ef7eb2e8f9f7 47 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
<> 144:ef7eb2e8f9f7 48 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
<> 144:ef7eb2e8f9f7 49 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
<> 144:ef7eb2e8f9f7 50 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
<> 144:ef7eb2e8f9f7 51 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
<> 144:ef7eb2e8f9f7 52 *
<> 144:ef7eb2e8f9f7 53 ******************************************************************************
<> 144:ef7eb2e8f9f7 54 */
<> 144:ef7eb2e8f9f7 55
<> 144:ef7eb2e8f9f7 56 /* Includes ------------------------------------------------------------------*/
<> 144:ef7eb2e8f9f7 57 #include "stm32l0xx_hal.h"
<> 144:ef7eb2e8f9f7 58
<> 144:ef7eb2e8f9f7 59 /** @addtogroup STM32L0xx_HAL_Driver
<> 144:ef7eb2e8f9f7 60 * @{
<> 144:ef7eb2e8f9f7 61 */
<> 144:ef7eb2e8f9f7 62
Anna Bridge 186:707f6e361f3e 63 /** @defgroup SMARTCARDEx SMARTCARDEx
<> 144:ef7eb2e8f9f7 64 * @brief SMARTCARD Extended HAL module driver
<> 144:ef7eb2e8f9f7 65 * @{
<> 144:ef7eb2e8f9f7 66 */
Anna Bridge 186:707f6e361f3e 67 #ifdef HAL_SMARTCARD_MODULE_ENABLED
<> 144:ef7eb2e8f9f7 68
<> 144:ef7eb2e8f9f7 69 /* Private typedef -----------------------------------------------------------*/
<> 144:ef7eb2e8f9f7 70 /* Private define ------------------------------------------------------------*/
Anna Bridge 186:707f6e361f3e 71 /* Private macros ------------------------------------------------------------*/
<> 144:ef7eb2e8f9f7 72 /* Private variables ---------------------------------------------------------*/
<> 144:ef7eb2e8f9f7 73 /* Private function prototypes -----------------------------------------------*/
<> 144:ef7eb2e8f9f7 74
Anna Bridge 186:707f6e361f3e 75 /* Exported functions --------------------------------------------------------*/
Anna Bridge 186:707f6e361f3e 76 /** @defgroup SMARTCARDEx_Exported_Functions SMARTCARD Extended Exported Functions
<> 144:ef7eb2e8f9f7 77 * @{
<> 144:ef7eb2e8f9f7 78 */
<> 144:ef7eb2e8f9f7 79
Anna Bridge 186:707f6e361f3e 80 /** @defgroup SMARTCARDEx_Exported_Functions_Group1 Extended Peripheral Control functions
<> 144:ef7eb2e8f9f7 81 * @brief Extended control functions
<> 144:ef7eb2e8f9f7 82 *
Anna Bridge 186:707f6e361f3e 83 @verbatim
Anna Bridge 186:707f6e361f3e 84 ===============================================================================
<> 144:ef7eb2e8f9f7 85 ##### Peripheral Control functions #####
Anna Bridge 186:707f6e361f3e 86 ===============================================================================
Anna Bridge 186:707f6e361f3e 87 [..]
Anna Bridge 186:707f6e361f3e 88 This subsection provides a set of functions allowing to initialize the SMARTCARD.
Anna Bridge 186:707f6e361f3e 89 (+) HAL_SMARTCARDEx_BlockLength_Config() API allows to configure the Block Length on the fly
Anna Bridge 186:707f6e361f3e 90 (+) HAL_SMARTCARDEx_TimeOut_Config() API allows to configure the receiver timeout value on the fly
<> 144:ef7eb2e8f9f7 91 (+) HAL_SMARTCARDEx_EnableReceiverTimeOut() API enables the receiver timeout feature
<> 144:ef7eb2e8f9f7 92 (+) HAL_SMARTCARDEx_DisableReceiverTimeOut() API disables the receiver timeout feature
<> 144:ef7eb2e8f9f7 93
<> 144:ef7eb2e8f9f7 94 @endverbatim
<> 144:ef7eb2e8f9f7 95 * @{
<> 144:ef7eb2e8f9f7 96 */
<> 144:ef7eb2e8f9f7 97
<> 144:ef7eb2e8f9f7 98 /**
Anna Bridge 186:707f6e361f3e 99 * @brief Update on the fly the SMARTCARD block length in RTOR register.
Anna Bridge 186:707f6e361f3e 100 * @param hsmartcard: Pointer to a SMARTCARD_HandleTypeDef structure that contains
Anna Bridge 186:707f6e361f3e 101 * the configuration information for the specified SMARTCARD module.
Anna Bridge 186:707f6e361f3e 102 * @param BlockLength: SMARTCARD block length (8-bit long at most)
<> 144:ef7eb2e8f9f7 103 * @retval None
<> 144:ef7eb2e8f9f7 104 */
Anna Bridge 186:707f6e361f3e 105 void HAL_SMARTCARDEx_BlockLength_Config(SMARTCARD_HandleTypeDef *hsmartcard, uint8_t BlockLength)
<> 144:ef7eb2e8f9f7 106 {
Anna Bridge 186:707f6e361f3e 107 MODIFY_REG(hsmartcard->Instance->RTOR, USART_RTOR_BLEN, ((uint32_t)BlockLength << SMARTCARD_RTOR_BLEN_LSB_POS));
<> 144:ef7eb2e8f9f7 108 }
<> 144:ef7eb2e8f9f7 109
<> 144:ef7eb2e8f9f7 110 /**
Anna Bridge 186:707f6e361f3e 111 * @brief Update on the fly the receiver timeout value in RTOR register.
Anna Bridge 186:707f6e361f3e 112 * @param hsmartcard: Pointer to a SMARTCARD_HandleTypeDef structure that contains
Anna Bridge 186:707f6e361f3e 113 * the configuration information for the specified SMARTCARD module.
<> 144:ef7eb2e8f9f7 114 * @param TimeOutValue: receiver timeout value in number of baud blocks. The timeout
Anna Bridge 186:707f6e361f3e 115 * value must be less or equal to 0x0FFFFFFFF.
<> 144:ef7eb2e8f9f7 116 * @retval None
<> 144:ef7eb2e8f9f7 117 */
Anna Bridge 186:707f6e361f3e 118 void HAL_SMARTCARDEx_TimeOut_Config(SMARTCARD_HandleTypeDef *hsmartcard, uint32_t TimeOutValue)
<> 144:ef7eb2e8f9f7 119 {
Anna Bridge 186:707f6e361f3e 120 assert_param(IS_SMARTCARD_TIMEOUT_VALUE(hsmartcard->Init.TimeOutValue));
Anna Bridge 186:707f6e361f3e 121 MODIFY_REG(hsmartcard->Instance->RTOR, USART_RTOR_RTO, TimeOutValue);
<> 144:ef7eb2e8f9f7 122 }
<> 144:ef7eb2e8f9f7 123
<> 144:ef7eb2e8f9f7 124 /**
Anna Bridge 186:707f6e361f3e 125 * @brief Enable the SMARTCARD receiver timeout feature.
Anna Bridge 186:707f6e361f3e 126 * @param hsmartcard: Pointer to a SMARTCARD_HandleTypeDef structure that contains
Anna Bridge 186:707f6e361f3e 127 * the configuration information for the specified SMARTCARD module.
<> 144:ef7eb2e8f9f7 128 * @retval HAL status
<> 144:ef7eb2e8f9f7 129 */
Anna Bridge 186:707f6e361f3e 130 HAL_StatusTypeDef HAL_SMARTCARDEx_EnableReceiverTimeOut(SMARTCARD_HandleTypeDef *hsmartcard)
<> 144:ef7eb2e8f9f7 131 {
<> 144:ef7eb2e8f9f7 132
Anna Bridge 186:707f6e361f3e 133 if(hsmartcard->gState == HAL_SMARTCARD_STATE_READY)
Anna Bridge 186:707f6e361f3e 134 {
Anna Bridge 186:707f6e361f3e 135 /* Process Locked */
Anna Bridge 186:707f6e361f3e 136 __HAL_LOCK(hsmartcard);
Anna Bridge 186:707f6e361f3e 137
Anna Bridge 186:707f6e361f3e 138 hsmartcard->gState = HAL_SMARTCARD_STATE_BUSY;
<> 144:ef7eb2e8f9f7 139
Anna Bridge 186:707f6e361f3e 140 /* Set the USART RTOEN bit */
Anna Bridge 186:707f6e361f3e 141 SET_BIT(hsmartcard->Instance->CR2, USART_CR2_RTOEN);
<> 144:ef7eb2e8f9f7 142
Anna Bridge 186:707f6e361f3e 143 hsmartcard->gState = HAL_SMARTCARD_STATE_READY;
<> 144:ef7eb2e8f9f7 144
Anna Bridge 186:707f6e361f3e 145 /* Process Unlocked */
Anna Bridge 186:707f6e361f3e 146 __HAL_UNLOCK(hsmartcard);
Anna Bridge 186:707f6e361f3e 147
Anna Bridge 186:707f6e361f3e 148 return HAL_OK;
Anna Bridge 186:707f6e361f3e 149 }
Anna Bridge 186:707f6e361f3e 150 else
Anna Bridge 186:707f6e361f3e 151 {
Anna Bridge 186:707f6e361f3e 152 return HAL_BUSY;
Anna Bridge 186:707f6e361f3e 153 }
<> 144:ef7eb2e8f9f7 154 }
<> 144:ef7eb2e8f9f7 155
<> 144:ef7eb2e8f9f7 156 /**
Anna Bridge 186:707f6e361f3e 157 * @brief Disable the SMARTCARD receiver timeout feature.
Anna Bridge 186:707f6e361f3e 158 * @param hsmartcard: Pointer to a SMARTCARD_HandleTypeDef structure that contains
Anna Bridge 186:707f6e361f3e 159 * the configuration information for the specified SMARTCARD module.
<> 144:ef7eb2e8f9f7 160 * @retval HAL status
<> 144:ef7eb2e8f9f7 161 */
Anna Bridge 186:707f6e361f3e 162 HAL_StatusTypeDef HAL_SMARTCARDEx_DisableReceiverTimeOut(SMARTCARD_HandleTypeDef *hsmartcard)
<> 144:ef7eb2e8f9f7 163 {
<> 144:ef7eb2e8f9f7 164
Anna Bridge 186:707f6e361f3e 165 if(hsmartcard->gState == HAL_SMARTCARD_STATE_READY)
Anna Bridge 186:707f6e361f3e 166 {
Anna Bridge 186:707f6e361f3e 167 /* Process Locked */
Anna Bridge 186:707f6e361f3e 168 __HAL_LOCK(hsmartcard);
Anna Bridge 186:707f6e361f3e 169
Anna Bridge 186:707f6e361f3e 170 hsmartcard->gState = HAL_SMARTCARD_STATE_BUSY;
<> 144:ef7eb2e8f9f7 171
Anna Bridge 186:707f6e361f3e 172 /* Clear the USART RTOEN bit */
Anna Bridge 186:707f6e361f3e 173 CLEAR_BIT(hsmartcard->Instance->CR2, USART_CR2_RTOEN);
<> 144:ef7eb2e8f9f7 174
Anna Bridge 186:707f6e361f3e 175 hsmartcard->gState = HAL_SMARTCARD_STATE_READY;
<> 144:ef7eb2e8f9f7 176
Anna Bridge 186:707f6e361f3e 177 /* Process Unlocked */
Anna Bridge 186:707f6e361f3e 178 __HAL_UNLOCK(hsmartcard);
Anna Bridge 186:707f6e361f3e 179
Anna Bridge 186:707f6e361f3e 180 return HAL_OK;
Anna Bridge 186:707f6e361f3e 181 }
Anna Bridge 186:707f6e361f3e 182 else
Anna Bridge 186:707f6e361f3e 183 {
Anna Bridge 186:707f6e361f3e 184 return HAL_BUSY;
Anna Bridge 186:707f6e361f3e 185 }
<> 144:ef7eb2e8f9f7 186 }
<> 144:ef7eb2e8f9f7 187
<> 144:ef7eb2e8f9f7 188 /**
<> 144:ef7eb2e8f9f7 189 * @}
<> 144:ef7eb2e8f9f7 190 */
<> 144:ef7eb2e8f9f7 191
<> 144:ef7eb2e8f9f7 192 /**
<> 144:ef7eb2e8f9f7 193 * @}
<> 144:ef7eb2e8f9f7 194 */
<> 144:ef7eb2e8f9f7 195
Anna Bridge 186:707f6e361f3e 196 #endif /* HAL_SMARTCARD_MODULE_ENABLED */
Anna Bridge 186:707f6e361f3e 197
<> 144:ef7eb2e8f9f7 198 /**
<> 144:ef7eb2e8f9f7 199 * @}
<> 144:ef7eb2e8f9f7 200 */
Anna Bridge 186:707f6e361f3e 201
<> 144:ef7eb2e8f9f7 202 /**
<> 144:ef7eb2e8f9f7 203 * @}
<> 144:ef7eb2e8f9f7 204 */
<> 144:ef7eb2e8f9f7 205
<> 144:ef7eb2e8f9f7 206 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
<> 144:ef7eb2e8f9f7 207