STM32L486xx HAL User Manual
Functions
IRDA Private Functions
IRDA

Functions

void IRDA_InitCallbacksToDefault (IRDA_HandleTypeDef *hirda)
 Initialize the callbacks to their default values.
static HAL_StatusTypeDef IRDA_SetConfig (IRDA_HandleTypeDef *hirda)
 Configure the IRDA peripheral.
static HAL_StatusTypeDef IRDA_CheckIdleState (IRDA_HandleTypeDef *hirda)
 Check the IRDA Idle State.
static HAL_StatusTypeDef IRDA_WaitOnFlagUntilTimeout (IRDA_HandleTypeDef *hirda, uint32_t Flag, FlagStatus Status, uint32_t Tickstart, uint32_t Timeout)
 Handle 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 UART peripheral (following error detection or Reception completion).
static void IRDA_DMATransmitCplt (DMA_HandleTypeDef *hdma)
 DMA IRDA transmit process complete callback.
static void IRDA_DMATransmitHalfCplt (DMA_HandleTypeDef *hdma)
 DMA IRDA transmit 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_Transmit_IT (IRDA_HandleTypeDef *hirda)
 Send an amount of data in interrupt mode.
static void IRDA_EndTransmit_IT (IRDA_HandleTypeDef *hirda)
 Wrap up transmission in non-blocking mode.
static HAL_StatusTypeDef IRDA_Receive_IT (IRDA_HandleTypeDef *hirda)
 Receive an amount of data in interrupt mode.

Function Documentation

static HAL_StatusTypeDef IRDA_CheckIdleState ( IRDA_HandleTypeDef hirda) [static]

Check the IRDA Idle State.

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

Definition at line 2285 of file stm32l4xx_hal_irda.c.

References __IRDA_HandleTypeDef::ErrorCode, __IRDA_HandleTypeDef::gState, HAL_GetTick(), HAL_IRDA_ERROR_NONE, HAL_IRDA_STATE_READY, __IRDA_HandleTypeDef::Instance, IRDA_TEACK_REACK_TIMEOUT, IRDA_WaitOnFlagUntilTimeout(), and __IRDA_HandleTypeDef::RxState.

Referenced by HAL_IRDA_Init().

static void IRDA_DMAAbortOnError ( DMA_HandleTypeDef hdma) [static]

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 2560 of file stm32l4xx_hal_irda.c.

References __IRDA_HandleTypeDef::ErrorCallback, HAL_IRDA_ErrorCallback(), __DMA_HandleTypeDef::Parent, __IRDA_HandleTypeDef::RxXferCount, and __IRDA_HandleTypeDef::TxXferCount.

Referenced by HAL_IRDA_IRQHandler().

static void IRDA_DMAError ( DMA_HandleTypeDef hdma) [static]
static void IRDA_DMAReceiveCplt ( DMA_HandleTypeDef hdma) [static]

DMA IRDA receive process complete callback.

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

Definition at line 2469 of file stm32l4xx_hal_irda.c.

References HAL_IRDA_RxCpltCallback(), HAL_IRDA_STATE_READY, __DMA_HandleTypeDef::Instance, __IRDA_HandleTypeDef::Instance, __DMA_HandleTypeDef::Parent, __IRDA_HandleTypeDef::RxCpltCallback, __IRDA_HandleTypeDef::RxState, and __IRDA_HandleTypeDef::RxXferCount.

Referenced by HAL_IRDA_Receive_DMA().

static void IRDA_DMAReceiveHalfCplt ( DMA_HandleTypeDef hdma) [static]

DMA IRDA receive process half complete callback.

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

Definition at line 2505 of file stm32l4xx_hal_irda.c.

References HAL_IRDA_RxHalfCpltCallback(), __DMA_HandleTypeDef::Parent, and __IRDA_HandleTypeDef::RxHalfCpltCallback.

Referenced by HAL_IRDA_Receive_DMA().

static void IRDA_DMARxAbortCallback ( DMA_HandleTypeDef hdma) [static]

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 2631 of file stm32l4xx_hal_irda.c.

