STM32F4xx_HAL_Driver  1.8.3
Initialization and de-initialization functions

Initialization and Configuration functions. More...

+ Collaboration diagram for Initialization and de-initialization functions:

Functions

HAL_StatusTypeDef HAL_CEC_Init (CEC_HandleTypeDef *hcec)
 Initializes the CEC mode according to the specified parameters in the CEC_InitTypeDef and creates the associated handle . More...
 
HAL_StatusTypeDef HAL_CEC_DeInit (CEC_HandleTypeDef *hcec)
 DeInitializes the CEC peripheral. More...
 
HAL_StatusTypeDef HAL_CEC_SetDeviceAddress (CEC_HandleTypeDef *hcec, uint16_t CEC_OwnAddress)
 Initializes the Own Address of the CEC device. More...
 
void HAL_CEC_MspInit (CEC_HandleTypeDef *hcec)
 CEC MSP Init. More...
 
void HAL_CEC_MspDeInit (CEC_HandleTypeDef *hcec)
 CEC MSP DeInit. More...
 
HAL_StatusTypeDef HAL_CEC_RegisterCallback (CEC_HandleTypeDef *hcec, HAL_CEC_CallbackIDTypeDef CallbackID, pCEC_CallbackTypeDef pCallback)
 Register a User CEC Callback To be used instead of the weak predefined callback. More...
 
HAL_StatusTypeDef HAL_CEC_UnRegisterCallback (CEC_HandleTypeDef *hcec, HAL_CEC_CallbackIDTypeDef CallbackID)
 Unregister an CEC Callback CEC callback is redirected to the weak predefined callback. More...
 
HAL_StatusTypeDef HAL_CEC_RegisterRxCpltCallback (CEC_HandleTypeDef *hcec, pCEC_RxCallbackTypeDef pCallback)
 Register CEC RX complete Callback To be used instead of the weak HAL_CEC_RxCpltCallback() predefined callback. More...
 
HAL_StatusTypeDef HAL_CEC_UnRegisterRxCpltCallback (CEC_HandleTypeDef *hcec)
 UnRegister CEC RX complete Callback CEC RX complete Callback is redirected to the weak HAL_CEC_RxCpltCallback() predefined callback. More...
 

Detailed Description

Initialization and Configuration functions.

===============================================================================
            ##### Initialization and Configuration functions #####
 ===============================================================================
    [..]
    This subsection provides a set of functions allowing to initialize the CEC
      (+) The following parameters need to be configured:
        (++) SignalFreeTime
        (++) Tolerance
        (++) BRERxStop                 (RX stopped or not upon Bit Rising Error)
        (++) BREErrorBitGen            (Error-Bit generation in case of Bit Rising Error)
        (++) LBPEErrorBitGen           (Error-Bit generation in case of Long Bit Period Error)
        (++) BroadcastMsgNoErrorBitGen (Error-bit generation in case of broadcast message error)
        (++) SignalFreeTimeOption      (SFT Timer start definition)
        (++) OwnAddress                (CEC device address)
        (++) ListenMode

Function Documentation

◆ HAL_CEC_DeInit()

HAL_StatusTypeDef HAL_CEC_DeInit ( CEC_HandleTypeDef hcec)

DeInitializes the CEC peripheral.

Parameters
hcecCEC handle
Return values
HALstatus

Definition at line 274 of file stm32f4xx_hal_cec.c.

◆ HAL_CEC_Init()

HAL_StatusTypeDef HAL_CEC_Init ( CEC_HandleTypeDef hcec)

Initializes the CEC mode according to the specified parameters in the CEC_InitTypeDef and creates the associated handle .

Parameters
hcecCEC handle
Return values
HALstatus

Definition at line 181 of file stm32f4xx_hal_cec.c.

◆ HAL_CEC_MspDeInit()

__weak void HAL_CEC_MspDeInit ( CEC_HandleTypeDef hcec)

CEC MSP DeInit.

Parameters
hcecCEC handle
Return values
None

Definition at line 401 of file stm32f4xx_hal_cec.c.

◆ HAL_CEC_MspInit()

__weak void HAL_CEC_MspInit ( CEC_HandleTypeDef hcec)

CEC MSP Init.

Parameters
hcecCEC handle
Return values
None

Definition at line 387 of file stm32f4xx_hal_cec.c.

◆ HAL_CEC_RegisterCallback()

HAL_StatusTypeDef HAL_CEC_RegisterCallback ( CEC_HandleTypeDef hcec,
HAL_CEC_CallbackIDTypeDef  CallbackID,
pCEC_CallbackTypeDef  pCallback 
)

Register a User CEC Callback To be used instead of the weak predefined callback.

Parameters
hcecCEC handle
CallbackIDID of the callback to be registered This parameter can be one of the following values:
  • HAL_CEC_TX_CPLT_CB_ID Tx Complete callback ID
  • HAL_CEC_ERROR_CB_ID Error callback ID
  • HAL_CEC_MSPINIT_CB_ID MspInit callback ID
  • HAL_CEC_MSPDEINIT_CB_ID MspDeInit callback ID
pCallbackpointer to the Callback function
Return values
HALstatus

Definition at line 423 of file stm32f4xx_hal_cec.c.

◆ HAL_CEC_RegisterRxCpltCallback()

HAL_StatusTypeDef HAL_CEC_RegisterRxCpltCallback ( CEC_HandleTypeDef hcec,
pCEC_RxCallbackTypeDef  pCallback 
)

Register CEC RX complete Callback To be used instead of the weak HAL_CEC_RxCpltCallback() predefined callback.

Parameters
hcecCEC handle
pCallbackpointer to the Rx transfer compelete Callback function
Return values
HALstatus

Definition at line 587 of file stm32f4xx_hal_cec.c.

◆ HAL_CEC_SetDeviceAddress()

HAL_StatusTypeDef HAL_CEC_SetDeviceAddress ( CEC_HandleTypeDef hcec,
uint16_t  CEC_OwnAddress 
)

Initializes the Own Address of the CEC device.

Parameters
hcecCEC handle
CEC_OwnAddressThe CEC own address.
Return values
HALstatus

Definition at line 341 of file stm32f4xx_hal_cec.c.

◆ HAL_CEC_UnRegisterCallback()

HAL_StatusTypeDef HAL_CEC_UnRegisterCallback ( CEC_HandleTypeDef hcec,
HAL_CEC_CallbackIDTypeDef  CallbackID 
)

Unregister an CEC Callback CEC callback is redirected to the weak predefined callback.

Parameters
hcecuart handle
CallbackIDID of the callback to be unregistered This parameter can be one of the following values:
  • HAL_CEC_TX_CPLT_CB_ID Tx Complete callback ID
  • HAL_CEC_ERROR_CB_ID Error callback ID
  • HAL_CEC_MSPINIT_CB_ID MspInit callback ID
  • HAL_CEC_MSPDEINIT_CB_ID MspDeInit callback ID
Return values
status

Definition at line 511 of file stm32f4xx_hal_cec.c.

◆ HAL_CEC_UnRegisterRxCpltCallback()

HAL_StatusTypeDef HAL_CEC_UnRegisterRxCpltCallback ( CEC_HandleTypeDef hcec)

UnRegister CEC RX complete Callback CEC RX complete Callback is redirected to the weak HAL_CEC_RxCpltCallback() predefined callback.

Parameters
hcecCEC handle
Return values
HALstatus

Definition at line 623 of file stm32f4xx_hal_cec.c.