The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

Committer:
AnnaBridge
Date:
Fri May 26 12:30:20 2017 +0100
Revision:
143:86740a56073b
Parent:
135:176b8275d35d
Release 143 of the mbed library.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
AnnaBridge 126:abea610beb85 1 /**
AnnaBridge 126:abea610beb85 2 ******************************************************************************
AnnaBridge 126:abea610beb85 3 * @file stm32f3xx_hal_irda.h
AnnaBridge 126:abea610beb85 4 * @author MCD Application Team
<> 135:176b8275d35d 5 * @version V1.4.0
<> 135:176b8275d35d 6 * @date 16-December-2016
AnnaBridge 126:abea610beb85 7 * @brief This file contains all the functions prototypes for the IRDA
AnnaBridge 126:abea610beb85 8 * firmware library.
AnnaBridge 126:abea610beb85 9 ******************************************************************************
AnnaBridge 126:abea610beb85 10 * @attention
AnnaBridge 126:abea610beb85 11 *
AnnaBridge 126:abea610beb85 12 * <h2><center>&copy; COPYRIGHT(c) 2016 STMicroelectronics</center></h2>
AnnaBridge 126:abea610beb85 13 *
AnnaBridge 126:abea610beb85 14 * Redistribution and use in source and binary forms, with or without modification,
AnnaBridge 126:abea610beb85 15 * are permitted provided that the following conditions are met:
AnnaBridge 126:abea610beb85 16 * 1. Redistributions of source code must retain the above copyright notice,
AnnaBridge 126:abea610beb85 17 * this list of conditions and the following disclaimer.
AnnaBridge 126:abea610beb85 18 * 2. Redistributions in binary form must reproduce the above copyright notice,
AnnaBridge 126:abea610beb85 19 * this list of conditions and the following disclaimer in the documentation
AnnaBridge 126:abea610beb85 20 * and/or other materials provided with the distribution.
AnnaBridge 126:abea610beb85 21 * 3. Neither the name of STMicroelectronics nor the names of its contributors
AnnaBridge 126:abea610beb85 22 * may be used to endorse or promote products derived from this software
AnnaBridge 126:abea610beb85 23 * without specific prior written permission.
AnnaBridge 126:abea610beb85 24 *
AnnaBridge 126:abea610beb85 25 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AnnaBridge 126:abea610beb85 26 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
AnnaBridge 126:abea610beb85 27 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
AnnaBridge 126:abea610beb85 28 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
AnnaBridge 126:abea610beb85 29 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
AnnaBridge 126:abea610beb85 30 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
AnnaBridge 126:abea610beb85 31 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
AnnaBridge 126:abea610beb85 32 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
AnnaBridge 126:abea610beb85 33 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
AnnaBridge 126:abea610beb85 34 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
AnnaBridge 126:abea610beb85 35 *
AnnaBridge 126:abea610beb85 36 ******************************************************************************
AnnaBridge 126:abea610beb85 37 */
AnnaBridge 126:abea610beb85 38
AnnaBridge 126:abea610beb85 39 /* Define to prevent recursive inclusion -------------------------------------*/
AnnaBridge 126:abea610beb85 40 #ifndef __STM32F3xx_HAL_IRDA_H
AnnaBridge 126:abea610beb85 41 #define __STM32F3xx_HAL_IRDA_H
AnnaBridge 126:abea610beb85 42
AnnaBridge 126:abea610beb85 43 #ifdef __cplusplus
AnnaBridge 126:abea610beb85 44 extern "C" {
AnnaBridge 126:abea610beb85 45 #endif
AnnaBridge 126:abea610beb85 46
AnnaBridge 126:abea610beb85 47 /* Includes ------------------------------------------------------------------*/
AnnaBridge 126:abea610beb85 48 #include "stm32f3xx_hal_def.h"
AnnaBridge 126:abea610beb85 49
AnnaBridge 126:abea610beb85 50 /** @addtogroup STM32F3xx_HAL_Driver
AnnaBridge 126:abea610beb85 51 * @{
AnnaBridge 126:abea610beb85 52 */
AnnaBridge 126:abea610beb85 53
AnnaBridge 126:abea610beb85 54 /** @addtogroup IRDA
AnnaBridge 126:abea610beb85 55 * @{
AnnaBridge 126:abea610beb85 56 */
AnnaBridge 126:abea610beb85 57
<> 135:176b8275d35d 58 /* Exported types ------------------------------------------------------------*/
AnnaBridge 126:abea610beb85 59 /** @defgroup IRDA_Exported_Types IRDA Exported Types
AnnaBridge 126:abea610beb85 60 * @{
AnnaBridge 126:abea610beb85 61 */
AnnaBridge 126:abea610beb85 62
AnnaBridge 126:abea610beb85 63 /**
AnnaBridge 126:abea610beb85 64 * @brief IRDA Init Structure definition
AnnaBridge 126:abea610beb85 65 */
AnnaBridge 126:abea610beb85 66 typedef struct
AnnaBridge 126:abea610beb85 67 {
AnnaBridge 126:abea610beb85 68 uint32_t BaudRate; /*!< This member configures the IRDA communication baud rate.
AnnaBridge 126:abea610beb85 69 The baud rate register is computed using the following formula:
AnnaBridge 126:abea610beb85 70 Baud Rate Register = ((PCLKx) / ((hirda->Init.BaudRate))) */
AnnaBridge 126:abea610beb85 71
AnnaBridge 126:abea610beb85 72 uint32_t WordLength; /*!< Specifies the number of data bits transmitted or received in a frame.
AnnaBridge 126:abea610beb85 73 This parameter can be a value of @ref IRDAEx_Word_Length */
AnnaBridge 126:abea610beb85 74
AnnaBridge 126:abea610beb85 75 uint32_t Parity; /*!< Specifies the parity mode.
AnnaBridge 126:abea610beb85 76 This parameter can be a value of @ref IRDA_Parity
AnnaBridge 126:abea610beb85 77 @note When parity is enabled, the computed parity is inserted
AnnaBridge 126:abea610beb85 78 at the MSB position of the transmitted data (9th bit when
AnnaBridge 126:abea610beb85 79 the word length is set to 9 data bits; 8th bit when the
AnnaBridge 126:abea610beb85 80 word length is set to 8 data bits). */
AnnaBridge 126:abea610beb85 81
AnnaBridge 126:abea610beb85 82 uint32_t Mode; /*!< Specifies whether the Receive or Transmit mode is enabled or disabled.
AnnaBridge 126:abea610beb85 83 This parameter can be a value of @ref IRDA_Transfer_Mode */
AnnaBridge 126:abea610beb85 84
AnnaBridge 126:abea610beb85 85 uint8_t Prescaler; /*!< Specifies the Prescaler value for dividing the UART/USART source clock
AnnaBridge 126:abea610beb85 86 to achieve low-power frequency.
AnnaBridge 126:abea610beb85 87 @note Prescaler value 0 is forbidden */
AnnaBridge 126:abea610beb85 88
AnnaBridge 126:abea610beb85 89 uint16_t PowerMode; /*!< Specifies the IRDA power mode.
AnnaBridge 126:abea610beb85 90 This parameter can be a value of @ref IRDA_Low_Power */
AnnaBridge 126:abea610beb85 91 }IRDA_InitTypeDef;
AnnaBridge 126:abea610beb85 92
AnnaBridge 126:abea610beb85 93 /**
AnnaBridge 126:abea610beb85 94 * @brief HAL IRDA State structures definition
AnnaBridge 126:abea610beb85 95 * @note HAL IRDA State value is a combination of 2 different substates: gState and RxState.
AnnaBridge 126:abea610beb85 96 * - gState contains IRDA state information related to global Handle management
AnnaBridge 126:abea610beb85 97 * and also information related to Tx operations.
AnnaBridge 126:abea610beb85 98 * gState value coding follow below described bitmap :
AnnaBridge 126:abea610beb85 99 * b7-b6 Error information
AnnaBridge 126:abea610beb85 100 * 00 : No Error
AnnaBridge 126:abea610beb85 101 * 01 : (Not Used)
AnnaBridge 126:abea610beb85 102 * 10 : Timeout
AnnaBridge 126:abea610beb85 103 * 11 : Error
AnnaBridge 126:abea610beb85 104 * b5 IP initilisation status
AnnaBridge 126:abea610beb85 105 * 0 : Reset (IP not initialized)
AnnaBridge 126:abea610beb85 106 * 1 : Init done (IP not initialized. HAL IRDA Init function already called)
AnnaBridge 126:abea610beb85 107 * b4-b3 (not used)
AnnaBridge 126:abea610beb85 108 * xx : Should be set to 00
AnnaBridge 126:abea610beb85 109 * b2 Intrinsic process state
AnnaBridge 126:abea610beb85 110 * 0 : Ready
AnnaBridge 126:abea610beb85 111 * 1 : Busy (IP busy with some configuration or internal operations)
AnnaBridge 126:abea610beb85 112 * b1 (not used)
AnnaBridge 126:abea610beb85 113 * x : Should be set to 0
AnnaBridge 126:abea610beb85 114 * b0 Tx state
AnnaBridge 126:abea610beb85 115 * 0 : Ready (no Tx operation ongoing)
AnnaBridge 126:abea610beb85 116 * 1 : Busy (Tx operation ongoing)
AnnaBridge 126:abea610beb85 117 * - RxState contains information related to Rx operations.
AnnaBridge 126:abea610beb85 118 * RxState value coding follow below described bitmap :
AnnaBridge 126:abea610beb85 119 * b7-b6 (not used)
AnnaBridge 126:abea610beb85 120 * xx : Should be set to 00
AnnaBridge 126:abea610beb85 121 * b5 IP initilisation status
AnnaBridge 126:abea610beb85 122 * 0 : Reset (IP not initialized)
AnnaBridge 126:abea610beb85 123 * 1 : Init done (IP not initialized)
AnnaBridge 126:abea610beb85 124 * b4-b2 (not used)
AnnaBridge 126:abea610beb85 125 * xxx : Should be set to 000
AnnaBridge 126:abea610beb85 126 * b1 Rx state
AnnaBridge 126:abea610beb85 127 * 0 : Ready (no Rx operation ongoing)
AnnaBridge 126:abea610beb85 128 * 1 : Busy (Rx operation ongoing)
AnnaBridge 126:abea610beb85 129 * b0 (not used)
AnnaBridge 126:abea610beb85 130 * x : Should be set to 0.
AnnaBridge 126:abea610beb85 131 */
AnnaBridge 126:abea610beb85 132 typedef enum
AnnaBridge 126:abea610beb85 133 {
AnnaBridge 126:abea610beb85 134 HAL_IRDA_STATE_RESET = 0x00U, /*!< Peripheral is not initialized
AnnaBridge 126:abea610beb85 135 Value is allowed for gState and RxState */
AnnaBridge 126:abea610beb85 136 HAL_IRDA_STATE_READY = 0x20U, /*!< Peripheral Initialized and ready for use
AnnaBridge 126:abea610beb85 137 Value is allowed for gState and RxState */
AnnaBridge 126:abea610beb85 138 HAL_IRDA_STATE_BUSY = 0x24U, /*!< an internal process is ongoing
AnnaBridge 126:abea610beb85 139 Value is allowed for gState only */
AnnaBridge 126:abea610beb85 140 HAL_IRDA_STATE_BUSY_TX = 0x21U, /*!< Data Transmission process is ongoing
AnnaBridge 126:abea610beb85 141 Value is allowed for gState only */
AnnaBridge 126:abea610beb85 142 HAL_IRDA_STATE_BUSY_RX = 0x22U, /*!< Data Reception process is ongoing
AnnaBridge 126:abea610beb85 143 Value is allowed for RxState only */
AnnaBridge 126:abea610beb85 144 HAL_IRDA_STATE_BUSY_TX_RX = 0x23U, /*!< Data Transmission and Reception process is ongoing
AnnaBridge 126:abea610beb85 145 Not to be used for neither gState nor RxState.
AnnaBridge 126:abea610beb85 146 Value is result of combination (Or) between gState and RxState values */
AnnaBridge 126:abea610beb85 147 HAL_IRDA_STATE_TIMEOUT = 0xA0U, /*!< Timeout state
AnnaBridge 126:abea610beb85 148 Value is allowed for gState only */
AnnaBridge 126:abea610beb85 149 HAL_IRDA_STATE_ERROR = 0xE0U /*!< Error
AnnaBridge 126:abea610beb85 150 Value is allowed for gState only */
AnnaBridge 126:abea610beb85 151 }HAL_IRDA_StateTypeDef;
AnnaBridge 126:abea610beb85 152
AnnaBridge 126:abea610beb85 153 /**
AnnaBridge 126:abea610beb85 154 * @brief IRDA clock sources definition
AnnaBridge 126:abea610beb85 155 */
AnnaBridge 126:abea610beb85 156 typedef enum
AnnaBridge 126:abea610beb85 157 {
<> 135:176b8275d35d 158 IRDA_CLOCKSOURCE_PCLK1 = 0x00U, /*!< PCLK1 clock source */
<> 135:176b8275d35d 159 IRDA_CLOCKSOURCE_PCLK2 = 0x01U, /*!< PCLK2 clock source */
<> 135:176b8275d35d 160 IRDA_CLOCKSOURCE_HSI = 0x02U, /*!< HSI clock source */
<> 135:176b8275d35d 161 IRDA_CLOCKSOURCE_SYSCLK = 0x04U, /*!< SYSCLK clock source */
<> 135:176b8275d35d 162 IRDA_CLOCKSOURCE_LSE = 0x08U, /*!< LSE clock source */
<> 135:176b8275d35d 163 IRDA_CLOCKSOURCE_UNDEFINED = 0x10U /*!< Undefined clock source */
AnnaBridge 126:abea610beb85 164 }IRDA_ClockSourceTypeDef;
AnnaBridge 126:abea610beb85 165
AnnaBridge 126:abea610beb85 166 /**
AnnaBridge 126:abea610beb85 167 * @brief IRDA handle Structure definition
AnnaBridge 126:abea610beb85 168 */
AnnaBridge 126:abea610beb85 169 typedef struct
AnnaBridge 126:abea610beb85 170 {
<> 135:176b8275d35d 171 USART_TypeDef *Instance; /*!< IRDA registers base address */
AnnaBridge 126:abea610beb85 172
AnnaBridge 126:abea610beb85 173 IRDA_InitTypeDef Init; /*!< IRDA communication parameters */
AnnaBridge 126:abea610beb85 174
AnnaBridge 126:abea610beb85 175 uint8_t *pTxBuffPtr; /*!< Pointer to IRDA Tx transfer Buffer */
AnnaBridge 126:abea610beb85 176
AnnaBridge 126:abea610beb85 177 uint16_t TxXferSize; /*!< IRDA Tx Transfer size */
AnnaBridge 126:abea610beb85 178
<> 135:176b8275d35d 179 __IO uint16_t TxXferCount; /*!< IRDA Tx Transfer Counter */
AnnaBridge 126:abea610beb85 180
AnnaBridge 126:abea610beb85 181 uint8_t *pRxBuffPtr; /*!< Pointer to IRDA Rx transfer Buffer */
AnnaBridge 126:abea610beb85 182
AnnaBridge 126:abea610beb85 183 uint16_t RxXferSize; /*!< IRDA Rx Transfer size */
AnnaBridge 126:abea610beb85 184
<> 135:176b8275d35d 185 __IO uint16_t RxXferCount; /*!< IRDA Rx Transfer Counter */
AnnaBridge 126:abea610beb85 186
<> 135:176b8275d35d 187 uint16_t Mask; /*!< IRDA RX RDR register mask */
AnnaBridge 126:abea610beb85 188
AnnaBridge 126:abea610beb85 189 DMA_HandleTypeDef *hdmatx; /*!< IRDA Tx DMA Handle parameters */
AnnaBridge 126:abea610beb85 190
AnnaBridge 126:abea610beb85 191 DMA_HandleTypeDef *hdmarx; /*!< IRDA Rx DMA Handle parameters */
AnnaBridge 126:abea610beb85 192
AnnaBridge 126:abea610beb85 193 HAL_LockTypeDef Lock; /*!< Locking object */
AnnaBridge 126:abea610beb85 194
AnnaBridge 126:abea610beb85 195 __IO HAL_IRDA_StateTypeDef gState; /*!< IRDA state information related to global Handle management
AnnaBridge 126:abea610beb85 196 and also related to Tx operations.
AnnaBridge 126:abea610beb85 197 This parameter can be a value of @ref HAL_IRDA_StateTypeDef */
AnnaBridge 126:abea610beb85 198
AnnaBridge 126:abea610beb85 199 __IO HAL_IRDA_StateTypeDef RxState; /*!< IRDA state information related to Rx operations.
AnnaBridge 126:abea610beb85 200 This parameter can be a value of @ref HAL_IRDA_StateTypeDef */
AnnaBridge 126:abea610beb85 201
AnnaBridge 126:abea610beb85 202 __IO uint32_t ErrorCode; /*!< IRDA Error code
AnnaBridge 126:abea610beb85 203 This parameter can be a value of @ref IRDA_Error */
AnnaBridge 126:abea610beb85 204
AnnaBridge 126:abea610beb85 205 }IRDA_HandleTypeDef;
AnnaBridge 126:abea610beb85 206
AnnaBridge 126:abea610beb85 207 /**
AnnaBridge 126:abea610beb85 208 * @brief IRDA Configuration enumeration values definition
AnnaBridge 126:abea610beb85 209 */
AnnaBridge 126:abea610beb85 210 typedef enum
AnnaBridge 126:abea610beb85 211 {
<> 135:176b8275d35d 212 IRDA_BAUDRATE = 0x00U, /*!< IRDA Baud rate */
<> 135:176b8275d35d 213 IRDA_PARITY = 0x01U, /*!< IRDA frame parity */
<> 135:176b8275d35d 214 IRDA_WORDLENGTH = 0x02U, /*!< IRDA frame length */
<> 135:176b8275d35d 215 IRDA_MODE = 0x03U, /*!< IRDA communication mode */
<> 135:176b8275d35d 216 IRDA_PRESCALER = 0x04U, /*!< IRDA prescaling */
<> 135:176b8275d35d 217 IRDA_POWERMODE = 0x05U /*!< IRDA power mode */
AnnaBridge 126:abea610beb85 218 }IRDA_ControlTypeDef;
AnnaBridge 126:abea610beb85 219
AnnaBridge 126:abea610beb85 220 /**
AnnaBridge 126:abea610beb85 221 * @}
AnnaBridge 126:abea610beb85 222 */
AnnaBridge 126:abea610beb85 223
AnnaBridge 126:abea610beb85 224 /* Exported constants --------------------------------------------------------*/
AnnaBridge 126:abea610beb85 225 /** @defgroup IRDA_Exported_Constants IRDA Exported Constants
AnnaBridge 126:abea610beb85 226 * @{
AnnaBridge 126:abea610beb85 227 */
AnnaBridge 126:abea610beb85 228
AnnaBridge 126:abea610beb85 229 /** @defgroup IRDA_Error IRDA Error
AnnaBridge 126:abea610beb85 230 * @{
AnnaBridge 126:abea610beb85 231 */
<> 135:176b8275d35d 232 #define HAL_IRDA_ERROR_NONE (0x00000000U) /*!< No error */
<> 135:176b8275d35d 233 #define HAL_IRDA_ERROR_PE (0x00000001U) /*!< Parity error */
<> 135:176b8275d35d 234 #define HAL_IRDA_ERROR_NE (0x00000002U) /*!< Noise error */
<> 135:176b8275d35d 235 #define HAL_IRDA_ERROR_FE (0x00000004U) /*!< frame error */
<> 135:176b8275d35d 236 #define HAL_IRDA_ERROR_ORE (0x00000008U) /*!< Overrun error */
<> 135:176b8275d35d 237 #define HAL_IRDA_ERROR_DMA (0x00000010U) /*!< DMA transfer error */
<> 135:176b8275d35d 238 #define HAL_IRDA_ERROR_BUSY (0x00000020U) /*!< Busy Error */
AnnaBridge 126:abea610beb85 239 /**
AnnaBridge 126:abea610beb85 240 * @}
AnnaBridge 126:abea610beb85 241 */
AnnaBridge 126:abea610beb85 242
AnnaBridge 126:abea610beb85 243 /** @defgroup IRDA_Parity IRDA Parity
AnnaBridge 126:abea610beb85 244 * @{
AnnaBridge 126:abea610beb85 245 */
<> 135:176b8275d35d 246 #define IRDA_PARITY_NONE (0x00000000U) /*!< No parity */
AnnaBridge 126:abea610beb85 247 #define IRDA_PARITY_EVEN ((uint32_t)USART_CR1_PCE) /*!< Even parity */
AnnaBridge 126:abea610beb85 248 #define IRDA_PARITY_ODD ((uint32_t)(USART_CR1_PCE | USART_CR1_PS)) /*!< Odd parity */
AnnaBridge 126:abea610beb85 249 /**
AnnaBridge 126:abea610beb85 250 * @}
AnnaBridge 126:abea610beb85 251 */
AnnaBridge 126:abea610beb85 252
AnnaBridge 126:abea610beb85 253 /** @defgroup IRDA_Transfer_Mode IRDA Transfer Mode
AnnaBridge 126:abea610beb85 254 * @{
AnnaBridge 126:abea610beb85 255 */
AnnaBridge 126:abea610beb85 256 #define IRDA_MODE_RX ((uint32_t)USART_CR1_RE) /*!< RX mode */
AnnaBridge 126:abea610beb85 257 #define IRDA_MODE_TX ((uint32_t)USART_CR1_TE) /*!< TX mode */
AnnaBridge 126:abea610beb85 258 #define IRDA_MODE_TX_RX ((uint32_t)(USART_CR1_TE |USART_CR1_RE)) /*!< RX and TX mode */
AnnaBridge 126:abea610beb85 259 /**
AnnaBridge 126:abea610beb85 260 * @}
AnnaBridge 126:abea610beb85 261 */
AnnaBridge 126:abea610beb85 262
AnnaBridge 126:abea610beb85 263 /** @defgroup IRDA_Low_Power IRDA Low Power
AnnaBridge 126:abea610beb85 264 * @{
AnnaBridge 126:abea610beb85 265 */
<> 135:176b8275d35d 266 #define IRDA_POWERMODE_NORMAL (0x00000000U) /*!< IRDA normal power mode */
AnnaBridge 126:abea610beb85 267 #define IRDA_POWERMODE_LOWPOWER ((uint32_t)USART_CR3_IRLP) /*!< IRDA low power mode */
AnnaBridge 126:abea610beb85 268 /**
AnnaBridge 126:abea610beb85 269 * @}
AnnaBridge 126:abea610beb85 270 */
AnnaBridge 126:abea610beb85 271
AnnaBridge 126:abea610beb85 272 /** @defgroup IRDA_State IRDA State
AnnaBridge 126:abea610beb85 273 * @{
AnnaBridge 126:abea610beb85 274 */
<> 135:176b8275d35d 275 #define IRDA_STATE_DISABLE (0x00000000U) /*!< IRDA disabled */
AnnaBridge 126:abea610beb85 276 #define IRDA_STATE_ENABLE ((uint32_t)USART_CR1_UE) /*!< IRDA enabled */
AnnaBridge 126:abea610beb85 277 /**
AnnaBridge 126:abea610beb85 278 * @}
AnnaBridge 126:abea610beb85 279 */
AnnaBridge 126:abea610beb85 280
AnnaBridge 126:abea610beb85 281 /** @defgroup IRDA_Mode IRDA Mode
AnnaBridge 126:abea610beb85 282 * @{
AnnaBridge 126:abea610beb85 283 */
<> 135:176b8275d35d 284 #define IRDA_MODE_DISABLE (0x00000000U) /*!< Associated UART disabled in IRDA mode */
AnnaBridge 126:abea610beb85 285 #define IRDA_MODE_ENABLE ((uint32_t)USART_CR3_IREN) /*!< Associated UART enabled in IRDA mode */
AnnaBridge 126:abea610beb85 286 /**
AnnaBridge 126:abea610beb85 287 * @}
AnnaBridge 126:abea610beb85 288 */
AnnaBridge 126:abea610beb85 289
AnnaBridge 126:abea610beb85 290 /** @defgroup IRDA_One_Bit IRDA One Bit Sampling
AnnaBridge 126:abea610beb85 291 * @{
AnnaBridge 126:abea610beb85 292 */
<> 135:176b8275d35d 293 #define IRDA_ONE_BIT_SAMPLE_DISABLE (0x00000000U) /*!< One-bit sampling disabled */
AnnaBridge 126:abea610beb85 294 #define IRDA_ONE_BIT_SAMPLE_ENABLE ((uint32_t)USART_CR3_ONEBIT) /*!< One-bit sampling enabled */
AnnaBridge 126:abea610beb85 295 /**
AnnaBridge 126:abea610beb85 296 * @}
AnnaBridge 126:abea610beb85 297 */
AnnaBridge 126:abea610beb85 298
AnnaBridge 126:abea610beb85 299 /** @defgroup IRDA_DMA_Tx IRDA DMA Tx
AnnaBridge 126:abea610beb85 300 * @{
AnnaBridge 126:abea610beb85 301 */
<> 135:176b8275d35d 302 #define IRDA_DMA_TX_DISABLE (0x00000000U) /*!< IRDA DMA TX disabled */
AnnaBridge 126:abea610beb85 303 #define IRDA_DMA_TX_ENABLE ((uint32_t)USART_CR3_DMAT) /*!< IRDA DMA TX enabled */
AnnaBridge 126:abea610beb85 304 /**
AnnaBridge 126:abea610beb85 305 * @}
AnnaBridge 126:abea610beb85 306 */
AnnaBridge 126:abea610beb85 307
AnnaBridge 126:abea610beb85 308 /** @defgroup IRDA_DMA_Rx IRDA DMA Rx
AnnaBridge 126:abea610beb85 309 * @{
AnnaBridge 126:abea610beb85 310 */
<> 135:176b8275d35d 311 #define IRDA_DMA_RX_DISABLE (0x00000000U) /*!< IRDA DMA RX disabled */
AnnaBridge 126:abea610beb85 312 #define IRDA_DMA_RX_ENABLE ((uint32_t)USART_CR3_DMAR) /*!< IRDA DMA RX enabled */
AnnaBridge 126:abea610beb85 313 /**
AnnaBridge 126:abea610beb85 314 * @}
AnnaBridge 126:abea610beb85 315 */
AnnaBridge 126:abea610beb85 316
AnnaBridge 126:abea610beb85 317 /** @defgroup IRDA_Request_Parameters IRDA Request Parameters
AnnaBridge 126:abea610beb85 318 * @{
AnnaBridge 126:abea610beb85 319 */
<> 135:176b8275d35d 320 #define IRDA_AUTOBAUD_REQUEST ((uint32_t)USART_RQR_ABRRQ) /*!< Auto-Baud Rate Request */
<> 135:176b8275d35d 321 #define IRDA_RXDATA_FLUSH_REQUEST ((uint32_t)USART_RQR_RXFRQ) /*!< Receive Data flush Request */
AnnaBridge 126:abea610beb85 322 #define IRDA_TXDATA_FLUSH_REQUEST ((uint32_t)USART_RQR_TXFRQ) /*!< Transmit data flush Request */
AnnaBridge 126:abea610beb85 323 /**
AnnaBridge 126:abea610beb85 324 * @}
AnnaBridge 126:abea610beb85 325 */
AnnaBridge 126:abea610beb85 326
AnnaBridge 126:abea610beb85 327 /** @defgroup IRDA_Flags IRDA Flags
AnnaBridge 126:abea610beb85 328 * Elements values convention: 0xXXXX
AnnaBridge 126:abea610beb85 329 * - 0xXXXX : Flag mask in the ISR register
AnnaBridge 126:abea610beb85 330 * @{
AnnaBridge 126:abea610beb85 331 */
<> 135:176b8275d35d 332 #define IRDA_FLAG_REACK (0x00400000U) /*!< IRDA Receive enable acknowledge flag */
<> 135:176b8275d35d 333 #define IRDA_FLAG_TEACK (0x00200000U) /*!< IRDA Transmit enable acknowledge flag */
<> 135:176b8275d35d 334 #define IRDA_FLAG_BUSY (0x00010000U) /*!< IRDA Busy flag */
<> 135:176b8275d35d 335 #define IRDA_FLAG_ABRF (0x00008000U) /*!< IRDA Auto baud rate flag */
<> 135:176b8275d35d 336 #define IRDA_FLAG_ABRE (0x00004000U) /*!< IRDA Auto baud rate error */
<> 135:176b8275d35d 337 #define IRDA_FLAG_TXE (0x00000080U) /*!< IRDA Transmit data register empty */
<> 135:176b8275d35d 338 #define IRDA_FLAG_TC (0x00000040U) /*!< IRDA Transmission complete */
<> 135:176b8275d35d 339 #define IRDA_FLAG_RXNE (0x00000020U) /*!< IRDA Read data register not empty */
<> 135:176b8275d35d 340 #define IRDA_FLAG_ORE (0x00000008U) /*!< IRDA Overrun error */
<> 135:176b8275d35d 341 #define IRDA_FLAG_NE (0x00000004U) /*!< IRDA Noise error */
<> 135:176b8275d35d 342 #define IRDA_FLAG_FE (0x00000002U) /*!< IRDA Framing error */
<> 135:176b8275d35d 343 #define IRDA_FLAG_PE (0x00000001U) /*!< IRDA Parity error */
AnnaBridge 126:abea610beb85 344 /**
AnnaBridge 126:abea610beb85 345 * @}
AnnaBridge 126:abea610beb85 346 */
AnnaBridge 126:abea610beb85 347
AnnaBridge 126:abea610beb85 348 /** @defgroup IRDA_Interrupt_definition IRDA Interrupts Definition
AnnaBridge 126:abea610beb85 349 * Elements values convention: 0000ZZZZ0XXYYYYYb
AnnaBridge 126:abea610beb85 350 * - YYYYY : Interrupt source position in the XX register (5bits)
AnnaBridge 126:abea610beb85 351 * - XX : Interrupt source register (2bits)
AnnaBridge 126:abea610beb85 352 * - 01: CR1 register
AnnaBridge 126:abea610beb85 353 * - 10: CR2 register
AnnaBridge 126:abea610beb85 354 * - 11: CR3 register
AnnaBridge 126:abea610beb85 355 * - ZZZZ : Flag position in the ISR register(4bits)
AnnaBridge 126:abea610beb85 356 * @{
AnnaBridge 126:abea610beb85 357 */
<> 135:176b8275d35d 358 #define IRDA_IT_PE ((uint16_t)0x0028U) /*!< IRDA Parity error interruption */
<> 135:176b8275d35d 359 #define IRDA_IT_TXE ((uint16_t)0x0727U) /*!< IRDA Transmit data register empty interruption */
<> 135:176b8275d35d 360 #define IRDA_IT_TC ((uint16_t)0x0626U) /*!< IRDA Transmission complete interruption */
<> 135:176b8275d35d 361 #define IRDA_IT_RXNE ((uint16_t)0x0525U) /*!< IRDA Read data register not empty interruption */
<> 135:176b8275d35d 362 #define IRDA_IT_IDLE ((uint16_t)0x0424U) /*!< IRDA Idle interruption */
<> 135:176b8275d35d 363 #define IRDA_IT_ERR ((uint16_t)0x0060U) /*!< IRDA Error interruption */
<> 135:176b8275d35d 364 #define IRDA_IT_ORE ((uint16_t)0x0300U) /*!< IRDA Overrun error interruption */
<> 135:176b8275d35d 365 #define IRDA_IT_NE ((uint16_t)0x0200U) /*!< IRDA Noise error interruption */
<> 135:176b8275d35d 366 #define IRDA_IT_FE ((uint16_t)0x0100U) /*!< IRDA Frame error interruption */
AnnaBridge 126:abea610beb85 367 /**
AnnaBridge 126:abea610beb85 368 * @}
AnnaBridge 126:abea610beb85 369 */
AnnaBridge 126:abea610beb85 370
AnnaBridge 126:abea610beb85 371 /** @defgroup IRDA_IT_CLEAR_Flags IRDA Interruption Clear Flags
AnnaBridge 126:abea610beb85 372 * @{
AnnaBridge 126:abea610beb85 373 */
<> 135:176b8275d35d 374 #define IRDA_CLEAR_PEF USART_ICR_PECF /*!< Parity Error Clear Flag */
<> 135:176b8275d35d 375 #define IRDA_CLEAR_FEF USART_ICR_FECF /*!< Framing Error Clear Flag */
<> 135:176b8275d35d 376 #define IRDA_CLEAR_NEF USART_ICR_NCF /*!< Noise detected Clear Flag */
<> 135:176b8275d35d 377 #define IRDA_CLEAR_OREF USART_ICR_ORECF /*!< OverRun Error Clear Flag */
<> 135:176b8275d35d 378 #define IRDA_CLEAR_IDLEF USART_ICR_IDLECF /*!< IDLE line detected Clear Flag */
AnnaBridge 126:abea610beb85 379 #define IRDA_CLEAR_TCF USART_ICR_TCCF /*!< Transmission Complete Clear Flag */
AnnaBridge 126:abea610beb85 380 /**
AnnaBridge 126:abea610beb85 381 * @}
AnnaBridge 126:abea610beb85 382 */
AnnaBridge 126:abea610beb85 383
AnnaBridge 126:abea610beb85 384 /** @defgroup IRDA_Interruption_Mask IRDA interruptions flags mask
AnnaBridge 126:abea610beb85 385 * @{
AnnaBridge 126:abea610beb85 386 */
<> 135:176b8275d35d 387 #define IRDA_IT_MASK ((uint16_t)0x001FU) /*!< IRDA Interruptions flags mask */
AnnaBridge 126:abea610beb85 388 /**
AnnaBridge 126:abea610beb85 389 * @}
AnnaBridge 126:abea610beb85 390 */
AnnaBridge 126:abea610beb85 391
AnnaBridge 126:abea610beb85 392 /**
AnnaBridge 126:abea610beb85 393 * @}
AnnaBridge 126:abea610beb85 394 */
AnnaBridge 126:abea610beb85 395
AnnaBridge 126:abea610beb85 396
AnnaBridge 126:abea610beb85 397 /* Exported macros -----------------------------------------------------------*/
AnnaBridge 126:abea610beb85 398 /** @defgroup IRDA_Exported_Macros IRDA Exported Macros
AnnaBridge 126:abea610beb85 399 * @{
AnnaBridge 126:abea610beb85 400 */
AnnaBridge 126:abea610beb85 401
AnnaBridge 126:abea610beb85 402 /** @brief Reset IRDA handle state.
AnnaBridge 126:abea610beb85 403 * @param __HANDLE__: IRDA handle.
AnnaBridge 126:abea610beb85 404 * @retval None
AnnaBridge 126:abea610beb85 405 */
AnnaBridge 126:abea610beb85 406 #define __HAL_IRDA_RESET_HANDLE_STATE(__HANDLE__) do{ \
AnnaBridge 126:abea610beb85 407 (__HANDLE__)->gState = HAL_IRDA_STATE_RESET; \
AnnaBridge 126:abea610beb85 408 (__HANDLE__)->RxState = HAL_IRDA_STATE_RESET; \
<> 135:176b8275d35d 409 } while(0U)
AnnaBridge 126:abea610beb85 410
<> 135:176b8275d35d 411 /** @brief Flush the IRDA DR register.
AnnaBridge 126:abea610beb85 412 * @param __HANDLE__: specifies the IRDA Handle.
AnnaBridge 126:abea610beb85 413 * @retval None
AnnaBridge 126:abea610beb85 414 */
AnnaBridge 126:abea610beb85 415 #define __HAL_IRDA_FLUSH_DRREGISTER(__HANDLE__) \
AnnaBridge 126:abea610beb85 416 do{ \
AnnaBridge 126:abea610beb85 417 SET_BIT((__HANDLE__)->Instance->RQR, IRDA_RXDATA_FLUSH_REQUEST); \
AnnaBridge 126:abea610beb85 418 SET_BIT((__HANDLE__)->Instance->RQR, IRDA_TXDATA_FLUSH_REQUEST); \
<> 135:176b8275d35d 419 } while(0U)
AnnaBridge 126:abea610beb85 420
AnnaBridge 126:abea610beb85 421 /** @brief Clear the specified IRDA pending flag.
AnnaBridge 126:abea610beb85 422 * @param __HANDLE__: specifies the IRDA Handle.
AnnaBridge 126:abea610beb85 423 * @param __FLAG__: specifies the flag to check.
AnnaBridge 126:abea610beb85 424 * This parameter can be any combination of the following values:
<> 135:176b8275d35d 425 * @arg @ref IRDA_CLEAR_PEF
<> 135:176b8275d35d 426 * @arg @ref IRDA_CLEAR_FEF
<> 135:176b8275d35d 427 * @arg @ref IRDA_CLEAR_NEF
<> 135:176b8275d35d 428 * @arg @ref IRDA_CLEAR_OREF
<> 135:176b8275d35d 429 * @arg @ref IRDA_CLEAR_TCF
<> 135:176b8275d35d 430 * @arg @ref IRDA_CLEAR_IDLEF
AnnaBridge 126:abea610beb85 431 * @retval None
AnnaBridge 126:abea610beb85 432 */
AnnaBridge 126:abea610beb85 433 #define __HAL_IRDA_CLEAR_FLAG(__HANDLE__, __FLAG__) ((__HANDLE__)->Instance->ICR = (__FLAG__))
AnnaBridge 126:abea610beb85 434
AnnaBridge 126:abea610beb85 435 /** @brief Clear the IRDA PE pending flag.
AnnaBridge 126:abea610beb85 436 * @param __HANDLE__: specifies the IRDA Handle.
AnnaBridge 126:abea610beb85 437 * @retval None
AnnaBridge 126:abea610beb85 438 */
AnnaBridge 126:abea610beb85 439 #define __HAL_IRDA_CLEAR_PEFLAG(__HANDLE__) __HAL_IRDA_CLEAR_FLAG((__HANDLE__), IRDA_CLEAR_PEF)
AnnaBridge 126:abea610beb85 440
AnnaBridge 126:abea610beb85 441
AnnaBridge 126:abea610beb85 442 /** @brief Clear the IRDA FE pending flag.
AnnaBridge 126:abea610beb85 443 * @param __HANDLE__: specifies the IRDA Handle.
AnnaBridge 126:abea610beb85 444 * @retval None
AnnaBridge 126:abea610beb85 445 */
AnnaBridge 126:abea610beb85 446 #define __HAL_IRDA_CLEAR_FEFLAG(__HANDLE__) __HAL_IRDA_CLEAR_FLAG((__HANDLE__), IRDA_CLEAR_FEF)
AnnaBridge 126:abea610beb85 447
AnnaBridge 126:abea610beb85 448 /** @brief Clear the IRDA NE pending flag.
AnnaBridge 126:abea610beb85 449 * @param __HANDLE__: specifies the IRDA Handle.
AnnaBridge 126:abea610beb85 450 * @retval None
AnnaBridge 126:abea610beb85 451 */
AnnaBridge 126:abea610beb85 452 #define __HAL_IRDA_CLEAR_NEFLAG(__HANDLE__) __HAL_IRDA_CLEAR_FLAG((__HANDLE__), IRDA_CLEAR_NEF)
AnnaBridge 126:abea610beb85 453
AnnaBridge 126:abea610beb85 454 /** @brief Clear the IRDA ORE pending flag.
AnnaBridge 126:abea610beb85 455 * @param __HANDLE__: specifies the IRDA Handle.
AnnaBridge 126:abea610beb85 456 * @retval None
AnnaBridge 126:abea610beb85 457 */
AnnaBridge 126:abea610beb85 458 #define __HAL_IRDA_CLEAR_OREFLAG(__HANDLE__) __HAL_IRDA_CLEAR_FLAG((__HANDLE__), IRDA_CLEAR_OREF)
AnnaBridge 126:abea610beb85 459
AnnaBridge 126:abea610beb85 460 /** @brief Clear the IRDA IDLE pending flag.
AnnaBridge 126:abea610beb85 461 * @param __HANDLE__: specifies the IRDA Handle.
AnnaBridge 126:abea610beb85 462 * @retval None
AnnaBridge 126:abea610beb85 463 */
AnnaBridge 126:abea610beb85 464 #define __HAL_IRDA_CLEAR_IDLEFLAG(__HANDLE__) __HAL_IRDA_CLEAR_FLAG((__HANDLE__), IRDA_CLEAR_IDLEF)
AnnaBridge 126:abea610beb85 465
AnnaBridge 126:abea610beb85 466 /** @brief Check whether the specified IRDA flag is set or not.
AnnaBridge 126:abea610beb85 467 * @param __HANDLE__: specifies the IRDA Handle.
AnnaBridge 126:abea610beb85 468 * @param __FLAG__: specifies the flag to check.
AnnaBridge 126:abea610beb85 469 * This parameter can be one of the following values:
<> 135:176b8275d35d 470 * @arg @ref IRDA_FLAG_REACK Receive enable acknowledge flag
<> 135:176b8275d35d 471 * @arg @ref IRDA_FLAG_TEACK Transmit enable acknowledge flag
<> 135:176b8275d35d 472 * @arg @ref IRDA_FLAG_BUSY Busy flag
<> 135:176b8275d35d 473 * @arg @ref IRDA_FLAG_ABRF Auto Baud rate detection flag
<> 135:176b8275d35d 474 * @arg @ref IRDA_FLAG_ABRE Auto Baud rate detection error flag
<> 135:176b8275d35d 475 * @arg @ref IRDA_FLAG_TXE Transmit data register empty flag
<> 135:176b8275d35d 476 * @arg @ref IRDA_FLAG_TC Transmission Complete flag
<> 135:176b8275d35d 477 * @arg @ref IRDA_FLAG_RXNE Receive data register not empty flag
<> 135:176b8275d35d 478 * @arg @ref IRDA_FLAG_ORE OverRun Error flag
<> 135:176b8275d35d 479 * @arg @ref IRDA_FLAG_NE Noise Error flag
<> 135:176b8275d35d 480 * @arg @ref IRDA_FLAG_FE Framing Error flag
<> 135:176b8275d35d 481 * @arg @ref IRDA_FLAG_PE Parity Error flag
AnnaBridge 126:abea610beb85 482 * @retval The new state of __FLAG__ (TRUE or FALSE).
AnnaBridge 126:abea610beb85 483 */
AnnaBridge 126:abea610beb85 484 #define __HAL_IRDA_GET_FLAG(__HANDLE__, __FLAG__) (((__HANDLE__)->Instance->ISR & (__FLAG__)) == (__FLAG__))
AnnaBridge 126:abea610beb85 485
AnnaBridge 126:abea610beb85 486
AnnaBridge 126:abea610beb85 487 /** @brief Enable the specified IRDA interrupt.
AnnaBridge 126:abea610beb85 488 * @param __HANDLE__: specifies the IRDA Handle.
AnnaBridge 126:abea610beb85 489 * @param __INTERRUPT__: specifies the IRDA interrupt source to enable.
AnnaBridge 126:abea610beb85 490 * This parameter can be one of the following values:
<> 135:176b8275d35d 491 * @arg @ref IRDA_IT_TXE Transmit Data Register empty interrupt
<> 135:176b8275d35d 492 * @arg @ref IRDA_IT_TC Transmission complete interrupt
<> 135:176b8275d35d 493 * @arg @ref IRDA_IT_RXNE Receive Data register not empty interrupt
<> 135:176b8275d35d 494 * @arg @ref IRDA_IT_IDLE Idle line detection interrupt
<> 135:176b8275d35d 495 * @arg @ref IRDA_IT_PE Parity Error interrupt
<> 135:176b8275d35d 496 * @arg @ref IRDA_IT_ERR Error interrupt(Frame error, noise error, overrun error)
AnnaBridge 126:abea610beb85 497 * @retval None
AnnaBridge 126:abea610beb85 498 */
<> 135:176b8275d35d 499 #define __HAL_IRDA_ENABLE_IT(__HANDLE__, __INTERRUPT__) (((((uint8_t)(__INTERRUPT__)) >> 5U) == 1U)? ((__HANDLE__)->Instance->CR1 |= (1U << ((__INTERRUPT__) & IRDA_IT_MASK))): \
<> 135:176b8275d35d 500 ((((uint8_t)(__INTERRUPT__)) >> 5U) == 2U)? ((__HANDLE__)->Instance->CR2 |= (1U << ((__INTERRUPT__) & IRDA_IT_MASK))): \
AnnaBridge 126:abea610beb85 501 ((__HANDLE__)->Instance->CR3 |= (1U << ((__INTERRUPT__) & IRDA_IT_MASK))))
AnnaBridge 126:abea610beb85 502
AnnaBridge 126:abea610beb85 503 /** @brief Disable the specified IRDA interrupt.
AnnaBridge 126:abea610beb85 504 * @param __HANDLE__: specifies the IRDA Handle.
AnnaBridge 126:abea610beb85 505 * @param __INTERRUPT__: specifies the IRDA interrupt source to disable.
AnnaBridge 126:abea610beb85 506 * This parameter can be one of the following values:
<> 135:176b8275d35d 507 * @arg @ref IRDA_IT_TXE Transmit Data Register empty interrupt
<> 135:176b8275d35d 508 * @arg @ref IRDA_IT_TC Transmission complete interrupt
<> 135:176b8275d35d 509 * @arg @ref IRDA_IT_RXNE Receive Data register not empty interrupt
<> 135:176b8275d35d 510 * @arg @ref IRDA_IT_IDLE Idle line detection interrupt
<> 135:176b8275d35d 511 * @arg @ref IRDA_IT_PE Parity Error interrupt
<> 135:176b8275d35d 512 * @arg @ref IRDA_IT_ERR Error interrupt(Frame error, noise error, overrun error)
AnnaBridge 126:abea610beb85 513 * @retval None
AnnaBridge 126:abea610beb85 514 */
<> 135:176b8275d35d 515 #define __HAL_IRDA_DISABLE_IT(__HANDLE__, __INTERRUPT__) (((((uint8_t)(__INTERRUPT__)) >> 5U) == 1U)? ((__HANDLE__)->Instance->CR1 &= ~ (1U << ((__INTERRUPT__) & IRDA_IT_MASK))): \
<> 135:176b8275d35d 516 ((((uint8_t)(__INTERRUPT__)) >> 5U) == 2U)? ((__HANDLE__)->Instance->CR2 &= ~ (1U << ((__INTERRUPT__) & IRDA_IT_MASK))): \
AnnaBridge 126:abea610beb85 517 ((__HANDLE__)->Instance->CR3 &= ~ (1U << ((__INTERRUPT__) & IRDA_IT_MASK))))
AnnaBridge 126:abea610beb85 518
AnnaBridge 126:abea610beb85 519
AnnaBridge 126:abea610beb85 520 /** @brief Check whether the specified IRDA interrupt has occurred or not.
AnnaBridge 126:abea610beb85 521 * @param __HANDLE__: specifies the IRDA Handle.
AnnaBridge 126:abea610beb85 522 * @param __IT__: specifies the IRDA interrupt source to check.
AnnaBridge 126:abea610beb85 523 * This parameter can be one of the following values:
<> 135:176b8275d35d 524 * @arg @ref IRDA_IT_TXE Transmit Data Register empty interrupt
<> 135:176b8275d35d 525 * @arg @ref IRDA_IT_TC Transmission complete interrupt
<> 135:176b8275d35d 526 * @arg @ref IRDA_IT_RXNE Receive Data register not empty interrupt
<> 135:176b8275d35d 527 * @arg @ref IRDA_IT_IDLE Idle line detection interrupt
<> 135:176b8275d35d 528 * @arg @ref IRDA_IT_ORE OverRun Error interrupt
<> 135:176b8275d35d 529 * @arg @ref IRDA_IT_NE Noise Error interrupt
<> 135:176b8275d35d 530 * @arg @ref IRDA_IT_FE Framing Error interrupt
<> 135:176b8275d35d 531 * @arg @ref IRDA_IT_PE Parity Error interrupt
AnnaBridge 126:abea610beb85 532 * @retval The new state of __IT__ (TRUE or FALSE).
AnnaBridge 126:abea610beb85 533 */
<> 135:176b8275d35d 534 #define __HAL_IRDA_GET_IT(__HANDLE__, __IT__) ((__HANDLE__)->Instance->ISR & (1U << ((__IT__)>> 0x08U)))
AnnaBridge 126:abea610beb85 535
AnnaBridge 126:abea610beb85 536 /** @brief Check whether the specified IRDA interrupt source is enabled or not.
AnnaBridge 126:abea610beb85 537 * @param __HANDLE__: specifies the IRDA Handle.
AnnaBridge 126:abea610beb85 538 * @param __IT__: specifies the IRDA interrupt source to check.
AnnaBridge 126:abea610beb85 539 * This parameter can be one of the following values:
<> 135:176b8275d35d 540 * @arg @ref IRDA_IT_TXE Transmit Data Register empty interrupt
<> 135:176b8275d35d 541 * @arg @ref IRDA_IT_TC Transmission complete interrupt
<> 135:176b8275d35d 542 * @arg @ref IRDA_IT_RXNE Receive Data register not empty interrupt
<> 135:176b8275d35d 543 * @arg @ref IRDA_IT_IDLE Idle line detection interrupt
<> 135:176b8275d35d 544 * @arg @ref IRDA_IT_ERR Framing, overrun or noise error interrupt
<> 135:176b8275d35d 545 * @arg @ref IRDA_IT_PE Parity Error interrupt
AnnaBridge 126:abea610beb85 546 * @retval The new state of __IT__ (TRUE or FALSE).
AnnaBridge 126:abea610beb85 547 */
<> 135:176b8275d35d 548 #define __HAL_IRDA_GET_IT_SOURCE(__HANDLE__, __IT__) ((((((uint8_t)(__IT__)) >> 5U) == 1U)? (__HANDLE__)->Instance->CR1:(((((uint8_t)(__IT__)) >> 5U) == 2U)? \
<> 135:176b8275d35d 549 (__HANDLE__)->Instance->CR2 : (__HANDLE__)->Instance->CR3)) & (1U << (((uint16_t)(__IT__)) & IRDA_IT_MASK)))
AnnaBridge 126:abea610beb85 550
AnnaBridge 126:abea610beb85 551
AnnaBridge 126:abea610beb85 552 /** @brief Clear the specified IRDA ISR flag, in setting the proper ICR register flag.
AnnaBridge 126:abea610beb85 553 * @param __HANDLE__: specifies the IRDA Handle.
AnnaBridge 126:abea610beb85 554 * @param __IT_CLEAR__: specifies the interrupt clear register flag that needs to be set
AnnaBridge 126:abea610beb85 555 * to clear the corresponding interrupt
AnnaBridge 126:abea610beb85 556 * This parameter can be one of the following values:
<> 135:176b8275d35d 557 * @arg @ref IRDA_CLEAR_PEF Parity Error Clear Flag
<> 135:176b8275d35d 558 * @arg @ref IRDA_CLEAR_FEF Framing Error Clear Flag
<> 135:176b8275d35d 559 * @arg @ref IRDA_CLEAR_NEF Noise detected Clear Flag
<> 135:176b8275d35d 560 * @arg @ref IRDA_CLEAR_OREF OverRun Error Clear Flag
<> 135:176b8275d35d 561 * @arg @ref IRDA_CLEAR_TCF Transmission Complete Clear Flag
AnnaBridge 126:abea610beb85 562 * @retval None
AnnaBridge 126:abea610beb85 563 */
AnnaBridge 126:abea610beb85 564 #define __HAL_IRDA_CLEAR_IT(__HANDLE__, __IT_CLEAR__) ((__HANDLE__)->Instance->ICR = (uint32_t)(__IT_CLEAR__))
AnnaBridge 126:abea610beb85 565
AnnaBridge 126:abea610beb85 566
AnnaBridge 126:abea610beb85 567 /** @brief Set a specific IRDA request flag.
AnnaBridge 126:abea610beb85 568 * @param __HANDLE__: specifies the IRDA Handle.
AnnaBridge 126:abea610beb85 569 * @param __REQ__: specifies the request flag to set
AnnaBridge 126:abea610beb85 570 * This parameter can be one of the following values:
<> 135:176b8275d35d 571 * @arg @ref IRDA_AUTOBAUD_REQUEST Auto-Baud Rate Request
<> 135:176b8275d35d 572 * @arg @ref IRDA_RXDATA_FLUSH_REQUEST Receive Data flush Request
<> 135:176b8275d35d 573 * @arg @ref IRDA_TXDATA_FLUSH_REQUEST Transmit data flush Request
AnnaBridge 126:abea610beb85 574 *
AnnaBridge 126:abea610beb85 575 * @retval None
AnnaBridge 126:abea610beb85 576 */
AnnaBridge 126:abea610beb85 577 #define __HAL_IRDA_SEND_REQ(__HANDLE__, __REQ__) ((__HANDLE__)->Instance->RQR |= (uint16_t)(__REQ__))
AnnaBridge 126:abea610beb85 578
AnnaBridge 126:abea610beb85 579 /** @brief Enable the IRDA one bit sample method.
AnnaBridge 126:abea610beb85 580 * @param __HANDLE__: specifies the IRDA Handle.
AnnaBridge 126:abea610beb85 581 * @retval None
<> 135:176b8275d35d 582 */
AnnaBridge 126:abea610beb85 583 #define __HAL_IRDA_ONE_BIT_SAMPLE_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->CR3|= USART_CR3_ONEBIT)
AnnaBridge 126:abea610beb85 584
AnnaBridge 126:abea610beb85 585 /** @brief Disable the IRDA one bit sample method.
AnnaBridge 126:abea610beb85 586 * @param __HANDLE__: specifies the IRDA Handle.
AnnaBridge 126:abea610beb85 587 * @retval None
<> 135:176b8275d35d 588 */
AnnaBridge 126:abea610beb85 589 #define __HAL_IRDA_ONE_BIT_SAMPLE_DISABLE(__HANDLE__) ((__HANDLE__)->Instance->CR3 &= (uint32_t)~((uint32_t)USART_CR3_ONEBIT))
AnnaBridge 126:abea610beb85 590
AnnaBridge 126:abea610beb85 591 /** @brief Enable UART/USART associated to IRDA Handle.
AnnaBridge 126:abea610beb85 592 * @param __HANDLE__: specifies the IRDA Handle.
AnnaBridge 126:abea610beb85 593 * @retval None
AnnaBridge 126:abea610beb85 594 */
AnnaBridge 126:abea610beb85 595 #define __HAL_IRDA_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->CR1 |= USART_CR1_UE)
AnnaBridge 126:abea610beb85 596
AnnaBridge 126:abea610beb85 597 /** @brief Disable UART/USART associated to IRDA Handle.
AnnaBridge 126:abea610beb85 598 * @param __HANDLE__: specifies the IRDA Handle.
AnnaBridge 126:abea610beb85 599 * @retval None
AnnaBridge 126:abea610beb85 600 */
AnnaBridge 126:abea610beb85 601 #define __HAL_IRDA_DISABLE(__HANDLE__) ((__HANDLE__)->Instance->CR1 &= ~USART_CR1_UE)
AnnaBridge 126:abea610beb85 602
AnnaBridge 126:abea610beb85 603 /**
AnnaBridge 126:abea610beb85 604 * @}
AnnaBridge 126:abea610beb85 605 */
AnnaBridge 126:abea610beb85 606
AnnaBridge 126:abea610beb85 607 /* Private macros --------------------------------------------------------*/
AnnaBridge 126:abea610beb85 608 /** @defgroup IRDA_Private_Macros IRDA Private Macros
AnnaBridge 126:abea610beb85 609 * @{
AnnaBridge 126:abea610beb85 610 */
AnnaBridge 126:abea610beb85 611
AnnaBridge 126:abea610beb85 612 /** @brief Ensure that IRDA Baud rate is less or equal to maximum value.
AnnaBridge 126:abea610beb85 613 * @param __BAUDRATE__: specifies the IRDA Baudrate set by the user.
AnnaBridge 126:abea610beb85 614 * @retval True or False
AnnaBridge 126:abea610beb85 615 */
<> 135:176b8275d35d 616 #define IS_IRDA_BAUDRATE(__BAUDRATE__) ((__BAUDRATE__) < 115201U)
AnnaBridge 126:abea610beb85 617
AnnaBridge 126:abea610beb85 618 /** @brief Ensure that IRDA prescaler value is strictly larger than 0.
AnnaBridge 126:abea610beb85 619 * @param __PRESCALER__: specifies the IRDA prescaler value set by the user.
AnnaBridge 126:abea610beb85 620 * @retval True or False
AnnaBridge 126:abea610beb85 621 */
<> 135:176b8275d35d 622 #define IS_IRDA_PRESCALER(__PRESCALER__) ((__PRESCALER__) > 0U)
AnnaBridge 126:abea610beb85 623
AnnaBridge 126:abea610beb85 624 /**
AnnaBridge 126:abea610beb85 625 * @brief Ensure that IRDA frame parity is valid.
AnnaBridge 126:abea610beb85 626 * @param __PARITY__: IRDA frame parity.
AnnaBridge 126:abea610beb85 627 * @retval SET (__PARITY__ is valid) or RESET (__PARITY__ is invalid)
AnnaBridge 126:abea610beb85 628 */
AnnaBridge 126:abea610beb85 629 #define IS_IRDA_PARITY(__PARITY__) (((__PARITY__) == IRDA_PARITY_NONE) || \
AnnaBridge 126:abea610beb85 630 ((__PARITY__) == IRDA_PARITY_EVEN) || \
AnnaBridge 126:abea610beb85 631 ((__PARITY__) == IRDA_PARITY_ODD))
AnnaBridge 126:abea610beb85 632
AnnaBridge 126:abea610beb85 633 /**
AnnaBridge 126:abea610beb85 634 * @brief Ensure that IRDA communication mode is valid.
AnnaBridge 126:abea610beb85 635 * @param __MODE__: IRDA communication mode.
AnnaBridge 126:abea610beb85 636 * @retval SET (__MODE__ is valid) or RESET (__MODE__ is invalid)
AnnaBridge 126:abea610beb85 637 */
<> 135:176b8275d35d 638 #define IS_IRDA_TX_RX_MODE(__MODE__) ((((__MODE__) & (~((uint32_t)(IRDA_MODE_TX_RX)))) == 0x00U) && ((__MODE__) != 0x00U))
AnnaBridge 126:abea610beb85 639
AnnaBridge 126:abea610beb85 640 /**
AnnaBridge 126:abea610beb85 641 * @brief Ensure that IRDA power mode is valid.
AnnaBridge 126:abea610beb85 642 * @param __MODE__: IRDA power mode.
AnnaBridge 126:abea610beb85 643 * @retval SET (__MODE__ is valid) or RESET (__MODE__ is invalid)
AnnaBridge 126:abea610beb85 644 */
AnnaBridge 126:abea610beb85 645 #define IS_IRDA_POWERMODE(__MODE__) (((__MODE__) == IRDA_POWERMODE_LOWPOWER) || \
AnnaBridge 126:abea610beb85 646 ((__MODE__) == IRDA_POWERMODE_NORMAL))
AnnaBridge 126:abea610beb85 647
AnnaBridge 126:abea610beb85 648 /**
AnnaBridge 126:abea610beb85 649 * @brief Ensure that IRDA state is valid.
AnnaBridge 126:abea610beb85 650 * @param __STATE__: IRDA state mode.
AnnaBridge 126:abea610beb85 651 * @retval SET (__STATE__ is valid) or RESET (__STATE__ is invalid)
AnnaBridge 126:abea610beb85 652 */
AnnaBridge 126:abea610beb85 653 #define IS_IRDA_STATE(__STATE__) (((__STATE__) == IRDA_STATE_DISABLE) || \
AnnaBridge 126:abea610beb85 654 ((__STATE__) == IRDA_STATE_ENABLE))
AnnaBridge 126:abea610beb85 655
AnnaBridge 126:abea610beb85 656 /**
AnnaBridge 126:abea610beb85 657 * @brief Ensure that IRDA associated UART/USART mode is valid.
AnnaBridge 126:abea610beb85 658 * @param __MODE__: IRDA associated UART/USART mode.
AnnaBridge 126:abea610beb85 659 * @retval SET (__MODE__ is valid) or RESET (__MODE__ is invalid)
AnnaBridge 126:abea610beb85 660 */
AnnaBridge 126:abea610beb85 661 #define IS_IRDA_MODE(__MODE__) (((__MODE__) == IRDA_MODE_DISABLE) || \
AnnaBridge 126:abea610beb85 662 ((__MODE__) == IRDA_MODE_ENABLE))
AnnaBridge 126:abea610beb85 663
AnnaBridge 126:abea610beb85 664 /**
AnnaBridge 126:abea610beb85 665 * @brief Ensure that IRDA sampling rate is valid.
AnnaBridge 126:abea610beb85 666 * @param __ONEBIT__: IRDA sampling rate.
AnnaBridge 126:abea610beb85 667 * @retval SET (__ONEBIT__ is valid) or RESET (__ONEBIT__ is invalid)
AnnaBridge 126:abea610beb85 668 */
AnnaBridge 126:abea610beb85 669 #define IS_IRDA_ONE_BIT_SAMPLE(__ONEBIT__) (((__ONEBIT__) == IRDA_ONE_BIT_SAMPLE_DISABLE) || \
AnnaBridge 126:abea610beb85 670 ((__ONEBIT__) == IRDA_ONE_BIT_SAMPLE_ENABLE))
AnnaBridge 126:abea610beb85 671
AnnaBridge 126:abea610beb85 672 /**
AnnaBridge 126:abea610beb85 673 * @brief Ensure that IRDA DMA TX mode is valid.
AnnaBridge 126:abea610beb85 674 * @param __DMATX__: IRDA DMA TX mode.
AnnaBridge 126:abea610beb85 675 * @retval SET (__DMATX__ is valid) or RESET (__DMATX__ is invalid)
AnnaBridge 126:abea610beb85 676 */
AnnaBridge 126:abea610beb85 677 #define IS_IRDA_DMA_TX(__DMATX__) (((__DMATX__) == IRDA_DMA_TX_DISABLE) || \
AnnaBridge 126:abea610beb85 678 ((__DMATX__) == IRDA_DMA_TX_ENABLE))
AnnaBridge 126:abea610beb85 679
AnnaBridge 126:abea610beb85 680 /**
AnnaBridge 126:abea610beb85 681 * @brief Ensure that IRDA DMA RX mode is valid.
AnnaBridge 126:abea610beb85 682 * @param __DMARX__: IRDA DMA RX mode.
AnnaBridge 126:abea610beb85 683 * @retval SET (__DMARX__ is valid) or RESET (__DMARX__ is invalid)
AnnaBridge 126:abea610beb85 684 */
<> 135:176b8275d35d 685 #define IS_IRDA_DMA_RX(__DMARX__) (((__DMARX__) == IRDA_DMA_RX_DISABLE) || \
<> 135:176b8275d35d 686 ((__DMARX__) == IRDA_DMA_RX_ENABLE))
AnnaBridge 126:abea610beb85 687
AnnaBridge 126:abea610beb85 688 /**
AnnaBridge 126:abea610beb85 689 * @brief Ensure that IRDA request is valid.
AnnaBridge 126:abea610beb85 690 * @param __PARAM__: IRDA request.
AnnaBridge 126:abea610beb85 691 * @retval SET (__PARAM__ is valid) or RESET (__PARAM__ is invalid)
AnnaBridge 126:abea610beb85 692 */
AnnaBridge 126:abea610beb85 693 #define IS_IRDA_REQUEST_PARAMETER(__PARAM__) (((__PARAM__) == IRDA_AUTOBAUD_REQUEST) || \
AnnaBridge 126:abea610beb85 694 ((__PARAM__) == IRDA_RXDATA_FLUSH_REQUEST) || \
AnnaBridge 126:abea610beb85 695 ((__PARAM__) == IRDA_TXDATA_FLUSH_REQUEST))
AnnaBridge 126:abea610beb85 696 /**
AnnaBridge 126:abea610beb85 697 * @}
AnnaBridge 126:abea610beb85 698 */
AnnaBridge 126:abea610beb85 699
AnnaBridge 126:abea610beb85 700 /* Include IRDA HAL Extended module */
AnnaBridge 126:abea610beb85 701 #include "stm32f3xx_hal_irda_ex.h"
AnnaBridge 126:abea610beb85 702
AnnaBridge 126:abea610beb85 703 /* Exported functions --------------------------------------------------------*/
AnnaBridge 126:abea610beb85 704 /** @addtogroup IRDA_Exported_Functions IRDA Exported Functions
AnnaBridge 126:abea610beb85 705 * @{
AnnaBridge 126:abea610beb85 706 */
AnnaBridge 126:abea610beb85 707
AnnaBridge 126:abea610beb85 708 /** @addtogroup IRDA_Exported_Functions_Group1 Initialization and de-initialization functions
AnnaBridge 126:abea610beb85 709 * @{
AnnaBridge 126:abea610beb85 710 */
AnnaBridge 126:abea610beb85 711
AnnaBridge 126:abea610beb85 712 /* Initialization and de-initialization functions ****************************/
AnnaBridge 126:abea610beb85 713 HAL_StatusTypeDef HAL_IRDA_Init(IRDA_HandleTypeDef *hirda);
AnnaBridge 126:abea610beb85 714 HAL_StatusTypeDef HAL_IRDA_DeInit(IRDA_HandleTypeDef *hirda);
AnnaBridge 126:abea610beb85 715 void HAL_IRDA_MspInit(IRDA_HandleTypeDef *hirda);
AnnaBridge 126:abea610beb85 716 void HAL_IRDA_MspDeInit(IRDA_HandleTypeDef *hirda);
AnnaBridge 126:abea610beb85 717
AnnaBridge 126:abea610beb85 718 /**
AnnaBridge 126:abea610beb85 719 * @}
AnnaBridge 126:abea610beb85 720 */
AnnaBridge 126:abea610beb85 721
AnnaBridge 126:abea610beb85 722 /** @addtogroup IRDA_Exported_Functions_Group2 IO operation functions
AnnaBridge 126:abea610beb85 723 * @{
AnnaBridge 126:abea610beb85 724 */
AnnaBridge 126:abea610beb85 725
AnnaBridge 126:abea610beb85 726 /* IO operation functions *****************************************************/
AnnaBridge 126:abea610beb85 727 HAL_StatusTypeDef HAL_IRDA_Transmit(IRDA_HandleTypeDef *hirda, uint8_t *pData, uint16_t Size, uint32_t Timeout);
AnnaBridge 126:abea610beb85 728 HAL_StatusTypeDef HAL_IRDA_Receive(IRDA_HandleTypeDef *hirda, uint8_t *pData, uint16_t Size, uint32_t Timeout);
AnnaBridge 126:abea610beb85 729 HAL_StatusTypeDef HAL_IRDA_Transmit_IT(IRDA_HandleTypeDef *hirda, uint8_t *pData, uint16_t Size);
AnnaBridge 126:abea610beb85 730 HAL_StatusTypeDef HAL_IRDA_Receive_IT(IRDA_HandleTypeDef *hirda, uint8_t *pData, uint16_t Size);
AnnaBridge 126:abea610beb85 731 HAL_StatusTypeDef HAL_IRDA_Transmit_DMA(IRDA_HandleTypeDef *hirda, uint8_t *pData, uint16_t Size);
AnnaBridge 126:abea610beb85 732 HAL_StatusTypeDef HAL_IRDA_Receive_DMA(IRDA_HandleTypeDef *hirda, uint8_t *pData, uint16_t Size);
AnnaBridge 126:abea610beb85 733 HAL_StatusTypeDef HAL_IRDA_DMAPause(IRDA_HandleTypeDef *hirda);
AnnaBridge 126:abea610beb85 734 HAL_StatusTypeDef HAL_IRDA_DMAResume(IRDA_HandleTypeDef *hirda);
AnnaBridge 126:abea610beb85 735 HAL_StatusTypeDef HAL_IRDA_DMAStop(IRDA_HandleTypeDef *hirda);
<> 135:176b8275d35d 736 /* Transfer Abort functions */
<> 135:176b8275d35d 737 HAL_StatusTypeDef HAL_IRDA_Abort(IRDA_HandleTypeDef *hirda);
<> 135:176b8275d35d 738 HAL_StatusTypeDef HAL_IRDA_AbortTransmit(IRDA_HandleTypeDef *hirda);
<> 135:176b8275d35d 739 HAL_StatusTypeDef HAL_IRDA_AbortReceive(IRDA_HandleTypeDef *hirda);
<> 135:176b8275d35d 740 HAL_StatusTypeDef HAL_IRDA_Abort_IT(IRDA_HandleTypeDef *hirda);
<> 135:176b8275d35d 741 HAL_StatusTypeDef HAL_IRDA_AbortTransmit_IT(IRDA_HandleTypeDef *hirda);
<> 135:176b8275d35d 742 HAL_StatusTypeDef HAL_IRDA_AbortReceive_IT(IRDA_HandleTypeDef *hirda);
<> 135:176b8275d35d 743
AnnaBridge 126:abea610beb85 744 void HAL_IRDA_IRQHandler(IRDA_HandleTypeDef *hirda);
AnnaBridge 126:abea610beb85 745 void HAL_IRDA_TxCpltCallback(IRDA_HandleTypeDef *hirda);
AnnaBridge 126:abea610beb85 746 void HAL_IRDA_RxCpltCallback(IRDA_HandleTypeDef *hirda);
AnnaBridge 126:abea610beb85 747 void HAL_IRDA_TxHalfCpltCallback(IRDA_HandleTypeDef *hirda);
AnnaBridge 126:abea610beb85 748 void HAL_IRDA_RxHalfCpltCallback(IRDA_HandleTypeDef *hirda);
AnnaBridge 126:abea610beb85 749 void HAL_IRDA_ErrorCallback(IRDA_HandleTypeDef *hirda);
<> 135:176b8275d35d 750 void HAL_IRDA_AbortCpltCallback (IRDA_HandleTypeDef *hirda);
<> 135:176b8275d35d 751 void HAL_IRDA_AbortTransmitCpltCallback (IRDA_HandleTypeDef *hirda);
<> 135:176b8275d35d 752 void HAL_IRDA_AbortReceiveCpltCallback (IRDA_HandleTypeDef *hirda);
AnnaBridge 126:abea610beb85 753
AnnaBridge 126:abea610beb85 754 /**
AnnaBridge 126:abea610beb85 755 * @}
AnnaBridge 126:abea610beb85 756 */
AnnaBridge 126:abea610beb85 757
AnnaBridge 126:abea610beb85 758 /* Peripheral Control functions ************************************************/
AnnaBridge 126:abea610beb85 759
AnnaBridge 126:abea610beb85 760 /** @addtogroup IRDA_Exported_Functions_Group3 Peripheral State and Error functions
AnnaBridge 126:abea610beb85 761 * @{
AnnaBridge 126:abea610beb85 762 */
AnnaBridge 126:abea610beb85 763
AnnaBridge 126:abea610beb85 764 /* Peripheral State and Error functions ***************************************/
AnnaBridge 126:abea610beb85 765 HAL_IRDA_StateTypeDef HAL_IRDA_GetState(IRDA_HandleTypeDef *hirda);
AnnaBridge 126:abea610beb85 766 uint32_t HAL_IRDA_GetError(IRDA_HandleTypeDef *hirda);
AnnaBridge 126:abea610beb85 767
AnnaBridge 126:abea610beb85 768 /**
AnnaBridge 126:abea610beb85 769 * @}
AnnaBridge 126:abea610beb85 770 */
AnnaBridge 126:abea610beb85 771
AnnaBridge 126:abea610beb85 772 /**
AnnaBridge 126:abea610beb85 773 * @}
AnnaBridge 126:abea610beb85 774 */
AnnaBridge 126:abea610beb85 775
AnnaBridge 126:abea610beb85 776 /**
AnnaBridge 126:abea610beb85 777 * @}
AnnaBridge 126:abea610beb85 778 */
AnnaBridge 126:abea610beb85 779
AnnaBridge 126:abea610beb85 780 /**
AnnaBridge 126:abea610beb85 781 * @}
AnnaBridge 126:abea610beb85 782 */
<> 135:176b8275d35d 783
AnnaBridge 126:abea610beb85 784 #ifdef __cplusplus
AnnaBridge 126:abea610beb85 785 }
AnnaBridge 126:abea610beb85 786 #endif
AnnaBridge 126:abea610beb85 787
AnnaBridge 126:abea610beb85 788 #endif /* __STM32F3xx_HAL_IRDA_H */
AnnaBridge 126:abea610beb85 789
AnnaBridge 126:abea610beb85 790 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/