shao ziyang / mbed-src-kl05

mbed library sources

Dependents:   frdm_kl05z_gpio_test

Fork of mbed-src by mbed official

targets/cmsis/TARGET_STM/TARGET_NUCLEO_L053R8/stm32l0xx_hal_smartcard_ex.c@181:a4cbdfbbd2f4, 2014-05-07 (annotated)

Committer:
mbed_official
Date:
Wed May 07 13:15:08 2014 +0100
Revision:
181:a4cbdfbbd2f4
Synchronized with git revision 7751e759576c6fd68deccb81ea82bac19ed41745



Full URL: https://github.com/mbedmicro/mbed/commit/7751e759576c6fd68deccb81ea82bac19ed41745/

Who changed what in which revision?

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