STM32F4xx HAL Documentation
Hardware Abstraction Layer for STM32F4 familiy
Loading...
Searching...
No Matches
IRDA Private Functions
Collaboration diagram for IRDA Private Functions:

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. It waits until a flag is no longer in the specified status.
 
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).
 

Detailed Description

Function Documentation

◆ IRDA_SetConfig()

static void IRDA_SetConfig ( IRDA_HandleTypeDef * hirda)
static

#include <stm32f4xx_hal_irda.c>

Configures the IRDA peripheral.

Parameters
hirdaPointer to a IRDA_HandleTypeDef structure that contains the configuration information for the specified IRDA module.
Return values
None

Definition at line 2610 of file stm32f4xx_hal_irda.c.

References assert_param, IRDA_InitTypeDef::BaudRate, HAL_RCC_GetPCLK1Freq(), HAL_RCC_GetPCLK2Freq(), IRDA_HandleTypeDef::Init, IRDA_HandleTypeDef::Instance, IRDA_BRR, IRDA_InitTypeDef::IrDAMode, IS_IRDA_BAUDRATE, IS_IRDA_MODE, IS_IRDA_PARITY, IS_IRDA_POWERMODE, IS_IRDA_WORD_LENGTH, IRDA_InitTypeDef::Mode, IRDA_InitTypeDef::Parity, and IRDA_InitTypeDef::WordLength.

Referenced by HAL_IRDA_Init().

◆ IRDA_Transmit_IT()

static HAL_StatusTypeDef IRDA_Transmit_IT ( IRDA_HandleTypeDef * hirda)
static

#include <stm32f4xx_hal_irda.c>

Send an amount of data in non blocking mode.

Parameters
hirdaPointer to a IRDA_HandleTypeDef structure that contains the configuration information for the specified IRDA module.
Return values
HALstatus

Definition at line 2461 of file stm32f4xx_hal_irda.c.

References IRDA_HandleTypeDef::gState, HAL_BUSY, HAL_IRDA_STATE_BUSY_TX, HAL_OK, IRDA_HandleTypeDef::Init, IRDA_HandleTypeDef::Instance, IRDA_PARITY_NONE, IRDA_WORDLENGTH_9B, IRDA_InitTypeDef::Parity, IRDA_HandleTypeDef::pTxBuffPtr, IRDA_HandleTypeDef::TxXferCount, and IRDA_InitTypeDef::WordLength.

Referenced by HAL_IRDA_IRQHandler().

◆ IRDA_EndTransmit_IT()

static HAL_StatusTypeDef IRDA_EndTransmit_IT ( IRDA_HandleTypeDef * hirda)
static

#include <stm32f4xx_hal_irda.c>

Wraps up transmission in non blocking mode.

Parameters
hirdaPointer to a IRDA_HandleTypeDef structure that contains the configuration information for the specified IRDA module.
Return values
HALstatus

Definition at line 2509 of file stm32f4xx_hal_irda.c.

References IRDA_HandleTypeDef::gState, HAL_IRDA_STATE_READY, HAL_IRDA_TxCpltCallback(), HAL_OK, and IRDA_HandleTypeDef::Instance.

Referenced by HAL_IRDA_IRQHandler().

◆ IRDA_Receive_IT()

static HAL_StatusTypeDef IRDA_Receive_IT ( IRDA_HandleTypeDef * hirda)
static

#include <stm32f4xx_hal_irda.c>

Receives an amount of data in non blocking mode.

Parameters
hirdaPointer to a IRDA_HandleTypeDef structure that contains the configuration information for the specified IRDA module.
Return values
HALstatus

Definition at line 2537 of file stm32f4xx_hal_irda.c.

References HAL_BUSY, HAL_IRDA_RxCpltCallback(), HAL_IRDA_STATE_BUSY_RX, HAL_IRDA_STATE_READY, HAL_OK, IRDA_HandleTypeDef::Init, IRDA_HandleTypeDef::Instance, IRDA_PARITY_NONE, IRDA_WORDLENGTH_9B, IRDA_InitTypeDef::Parity, IRDA_HandleTypeDef::pRxBuffPtr, IRDA_HandleTypeDef::RxState, IRDA_HandleTypeDef::RxXferCount, and IRDA_InitTypeDef::WordLength.

Referenced by HAL_IRDA_IRQHandler().

◆ IRDA_DMATransmitCplt()

static void IRDA_DMATransmitCplt ( DMA_HandleTypeDef * hdma)
static

#include <stm32f4xx_hal_irda.c>

DMA IRDA transmit process complete callback.

Parameters
hdmaPointer to a DMA_HandleTypeDef structure that contains the configuration information for the specified DMA.
Return values
None

Definition at line 2085 of file stm32f4xx_hal_irda.c.

References HAL_IRDA_TxCpltCallback(), __DMA_HandleTypeDef::Instance, IRDA_HandleTypeDef::Instance, and IRDA_HandleTypeDef::TxXferCount.

