Collaboration diagram for CEC Exported Macros:

Macros
#define	__HAL_CEC_RESET_HANDLE_STATE(__HANDLE__)
	Reset CEC handle gstate & RxState.

#define	__HAL_CEC_GET_FLAG(__HANDLE__, __FLAG__)
	Checks whether or not the specified CEC interrupt flag is set.

#define	__HAL_CEC_CLEAR_FLAG(__HANDLE__, __FLAG__)
	Clears the interrupt or status flag when raised (write at 1)

#define	__HAL_CEC_ENABLE_IT(__HANDLE__, __INTERRUPT__)
	Enables the specified CEC interrupt.

#define	__HAL_CEC_DISABLE_IT(__HANDLE__, __INTERRUPT__)
	Disables the specified CEC interrupt.

#define	__HAL_CEC_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__)
	Checks whether or not the specified CEC interrupt is enabled.

#define	__HAL_CEC_ENABLE(__HANDLE__)
	Enables the CEC device.

#define	__HAL_CEC_DISABLE(__HANDLE__)
	Disables the CEC device.

#define	__HAL_CEC_FIRST_BYTE_TX_SET(__HANDLE__)
	Set Transmission Start flag.

#define	__HAL_CEC_LAST_BYTE_TX_SET(__HANDLE__)
	Set Transmission End flag.

#define	__HAL_CEC_GET_TRANSMISSION_START_FLAG(__HANDLE__)
	Get Transmission Start flag.

#define	__HAL_CEC_GET_TRANSMISSION_END_FLAG(__HANDLE__)
	Get Transmission End flag.

#define	__HAL_CEC_CLEAR_OAR(__HANDLE__)
	Clear OAR register.

#define	__HAL_CEC_SET_OAR(__HANDLE__, __ADDRESS__)
	Set OAR register (without resetting previously set address in case of multi-address mode) To reset OAR, __HAL_CEC_CLEAR_OAR() needs to be called beforehand.

Detailed Description

Macro Definition Documentation

◆ __HAL_CEC_RESET_HANDLE_STATE

#define __HAL_CEC_RESET_HANDLE_STATE ( __HANDLE__ )

#include <stm32f4xx_hal_cec.h>

Value:

                                                       do{                                                   \
                                                       (__HANDLE__)->gState = HAL_CEC_STATE_RESET;     \
                                                       (__HANDLE__)->RxState = HAL_CEC_STATE_RESET;    \
                                                     } while(0)

Reset CEC handle gstate & RxState.

Parameters

__HANDLE__ CEC handle.

Return values

None

Definition at line 478 of file stm32f4xx_hal_cec.h.

◆ __HAL_CEC_GET_FLAG

#define __HAL_CEC_GET_FLAG	(		__HANDLE__,
			__FLAG__ )

#include <stm32f4xx_hal_cec.h>

Value:

((__HANDLE__)->Instance->ISR & (__FLAG__))

Checks whether or not the specified CEC interrupt flag is set.

Parameters

__HANDLE__ specifies the CEC Handle.

__FLAG__

specifies the flag to check.

CEC_FLAG_TXACKE: Tx Missing acknowledge Error
CEC_FLAG_TXERR: Tx Error.
CEC_FLAG_TXUDR: Tx-Buffer Underrun.
CEC_FLAG_TXEND: End of transmission (successful transmission of the last byte).
CEC_FLAG_TXBR: Tx-Byte Request.
CEC_FLAG_ARBLST: Arbitration Lost
CEC_FLAG_RXACKE: Rx-Missing Acknowledge
CEC_FLAG_LBPE: Rx Long period Error
CEC_FLAG_SBPE: Rx Short period Error
CEC_FLAG_BRE: Rx Bit Rising Error
CEC_FLAG_RXOVR: Rx Overrun.
CEC_FLAG_RXEND: End Of Reception.
CEC_FLAG_RXBR: Rx-Byte Received.

Return values

ITStatus

Definition at line 501 of file stm32f4xx_hal_cec.h.

◆ __HAL_CEC_CLEAR_FLAG

#define __HAL_CEC_CLEAR_FLAG	(		__HANDLE__,
			__FLAG__ )

#include <stm32f4xx_hal_cec.h>

Value:

((__HANDLE__)->Instance->ISR |= (__FLAG__))

Clears the interrupt or status flag when raised (write at 1)

Parameters

__HANDLE__ specifies the CEC Handle.

__FLAG__

specifies the interrupt/status flag to clear. This parameter can be one of the following values:

