SAKURA Internet / mbed-dev

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Fork of mbed-dev by mbed official

targets/TARGET_STM/TARGET_STM32F3/device/stm32f3xx_hal_smartcard_ex.c@157:ff67d9f36b67, 2017-02-02 (annotated)

Committer:
<>
Date:
Thu Feb 02 17:01:33 2017 +0000
Revision:
157:ff67d9f36b67
Parent:
149:156823d33999 
This updates the lib to the mbed lib v135

Who changed what in which revision?

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