meh

Fork of mbed by mbed official

Committer:
ricardobtez
Date:
Tue Apr 05 23:51:21 2016 +0000
Revision:
118:16969dd821af
Parent:
90:cb3d968589d8
dgdgr

Who changed what in which revision?

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