References __HAL_IRDA_CLEAR_FLAG, __IRDA_HandleTypeDef::AbortCpltCallback, __IRDA_HandleTypeDef::ErrorCode, __IRDA_HandleTypeDef::gState, HAL_IRDA_AbortCpltCallback(), HAL_IRDA_ERROR_NONE, HAL_IRDA_STATE_READY, __IRDA_HandleTypeDef::hdmarx, __IRDA_HandleTypeDef::hdmatx, IRDA_CLEAR_FEF, IRDA_CLEAR_NEF, IRDA_CLEAR_OREF, IRDA_CLEAR_PEF, __DMA_HandleTypeDef::Parent, __IRDA_HandleTypeDef::RxState, __IRDA_HandleTypeDef::RxXferCount, __IRDA_HandleTypeDef::TxXferCount, and __DMA_HandleTypeDef::XferAbortCallback.

Referenced by HAL_IRDA_Abort_IT().

static void IRDA_DMARxOnlyAbortCallback ( DMA_HandleTypeDef hdma) [static]

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 2706 of file stm32l4xx_hal_irda.c.

References __HAL_IRDA_CLEAR_FLAG, __IRDA_HandleTypeDef::AbortReceiveCpltCallback, HAL_IRDA_AbortReceiveCpltCallback(), HAL_IRDA_STATE_READY, IRDA_CLEAR_FEF, IRDA_CLEAR_NEF, IRDA_CLEAR_OREF, IRDA_CLEAR_PEF, __IRDA_HandleTypeDef::RxState, and __IRDA_HandleTypeDef::RxXferCount.

Referenced by HAL_IRDA_AbortReceive_IT().

static void IRDA_DMATransmitCplt ( DMA_HandleTypeDef hdma) [static]

DMA IRDA transmit process complete callback.

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

Definition at line 2414 of file stm32l4xx_hal_irda.c.

References HAL_IRDA_TxCpltCallback(), __DMA_HandleTypeDef::Instance, __IRDA_HandleTypeDef::Instance, __DMA_HandleTypeDef::Parent, __IRDA_HandleTypeDef::TxCpltCallback, and __IRDA_HandleTypeDef::TxXferCount.

Referenced by HAL_IRDA_Transmit_DMA().

static void IRDA_DMATransmitHalfCplt ( DMA_HandleTypeDef hdma) [static]

DMA IRDA transmit process half complete callback.

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

Definition at line 2450 of file stm32l4xx_hal_irda.c.

References HAL_IRDA_TxHalfCpltCallback(), __DMA_HandleTypeDef::Parent, and __IRDA_HandleTypeDef::TxHalfCpltCallback.

Referenced by HAL_IRDA_Transmit_DMA().

static void IRDA_DMATxAbortCallback ( DMA_HandleTypeDef hdma) [static]

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 2583 of file stm32l4xx_hal_irda.c.

References __HAL_IRDA_CLEAR_FLAG, __IRDA_HandleTypeDef::AbortCpltCallback, __IRDA_HandleTypeDef::ErrorCode, __IRDA_HandleTypeDef::gState, HAL_IRDA_AbortCpltCallback(), HAL_IRDA_ERROR_NONE, HAL_IRDA_STATE_READY, __IRDA_HandleTypeDef::hdmarx, __IRDA_HandleTypeDef::hdmatx, IRDA_CLEAR_FEF, IRDA_CLEAR_NEF, IRDA_CLEAR_OREF, IRDA_CLEAR_PEF, __DMA_HandleTypeDef::Parent, __IRDA_HandleTypeDef::RxState, __IRDA_HandleTypeDef::RxXferCount, __IRDA_HandleTypeDef::TxXferCount, and __DMA_HandleTypeDef::XferAbortCallback.

Referenced by HAL_IRDA_Abort_IT().

static void IRDA_DMATxOnlyAbortCallback ( DMA_HandleTypeDef hdma) [static]

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 2679 of file stm32l4xx_hal_irda.c.

