shao ziyang / mbed-src-kl05

mbed library sources

Dependents:   frdm_kl05z_gpio_test

Fork of mbed-src by mbed official

targets/cmsis/TARGET_STM/TARGET_STM32F407VG/stm32f4xx_hal_irda.h@323:9e901b0a5aa1, 2014-09-13 (annotated)

Committer:
shaoziyang
Date:
Sat Sep 13 14:25:46 2014 +0000
Revision:
323:9e901b0a5aa1
Parent:
296:ec1b66a3d094 
test with CLOCK_SETUP = 0

Who changed what in which revision?

UserRevisionLine numberNew contents of line
mbed_official 133:d4dda5c437f0 1 /**
mbed_official 133:d4dda5c437f0 2 ******************************************************************************
mbed_official 133:d4dda5c437f0 3 * @file stm32f4xx_hal_irda.h
mbed_official 133:d4dda5c437f0 4 * @author MCD Application Team
mbed_official 242:7074e42da0b2 5 * @version V1.1.0RC2
mbed_official 242:7074e42da0b2 6 * @date 14-May-2014
mbed_official 133:d4dda5c437f0 7 * @brief Header file of IRDA HAL module.
mbed_official 133:d4dda5c437f0 8 ******************************************************************************
mbed_official 133:d4dda5c437f0 9 * @attention
mbed_official 133:d4dda5c437f0 10 *
mbed_official 133:d4dda5c437f0 11 * <h2><center>&copy; COPYRIGHT(c) 2014 STMicroelectronics</center></h2>
mbed_official 133:d4dda5c437f0 12 *
mbed_official 133:d4dda5c437f0 13 * Redistribution and use in source and binary forms, with or without modification,
mbed_official 133:d4dda5c437f0 14 * are permitted provided that the following conditions are met:
mbed_official 133:d4dda5c437f0 15 * 1. Redistributions of source code must retain the above copyright notice,
mbed_official 133:d4dda5c437f0 16 * this list of conditions and the following disclaimer.
mbed_official 133:d4dda5c437f0 17 * 2. Redistributions in binary form must reproduce the above copyright notice,
mbed_official 133:d4dda5c437f0 18 * this list of conditions and the following disclaimer in the documentation
mbed_official 133:d4dda5c437f0 19 * and/or other materials provided with the distribution.
mbed_official 133:d4dda5c437f0 20 * 3. Neither the name of STMicroelectronics nor the names of its contributors
mbed_official 133:d4dda5c437f0 21 * may be used to endorse or promote products derived from this software
mbed_official 133:d4dda5c437f0 22 * without specific prior written permission.
mbed_official 133:d4dda5c437f0 23 *
mbed_official 133:d4dda5c437f0 24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
mbed_official 133:d4dda5c437f0 25 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
mbed_official 133:d4dda5c437f0 26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
mbed_official 133:d4dda5c437f0 27 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
mbed_official 133:d4dda5c437f0 28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
mbed_official 133:d4dda5c437f0 29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
mbed_official 133:d4dda5c437f0 30 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
mbed_official 133:d4dda5c437f0 31 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
mbed_official 133:d4dda5c437f0 32 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
mbed_official 133:d4dda5c437f0 33 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
mbed_official 133:d4dda5c437f0 34 *
mbed_official 133:d4dda5c437f0 35 ******************************************************************************
mbed_official 133:d4dda5c437f0 36 */
mbed_official 133:d4dda5c437f0 37
mbed_official 133:d4dda5c437f0 38 /* Define to prevent recursive inclusion -------------------------------------*/
mbed_official 133:d4dda5c437f0 39 #ifndef __STM32F4xx_HAL_IRDA_H
mbed_official 133:d4dda5c437f0 40 #define __STM32F4xx_HAL_IRDA_H
mbed_official 133:d4dda5c437f0 41
mbed_official 133:d4dda5c437f0 42 #ifdef __cplusplus
mbed_official 133:d4dda5c437f0 43 extern "C" {
mbed_official 133:d4dda5c437f0 44 #endif
mbed_official 133:d4dda5c437f0 45
mbed_official 133:d4dda5c437f0 46 /* Includes ------------------------------------------------------------------*/
mbed_official 133:d4dda5c437f0 47 #include "stm32f4xx_hal_def.h"
mbed_official 133:d4dda5c437f0 48
mbed_official 133:d4dda5c437f0 49 /** @addtogroup STM32F4xx_HAL_Driver
mbed_official 133:d4dda5c437f0 50 * @{
mbed_official 133:d4dda5c437f0 51 */
mbed_official 133:d4dda5c437f0 52
mbed_official 133:d4dda5c437f0 53 /** @addtogroup IRDA
mbed_official 133:d4dda5c437f0 54 * @{
mbed_official 133:d4dda5c437f0 55 */
mbed_official 133:d4dda5c437f0 56
mbed_official 133:d4dda5c437f0 57 /* Exported types ------------------------------------------------------------*/
mbed_official 133:d4dda5c437f0 58
mbed_official 133:d4dda5c437f0 59 /**
mbed_official 133:d4dda5c437f0 60 * @brief IRDA Init Structure definition
mbed_official 133:d4dda5c437f0 61 */
mbed_official 133:d4dda5c437f0 62 typedef struct
mbed_official 133:d4dda5c437f0 63 {
mbed_official 133:d4dda5c437f0 64 uint32_t BaudRate; /*!< This member configures the IRDA communication baud rate.
mbed_official 133:d4dda5c437f0 65 The baud rate is computed using the following formula:
mbed_official 133:d4dda5c437f0 66 - IntegerDivider = ((PCLKx) / (8 * (hirda->Init.BaudRate)))
mbed_official 133:d4dda5c437f0 67 - FractionalDivider = ((IntegerDivider - ((uint32_t) IntegerDivider)) * 8) + 0.5 */
mbed_official 133:d4dda5c437f0 68
mbed_official 133:d4dda5c437f0 69 uint32_t WordLength; /*!< Specifies the number of data bits transmitted or received in a frame.
mbed_official 133:d4dda5c437f0 70 This parameter can be a value of @ref IRDA_Word_Length */
mbed_official 133:d4dda5c437f0 71
mbed_official 133:d4dda5c437f0 72
mbed_official 133:d4dda5c437f0 73 uint32_t Parity; /*!< Specifies the parity mode.
mbed_official 133:d4dda5c437f0 74 This parameter can be a value of @ref IRDA_Parity
mbed_official 133:d4dda5c437f0 75 @note When parity is enabled, the computed parity is inserted
mbed_official 133:d4dda5c437f0 76 at the MSB position of the transmitted data (9th bit when
mbed_official 133:d4dda5c437f0 77 the word length is set to 9 data bits; 8th bit when the
mbed_official 133:d4dda5c437f0 78 word length is set to 8 data bits). */
mbed_official 133:d4dda5c437f0 79
mbed_official 133:d4dda5c437f0 80 uint32_t Mode; /*!< Specifies wether the Receive or Transmit mode is enabled or disabled.
mbed_official 133:d4dda5c437f0 81 This parameter can be a value of @ref IRDA_Mode */
mbed_official 133:d4dda5c437f0 82
mbed_official 133:d4dda5c437f0 83 uint8_t Prescaler; /*!< Specifies the Prescaler */
mbed_official 133:d4dda5c437f0 84
mbed_official 133:d4dda5c437f0 85 uint32_t IrDAMode; /*!< Specifies the IrDA mode
mbed_official 133:d4dda5c437f0 86 This parameter can be a value of @ref IrDA_Low_Power */
mbed_official 133:d4dda5c437f0 87 }IRDA_InitTypeDef;
mbed_official 133:d4dda5c437f0 88
mbed_official 133:d4dda5c437f0 89 /**
mbed_official 133:d4dda5c437f0 90 * @brief HAL State structures definition
mbed_official 133:d4dda5c437f0 91 */
mbed_official 133:d4dda5c437f0 92 typedef enum
mbed_official 133:d4dda5c437f0 93 {
mbed_official 133:d4dda5c437f0 94 HAL_IRDA_STATE_RESET = 0x00, /*!< Peripheral is not yet Initialized */
mbed_official 133:d4dda5c437f0 95 HAL_IRDA_STATE_READY = 0x01, /*!< Peripheral Initialized and ready for use */
mbed_official 133:d4dda5c437f0 96 HAL_IRDA_STATE_BUSY = 0x02, /*!< an internal process is ongoing */
mbed_official 133:d4dda5c437f0 97 HAL_IRDA_STATE_BUSY_TX = 0x12, /*!< Data Transmission process is ongoing */
mbed_official 133:d4dda5c437f0 98 HAL_IRDA_STATE_BUSY_RX = 0x22, /*!< Data Reception process is ongoing */
mbed_official 133:d4dda5c437f0 99 HAL_IRDA_STATE_BUSY_TX_RX = 0x32, /*!< Data Transmission and Reception process is ongoing */
mbed_official 133:d4dda5c437f0 100 HAL_IRDA_STATE_TIMEOUT = 0x03, /*!< Timeout state */
mbed_official 133:d4dda5c437f0 101 HAL_IRDA_STATE_ERROR = 0x04 /*!< Error */
mbed_official 133:d4dda5c437f0 102 }HAL_IRDA_StateTypeDef;
mbed_official 133:d4dda5c437f0 103
mbed_official 133:d4dda5c437f0 104 /**
mbed_official 133:d4dda5c437f0 105 * @brief HAL IRDA Error Code structure definition
mbed_official 133:d4dda5c437f0 106 */
mbed_official 133:d4dda5c437f0 107 typedef enum
mbed_official 133:d4dda5c437f0 108 {
mbed_official 133:d4dda5c437f0 109 HAL_IRDA_ERROR_NONE = 0x00, /*!< No error */
mbed_official 133:d4dda5c437f0 110 HAL_IRDA_ERROR_PE = 0x01, /*!< Parity error */
mbed_official 133:d4dda5c437f0 111 HAL_IRDA_ERROR_NE = 0x02, /*!< Noise error */
mbed_official 133:d4dda5c437f0 112 HAL_IRDA_ERROR_FE = 0x04, /*!< frame error */
mbed_official 133:d4dda5c437f0 113 HAL_IRDA_ERROR_ORE = 0x08, /*!< Overrun error */
mbed_official 133:d4dda5c437f0 114 HAL_IRDA_ERROR_DMA = 0x10 /*!< DMA transfer error */
mbed_official 133:d4dda5c437f0 115 }HAL_IRDA_ErrorTypeDef;
mbed_official 133:d4dda5c437f0 116
mbed_official 133:d4dda5c437f0 117 /**
mbed_official 133:d4dda5c437f0 118 * @brief IRDA handle Structure definition
mbed_official 133:d4dda5c437f0 119 */
mbed_official 133:d4dda5c437f0 120 typedef struct
mbed_official 133:d4dda5c437f0 121 {
mbed_official 133:d4dda5c437f0 122 USART_TypeDef *Instance; /* USART registers base address */
mbed_official 133:d4dda5c437f0 123
mbed_official 133:d4dda5c437f0 124 IRDA_InitTypeDef Init; /* IRDA communication parameters */
mbed_official 133:d4dda5c437f0 125
mbed_official 133:d4dda5c437f0 126 uint8_t *pTxBuffPtr; /* Pointer to IRDA Tx transfer Buffer */
mbed_official 133:d4dda5c437f0 127
mbed_official 133:d4dda5c437f0 128 uint16_t TxXferSize; /* IRDA Tx Transfer size */
mbed_official 133:d4dda5c437f0 129
mbed_official 133:d4dda5c437f0 130 uint16_t TxXferCount; /* IRDA Tx Transfer Counter */
mbed_official 133:d4dda5c437f0 131
mbed_official 133:d4dda5c437f0 132 uint8_t *pRxBuffPtr; /* Pointer to IRDA Rx transfer Buffer */
mbed_official 133:d4dda5c437f0 133
mbed_official 133:d4dda5c437f0 134 uint16_t RxXferSize; /* IRDA Rx Transfer size */
mbed_official 133:d4dda5c437f0 135
mbed_official 133:d4dda5c437f0 136 uint16_t RxXferCount; /* IRDA Rx Transfer Counter */
mbed_official 133:d4dda5c437f0 137
mbed_official 133:d4dda5c437f0 138 DMA_HandleTypeDef *hdmatx; /* IRDA Tx DMA Handle parameters */
mbed_official 133:d4dda5c437f0 139
mbed_official 133:d4dda5c437f0 140 DMA_HandleTypeDef *hdmarx; /* IRDA Rx DMA Handle parameters */
mbed_official 133:d4dda5c437f0 141
mbed_official 133:d4dda5c437f0 142 HAL_LockTypeDef Lock; /* Locking object */
mbed_official 133:d4dda5c437f0 143
mbed_official 133:d4dda5c437f0 144 __IO HAL_IRDA_StateTypeDef State; /* IRDA communication state */
mbed_official 133:d4dda5c437f0 145
mbed_official 133:d4dda5c437f0 146 __IO HAL_IRDA_ErrorTypeDef ErrorCode; /* IRDA Error code */
mbed_official 133:d4dda5c437f0 147
mbed_official 133:d4dda5c437f0 148 }IRDA_HandleTypeDef;
mbed_official 133:d4dda5c437f0 149
mbed_official 133:d4dda5c437f0 150 /* Exported constants --------------------------------------------------------*/
mbed_official 133:d4dda5c437f0 151 /** @defgroup IRDA_Exported_Constants
mbed_official 133:d4dda5c437f0 152 * @{
mbed_official 133:d4dda5c437f0 153 */
mbed_official 133:d4dda5c437f0 154
mbed_official 133:d4dda5c437f0 155 /** @defgroup IRDA_Word_Length
mbed_official 133:d4dda5c437f0 156 * @{
mbed_official 133:d4dda5c437f0 157 */
mbed_official 133:d4dda5c437f0 158 #define IRDA_WORDLENGTH_8B ((uint32_t)0x00000000)
mbed_official 133:d4dda5c437f0 159 #define IRDA_WORDLENGTH_9B ((uint32_t)USART_CR1_M)
mbed_official 133:d4dda5c437f0 160 #define IS_IRDA_WORD_LENGTH(LENGTH) (((LENGTH) == IRDA_WORDLENGTH_8B) || \
mbed_official 133:d4dda5c437f0 161 ((LENGTH) == IRDA_WORDLENGTH_9B))
mbed_official 133:d4dda5c437f0 162 /**
mbed_official 133:d4dda5c437f0 163 * @}
mbed_official 133:d4dda5c437f0 164 */
mbed_official 133:d4dda5c437f0 165
mbed_official 133:d4dda5c437f0 166
mbed_official 133:d4dda5c437f0 167 /** @defgroup IRDA_Parity
mbed_official 133:d4dda5c437f0 168 * @{
mbed_official 133:d4dda5c437f0 169 */
mbed_official 133:d4dda5c437f0 170 #define IRDA_PARITY_NONE ((uint32_t)0x00000000)
mbed_official 133:d4dda5c437f0 171 #define IRDA_PARITY_EVEN ((uint32_t)USART_CR1_PCE)
mbed_official 133:d4dda5c437f0 172 #define IRDA_PARITY_ODD ((uint32_t)(USART_CR1_PCE | USART_CR1_PS))
mbed_official 133:d4dda5c437f0 173 #define IS_IRDA_PARITY(PARITY) (((PARITY) == IRDA_PARITY_NONE) || \
mbed_official 133:d4dda5c437f0 174 ((PARITY) == IRDA_PARITY_EVEN) || \
mbed_official 133:d4dda5c437f0 175 ((PARITY) == IRDA_PARITY_ODD))
mbed_official 133:d4dda5c437f0 176 /**
mbed_official 133:d4dda5c437f0 177 * @}
mbed_official 133:d4dda5c437f0 178 */
mbed_official 133:d4dda5c437f0 179
mbed_official 133:d4dda5c437f0 180
mbed_official 133:d4dda5c437f0 181 /** @defgroup IRDA_Mode
mbed_official 133:d4dda5c437f0 182 * @{
mbed_official 133:d4dda5c437f0 183 */
mbed_official 133:d4dda5c437f0 184 #define IRDA_MODE_RX ((uint32_t)USART_CR1_RE)
mbed_official 133:d4dda5c437f0 185 #define IRDA_MODE_TX ((uint32_t)USART_CR1_TE)
mbed_official 133:d4dda5c437f0 186 #define IRDA_MODE_TX_RX ((uint32_t)(USART_CR1_TE |USART_CR1_RE))
mbed_official 133:d4dda5c437f0 187 #define IS_IRDA_MODE(MODE) ((((MODE) & (uint32_t)0x0000FFF3) == 0x00) && ((MODE) != (uint32_t)0x000000))
mbed_official 133:d4dda5c437f0 188 /**
mbed_official 133:d4dda5c437f0 189 * @}
mbed_official 133:d4dda5c437f0 190 */
mbed_official 133:d4dda5c437f0 191
mbed_official 133:d4dda5c437f0 192 /** @defgroup IrDA_Low_Power
mbed_official 133:d4dda5c437f0 193 * @{
mbed_official 133:d4dda5c437f0 194 */
mbed_official 133:d4dda5c437f0 195 #define IRDA_POWERMODE_LOWPOWER ((uint32_t)USART_CR3_IRLP)
mbed_official 133:d4dda5c437f0 196 #define IRDA_POWERMODE_NORMAL ((uint32_t)0x00000000)
mbed_official 133:d4dda5c437f0 197 #define IS_IRDA_POWERMODE(MODE) (((MODE) == IRDA_POWERMODE_LOWPOWER) || \
mbed_official 133:d4dda5c437f0 198 ((MODE) == IRDA_POWERMODE_NORMAL))
mbed_official 133:d4dda5c437f0 199 /**
mbed_official 133:d4dda5c437f0 200 * @}
mbed_official 133:d4dda5c437f0 201 */
mbed_official 133:d4dda5c437f0 202
mbed_official 133:d4dda5c437f0 203 /** @defgroup IRDA_Flags
mbed_official 133:d4dda5c437f0 204 * Elements values convention: 0xXXXX
mbed_official 133:d4dda5c437f0 205 * - 0xXXXX : Flag mask in the SR register
mbed_official 133:d4dda5c437f0 206 * @{
mbed_official 133:d4dda5c437f0 207 */
mbed_official 133:d4dda5c437f0 208 #define IRDA_FLAG_TXE ((uint32_t)0x00000080)
mbed_official 133:d4dda5c437f0 209 #define IRDA_FLAG_TC ((uint32_t)0x00000040)
mbed_official 133:d4dda5c437f0 210 #define IRDA_FLAG_RXNE ((uint32_t)0x00000020)
mbed_official 133:d4dda5c437f0 211 #define IRDA_FLAG_IDLE ((uint32_t)0x00000010)
mbed_official 133:d4dda5c437f0 212 #define IRDA_FLAG_ORE ((uint32_t)0x00000008)
mbed_official 133:d4dda5c437f0 213 #define IRDA_FLAG_NE ((uint32_t)0x00000004)
mbed_official 133:d4dda5c437f0 214 #define IRDA_FLAG_FE ((uint32_t)0x00000002)
mbed_official 133:d4dda5c437f0 215 #define IRDA_FLAG_PE ((uint32_t)0x00000001)
mbed_official 133:d4dda5c437f0 216 /**
mbed_official 133:d4dda5c437f0 217 * @}
mbed_official 133:d4dda5c437f0 218 */
mbed_official 133:d4dda5c437f0 219
mbed_official 133:d4dda5c437f0 220 /** @defgroup IRDA_Interrupt_definition
mbed_official 133:d4dda5c437f0 221 * Elements values convention: 0xY000XXXX
mbed_official 133:d4dda5c437f0 222 * - XXXX : Interrupt mask in the XX register
mbed_official 133:d4dda5c437f0 223 * - Y : Interrupt source register (2bits)
mbed_official 133:d4dda5c437f0 224 * - 01: CR1 register
mbed_official 133:d4dda5c437f0 225 * - 10: CR2 register
mbed_official 133:d4dda5c437f0 226 * - 11: CR3 register
mbed_official 133:d4dda5c437f0 227 *
mbed_official 133:d4dda5c437f0 228 * @{
mbed_official 133:d4dda5c437f0 229 */
mbed_official 133:d4dda5c437f0 230
mbed_official 133:d4dda5c437f0 231 #define IRDA_IT_PE ((uint32_t)0x10000100)
mbed_official 133:d4dda5c437f0 232 #define IRDA_IT_TXE ((uint32_t)0x10000080)
mbed_official 133:d4dda5c437f0 233 #define IRDA_IT_TC ((uint32_t)0x10000040)
mbed_official 133:d4dda5c437f0 234 #define IRDA_IT_RXNE ((uint32_t)0x10000020)
mbed_official 133:d4dda5c437f0 235 #define IRDA_IT_IDLE ((uint32_t)0x10000010)
mbed_official 242:7074e42da0b2 236
mbed_official 133:d4dda5c437f0 237 #define IRDA_IT_LBD ((uint32_t)0x20000040)
mbed_official 133:d4dda5c437f0 238
mbed_official 242:7074e42da0b2 239 #define IRDA_IT_CTS ((uint32_t)0x30000400)
mbed_official 133:d4dda5c437f0 240 #define IRDA_IT_ERR ((uint32_t)0x30000001)
mbed_official 133:d4dda5c437f0 241
mbed_official 133:d4dda5c437f0 242 /**
mbed_official 133:d4dda5c437f0 243 * @}
mbed_official 133:d4dda5c437f0 244 */
mbed_official 242:7074e42da0b2 245
mbed_official 133:d4dda5c437f0 246 /**
mbed_official 133:d4dda5c437f0 247 * @}
mbed_official 133:d4dda5c437f0 248 */
mbed_official 133:d4dda5c437f0 249
mbed_official 133:d4dda5c437f0 250 /* Exported macro ------------------------------------------------------------*/
mbed_official 133:d4dda5c437f0 251
mbed_official 242:7074e42da0b2 252 /** @brief Reset IRDA handle state
mbed_official 242:7074e42da0b2 253 * @param __HANDLE__: specifies the IRDA Handle.
mbed_official 242:7074e42da0b2 254 * @retval None
mbed_official 242:7074e42da0b2 255 */
mbed_official 242:7074e42da0b2 256 #define __HAL_IRDA_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_IRDA_STATE_RESET)
mbed_official 242:7074e42da0b2 257
mbed_official 242:7074e42da0b2 258 /** @brief Flushs the IRDA DR register
mbed_official 242:7074e42da0b2 259 * @param __HANDLE__: specifies the IRDA Handle.
mbed_official 242:7074e42da0b2 260 */
mbed_official 242:7074e42da0b2 261 #define __HAL_IRDA_FLUSH_DRREGISTER(__HANDLE__) ((__HANDLE__)->Instance->DR)
mbed_official 242:7074e42da0b2 262
mbed_official 133:d4dda5c437f0 263 /** @brief Checks whether the specified IRDA flag is set or not.
mbed_official 133:d4dda5c437f0 264 * @param __HANDLE__: specifies the USART Handle.
mbed_official 133:d4dda5c437f0 265 * This parameter can be USARTx where x: 1, 2, 3, 4, 5, 6, 7 or 8 to select the USART or
mbed_official 133:d4dda5c437f0 266 * UART peripheral.
mbed_official 133:d4dda5c437f0 267 * @param __FLAG__: specifies the flag to check.
mbed_official 133:d4dda5c437f0 268 * This parameter can be one of the following values:
mbed_official 133:d4dda5c437f0 269 * @arg IRDA_FLAG_TXE: Transmit data register empty flag
mbed_official 133:d4dda5c437f0 270 * @arg IRDA_FLAG_TC: Transmission Complete flag
mbed_official 133:d4dda5c437f0 271 * @arg IRDA_FLAG_RXNE: Receive data register not empty flag
mbed_official 133:d4dda5c437f0 272 * @arg IRDA_FLAG_IDLE: Idle Line detection flag
mbed_official 133:d4dda5c437f0 273 * @arg IRDA_FLAG_ORE: OverRun Error flag
mbed_official 133:d4dda5c437f0 274 * @arg IRDA_FLAG_NE: Noise Error flag
mbed_official 133:d4dda5c437f0 275 * @arg IRDA_FLAG_FE: Framing Error flag
mbed_official 133:d4dda5c437f0 276 * @arg IRDA_FLAG_PE: Parity Error flag
mbed_official 133:d4dda5c437f0 277 * @retval The new state of __FLAG__ (TRUE or FALSE).
mbed_official 133:d4dda5c437f0 278 */
mbed_official 133:d4dda5c437f0 279 #define __HAL_IRDA_GET_FLAG(__HANDLE__, __FLAG__) (((__HANDLE__)->Instance->SR & (__FLAG__)) == (__FLAG__))
mbed_official 133:d4dda5c437f0 280
mbed_official 133:d4dda5c437f0 281 /** @brief Clears the specified IRDA pending flag.
mbed_official 133:d4dda5c437f0 282 * @param __HANDLE__: specifies the USART Handle.
mbed_official 133:d4dda5c437f0 283 * This parameter can be USARTx where x: 1, 2, 3, 4, 5, 6, 7 or 8 to select the USART or
mbed_official 133:d4dda5c437f0 284 * UART peripheral.
mbed_official 133:d4dda5c437f0 285 * @param __FLAG__: specifies the flag to check.
mbed_official 133:d4dda5c437f0 286 * This parameter can be any combination of the following values:
mbed_official 133:d4dda5c437f0 287 * @arg IRDA_FLAG_TC: Transmission Complete flag.
mbed_official 133:d4dda5c437f0 288 * @arg IRDA_FLAG_RXNE: Receive data register not empty flag.
mbed_official 133:d4dda5c437f0 289 *
mbed_official 133:d4dda5c437f0 290 * @note PE (Parity error), FE (Framing error), NE (Noise error), ORE (OverRun
mbed_official 133:d4dda5c437f0 291 * error) and IDLE (Idle line detected) flags are cleared by software
mbed_official 133:d4dda5c437f0 292 * sequence: a read operation to USART_SR register followed by a read
mbed_official 133:d4dda5c437f0 293 * operation to USART_DR register.
mbed_official 133:d4dda5c437f0 294 * @note RXNE flag can be also cleared by a read to the USART_DR register.
mbed_official 133:d4dda5c437f0 295 * @note TC flag can be also cleared by software sequence: a read operation to
mbed_official 133:d4dda5c437f0 296 * USART_SR register followed by a write operation to USART_DR register.
mbed_official 133:d4dda5c437f0 297 * @note TXE flag is cleared only by a write to the USART_DR register.
mbed_official 133:d4dda5c437f0 298 *
mbed_official 133:d4dda5c437f0 299 * @retval None
mbed_official 133:d4dda5c437f0 300 */
mbed_official 133:d4dda5c437f0 301 #define __HAL_IRDA_CLEAR_FLAG(__HANDLE__, __FLAG__) ((__HANDLE__)->Instance->SR &= ~(__FLAG__))
mbed_official 133:d4dda5c437f0 302
mbed_official 133:d4dda5c437f0 303
mbed_official 133:d4dda5c437f0 304 /** @brief Enables or disables the specified IRDA interrupt.
mbed_official 133:d4dda5c437f0 305 * @param __HANDLE__: specifies the USART Handle.
mbed_official 133:d4dda5c437f0 306 * This parameter can be USARTx where x: 1, 2, 3, 4, 5, 6, 7 or 8 to select the USART or
mbed_official 133:d4dda5c437f0 307 * UART peripheral.
mbed_official 133:d4dda5c437f0 308 * @param __INTERRUPT__: specifies the IRDA interrupt source to check.
mbed_official 133:d4dda5c437f0 309 * This parameter can be one of the following values:
mbed_official 133:d4dda5c437f0 310 * @arg IRDA_IT_TXE: Transmit Data Register empty interrupt
mbed_official 133:d4dda5c437f0 311 * @arg IRDA_IT_TC: Transmission complete interrupt
mbed_official 133:d4dda5c437f0 312 * @arg IRDA_IT_RXNE: Receive Data register not empty interrupt
mbed_official 133:d4dda5c437f0 313 * @arg IRDA_IT_IDLE: Idle line detection interrupt
mbed_official 133:d4dda5c437f0 314 * @arg IRDA_IT_PE: Parity Error interrupt
mbed_official 133:d4dda5c437f0 315 * @arg IRDA_IT_ERR: Error interrupt(Frame error, noise error, overrun error)
mbed_official 133:d4dda5c437f0 316 * @param NewState: new state of the specified IRDA interrupt.
mbed_official 133:d4dda5c437f0 317 * This parameter can be: ENABLE or DISABLE.
mbed_official 133:d4dda5c437f0 318 * @retval None
mbed_official 133:d4dda5c437f0 319 */
mbed_official 133:d4dda5c437f0 320 #define IRDA_IT_MASK ((uint32_t)0x0000FFFF)
mbed_official 133:d4dda5c437f0 321 #define __HAL_IRDA_ENABLE_IT(__HANDLE__, __INTERRUPT__) ((((__INTERRUPT__) >> 28) == 1)? ((__HANDLE__)->Instance->CR1 |= ((__INTERRUPT__) & IRDA_IT_MASK)): \
mbed_official 133:d4dda5c437f0 322 (((__INTERRUPT__) >> 28) == 2)? ((__HANDLE__)->Instance->CR2 |= ((__INTERRUPT__) & IRDA_IT_MASK)): \
mbed_official 133:d4dda5c437f0 323 ((__HANDLE__)->Instance->CR3 |= ((__INTERRUPT__) & IRDA_IT_MASK)))
mbed_official 133:d4dda5c437f0 324 #define __HAL_IRDA_DISABLE_IT(__HANDLE__, __INTERRUPT__) ((((__INTERRUPT__) >> 28) == 1)? ((__HANDLE__)->Instance->CR1 &= ~((__INTERRUPT__) & IRDA_IT_MASK)): \
mbed_official 133:d4dda5c437f0 325 (((__INTERRUPT__) >> 28) == 2)? ((__HANDLE__)->Instance->CR2 &= ~((__INTERRUPT__) & IRDA_IT_MASK)): \
mbed_official 133:d4dda5c437f0 326 ((__HANDLE__)->Instance->CR3 &= ~ ((__INTERRUPT__) & IRDA_IT_MASK)))
mbed_official 133:d4dda5c437f0 327
mbed_official 133:d4dda5c437f0 328 /** @brief Checks whether the specified IRDA interrupt has occurred or not.
mbed_official 133:d4dda5c437f0 329 * @param __HANDLE__: specifies the USART Handle.
mbed_official 133:d4dda5c437f0 330 * This parameter can be USARTx where x: 1, 2, 3, 4, 5, 6, 7 or 8 to select the USART or
mbed_official 133:d4dda5c437f0 331 * UART peripheral.
mbed_official 133:d4dda5c437f0 332 * @param __IT__: specifies the IRDA interrupt source to check.
mbed_official 133:d4dda5c437f0 333 * This parameter can be one of the following values:
mbed_official 133:d4dda5c437f0 334 * @arg IRDA_IT_TXE: Transmit Data Register empty interrupt
mbed_official 133:d4dda5c437f0 335 * @arg IRDA_IT_TC: Transmission complete interrupt
mbed_official 133:d4dda5c437f0 336 * @arg IRDA_IT_RXNE: Receive Data register not empty interrupt
mbed_official 133:d4dda5c437f0 337 * @arg IRDA_IT_IDLE: Idle line detection interrupt
mbed_official 133:d4dda5c437f0 338 * @arg USART_IT_ERR: Error interrupt
mbed_official 133:d4dda5c437f0 339 * @arg IRDA_IT_PE: Parity Error interrupt
mbed_official 133:d4dda5c437f0 340 * @retval The new state of __IT__ (TRUE or FALSE).
mbed_official 133:d4dda5c437f0 341 */
mbed_official 133:d4dda5c437f0 342 #define __HAL_IRDA_GET_IT_SOURCE(__HANDLE__, __IT__) (((((__IT__) >> 28) == 1)? (__HANDLE__)->Instance->CR1:(((((uint32_t)(__IT__)) >> 28) == 2)? \
mbed_official 133:d4dda5c437f0 343 (__HANDLE__)->Instance->CR2 : (__HANDLE__)->Instance->CR3)) & (((uint32_t)(__IT__)) & IRDA_IT_MASK))
mbed_official 133:d4dda5c437f0 344
mbed_official 133:d4dda5c437f0 345
mbed_official 133:d4dda5c437f0 346
mbed_official 133:d4dda5c437f0 347 #define __IRDA_ENABLE(__HANDLE__) ( (__HANDLE__)->Instance->CR1 |= USART_CR1_UE)
mbed_official 133:d4dda5c437f0 348 #define __IRDA_DISABLE(__HANDLE__) ( (__HANDLE__)->Instance->CR1 &= ~USART_CR1_UE)
mbed_official 133:d4dda5c437f0 349
mbed_official 133:d4dda5c437f0 350 #define __DIV(_PCLK_, _BAUD_) (((_PCLK_)*25)/(4*(_BAUD_)))
mbed_official 133:d4dda5c437f0 351 #define __DIVMANT(_PCLK_, _BAUD_) (__DIV((_PCLK_), (_BAUD_))/100)
mbed_official 133:d4dda5c437f0 352 #define __DIVFRAQ(_PCLK_, _BAUD_) (((__DIV((_PCLK_), (_BAUD_)) - (__DIVMANT((_PCLK_), (_BAUD_)) * 100)) * 16 + 50) / 100)
mbed_official 133:d4dda5c437f0 353 #define __IRDA_BRR(_PCLK_, _BAUD_) ((__DIVMANT((_PCLK_), (_BAUD_)) << 4)|(__DIVFRAQ((_PCLK_), (_BAUD_)) & 0x0F))
mbed_official 133:d4dda5c437f0 354
mbed_official 133:d4dda5c437f0 355 #define IS_IRDA_BAUDRATE(BAUDRATE) ((BAUDRATE) < 115201)
mbed_official 133:d4dda5c437f0 356
mbed_official 133:d4dda5c437f0 357
mbed_official 133:d4dda5c437f0 358 /* Exported functions --------------------------------------------------------*/
mbed_official 133:d4dda5c437f0 359 /* Initialization/de-initialization functions **********************************/
mbed_official 133:d4dda5c437f0 360 HAL_StatusTypeDef HAL_IRDA_Init(IRDA_HandleTypeDef *hirda);
mbed_official 133:d4dda5c437f0 361 HAL_StatusTypeDef HAL_IRDA_DeInit(IRDA_HandleTypeDef *hirda);
mbed_official 133:d4dda5c437f0 362 void HAL_IRDA_MspInit(IRDA_HandleTypeDef *hirda);
mbed_official 133:d4dda5c437f0 363 void HAL_IRDA_MspDeInit(IRDA_HandleTypeDef *hirda);
mbed_official 133:d4dda5c437f0 364
mbed_official 133:d4dda5c437f0 365 /* IO operation functions *******************************************************/
mbed_official 133:d4dda5c437f0 366 HAL_StatusTypeDef HAL_IRDA_Transmit(IRDA_HandleTypeDef *hirda, uint8_t *pData, uint16_t Size, uint32_t Timeout);
mbed_official 133:d4dda5c437f0 367 HAL_StatusTypeDef HAL_IRDA_Receive(IRDA_HandleTypeDef *hirda, uint8_t *pData, uint16_t Size, uint32_t Timeout);
mbed_official 133:d4dda5c437f0 368 HAL_StatusTypeDef HAL_IRDA_Transmit_IT(IRDA_HandleTypeDef *hirda, uint8_t *pData, uint16_t Size);
mbed_official 133:d4dda5c437f0 369 HAL_StatusTypeDef HAL_IRDA_Receive_IT(IRDA_HandleTypeDef *hirda, uint8_t *pData, uint16_t Size);
mbed_official 133:d4dda5c437f0 370 HAL_StatusTypeDef HAL_IRDA_Transmit_DMA(IRDA_HandleTypeDef *hirda, uint8_t *pData, uint16_t Size);
mbed_official 133:d4dda5c437f0 371 HAL_StatusTypeDef HAL_IRDA_Receive_DMA(IRDA_HandleTypeDef *hirda, uint8_t *pData, uint16_t Size);
mbed_official 133:d4dda5c437f0 372 void HAL_IRDA_IRQHandler(IRDA_HandleTypeDef *hirda);
mbed_official 133:d4dda5c437f0 373 void HAL_IRDA_TxCpltCallback(IRDA_HandleTypeDef *hirda);
mbed_official 133:d4dda5c437f0 374 void HAL_IRDA_RxCpltCallback(IRDA_HandleTypeDef *hirda);
mbed_official 133:d4dda5c437f0 375 void HAL_IRDA_ErrorCallback(IRDA_HandleTypeDef *hirda);
mbed_official 133:d4dda5c437f0 376
mbed_official 133:d4dda5c437f0 377 /* Peripheral State functions **************************************************/
mbed_official 133:d4dda5c437f0 378 HAL_IRDA_StateTypeDef HAL_IRDA_GetState(IRDA_HandleTypeDef *hirda);
mbed_official 133:d4dda5c437f0 379 uint32_t HAL_IRDA_GetError(IRDA_HandleTypeDef *hirda);
mbed_official 133:d4dda5c437f0 380
mbed_official 133:d4dda5c437f0 381 /**
mbed_official 133:d4dda5c437f0 382 * @}
mbed_official 133:d4dda5c437f0 383 */
mbed_official 133:d4dda5c437f0 384
mbed_official 133:d4dda5c437f0 385 /**
mbed_official 133:d4dda5c437f0 386 * @}
mbed_official 133:d4dda5c437f0 387 */
mbed_official 133:d4dda5c437f0 388
mbed_official 133:d4dda5c437f0 389 #ifdef __cplusplus
mbed_official 133:d4dda5c437f0 390 }
mbed_official 133:d4dda5c437f0 391 #endif
mbed_official 133:d4dda5c437f0 392
mbed_official 133:d4dda5c437f0 393 #endif /* __STM32F4xx_HAL_IRDA_H */
mbed_official 133:d4dda5c437f0 394
mbed_official 133:d4dda5c437f0 395 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/