Ricardo Benitez / mbed

meh

Fork of mbed by mbed official

TARGET_NUCLEO_F334R8/stm32f3xx_hal_irda.h@118:16969dd821af, 2016-04-05 (annotated)

Committer:
ricardobtez
Date:
Tue Apr 05 23:51:21 2016 +0000
Revision:
118:16969dd821af
Parent:
92:4fc01daae5a5 
dgdgr

Who changed what in which revision?

UserRevisionLine numberNew contents of line
bogdanm 86:04dd9b1680ae 1 /**
bogdanm 86:04dd9b1680ae 2 ******************************************************************************
bogdanm 86:04dd9b1680ae 3 * @file stm32f3xx_hal_irda.h
bogdanm 86:04dd9b1680ae 4 * @author MCD Application Team
bogdanm 92:4fc01daae5a5 5 * @version V1.1.0
bogdanm 92:4fc01daae5a5 6 * @date 12-Sept-2014
bogdanm 86:04dd9b1680ae 7 * @brief Header file of IRDA HAL module.
bogdanm 86:04dd9b1680ae 8 ******************************************************************************
bogdanm 86:04dd9b1680ae 9 * @attention
bogdanm 86:04dd9b1680ae 10 *
bogdanm 86:04dd9b1680ae 11 * <h2><center>&copy; COPYRIGHT(c) 2014 STMicroelectronics</center></h2>
bogdanm 86:04dd9b1680ae 12 *
bogdanm 86:04dd9b1680ae 13 * Redistribution and use in source and binary forms, with or without modification,
bogdanm 86:04dd9b1680ae 14 * are permitted provided that the following conditions are met:
bogdanm 86:04dd9b1680ae 15 * 1. Redistributions of source code must retain the above copyright notice,
bogdanm 86:04dd9b1680ae 16 * this list of conditions and the following disclaimer.
bogdanm 86:04dd9b1680ae 17 * 2. Redistributions in binary form must reproduce the above copyright notice,
bogdanm 86:04dd9b1680ae 18 * this list of conditions and the following disclaimer in the documentation
bogdanm 86:04dd9b1680ae 19 * and/or other materials provided with the distribution.
bogdanm 86:04dd9b1680ae 20 * 3. Neither the name of STMicroelectronics nor the names of its contributors
bogdanm 86:04dd9b1680ae 21 * may be used to endorse or promote products derived from this software
bogdanm 86:04dd9b1680ae 22 * without specific prior written permission.
bogdanm 86:04dd9b1680ae 23 *
bogdanm 86:04dd9b1680ae 24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
bogdanm 86:04dd9b1680ae 25 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
bogdanm 86:04dd9b1680ae 26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
bogdanm 86:04dd9b1680ae 27 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
bogdanm 86:04dd9b1680ae 28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
bogdanm 86:04dd9b1680ae 29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
bogdanm 86:04dd9b1680ae 30 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
bogdanm 86:04dd9b1680ae 31 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
bogdanm 86:04dd9b1680ae 32 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
bogdanm 86:04dd9b1680ae 33 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
bogdanm 86:04dd9b1680ae 34 *
bogdanm 86:04dd9b1680ae 35 ******************************************************************************
bogdanm 86:04dd9b1680ae 36 */
bogdanm 86:04dd9b1680ae 37
bogdanm 86:04dd9b1680ae 38 /* Define to prevent recursive inclusion -------------------------------------*/
bogdanm 86:04dd9b1680ae 39 #ifndef __STM32F3xx_HAL_IRDA_H
bogdanm 86:04dd9b1680ae 40 #define __STM32F3xx_HAL_IRDA_H
bogdanm 86:04dd9b1680ae 41
bogdanm 86:04dd9b1680ae 42 #ifdef __cplusplus
bogdanm 86:04dd9b1680ae 43 extern "C" {
bogdanm 86:04dd9b1680ae 44 #endif
bogdanm 86:04dd9b1680ae 45
bogdanm 86:04dd9b1680ae 46 /* Includes ------------------------------------------------------------------*/
bogdanm 86:04dd9b1680ae 47 #include "stm32f3xx_hal_def.h"
bogdanm 86:04dd9b1680ae 48
bogdanm 86:04dd9b1680ae 49 /** @addtogroup STM32F3xx_HAL_Driver
bogdanm 86:04dd9b1680ae 50 * @{
bogdanm 86:04dd9b1680ae 51 */
bogdanm 86:04dd9b1680ae 52
bogdanm 92:4fc01daae5a5 53 /** @addtogroup IRDA IRDA HAL module driver
bogdanm 86:04dd9b1680ae 54 * @{
bogdanm 86:04dd9b1680ae 55 */
bogdanm 86:04dd9b1680ae 56
bogdanm 86:04dd9b1680ae 57 /* Exported types ------------------------------------------------------------*/
bogdanm 92:4fc01daae5a5 58 /** @defgroup IRDA_Exported_Types IRDA Exported Types
bogdanm 92:4fc01daae5a5 59 * @{
bogdanm 92:4fc01daae5a5 60 */
bogdanm 86:04dd9b1680ae 61
bogdanm 86:04dd9b1680ae 62 /**
bogdanm 86:04dd9b1680ae 63 * @brief IRDA Init Structure definition
bogdanm 86:04dd9b1680ae 64 */
bogdanm 86:04dd9b1680ae 65 typedef struct
bogdanm 86:04dd9b1680ae 66 {
bogdanm 86:04dd9b1680ae 67 uint32_t BaudRate; /*!< This member configures the IRDA communication baud rate.
bogdanm 86:04dd9b1680ae 68 The baud rate register is computed using the following formula:
bogdanm 86:04dd9b1680ae 69 Baud Rate Register = ((PCLKx) / ((hirda->Init.BaudRate))) */
bogdanm 86:04dd9b1680ae 70
bogdanm 86:04dd9b1680ae 71 uint32_t WordLength; /*!< Specifies the number of data bits transmitted or received in a frame.
bogdanm 86:04dd9b1680ae 72 This parameter can be a value of @ref IRDAEx_Word_Length */
bogdanm 86:04dd9b1680ae 73
bogdanm 86:04dd9b1680ae 74 uint16_t Parity; /*!< Specifies the parity mode.
bogdanm 86:04dd9b1680ae 75 This parameter can be a value of @ref IRDA_Parity
bogdanm 86:04dd9b1680ae 76 @note When parity is enabled, the computed parity is inserted
bogdanm 86:04dd9b1680ae 77 at the MSB position of the transmitted data (9th bit when
bogdanm 86:04dd9b1680ae 78 the word length is set to 9 data bits; 8th bit when the
bogdanm 86:04dd9b1680ae 79 word length is set to 8 data bits). */
bogdanm 86:04dd9b1680ae 80
bogdanm 92:4fc01daae5a5 81 uint16_t Mode; /*!< Specifies whether the Receive or Transmit mode is enabled or disabled.
bogdanm 86:04dd9b1680ae 82 This parameter can be a value of @ref IRDA_Mode */
bogdanm 86:04dd9b1680ae 83
bogdanm 86:04dd9b1680ae 84 uint8_t Prescaler; /*!< Specifies the Prescaler value for dividing the UART/USART source clock
bogdanm 86:04dd9b1680ae 85 to achieve low-power frequency.
bogdanm 86:04dd9b1680ae 86 @note Prescaler value 0 is forbidden */
bogdanm 86:04dd9b1680ae 87
bogdanm 86:04dd9b1680ae 88 uint16_t PowerMode; /*!< Specifies the IRDA power mode.
bogdanm 86:04dd9b1680ae 89 This parameter can be a value of @ref IRDA_Low_Power */
bogdanm 86:04dd9b1680ae 90 }IRDA_InitTypeDef;
bogdanm 86:04dd9b1680ae 91
bogdanm 86:04dd9b1680ae 92 /**
bogdanm 86:04dd9b1680ae 93 * @brief HAL IRDA State structures definition
bogdanm 86:04dd9b1680ae 94 */
bogdanm 86:04dd9b1680ae 95 typedef enum
bogdanm 86:04dd9b1680ae 96 {
bogdanm 86:04dd9b1680ae 97 HAL_IRDA_STATE_RESET = 0x00, /*!< Peripheral is not initialized */
bogdanm 86:04dd9b1680ae 98 HAL_IRDA_STATE_READY = 0x01, /*!< Peripheral Initialized and ready for use */
bogdanm 86:04dd9b1680ae 99 HAL_IRDA_STATE_BUSY = 0x02, /*!< an internal process is ongoing */
bogdanm 86:04dd9b1680ae 100 HAL_IRDA_STATE_BUSY_TX = 0x12, /*!< Data Transmission process is ongoing */
bogdanm 86:04dd9b1680ae 101 HAL_IRDA_STATE_BUSY_RX = 0x22, /*!< Data Reception process is ongoing */
bogdanm 86:04dd9b1680ae 102 HAL_IRDA_STATE_BUSY_TX_RX = 0x32, /*!< Data Transmission and Reception process is ongoing */
bogdanm 86:04dd9b1680ae 103 HAL_IRDA_STATE_TIMEOUT = 0x03, /*!< Timeout state */
bogdanm 86:04dd9b1680ae 104 HAL_IRDA_STATE_ERROR = 0x04 /*!< Error */
bogdanm 86:04dd9b1680ae 105 }HAL_IRDA_StateTypeDef;
bogdanm 86:04dd9b1680ae 106
bogdanm 86:04dd9b1680ae 107 /**
bogdanm 86:04dd9b1680ae 108 * @brief HAL IRDA Error Code structure definition
bogdanm 86:04dd9b1680ae 109 */
bogdanm 86:04dd9b1680ae 110 typedef enum
bogdanm 86:04dd9b1680ae 111 {
bogdanm 86:04dd9b1680ae 112 HAL_IRDA_ERROR_NONE = 0x00, /*!< No error */
bogdanm 86:04dd9b1680ae 113 HAL_IRDA_ERROR_PE = 0x01, /*!< Parity error */
bogdanm 86:04dd9b1680ae 114 HAL_IRDA_ERROR_NE = 0x02, /*!< Noise error */
bogdanm 86:04dd9b1680ae 115 HAL_IRDA_ERROR_FE = 0x04, /*!< frame error */
bogdanm 86:04dd9b1680ae 116 HAL_IRDA_ERROR_ORE = 0x08, /*!< Overrun error */
bogdanm 86:04dd9b1680ae 117 HAL_IRDA_ERROR_DMA = 0x10 /*!< DMA transfer error */
bogdanm 86:04dd9b1680ae 118 }HAL_IRDA_ErrorTypeDef;
bogdanm 86:04dd9b1680ae 119
bogdanm 86:04dd9b1680ae 120 /**
bogdanm 86:04dd9b1680ae 121 * @brief IRDA clock sources definition
bogdanm 86:04dd9b1680ae 122 */
bogdanm 86:04dd9b1680ae 123 typedef enum
bogdanm 86:04dd9b1680ae 124 {
bogdanm 86:04dd9b1680ae 125 IRDA_CLOCKSOURCE_PCLK1 = 0x00, /*!< PCLK1 clock source */
bogdanm 86:04dd9b1680ae 126 IRDA_CLOCKSOURCE_PCLK2 = 0x01, /*!< PCLK2 clock source */
bogdanm 86:04dd9b1680ae 127 IRDA_CLOCKSOURCE_HSI = 0x02, /*!< HSI clock source */
bogdanm 86:04dd9b1680ae 128 IRDA_CLOCKSOURCE_SYSCLK = 0x04, /*!< SYSCLK clock source */
bogdanm 86:04dd9b1680ae 129 IRDA_CLOCKSOURCE_LSE = 0x08, /*!< LSE clock source */
bogdanm 86:04dd9b1680ae 130 IRDA_CLOCKSOURCE_UNDEFINED = 0x10 /*!< Undefined clock source */
bogdanm 86:04dd9b1680ae 131 }IRDA_ClockSourceTypeDef;
bogdanm 86:04dd9b1680ae 132
bogdanm 86:04dd9b1680ae 133 /**
bogdanm 86:04dd9b1680ae 134 * @brief IRDA handle Structure definition
bogdanm 86:04dd9b1680ae 135 */
bogdanm 86:04dd9b1680ae 136 typedef struct
bogdanm 86:04dd9b1680ae 137 {
bogdanm 86:04dd9b1680ae 138 USART_TypeDef *Instance; /* USART registers base address */
bogdanm 86:04dd9b1680ae 139
bogdanm 86:04dd9b1680ae 140 IRDA_InitTypeDef Init; /* IRDA communication parameters */
bogdanm 86:04dd9b1680ae 141
bogdanm 86:04dd9b1680ae 142 uint8_t *pTxBuffPtr; /* Pointer to IRDA Tx transfer Buffer */
bogdanm 86:04dd9b1680ae 143
bogdanm 86:04dd9b1680ae 144 uint16_t TxXferSize; /* IRDA Tx Transfer size */
bogdanm 86:04dd9b1680ae 145
bogdanm 86:04dd9b1680ae 146 uint16_t TxXferCount; /* IRDA Tx Transfer Counter */
bogdanm 86:04dd9b1680ae 147
bogdanm 86:04dd9b1680ae 148 uint8_t *pRxBuffPtr; /* Pointer to IRDA Rx transfer Buffer */
bogdanm 86:04dd9b1680ae 149
bogdanm 86:04dd9b1680ae 150 uint16_t RxXferSize; /* IRDA Rx Transfer size */
bogdanm 86:04dd9b1680ae 151
bogdanm 86:04dd9b1680ae 152 uint16_t RxXferCount; /* IRDA Rx Transfer Counter */
bogdanm 86:04dd9b1680ae 153
bogdanm 86:04dd9b1680ae 154 uint16_t Mask; /* USART RX RDR register mask */
bogdanm 86:04dd9b1680ae 155
bogdanm 86:04dd9b1680ae 156 DMA_HandleTypeDef *hdmatx; /* IRDA Tx DMA Handle parameters */
bogdanm 86:04dd9b1680ae 157
bogdanm 86:04dd9b1680ae 158 DMA_HandleTypeDef *hdmarx; /* IRDA Rx DMA Handle parameters */
bogdanm 86:04dd9b1680ae 159
bogdanm 86:04dd9b1680ae 160 HAL_LockTypeDef Lock; /* Locking object */
bogdanm 86:04dd9b1680ae 161
bogdanm 86:04dd9b1680ae 162 HAL_IRDA_StateTypeDef State; /* IRDA communication state */
bogdanm 86:04dd9b1680ae 163
bogdanm 86:04dd9b1680ae 164 HAL_IRDA_ErrorTypeDef ErrorCode; /* IRDA Error code */
bogdanm 86:04dd9b1680ae 165
bogdanm 86:04dd9b1680ae 166 }IRDA_HandleTypeDef;
bogdanm 86:04dd9b1680ae 167
bogdanm 86:04dd9b1680ae 168 /**
bogdanm 86:04dd9b1680ae 169 * @brief IRDA Configuration enumeration values definition
bogdanm 86:04dd9b1680ae 170 */
bogdanm 86:04dd9b1680ae 171 typedef enum
bogdanm 86:04dd9b1680ae 172 {
bogdanm 86:04dd9b1680ae 173 IRDA_BAUDRATE = 0x00,
bogdanm 86:04dd9b1680ae 174 IRDA_PARITY = 0x01,
bogdanm 86:04dd9b1680ae 175 IRDA_WORDLENGTH = 0x02,
bogdanm 86:04dd9b1680ae 176 IRDA_MODE = 0x03,
bogdanm 86:04dd9b1680ae 177 IRDA_PRESCALER = 0x04,
bogdanm 86:04dd9b1680ae 178 IRDA_POWERMODE = 0x05
bogdanm 86:04dd9b1680ae 179 }IRDA_ControlTypeDef;
bogdanm 86:04dd9b1680ae 180
bogdanm 92:4fc01daae5a5 181 /**
bogdanm 92:4fc01daae5a5 182 * @}
bogdanm 92:4fc01daae5a5 183 */
bogdanm 92:4fc01daae5a5 184
bogdanm 86:04dd9b1680ae 185 /* Exported constants --------------------------------------------------------*/
bogdanm 86:04dd9b1680ae 186 /** @defgroup IRDA_Exported_Constants IRDA Exported Constants
bogdanm 86:04dd9b1680ae 187 * @{
bogdanm 86:04dd9b1680ae 188 */
bogdanm 86:04dd9b1680ae 189
bogdanm 86:04dd9b1680ae 190 /** @defgroup IRDA_Parity IRDA Parity
bogdanm 86:04dd9b1680ae 191 * @{
bogdanm 86:04dd9b1680ae 192 */
bogdanm 86:04dd9b1680ae 193 #define IRDA_PARITY_NONE ((uint16_t)0x0000)
bogdanm 86:04dd9b1680ae 194 #define IRDA_PARITY_EVEN ((uint16_t)USART_CR1_PCE)
bogdanm 86:04dd9b1680ae 195 #define IRDA_PARITY_ODD ((uint16_t)(USART_CR1_PCE | USART_CR1_PS))
bogdanm 86:04dd9b1680ae 196 #define IS_IRDA_PARITY(PARITY) (((PARITY) == IRDA_PARITY_NONE) || \
bogdanm 86:04dd9b1680ae 197 ((PARITY) == IRDA_PARITY_EVEN) || \
bogdanm 86:04dd9b1680ae 198 ((PARITY) == IRDA_PARITY_ODD))
bogdanm 86:04dd9b1680ae 199 /**
bogdanm 86:04dd9b1680ae 200 * @}
bogdanm 86:04dd9b1680ae 201 */
bogdanm 86:04dd9b1680ae 202
bogdanm 86:04dd9b1680ae 203
bogdanm 86:04dd9b1680ae 204 /** @defgroup IRDA_Transfer_Mode IRDA Transfer Mode
bogdanm 86:04dd9b1680ae 205 * @{
bogdanm 86:04dd9b1680ae 206 */
bogdanm 86:04dd9b1680ae 207 #define IRDA_MODE_RX ((uint16_t)USART_CR1_RE)
bogdanm 86:04dd9b1680ae 208 #define IRDA_MODE_TX ((uint16_t)USART_CR1_TE)
bogdanm 86:04dd9b1680ae 209 #define IRDA_MODE_TX_RX ((uint16_t)(USART_CR1_TE |USART_CR1_RE))
bogdanm 86:04dd9b1680ae 210 #define IS_IRDA_TX_RX_MODE(MODE) ((((MODE) & (~((uint16_t)(IRDA_MODE_TX_RX)))) == (uint16_t)0x00) && ((MODE) != (uint16_t)0x00))
bogdanm 86:04dd9b1680ae 211 /**
bogdanm 86:04dd9b1680ae 212 * @}
bogdanm 86:04dd9b1680ae 213 */
bogdanm 86:04dd9b1680ae 214
bogdanm 86:04dd9b1680ae 215 /** @defgroup IRDA_Low_Power IRDA Low Power
bogdanm 86:04dd9b1680ae 216 * @{
bogdanm 86:04dd9b1680ae 217 */
bogdanm 86:04dd9b1680ae 218 #define IRDA_POWERMODE_NORMAL ((uint16_t)0x0000)
bogdanm 86:04dd9b1680ae 219 #define IRDA_POWERMODE_LOWPOWER ((uint16_t)USART_CR3_IRLP)
bogdanm 86:04dd9b1680ae 220 #define IS_IRDA_POWERMODE(MODE) (((MODE) == IRDA_POWERMODE_LOWPOWER) || \
bogdanm 86:04dd9b1680ae 221 ((MODE) == IRDA_POWERMODE_NORMAL))
bogdanm 86:04dd9b1680ae 222 /**
bogdanm 86:04dd9b1680ae 223 * @}
bogdanm 86:04dd9b1680ae 224 */
bogdanm 86:04dd9b1680ae 225
bogdanm 86:04dd9b1680ae 226 /** @defgroup IRDA_State IRDA State
bogdanm 86:04dd9b1680ae 227 * @{
bogdanm 86:04dd9b1680ae 228 */
bogdanm 86:04dd9b1680ae 229 #define IRDA_STATE_DISABLE ((uint16_t)0x0000)
bogdanm 86:04dd9b1680ae 230 #define IRDA_STATE_ENABLE ((uint16_t)USART_CR1_UE)
bogdanm 86:04dd9b1680ae 231 #define IS_IRDA_STATE(STATE) (((STATE) == IRDA_STATE_DISABLE) || \
bogdanm 86:04dd9b1680ae 232 ((STATE) == IRDA_STATE_ENABLE))
bogdanm 86:04dd9b1680ae 233 /**
bogdanm 86:04dd9b1680ae 234 * @}
bogdanm 86:04dd9b1680ae 235 */
bogdanm 86:04dd9b1680ae 236
bogdanm 86:04dd9b1680ae 237 /** @defgroup IRDA_Mode IRDA Mode
bogdanm 86:04dd9b1680ae 238 * @{
bogdanm 86:04dd9b1680ae 239 */
bogdanm 86:04dd9b1680ae 240 #define IRDA_MODE_DISABLE ((uint16_t)0x0000)
bogdanm 86:04dd9b1680ae 241 #define IRDA_MODE_ENABLE ((uint16_t)USART_CR3_IREN)
bogdanm 86:04dd9b1680ae 242 #define IS_IRDA_MODE(STATE) (((STATE) == IRDA_MODE_DISABLE) || \
bogdanm 86:04dd9b1680ae 243 ((STATE) == IRDA_MODE_ENABLE))
bogdanm 86:04dd9b1680ae 244 /**
bogdanm 86:04dd9b1680ae 245 * @}
bogdanm 86:04dd9b1680ae 246 */
bogdanm 86:04dd9b1680ae 247
bogdanm 86:04dd9b1680ae 248 /** @defgroup IRDA_One_Bit IRDA One Bit Sampling
bogdanm 86:04dd9b1680ae 249 * @{
bogdanm 86:04dd9b1680ae 250 */
bogdanm 86:04dd9b1680ae 251 #define IRDA_ONE_BIT_SAMPLE_DISABLED ((uint16_t)0x00000000)
bogdanm 86:04dd9b1680ae 252 #define IRDA_ONE_BIT_SAMPLE_ENABLED ((uint16_t)USART_CR3_ONEBIT)
bogdanm 86:04dd9b1680ae 253 #define IS_IRDA_ONEBIT_SAMPLE(ONEBIT) (((ONEBIT) == IRDA_ONE_BIT_SAMPLE_DISABLED) || \
bogdanm 86:04dd9b1680ae 254 ((ONEBIT) == IRDA_ONE_BIT_SAMPLE_ENABLED))
bogdanm 86:04dd9b1680ae 255 /**
bogdanm 86:04dd9b1680ae 256 * @}
bogdanm 86:04dd9b1680ae 257 */
bogdanm 86:04dd9b1680ae 258
bogdanm 86:04dd9b1680ae 259 /** @defgroup IRDA_DMA_Tx IRDA DMA Tx
bogdanm 86:04dd9b1680ae 260 * @{
bogdanm 86:04dd9b1680ae 261 */
bogdanm 86:04dd9b1680ae 262 #define IRDA_DMA_TX_DISABLE ((uint16_t)0x00000000)
bogdanm 86:04dd9b1680ae 263 #define IRDA_DMA_TX_ENABLE ((uint16_t)USART_CR3_DMAT)
bogdanm 86:04dd9b1680ae 264 #define IS_IRDA_DMA_TX(DMATX) (((DMATX) == IRDA_DMA_TX_DISABLE) || \
bogdanm 86:04dd9b1680ae 265 ((DMATX) == IRDA_DMA_TX_ENABLE))
bogdanm 86:04dd9b1680ae 266 /**
bogdanm 86:04dd9b1680ae 267 * @}
bogdanm 86:04dd9b1680ae 268 */
bogdanm 86:04dd9b1680ae 269
bogdanm 86:04dd9b1680ae 270 /** @defgroup IRDA_DMA_Rx IRDA DMA Rx
bogdanm 86:04dd9b1680ae 271 * @{
bogdanm 86:04dd9b1680ae 272 */
bogdanm 86:04dd9b1680ae 273 #define IRDA_DMA_RX_DISABLE ((uint16_t)0x0000)
bogdanm 86:04dd9b1680ae 274 #define IRDA_DMA_RX_ENABLE ((uint16_t)USART_CR3_DMAR)
bogdanm 86:04dd9b1680ae 275 #define IS_IRDA_DMA_RX(DMARX) (((DMARX) == IRDA_DMA_RX_DISABLE) || \
bogdanm 86:04dd9b1680ae 276 ((DMARX) == IRDA_DMA_RX_ENABLE))
bogdanm 86:04dd9b1680ae 277 /**
bogdanm 86:04dd9b1680ae 278 * @}
bogdanm 86:04dd9b1680ae 279 */
bogdanm 86:04dd9b1680ae 280
bogdanm 86:04dd9b1680ae 281 /** @defgroup IRDA_Flags IRDA Flags
bogdanm 86:04dd9b1680ae 282 * Elements values convention: 0xXXXX
bogdanm 86:04dd9b1680ae 283 * - 0xXXXX : Flag mask in the ISR register
bogdanm 86:04dd9b1680ae 284 * @{
bogdanm 86:04dd9b1680ae 285 */
bogdanm 86:04dd9b1680ae 286 #define IRDA_FLAG_REACK ((uint32_t)0x00400000)
bogdanm 86:04dd9b1680ae 287 #define IRDA_FLAG_TEACK ((uint32_t)0x00200000)
bogdanm 86:04dd9b1680ae 288 #define IRDA_FLAG_BUSY ((uint32_t)0x00010000)
bogdanm 86:04dd9b1680ae 289 #define IRDA_FLAG_ABRF ((uint32_t)0x00008000)
bogdanm 86:04dd9b1680ae 290 #define IRDA_FLAG_ABRE ((uint32_t)0x00004000)
bogdanm 86:04dd9b1680ae 291 #define IRDA_FLAG_TXE ((uint32_t)0x00000080)
bogdanm 86:04dd9b1680ae 292 #define IRDA_FLAG_TC ((uint32_t)0x00000040)
bogdanm 86:04dd9b1680ae 293 #define IRDA_FLAG_RXNE ((uint32_t)0x00000020)
bogdanm 86:04dd9b1680ae 294 #define IRDA_FLAG_ORE ((uint32_t)0x00000008)
bogdanm 86:04dd9b1680ae 295 #define IRDA_FLAG_NE ((uint32_t)0x00000004)
bogdanm 86:04dd9b1680ae 296 #define IRDA_FLAG_FE ((uint32_t)0x00000002)
bogdanm 86:04dd9b1680ae 297 #define IRDA_FLAG_PE ((uint32_t)0x00000001)
bogdanm 86:04dd9b1680ae 298 /**
bogdanm 86:04dd9b1680ae 299 * @}
bogdanm 86:04dd9b1680ae 300 */
bogdanm 86:04dd9b1680ae 301
bogdanm 86:04dd9b1680ae 302 /** @defgroup IRDA_Interrupt_definition IRDA Interrupts Definition
bogdanm 86:04dd9b1680ae 303 * Elements values convention: 0000ZZZZ0XXYYYYYb
bogdanm 86:04dd9b1680ae 304 * - YYYYY : Interrupt source position in the XX register (5bits)
bogdanm 86:04dd9b1680ae 305 * - XX : Interrupt source register (2bits)
bogdanm 86:04dd9b1680ae 306 * - 01: CR1 register
bogdanm 86:04dd9b1680ae 307 * - 10: CR2 register
bogdanm 86:04dd9b1680ae 308 * - 11: CR3 register
bogdanm 86:04dd9b1680ae 309 * - ZZZZ : Flag position in the ISR register(4bits)
bogdanm 86:04dd9b1680ae 310 * @{
bogdanm 86:04dd9b1680ae 311 */
bogdanm 86:04dd9b1680ae 312 #define IRDA_IT_PE ((uint16_t)0x0028)
bogdanm 86:04dd9b1680ae 313 #define IRDA_IT_TXE ((uint16_t)0x0727)
bogdanm 86:04dd9b1680ae 314 #define IRDA_IT_TC ((uint16_t)0x0626)
bogdanm 86:04dd9b1680ae 315 #define IRDA_IT_RXNE ((uint16_t)0x0525)
bogdanm 86:04dd9b1680ae 316 #define IRDA_IT_IDLE ((uint16_t)0x0424)
bogdanm 86:04dd9b1680ae 317
bogdanm 86:04dd9b1680ae 318
bogdanm 86:04dd9b1680ae 319
bogdanm 86:04dd9b1680ae 320 /** Elements values convention: 000000000XXYYYYYb
bogdanm 86:04dd9b1680ae 321 * - YYYYY : Interrupt source position in the XX register (5bits)
bogdanm 86:04dd9b1680ae 322 * - XX : Interrupt source register (2bits)
bogdanm 86:04dd9b1680ae 323 * - 01: CR1 register
bogdanm 86:04dd9b1680ae 324 * - 10: CR2 register
bogdanm 86:04dd9b1680ae 325 * - 11: CR3 register
bogdanm 86:04dd9b1680ae 326 */
bogdanm 86:04dd9b1680ae 327 #define IRDA_IT_ERR ((uint16_t)0x0060)
bogdanm 86:04dd9b1680ae 328
bogdanm 86:04dd9b1680ae 329 /** Elements values convention: 0000ZZZZ00000000b
bogdanm 86:04dd9b1680ae 330 * - ZZZZ : Flag position in the ISR register(4bits)
bogdanm 86:04dd9b1680ae 331 */
bogdanm 86:04dd9b1680ae 332 #define IRDA_IT_ORE ((uint16_t)0x0300)
bogdanm 86:04dd9b1680ae 333 #define IRDA_IT_NE ((uint16_t)0x0200)
bogdanm 86:04dd9b1680ae 334 #define IRDA_IT_FE ((uint16_t)0x0100)
bogdanm 86:04dd9b1680ae 335 /**
bogdanm 86:04dd9b1680ae 336 * @}
bogdanm 86:04dd9b1680ae 337 */
bogdanm 86:04dd9b1680ae 338
bogdanm 86:04dd9b1680ae 339 /** @defgroup IRDA_IT_CLEAR_Flags IRDA Interruption Clear Flags
bogdanm 86:04dd9b1680ae 340 * @{
bogdanm 86:04dd9b1680ae 341 */
bogdanm 86:04dd9b1680ae 342 #define IRDA_CLEAR_PEF USART_ICR_PECF /*!< Parity Error Clear Flag */
bogdanm 86:04dd9b1680ae 343 #define IRDA_CLEAR_FEF USART_ICR_FECF /*!< Framing Error Clear Flag */
bogdanm 86:04dd9b1680ae 344 #define IRDA_CLEAR_NEF USART_ICR_NCF /*!< Noise detected Clear Flag */
bogdanm 86:04dd9b1680ae 345 #define IRDA_CLEAR_OREF USART_ICR_ORECF /*!< OverRun Error Clear Flag */
bogdanm 86:04dd9b1680ae 346 #define IRDA_CLEAR_TCF USART_ICR_TCCF /*!< Transmission Complete Clear Flag */
bogdanm 86:04dd9b1680ae 347 /**
bogdanm 86:04dd9b1680ae 348 * @}
bogdanm 86:04dd9b1680ae 349 */
bogdanm 86:04dd9b1680ae 350
bogdanm 86:04dd9b1680ae 351
bogdanm 86:04dd9b1680ae 352
bogdanm 86:04dd9b1680ae 353 /** @defgroup IRDA_Request_Parameters IRDA Request Parameters
bogdanm 86:04dd9b1680ae 354 * @{
bogdanm 86:04dd9b1680ae 355 */
bogdanm 86:04dd9b1680ae 356 #define IRDA_AUTOBAUD_REQUEST ((uint16_t)USART_RQR_ABRRQ) /*!< Auto-Baud Rate Request */
bogdanm 86:04dd9b1680ae 357 #define IRDA_RXDATA_FLUSH_REQUEST ((uint16_t)USART_RQR_RXFRQ) /*!< Receive Data flush Request */
bogdanm 86:04dd9b1680ae 358 #define IRDA_TXDATA_FLUSH_REQUEST ((uint16_t)USART_RQR_TXFRQ) /*!< Transmit data flush Request */
bogdanm 86:04dd9b1680ae 359 #define IS_IRDA_REQUEST_PARAMETER(PARAM) (((PARAM) == IRDA_AUTOBAUD_REQUEST) || \
bogdanm 86:04dd9b1680ae 360 ((PARAM) == IRDA_SENDBREAK_REQUEST) || \
bogdanm 86:04dd9b1680ae 361 ((PARAM) == IRDA_MUTE_MODE_REQUEST) || \
bogdanm 86:04dd9b1680ae 362 ((PARAM) == IRDA_RXDATA_FLUSH_REQUEST) || \
bogdanm 86:04dd9b1680ae 363 ((PARAM) == IRDA_TXDATA_FLUSH_REQUEST))
bogdanm 86:04dd9b1680ae 364 /**
bogdanm 86:04dd9b1680ae 365 * @}
bogdanm 86:04dd9b1680ae 366 */
bogdanm 86:04dd9b1680ae 367
bogdanm 86:04dd9b1680ae 368 /** @defgroup IRDA_Interruption_Mask IRDA interruptions flag mask
bogdanm 86:04dd9b1680ae 369 * @{
bogdanm 86:04dd9b1680ae 370 */
bogdanm 86:04dd9b1680ae 371 #define IRDA_IT_MASK ((uint16_t)0x001F)
bogdanm 86:04dd9b1680ae 372 /**
bogdanm 86:04dd9b1680ae 373 * @}
bogdanm 86:04dd9b1680ae 374 */
bogdanm 86:04dd9b1680ae 375
bogdanm 86:04dd9b1680ae 376 /**
bogdanm 86:04dd9b1680ae 377 * @}
bogdanm 86:04dd9b1680ae 378 */
bogdanm 86:04dd9b1680ae 379
bogdanm 86:04dd9b1680ae 380 /* Exported macros -----------------------------------------------------------*/
bogdanm 92:4fc01daae5a5 381 /** @defgroup IRDA_Exported_Macros IRDA Exported Macros
bogdanm 86:04dd9b1680ae 382 * @{
bogdanm 86:04dd9b1680ae 383 */
bogdanm 86:04dd9b1680ae 384
bogdanm 86:04dd9b1680ae 385 /** @brief Reset IRDA handle state
bogdanm 86:04dd9b1680ae 386 * @param __HANDLE__: IRDA handle.
bogdanm 86:04dd9b1680ae 387 * @retval None
bogdanm 86:04dd9b1680ae 388 */
bogdanm 86:04dd9b1680ae 389 #define __HAL_IRDA_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_IRDA_STATE_RESET)
bogdanm 86:04dd9b1680ae 390
bogdanm 86:04dd9b1680ae 391 /** @brief Checks whether the specified IRDA flag is set or not.
bogdanm 86:04dd9b1680ae 392 * @param __HANDLE__: specifies the IRDA Handle.
bogdanm 86:04dd9b1680ae 393 * The Handle Instance can be UARTx where x: 1, 2, 3, 4, 5 to select the USART or
bogdanm 86:04dd9b1680ae 394 * UART peripheral
bogdanm 86:04dd9b1680ae 395 * @param __FLAG__: specifies the flag to check.
bogdanm 86:04dd9b1680ae 396 * This parameter can be one of the following values:
bogdanm 86:04dd9b1680ae 397 * @arg IRDA_FLAG_REACK: Receive enable ackowledge flag
bogdanm 86:04dd9b1680ae 398 * @arg IRDA_FLAG_TEACK: Transmit enable ackowledge flag
bogdanm 86:04dd9b1680ae 399 * @arg IRDA_FLAG_BUSY: Busy flag
bogdanm 86:04dd9b1680ae 400 * @arg IRDA_FLAG_ABRF: Auto Baud rate detection flag
bogdanm 86:04dd9b1680ae 401 * @arg IRDA_FLAG_ABRE: Auto Baud rate detection error flag
bogdanm 86:04dd9b1680ae 402 * @arg IRDA_FLAG_TXE: Transmit data register empty flag
bogdanm 86:04dd9b1680ae 403 * @arg IRDA_FLAG_TC: Transmission Complete flag
bogdanm 86:04dd9b1680ae 404 * @arg IRDA_FLAG_RXNE: Receive data register not empty flag
bogdanm 86:04dd9b1680ae 405 * @arg IRDA_FLAG_IDLE: Idle Line detection flag
bogdanm 86:04dd9b1680ae 406 * @arg IRDA_FLAG_ORE: OverRun Error flag
bogdanm 86:04dd9b1680ae 407 * @arg IRDA_FLAG_NE: Noise Error flag
bogdanm 86:04dd9b1680ae 408 * @arg IRDA_FLAG_FE: Framing Error flag
bogdanm 86:04dd9b1680ae 409 * @arg IRDA_FLAG_PE: Parity Error flag
bogdanm 86:04dd9b1680ae 410 * @retval The new state of __FLAG__ (TRUE or FALSE).
bogdanm 86:04dd9b1680ae 411 */
bogdanm 86:04dd9b1680ae 412 #define __HAL_IRDA_GET_FLAG(__HANDLE__, __FLAG__) (((__HANDLE__)->Instance->ISR & (__FLAG__)) == (__FLAG__))
bogdanm 86:04dd9b1680ae 413
bogdanm 86:04dd9b1680ae 414 /** @brief Enables the specified IRDA interrupt.
bogdanm 86:04dd9b1680ae 415 * @param __HANDLE__: specifies the IRDA Handle.
bogdanm 86:04dd9b1680ae 416 * The Handle Instance can be UARTx where x: 1, 2, 3, 4, 5 to select the USART or
bogdanm 86:04dd9b1680ae 417 * UART peripheral
bogdanm 86:04dd9b1680ae 418 * @param __INTERRUPT__: specifies the IRDA interrupt source to enable.
bogdanm 86:04dd9b1680ae 419 * This parameter can be one of the following values:
bogdanm 86:04dd9b1680ae 420 * @arg IRDA_IT_TXE: Transmit Data Register empty interrupt
bogdanm 86:04dd9b1680ae 421 * @arg IRDA_IT_TC: Transmission complete interrupt
bogdanm 86:04dd9b1680ae 422 * @arg IRDA_IT_RXNE: Receive Data register not empty interrupt
bogdanm 86:04dd9b1680ae 423 * @arg IRDA_IT_IDLE: Idle line detection interrupt
bogdanm 86:04dd9b1680ae 424 * @arg IRDA_IT_PE: Parity Error interrupt
bogdanm 86:04dd9b1680ae 425 * @arg IRDA_IT_ERR: Error interrupt(Frame error, noise error, overrun error)
bogdanm 86:04dd9b1680ae 426 * @retval None
bogdanm 86:04dd9b1680ae 427 */
bogdanm 86:04dd9b1680ae 428 #define __HAL_IRDA_ENABLE_IT(__HANDLE__, __INTERRUPT__) (((((uint8_t)(__INTERRUPT__)) >> 5U) == 1)? ((__HANDLE__)->Instance->CR1 |= (1U << ((__INTERRUPT__) & IRDA_IT_MASK))): \
bogdanm 86:04dd9b1680ae 429 ((((uint8_t)(__INTERRUPT__)) >> 5U) == 2)? ((__HANDLE__)->Instance->CR2 |= (1U << ((__INTERRUPT__) & IRDA_IT_MASK))): \
bogdanm 86:04dd9b1680ae 430 ((__HANDLE__)->Instance->CR3 |= (1U << ((__INTERRUPT__) & IRDA_IT_MASK))))
bogdanm 86:04dd9b1680ae 431
bogdanm 86:04dd9b1680ae 432 /** @brief Disables the specified IRDA interrupt.
bogdanm 86:04dd9b1680ae 433 * @param __HANDLE__: specifies the IRDA Handle.
bogdanm 86:04dd9b1680ae 434 * The Handle Instance can be UARTx where x: 1, 2, 3, 4, 5 to select the USART or
bogdanm 86:04dd9b1680ae 435 * UART peripheral
bogdanm 86:04dd9b1680ae 436 * @param __INTERRUPT__: specifies the IRDA interrupt source to disable.
bogdanm 86:04dd9b1680ae 437 * This parameter can be one of the following values:
bogdanm 86:04dd9b1680ae 438 * @arg IRDA_IT_TXE: Transmit Data Register empty interrupt
bogdanm 86:04dd9b1680ae 439 * @arg IRDA_IT_TC: Transmission complete interrupt
bogdanm 86:04dd9b1680ae 440 * @arg IRDA_IT_RXNE: Receive Data register not empty interrupt
bogdanm 86:04dd9b1680ae 441 * @arg IRDA_IT_IDLE: Idle line detection interrupt
bogdanm 86:04dd9b1680ae 442 * @arg IRDA_IT_PE: Parity Error interrupt
bogdanm 86:04dd9b1680ae 443 * @arg IRDA_IT_ERR: Error interrupt(Frame error, noise error, overrun error)
bogdanm 86:04dd9b1680ae 444 * @retval None
bogdanm 86:04dd9b1680ae 445 */
bogdanm 86:04dd9b1680ae 446 #define __HAL_IRDA_DISABLE_IT(__HANDLE__, __INTERRUPT__) (((((uint8_t)(__INTERRUPT__)) >> 5U) == 1)? ((__HANDLE__)->Instance->CR1 &= ~ (1U << ((__INTERRUPT__) & IRDA_IT_MASK))): \
bogdanm 86:04dd9b1680ae 447 ((((uint8_t)(__INTERRUPT__)) >> 5U) == 2)? ((__HANDLE__)->Instance->CR2 &= ~ (1U << ((__INTERRUPT__) & IRDA_IT_MASK))): \
bogdanm 86:04dd9b1680ae 448 ((__HANDLE__)->Instance->CR3 &= ~ (1U << ((__INTERRUPT__) & IRDA_IT_MASK))))
bogdanm 86:04dd9b1680ae 449
bogdanm 86:04dd9b1680ae 450
bogdanm 86:04dd9b1680ae 451 /** @brief Checks whether the specified IRDA interrupt has occurred or not.
bogdanm 86:04dd9b1680ae 452 * @param __HANDLE__: specifies the IRDA Handle.
bogdanm 86:04dd9b1680ae 453 * The Handle Instance can be UARTx where x: 1, 2, 3, 4, 5 to select the USART or
bogdanm 86:04dd9b1680ae 454 * UART peripheral
bogdanm 86:04dd9b1680ae 455 * @param __IT__: specifies the IRDA interrupt source to check.
bogdanm 86:04dd9b1680ae 456 * This parameter can be one of the following values:
bogdanm 86:04dd9b1680ae 457 * @arg IRDA_IT_TXE: Transmit Data Register empty interrupt
bogdanm 86:04dd9b1680ae 458 * @arg IRDA_IT_TC: Transmission complete interrupt
bogdanm 86:04dd9b1680ae 459 * @arg IRDA_IT_RXNE: Receive Data register not empty interrupt
bogdanm 86:04dd9b1680ae 460 * @arg IRDA_IT_IDLE: Idle line detection interrupt
bogdanm 86:04dd9b1680ae 461 * @arg IRDA_IT_ORE: OverRun Error interrupt
bogdanm 86:04dd9b1680ae 462 * @arg IRDA_IT_NE: Noise Error interrupt
bogdanm 86:04dd9b1680ae 463 * @arg IRDA_IT_FE: Framing Error interrupt
bogdanm 86:04dd9b1680ae 464 * @arg IRDA_IT_PE: Parity Error interrupt
bogdanm 86:04dd9b1680ae 465 * @retval The new state of __IT__ (TRUE or FALSE).
bogdanm 86:04dd9b1680ae 466 */
bogdanm 86:04dd9b1680ae 467 #define __HAL_IRDA_GET_IT(__HANDLE__, __IT__) ((__HANDLE__)->Instance->ISR & ((uint32_t)1U << ((__IT__)>> 0x08)))
bogdanm 86:04dd9b1680ae 468
bogdanm 86:04dd9b1680ae 469 /** @brief Checks whether the specified IRDA interrupt source is enabled.
bogdanm 86:04dd9b1680ae 470 * @param __HANDLE__: specifies the IRDA Handle.
bogdanm 86:04dd9b1680ae 471 * The Handle Instance can be UARTx where x: 1, 2, 3, 4, 5 to select the USART or
bogdanm 86:04dd9b1680ae 472 * UART peripheral
bogdanm 86:04dd9b1680ae 473 * @param __IT__: specifies the IRDA interrupt source to check.
bogdanm 86:04dd9b1680ae 474 * This parameter can be one of the following values:
bogdanm 86:04dd9b1680ae 475 * @arg IRDA_IT_TXE: Transmit Data Register empty interrupt
bogdanm 86:04dd9b1680ae 476 * @arg IRDA_IT_TC: Transmission complete interrupt
bogdanm 86:04dd9b1680ae 477 * @arg IRDA_IT_RXNE: Receive Data register not empty interrupt
bogdanm 86:04dd9b1680ae 478 * @arg IRDA_IT_IDLE: Idle line detection interrupt
bogdanm 86:04dd9b1680ae 479 * @arg IRDA_IT_ORE: OverRun Error interrupt
bogdanm 86:04dd9b1680ae 480 * @arg IRDA_IT_NE: Noise Error interrupt
bogdanm 86:04dd9b1680ae 481 * @arg IRDA_IT_FE: Framing Error interrupt
bogdanm 86:04dd9b1680ae 482 * @arg IRDA_IT_PE: Parity Error interrupt
bogdanm 86:04dd9b1680ae 483 * @retval The new state of __IT__ (TRUE or FALSE).
bogdanm 86:04dd9b1680ae 484 */
bogdanm 86:04dd9b1680ae 485 #define __HAL_IRDA_GET_IT_SOURCE(__HANDLE__, __IT__) ((((((uint8_t)(__IT__)) >> 5U) == 1)? (__HANDLE__)->Instance->CR1:(((((uint8_t)(__IT__)) >> 5U) == 2)? \
bogdanm 86:04dd9b1680ae 486 (__HANDLE__)->Instance->CR2 : (__HANDLE__)->Instance->CR3)) & ((uint32_t)1 << (((uint16_t)(__IT__)) & IRDA_IT_MASK)))
bogdanm 86:04dd9b1680ae 487
bogdanm 86:04dd9b1680ae 488
bogdanm 86:04dd9b1680ae 489 /** @brief Clears the specified IRDA ISR flag, in setting the proper ICR register flag.
bogdanm 86:04dd9b1680ae 490 * @param __HANDLE__: specifies the IRDA Handle.
bogdanm 86:04dd9b1680ae 491 * The Handle Instance can be UARTx where x: 1, 2, 3, 4, 5 to select the USART or
bogdanm 86:04dd9b1680ae 492 * UART peripheral
bogdanm 86:04dd9b1680ae 493 * @param __IT_CLEAR__: specifies the interrupt clear register flag that needs to be set
bogdanm 86:04dd9b1680ae 494 * to clear the corresponding interrupt
bogdanm 86:04dd9b1680ae 495 * This parameter can be one of the following values:
bogdanm 86:04dd9b1680ae 496 * @arg IRDA_CLEAR_PEF: Parity Error Clear Flag
bogdanm 86:04dd9b1680ae 497 * @arg IRDA_CLEAR_FEF: Framing Error Clear Flag
bogdanm 86:04dd9b1680ae 498 * @arg IRDA_CLEAR_NEF: Noise detected Clear Flag
bogdanm 86:04dd9b1680ae 499 * @arg IRDA_CLEAR_OREF: OverRun Error Clear Flag
bogdanm 86:04dd9b1680ae 500 * @arg IRDA_CLEAR_TCF: Transmission Complete Clear Flag
bogdanm 86:04dd9b1680ae 501 * @retval None
bogdanm 86:04dd9b1680ae 502 */
bogdanm 86:04dd9b1680ae 503 #define __HAL_IRDA_CLEAR_IT(__HANDLE__, __IT_CLEAR__) ((__HANDLE__)->Instance->ICR = (uint32_t)(__IT_CLEAR__))
bogdanm 86:04dd9b1680ae 504
bogdanm 86:04dd9b1680ae 505
bogdanm 86:04dd9b1680ae 506 /** @brief Set a specific IRDA request flag.
bogdanm 86:04dd9b1680ae 507 * @param __HANDLE__: specifies the IRDA Handle.
bogdanm 86:04dd9b1680ae 508 * The Handle Instance can be UARTx where x: 1, 2, 3, 4, 5 to select the USART or
bogdanm 86:04dd9b1680ae 509 * UART peripheral
bogdanm 86:04dd9b1680ae 510 * @param __REQ__: specifies the request flag to set
bogdanm 86:04dd9b1680ae 511 * This parameter can be one of the following values:
bogdanm 86:04dd9b1680ae 512 * @arg IRDA_AUTOBAUD_REQUEST: Auto-Baud Rate Request
bogdanm 86:04dd9b1680ae 513 * @arg IRDA_RXDATA_FLUSH_REQUEST: Receive Data flush Request
bogdanm 86:04dd9b1680ae 514 * @arg IRDA_TXDATA_FLUSH_REQUEST: Transmit data flush Request
bogdanm 86:04dd9b1680ae 515 *
bogdanm 86:04dd9b1680ae 516 * @retval None
bogdanm 86:04dd9b1680ae 517 */
bogdanm 86:04dd9b1680ae 518 #define __HAL_IRDA_SEND_REQ(__HANDLE__, __REQ__) ((__HANDLE__)->Instance->RQR |= (uint16_t)(__REQ__))
bogdanm 86:04dd9b1680ae 519
bogdanm 86:04dd9b1680ae 520
bogdanm 86:04dd9b1680ae 521
bogdanm 86:04dd9b1680ae 522 /** @brief Enable UART/USART associated to IRDA Handle
bogdanm 86:04dd9b1680ae 523 * @param __HANDLE__: specifies the IRDA Handle.
bogdanm 86:04dd9b1680ae 524 * The Handle Instance can be UARTx where x: 1, 2, 3, 4, 5 to select the USART or
bogdanm 86:04dd9b1680ae 525 * UART peripheral
bogdanm 86:04dd9b1680ae 526 * @retval None
bogdanm 86:04dd9b1680ae 527 */
bogdanm 86:04dd9b1680ae 528 #define __HAL_IRDA_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->CR1 |= USART_CR1_UE)
bogdanm 86:04dd9b1680ae 529
bogdanm 86:04dd9b1680ae 530 /** @brief Disable UART/USART associated to IRDA Handle
bogdanm 86:04dd9b1680ae 531 * @param __HANDLE__: specifies the IRDA Handle.
bogdanm 86:04dd9b1680ae 532 * The Handle Instance can be UARTx where x: 1, 2, 3, 4, 5 to select the USART or
bogdanm 86:04dd9b1680ae 533 * UART peripheral
bogdanm 86:04dd9b1680ae 534 * @retval None
bogdanm 86:04dd9b1680ae 535 */
bogdanm 86:04dd9b1680ae 536 #define __HAL_IRDA_DISABLE(__HANDLE__) ((__HANDLE__)->Instance->CR1 &= ~USART_CR1_UE)
bogdanm 86:04dd9b1680ae 537
bogdanm 86:04dd9b1680ae 538 /** @brief Ensure that IRDA Baud rate is less or equal to maximum value
bogdanm 86:04dd9b1680ae 539 * @param __BAUDRATE__: specifies the IRDA Baudrate set by the user.
bogdanm 86:04dd9b1680ae 540 * @retval True or False
bogdanm 86:04dd9b1680ae 541 */
bogdanm 86:04dd9b1680ae 542 #define IS_IRDA_BAUDRATE(__BAUDRATE__) ((__BAUDRATE__) < 115201)
bogdanm 86:04dd9b1680ae 543
bogdanm 86:04dd9b1680ae 544 /** @brief Ensure that IRDA prescaler value is strictly larger than 0
bogdanm 86:04dd9b1680ae 545 * @param __PRESCALER__: specifies the IRDA prescaler value set by the user.
bogdanm 86:04dd9b1680ae 546 * @retval True or False
bogdanm 86:04dd9b1680ae 547 */
bogdanm 86:04dd9b1680ae 548 #define IS_IRDA_PRESCALER(__PRESCALER__) ((__PRESCALER__) > 0)
bogdanm 86:04dd9b1680ae 549
bogdanm 86:04dd9b1680ae 550 /**
bogdanm 86:04dd9b1680ae 551 * @}
bogdanm 86:04dd9b1680ae 552 */
bogdanm 86:04dd9b1680ae 553
bogdanm 92:4fc01daae5a5 554 /* Include IRDA HAL Extended module */
bogdanm 86:04dd9b1680ae 555 #include "stm32f3xx_hal_irda_ex.h"
bogdanm 86:04dd9b1680ae 556
bogdanm 86:04dd9b1680ae 557 /* Exported functions --------------------------------------------------------*/
bogdanm 92:4fc01daae5a5 558
bogdanm 92:4fc01daae5a5 559 /** @addtogroup IRDA_Exported_Functions IRDA Exported Functions
bogdanm 92:4fc01daae5a5 560 * @{
bogdanm 92:4fc01daae5a5 561 */
bogdanm 92:4fc01daae5a5 562
bogdanm 92:4fc01daae5a5 563 /** @addtogroup IRDA_Exported_Functions_Group1 Initialization and de-initialization functions
bogdanm 92:4fc01daae5a5 564 * @{
bogdanm 92:4fc01daae5a5 565 */
bogdanm 92:4fc01daae5a5 566
bogdanm 86:04dd9b1680ae 567 /* Initialization and de-initialization functions ****************************/
bogdanm 86:04dd9b1680ae 568 HAL_StatusTypeDef HAL_IRDA_Init(IRDA_HandleTypeDef *hirda);
bogdanm 86:04dd9b1680ae 569 HAL_StatusTypeDef HAL_IRDA_DeInit(IRDA_HandleTypeDef *hirda);
bogdanm 86:04dd9b1680ae 570 void HAL_IRDA_MspInit(IRDA_HandleTypeDef *hirda);
bogdanm 86:04dd9b1680ae 571 void HAL_IRDA_MspDeInit(IRDA_HandleTypeDef *hirda);
bogdanm 86:04dd9b1680ae 572
bogdanm 92:4fc01daae5a5 573 /**
bogdanm 92:4fc01daae5a5 574 * @}
bogdanm 92:4fc01daae5a5 575 */
bogdanm 92:4fc01daae5a5 576
bogdanm 92:4fc01daae5a5 577 /** @addtogroup IRDA_Exported_Functions_Group2 Input and Output operation functions
bogdanm 92:4fc01daae5a5 578 * @{
bogdanm 92:4fc01daae5a5 579 */
bogdanm 86:04dd9b1680ae 580
bogdanm 86:04dd9b1680ae 581 /* IO operation functions *****************************************************/
bogdanm 86:04dd9b1680ae 582 HAL_StatusTypeDef HAL_IRDA_Transmit(IRDA_HandleTypeDef *hirda, uint8_t *pData, uint16_t Size, uint32_t Timeout);
bogdanm 86:04dd9b1680ae 583 HAL_StatusTypeDef HAL_IRDA_Receive(IRDA_HandleTypeDef *hirda, uint8_t *pData, uint16_t Size, uint32_t Timeout);
bogdanm 86:04dd9b1680ae 584 HAL_StatusTypeDef HAL_IRDA_Transmit_IT(IRDA_HandleTypeDef *hirda, uint8_t *pData, uint16_t Size);
bogdanm 86:04dd9b1680ae 585 HAL_StatusTypeDef HAL_IRDA_Receive_IT(IRDA_HandleTypeDef *hirda, uint8_t *pData, uint16_t Size);
bogdanm 86:04dd9b1680ae 586 HAL_StatusTypeDef HAL_IRDA_Transmit_DMA(IRDA_HandleTypeDef *hirda, uint8_t *pData, uint16_t Size);
bogdanm 86:04dd9b1680ae 587 HAL_StatusTypeDef HAL_IRDA_Receive_DMA(IRDA_HandleTypeDef *hirda, uint8_t *pData, uint16_t Size);
bogdanm 86:04dd9b1680ae 588 void HAL_IRDA_IRQHandler(IRDA_HandleTypeDef *hirda);
bogdanm 86:04dd9b1680ae 589 void HAL_IRDA_TxCpltCallback(IRDA_HandleTypeDef *hirda);
bogdanm 86:04dd9b1680ae 590 void HAL_IRDA_RxCpltCallback(IRDA_HandleTypeDef *hirda);
bogdanm 86:04dd9b1680ae 591 void HAL_IRDA_ErrorCallback(IRDA_HandleTypeDef *hirda);
bogdanm 86:04dd9b1680ae 592
bogdanm 92:4fc01daae5a5 593 /**
bogdanm 92:4fc01daae5a5 594 * @}
bogdanm 92:4fc01daae5a5 595 */
bogdanm 92:4fc01daae5a5 596
bogdanm 92:4fc01daae5a5 597 /** @addtogroup IRDA_Exported_Functions_Group3 Peripheral State and Errors functions
bogdanm 92:4fc01daae5a5 598 * @{
bogdanm 92:4fc01daae5a5 599 */
bogdanm 92:4fc01daae5a5 600
bogdanm 86:04dd9b1680ae 601 /* Peripheral State and Error functions ***************************************/
bogdanm 86:04dd9b1680ae 602 HAL_IRDA_StateTypeDef HAL_IRDA_GetState(IRDA_HandleTypeDef *hirda);
bogdanm 86:04dd9b1680ae 603 uint32_t HAL_IRDA_GetError(IRDA_HandleTypeDef *hirda);
bogdanm 86:04dd9b1680ae 604
bogdanm 86:04dd9b1680ae 605 /**
bogdanm 86:04dd9b1680ae 606 * @}
bogdanm 86:04dd9b1680ae 607 */
bogdanm 86:04dd9b1680ae 608
bogdanm 86:04dd9b1680ae 609 /**
bogdanm 86:04dd9b1680ae 610 * @}
bogdanm 92:4fc01daae5a5 611 */
bogdanm 92:4fc01daae5a5 612
bogdanm 92:4fc01daae5a5 613 /**
bogdanm 92:4fc01daae5a5 614 * @}
bogdanm 86:04dd9b1680ae 615 */
bogdanm 92:4fc01daae5a5 616
bogdanm 92:4fc01daae5a5 617 /**
bogdanm 92:4fc01daae5a5 618 * @}
bogdanm 92:4fc01daae5a5 619 */
bogdanm 86:04dd9b1680ae 620 #ifdef __cplusplus
bogdanm 86:04dd9b1680ae 621 }
bogdanm 86:04dd9b1680ae 622 #endif
bogdanm 86:04dd9b1680ae 623
bogdanm 86:04dd9b1680ae 624 #endif /* __STM32F3xx_HAL_IRDA_H */
bogdanm 86:04dd9b1680ae 625
bogdanm 86:04dd9b1680ae 626 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/