References __IRDA_HandleTypeDef::AbortTransmitCpltCallback, __IRDA_HandleTypeDef::gState, HAL_IRDA_AbortTransmitCpltCallback(), HAL_IRDA_STATE_READY, __DMA_HandleTypeDef::Parent, and __IRDA_HandleTypeDef::TxXferCount.

Referenced by HAL_IRDA_AbortTransmit_IT().

static void IRDA_EndRxTransfer ( IRDA_HandleTypeDef hirda) [static]

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

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

Definition at line 2393 of file stm32l4xx_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().

static void IRDA_EndTransmit_IT ( IRDA_HandleTypeDef hirda) [static]

Wrap 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:
None

Definition at line 2786 of file stm32l4xx_hal_irda.c.

References __IRDA_HandleTypeDef::gState, HAL_IRDA_STATE_READY, HAL_IRDA_TxCpltCallback(), __IRDA_HandleTypeDef::Instance, and __IRDA_HandleTypeDef::TxCpltCallback.

Referenced by HAL_IRDA_IRQHandler().

static void IRDA_EndTxTransfer ( IRDA_HandleTypeDef hirda) [static]

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

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

Definition at line 2373 of file stm32l4xx_hal_irda.c.

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

Referenced by HAL_IRDA_DMAStop(), and IRDA_DMAError().

static HAL_StatusTypeDef IRDA_Receive_IT ( IRDA_HandleTypeDef hirda) [static]

Receive an amount of data in interrupt mode.

Note:
Function is called under interruption only, once interruptions have been enabled by HAL_IRDA_Receive_IT()
Parameters:
hirdaPointer to a IRDA_HandleTypeDef structure that contains the configuration information for the specified IRDA module.
Return values:
HALstatus

Definition at line 2811 of file stm32l4xx_hal_irda.c.

References __HAL_IRDA_SEND_REQ, HAL_IRDA_RxCpltCallback(), HAL_IRDA_STATE_BUSY_RX, HAL_IRDA_STATE_READY, __IRDA_HandleTypeDef::Init, __IRDA_HandleTypeDef::Instance, IRDA_PARITY_NONE, IRDA_RXDATA_FLUSH_REQUEST, IRDA_WORDLENGTH_9B, __IRDA_HandleTypeDef::Mask, IRDA_InitTypeDef::Parity, __IRDA_HandleTypeDef::pRxBuffPtr, __IRDA_HandleTypeDef::RxCpltCallback, __IRDA_HandleTypeDef::RxState, __IRDA_HandleTypeDef::RxXferCount, and IRDA_InitTypeDef::WordLength.

Referenced by HAL_IRDA_IRQHandler().

static HAL_StatusTypeDef IRDA_SetConfig ( IRDA_HandleTypeDef hirda) [static]
static HAL_StatusTypeDef IRDA_Transmit_IT ( IRDA_HandleTypeDef hirda) [static]

Send an amount of data in interrupt mode.

Note:
Function is called under interruption only, once interruptions have been enabled by HAL_IRDA_Transmit_IT().
Parameters:
hirdaPointer to a IRDA_HandleTypeDef structure that contains the configuration information for the specified IRDA module.
Return values:
HALstatus

Definition at line 2736 of file stm32l4xx_hal_irda.c.

References __IRDA_HandleTypeDef::gState, HAL_IRDA_STATE_BUSY_TX, __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().

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

Handle IRDA Communication Timeout.

Parameters:
hirdaPointer to a IRDA_HandleTypeDef structure that contains the configuration information for the specified IRDA module.
FlagSpecifies the IRDA flag to check.
StatusFlag status (SET or RESET)
TickstartTick start value
TimeoutTimeout duration
Return values:
HALstatus

Definition at line 2336 of file stm32l4xx_hal_irda.c.

References __HAL_IRDA_GET_FLAG, __IRDA_HandleTypeDef::gState, HAL_GetTick(), HAL_IRDA_STATE_READY, __IRDA_HandleTypeDef::Instance, and __IRDA_HandleTypeDef::RxState.

Referenced by HAL_IRDA_Receive(), HAL_IRDA_Transmit(), and IRDA_CheckIdleState().