PHung Tung / SRC_STM32F7

SPKT

Dependents:   WAV

targets/cmsis/TARGET_STM/TARGET_STM32F7/stm32f7xx_hal_smartcard_ex.c@0:e87aa4c49e95, 2019-06-04 (annotated)

Committer:
phungductung
Date:
Tue Jun 04 21:51:46 2019 +0000
Revision:
0:e87aa4c49e95
libray

Who changed what in which revision?

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