Referenced by HAL_IRDA_Transmit_DMA().

◆ IRDA_DMATransmitHalfCplt()

static void IRDA_DMATransmitHalfCplt ( DMA_HandleTypeDef * hdma)
static

#include <stm32f4xx_hal_irda.c>

DMA IRDA receive process half complete callback.

Parameters
hdmaPointer to a DMA_HandleTypeDef structure that contains the configuration information for the specified DMA.
Return values
None

Definition at line 2119 of file stm32f4xx_hal_irda.c.

References HAL_IRDA_TxHalfCpltCallback().

Referenced by HAL_IRDA_Transmit_DMA().

◆ IRDA_DMAReceiveCplt()

static void IRDA_DMAReceiveCplt ( DMA_HandleTypeDef * hdma)
static

#include <stm32f4xx_hal_irda.c>

DMA IRDA receive process complete callback.

Parameters
hdmaPointer to a DMA_HandleTypeDef structure that contains the configuration information for the specified DMA.
Return values
None

Definition at line 2138 of file stm32f4xx_hal_irda.c.

References HAL_IRDA_RxCpltCallback(), HAL_IRDA_STATE_READY, __DMA_HandleTypeDef::Instance, IRDA_HandleTypeDef::Instance, IRDA_HandleTypeDef::RxState, and IRDA_HandleTypeDef::RxXferCount.

Referenced by HAL_IRDA_Receive_DMA().

◆ IRDA_DMAReceiveHalfCplt()

static void IRDA_DMAReceiveHalfCplt ( DMA_HandleTypeDef * hdma)
static

#include <stm32f4xx_hal_irda.c>

DMA IRDA receive process half complete callback.

Parameters
hdmaPointer to a DMA_HandleTypeDef structure that contains the configuration information for the specified DMA.
Return values
None

Definition at line 2174 of file stm32f4xx_hal_irda.c.

References HAL_IRDA_RxHalfCpltCallback().

Referenced by HAL_IRDA_Receive_DMA().

◆ IRDA_DMAError()

static void IRDA_DMAError ( DMA_HandleTypeDef * hdma)
static

#include <stm32f4xx_hal_irda.c>

DMA IRDA communication error callback.

Parameters
hdmaPointer to a DMA_HandleTypeDef structure that contains the configuration information for the specified DMA.
Return values
None

Definition at line 2193 of file stm32f4xx_hal_irda.c.

References IRDA_HandleTypeDef::ErrorCode, IRDA_HandleTypeDef::gState, HAL_IRDA_ERROR_DMA, HAL_IRDA_ErrorCallback(), HAL_IRDA_STATE_BUSY_RX, HAL_IRDA_STATE_BUSY_TX, HAL_IS_BIT_SET, IRDA_HandleTypeDef::Instance, IRDA_EndRxTransfer(), IRDA_EndTxTransfer(), IRDA_HandleTypeDef::RxState, IRDA_HandleTypeDef::RxXferCount, and IRDA_HandleTypeDef::TxXferCount.

Referenced by HAL_IRDA_Receive_DMA(), and HAL_IRDA_Transmit_DMA().

◆ IRDA_DMAAbortOnError()

static void IRDA_DMAAbortOnError ( DMA_HandleTypeDef * hdma)
static

#include <stm32f4xx_hal_irda.c>

DMA IRDA communication abort callback, when initiated by HAL services on Error (To be called at end of DMA Abort procedure following error occurrence).

Parameters
hdmaDMA handle.
Return values
None

Definition at line 2298 of file stm32f4xx_hal_irda.c.

References HAL_IRDA_ErrorCallback(), IRDA_HandleTypeDef::RxXferCount, and IRDA_HandleTypeDef::TxXferCount.

Referenced by HAL_IRDA_IRQHandler().

◆ IRDA_DMATxAbortCallback()

static void IRDA_DMATxAbortCallback ( DMA_HandleTypeDef * hdma)
static

#include <stm32f4xx_hal_irda.c>

DMA IRDA Tx communication abort callback, when initiated by user (To be called at end of DMA Tx Abort procedure following user abort request).

Note
When this callback is executed, User Abort complete call back is called only if no Abort still ongoing for Rx DMA Handle.
Parameters
hdmaDMA handle.
Return values
None

Definition at line 2321 of file stm32f4xx_hal_irda.c.

References IRDA_HandleTypeDef::ErrorCode, IRDA_HandleTypeDef::gState, HAL_IRDA_AbortCpltCallback(), HAL_IRDA_ERROR_NONE, HAL_IRDA_STATE_READY, IRDA_HandleTypeDef::hdmarx, IRDA_HandleTypeDef::hdmatx, IRDA_HandleTypeDef::RxState, IRDA_HandleTypeDef::RxXferCount, IRDA_HandleTypeDef::TxXferCount, and __DMA_HandleTypeDef::XferAbortCallback.

Referenced by HAL_IRDA_Abort_IT().

