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