stm32f4xx_hal_irda.c File Reference

IRDA HAL module driver. This file provides firmware functions to manage the following functionalities of the IrDA SIR ENDEC block (IrDA): + Initialization and de-initialization methods + IO operation methods + Peripheral Control methods. More...

#include "stm32f4xx_hal.h"

Go to the source code of this file.

Functions
static void	IRDA_SetConfig (IRDA_HandleTypeDef *hirda)
	Configures the IRDA peripheral.
static HAL_StatusTypeDef	IRDA_Transmit_IT (IRDA_HandleTypeDef *hirda)
	Send an amount of data in non blocking mode.
static HAL_StatusTypeDef	IRDA_EndTransmit_IT (IRDA_HandleTypeDef *hirda)
	Wraps up transmission in non blocking mode.
static HAL_StatusTypeDef	IRDA_Receive_IT (IRDA_HandleTypeDef *hirda)
	Receives an amount of data in non blocking mode.
static void	IRDA_DMATransmitCplt (DMA_HandleTypeDef *hdma)
	DMA IRDA transmit process complete callback.
static void	IRDA_DMATransmitHalfCplt (DMA_HandleTypeDef *hdma)
	DMA IRDA receive process half complete callback.
static void	IRDA_DMAReceiveCplt (DMA_HandleTypeDef *hdma)
	DMA IRDA receive process complete callback.
static void	IRDA_DMAReceiveHalfCplt (DMA_HandleTypeDef *hdma)
	DMA IRDA receive process half complete callback.
static void	IRDA_DMAError (DMA_HandleTypeDef *hdma)
	DMA IRDA communication error callback.
static void	IRDA_DMAAbortOnError (DMA_HandleTypeDef *hdma)
	DMA IRDA communication abort callback, when initiated by HAL services on Error (To be called at end of DMA Abort procedure following error occurrence).
static void	IRDA_DMATxAbortCallback (DMA_HandleTypeDef *hdma)
	DMA IRDA Tx communication abort callback, when initiated by user (To be called at end of DMA Tx Abort procedure following user abort request).
static void	IRDA_DMARxAbortCallback (DMA_HandleTypeDef *hdma)
	DMA IRDA Rx communication abort callback, when initiated by user (To be called at end of DMA Rx Abort procedure following user abort request).
static void	IRDA_DMATxOnlyAbortCallback (DMA_HandleTypeDef *hdma)
	DMA IRDA Tx communication abort callback, when initiated by user by a call to HAL_IRDA_AbortTransmit_IT API (Abort only Tx transfer) (This callback is executed at end of DMA Tx Abort procedure following user abort request, and leads to user Tx Abort Complete callback execution).
static void	IRDA_DMARxOnlyAbortCallback (DMA_HandleTypeDef *hdma)
	DMA IRDA Rx communication abort callback, when initiated by user by a call to HAL_IRDA_AbortReceive_IT API (Abort only Rx transfer) (This callback is executed at end of DMA Rx Abort procedure following user abort request, and leads to user Rx Abort Complete callback execution).
static HAL_StatusTypeDef	IRDA_WaitOnFlagUntilTimeout (IRDA_HandleTypeDef *hirda, uint32_t Flag, FlagStatus Status, uint32_t Tickstart, uint32_t Timeout)
	This function handles IRDA Communication Timeout.
static void	IRDA_EndTxTransfer (IRDA_HandleTypeDef *hirda)
	End ongoing Tx transfer on IRDA peripheral (following error detection or Transmit completion).
static void	IRDA_EndRxTransfer (IRDA_HandleTypeDef *hirda)
	End ongoing Rx transfer on IRDA peripheral (following error detection or Reception completion).
HAL_StatusTypeDef	HAL_IRDA_Init (IRDA_HandleTypeDef *hirda)
	Initializes the IRDA mode according to the specified parameters in the IRDA_InitTypeDef and create the associated handle.
HAL_StatusTypeDef	HAL_IRDA_DeInit (IRDA_HandleTypeDef *hirda)
	DeInitializes the IRDA peripheral.
__weak void	HAL_IRDA_MspInit (IRDA_HandleTypeDef *hirda)
	IRDA MSP Init.
__weak void	HAL_IRDA_MspDeInit (IRDA_HandleTypeDef *hirda)
	IRDA MSP DeInit.
HAL_StatusTypeDef	HAL_IRDA_Transmit (IRDA_HandleTypeDef *hirda, uint8_t *pData, uint16_t Size, uint32_t Timeout)
	Sends an amount of data in blocking mode.
HAL_StatusTypeDef	HAL_IRDA_Receive (IRDA_HandleTypeDef *hirda, uint8_t *pData, uint16_t Size, uint32_t Timeout)
	Receive an amount of data in blocking mode.
