mbed(SerialHalfDuplex入り)
Fork of mbed by
TARGET_NUCLEO_F302R8/stm32f3xx_hal_irda.h
- Committer:
- yusuke_kyo
- Date:
- 2015-04-08
- Revision:
- 98:01a414ca7d6d
- Parent:
- 90:cb3d968589d8
File content as of revision 98:01a414ca7d6d:
/** ****************************************************************************** * @file stm32f3xx_hal_irda.h * @author MCD Application Team * @version V1.1.0 * @date 12-Sept-2014 * @brief Header file of IRDA HAL module. ****************************************************************************** * @attention * * <h2><center>© COPYRIGHT(c) 2014 STMicroelectronics</center></h2> * * Redistribution and use in source and binary forms, with or without modification, * are permitted provided that the following conditions are met: * 1. Redistributions of source code must retain the above copyright notice, * this list of conditions and the following disclaimer. * 2. Redistributions in binary form must reproduce the above copyright notice, * this list of conditions and the following disclaimer in the documentation * and/or other materials provided with the distribution. * 3. Neither the name of STMicroelectronics nor the names of its contributors * may be used to endorse or promote products derived from this software * without specific prior written permission. * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. * ****************************************************************************** */ /* Define to prevent recursive inclusion -------------------------------------*/ #ifndef __STM32F3xx_HAL_IRDA_H #define __STM32F3xx_HAL_IRDA_H #ifdef __cplusplus extern "C" { #endif /* Includes ------------------------------------------------------------------*/ #include "stm32f3xx_hal_def.h" /** @addtogroup STM32F3xx_HAL_Driver * @{ */ /** @addtogroup IRDA IRDA HAL module driver * @{ */ /* Exported types ------------------------------------------------------------*/ /** @defgroup IRDA_Exported_Types IRDA Exported Types * @{ */ /** * @brief IRDA Init Structure definition */ typedef struct { uint32_t BaudRate; /*!< This member configures the IRDA communication baud rate. The baud rate register is computed using the following formula: Baud Rate Register = ((PCLKx) / ((hirda->Init.BaudRate))) */ uint32_t WordLength; /*!< Specifies the number of data bits transmitted or received in a frame. This parameter can be a value of @ref IRDAEx_Word_Length */ uint16_t Parity; /*!< Specifies the parity mode. This parameter can be a value of @ref IRDA_Parity @note When parity is enabled, the computed parity is inserted at the MSB position of the transmitted data (9th bit when the word length is set to 9 data bits; 8th bit when the word length is set to 8 data bits). */ uint16_t Mode; /*!< Specifies whether the Receive or Transmit mode is enabled or disabled. This parameter can be a value of @ref IRDA_Mode */ uint8_t Prescaler; /*!< Specifies the Prescaler value for dividing the UART/USART source clock to achieve low-power frequency. @note Prescaler value 0 is forbidden */ uint16_t PowerMode; /*!< Specifies the IRDA power mode. This parameter can be a value of @ref IRDA_Low_Power */ }IRDA_InitTypeDef; /** * @brief HAL IRDA State structures definition */ typedef enum { HAL_IRDA_STATE_RESET = 0x00, /*!< Peripheral is not initialized */ HAL_IRDA_STATE_READY = 0x01, /*!< Peripheral Initialized and ready for use */ HAL_IRDA_STATE_BUSY = 0x02, /*!< an internal process is ongoing */ HAL_IRDA_STATE_BUSY_TX = 0x12, /*!< Data Transmission process is ongoing */ HAL_IRDA_STATE_BUSY_RX = 0x22, /*!< Data Reception process is ongoing */ HAL_IRDA_STATE_BUSY_TX_RX = 0x32, /*!< Data Transmission and Reception process is ongoing */ HAL_IRDA_STATE_TIMEOUT = 0x03, /*!< Timeout state */ HAL_IRDA_STATE_ERROR = 0x04 /*!< Error */ }HAL_IRDA_StateTypeDef; /** * @brief HAL IRDA Error Code structure definition */ typedef enum { HAL_IRDA_ERROR_NONE = 0x00, /*!< No error */ HAL_IRDA_ERROR_PE = 0x01, /*!< Parity error */ HAL_IRDA_ERROR_NE = 0x02, /*!< Noise error */ HAL_IRDA_ERROR_FE = 0x04, /*!< frame error */ HAL_IRDA_ERROR_ORE = 0x08, /*!< Overrun error */ HAL_IRDA_ERROR_DMA = 0x10 /*!< DMA transfer error */ }HAL_IRDA_ErrorTypeDef; /** * @brief IRDA clock sources definition */ typedef enum { IRDA_CLOCKSOURCE_PCLK1 = 0x00, /*!< PCLK1 clock source */ IRDA_CLOCKSOURCE_PCLK2 = 0x01, /*!< PCLK2 clock source */ IRDA_CLOCKSOURCE_HSI = 0x02, /*!< HSI clock source */ IRDA_CLOCKSOURCE_SYSCLK = 0x04, /*!< SYSCLK clock source */ IRDA_CLOCKSOURCE_LSE = 0x08, /*!< LSE clock source */ IRDA_CLOCKSOURCE_UNDEFINED = 0x10 /*!< Undefined clock source */ }IRDA_ClockSourceTypeDef; /** * @brief IRDA handle Structure definition */ typedef struct { USART_TypeDef *Instance; /* USART registers base address */ IRDA_InitTypeDef Init; /* IRDA communication parameters */ uint8_t *pTxBuffPtr; /* Pointer to IRDA Tx transfer Buffer */ uint16_t TxXferSize; /* IRDA Tx Transfer size */ uint16_t TxXferCount; /* IRDA Tx Transfer Counter */ uint8_t *pRxBuffPtr; /* Pointer to IRDA Rx transfer Buffer */ uint16_t RxXferSize; /* IRDA Rx Transfer size */ uint16_t RxXferCount; /* IRDA Rx Transfer Counter */ uint16_t Mask; /* USART RX RDR register mask */ DMA_HandleTypeDef *hdmatx; /* IRDA Tx DMA Handle parameters */ DMA_HandleTypeDef *hdmarx; /* IRDA Rx DMA Handle parameters */ HAL_LockTypeDef Lock; /* Locking object */ HAL_IRDA_StateTypeDef State; /* IRDA communication state */ HAL_IRDA_ErrorTypeDef ErrorCode; /* IRDA Error code */ }IRDA_HandleTypeDef; /** * @brief IRDA Configuration enumeration values definition */ typedef enum { IRDA_BAUDRATE = 0x00, IRDA_PARITY = 0x01, IRDA_WORDLENGTH = 0x02, IRDA_MODE = 0x03, IRDA_PRESCALER = 0x04, IRDA_POWERMODE = 0x05 }IRDA_ControlTypeDef; /** * @} */ /* Exported constants --------------------------------------------------------*/ /** @defgroup IRDA_Exported_Constants IRDA Exported Constants * @{ */ /** @defgroup IRDA_Parity IRDA Parity * @{ */ #define IRDA_PARITY_NONE ((uint16_t)0x0000) #define IRDA_PARITY_EVEN ((uint16_t)USART_CR1_PCE) #define IRDA_PARITY_ODD ((uint16_t)(USART_CR1_PCE | USART_CR1_PS)) #define IS_IRDA_PARITY(PARITY) (((PARITY) == IRDA_PARITY_NONE) || \ ((PARITY) == IRDA_PARITY_EVEN) || \ ((PARITY) == IRDA_PARITY_ODD)) /** * @} */ /** @defgroup IRDA_Transfer_Mode IRDA Transfer Mode * @{ */ #define IRDA_MODE_RX ((uint16_t)USART_CR1_RE) #define IRDA_MODE_TX ((uint16_t)USART_CR1_TE) #define IRDA_MODE_TX_RX ((uint16_t)(USART_CR1_TE |USART_CR1_RE)) #define IS_IRDA_TX_RX_MODE(MODE) ((((MODE) & (~((uint16_t)(IRDA_MODE_TX_RX)))) == (uint16_t)0x00) && ((MODE) != (uint16_t)0x00)) /** * @} */ /** @defgroup IRDA_Low_Power IRDA Low Power * @{ */ #define IRDA_POWERMODE_NORMAL ((uint16_t)0x0000) #define IRDA_POWERMODE_LOWPOWER ((uint16_t)USART_CR3_IRLP) #define IS_IRDA_POWERMODE(MODE) (((MODE) == IRDA_POWERMODE_LOWPOWER) || \ ((MODE) == IRDA_POWERMODE_NORMAL)) /** * @} */ /** @defgroup IRDA_State IRDA State * @{ */ #define IRDA_STATE_DISABLE ((uint16_t)0x0000) #define IRDA_STATE_ENABLE ((uint16_t)USART_CR1_UE) #define IS_IRDA_STATE(STATE) (((STATE) == IRDA_STATE_DISABLE) || \ ((STATE) == IRDA_STATE_ENABLE)) /** * @} */ /** @defgroup IRDA_Mode IRDA Mode * @{ */ #define IRDA_MODE_DISABLE ((uint16_t)0x0000) #define IRDA_MODE_ENABLE ((uint16_t)USART_CR3_IREN) #define IS_IRDA_MODE(STATE) (((STATE) == IRDA_MODE_DISABLE) || \ ((STATE) == IRDA_MODE_ENABLE)) /** * @} */ /** @defgroup IRDA_One_Bit IRDA One Bit Sampling * @{ */ #define IRDA_ONE_BIT_SAMPLE_DISABLED ((uint16_t)0x00000000) #define IRDA_ONE_BIT_SAMPLE_ENABLED ((uint16_t)USART_CR3_ONEBIT) #define IS_IRDA_ONEBIT_SAMPLE(ONEBIT) (((ONEBIT) == IRDA_ONE_BIT_SAMPLE_DISABLED) || \ ((ONEBIT) == IRDA_ONE_BIT_SAMPLE_ENABLED)) /** * @} */ /** @defgroup IRDA_DMA_Tx IRDA DMA Tx * @{ */ #define IRDA_DMA_TX_DISABLE ((uint16_t)0x00000000) #define IRDA_DMA_TX_ENABLE ((uint16_t)USART_CR3_DMAT) #define IS_IRDA_DMA_TX(DMATX) (((DMATX) == IRDA_DMA_TX_DISABLE) || \ ((DMATX) == IRDA_DMA_TX_ENABLE)) /** * @} */ /** @defgroup IRDA_DMA_Rx IRDA DMA Rx * @{ */ #define IRDA_DMA_RX_DISABLE ((uint16_t)0x0000) #define IRDA_DMA_RX_ENABLE ((uint16_t)USART_CR3_DMAR) #define IS_IRDA_DMA_RX(DMARX) (((DMARX) == IRDA_DMA_RX_DISABLE) || \ ((DMARX) == IRDA_DMA_RX_ENABLE)) /** * @} */ /** @defgroup IRDA_Flags IRDA Flags * Elements values convention: 0xXXXX * - 0xXXXX : Flag mask in the ISR register * @{ */ #define IRDA_FLAG_REACK ((uint32_t)0x00400000) #define IRDA_FLAG_TEACK ((uint32_t)0x00200000) #define IRDA_FLAG_BUSY ((uint32_t)0x00010000) #define IRDA_FLAG_ABRF ((uint32_t)0x00008000) #define IRDA_FLAG_ABRE ((uint32_t)0x00004000) #define IRDA_FLAG_TXE ((uint32_t)0x00000080) #define IRDA_FLAG_TC ((uint32_t)0x00000040) #define IRDA_FLAG_RXNE ((uint32_t)0x00000020) #define IRDA_FLAG_ORE ((uint32_t)0x00000008) #define IRDA_FLAG_NE ((uint32_t)0x00000004) #define IRDA_FLAG_FE ((uint32_t)0x00000002) #define IRDA_FLAG_PE ((uint32_t)0x00000001) /** * @} */ /** @defgroup IRDA_Interrupt_definition IRDA Interrupts Definition * Elements values convention: 0000ZZZZ0XXYYYYYb * - YYYYY : Interrupt source position in the XX register (5bits) * - XX : Interrupt source register (2bits) * - 01: CR1 register * - 10: CR2 register * - 11: CR3 register * - ZZZZ : Flag position in the ISR register(4bits) * @{ */ #define IRDA_IT_PE ((uint16_t)0x0028) #define IRDA_IT_TXE ((uint16_t)0x0727) #define IRDA_IT_TC ((uint16_t)0x0626) #define IRDA_IT_RXNE ((uint16_t)0x0525) #define IRDA_IT_IDLE ((uint16_t)0x0424) /** Elements values convention: 000000000XXYYYYYb * - YYYYY : Interrupt source position in the XX register (5bits) * - XX : Interrupt source register (2bits) * - 01: CR1 register * - 10: CR2 register * - 11: CR3 register */ #define IRDA_IT_ERR ((uint16_t)0x0060) /** Elements values convention: 0000ZZZZ00000000b * - ZZZZ : Flag position in the ISR register(4bits) */ #define IRDA_IT_ORE ((uint16_t)0x0300) #define IRDA_IT_NE ((uint16_t)0x0200) #define IRDA_IT_FE ((uint16_t)0x0100) /** * @} */ /** @defgroup IRDA_IT_CLEAR_Flags IRDA Interruption Clear Flags * @{ */ #define IRDA_CLEAR_PEF USART_ICR_PECF /*!< Parity Error Clear Flag */ #define IRDA_CLEAR_FEF USART_ICR_FECF /*!< Framing Error Clear Flag */ #define IRDA_CLEAR_NEF USART_ICR_NCF /*!< Noise detected Clear Flag */ #define IRDA_CLEAR_OREF USART_ICR_ORECF /*!< OverRun Error Clear Flag */ #define IRDA_CLEAR_TCF USART_ICR_TCCF /*!< Transmission Complete Clear Flag */ /** * @} */ /** @defgroup IRDA_Request_Parameters IRDA Request Parameters * @{ */ #define IRDA_AUTOBAUD_REQUEST ((uint16_t)USART_RQR_ABRRQ) /*!< Auto-Baud Rate Request */ #define IRDA_RXDATA_FLUSH_REQUEST ((uint16_t)USART_RQR_RXFRQ) /*!< Receive Data flush Request */ #define IRDA_TXDATA_FLUSH_REQUEST ((uint16_t)USART_RQR_TXFRQ) /*!< Transmit data flush Request */ #define IS_IRDA_REQUEST_PARAMETER(PARAM) (((PARAM) == IRDA_AUTOBAUD_REQUEST) || \ ((PARAM) == IRDA_SENDBREAK_REQUEST) || \ ((PARAM) == IRDA_MUTE_MODE_REQUEST) || \ ((PARAM) == IRDA_RXDATA_FLUSH_REQUEST) || \ ((PARAM) == IRDA_TXDATA_FLUSH_REQUEST)) /** * @} */ /** @defgroup IRDA_Interruption_Mask IRDA interruptions flag mask * @{ */ #define IRDA_IT_MASK ((uint16_t)0x001F) /** * @} */ /** * @} */ /* Exported macros -----------------------------------------------------------*/ /** @defgroup IRDA_Exported_Macros IRDA Exported Macros * @{ */ /** @brief Reset IRDA handle state * @param __HANDLE__: IRDA handle. * @retval None */ #define __HAL_IRDA_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_IRDA_STATE_RESET) /** @brief Checks whether the specified IRDA flag is set or not. * @param __HANDLE__: specifies the IRDA Handle. * The Handle Instance can be UARTx where x: 1, 2, 3, 4, 5 to select the USART or * UART peripheral * @param __FLAG__: specifies the flag to check. * This parameter can be one of the following values: * @arg IRDA_FLAG_REACK: Receive enable ackowledge flag * @arg IRDA_FLAG_TEACK: Transmit enable ackowledge flag * @arg IRDA_FLAG_BUSY: Busy flag * @arg IRDA_FLAG_ABRF: Auto Baud rate detection flag * @arg IRDA_FLAG_ABRE: Auto Baud rate detection error flag * @arg IRDA_FLAG_TXE: Transmit data register empty flag * @arg IRDA_FLAG_TC: Transmission Complete flag * @arg IRDA_FLAG_RXNE: Receive data register not empty flag * @arg IRDA_FLAG_IDLE: Idle Line detection flag * @arg IRDA_FLAG_ORE: OverRun Error flag * @arg IRDA_FLAG_NE: Noise Error flag * @arg IRDA_FLAG_FE: Framing Error flag * @arg IRDA_FLAG_PE: Parity Error flag * @retval The new state of __FLAG__ (TRUE or FALSE). */ #define __HAL_IRDA_GET_FLAG(__HANDLE__, __FLAG__) (((__HANDLE__)->Instance->ISR & (__FLAG__)) == (__FLAG__)) /** @brief Enables the specified IRDA interrupt. * @param __HANDLE__: specifies the IRDA Handle. * The Handle Instance can be UARTx where x: 1, 2, 3, 4, 5 to select the USART or * UART peripheral * @param __INTERRUPT__: specifies the IRDA interrupt source to enable. * This parameter can be one of the following values: * @arg IRDA_IT_TXE: Transmit Data Register empty interrupt * @arg IRDA_IT_TC: Transmission complete interrupt * @arg IRDA_IT_RXNE: Receive Data register not empty interrupt * @arg IRDA_IT_IDLE: Idle line detection interrupt * @arg IRDA_IT_PE: Parity Error interrupt * @arg IRDA_IT_ERR: Error interrupt(Frame error, noise error, overrun error) * @retval None */ #define __HAL_IRDA_ENABLE_IT(__HANDLE__, __INTERRUPT__) (((((uint8_t)(__INTERRUPT__)) >> 5U) == 1)? ((__HANDLE__)->Instance->CR1 |= (1U << ((__INTERRUPT__) & IRDA_IT_MASK))): \ ((((uint8_t)(__INTERRUPT__)) >> 5U) == 2)? ((__HANDLE__)->Instance->CR2 |= (1U << ((__INTERRUPT__) & IRDA_IT_MASK))): \ ((__HANDLE__)->Instance->CR3 |= (1U << ((__INTERRUPT__) & IRDA_IT_MASK)))) /** @brief Disables the specified IRDA interrupt. * @param __HANDLE__: specifies the IRDA Handle. * The Handle Instance can be UARTx where x: 1, 2, 3, 4, 5 to select the USART or * UART peripheral * @param __INTERRUPT__: specifies the IRDA interrupt source to disable. * This parameter can be one of the following values: * @arg IRDA_IT_TXE: Transmit Data Register empty interrupt * @arg IRDA_IT_TC: Transmission complete interrupt * @arg IRDA_IT_RXNE: Receive Data register not empty interrupt * @arg IRDA_IT_IDLE: Idle line detection interrupt * @arg IRDA_IT_PE: Parity Error interrupt * @arg IRDA_IT_ERR: Error interrupt(Frame error, noise error, overrun error) * @retval None */ #define __HAL_IRDA_DISABLE_IT(__HANDLE__, __INTERRUPT__) (((((uint8_t)(__INTERRUPT__)) >> 5U) == 1)? ((__HANDLE__)->Instance->CR1 &= ~ (1U << ((__INTERRUPT__) & IRDA_IT_MASK))): \ ((((uint8_t)(__INTERRUPT__)) >> 5U) == 2)? ((__HANDLE__)->Instance->CR2 &= ~ (1U << ((__INTERRUPT__) & IRDA_IT_MASK))): \ ((__HANDLE__)->Instance->CR3 &= ~ (1U << ((__INTERRUPT__) & IRDA_IT_MASK)))) /** @brief Checks whether the specified IRDA interrupt has occurred or not. * @param __HANDLE__: specifies the IRDA Handle. * The Handle Instance can be UARTx where x: 1, 2, 3, 4, 5 to select the USART or * UART peripheral * @param __IT__: specifies the IRDA interrupt source to check. * This parameter can be one of the following values: * @arg IRDA_IT_TXE: Transmit Data Register empty interrupt * @arg IRDA_IT_TC: Transmission complete interrupt * @arg IRDA_IT_RXNE: Receive Data register not empty interrupt * @arg IRDA_IT_IDLE: Idle line detection interrupt * @arg IRDA_IT_ORE: OverRun Error interrupt * @arg IRDA_IT_NE: Noise Error interrupt * @arg IRDA_IT_FE: Framing Error interrupt * @arg IRDA_IT_PE: Parity Error interrupt * @retval The new state of __IT__ (TRUE or FALSE). */ #define __HAL_IRDA_GET_IT(__HANDLE__, __IT__) ((__HANDLE__)->Instance->ISR & ((uint32_t)1U << ((__IT__)>> 0x08))) /** @brief Checks whether the specified IRDA interrupt source is enabled. * @param __HANDLE__: specifies the IRDA Handle. * The Handle Instance can be UARTx where x: 1, 2, 3, 4, 5 to select the USART or * UART peripheral * @param __IT__: specifies the IRDA interrupt source to check. * This parameter can be one of the following values: * @arg IRDA_IT_TXE: Transmit Data Register empty interrupt * @arg IRDA_IT_TC: Transmission complete interrupt * @arg IRDA_IT_RXNE: Receive Data register not empty interrupt * @arg IRDA_IT_IDLE: Idle line detection interrupt * @arg IRDA_IT_ORE: OverRun Error interrupt * @arg IRDA_IT_NE: Noise Error interrupt * @arg IRDA_IT_FE: Framing Error interrupt * @arg IRDA_IT_PE: Parity Error interrupt * @retval The new state of __IT__ (TRUE or FALSE). */ #define __HAL_IRDA_GET_IT_SOURCE(__HANDLE__, __IT__) ((((((uint8_t)(__IT__)) >> 5U) == 1)? (__HANDLE__)->Instance->CR1:(((((uint8_t)(__IT__)) >> 5U) == 2)? \ (__HANDLE__)->Instance->CR2 : (__HANDLE__)->Instance->CR3)) & ((uint32_t)1 << (((uint16_t)(__IT__)) & IRDA_IT_MASK))) /** @brief Clears the specified IRDA ISR flag, in setting the proper ICR register flag. * @param __HANDLE__: specifies the IRDA Handle. * The Handle Instance can be UARTx where x: 1, 2, 3, 4, 5 to select the USART or * UART peripheral * @param __IT_CLEAR__: specifies the interrupt clear register flag that needs to be set * to clear the corresponding interrupt * This parameter can be one of the following values: * @arg IRDA_CLEAR_PEF: Parity Error Clear Flag * @arg IRDA_CLEAR_FEF: Framing Error Clear Flag * @arg IRDA_CLEAR_NEF: Noise detected Clear Flag * @arg IRDA_CLEAR_OREF: OverRun Error Clear Flag * @arg IRDA_CLEAR_TCF: Transmission Complete Clear Flag * @retval None */ #define __HAL_IRDA_CLEAR_IT(__HANDLE__, __IT_CLEAR__) ((__HANDLE__)->Instance->ICR = (uint32_t)(__IT_CLEAR__)) /** @brief Set a specific IRDA request flag. * @param __HANDLE__: specifies the IRDA Handle. * The Handle Instance can be UARTx where x: 1, 2, 3, 4, 5 to select the USART or * UART peripheral * @param __REQ__: specifies the request flag to set * This parameter can be one of the following values: * @arg IRDA_AUTOBAUD_REQUEST: Auto-Baud Rate Request * @arg IRDA_RXDATA_FLUSH_REQUEST: Receive Data flush Request * @arg IRDA_TXDATA_FLUSH_REQUEST: Transmit data flush Request * * @retval None */ #define __HAL_IRDA_SEND_REQ(__HANDLE__, __REQ__) ((__HANDLE__)->Instance->RQR |= (uint16_t)(__REQ__)) /** @brief Enable UART/USART associated to IRDA Handle * @param __HANDLE__: specifies the IRDA Handle. * The Handle Instance can be UARTx where x: 1, 2, 3, 4, 5 to select the USART or * UART peripheral * @retval None */ #define __HAL_IRDA_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->CR1 |= USART_CR1_UE) /** @brief Disable UART/USART associated to IRDA Handle * @param __HANDLE__: specifies the IRDA Handle. * The Handle Instance can be UARTx where x: 1, 2, 3, 4, 5 to select the USART or * UART peripheral * @retval None */ #define __HAL_IRDA_DISABLE(__HANDLE__) ((__HANDLE__)->Instance->CR1 &= ~USART_CR1_UE) /** @brief Ensure that IRDA Baud rate is less or equal to maximum value * @param __BAUDRATE__: specifies the IRDA Baudrate set by the user. * @retval True or False */ #define IS_IRDA_BAUDRATE(__BAUDRATE__) ((__BAUDRATE__) < 115201) /** @brief Ensure that IRDA prescaler value is strictly larger than 0 * @param __PRESCALER__: specifies the IRDA prescaler value set by the user. * @retval True or False */ #define IS_IRDA_PRESCALER(__PRESCALER__) ((__PRESCALER__) > 0) /** * @} */ /* Include IRDA HAL Extended module */ #include "stm32f3xx_hal_irda_ex.h" /* Exported functions --------------------------------------------------------*/ /** @addtogroup IRDA_Exported_Functions IRDA Exported Functions * @{ */ /** @addtogroup IRDA_Exported_Functions_Group1 Initialization and de-initialization functions * @{ */ /* Initialization and de-initialization functions ****************************/ HAL_StatusTypeDef HAL_IRDA_Init(IRDA_HandleTypeDef *hirda); HAL_StatusTypeDef HAL_IRDA_DeInit(IRDA_HandleTypeDef *hirda); void HAL_IRDA_MspInit(IRDA_HandleTypeDef *hirda); void HAL_IRDA_MspDeInit(IRDA_HandleTypeDef *hirda); /** * @} */ /** @addtogroup IRDA_Exported_Functions_Group2 Input and Output operation functions * @{ */ /* IO operation functions *****************************************************/ HAL_StatusTypeDef HAL_IRDA_Transmit(IRDA_HandleTypeDef *hirda, uint8_t *pData, uint16_t Size, uint32_t Timeout); HAL_StatusTypeDef HAL_IRDA_Receive(IRDA_HandleTypeDef *hirda, uint8_t *pData, uint16_t Size, uint32_t Timeout); HAL_StatusTypeDef HAL_IRDA_Transmit_IT(IRDA_HandleTypeDef *hirda, uint8_t *pData, uint16_t Size); HAL_StatusTypeDef HAL_IRDA_Receive_IT(IRDA_HandleTypeDef *hirda, uint8_t *pData, uint16_t Size); HAL_StatusTypeDef HAL_IRDA_Transmit_DMA(IRDA_HandleTypeDef *hirda, uint8_t *pData, uint16_t Size); HAL_StatusTypeDef HAL_IRDA_Receive_DMA(IRDA_HandleTypeDef *hirda, uint8_t *pData, uint16_t Size); void HAL_IRDA_IRQHandler(IRDA_HandleTypeDef *hirda); void HAL_IRDA_TxCpltCallback(IRDA_HandleTypeDef *hirda); void HAL_IRDA_RxCpltCallback(IRDA_HandleTypeDef *hirda); void HAL_IRDA_ErrorCallback(IRDA_HandleTypeDef *hirda); /** * @} */ /** @addtogroup IRDA_Exported_Functions_Group3 Peripheral State and Errors functions * @{ */ /* Peripheral State and Error functions ***************************************/ HAL_IRDA_StateTypeDef HAL_IRDA_GetState(IRDA_HandleTypeDef *hirda); uint32_t HAL_IRDA_GetError(IRDA_HandleTypeDef *hirda); /** * @} */ /** * @} */ /** * @} */ /** * @} */ #ifdef __cplusplus } #endif #endif /* __STM32F3xx_HAL_IRDA_H */ /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/