STM32F4xx_HAL_Driver  1.8.3
stm32f4xx_hal_cec.h
Go to the documentation of this file.
1 
19 /* Define to prevent recursive inclusion -------------------------------------*/
20 #ifndef STM32F4xx_HAL_CEC_H
21 #define STM32F4xx_HAL_CEC_H
22 
23 #ifdef __cplusplus
24 extern "C" {
25 #endif
26 
27 /* Includes ------------------------------------------------------------------*/
28 #include "stm32f4xx_hal_def.h"
29 
30 #if defined (CEC)
31 
40 /* Exported types ------------------------------------------------------------*/
48 typedef struct
49 {
50  uint32_t SignalFreeTime;
56  uint32_t Tolerance;
60  uint32_t BRERxStop;
65  uint32_t BREErrorBitGen;
71  uint32_t LBPEErrorBitGen;
100  uint32_t ListenMode;
113  uint16_t OwnAddress;
116  uint8_t *RxBuffer;
120 
161 typedef uint32_t HAL_CEC_StateTypeDef;
162 
166 #if (USE_HAL_CEC_REGISTER_CALLBACKS == 1)
167 typedef struct __CEC_HandleTypeDef
168 #else
169 typedef struct
170 #endif /* USE_HAL_CEC_REGISTER_CALLBACKS */
171 {
172  CEC_TypeDef *Instance;
176  const uint8_t *pTxBuffPtr;
178  uint16_t TxXferCount;
180  uint16_t RxXferSize;
182  HAL_LockTypeDef Lock;
191  uint32_t ErrorCode;
194 #if (USE_HAL_CEC_REGISTER_CALLBACKS == 1)
195  void (* TxCpltCallback)(struct __CEC_HandleTypeDef
196  *hcec);
197  void (* RxCpltCallback)(struct __CEC_HandleTypeDef *hcec,
198  uint32_t RxFrameSize);
199  void (* ErrorCallback)(struct __CEC_HandleTypeDef *hcec);
201  void (* MspInitCallback)(struct __CEC_HandleTypeDef *hcec);
202  void (* MspDeInitCallback)(struct __CEC_HandleTypeDef *hcec);
204 #endif /* (USE_HAL_CEC_REGISTER_CALLBACKS) */
206 
207 #if (USE_HAL_CEC_REGISTER_CALLBACKS == 1)
211 typedef enum
212 {
217  HAL_CEC_MSPDEINIT_CB_ID = 0x04U
219 
223 typedef void (*pCEC_CallbackTypeDef)(CEC_HandleTypeDef *hcec);
225  uint32_t RxFrameSize);
227 #endif /* USE_HAL_CEC_REGISTER_CALLBACKS */
232 /* Exported constants --------------------------------------------------------*/
239 #define HAL_CEC_STATE_RESET ((uint32_t)0x00000000)
241 #define HAL_CEC_STATE_READY ((uint32_t)0x00000020)
243 #define HAL_CEC_STATE_BUSY ((uint32_t)0x00000024)
245 #define HAL_CEC_STATE_BUSY_RX ((uint32_t)0x00000022)
247 #define HAL_CEC_STATE_BUSY_TX ((uint32_t)0x00000021)
249 #define HAL_CEC_STATE_BUSY_RX_TX ((uint32_t)0x00000023)
251 #define HAL_CEC_STATE_ERROR ((uint32_t)0x00000050)
258 #define HAL_CEC_ERROR_NONE (uint32_t) 0x0000U
259 #define HAL_CEC_ERROR_RXOVR CEC_ISR_RXOVR
260 #define HAL_CEC_ERROR_BRE CEC_ISR_BRE
261 #define HAL_CEC_ERROR_SBPE CEC_ISR_SBPE
262 #define HAL_CEC_ERROR_LBPE CEC_ISR_LBPE
263 #define HAL_CEC_ERROR_RXACKE CEC_ISR_RXACKE
264 #define HAL_CEC_ERROR_ARBLST CEC_ISR_ARBLST
265 #define HAL_CEC_ERROR_TXUDR CEC_ISR_TXUDR
266 #define HAL_CEC_ERROR_TXERR CEC_ISR_TXERR
267 #define HAL_CEC_ERROR_TXACKE CEC_ISR_TXACKE
268 #if (USE_HAL_CEC_REGISTER_CALLBACKS == 1)
269 #define HAL_CEC_ERROR_INVALID_CALLBACK ((uint32_t)0x00002000U)
270 #endif /* USE_HAL_CEC_REGISTER_CALLBACKS */
278 #define CEC_DEFAULT_SFT ((uint32_t)0x00000000U)
279 #define CEC_0_5_BITPERIOD_SFT ((uint32_t)0x00000001U)
280 #define CEC_1_5_BITPERIOD_SFT ((uint32_t)0x00000002U)
281 #define CEC_2_5_BITPERIOD_SFT ((uint32_t)0x00000003U)
282 #define CEC_3_5_BITPERIOD_SFT ((uint32_t)0x00000004U)
283 #define CEC_4_5_BITPERIOD_SFT ((uint32_t)0x00000005U)
284 #define CEC_5_5_BITPERIOD_SFT ((uint32_t)0x00000006U)
285 #define CEC_6_5_BITPERIOD_SFT ((uint32_t)0x00000007U)
293 #define CEC_STANDARD_TOLERANCE ((uint32_t)0x00000000U)
294 #define CEC_EXTENDED_TOLERANCE ((uint32_t)CEC_CFGR_RXTOL)
302 #define CEC_NO_RX_STOP_ON_BRE ((uint32_t)0x00000000U)
303 #define CEC_RX_STOP_ON_BRE ((uint32_t)CEC_CFGR_BRESTP)
311 #define CEC_BRE_ERRORBIT_NO_GENERATION ((uint32_t)0x00000000U)
312 #define CEC_BRE_ERRORBIT_GENERATION ((uint32_t)CEC_CFGR_BREGEN)
320 #define CEC_LBPE_ERRORBIT_NO_GENERATION ((uint32_t)0x00000000U)
321 #define CEC_LBPE_ERRORBIT_GENERATION ((uint32_t)CEC_CFGR_LBPEGEN)
329 #define CEC_BROADCASTERROR_ERRORBIT_GENERATION ((uint32_t)0x00000000U)
330 #define CEC_BROADCASTERROR_NO_ERRORBIT_GENERATION ((uint32_t)CEC_CFGR_BRDNOGEN)
338 #define CEC_SFT_START_ON_TXSOM ((uint32_t)0x00000000U)
339 #define CEC_SFT_START_ON_TX_RX_END ((uint32_t)CEC_CFGR_SFTOPT)
347 #define CEC_REDUCED_LISTENING_MODE ((uint32_t)0x00000000U)
348 #define CEC_FULL_LISTENING_MODE ((uint32_t)CEC_CFGR_LSTN)
356 #define CEC_CFGR_OAR_LSB_POS ((uint32_t) 16U)
364 #define CEC_INITIATOR_LSB_POS ((uint32_t) 4U)
372 #define CEC_OWN_ADDRESS_NONE ((uint16_t) 0x0000U) /* Reset value */
373 #define CEC_OWN_ADDRESS_0 ((uint16_t) 0x0001U) /* Logical Address 0 */
374 #define CEC_OWN_ADDRESS_1 ((uint16_t) 0x0002U) /* Logical Address 1 */
375 #define CEC_OWN_ADDRESS_2 ((uint16_t) 0x0004U) /* Logical Address 2 */
376 #define CEC_OWN_ADDRESS_3 ((uint16_t) 0x0008U) /* Logical Address 3 */
377 #define CEC_OWN_ADDRESS_4 ((uint16_t) 0x0010U) /* Logical Address 4 */
378 #define CEC_OWN_ADDRESS_5 ((uint16_t) 0x0020U) /* Logical Address 5 */
379 #define CEC_OWN_ADDRESS_6 ((uint16_t) 0x0040U) /* Logical Address 6 */
380 #define CEC_OWN_ADDRESS_7 ((uint16_t) 0x0080U) /* Logical Address 7 */
381 #define CEC_OWN_ADDRESS_8 ((uint16_t) 0x0100U) /* Logical Address 9 */
382 #define CEC_OWN_ADDRESS_9 ((uint16_t) 0x0200U) /* Logical Address 10 */
383 #define CEC_OWN_ADDRESS_10 ((uint16_t) 0x0400U) /* Logical Address 11 */
384 #define CEC_OWN_ADDRESS_11 ((uint16_t) 0x0800U) /* Logical Address 12 */
385 #define CEC_OWN_ADDRESS_12 ((uint16_t) 0x1000U) /* Logical Address 13 */
386 #define CEC_OWN_ADDRESS_13 ((uint16_t) 0x2000U) /* Logical Address 14 */
387 #define CEC_OWN_ADDRESS_14 ((uint16_t) 0x4000U) /* Logical Address 15 */
395 #define CEC_IT_TXACKE CEC_IER_TXACKEIE
396 #define CEC_IT_TXERR CEC_IER_TXERRIE
397 #define CEC_IT_TXUDR CEC_IER_TXUDRIE
398 #define CEC_IT_TXEND CEC_IER_TXENDIE
399 #define CEC_IT_TXBR CEC_IER_TXBRIE
400 #define CEC_IT_ARBLST CEC_IER_ARBLSTIE
401 #define CEC_IT_RXACKE CEC_IER_RXACKEIE
402 #define CEC_IT_LBPE CEC_IER_LBPEIE
403 #define CEC_IT_SBPE CEC_IER_SBPEIE
404 #define CEC_IT_BRE CEC_IER_BREIE
405 #define CEC_IT_RXOVR CEC_IER_RXOVRIE
406 #define CEC_IT_RXEND CEC_IER_RXENDIE
407 #define CEC_IT_RXBR CEC_IER_RXBRIE
415 #define CEC_FLAG_TXACKE CEC_ISR_TXACKE
416 #define CEC_FLAG_TXERR CEC_ISR_TXERR
417 #define CEC_FLAG_TXUDR CEC_ISR_TXUDR
418 #define CEC_FLAG_TXEND CEC_ISR_TXEND
419 #define CEC_FLAG_TXBR CEC_ISR_TXBR
420 #define CEC_FLAG_ARBLST CEC_ISR_ARBLST
421 #define CEC_FLAG_RXACKE CEC_ISR_RXACKE
422 #define CEC_FLAG_LBPE CEC_ISR_LBPE
423 #define CEC_FLAG_SBPE CEC_ISR_SBPE
424 #define CEC_FLAG_BRE CEC_ISR_BRE
425 #define CEC_FLAG_RXOVR CEC_ISR_RXOVR
426 #define CEC_FLAG_RXEND CEC_ISR_RXEND
427 #define CEC_FLAG_RXBR CEC_ISR_RXBR
435 #define CEC_ISR_ALL_ERROR ((uint32_t)CEC_ISR_RXOVR|CEC_ISR_BRE|CEC_ISR_SBPE|CEC_ISR_LBPE|CEC_ISR_RXACKE|\
436  CEC_ISR_ARBLST|CEC_ISR_TXUDR|CEC_ISR_TXERR|CEC_ISR_TXACKE)
444 #define CEC_IER_RX_ALL_ERR ((uint32_t)CEC_IER_RXACKEIE|CEC_IER_LBPEIE|CEC_IER_SBPEIE|CEC_IER_BREIE|CEC_IER_RXOVRIE)
452 #define CEC_IER_TX_ALL_ERR ((uint32_t)CEC_IER_TXACKEIE|CEC_IER_TXERRIE|CEC_IER_TXUDRIE|CEC_IER_ARBLSTIE)
461 /* Exported macros -----------------------------------------------------------*/
470 #if (USE_HAL_CEC_REGISTER_CALLBACKS == 1)
471 #define __HAL_CEC_RESET_HANDLE_STATE(__HANDLE__) do{ \
472  (__HANDLE__)->gState = HAL_CEC_STATE_RESET; \
473  (__HANDLE__)->RxState = HAL_CEC_STATE_RESET; \
474  (__HANDLE__)->MspInitCallback = NULL; \
475  (__HANDLE__)->MspDeInitCallback = NULL; \
476  } while(0)
477 #else
478 #define __HAL_CEC_RESET_HANDLE_STATE(__HANDLE__) do{ \
479  (__HANDLE__)->gState = HAL_CEC_STATE_RESET; \
480  (__HANDLE__)->RxState = HAL_CEC_STATE_RESET; \
481  } while(0)
482 #endif /* USE_HAL_CEC_REGISTER_CALLBACKS */
501 #define __HAL_CEC_GET_FLAG(__HANDLE__, __FLAG__) ((__HANDLE__)->Instance->ISR & (__FLAG__))
502 
522 #define __HAL_CEC_CLEAR_FLAG(__HANDLE__, __FLAG__) ((__HANDLE__)->Instance->ISR |= (__FLAG__))
523 
543 #define __HAL_CEC_ENABLE_IT(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->IER |= (__INTERRUPT__))
544 
564 #define __HAL_CEC_DISABLE_IT(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->IER &= (~(__INTERRUPT__)))
565 
585 #define __HAL_CEC_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->IER & (__INTERRUPT__))
586 
591 #define __HAL_CEC_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->CR |= CEC_CR_CECEN)
592 
597 #define __HAL_CEC_DISABLE(__HANDLE__) ((__HANDLE__)->Instance->CR &= ~CEC_CR_CECEN)
598 
603 #define __HAL_CEC_FIRST_BYTE_TX_SET(__HANDLE__) ((__HANDLE__)->Instance->CR |= CEC_CR_TXSOM)
604 
610 #define __HAL_CEC_LAST_BYTE_TX_SET(__HANDLE__) ((__HANDLE__)->Instance->CR |= CEC_CR_TXEOM)
611 
616 #define __HAL_CEC_GET_TRANSMISSION_START_FLAG(__HANDLE__) ((__HANDLE__)->Instance->CR & CEC_CR_TXSOM)
617 
622 #define __HAL_CEC_GET_TRANSMISSION_END_FLAG(__HANDLE__) ((__HANDLE__)->Instance->CR & CEC_CR_TXEOM)
623 
628 #define __HAL_CEC_CLEAR_OAR(__HANDLE__) CLEAR_BIT((__HANDLE__)->Instance->CFGR, CEC_CFGR_OAR)
629 
636 #define __HAL_CEC_SET_OAR(__HANDLE__,__ADDRESS__) SET_BIT((__HANDLE__)->Instance->CFGR, \
637  (__ADDRESS__)<< CEC_CFGR_OAR_LSB_POS)
638 
643 /* Exported functions --------------------------------------------------------*/
651 /* Initialization and de-initialization functions ****************************/
652 HAL_StatusTypeDef HAL_CEC_Init(CEC_HandleTypeDef *hcec);
653 HAL_StatusTypeDef HAL_CEC_DeInit(CEC_HandleTypeDef *hcec);
654 HAL_StatusTypeDef HAL_CEC_SetDeviceAddress(CEC_HandleTypeDef *hcec, uint16_t CEC_OwnAddress);
657 
658 #if (USE_HAL_CEC_REGISTER_CALLBACKS == 1)
659 HAL_StatusTypeDef HAL_CEC_RegisterCallback(CEC_HandleTypeDef *hcec, HAL_CEC_CallbackIDTypeDef CallbackID,
660  pCEC_CallbackTypeDef pCallback);
661 HAL_StatusTypeDef HAL_CEC_UnRegisterCallback(CEC_HandleTypeDef *hcec, HAL_CEC_CallbackIDTypeDef CallbackID);
662 
664 HAL_StatusTypeDef HAL_CEC_UnRegisterRxCpltCallback(CEC_HandleTypeDef *hcec);
665 #endif /* USE_HAL_CEC_REGISTER_CALLBACKS */
673 /* I/O operation functions ***************************************************/
674 HAL_StatusTypeDef HAL_CEC_Transmit_IT(CEC_HandleTypeDef *hcec, uint8_t InitiatorAddress, uint8_t DestinationAddress,
675  const uint8_t *pData, uint32_t Size);
677 void HAL_CEC_ChangeRxBuffer(CEC_HandleTypeDef *hcec, uint8_t *Rxbuffer);
680 void HAL_CEC_RxCpltCallback(CEC_HandleTypeDef *hcec, uint32_t RxFrameSize);
689 /* Peripheral State functions ************************************************/
691 uint32_t HAL_CEC_GetError(const CEC_HandleTypeDef *hcec);
700 /* Private types -------------------------------------------------------------*/
709 /* Private variables ---------------------------------------------------------*/
718 /* Private constants ---------------------------------------------------------*/
727 /* Private macros ------------------------------------------------------------*/
732 #define IS_CEC_SIGNALFREETIME(__SFT__) ((__SFT__) <= CEC_CFGR_SFT)
733 
734 #define IS_CEC_TOLERANCE(__RXTOL__) (((__RXTOL__) == CEC_STANDARD_TOLERANCE) || \
735  ((__RXTOL__) == CEC_EXTENDED_TOLERANCE))
736 
737 #define IS_CEC_BRERXSTOP(__BRERXSTOP__) (((__BRERXSTOP__) == CEC_NO_RX_STOP_ON_BRE) || \
738  ((__BRERXSTOP__) == CEC_RX_STOP_ON_BRE))
739 
740 #define IS_CEC_BREERRORBITGEN(__ERRORBITGEN__) (((__ERRORBITGEN__) == CEC_BRE_ERRORBIT_NO_GENERATION) || \
741  ((__ERRORBITGEN__) == CEC_BRE_ERRORBIT_GENERATION))
742 
743 #define IS_CEC_LBPEERRORBITGEN(__ERRORBITGEN__) (((__ERRORBITGEN__) == CEC_LBPE_ERRORBIT_NO_GENERATION) || \
744  ((__ERRORBITGEN__) == CEC_LBPE_ERRORBIT_GENERATION))
745 
746 #define IS_CEC_BROADCASTERROR_NO_ERRORBIT_GENERATION(__ERRORBITGEN__) \
747  (((__ERRORBITGEN__) == CEC_BROADCASTERROR_ERRORBIT_GENERATION) || \
748  ((__ERRORBITGEN__) == CEC_BROADCASTERROR_NO_ERRORBIT_GENERATION))
749 
750 #define IS_CEC_SFTOP(__SFTOP__) (((__SFTOP__) == CEC_SFT_START_ON_TXSOM) || \
751  ((__SFTOP__) == CEC_SFT_START_ON_TX_RX_END))
752 
753 #define IS_CEC_LISTENING_MODE(__MODE__) (((__MODE__) == CEC_REDUCED_LISTENING_MODE) || \
754  ((__MODE__) == CEC_FULL_LISTENING_MODE))
755 
763 #define IS_CEC_MSGSIZE(__SIZE__) ((__SIZE__) <= 0x10U)
764 
770 #define IS_CEC_OWN_ADDRESS(__ADDRESS__) ((__ADDRESS__) <= 0x7FFFU)
771 
777 #define IS_CEC_ADDRESS(__ADDRESS__) ((__ADDRESS__) <= 0xFU)
781 /* Private functions ---------------------------------------------------------*/
798 #endif /* CEC */
799 
800 #ifdef __cplusplus
801 }
802 #endif
803 
804 #endif /* STM32F4xxHAL_CEC_H */
HAL_CEC_StateTypeDef RxState
CEC_InitTypeDef Init
HAL_CEC_StateTypeDef gState
uint32_t ErrorCode
uint16_t TxXferCount
uint16_t RxXferSize
const uint8_t * pTxBuffPtr
CEC_TypeDef * Instance
ADC handle Structure definition.
void HAL_CEC_MspDeInit(CEC_HandleTypeDef *hcec)
CEC MSP DeInit.
void HAL_CEC_MspInit(CEC_HandleTypeDef *hcec)
CEC MSP Init.
HAL_StatusTypeDef HAL_CEC_DeInit(CEC_HandleTypeDef *hcec)
DeInitializes the CEC peripheral.
HAL_StatusTypeDef HAL_CEC_Init(CEC_HandleTypeDef *hcec)
Initializes the CEC mode according to the specified parameters in the CEC_InitTypeDef and creates the...
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.
HAL_StatusTypeDef HAL_CEC_SetDeviceAddress(CEC_HandleTypeDef *hcec, uint16_t CEC_OwnAddress)
Initializes the Own Address of the CEC device.
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 ...
HAL_StatusTypeDef HAL_CEC_UnRegisterRxCpltCallback(CEC_HandleTypeDef *hcec)
UnRegister CEC RX complete Callback CEC RX complete Callback is redirected to the weak HAL_CEC_RxCplt...
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.
void HAL_CEC_TxCpltCallback(CEC_HandleTypeDef *hcec)
Tx Transfer completed callback.
void HAL_CEC_IRQHandler(CEC_HandleTypeDef *hcec)
This function handles CEC interrupt requests.
void HAL_CEC_ErrorCallback(CEC_HandleTypeDef *hcec)
CEC error callbacks.
uint32_t HAL_CEC_GetLastReceivedFrameSize(const CEC_HandleTypeDef *hcec)
Get size of the received frame.
void HAL_CEC_RxCpltCallback(CEC_HandleTypeDef *hcec, uint32_t RxFrameSize)
Rx Transfer completed callback.
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.
void HAL_CEC_ChangeRxBuffer(CEC_HandleTypeDef *hcec, uint8_t *Rxbuffer)
Change Rx Buffer.
uint32_t HAL_CEC_GetError(const CEC_HandleTypeDef *hcec)
Return the CEC error code.
HAL_CEC_StateTypeDef HAL_CEC_GetState(const CEC_HandleTypeDef *hcec)
return the CEC state
uint32_t LBPEErrorBitGen
uint32_t BroadcastMsgNoErrorBitGen
uint32_t SignalFreeTimeOption
HAL_CEC_CallbackIDTypeDef
HAL CEC Callback ID enumeration definition.
struct __CEC_HandleTypeDef else typedef struct endif CEC_HandleTypeDef
CEC handle Structure definition.
void(* pCEC_CallbackTypeDef)(CEC_HandleTypeDef *hcec)
HAL CEC Callback pointer definition.
void(* pCEC_RxCallbackTypeDef)(CEC_HandleTypeDef *hcec, uint32_t RxFrameSize)
uint32_t HAL_CEC_StateTypeDef
HAL CEC State definition.
@ HAL_CEC_TX_CPLT_CB_ID
@ HAL_CEC_MSPINIT_CB_ID
@ HAL_CEC_MSPDEINIT_CB_ID
@ HAL_CEC_RX_CPLT_CB_ID
@ HAL_CEC_ERROR_CB_ID
CEC Init Structure definition.
This file contains HAL common defines, enumeration, macros and structures definitions.
HAL_LockTypeDef
HAL Lock structures definition