Joris Aerts / mbed-src

mbed library sources

Dependents:   Marvino mbot

Fork of mbed-src by mbed official

targets/cmsis/TARGET_STM/TARGET_STM32F7/stm32f7xx_hal_smartcard_ex.c@637:ed69428d4850, 2015-12-22 (annotated)

Committer:
jaerts
Date:
Tue Dec 22 13:22:16 2015 +0000
Revision:
637:ed69428d4850
Parent:
610:813dcc80987e 
Add very shady LPC1768 CAN Filter implementation

Who changed what in which revision?

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