HAL_StatusTypeDef	HAL_IRDA_Transmit_IT (IRDA_HandleTypeDef *hirda, uint8_t *pData, uint16_t Size)
	Send an amount of data in non blocking mode.
HAL_StatusTypeDef	HAL_IRDA_Receive_IT (IRDA_HandleTypeDef *hirda, uint8_t *pData, uint16_t Size)
	Receives an amount of data in non blocking mode.
HAL_StatusTypeDef	HAL_IRDA_Transmit_DMA (IRDA_HandleTypeDef *hirda, uint8_t *pData, uint16_t Size)
	Sends an amount of data in non blocking mode.
HAL_StatusTypeDef	HAL_IRDA_Receive_DMA (IRDA_HandleTypeDef *hirda, uint8_t *pData, uint16_t Size)
	Receives an amount of data in non blocking mode.
HAL_StatusTypeDef	HAL_IRDA_DMAPause (IRDA_HandleTypeDef *hirda)
	Pauses the DMA Transfer.
HAL_StatusTypeDef	HAL_IRDA_DMAResume (IRDA_HandleTypeDef *hirda)
	Resumes the DMA Transfer.
HAL_StatusTypeDef	HAL_IRDA_DMAStop (IRDA_HandleTypeDef *hirda)
	Stops the DMA Transfer.
HAL_StatusTypeDef	HAL_IRDA_Abort (IRDA_HandleTypeDef *hirda)
	Abort ongoing transfers (blocking mode).
HAL_StatusTypeDef	HAL_IRDA_AbortTransmit (IRDA_HandleTypeDef *hirda)
	Abort ongoing Transmit transfer (blocking mode).
HAL_StatusTypeDef	HAL_IRDA_AbortReceive (IRDA_HandleTypeDef *hirda)
	Abort ongoing Receive transfer (blocking mode).
HAL_StatusTypeDef	HAL_IRDA_Abort_IT (IRDA_HandleTypeDef *hirda)
	Abort ongoing transfers (Interrupt mode).
HAL_StatusTypeDef	HAL_IRDA_AbortTransmit_IT (IRDA_HandleTypeDef *hirda)
	Abort ongoing Transmit transfer (Interrupt mode).
HAL_StatusTypeDef	HAL_IRDA_AbortReceive_IT (IRDA_HandleTypeDef *hirda)
	Abort ongoing Receive transfer (Interrupt mode).
void	HAL_IRDA_IRQHandler (IRDA_HandleTypeDef *hirda)
	This function handles IRDA interrupt request.
__weak void	HAL_IRDA_TxCpltCallback (IRDA_HandleTypeDef *hirda)
	Tx Transfer complete callbacks.
__weak void	HAL_IRDA_TxHalfCpltCallback (IRDA_HandleTypeDef *hirda)
	Tx Half Transfer completed callbacks.
__weak void	HAL_IRDA_RxCpltCallback (IRDA_HandleTypeDef *hirda)
	Rx Transfer complete callbacks.
__weak void	HAL_IRDA_RxHalfCpltCallback (IRDA_HandleTypeDef *hirda)
	Rx Half Transfer complete callbacks.
__weak void	HAL_IRDA_ErrorCallback (IRDA_HandleTypeDef *hirda)
	IRDA error callbacks.
__weak void	HAL_IRDA_AbortCpltCallback (IRDA_HandleTypeDef *hirda)
	IRDA Abort Complete callback.
__weak void	HAL_IRDA_AbortTransmitCpltCallback (IRDA_HandleTypeDef *hirda)
	IRDA Abort Transmit Complete callback.
__weak void	HAL_IRDA_AbortReceiveCpltCallback (IRDA_HandleTypeDef *hirda)
	IRDA Abort ReceiveComplete callback.
HAL_IRDA_StateTypeDef	HAL_IRDA_GetState (IRDA_HandleTypeDef *hirda)
	Returns the IRDA state.
uint32_t	HAL_IRDA_GetError (IRDA_HandleTypeDef *hirda)
	Return the IARDA error code.

---

Detailed Description

IRDA HAL module driver. This file provides firmware functions to manage the following functionalities of the IrDA SIR ENDEC block (IrDA): + Initialization and de-initialization methods + IO operation methods + Peripheral Control methods.

Author:

