Fork of the official mbed C/C SDK provides the software platform and libraries to build your applications for RenBED.

Dependents:   1-RenBuggyTimed RenBED_RGB RenBED_RGB_PWM RenBED_RGB

Fork of mbed by mbed official

Committer:
elijahorr
Date:
Thu Apr 14 07:28:54 2016 +0000
Revision:
121:672067c3ada4
Parent:
110:165afa46840b
.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Kojto 110:165afa46840b 1 /**
Kojto 110:165afa46840b 2 ******************************************************************************
Kojto 110:165afa46840b 3 * @file stm32f4xx_hal_irda.h
Kojto 110:165afa46840b 4 * @author MCD Application Team
Kojto 110:165afa46840b 5 * @version V1.4.1
Kojto 110:165afa46840b 6 * @date 09-October-2015
Kojto 110:165afa46840b 7 * @brief Header file of IRDA HAL module.
Kojto 110:165afa46840b 8 ******************************************************************************
Kojto 110:165afa46840b 9 * @attention
Kojto 110:165afa46840b 10 *
Kojto 110:165afa46840b 11 * <h2><center>&copy; COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
Kojto 110:165afa46840b 12 *
Kojto 110:165afa46840b 13 * Redistribution and use in source and binary forms, with or without modification,
Kojto 110:165afa46840b 14 * are permitted provided that the following conditions are met:
Kojto 110:165afa46840b 15 * 1. Redistributions of source code must retain the above copyright notice,
Kojto 110:165afa46840b 16 * this list of conditions and the following disclaimer.
Kojto 110:165afa46840b 17 * 2. Redistributions in binary form must reproduce the above copyright notice,
Kojto 110:165afa46840b 18 * this list of conditions and the following disclaimer in the documentation
Kojto 110:165afa46840b 19 * and/or other materials provided with the distribution.
Kojto 110:165afa46840b 20 * 3. Neither the name of STMicroelectronics nor the names of its contributors
Kojto 110:165afa46840b 21 * may be used to endorse or promote products derived from this software
Kojto 110:165afa46840b 22 * without specific prior written permission.
Kojto 110:165afa46840b 23 *
Kojto 110:165afa46840b 24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
Kojto 110:165afa46840b 25 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
Kojto 110:165afa46840b 26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
Kojto 110:165afa46840b 27 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
Kojto 110:165afa46840b 28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
Kojto 110:165afa46840b 29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
Kojto 110:165afa46840b 30 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
Kojto 110:165afa46840b 31 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
Kojto 110:165afa46840b 32 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
Kojto 110:165afa46840b 33 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Kojto 110:165afa46840b 34 *
Kojto 110:165afa46840b 35 ******************************************************************************
Kojto 110:165afa46840b 36 */
Kojto 110:165afa46840b 37
Kojto 110:165afa46840b 38 /* Define to prevent recursive inclusion -------------------------------------*/
Kojto 110:165afa46840b 39 #ifndef __STM32F4xx_HAL_IRDA_H
Kojto 110:165afa46840b 40 #define __STM32F4xx_HAL_IRDA_H
Kojto 110:165afa46840b 41
Kojto 110:165afa46840b 42 #ifdef __cplusplus
Kojto 110:165afa46840b 43 extern "C" {
Kojto 110:165afa46840b 44 #endif
Kojto 110:165afa46840b 45
Kojto 110:165afa46840b 46 /* Includes ------------------------------------------------------------------*/
Kojto 110:165afa46840b 47 #include "stm32f4xx_hal_def.h"
Kojto 110:165afa46840b 48
Kojto 110:165afa46840b 49 /** @addtogroup STM32F4xx_HAL_Driver
Kojto 110:165afa46840b 50 * @{
Kojto 110:165afa46840b 51 */
Kojto 110:165afa46840b 52
Kojto 110:165afa46840b 53 /** @addtogroup IRDA
Kojto 110:165afa46840b 54 * @{
Kojto 110:165afa46840b 55 */
Kojto 110:165afa46840b 56
Kojto 110:165afa46840b 57 /* Exported types ------------------------------------------------------------*/
Kojto 110:165afa46840b 58 /** @defgroup IRDA_Exported_Types IRDA Exported Types
Kojto 110:165afa46840b 59 * @{
Kojto 110:165afa46840b 60 */
Kojto 110:165afa46840b 61 /**
Kojto 110:165afa46840b 62 * @brief IRDA Init Structure definition
Kojto 110:165afa46840b 63 */
Kojto 110:165afa46840b 64 typedef struct
Kojto 110:165afa46840b 65 {
Kojto 110:165afa46840b 66 uint32_t BaudRate; /*!< This member configures the IRDA communication baud rate.
Kojto 110:165afa46840b 67 The baud rate is computed using the following formula:
Kojto 110:165afa46840b 68 - IntegerDivider = ((PCLKx) / (8 * (hirda->Init.BaudRate)))
Kojto 110:165afa46840b 69 - FractionalDivider = ((IntegerDivider - ((uint32_t) IntegerDivider)) * 8) + 0.5 */
Kojto 110:165afa46840b 70
Kojto 110:165afa46840b 71 uint32_t WordLength; /*!< Specifies the number of data bits transmitted or received in a frame.
Kojto 110:165afa46840b 72 This parameter can be a value of @ref IRDA_Word_Length */
Kojto 110:165afa46840b 73
Kojto 110:165afa46840b 74
Kojto 110:165afa46840b 75 uint32_t Parity; /*!< Specifies the parity mode.
Kojto 110:165afa46840b 76 This parameter can be a value of @ref IRDA_Parity
Kojto 110:165afa46840b 77 @note When parity is enabled, the computed parity is inserted
Kojto 110:165afa46840b 78 at the MSB position of the transmitted data (9th bit when
Kojto 110:165afa46840b 79 the word length is set to 9 data bits; 8th bit when the
Kojto 110:165afa46840b 80 word length is set to 8 data bits). */
Kojto 110:165afa46840b 81
Kojto 110:165afa46840b 82 uint32_t Mode; /*!< Specifies wether the Receive or Transmit mode is enabled or disabled.
Kojto 110:165afa46840b 83 This parameter can be a value of @ref IRDA_Mode */
Kojto 110:165afa46840b 84
Kojto 110:165afa46840b 85 uint8_t Prescaler; /*!< Specifies the Prescaler */
Kojto 110:165afa46840b 86
Kojto 110:165afa46840b 87 uint32_t IrDAMode; /*!< Specifies the IrDA mode
Kojto 110:165afa46840b 88 This parameter can be a value of @ref IRDA_Low_Power */
Kojto 110:165afa46840b 89 }IRDA_InitTypeDef;
Kojto 110:165afa46840b 90
Kojto 110:165afa46840b 91 /**
Kojto 110:165afa46840b 92 * @brief HAL State structures definition
Kojto 110:165afa46840b 93 */
Kojto 110:165afa46840b 94 typedef enum
Kojto 110:165afa46840b 95 {
Kojto 110:165afa46840b 96 HAL_IRDA_STATE_RESET = 0x00, /*!< Peripheral is not yet Initialized */
Kojto 110:165afa46840b 97 HAL_IRDA_STATE_READY = 0x01, /*!< Peripheral Initialized and ready for use */
Kojto 110:165afa46840b 98 HAL_IRDA_STATE_BUSY = 0x02, /*!< An internal process is ongoing */
Kojto 110:165afa46840b 99 HAL_IRDA_STATE_BUSY_TX = 0x12, /*!< Data Transmission process is ongoing */
Kojto 110:165afa46840b 100 HAL_IRDA_STATE_BUSY_RX = 0x22, /*!< Data Reception process is ongoing */
Kojto 110:165afa46840b 101 HAL_IRDA_STATE_BUSY_TX_RX = 0x32, /*!< Data Transmission and Reception process is ongoing */
Kojto 110:165afa46840b 102 HAL_IRDA_STATE_TIMEOUT = 0x03, /*!< Timeout state */
Kojto 110:165afa46840b 103 HAL_IRDA_STATE_ERROR = 0x04 /*!< Error */
Kojto 110:165afa46840b 104 }HAL_IRDA_StateTypeDef;
Kojto 110:165afa46840b 105
Kojto 110:165afa46840b 106 /**
Kojto 110:165afa46840b 107 * @brief IRDA handle Structure definition
Kojto 110:165afa46840b 108 */
Kojto 110:165afa46840b 109 typedef struct
Kojto 110:165afa46840b 110 {
Kojto 110:165afa46840b 111 USART_TypeDef *Instance; /* USART registers base address */
Kojto 110:165afa46840b 112
Kojto 110:165afa46840b 113 IRDA_InitTypeDef Init; /* IRDA communication parameters */
Kojto 110:165afa46840b 114
Kojto 110:165afa46840b 115 uint8_t *pTxBuffPtr; /* Pointer to IRDA Tx transfer Buffer */
Kojto 110:165afa46840b 116
Kojto 110:165afa46840b 117 uint16_t TxXferSize; /* IRDA Tx Transfer size */
Kojto 110:165afa46840b 118
Kojto 110:165afa46840b 119 uint16_t TxXferCount; /* IRDA Tx Transfer Counter */
Kojto 110:165afa46840b 120
Kojto 110:165afa46840b 121 uint8_t *pRxBuffPtr; /* Pointer to IRDA Rx transfer Buffer */
Kojto 110:165afa46840b 122
Kojto 110:165afa46840b 123 uint16_t RxXferSize; /* IRDA Rx Transfer size */
Kojto 110:165afa46840b 124
Kojto 110:165afa46840b 125 uint16_t RxXferCount; /* IRDA Rx Transfer Counter */
Kojto 110:165afa46840b 126
Kojto 110:165afa46840b 127 DMA_HandleTypeDef *hdmatx; /* IRDA Tx DMA Handle parameters */
Kojto 110:165afa46840b 128
Kojto 110:165afa46840b 129 DMA_HandleTypeDef *hdmarx; /* IRDA Rx DMA Handle parameters */
Kojto 110:165afa46840b 130
Kojto 110:165afa46840b 131 HAL_LockTypeDef Lock; /* Locking object */
Kojto 110:165afa46840b 132
Kojto 110:165afa46840b 133 __IO HAL_IRDA_StateTypeDef State; /* IRDA communication state */
Kojto 110:165afa46840b 134
Kojto 110:165afa46840b 135 __IO uint32_t ErrorCode; /* IRDA Error code */
Kojto 110:165afa46840b 136
Kojto 110:165afa46840b 137 }IRDA_HandleTypeDef;
Kojto 110:165afa46840b 138 /**
Kojto 110:165afa46840b 139 * @}
Kojto 110:165afa46840b 140 */
Kojto 110:165afa46840b 141
Kojto 110:165afa46840b 142 /* Exported constants --------------------------------------------------------*/
Kojto 110:165afa46840b 143 /** @defgroup IRDA_Exported_Constants IRDA Exported constants
Kojto 110:165afa46840b 144 * @{
Kojto 110:165afa46840b 145 */
Kojto 110:165afa46840b 146 /** @defgroup IRDA_Error_Code IRDA Error Code
Kojto 110:165afa46840b 147 * @brief IRDA Error Code
Kojto 110:165afa46840b 148 * @{
Kojto 110:165afa46840b 149 */
Kojto 110:165afa46840b 150 #define HAL_IRDA_ERROR_NONE ((uint32_t)0x00000000) /*!< No error */
Kojto 110:165afa46840b 151 #define HAL_IRDA_ERROR_PE ((uint32_t)0x00000001) /*!< Parity error */
Kojto 110:165afa46840b 152 #define HAL_IRDA_ERROR_NE ((uint32_t)0x00000002) /*!< Noise error */
Kojto 110:165afa46840b 153 #define HAL_IRDA_ERROR_FE ((uint32_t)0x00000004) /*!< Frame error */
Kojto 110:165afa46840b 154 #define HAL_IRDA_ERROR_ORE ((uint32_t)0x00000008) /*!< Overrun error */
Kojto 110:165afa46840b 155 #define HAL_IRDA_ERROR_DMA ((uint32_t)0x00000010) /*!< DMA transfer error */
Kojto 110:165afa46840b 156 /**
Kojto 110:165afa46840b 157 * @}
Kojto 110:165afa46840b 158 */
Kojto 110:165afa46840b 159
Kojto 110:165afa46840b 160 /** @defgroup IRDA_Word_Length IRDA Word Length
Kojto 110:165afa46840b 161 * @{
Kojto 110:165afa46840b 162 */
Kojto 110:165afa46840b 163 #define IRDA_WORDLENGTH_8B ((uint32_t)0x00000000)
Kojto 110:165afa46840b 164 #define IRDA_WORDLENGTH_9B ((uint32_t)USART_CR1_M)
Kojto 110:165afa46840b 165 /**
Kojto 110:165afa46840b 166 * @}
Kojto 110:165afa46840b 167 */
Kojto 110:165afa46840b 168
Kojto 110:165afa46840b 169 /** @defgroup IRDA_Parity IRDA Parity
Kojto 110:165afa46840b 170 * @{
Kojto 110:165afa46840b 171 */
Kojto 110:165afa46840b 172 #define IRDA_PARITY_NONE ((uint32_t)0x00000000)
Kojto 110:165afa46840b 173 #define IRDA_PARITY_EVEN ((uint32_t)USART_CR1_PCE)
Kojto 110:165afa46840b 174 #define IRDA_PARITY_ODD ((uint32_t)(USART_CR1_PCE | USART_CR1_PS))
Kojto 110:165afa46840b 175 /**
Kojto 110:165afa46840b 176 * @}
Kojto 110:165afa46840b 177 */
Kojto 110:165afa46840b 178
Kojto 110:165afa46840b 179 /** @defgroup IRDA_Mode IRDA Transfer Mode
Kojto 110:165afa46840b 180 * @{
Kojto 110:165afa46840b 181 */
Kojto 110:165afa46840b 182 #define IRDA_MODE_RX ((uint32_t)USART_CR1_RE)
Kojto 110:165afa46840b 183 #define IRDA_MODE_TX ((uint32_t)USART_CR1_TE)
Kojto 110:165afa46840b 184 #define IRDA_MODE_TX_RX ((uint32_t)(USART_CR1_TE |USART_CR1_RE))
Kojto 110:165afa46840b 185 /**
Kojto 110:165afa46840b 186 * @}
Kojto 110:165afa46840b 187 */
Kojto 110:165afa46840b 188
Kojto 110:165afa46840b 189 /** @defgroup IRDA_Low_Power IRDA Low Power
Kojto 110:165afa46840b 190 * @{
Kojto 110:165afa46840b 191 */
Kojto 110:165afa46840b 192 #define IRDA_POWERMODE_LOWPOWER ((uint32_t)USART_CR3_IRLP)
Kojto 110:165afa46840b 193 #define IRDA_POWERMODE_NORMAL ((uint32_t)0x00000000)
Kojto 110:165afa46840b 194 /**
Kojto 110:165afa46840b 195 * @}
Kojto 110:165afa46840b 196 */
Kojto 110:165afa46840b 197
Kojto 110:165afa46840b 198 /** @defgroup IRDA_Flags IRDA Flags
Kojto 110:165afa46840b 199 * Elements values convention: 0xXXXX
Kojto 110:165afa46840b 200 * - 0xXXXX : Flag mask in the SR register
Kojto 110:165afa46840b 201 * @{
Kojto 110:165afa46840b 202 */
Kojto 110:165afa46840b 203 #define IRDA_FLAG_TXE ((uint32_t)0x00000080)
Kojto 110:165afa46840b 204 #define IRDA_FLAG_TC ((uint32_t)0x00000040)
Kojto 110:165afa46840b 205 #define IRDA_FLAG_RXNE ((uint32_t)0x00000020)
Kojto 110:165afa46840b 206 #define IRDA_FLAG_IDLE ((uint32_t)0x00000010)
Kojto 110:165afa46840b 207 #define IRDA_FLAG_ORE ((uint32_t)0x00000008)
Kojto 110:165afa46840b 208 #define IRDA_FLAG_NE ((uint32_t)0x00000004)
Kojto 110:165afa46840b 209 #define IRDA_FLAG_FE ((uint32_t)0x00000002)
Kojto 110:165afa46840b 210 #define IRDA_FLAG_PE ((uint32_t)0x00000001)
Kojto 110:165afa46840b 211 /**
Kojto 110:165afa46840b 212 * @}
Kojto 110:165afa46840b 213 */
Kojto 110:165afa46840b 214
Kojto 110:165afa46840b 215 /** @defgroup IRDA_Interrupt_definition IRDA Interrupt Definitions
Kojto 110:165afa46840b 216 * Elements values convention: 0xY000XXXX
Kojto 110:165afa46840b 217 * - XXXX : Interrupt mask in the XX register
Kojto 110:165afa46840b 218 * - Y : Interrupt source register (2bits)
Kojto 110:165afa46840b 219 * - 01: CR1 register
Kojto 110:165afa46840b 220 * - 10: CR2 register
Kojto 110:165afa46840b 221 * - 11: CR3 register
Kojto 110:165afa46840b 222 * @{
Kojto 110:165afa46840b 223 */
Kojto 110:165afa46840b 224 #define IRDA_IT_PE ((uint32_t)(IRDA_CR1_REG_INDEX << 28 | USART_CR1_PEIE))
Kojto 110:165afa46840b 225 #define IRDA_IT_TXE ((uint32_t)(IRDA_CR1_REG_INDEX << 28 | USART_CR1_TXEIE))
Kojto 110:165afa46840b 226 #define IRDA_IT_TC ((uint32_t)(IRDA_CR1_REG_INDEX << 28 | USART_CR1_TCIE))
Kojto 110:165afa46840b 227 #define IRDA_IT_RXNE ((uint32_t)(IRDA_CR1_REG_INDEX << 28 | USART_CR1_RXNEIE))
Kojto 110:165afa46840b 228 #define IRDA_IT_IDLE ((uint32_t)(IRDA_CR1_REG_INDEX << 28 | USART_CR1_IDLEIE))
Kojto 110:165afa46840b 229
Kojto 110:165afa46840b 230 #define IRDA_IT_LBD ((uint32_t)(IRDA_CR2_REG_INDEX << 28 | USART_CR2_LBDIE))
Kojto 110:165afa46840b 231
Kojto 110:165afa46840b 232 #define IRDA_IT_CTS ((uint32_t)(IRDA_CR3_REG_INDEX << 28 | USART_CR3_CTSIE))
Kojto 110:165afa46840b 233 #define IRDA_IT_ERR ((uint32_t)(IRDA_CR3_REG_INDEX << 28 | USART_CR3_EIE))
Kojto 110:165afa46840b 234 /**
Kojto 110:165afa46840b 235 * @}
Kojto 110:165afa46840b 236 */
Kojto 110:165afa46840b 237
Kojto 110:165afa46840b 238 /**
Kojto 110:165afa46840b 239 * @}
Kojto 110:165afa46840b 240 */
Kojto 110:165afa46840b 241
Kojto 110:165afa46840b 242 /* Exported macro ------------------------------------------------------------*/
Kojto 110:165afa46840b 243 /** @defgroup IRDA_Exported_Macros IRDA Exported Macros
Kojto 110:165afa46840b 244 * @{
Kojto 110:165afa46840b 245 */
Kojto 110:165afa46840b 246
Kojto 110:165afa46840b 247 /** @brief Reset IRDA handle state
Kojto 110:165afa46840b 248 * @param __HANDLE__: specifies the USART Handle.
Kojto 110:165afa46840b 249 * This parameter can be USARTx where x: 1, 2, 3, 4, 5, 6, 7 or 8 to select the USART or
Kojto 110:165afa46840b 250 * UART peripheral.
Kojto 110:165afa46840b 251 * @retval None
Kojto 110:165afa46840b 252 */
Kojto 110:165afa46840b 253 #define __HAL_IRDA_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_IRDA_STATE_RESET)
Kojto 110:165afa46840b 254
Kojto 110:165afa46840b 255 /** @brief Flushs the IRDA DR register
Kojto 110:165afa46840b 256 * @param __HANDLE__: specifies the USART Handle.
Kojto 110:165afa46840b 257 * This parameter can be USARTx where x: 1, 2, 3, 4, 5, 6, 7 or 8 to select the USART or
Kojto 110:165afa46840b 258 * UART peripheral.
Kojto 110:165afa46840b 259 */
Kojto 110:165afa46840b 260 #define __HAL_IRDA_FLUSH_DRREGISTER(__HANDLE__) ((__HANDLE__)->Instance->DR)
Kojto 110:165afa46840b 261
Kojto 110:165afa46840b 262 /** @brief Checks whether the specified IRDA flag is set or not.
Kojto 110:165afa46840b 263 * @param __HANDLE__: specifies the USART Handle.
Kojto 110:165afa46840b 264 * This parameter can be USARTx where x: 1, 2, 3, 4, 5, 6, 7 or 8 to select the USART or
Kojto 110:165afa46840b 265 * UART peripheral.
Kojto 110:165afa46840b 266 * @param __FLAG__: specifies the flag to check.
Kojto 110:165afa46840b 267 * This parameter can be one of the following values:
Kojto 110:165afa46840b 268 * @arg IRDA_FLAG_TXE: Transmit data register empty flag
Kojto 110:165afa46840b 269 * @arg IRDA_FLAG_TC: Transmission Complete flag
Kojto 110:165afa46840b 270 * @arg IRDA_FLAG_RXNE: Receive data register not empty flag
Kojto 110:165afa46840b 271 * @arg IRDA_FLAG_IDLE: Idle Line detection flag
Kojto 110:165afa46840b 272 * @arg IRDA_FLAG_ORE: OverRun Error flag
Kojto 110:165afa46840b 273 * @arg IRDA_FLAG_NE: Noise Error flag
Kojto 110:165afa46840b 274 * @arg IRDA_FLAG_FE: Framing Error flag
Kojto 110:165afa46840b 275 * @arg IRDA_FLAG_PE: Parity Error flag
Kojto 110:165afa46840b 276 * @retval The new state of __FLAG__ (TRUE or FALSE).
Kojto 110:165afa46840b 277 */
Kojto 110:165afa46840b 278 #define __HAL_IRDA_GET_FLAG(__HANDLE__, __FLAG__) (((__HANDLE__)->Instance->SR & (__FLAG__)) == (__FLAG__))
Kojto 110:165afa46840b 279
Kojto 110:165afa46840b 280 /** @brief Clears the specified IRDA pending flag.
Kojto 110:165afa46840b 281 * @param __HANDLE__: specifies the USART Handle.
Kojto 110:165afa46840b 282 * This parameter can be USARTx where x: 1, 2, 3, 4, 5, 6, 7 or 8 to select the USART or
Kojto 110:165afa46840b 283 * UART peripheral.
Kojto 110:165afa46840b 284 * @param __FLAG__: specifies the flag to check.
Kojto 110:165afa46840b 285 * This parameter can be any combination of the following values:
Kojto 110:165afa46840b 286 * @arg IRDA_FLAG_TC: Transmission Complete flag.
Kojto 110:165afa46840b 287 * @arg IRDA_FLAG_RXNE: Receive data register not empty flag.
Kojto 110:165afa46840b 288 *
Kojto 110:165afa46840b 289 * @note PE (Parity error), FE (Framing error), NE (Noise error), ORE (OverRun
Kojto 110:165afa46840b 290 * error) and IDLE (Idle line detected) flags are cleared by software
Kojto 110:165afa46840b 291 * sequence: a read operation to USART_SR register followed by a read
Kojto 110:165afa46840b 292 * operation to USART_DR register.
Kojto 110:165afa46840b 293 * @note RXNE flag can be also cleared by a read to the USART_DR register.
Kojto 110:165afa46840b 294 * @note TC flag can be also cleared by software sequence: a read operation to
Kojto 110:165afa46840b 295 * USART_SR register followed by a write operation to USART_DR register.
Kojto 110:165afa46840b 296 * @note TXE flag is cleared only by a write to the USART_DR register.
Kojto 110:165afa46840b 297 *
Kojto 110:165afa46840b 298 * @retval None
Kojto 110:165afa46840b 299 */
Kojto 110:165afa46840b 300 #define __HAL_IRDA_CLEAR_FLAG(__HANDLE__, __FLAG__) ((__HANDLE__)->Instance->SR = ~(__FLAG__))
Kojto 110:165afa46840b 301
Kojto 110:165afa46840b 302 /** @brief Clear the IRDA PE pending flag.
Kojto 110:165afa46840b 303 * @param __HANDLE__: specifies the USART Handle.
Kojto 110:165afa46840b 304 * This parameter can be USARTx where x: 1, 2, 3, 4, 5, 6, 7 or 8 to select the USART or
Kojto 110:165afa46840b 305 * UART peripheral.
Kojto 110:165afa46840b 306 * @retval None
Kojto 110:165afa46840b 307 */
Kojto 110:165afa46840b 308 #define __HAL_IRDA_CLEAR_PEFLAG(__HANDLE__) \
Kojto 110:165afa46840b 309 do{ \
Kojto 110:165afa46840b 310 __IO uint32_t tmpreg; \
Kojto 110:165afa46840b 311 tmpreg = (__HANDLE__)->Instance->SR; \
Kojto 110:165afa46840b 312 UNUSED(tmpreg); \
Kojto 110:165afa46840b 313 } while(0)
Kojto 110:165afa46840b 314
Kojto 110:165afa46840b 315 /** @brief Clear the IRDA FE pending flag.
Kojto 110:165afa46840b 316 * @param __HANDLE__: specifies the USART Handle.
Kojto 110:165afa46840b 317 * This parameter can be USARTx where x: 1, 2, 3, 4, 5, 6, 7 or 8 to select the USART or
Kojto 110:165afa46840b 318 * UART peripheral.
Kojto 110:165afa46840b 319 * @retval None
Kojto 110:165afa46840b 320 */
Kojto 110:165afa46840b 321 #define __HAL_IRDA_CLEAR_FEFLAG(__HANDLE__) __HAL_IRDA_CLEAR_PEFLAG(__HANDLE__)
Kojto 110:165afa46840b 322
Kojto 110:165afa46840b 323 /** @brief Clear the IRDA NE pending flag.
Kojto 110:165afa46840b 324 * @param __HANDLE__: specifies the USART Handle.
Kojto 110:165afa46840b 325 * This parameter can be USARTx where x: 1, 2, 3, 4, 5, 6, 7 or 8 to select the USART or
Kojto 110:165afa46840b 326 * UART peripheral.
Kojto 110:165afa46840b 327 * @retval None
Kojto 110:165afa46840b 328 */
Kojto 110:165afa46840b 329 #define __HAL_IRDA_CLEAR_NEFLAG(__HANDLE__) __HAL_IRDA_CLEAR_PEFLAG(__HANDLE__)
Kojto 110:165afa46840b 330
Kojto 110:165afa46840b 331 /** @brief Clear the IRDA ORE pending flag.
Kojto 110:165afa46840b 332 * @param __HANDLE__: specifies the USART Handle.
Kojto 110:165afa46840b 333 * This parameter can be USARTx where x: 1, 2, 3, 4, 5, 6, 7 or 8 to select the USART or
Kojto 110:165afa46840b 334 * UART peripheral.
Kojto 110:165afa46840b 335 * @retval None
Kojto 110:165afa46840b 336 */
Kojto 110:165afa46840b 337 #define __HAL_IRDA_CLEAR_OREFLAG(__HANDLE__) __HAL_IRDA_CLEAR_PEFLAG(__HANDLE__)
Kojto 110:165afa46840b 338
Kojto 110:165afa46840b 339 /** @brief Clear the IRDA IDLE pending flag.
Kojto 110:165afa46840b 340 * @param __HANDLE__: specifies the USART Handle.
Kojto 110:165afa46840b 341 * This parameter can be USARTx where x: 1, 2, 3, 4, 5, 6, 7 or 8 to select the USART or
Kojto 110:165afa46840b 342 * UART peripheral.
Kojto 110:165afa46840b 343 * @retval None
Kojto 110:165afa46840b 344 */
Kojto 110:165afa46840b 345 #define __HAL_IRDA_CLEAR_IDLEFLAG(__HANDLE__) __HAL_IRDA_CLEAR_PEFLAG(__HANDLE__)
Kojto 110:165afa46840b 346
Kojto 110:165afa46840b 347 /** @brief Enables or disables the specified IRDA interrupt.
Kojto 110:165afa46840b 348 * @param __HANDLE__: specifies the USART Handle.
Kojto 110:165afa46840b 349 * This parameter can be USARTx where x: 1, 2, 3, 4, 5, 6, 7 or 8 to select the USART or
Kojto 110:165afa46840b 350 * UART peripheral.
Kojto 110:165afa46840b 351 * @param __INTERRUPT__: specifies the IRDA interrupt source to check.
Kojto 110:165afa46840b 352 * This parameter can be one of the following values:
Kojto 110:165afa46840b 353 * @arg IRDA_IT_TXE: Transmit Data Register empty interrupt
Kojto 110:165afa46840b 354 * @arg IRDA_IT_TC: Transmission complete interrupt
Kojto 110:165afa46840b 355 * @arg IRDA_IT_RXNE: Receive Data register not empty interrupt
Kojto 110:165afa46840b 356 * @arg IRDA_IT_IDLE: Idle line detection interrupt
Kojto 110:165afa46840b 357 * @arg IRDA_IT_PE: Parity Error interrupt
Kojto 110:165afa46840b 358 * @arg IRDA_IT_ERR: Error interrupt(Frame error, noise error, overrun error)
Kojto 110:165afa46840b 359 * @retval None
Kojto 110:165afa46840b 360 */
Kojto 110:165afa46840b 361 #define __HAL_IRDA_ENABLE_IT(__HANDLE__, __INTERRUPT__) ((((__INTERRUPT__) >> 28) == 1)? ((__HANDLE__)->Instance->CR1 |= ((__INTERRUPT__) & IRDA_IT_MASK)): \
Kojto 110:165afa46840b 362 (((__INTERRUPT__) >> 28) == 2)? ((__HANDLE__)->Instance->CR2 |= ((__INTERRUPT__) & IRDA_IT_MASK)): \
Kojto 110:165afa46840b 363 ((__HANDLE__)->Instance->CR3 |= ((__INTERRUPT__) & IRDA_IT_MASK)))
Kojto 110:165afa46840b 364 #define __HAL_IRDA_DISABLE_IT(__HANDLE__, __INTERRUPT__) ((((__INTERRUPT__) >> 28) == 1)? ((__HANDLE__)->Instance->CR1 &= ~((__INTERRUPT__) & IRDA_IT_MASK)): \
Kojto 110:165afa46840b 365 (((__INTERRUPT__) >> 28) == 2)? ((__HANDLE__)->Instance->CR2 &= ~((__INTERRUPT__) & IRDA_IT_MASK)): \
Kojto 110:165afa46840b 366 ((__HANDLE__)->Instance->CR3 &= ~ ((__INTERRUPT__) & IRDA_IT_MASK)))
Kojto 110:165afa46840b 367
Kojto 110:165afa46840b 368 /** @brief Checks whether the specified IRDA interrupt has occurred or not.
Kojto 110:165afa46840b 369 * @param __HANDLE__: specifies the USART Handle.
Kojto 110:165afa46840b 370 * This parameter can be USARTx where x: 1, 2, 3, 4, 5, 6, 7 or 8 to select the USART or
Kojto 110:165afa46840b 371 * UART peripheral.
Kojto 110:165afa46840b 372 * @param __IT__: specifies the IRDA interrupt source to check.
Kojto 110:165afa46840b 373 * This parameter can be one of the following values:
Kojto 110:165afa46840b 374 * @arg IRDA_IT_TXE: Transmit Data Register empty interrupt
Kojto 110:165afa46840b 375 * @arg IRDA_IT_TC: Transmission complete interrupt
Kojto 110:165afa46840b 376 * @arg IRDA_IT_RXNE: Receive Data register not empty interrupt
Kojto 110:165afa46840b 377 * @arg IRDA_IT_IDLE: Idle line detection interrupt
Kojto 110:165afa46840b 378 * @arg USART_IT_ERR: Error interrupt
Kojto 110:165afa46840b 379 * @arg IRDA_IT_PE: Parity Error interrupt
Kojto 110:165afa46840b 380 * @retval The new state of __IT__ (TRUE or FALSE).
Kojto 110:165afa46840b 381 */
Kojto 110:165afa46840b 382 #define __HAL_IRDA_GET_IT_SOURCE(__HANDLE__, __IT__) (((((__IT__) >> 28) == 1)? (__HANDLE__)->Instance->CR1:(((((uint32_t)(__IT__)) >> 28) == 2)? \
Kojto 110:165afa46840b 383 (__HANDLE__)->Instance->CR2 : (__HANDLE__)->Instance->CR3)) & (((uint32_t)(__IT__)) & IRDA_IT_MASK))
Kojto 110:165afa46840b 384
Kojto 110:165afa46840b 385 /** @brief Macro to enable the IRDA's one bit sample method
Kojto 110:165afa46840b 386 * @param __HANDLE__: specifies the IRDA Handle.
Kojto 110:165afa46840b 387 * @retval None
Kojto 110:165afa46840b 388 */
Kojto 110:165afa46840b 389 #define __HAL_IRDA_ONE_BIT_SAMPLE_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->CR3|= USART_CR3_ONEBIT)
Kojto 110:165afa46840b 390
Kojto 110:165afa46840b 391 /** @brief Macro to disable the IRDA's one bit sample method
Kojto 110:165afa46840b 392 * @param __HANDLE__: specifies the IRDA Handle.
Kojto 110:165afa46840b 393 * @retval None
Kojto 110:165afa46840b 394 */
Kojto 110:165afa46840b 395 #define __HAL_IRDA_ONE_BIT_SAMPLE_DISABLE(__HANDLE__) ((__HANDLE__)->Instance->CR3 &= (uint16_t)~((uint16_t)USART_CR3_ONEBIT))
Kojto 110:165afa46840b 396
Kojto 110:165afa46840b 397 /** @brief Enable UART/USART associated to IRDA Handle
Kojto 110:165afa46840b 398 * @param __HANDLE__: specifies the IRDA Handle.
Kojto 110:165afa46840b 399 * IRDA Handle selects the USARTx or UARTy peripheral
Kojto 110:165afa46840b 400 * (USART,UART availability and x,y values depending on device).
Kojto 110:165afa46840b 401 * @retval None
Kojto 110:165afa46840b 402 */
Kojto 110:165afa46840b 403 #define __HAL_IRDA_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->CR1 |= USART_CR1_UE)
Kojto 110:165afa46840b 404
Kojto 110:165afa46840b 405 /** @brief Disable UART/USART associated to IRDA Handle
Kojto 110:165afa46840b 406 * @param __HANDLE__: specifies the IRDA Handle.
Kojto 110:165afa46840b 407 * IRDA Handle selects the USARTx or UARTy peripheral
Kojto 110:165afa46840b 408 * (USART,UART availability and x,y values depending on device).
Kojto 110:165afa46840b 409 * @retval None
Kojto 110:165afa46840b 410 */
Kojto 110:165afa46840b 411 #define __HAL_IRDA_DISABLE(__HANDLE__) ((__HANDLE__)->Instance->CR1 &= ~USART_CR1_UE)
Kojto 110:165afa46840b 412
Kojto 110:165afa46840b 413 /**
Kojto 110:165afa46840b 414 * @}
Kojto 110:165afa46840b 415 */
Kojto 110:165afa46840b 416
Kojto 110:165afa46840b 417 /* Exported functions --------------------------------------------------------*/
Kojto 110:165afa46840b 418 /** @addtogroup IRDA_Exported_Functions
Kojto 110:165afa46840b 419 * @{
Kojto 110:165afa46840b 420 */
Kojto 110:165afa46840b 421
Kojto 110:165afa46840b 422 /** @addtogroup IRDA_Exported_Functions_Group1
Kojto 110:165afa46840b 423 * @{
Kojto 110:165afa46840b 424 */
Kojto 110:165afa46840b 425 /* Initialization/de-initialization functions **********************************/
Kojto 110:165afa46840b 426 HAL_StatusTypeDef HAL_IRDA_Init(IRDA_HandleTypeDef *hirda);
Kojto 110:165afa46840b 427 HAL_StatusTypeDef HAL_IRDA_DeInit(IRDA_HandleTypeDef *hirda);
Kojto 110:165afa46840b 428 void HAL_IRDA_MspInit(IRDA_HandleTypeDef *hirda);
Kojto 110:165afa46840b 429 void HAL_IRDA_MspDeInit(IRDA_HandleTypeDef *hirda);
Kojto 110:165afa46840b 430 /**
Kojto 110:165afa46840b 431 * @}
Kojto 110:165afa46840b 432 */
Kojto 110:165afa46840b 433
Kojto 110:165afa46840b 434 /** @addtogroup IRDA_Exported_Functions_Group2
Kojto 110:165afa46840b 435 * @{
Kojto 110:165afa46840b 436 */
Kojto 110:165afa46840b 437 /* IO operation functions *******************************************************/
Kojto 110:165afa46840b 438 HAL_StatusTypeDef HAL_IRDA_Transmit(IRDA_HandleTypeDef *hirda, uint8_t *pData, uint16_t Size, uint32_t Timeout);
Kojto 110:165afa46840b 439 HAL_StatusTypeDef HAL_IRDA_Receive(IRDA_HandleTypeDef *hirda, uint8_t *pData, uint16_t Size, uint32_t Timeout);
Kojto 110:165afa46840b 440 HAL_StatusTypeDef HAL_IRDA_Transmit_IT(IRDA_HandleTypeDef *hirda, uint8_t *pData, uint16_t Size);
Kojto 110:165afa46840b 441 HAL_StatusTypeDef HAL_IRDA_Receive_IT(IRDA_HandleTypeDef *hirda, uint8_t *pData, uint16_t Size);
Kojto 110:165afa46840b 442 HAL_StatusTypeDef HAL_IRDA_Transmit_DMA(IRDA_HandleTypeDef *hirda, uint8_t *pData, uint16_t Size);
Kojto 110:165afa46840b 443 HAL_StatusTypeDef HAL_IRDA_Receive_DMA(IRDA_HandleTypeDef *hirda, uint8_t *pData, uint16_t Size);
Kojto 110:165afa46840b 444 HAL_StatusTypeDef HAL_IRDA_DMAPause(IRDA_HandleTypeDef *hirda);
Kojto 110:165afa46840b 445 HAL_StatusTypeDef HAL_IRDA_DMAResume(IRDA_HandleTypeDef *hirda);
Kojto 110:165afa46840b 446 HAL_StatusTypeDef HAL_IRDA_DMAStop(IRDA_HandleTypeDef *hirda);
Kojto 110:165afa46840b 447 void HAL_IRDA_IRQHandler(IRDA_HandleTypeDef *hirda);
Kojto 110:165afa46840b 448 void HAL_IRDA_TxCpltCallback(IRDA_HandleTypeDef *hirda);
Kojto 110:165afa46840b 449 void HAL_IRDA_RxCpltCallback(IRDA_HandleTypeDef *hirda);
Kojto 110:165afa46840b 450 void HAL_IRDA_TxHalfCpltCallback(IRDA_HandleTypeDef *hirda);
Kojto 110:165afa46840b 451 void HAL_IRDA_RxHalfCpltCallback(IRDA_HandleTypeDef *hirda);
Kojto 110:165afa46840b 452 void HAL_IRDA_ErrorCallback(IRDA_HandleTypeDef *hirda);
Kojto 110:165afa46840b 453 /**
Kojto 110:165afa46840b 454 * @}
Kojto 110:165afa46840b 455 */
Kojto 110:165afa46840b 456
Kojto 110:165afa46840b 457 /** @addtogroup IRDA_Exported_Functions_Group3
Kojto 110:165afa46840b 458 * @{
Kojto 110:165afa46840b 459 */
Kojto 110:165afa46840b 460 /* Peripheral State functions **************************************************/
Kojto 110:165afa46840b 461 HAL_IRDA_StateTypeDef HAL_IRDA_GetState(IRDA_HandleTypeDef *hirda);
Kojto 110:165afa46840b 462 uint32_t HAL_IRDA_GetError(IRDA_HandleTypeDef *hirda);
Kojto 110:165afa46840b 463 /**
Kojto 110:165afa46840b 464 * @}
Kojto 110:165afa46840b 465 */
Kojto 110:165afa46840b 466
Kojto 110:165afa46840b 467 /**
Kojto 110:165afa46840b 468 * @}
Kojto 110:165afa46840b 469 */
Kojto 110:165afa46840b 470
Kojto 110:165afa46840b 471 /* Private types -------------------------------------------------------------*/
Kojto 110:165afa46840b 472 /* Private variables ---------------------------------------------------------*/
Kojto 110:165afa46840b 473 /* Private constants ---------------------------------------------------------*/
Kojto 110:165afa46840b 474 /** @defgroup IRDA_Private_Constants IRDA Private Constants
Kojto 110:165afa46840b 475 * @{
Kojto 110:165afa46840b 476 */
Kojto 110:165afa46840b 477
Kojto 110:165afa46840b 478 /** @brief IRDA interruptions flag mask
Kojto 110:165afa46840b 479 *
Kojto 110:165afa46840b 480 */
Kojto 110:165afa46840b 481 #define IRDA_IT_MASK ((uint32_t) USART_CR1_PEIE | USART_CR1_TXEIE | USART_CR1_TCIE | USART_CR1_RXNEIE | \
Kojto 110:165afa46840b 482 USART_CR1_IDLEIE | USART_CR2_LBDIE | USART_CR3_CTSIE | USART_CR3_EIE )
Kojto 110:165afa46840b 483
Kojto 110:165afa46840b 484
Kojto 110:165afa46840b 485 #define IRDA_CR1_REG_INDEX 1
Kojto 110:165afa46840b 486 #define IRDA_CR2_REG_INDEX 2
Kojto 110:165afa46840b 487 #define IRDA_CR3_REG_INDEX 3
Kojto 110:165afa46840b 488 /**
Kojto 110:165afa46840b 489 * @}
Kojto 110:165afa46840b 490 */
Kojto 110:165afa46840b 491
Kojto 110:165afa46840b 492 /* Private macros --------------------------------------------------------*/
Kojto 110:165afa46840b 493 /** @defgroup IRDA_Private_Macros IRDA Private Macros
Kojto 110:165afa46840b 494 * @{
Kojto 110:165afa46840b 495 */
Kojto 110:165afa46840b 496 #define IS_IRDA_WORD_LENGTH(LENGTH) (((LENGTH) == IRDA_WORDLENGTH_8B) || \
Kojto 110:165afa46840b 497 ((LENGTH) == IRDA_WORDLENGTH_9B))
Kojto 110:165afa46840b 498 #define IS_IRDA_PARITY(PARITY) (((PARITY) == IRDA_PARITY_NONE) || \
Kojto 110:165afa46840b 499 ((PARITY) == IRDA_PARITY_EVEN) || \
Kojto 110:165afa46840b 500 ((PARITY) == IRDA_PARITY_ODD))
Kojto 110:165afa46840b 501 #define IS_IRDA_MODE(MODE) ((((MODE) & (uint32_t)0x0000FFF3) == 0x00) && ((MODE) != (uint32_t)0x000000))
Kojto 110:165afa46840b 502 #define IS_IRDA_POWERMODE(MODE) (((MODE) == IRDA_POWERMODE_LOWPOWER) || \
Kojto 110:165afa46840b 503 ((MODE) == IRDA_POWERMODE_NORMAL))
Kojto 110:165afa46840b 504 #define IS_IRDA_BAUDRATE(BAUDRATE) ((BAUDRATE) < 115201)
Kojto 110:165afa46840b 505
Kojto 110:165afa46840b 506 #define IRDA_DIV(_PCLK_, _BAUD_) (((_PCLK_)*25)/(4*(_BAUD_)))
Kojto 110:165afa46840b 507 #define IRDA_DIVMANT(_PCLK_, _BAUD_) (IRDA_DIV((_PCLK_), (_BAUD_))/100)
Kojto 110:165afa46840b 508 #define IRDA_DIVFRAQ(_PCLK_, _BAUD_) (((IRDA_DIV((_PCLK_), (_BAUD_)) - (IRDA_DIVMANT((_PCLK_), (_BAUD_)) * 100)) * 16 + 50) / 100)
Kojto 110:165afa46840b 509 #define IRDA_BRR(_PCLK_, _BAUD_) ((IRDA_DIVMANT((_PCLK_), (_BAUD_)) << 4)|(IRDA_DIVFRAQ((_PCLK_), (_BAUD_)) & 0x0F))
Kojto 110:165afa46840b 510
Kojto 110:165afa46840b 511 /**
Kojto 110:165afa46840b 512 * @}
Kojto 110:165afa46840b 513 */
Kojto 110:165afa46840b 514
Kojto 110:165afa46840b 515 /* Private functions ---------------------------------------------------------*/
Kojto 110:165afa46840b 516 /** @defgroup IRDA_Private_Functions IRDA Private Functions
Kojto 110:165afa46840b 517 * @{
Kojto 110:165afa46840b 518 */
Kojto 110:165afa46840b 519
Kojto 110:165afa46840b 520 /**
Kojto 110:165afa46840b 521 * @}
Kojto 110:165afa46840b 522 */
Kojto 110:165afa46840b 523
Kojto 110:165afa46840b 524 /**
Kojto 110:165afa46840b 525 * @}
Kojto 110:165afa46840b 526 */
Kojto 110:165afa46840b 527
Kojto 110:165afa46840b 528 /**
Kojto 110:165afa46840b 529 * @}
Kojto 110:165afa46840b 530 */
Kojto 110:165afa46840b 531
Kojto 110:165afa46840b 532 #ifdef __cplusplus
Kojto 110:165afa46840b 533 }
Kojto 110:165afa46840b 534 #endif
Kojto 110:165afa46840b 535
Kojto 110:165afa46840b 536 #endif /* __STM32F4xx_HAL_IRDA_H */
Kojto 110:165afa46840b 537
Kojto 110:165afa46840b 538 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/