meh

Fork of mbed by mbed official

Committer:
Kojto
Date:
Wed May 13 08:08:21 2015 +0200
Revision:
99:dbbf35b96557
Parent:
90:cb3d968589d8
Child:
106:ba1f97679dad
Release 99 of the mbed library

Changes:
- new targets - MAXWSNENV, DISCO_L053C8
- STM32F4xx - ST Cube driver
- KSDK mcu - SPI timing fix
- Nordic - update to softdevice s130

Who changed what in which revision?

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