MCD Application Team

  ==============================================================================
                        ##### How to use this driver #####
  ==============================================================================
  [..]
    The IRDA HAL driver can be used as follows:
    
    (#) Declare a IRDA_HandleTypeDef handle structure.
    (#) Initialize the IRDA low level resources by implementing the HAL_IRDA_MspInit() API:
        (##) Enable the USARTx interface clock.
        (##) IRDA pins configuration:
            (+++) Enable the clock for the IRDA GPIOs.
            (+++) Configure these IRDA pins as alternate function pull-up.
        (##) NVIC configuration if you need to use interrupt process (HAL_IRDA_Transmit_IT()
             and HAL_IRDA_Receive_IT() APIs):
            (+++) Configure the USARTx interrupt priority.
            (+++) Enable the NVIC USART IRQ handle.
        (##) DMA Configuration if you need to use DMA process (HAL_IRDA_Transmit_DMA()
             and HAL_IRDA_Receive_DMA() APIs):
            (+++) Declare a DMA handle structure for the Tx/Rx stream.
            (+++) Enable the DMAx interface clock.
            (+++) Configure the declared DMA handle structure with the required Tx/Rx parameters.                
            (+++) Configure the DMA Tx/Rx Stream.
            (+++) Associate the initialized DMA handle to the IRDA DMA Tx/Rx handle.
            (+++) Configure the priority and enable the NVIC for the transfer complete interrupt on the DMA Tx/Rx Stream.

    (#) Program the Baud Rate, Word Length, Parity, IrDA Mode, Prescaler 
        and Mode(Receiver/Transmitter) in the hirda Init structure.

    (#) Initialize the IRDA registers by calling the HAL_IRDA_Init() API:
        (++) This API configures also the low level Hardware GPIO, CLOCK, CORTEX...etc)
            by calling the customized HAL_IRDA_MspInit() API.
    -@@- The specific IRDA interrupts (Transmission complete interrupt, 
        RXNE interrupt and Error Interrupts) will be managed using the macros
        __HAL_IRDA_ENABLE_IT() and __HAL_IRDA_DISABLE_IT() inside the transmit and receive process.
        
    (#) Three operation modes are available within this driver :
             
    *** Polling mode IO operation ***
    =================================
    [..]    
      (+) Send an amount of data in blocking mode using HAL_IRDA_Transmit() 
      (+) Receive an amount of data in blocking mode using HAL_IRDA_Receive()
       
    *** Interrupt mode IO operation ***    
    ===================================
    [..]    
      (+) Send an amount of data in non blocking mode using HAL_IRDA_Transmit_IT() 
      (+) At transmission end of transfer HAL_IRDA_TxCpltCallback is executed and user can 
           add his own code by customization of function pointer HAL_IRDA_TxCpltCallback
      (+) Receive an amount of data in non blocking mode using HAL_IRDA_Receive_IT() 
      (+) At reception end of transfer HAL_IRDA_RxCpltCallback is executed and user can 
           add his own code by customization of function pointer HAL_IRDA_RxCpltCallback                                      
      (+) In case of transfer Error, HAL_IRDA_ErrorCallback() function is executed and user can 
           add his own code by customization of function pointer HAL_IRDA_ErrorCallback

    *** DMA mode IO operation ***    
    =============================
    [..]
      (+) Send an amount of data in non blocking mode (DMA) using HAL_IRDA_Transmit_DMA() 
      (+) At transmission end of transfer HAL_IRDA_TxCpltCallback is executed and user can 
           add his own code by customization of function pointer HAL_IRDA_TxCpltCallback
      (+) Receive an amount of data in non blocking mode (DMA) using HAL_IRDA_Receive_DMA() 
      (+) At reception end of transfer HAL_IRDA_RxCpltCallback is executed and user can 
           add his own code by customization of function pointer HAL_IRDA_RxCpltCallback                                      
      (+) In case of transfer Error, HAL_IRDA_ErrorCallback() function is executed and user can 
           add his own code by customization of function pointer HAL_IRDA_ErrorCallback    

    *** IRDA HAL driver macros list ***
    ===================================
    [..]
      Below the list of most used macros in IRDA HAL driver.
       
     (+) __HAL_IRDA_ENABLE: Enable the IRDA peripheral 
     (+) __HAL_IRDA_DISABLE: Disable the IRDA peripheral     
     (+) __HAL_IRDA_GET_FLAG : Checks whether the specified IRDA flag is set or not
     (+) __HAL_IRDA_CLEAR_FLAG : Clears the specified IRDA pending flag
     (+) __HAL_IRDA_ENABLE_IT: Enables the specified IRDA interrupt
     (+) __HAL_IRDA_DISABLE_IT: Disables the specified IRDA interrupt

    [..]
     (@) You can refer to the IRDA HAL driver header file for more useful macros

  

Attention:

© COPYRIGHT(c) 2017 STMicroelectronics

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.

Definition in file stm32f4xx_hal_irda.c.