Joris Aerts / mbed-src

mbed library sources

Dependents:   Marvino mbot

Fork of mbed-src by mbed official

targets/cmsis/TARGET_STM/TARGET_STM32L4/stm32l4xx_hal_smartcard_ex.c@610:813dcc80987e, 2015-08-14 (annotated)

Committer:
mbed_official
Date:
Fri Aug 14 13:15:17 2015 +0100
Revision:
610:813dcc80987e
Synchronized with git revision 6d84db41c6833e0b9b024741eb0616a5f62d5599



Full URL: https://github.com/mbedmicro/mbed/commit/6d84db41c6833e0b9b024741eb0616a5f62d5599/



DISCO_F746NG - Improvements

Who changed what in which revision?

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