◆ IRDA_DMARxAbortCallback()

static void IRDA_DMARxAbortCallback ( DMA_HandleTypeDef * hdma)
static

#include <stm32f4xx_hal_irda.c>

DMA IRDA Rx communication abort callback, when initiated by user (To be called at end of DMA Rx Abort procedure following user abort request).

Note
When this callback is executed, User Abort complete call back is called only if no Abort still ongoing for Tx DMA Handle.
Parameters
hdmaDMA handle.
Return values
None

Definition at line 2365 of file stm32f4xx_hal_irda.c.

References IRDA_HandleTypeDef::ErrorCode, IRDA_HandleTypeDef::gState, HAL_IRDA_AbortCpltCallback(), HAL_IRDA_ERROR_NONE, HAL_IRDA_STATE_READY, IRDA_HandleTypeDef::hdmarx, IRDA_HandleTypeDef::hdmatx, IRDA_HandleTypeDef::RxState, IRDA_HandleTypeDef::RxXferCount, IRDA_HandleTypeDef::TxXferCount, and __DMA_HandleTypeDef::XferAbortCallback.

Referenced by HAL_IRDA_Abort_IT().

◆ IRDA_DMATxOnlyAbortCallback()

static void IRDA_DMATxOnlyAbortCallback ( DMA_HandleTypeDef * hdma)
static

#include <stm32f4xx_hal_irda.c>

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).

Parameters
hdmaDMA handle.
Return values
None

Definition at line 2409 of file stm32f4xx_hal_irda.c.

References IRDA_HandleTypeDef::gState, HAL_IRDA_AbortTransmitCpltCallback(), HAL_IRDA_STATE_READY, and IRDA_HandleTypeDef::TxXferCount.

Referenced by HAL_IRDA_AbortTransmit_IT().

◆ IRDA_DMARxOnlyAbortCallback()

static void IRDA_DMARxOnlyAbortCallback ( DMA_HandleTypeDef * hdma)
static

#include <stm32f4xx_hal_irda.c>

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).

Parameters
hdmaDMA handle.
Return values
None

Definition at line 2436 of file stm32f4xx_hal_irda.c.

References HAL_IRDA_AbortReceiveCpltCallback(), HAL_IRDA_STATE_READY, IRDA_HandleTypeDef::RxState, and IRDA_HandleTypeDef::RxXferCount.

Referenced by HAL_IRDA_AbortReceive_IT().

◆ IRDA_WaitOnFlagUntilTimeout()

static HAL_StatusTypeDef IRDA_WaitOnFlagUntilTimeout ( IRDA_HandleTypeDef * hirda,
uint32_t Flag,
FlagStatus Status,
uint32_t Tickstart,
uint32_t Timeout )
static

#include <stm32f4xx_hal_irda.c>

This function handles IRDA Communication Timeout. It waits until a flag is no longer in the specified status.

Parameters
hirdaPointer to a IRDA_HandleTypeDef structure that contains the configuration information for the specified IRDA.
Flagspecifies the IRDA flag to check.
StatusThe actual Flag status (SET or RESET).
TickstartTick start value
TimeoutTimeout duration
Return values
HALstatus

Definition at line 2236 of file stm32f4xx_hal_irda.c.

References __HAL_IRDA_GET_FLAG, __HAL_UNLOCK, IRDA_HandleTypeDef::gState, HAL_GetTick(), HAL_IRDA_STATE_READY, HAL_MAX_DELAY, HAL_OK, HAL_TIMEOUT, IRDA_HandleTypeDef::Instance, and IRDA_HandleTypeDef::RxState.

Referenced by HAL_IRDA_Receive(), and HAL_IRDA_Transmit().

◆ IRDA_EndTxTransfer()

static void IRDA_EndTxTransfer ( IRDA_HandleTypeDef * hirda)
static

#include <stm32f4xx_hal_irda.c>

End ongoing Tx transfer on IRDA peripheral (following error detection or Transmit completion).

Parameters
hirdaIRDA handle.
Return values
None

Definition at line 2268 of file stm32f4xx_hal_irda.c.

References IRDA_HandleTypeDef::gState, HAL_IRDA_STATE_READY, and IRDA_HandleTypeDef::Instance.

Referenced by HAL_IRDA_DMAStop(), and IRDA_DMAError().

◆ IRDA_EndRxTransfer()

static void IRDA_EndRxTransfer ( IRDA_HandleTypeDef * hirda)
static

#include <stm32f4xx_hal_irda.c>

End ongoing Rx transfer on IRDA peripheral (following error detection or Reception completion).

Parameters
hirdaIRDA handle.
Return values
None

Definition at line 2282 of file stm32f4xx_hal_irda.c.

References HAL_IRDA_STATE_READY, IRDA_HandleTypeDef::Instance, and IRDA_HandleTypeDef::RxState.

Referenced by HAL_IRDA_DMAStop(), HAL_IRDA_IRQHandler(), and IRDA_DMAError().