Ricardo Benitez / mbed

meh

Fork of mbed by mbed official

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

Committer:
ricardobtez
Date:
Tue Apr 05 23:51:21 2016 +0000
Revision:
118:16969dd821af
Parent:
86:04dd9b1680ae
Child:
99:dbbf35b96557
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 stm32f4xx_hal_irda.h
bogdanm 86:04dd9b1680ae 4 * @author MCD Application Team
bogdanm 86:04dd9b1680ae 5 * @version V1.1.0
bogdanm 86:04dd9b1680ae 6 * @date 19-June-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 __STM32F4xx_HAL_IRDA_H
bogdanm 86:04dd9b1680ae 40 #define __STM32F4xx_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 "stm32f4xx_hal_def.h"
bogdanm 86:04dd9b1680ae 48
bogdanm 86:04dd9b1680ae 49 /** @addtogroup STM32F4xx_HAL_Driver
bogdanm 86:04dd9b1680ae 50 * @{
bogdanm 86:04dd9b1680ae 51 */
bogdanm 86:04dd9b1680ae 52
bogdanm 86:04dd9b1680ae 53 /** @addtogroup IRDA
bogdanm 86:04dd9b1680ae 54 * @{
bogdanm 86:04dd9b1680ae 55 */
bogdanm 86:04dd9b1680ae 56
bogdanm 86:04dd9b1680ae 57 /* Exported types ------------------------------------------------------------*/
bogdanm 86:04dd9b1680ae 58
bogdanm 86:04dd9b1680ae 59 /**
bogdanm 86:04dd9b1680ae 60 * @brief IRDA Init Structure definition
bogdanm 86:04dd9b1680ae 61 */
bogdanm 86:04dd9b1680ae 62 typedef struct
bogdanm 86:04dd9b1680ae 63 {
bogdanm 86:04dd9b1680ae 64 uint32_t BaudRate; /*!< This member configures the IRDA communication baud rate.
bogdanm 86:04dd9b1680ae 65 The baud rate is computed using the following formula:
bogdanm 86:04dd9b1680ae 66 - IntegerDivider = ((PCLKx) / (8 * (hirda->Init.BaudRate)))
bogdanm 86:04dd9b1680ae 67 - FractionalDivider = ((IntegerDivider - ((uint32_t) IntegerDivider)) * 8) + 0.5 */
bogdanm 86:04dd9b1680ae 68
bogdanm 86:04dd9b1680ae 69 uint32_t WordLength; /*!< Specifies the number of data bits transmitted or received in a frame.
bogdanm 86:04dd9b1680ae 70 This parameter can be a value of @ref IRDA_Word_Length */
bogdanm 86:04dd9b1680ae 71
bogdanm 86:04dd9b1680ae 72
bogdanm 86:04dd9b1680ae 73 uint32_t Parity; /*!< Specifies the parity mode.
bogdanm 86:04dd9b1680ae 74 This parameter can be a value of @ref IRDA_Parity
bogdanm 86:04dd9b1680ae 75 @note When parity is enabled, the computed parity is inserted
bogdanm 86:04dd9b1680ae 76 at the MSB position of the transmitted data (9th bit when
bogdanm 86:04dd9b1680ae 77 the word length is set to 9 data bits; 8th bit when the
bogdanm 86:04dd9b1680ae 78 word length is set to 8 data bits). */
bogdanm 86:04dd9b1680ae 79
bogdanm 86:04dd9b1680ae 80 uint32_t Mode; /*!< Specifies wether the Receive or Transmit mode is enabled or disabled.
bogdanm 86:04dd9b1680ae 81 This parameter can be a value of @ref IRDA_Mode */
bogdanm 86:04dd9b1680ae 82
bogdanm 86:04dd9b1680ae 83 uint8_t Prescaler; /*!< Specifies the Prescaler */
bogdanm 86:04dd9b1680ae 84
bogdanm 86:04dd9b1680ae 85 uint32_t IrDAMode; /*!< Specifies the IrDA mode
bogdanm 86:04dd9b1680ae 86 This parameter can be a value of @ref IrDA_Low_Power */
bogdanm 86:04dd9b1680ae 87 }IRDA_InitTypeDef;
bogdanm 86:04dd9b1680ae 88
bogdanm 86:04dd9b1680ae 89 /**
bogdanm 86:04dd9b1680ae 90 * @brief HAL State structures definition
bogdanm 86:04dd9b1680ae 91 */
bogdanm 86:04dd9b1680ae 92 typedef enum
bogdanm 86:04dd9b1680ae 93 {
bogdanm 86:04dd9b1680ae 94 HAL_IRDA_STATE_RESET = 0x00, /*!< Peripheral is not yet Initialized */
bogdanm 86:04dd9b1680ae 95 HAL_IRDA_STATE_READY = 0x01, /*!< Peripheral Initialized and ready for use */
bogdanm 86:04dd9b1680ae 96 HAL_IRDA_STATE_BUSY = 0x02, /*!< an internal process is ongoing */
bogdanm 86:04dd9b1680ae 97 HAL_IRDA_STATE_BUSY_TX = 0x12, /*!< Data Transmission process is ongoing */
bogdanm 86:04dd9b1680ae 98 HAL_IRDA_STATE_BUSY_RX = 0x22, /*!< Data Reception process is ongoing */
bogdanm 86:04dd9b1680ae 99 HAL_IRDA_STATE_BUSY_TX_RX = 0x32, /*!< Data Transmission and Reception process is ongoing */
bogdanm 86:04dd9b1680ae 100 HAL_IRDA_STATE_TIMEOUT = 0x03, /*!< Timeout state */
bogdanm 86:04dd9b1680ae 101 HAL_IRDA_STATE_ERROR = 0x04 /*!< Error */
bogdanm 86:04dd9b1680ae 102 }HAL_IRDA_StateTypeDef;
bogdanm 86:04dd9b1680ae 103
bogdanm 86:04dd9b1680ae 104 /**
bogdanm 86:04dd9b1680ae 105 * @brief HAL IRDA Error Code structure definition
bogdanm 86:04dd9b1680ae 106 */
bogdanm 86:04dd9b1680ae 107 typedef enum
bogdanm 86:04dd9b1680ae 108 {
bogdanm 86:04dd9b1680ae 109 HAL_IRDA_ERROR_NONE = 0x00, /*!< No error */
bogdanm 86:04dd9b1680ae 110 HAL_IRDA_ERROR_PE = 0x01, /*!< Parity error */
bogdanm 86:04dd9b1680ae 111 HAL_IRDA_ERROR_NE = 0x02, /*!< Noise error */
bogdanm 86:04dd9b1680ae 112 HAL_IRDA_ERROR_FE = 0x04, /*!< frame error */
bogdanm 86:04dd9b1680ae 113 HAL_IRDA_ERROR_ORE = 0x08, /*!< Overrun error */
bogdanm 86:04dd9b1680ae 114 HAL_IRDA_ERROR_DMA = 0x10 /*!< DMA transfer error */
bogdanm 86:04dd9b1680ae 115 }HAL_IRDA_ErrorTypeDef;
bogdanm 86:04dd9b1680ae 116
bogdanm 86:04dd9b1680ae 117 /**
bogdanm 86:04dd9b1680ae 118 * @brief IRDA handle Structure definition
bogdanm 86:04dd9b1680ae 119 */
bogdanm 86:04dd9b1680ae 120 typedef struct
bogdanm 86:04dd9b1680ae 121 {
bogdanm 86:04dd9b1680ae 122 USART_TypeDef *Instance; /* USART registers base address */
bogdanm 86:04dd9b1680ae 123
bogdanm 86:04dd9b1680ae 124 IRDA_InitTypeDef Init; /* IRDA communication parameters */
bogdanm 86:04dd9b1680ae 125
bogdanm 86:04dd9b1680ae 126 uint8_t *pTxBuffPtr; /* Pointer to IRDA Tx transfer Buffer */
bogdanm 86:04dd9b1680ae 127
bogdanm 86:04dd9b1680ae 128 uint16_t TxXferSize; /* IRDA Tx Transfer size */
bogdanm 86:04dd9b1680ae 129
bogdanm 86:04dd9b1680ae 130 uint16_t TxXferCount; /* IRDA Tx Transfer Counter */
bogdanm 86:04dd9b1680ae 131
bogdanm 86:04dd9b1680ae 132 uint8_t *pRxBuffPtr; /* Pointer to IRDA Rx transfer Buffer */
bogdanm 86:04dd9b1680ae 133
bogdanm 86:04dd9b1680ae 134 uint16_t RxXferSize; /* IRDA Rx Transfer size */
bogdanm 86:04dd9b1680ae 135
bogdanm 86:04dd9b1680ae 136 uint16_t RxXferCount; /* IRDA Rx Transfer Counter */
bogdanm 86:04dd9b1680ae 137
bogdanm 86:04dd9b1680ae 138 DMA_HandleTypeDef *hdmatx; /* IRDA Tx DMA Handle parameters */
bogdanm 86:04dd9b1680ae 139
bogdanm 86:04dd9b1680ae 140 DMA_HandleTypeDef *hdmarx; /* IRDA Rx DMA Handle parameters */
bogdanm 86:04dd9b1680ae 141
bogdanm 86:04dd9b1680ae 142 HAL_LockTypeDef Lock; /* Locking object */
bogdanm 86:04dd9b1680ae 143
bogdanm 86:04dd9b1680ae 144 __IO HAL_IRDA_StateTypeDef State; /* IRDA communication state */
bogdanm 86:04dd9b1680ae 145
bogdanm 86:04dd9b1680ae 146 __IO HAL_IRDA_ErrorTypeDef ErrorCode; /* IRDA Error code */
bogdanm 86:04dd9b1680ae 147
bogdanm 86:04dd9b1680ae 148 }IRDA_HandleTypeDef;
bogdanm 86:04dd9b1680ae 149
bogdanm 86:04dd9b1680ae 150 /* Exported constants --------------------------------------------------------*/
bogdanm 86:04dd9b1680ae 151 /** @defgroup IRDA_Exported_Constants
bogdanm 86:04dd9b1680ae 152 * @{
bogdanm 86:04dd9b1680ae 153 */
bogdanm 86:04dd9b1680ae 154
bogdanm 86:04dd9b1680ae 155 /** @defgroup IRDA_Word_Length
bogdanm 86:04dd9b1680ae 156 * @{
bogdanm 86:04dd9b1680ae 157 */
bogdanm 86:04dd9b1680ae 158 #define IRDA_WORDLENGTH_8B ((uint32_t)0x00000000)
bogdanm 86:04dd9b1680ae 159 #define IRDA_WORDLENGTH_9B ((uint32_t)USART_CR1_M)
bogdanm 86:04dd9b1680ae 160 #define IS_IRDA_WORD_LENGTH(LENGTH) (((LENGTH) == IRDA_WORDLENGTH_8B) || \
bogdanm 86:04dd9b1680ae 161 ((LENGTH) == IRDA_WORDLENGTH_9B))
bogdanm 86:04dd9b1680ae 162 /**
bogdanm 86:04dd9b1680ae 163 * @}
bogdanm 86:04dd9b1680ae 164 */
bogdanm 86:04dd9b1680ae 165
bogdanm 86:04dd9b1680ae 166
bogdanm 86:04dd9b1680ae 167 /** @defgroup IRDA_Parity
bogdanm 86:04dd9b1680ae 168 * @{
bogdanm 86:04dd9b1680ae 169 */
bogdanm 86:04dd9b1680ae 170 #define IRDA_PARITY_NONE ((uint32_t)0x00000000)
bogdanm 86:04dd9b1680ae 171 #define IRDA_PARITY_EVEN ((uint32_t)USART_CR1_PCE)
bogdanm 86:04dd9b1680ae 172 #define IRDA_PARITY_ODD ((uint32_t)(USART_CR1_PCE | USART_CR1_PS))
bogdanm 86:04dd9b1680ae 173 #define IS_IRDA_PARITY(PARITY) (((PARITY) == IRDA_PARITY_NONE) || \
bogdanm 86:04dd9b1680ae 174 ((PARITY) == IRDA_PARITY_EVEN) || \
bogdanm 86:04dd9b1680ae 175 ((PARITY) == IRDA_PARITY_ODD))
bogdanm 86:04dd9b1680ae 176 /**
bogdanm 86:04dd9b1680ae 177 * @}
bogdanm 86:04dd9b1680ae 178 */
bogdanm 86:04dd9b1680ae 179
bogdanm 86:04dd9b1680ae 180
bogdanm 86:04dd9b1680ae 181 /** @defgroup IRDA_Mode
bogdanm 86:04dd9b1680ae 182 * @{
bogdanm 86:04dd9b1680ae 183 */
bogdanm 86:04dd9b1680ae 184 #define IRDA_MODE_RX ((uint32_t)USART_CR1_RE)
bogdanm 86:04dd9b1680ae 185 #define IRDA_MODE_TX ((uint32_t)USART_CR1_TE)
bogdanm 86:04dd9b1680ae 186 #define IRDA_MODE_TX_RX ((uint32_t)(USART_CR1_TE |USART_CR1_RE))
bogdanm 86:04dd9b1680ae 187 #define IS_IRDA_MODE(MODE) ((((MODE) & (uint32_t)0x0000FFF3) == 0x00) && ((MODE) != (uint32_t)0x000000))
bogdanm 86:04dd9b1680ae 188 /**
bogdanm 86:04dd9b1680ae 189 * @}
bogdanm 86:04dd9b1680ae 190 */
bogdanm 86:04dd9b1680ae 191
bogdanm 86:04dd9b1680ae 192 /** @defgroup IrDA_Low_Power
bogdanm 86:04dd9b1680ae 193 * @{
bogdanm 86:04dd9b1680ae 194 */
bogdanm 86:04dd9b1680ae 195 #define IRDA_POWERMODE_LOWPOWER ((uint32_t)USART_CR3_IRLP)
bogdanm 86:04dd9b1680ae 196 #define IRDA_POWERMODE_NORMAL ((uint32_t)0x00000000)
bogdanm 86:04dd9b1680ae 197 #define IS_IRDA_POWERMODE(MODE) (((MODE) == IRDA_POWERMODE_LOWPOWER) || \
bogdanm 86:04dd9b1680ae 198 ((MODE) == IRDA_POWERMODE_NORMAL))
bogdanm 86:04dd9b1680ae 199 /**
bogdanm 86:04dd9b1680ae 200 * @}
bogdanm 86:04dd9b1680ae 201 */
bogdanm 86:04dd9b1680ae 202
bogdanm 86:04dd9b1680ae 203 /** @defgroup IRDA_Flags
bogdanm 86:04dd9b1680ae 204 * Elements values convention: 0xXXXX
bogdanm 86:04dd9b1680ae 205 * - 0xXXXX : Flag mask in the SR register
bogdanm 86:04dd9b1680ae 206 * @{
bogdanm 86:04dd9b1680ae 207 */
bogdanm 86:04dd9b1680ae 208 #define IRDA_FLAG_TXE ((uint32_t)0x00000080)
bogdanm 86:04dd9b1680ae 209 #define IRDA_FLAG_TC ((uint32_t)0x00000040)
bogdanm 86:04dd9b1680ae 210 #define IRDA_FLAG_RXNE ((uint32_t)0x00000020)
bogdanm 86:04dd9b1680ae 211 #define IRDA_FLAG_IDLE ((uint32_t)0x00000010)
bogdanm 86:04dd9b1680ae 212 #define IRDA_FLAG_ORE ((uint32_t)0x00000008)
bogdanm 86:04dd9b1680ae 213 #define IRDA_FLAG_NE ((uint32_t)0x00000004)
bogdanm 86:04dd9b1680ae 214 #define IRDA_FLAG_FE ((uint32_t)0x00000002)
bogdanm 86:04dd9b1680ae 215 #define IRDA_FLAG_PE ((uint32_t)0x00000001)
bogdanm 86:04dd9b1680ae 216 /**
bogdanm 86:04dd9b1680ae 217 * @}
bogdanm 86:04dd9b1680ae 218 */
bogdanm 86:04dd9b1680ae 219
bogdanm 86:04dd9b1680ae 220 /** @defgroup IRDA_Interrupt_definition
bogdanm 86:04dd9b1680ae 221 * Elements values convention: 0xY000XXXX
bogdanm 86:04dd9b1680ae 222 * - XXXX : Interrupt mask in the XX register
bogdanm 86:04dd9b1680ae 223 * - Y : Interrupt source register (2bits)
bogdanm 86:04dd9b1680ae 224 * - 01: CR1 register
bogdanm 86:04dd9b1680ae 225 * - 10: CR2 register
bogdanm 86:04dd9b1680ae 226 * - 11: CR3 register
bogdanm 86:04dd9b1680ae 227 *
bogdanm 86:04dd9b1680ae 228 * @{
bogdanm 86:04dd9b1680ae 229 */
bogdanm 86:04dd9b1680ae 230
bogdanm 86:04dd9b1680ae 231 #define IRDA_IT_PE ((uint32_t)0x10000100)
bogdanm 86:04dd9b1680ae 232 #define IRDA_IT_TXE ((uint32_t)0x10000080)
bogdanm 86:04dd9b1680ae 233 #define IRDA_IT_TC ((uint32_t)0x10000040)
bogdanm 86:04dd9b1680ae 234 #define IRDA_IT_RXNE ((uint32_t)0x10000020)
bogdanm 86:04dd9b1680ae 235 #define IRDA_IT_IDLE ((uint32_t)0x10000010)
bogdanm 86:04dd9b1680ae 236
bogdanm 86:04dd9b1680ae 237 #define IRDA_IT_LBD ((uint32_t)0x20000040)
bogdanm 86:04dd9b1680ae 238
bogdanm 86:04dd9b1680ae 239 #define IRDA_IT_CTS ((uint32_t)0x30000400)
bogdanm 86:04dd9b1680ae 240 #define IRDA_IT_ERR ((uint32_t)0x30000001)
bogdanm 86:04dd9b1680ae 241
bogdanm 86:04dd9b1680ae 242 /**
bogdanm 86:04dd9b1680ae 243 * @}
bogdanm 86:04dd9b1680ae 244 */
bogdanm 86:04dd9b1680ae 245
bogdanm 86:04dd9b1680ae 246 /**
bogdanm 86:04dd9b1680ae 247 * @}
bogdanm 86:04dd9b1680ae 248 */
bogdanm 86:04dd9b1680ae 249
bogdanm 86:04dd9b1680ae 250 /* Exported macro ------------------------------------------------------------*/
bogdanm 86:04dd9b1680ae 251
bogdanm 86:04dd9b1680ae 252 /** @brief Reset IRDA handle state
bogdanm 86:04dd9b1680ae 253 * @param __HANDLE__: specifies the USART Handle.
bogdanm 86:04dd9b1680ae 254 * This parameter can be USARTx where x: 1, 2, 3, 4, 5, 6, 7 or 8 to select the USART or
bogdanm 86:04dd9b1680ae 255 * UART peripheral.
bogdanm 86:04dd9b1680ae 256 * @retval None
bogdanm 86:04dd9b1680ae 257 */
bogdanm 86:04dd9b1680ae 258 #define __HAL_IRDA_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_IRDA_STATE_RESET)
bogdanm 86:04dd9b1680ae 259
bogdanm 86:04dd9b1680ae 260 /** @brief Flushs the IRDA DR register
bogdanm 86:04dd9b1680ae 261 * @param __HANDLE__: specifies the USART Handle.
bogdanm 86:04dd9b1680ae 262 * This parameter can be USARTx where x: 1, 2, 3, 4, 5, 6, 7 or 8 to select the USART or
bogdanm 86:04dd9b1680ae 263 * UART peripheral.
bogdanm 86:04dd9b1680ae 264 */
bogdanm 86:04dd9b1680ae 265 #define __HAL_IRDA_FLUSH_DRREGISTER(__HANDLE__) ((__HANDLE__)->Instance->DR)
bogdanm 86:04dd9b1680ae 266
bogdanm 86:04dd9b1680ae 267 /** @brief Checks whether the specified IRDA flag is set or not.
bogdanm 86:04dd9b1680ae 268 * @param __HANDLE__: specifies the USART Handle.
bogdanm 86:04dd9b1680ae 269 * This parameter can be USARTx where x: 1, 2, 3, 4, 5, 6, 7 or 8 to select the USART or
bogdanm 86:04dd9b1680ae 270 * UART peripheral.
bogdanm 86:04dd9b1680ae 271 * @param __FLAG__: specifies the flag to check.
bogdanm 86:04dd9b1680ae 272 * This parameter can be one of the following values:
bogdanm 86:04dd9b1680ae 273 * @arg IRDA_FLAG_TXE: Transmit data register empty flag
bogdanm 86:04dd9b1680ae 274 * @arg IRDA_FLAG_TC: Transmission Complete flag
bogdanm 86:04dd9b1680ae 275 * @arg IRDA_FLAG_RXNE: Receive data register not empty flag
bogdanm 86:04dd9b1680ae 276 * @arg IRDA_FLAG_IDLE: Idle Line detection flag
bogdanm 86:04dd9b1680ae 277 * @arg IRDA_FLAG_ORE: OverRun Error flag
bogdanm 86:04dd9b1680ae 278 * @arg IRDA_FLAG_NE: Noise Error flag
bogdanm 86:04dd9b1680ae 279 * @arg IRDA_FLAG_FE: Framing Error flag
bogdanm 86:04dd9b1680ae 280 * @arg IRDA_FLAG_PE: Parity Error flag
bogdanm 86:04dd9b1680ae 281 * @retval The new state of __FLAG__ (TRUE or FALSE).
bogdanm 86:04dd9b1680ae 282 */
bogdanm 86:04dd9b1680ae 283 #define __HAL_IRDA_GET_FLAG(__HANDLE__, __FLAG__) (((__HANDLE__)->Instance->SR & (__FLAG__)) == (__FLAG__))
bogdanm 86:04dd9b1680ae 284
bogdanm 86:04dd9b1680ae 285 /** @brief Clears the specified IRDA pending flag.
bogdanm 86:04dd9b1680ae 286 * @param __HANDLE__: specifies the USART Handle.
bogdanm 86:04dd9b1680ae 287 * This parameter can be USARTx where x: 1, 2, 3, 4, 5, 6, 7 or 8 to select the USART or
bogdanm 86:04dd9b1680ae 288 * UART peripheral.
bogdanm 86:04dd9b1680ae 289 * @param __FLAG__: specifies the flag to check.
bogdanm 86:04dd9b1680ae 290 * This parameter can be any combination of the following values:
bogdanm 86:04dd9b1680ae 291 * @arg IRDA_FLAG_TC: Transmission Complete flag.
bogdanm 86:04dd9b1680ae 292 * @arg IRDA_FLAG_RXNE: Receive data register not empty flag.
bogdanm 86:04dd9b1680ae 293 *
bogdanm 86:04dd9b1680ae 294 * @note PE (Parity error), FE (Framing error), NE (Noise error), ORE (OverRun
bogdanm 86:04dd9b1680ae 295 * error) and IDLE (Idle line detected) flags are cleared by software
bogdanm 86:04dd9b1680ae 296 * sequence: a read operation to USART_SR register followed by a read
bogdanm 86:04dd9b1680ae 297 * operation to USART_DR register.
bogdanm 86:04dd9b1680ae 298 * @note RXNE flag can be also cleared by a read to the USART_DR register.
bogdanm 86:04dd9b1680ae 299 * @note TC flag can be also cleared by software sequence: a read operation to
bogdanm 86:04dd9b1680ae 300 * USART_SR register followed by a write operation to USART_DR register.
bogdanm 86:04dd9b1680ae 301 * @note TXE flag is cleared only by a write to the USART_DR register.
bogdanm 86:04dd9b1680ae 302 *
bogdanm 86:04dd9b1680ae 303 * @retval None
bogdanm 86:04dd9b1680ae 304 */
bogdanm 86:04dd9b1680ae 305 #define __HAL_IRDA_CLEAR_FLAG(__HANDLE__, __FLAG__) ((__HANDLE__)->Instance->SR = ~(__FLAG__))
bogdanm 86:04dd9b1680ae 306
bogdanm 86:04dd9b1680ae 307 /** @brief Clear the IRDA PE pending flag.
bogdanm 86:04dd9b1680ae 308 * @param __HANDLE__: specifies the USART Handle.
bogdanm 86:04dd9b1680ae 309 * This parameter can be USARTx where x: 1, 2, 3, 4, 5, 6, 7 or 8 to select the USART or
bogdanm 86:04dd9b1680ae 310 * UART peripheral.
bogdanm 86:04dd9b1680ae 311 * @retval None
bogdanm 86:04dd9b1680ae 312 */
bogdanm 86:04dd9b1680ae 313 #define __HAL_IRDA_CLEAR_PEFLAG(__HANDLE__) do{(__HANDLE__)->Instance->SR;\
bogdanm 86:04dd9b1680ae 314 (__HANDLE__)->Instance->DR;}while(0)
bogdanm 86:04dd9b1680ae 315 /** @brief Clear the IRDA FE pending flag.
bogdanm 86:04dd9b1680ae 316 * @param __HANDLE__: specifies the USART Handle.
bogdanm 86:04dd9b1680ae 317 * This parameter can be USARTx where x: 1, 2, 3, 4, 5, 6, 7 or 8 to select the USART or
bogdanm 86:04dd9b1680ae 318 * UART peripheral.
bogdanm 86:04dd9b1680ae 319 * @retval None
bogdanm 86:04dd9b1680ae 320 */
bogdanm 86:04dd9b1680ae 321 #define __HAL_IRDA_CLEAR_FEFLAG(__HANDLE__) __HAL_IRDA_CLEAR_PEFLAG(__HANDLE__)
bogdanm 86:04dd9b1680ae 322
bogdanm 86:04dd9b1680ae 323 /** @brief Clear the IRDA NE pending flag.
bogdanm 86:04dd9b1680ae 324 * @param __HANDLE__: specifies the USART Handle.
bogdanm 86:04dd9b1680ae 325 * This parameter can be USARTx where x: 1, 2, 3, 4, 5, 6, 7 or 8 to select the USART or
bogdanm 86:04dd9b1680ae 326 * UART peripheral.
bogdanm 86:04dd9b1680ae 327 * @retval None
bogdanm 86:04dd9b1680ae 328 */
bogdanm 86:04dd9b1680ae 329 #define __HAL_IRDA_CLEAR_NEFLAG(__HANDLE__) __HAL_IRDA_CLEAR_PEFLAG(__HANDLE__)
bogdanm 86:04dd9b1680ae 330
bogdanm 86:04dd9b1680ae 331 /** @brief Clear the IRDA ORE pending flag.
bogdanm 86:04dd9b1680ae 332 * @param __HANDLE__: specifies the USART Handle.
bogdanm 86:04dd9b1680ae 333 * This parameter can be USARTx where x: 1, 2, 3, 4, 5, 6, 7 or 8 to select the USART or
bogdanm 86:04dd9b1680ae 334 * UART peripheral.
bogdanm 86:04dd9b1680ae 335 * @retval None
bogdanm 86:04dd9b1680ae 336 */
bogdanm 86:04dd9b1680ae 337 #define __HAL_IRDA_CLEAR_OREFLAG(__HANDLE__) __HAL_IRDA_CLEAR_PEFLAG(__HANDLE__)
bogdanm 86:04dd9b1680ae 338
bogdanm 86:04dd9b1680ae 339 /** @brief Clear the IRDA IDLE pending flag.
bogdanm 86:04dd9b1680ae 340 * @param __HANDLE__: specifies the USART Handle.
bogdanm 86:04dd9b1680ae 341 * This parameter can be USARTx where x: 1, 2, 3, 4, 5, 6, 7 or 8 to select the USART or
bogdanm 86:04dd9b1680ae 342 * UART peripheral.
bogdanm 86:04dd9b1680ae 343 * @retval None
bogdanm 86:04dd9b1680ae 344 */
bogdanm 86:04dd9b1680ae 345 #define __HAL_IRDA_CLEAR_IDLEFLAG(__HANDLE__) __HAL_IRDA_CLEAR_PEFLAG(__HANDLE__)
bogdanm 86:04dd9b1680ae 346
bogdanm 86:04dd9b1680ae 347 /** @brief Enables or disables the specified IRDA interrupt.
bogdanm 86:04dd9b1680ae 348 * @param __HANDLE__: specifies the USART Handle.
bogdanm 86:04dd9b1680ae 349 * This parameter can be USARTx where x: 1, 2, 3, 4, 5, 6, 7 or 8 to select the USART or
bogdanm 86:04dd9b1680ae 350 * UART peripheral.
bogdanm 86:04dd9b1680ae 351 * @param __INTERRUPT__: specifies the IRDA interrupt source to check.
bogdanm 86:04dd9b1680ae 352 * This parameter can be one of the following values:
bogdanm 86:04dd9b1680ae 353 * @arg IRDA_IT_TXE: Transmit Data Register empty interrupt
bogdanm 86:04dd9b1680ae 354 * @arg IRDA_IT_TC: Transmission complete interrupt
bogdanm 86:04dd9b1680ae 355 * @arg IRDA_IT_RXNE: Receive Data register not empty interrupt
bogdanm 86:04dd9b1680ae 356 * @arg IRDA_IT_IDLE: Idle line detection interrupt
bogdanm 86:04dd9b1680ae 357 * @arg IRDA_IT_PE: Parity Error interrupt
bogdanm 86:04dd9b1680ae 358 * @arg IRDA_IT_ERR: Error interrupt(Frame error, noise error, overrun error)
bogdanm 86:04dd9b1680ae 359 * @param NewState: new state of the specified IRDA interrupt.
bogdanm 86:04dd9b1680ae 360 * This parameter can be: ENABLE or DISABLE.
bogdanm 86:04dd9b1680ae 361 * @retval None
bogdanm 86:04dd9b1680ae 362 */
bogdanm 86:04dd9b1680ae 363 #define IRDA_IT_MASK ((uint32_t)0x0000FFFF)
bogdanm 86:04dd9b1680ae 364 #define __HAL_IRDA_ENABLE_IT(__HANDLE__, __INTERRUPT__) ((((__INTERRUPT__) >> 28) == 1)? ((__HANDLE__)->Instance->CR1 |= ((__INTERRUPT__) & IRDA_IT_MASK)): \
bogdanm 86:04dd9b1680ae 365 (((__INTERRUPT__) >> 28) == 2)? ((__HANDLE__)->Instance->CR2 |= ((__INTERRUPT__) & IRDA_IT_MASK)): \
bogdanm 86:04dd9b1680ae 366 ((__HANDLE__)->Instance->CR3 |= ((__INTERRUPT__) & IRDA_IT_MASK)))
bogdanm 86:04dd9b1680ae 367 #define __HAL_IRDA_DISABLE_IT(__HANDLE__, __INTERRUPT__) ((((__INTERRUPT__) >> 28) == 1)? ((__HANDLE__)->Instance->CR1 &= ~((__INTERRUPT__) & IRDA_IT_MASK)): \
bogdanm 86:04dd9b1680ae 368 (((__INTERRUPT__) >> 28) == 2)? ((__HANDLE__)->Instance->CR2 &= ~((__INTERRUPT__) & IRDA_IT_MASK)): \
bogdanm 86:04dd9b1680ae 369 ((__HANDLE__)->Instance->CR3 &= ~ ((__INTERRUPT__) & IRDA_IT_MASK)))
bogdanm 86:04dd9b1680ae 370
bogdanm 86:04dd9b1680ae 371 /** @brief Checks whether the specified IRDA interrupt has occurred or not.
bogdanm 86:04dd9b1680ae 372 * @param __HANDLE__: specifies the USART Handle.
bogdanm 86:04dd9b1680ae 373 * This parameter can be USARTx where x: 1, 2, 3, 4, 5, 6, 7 or 8 to select the USART or
bogdanm 86:04dd9b1680ae 374 * UART peripheral.
bogdanm 86:04dd9b1680ae 375 * @param __IT__: specifies the IRDA interrupt source to check.
bogdanm 86:04dd9b1680ae 376 * This parameter can be one of the following values:
bogdanm 86:04dd9b1680ae 377 * @arg IRDA_IT_TXE: Transmit Data Register empty interrupt
bogdanm 86:04dd9b1680ae 378 * @arg IRDA_IT_TC: Transmission complete interrupt
bogdanm 86:04dd9b1680ae 379 * @arg IRDA_IT_RXNE: Receive Data register not empty interrupt
bogdanm 86:04dd9b1680ae 380 * @arg IRDA_IT_IDLE: Idle line detection interrupt
bogdanm 86:04dd9b1680ae 381 * @arg USART_IT_ERR: Error interrupt
bogdanm 86:04dd9b1680ae 382 * @arg IRDA_IT_PE: Parity Error interrupt
bogdanm 86:04dd9b1680ae 383 * @retval The new state of __IT__ (TRUE or FALSE).
bogdanm 86:04dd9b1680ae 384 */
bogdanm 86:04dd9b1680ae 385 #define __HAL_IRDA_GET_IT_SOURCE(__HANDLE__, __IT__) (((((__IT__) >> 28) == 1)? (__HANDLE__)->Instance->CR1:(((((uint32_t)(__IT__)) >> 28) == 2)? \
bogdanm 86:04dd9b1680ae 386 (__HANDLE__)->Instance->CR2 : (__HANDLE__)->Instance->CR3)) & (((uint32_t)(__IT__)) & IRDA_IT_MASK))
bogdanm 86:04dd9b1680ae 387
bogdanm 86:04dd9b1680ae 388
bogdanm 86:04dd9b1680ae 389
bogdanm 86:04dd9b1680ae 390 #define __IRDA_ENABLE(__HANDLE__) ( (__HANDLE__)->Instance->CR1 |= USART_CR1_UE)
bogdanm 86:04dd9b1680ae 391 #define __IRDA_DISABLE(__HANDLE__) ( (__HANDLE__)->Instance->CR1 &= ~USART_CR1_UE)
bogdanm 86:04dd9b1680ae 392
bogdanm 86:04dd9b1680ae 393 #define __DIV(_PCLK_, _BAUD_) (((_PCLK_)*25)/(4*(_BAUD_)))
bogdanm 86:04dd9b1680ae 394 #define __DIVMANT(_PCLK_, _BAUD_) (__DIV((_PCLK_), (_BAUD_))/100)
bogdanm 86:04dd9b1680ae 395 #define __DIVFRAQ(_PCLK_, _BAUD_) (((__DIV((_PCLK_), (_BAUD_)) - (__DIVMANT((_PCLK_), (_BAUD_)) * 100)) * 16 + 50) / 100)
bogdanm 86:04dd9b1680ae 396 #define __IRDA_BRR(_PCLK_, _BAUD_) ((__DIVMANT((_PCLK_), (_BAUD_)) << 4)|(__DIVFRAQ((_PCLK_), (_BAUD_)) & 0x0F))
bogdanm 86:04dd9b1680ae 397
bogdanm 86:04dd9b1680ae 398 #define IS_IRDA_BAUDRATE(BAUDRATE) ((BAUDRATE) < 115201)
bogdanm 86:04dd9b1680ae 399
bogdanm 86:04dd9b1680ae 400
bogdanm 86:04dd9b1680ae 401 /* Exported functions --------------------------------------------------------*/
bogdanm 86:04dd9b1680ae 402 /* Initialization/de-initialization functions **********************************/
bogdanm 86:04dd9b1680ae 403 HAL_StatusTypeDef HAL_IRDA_Init(IRDA_HandleTypeDef *hirda);
bogdanm 86:04dd9b1680ae 404 HAL_StatusTypeDef HAL_IRDA_DeInit(IRDA_HandleTypeDef *hirda);
bogdanm 86:04dd9b1680ae 405 void HAL_IRDA_MspInit(IRDA_HandleTypeDef *hirda);
bogdanm 86:04dd9b1680ae 406 void HAL_IRDA_MspDeInit(IRDA_HandleTypeDef *hirda);
bogdanm 86:04dd9b1680ae 407
bogdanm 86:04dd9b1680ae 408 /* IO operation functions *******************************************************/
bogdanm 86:04dd9b1680ae 409 HAL_StatusTypeDef HAL_IRDA_Transmit(IRDA_HandleTypeDef *hirda, uint8_t *pData, uint16_t Size, uint32_t Timeout);
bogdanm 86:04dd9b1680ae 410 HAL_StatusTypeDef HAL_IRDA_Receive(IRDA_HandleTypeDef *hirda, uint8_t *pData, uint16_t Size, uint32_t Timeout);
bogdanm 86:04dd9b1680ae 411 HAL_StatusTypeDef HAL_IRDA_Transmit_IT(IRDA_HandleTypeDef *hirda, uint8_t *pData, uint16_t Size);
bogdanm 86:04dd9b1680ae 412 HAL_StatusTypeDef HAL_IRDA_Receive_IT(IRDA_HandleTypeDef *hirda, uint8_t *pData, uint16_t Size);
bogdanm 86:04dd9b1680ae 413 HAL_StatusTypeDef HAL_IRDA_Transmit_DMA(IRDA_HandleTypeDef *hirda, uint8_t *pData, uint16_t Size);
bogdanm 86:04dd9b1680ae 414 HAL_StatusTypeDef HAL_IRDA_Receive_DMA(IRDA_HandleTypeDef *hirda, uint8_t *pData, uint16_t Size);
bogdanm 86:04dd9b1680ae 415 HAL_StatusTypeDef HAL_IRDA_DMAPause(IRDA_HandleTypeDef *hirda);
bogdanm 86:04dd9b1680ae 416 HAL_StatusTypeDef HAL_IRDA_DMAResume(IRDA_HandleTypeDef *hirda);
bogdanm 86:04dd9b1680ae 417 HAL_StatusTypeDef HAL_IRDA_DMAStop(IRDA_HandleTypeDef *hirda);
bogdanm 86:04dd9b1680ae 418 void HAL_IRDA_IRQHandler(IRDA_HandleTypeDef *hirda);
bogdanm 86:04dd9b1680ae 419 void HAL_IRDA_TxCpltCallback(IRDA_HandleTypeDef *hirda);
bogdanm 86:04dd9b1680ae 420 void HAL_IRDA_RxCpltCallback(IRDA_HandleTypeDef *hirda);
bogdanm 86:04dd9b1680ae 421 void HAL_IRDA_TxHalfCpltCallback(IRDA_HandleTypeDef *hirda);
bogdanm 86:04dd9b1680ae 422 void HAL_IRDA_RxHalfCpltCallback(IRDA_HandleTypeDef *hirda);
bogdanm 86:04dd9b1680ae 423 void HAL_IRDA_ErrorCallback(IRDA_HandleTypeDef *hirda);
bogdanm 86:04dd9b1680ae 424
bogdanm 86:04dd9b1680ae 425 /* Peripheral State functions **************************************************/
bogdanm 86:04dd9b1680ae 426 HAL_IRDA_StateTypeDef HAL_IRDA_GetState(IRDA_HandleTypeDef *hirda);
bogdanm 86:04dd9b1680ae 427 uint32_t HAL_IRDA_GetError(IRDA_HandleTypeDef *hirda);
bogdanm 86:04dd9b1680ae 428
bogdanm 86:04dd9b1680ae 429 /**
bogdanm 86:04dd9b1680ae 430 * @}
bogdanm 86:04dd9b1680ae 431 */
bogdanm 86:04dd9b1680ae 432
bogdanm 86:04dd9b1680ae 433 /**
bogdanm 86:04dd9b1680ae 434 * @}
bogdanm 86:04dd9b1680ae 435 */
bogdanm 86:04dd9b1680ae 436
bogdanm 86:04dd9b1680ae 437 #ifdef __cplusplus
bogdanm 86:04dd9b1680ae 438 }
bogdanm 86:04dd9b1680ae 439 #endif
bogdanm 86:04dd9b1680ae 440
bogdanm 86:04dd9b1680ae 441 #endif /* __STM32F4xx_HAL_IRDA_H */
bogdanm 86:04dd9b1680ae 442
bogdanm 86:04dd9b1680ae 443 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/