CEC_FLAG_TXACKE: Tx Missing acknowledge Error
CEC_FLAG_TXERR: Tx Error.
CEC_FLAG_TXUDR: Tx-Buffer Underrun.
CEC_FLAG_TXEND: End of transmission (successful transmission of the last byte).
CEC_FLAG_TXBR: Tx-Byte Request.
CEC_FLAG_ARBLST: Arbitration Lost
CEC_FLAG_RXACKE: Rx-Missing Acknowledge
CEC_FLAG_LBPE: Rx Long period Error
CEC_FLAG_SBPE: Rx Short period Error
CEC_FLAG_BRE: Rx Bit Rising Error
CEC_FLAG_RXOVR: Rx Overrun.
CEC_FLAG_RXEND: End Of Reception.
CEC_FLAG_RXBR: Rx-Byte Received.

Return values

none

Definition at line 522 of file stm32f4xx_hal_cec.h.

Referenced by HAL_CEC_DeInit(), and HAL_CEC_IRQHandler().

◆ __HAL_CEC_ENABLE_IT

#define __HAL_CEC_ENABLE_IT	(		__HANDLE__,
			__INTERRUPT__ )

#include <stm32f4xx_hal_cec.h>

Value:

((__HANDLE__)->Instance->IER |= (__INTERRUPT__))

Enables the specified CEC interrupt.

Parameters

__HANDLE__ specifies the CEC Handle.

__INTERRUPT__

specifies the CEC interrupt to enable. This parameter can be one of the following values:

CEC_IT_TXACKE: Tx Missing acknowledge Error IT Enable
CEC_IT_TXERR: Tx Error IT Enable
CEC_IT_TXUDR: Tx-Buffer Underrun IT Enable
CEC_IT_TXEND: End of transmission IT Enable
CEC_IT_TXBR: Tx-Byte Request IT Enable
CEC_IT_ARBLST: Arbitration Lost IT Enable
CEC_IT_RXACKE: Rx-Missing Acknowledge IT Enable
CEC_IT_LBPE: Rx Long period Error IT Enable
CEC_IT_SBPE: Rx Short period Error IT Enable
CEC_IT_BRE: Rx Bit Rising Error IT Enable
CEC_IT_RXOVR: Rx Overrun IT Enable
CEC_IT_RXEND: End Of Reception IT Enable
CEC_IT_RXBR: Rx-Byte Received IT Enable

Return values

none

Definition at line 543 of file stm32f4xx_hal_cec.h.

Referenced by HAL_CEC_Init().

◆ __HAL_CEC_DISABLE_IT

#define __HAL_CEC_DISABLE_IT	(		__HANDLE__,
			__INTERRUPT__ )

#include <stm32f4xx_hal_cec.h>

Value:

((__HANDLE__)->Instance->IER &= (~(__INTERRUPT__)))

Disables the specified CEC interrupt.

Parameters

__HANDLE__ specifies the CEC Handle.

__INTERRUPT__

specifies the CEC interrupt to disable. This parameter can be one of the following values:

CEC_IT_TXACKE: Tx Missing acknowledge Error IT Enable
CEC_IT_TXERR: Tx Error IT Enable
CEC_IT_TXUDR: Tx-Buffer Underrun IT Enable
CEC_IT_TXEND: End of transmission IT Enable
CEC_IT_TXBR: Tx-Byte Request IT Enable
CEC_IT_ARBLST: Arbitration Lost IT Enable
CEC_IT_RXACKE: Rx-Missing Acknowledge IT Enable
CEC_IT_LBPE: Rx Long period Error IT Enable
CEC_IT_SBPE: Rx Short period Error IT Enable
CEC_IT_BRE: Rx Bit Rising Error IT Enable
CEC_IT_RXOVR: Rx Overrun IT Enable
CEC_IT_RXEND: End Of Reception IT Enable
CEC_IT_RXBR: Rx-Byte Received IT Enable

Return values

none

Definition at line 564 of file stm32f4xx_hal_cec.h.

Referenced by HAL_CEC_DeInit().

◆ __HAL_CEC_GET_IT_SOURCE

#define __HAL_CEC_GET_IT_SOURCE	(		__HANDLE__,
			__INTERRUPT__ )

#include <stm32f4xx_hal_cec.h>

Value:

((__HANDLE__)->Instance->IER & (__INTERRUPT__))

Checks whether or not the specified CEC interrupt is enabled.

Parameters

__HANDLE__ specifies the CEC Handle.

__INTERRUPT__

specifies the CEC interrupt to check. This parameter can be one of the following values:

CEC_IT_TXACKE: Tx Missing acknowledge Error IT Enable
CEC_IT_TXERR: Tx Error IT Enable
CEC_IT_TXUDR: Tx-Buffer Underrun IT Enable
CEC_IT_TXEND: End of transmission IT Enable
CEC_IT_TXBR: Tx-Byte Request IT Enable
CEC_IT_ARBLST: Arbitration Lost IT Enable
CEC_IT_RXACKE: Rx-Missing Acknowledge IT Enable
CEC_IT_LBPE: Rx Long period Error IT Enable
CEC_IT_SBPE: Rx Short period Error IT Enable
CEC_IT_BRE: Rx Bit Rising Error IT Enable
CEC_IT_RXOVR: Rx Overrun IT Enable
CEC_IT_RXEND: End Of Reception IT Enable
CEC_IT_RXBR: Rx-Byte Received IT Enable

