Elijah Orr / mbed-renbed

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

TARGET_B96B_F446VE/stm32f4xx_hal_irda.h@112:6f327212ef96, 2016-01-13 (annotated)

Committer:
Kojto
Date:
Wed Jan 13 09:48:29 2016 +0000
Revision:
112:6f327212ef96
Release 112 of the mbed library



Changes:

- new platforms - STM32 B96B F446, MOTE_L152RC

- nrf51 - fix serial init bug (character sent)

- stm all devices - fix RTC clocking in the init

- stm f0 - SystemInit clock fix, for SetVector()

- RawSerial - fix for microlib (vsnprintf with size 0)

Who changed what in which revision?

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