Input and Output operation functions

CEC Transmit/Receive functions. More...

Collaboration diagram for Input and Output operation functions:

Functions
HAL_StatusTypeDef	HAL_CEC_Transmit_IT (CEC_HandleTypeDef *hcec, uint8_t InitiatorAddress, uint8_t DestinationAddress, const uint8_t *pData, uint32_t Size)
	Send data in interrupt mode. More...
uint32_t	HAL_CEC_GetLastReceivedFrameSize (const CEC_HandleTypeDef *hcec)
	Get size of the received frame. More...
void	HAL_CEC_ChangeRxBuffer (CEC_HandleTypeDef *hcec, uint8_t *Rxbuffer)
	Change Rx Buffer. More...
void	HAL_CEC_IRQHandler (CEC_HandleTypeDef *hcec)
	This function handles CEC interrupt requests. More...
void	HAL_CEC_TxCpltCallback (CEC_HandleTypeDef *hcec)
	Tx Transfer completed callback. More...
void	HAL_CEC_RxCpltCallback (CEC_HandleTypeDef *hcec, uint32_t RxFrameSize)
	Rx Transfer completed callback. More...
void	HAL_CEC_ErrorCallback (CEC_HandleTypeDef *hcec)
	CEC error callbacks. More...

Detailed Description

CEC Transmit/Receive functions.

 ===============================================================================
                      ##### IO operation functions #####
 ===============================================================================
    This subsection provides a set of functions allowing to manage the CEC data transfers.

    (#) The CEC handle must contain the initiator (TX side) and the destination (RX side)
        logical addresses (4-bit long addresses, 0xF for broadcast messages destination)

    (#) The communication is performed using Interrupts.
           These API's return the HAL status.
           The end of the data processing will be indicated through the
           dedicated CEC IRQ when using Interrupt mode.
           The HAL_CEC_TxCpltCallback(), HAL_CEC_RxCpltCallback() user callbacks
           will be executed respectively at the end of the transmit or Receive process
           The HAL_CEC_ErrorCallback() user callback will be executed when a communication
           error is detected

    (#) API's with Interrupt are :
         (+) HAL_CEC_Transmit_IT()
         (+) HAL_CEC_IRQHandler()

    (#) A set of User Callbacks are provided:
         (+) HAL_CEC_TxCpltCallback()
         (+) HAL_CEC_RxCpltCallback()
         (+) HAL_CEC_ErrorCallback()

Function Documentation

HAL_CEC_ChangeRxBuffer()

void HAL_CEC_ChangeRxBuffer	(	CEC_HandleTypeDef *	hcec,
		uint8_t *	Rxbuffer
	)

Change Rx Buffer.

Parameters

hcec	CEC handle
Rxbuffer	Rx Buffer

Note

This function can be called only inside the HAL_CEC_RxCpltCallback()

Return values

Frame

size

Definition at line 765 of file stm32f4xx_hal_cec.c.

HAL_CEC_ErrorCallback()

__weak void HAL_CEC_ErrorCallback

(

CEC_HandleTypeDef *

hcec

)

CEC error callbacks.

Parameters

hcec	CEC handle

Return values

None

Definition at line 929 of file stm32f4xx_hal_cec.c.

HAL_CEC_GetLastReceivedFrameSize()

uint32_t HAL_CEC_GetLastReceivedFrameSize

(

const CEC_HandleTypeDef *

hcec

)

Get size of the received frame.

Parameters

hcec	CEC handle

Return values

Frame

size

Definition at line 753 of file stm32f4xx_hal_cec.c.

HAL_CEC_IRQHandler()

void HAL_CEC_IRQHandler

(

CEC_HandleTypeDef *

hcec

)

This function handles CEC interrupt requests.

Parameters

hcec	CEC handle

Return values

None

Definition at line 775 of file stm32f4xx_hal_cec.c.

HAL_CEC_RxCpltCallback()

__weak void HAL_CEC_RxCpltCallback	(	CEC_HandleTypeDef *	hcec,
		uint32_t	RxFrameSize
	)

Rx Transfer completed callback.

Parameters

hcec	CEC handle
RxFrameSize	Size of frame

Return values

None

Definition at line 914 of file stm32f4xx_hal_cec.c.

HAL_CEC_Transmit_IT()

HAL_StatusTypeDef HAL_CEC_Transmit_IT	(	CEC_HandleTypeDef *	hcec,
		uint8_t	InitiatorAddress,
		uint8_t	DestinationAddress,
		const uint8_t *	pData,
		uint32_t	Size
	)

Send data in interrupt mode.

Parameters

hcec	CEC handle
InitiatorAddress	Initiator address
DestinationAddress	destination logical address
pData	pointer to input byte data buffer
Size	amount of data to be sent in bytes (without counting the header). 0 means only the header is sent (ping operation). Maximum TX size is 15 bytes (1 opcode and up to 14 operands).

Return values

HAL

status

Definition at line 697 of file stm32f4xx_hal_cec.c.

HAL_CEC_TxCpltCallback()

__weak void HAL_CEC_TxCpltCallback

(

CEC_HandleTypeDef *

hcec

)

Tx Transfer completed callback.

Parameters

hcec	CEC handle

Return values

None

Definition at line 899 of file stm32f4xx_hal_cec.c.