Return values

FlagStatus

Definition at line 585 of file stm32f4xx_hal_cec.h.

◆ __HAL_CEC_ENABLE

#define __HAL_CEC_ENABLE ( __HANDLE__ )

#include <stm32f4xx_hal_cec.h>

Value:

((__HANDLE__)->Instance->CR |= CEC_CR_CECEN)

Enables the CEC device.

Parameters

__HANDLE__ specifies the CEC Handle.

Return values

none

Definition at line 591 of file stm32f4xx_hal_cec.h.

Referenced by HAL_CEC_Init(), and HAL_CEC_SetDeviceAddress().

◆ __HAL_CEC_DISABLE

#define __HAL_CEC_DISABLE ( __HANDLE__ )

#include <stm32f4xx_hal_cec.h>

Value:

((__HANDLE__)->Instance->CR &= ~CEC_CR_CECEN)

Disables the CEC device.

Parameters

__HANDLE__ specifies the CEC Handle.

Return values

none

Definition at line 597 of file stm32f4xx_hal_cec.h.

Referenced by HAL_CEC_DeInit(), HAL_CEC_Init(), and HAL_CEC_SetDeviceAddress().

◆ __HAL_CEC_FIRST_BYTE_TX_SET

#define __HAL_CEC_FIRST_BYTE_TX_SET ( __HANDLE__ )

#include <stm32f4xx_hal_cec.h>

Value:

((__HANDLE__)->Instance->CR |= CEC_CR_TXSOM)

Set Transmission Start flag.

Parameters

__HANDLE__ specifies the CEC Handle.

Return values

none

Definition at line 603 of file stm32f4xx_hal_cec.h.

Referenced by HAL_CEC_Transmit_IT().

◆ __HAL_CEC_LAST_BYTE_TX_SET

#define __HAL_CEC_LAST_BYTE_TX_SET ( __HANDLE__ )

#include <stm32f4xx_hal_cec.h>

Value:

((__HANDLE__)->Instance->CR |= CEC_CR_TXEOM)

Set Transmission End flag.

Parameters

__HANDLE__ specifies the CEC Handle.

Return values

none	If the CEC message consists of only one byte, TXEOM must be set before of TXSOM.

Definition at line 610 of file stm32f4xx_hal_cec.h.

Referenced by HAL_CEC_IRQHandler(), and HAL_CEC_Transmit_IT().

◆ __HAL_CEC_GET_TRANSMISSION_START_FLAG

#define __HAL_CEC_GET_TRANSMISSION_START_FLAG ( __HANDLE__ )

#include <stm32f4xx_hal_cec.h>

Value:

((__HANDLE__)->Instance->CR & CEC_CR_TXSOM)

Get Transmission Start flag.

Parameters

__HANDLE__ specifies the CEC Handle.

Return values

FlagStatus

Definition at line 616 of file stm32f4xx_hal_cec.h.

◆ __HAL_CEC_GET_TRANSMISSION_END_FLAG

#define __HAL_CEC_GET_TRANSMISSION_END_FLAG ( __HANDLE__ )

#include <stm32f4xx_hal_cec.h>

Value:

((__HANDLE__)->Instance->CR & CEC_CR_TXEOM)

Get Transmission End flag.

Parameters

__HANDLE__ specifies the CEC Handle.

Return values

FlagStatus

Definition at line 622 of file stm32f4xx_hal_cec.h.

◆ __HAL_CEC_CLEAR_OAR

#define __HAL_CEC_CLEAR_OAR ( __HANDLE__ )

#include <stm32f4xx_hal_cec.h>

Value:

CLEAR_BIT((__HANDLE__)->Instance->CFGR, CEC_CFGR_OAR)

Clear OAR register.

Parameters

__HANDLE__ specifies the CEC Handle.

Return values

none

Definition at line 628 of file stm32f4xx_hal_cec.h.

◆ __HAL_CEC_SET_OAR

#define __HAL_CEC_SET_OAR	(		__HANDLE__,
			__ADDRESS__ )

#include <stm32f4xx_hal_cec.h>

Value:

SET_BIT((__HANDLE__)->Instance->CFGR, \

(__ADDRESS__)<< CEC_CFGR_OAR_LSB_POS)

CEC_CFGR_OAR_LSB_POS

#define CEC_CFGR_OAR_LSB_POS

Definition stm32f4xx_hal_cec.h:356

Set OAR register (without resetting previously set address in case of multi-address mode) To reset OAR, __HAL_CEC_CLEAR_OAR() needs to be called beforehand.

Parameters

__HANDLE__	specifies the CEC Handle.
__ADDRESS__	Own Address value (CEC logical address is identified by bit position)

Return values

none

Definition at line 636 of file stm32f4xx_hal_cec.h.