2 ******************************************************************************
\r
3 * @file stm32f7xx_hal_cec.c
\r
4 * @author MCD Application Team
\r
7 * @brief CEC HAL module driver.
\r
9 * This file provides firmware functions to manage the following
\r
10 * functionalities of the High Definition Multimedia Interface
\r
11 * Consumer Electronics Control Peripheral (CEC).
\r
12 * + Initialization and de-initialization function
\r
13 * + IO operation function
\r
14 * + Peripheral Control function
\r
18 ===============================================================================
\r
19 ##### How to use this driver #####
\r
20 ===============================================================================
\r
22 The CEC HAL driver can be used as follow:
\r
24 (#) Declare a CEC_HandleTypeDef handle structure.
\r
25 (#) Initialize the CEC low level resources by implementing the HAL_CEC_MspInit ()API:
\r
26 (##) Enable the CEC interface clock.
\r
27 (##) CEC pins configuration:
\r
28 (+) Enable the clock for the CEC GPIOs.
\r
29 (+) Configure these CEC pins as alternate function pull-up.
\r
30 (##) NVIC configuration if you need to use interrupt process (HAL_CEC_Transmit_IT()
\r
31 and HAL_CEC_Receive_IT() APIs):
\r
32 (+) Configure the CEC interrupt priority.
\r
33 (+) Enable the NVIC CEC IRQ handle.
\r
34 (@) The specific CEC interrupts (Transmission complete interrupt,
\r
35 RXNE interrupt and Error Interrupts) will be managed using the macros
\r
36 __HAL_CEC_ENABLE_IT() and __HAL_CEC_DISABLE_IT() inside the transmit
\r
37 and receive process.
\r
39 (#) Program the Signal Free Time (SFT) and SFT option, Tolerance, reception stop in
\r
40 in case of Bit Rising Error, Error-Bit generation conditions, device logical
\r
41 address and Listen mode in the hcec Init structure.
\r
43 (#) Initialize the CEC registers by calling the HAL_CEC_Init() API.
\r
45 (@) This API (HAL_CEC_Init()) configures also the low level Hardware GPIO, CLOCK, CORTEX...etc)
\r
46 by calling the customed HAL_CEC_MspInit() API.
\r
49 ******************************************************************************
\r
52 * <h2><center>© COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
\r
54 * Redistribution and use in source and binary forms, with or without modification,
\r
55 * are permitted provided that the following conditions are met:
\r
56 * 1. Redistributions of source code must retain the above copyright notice,
\r
57 * this list of conditions and the following disclaimer.
\r
58 * 2. Redistributions in binary form must reproduce the above copyright notice,
\r
59 * this list of conditions and the following disclaimer in the documentation
\r
60 * and/or other materials provided with the distribution.
\r
61 * 3. Neither the name of STMicroelectronics nor the names of its contributors
\r
62 * may be used to endorse or promote products derived from this software
\r
63 * without specific prior written permission.
\r
65 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
\r
66 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
\r
67 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
\r
68 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
\r
69 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
\r
70 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
\r
71 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
\r
72 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
\r
73 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
\r
74 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
\r
76 ******************************************************************************
\r
79 /* Includes ------------------------------------------------------------------*/
\r
80 #include "stm32f7xx_hal.h"
\r
82 /** @addtogroup STM32F7xx_HAL_Driver
\r
86 /** @defgroup CEC CEC
\r
87 * @brief HAL CEC module driver
\r
90 #ifdef HAL_CEC_MODULE_ENABLED
\r
92 /* Private typedef -----------------------------------------------------------*/
\r
93 /* Private define ------------------------------------------------------------*/
\r
94 /** @defgroup CEC_Private_Constants CEC Private Constants
\r
97 #define CEC_CFGR_FIELDS (CEC_CFGR_SFT | CEC_CFGR_RXTOL | CEC_CFGR_BRESTP \
\r
98 | CEC_CFGR_BREGEN | CEC_CFGR_LBPEGEN | CEC_CFGR_SFTOPT \
\r
99 | CEC_CFGR_BRDNOGEN | CEC_CFGR_OAR | CEC_CFGR_LSTN)
\r
104 /* Private macro -------------------------------------------------------------*/
\r
105 /* Private variables ---------------------------------------------------------*/
\r
106 /* Private function prototypes -----------------------------------------------*/
\r
107 /** @defgroup CEC_Private_Functions CEC Private Functions
\r
110 static HAL_StatusTypeDef CEC_Transmit_IT(CEC_HandleTypeDef *hcec);
\r
111 static HAL_StatusTypeDef CEC_Receive_IT(CEC_HandleTypeDef *hcec);
\r
116 /* Exported functions ---------------------------------------------------------*/
\r
118 /** @defgroup CEC_Exported_Functions CEC Exported Functions
\r
122 /** @defgroup CEC_Exported_Functions_Group1 Initialization and de-initialization functions
\r
123 * @brief Initialization and Configuration functions
\r
126 ===============================================================================
\r
127 ##### Initialization and Configuration functions #####
\r
128 ===============================================================================
\r
130 This subsection provides a set of functions allowing to initialize the CEC
\r
131 (+) The following parameters need to be configured:
\r
132 (++) SignalFreeTime
\r
134 (++) BRERxStop (RX stopped or not upon Bit Rising Error)
\r
135 (++) BREErrorBitGen (Error-Bit generation in case of Bit Rising Error)
\r
136 (++) LBPEErrorBitGen (Error-Bit generation in case of Long Bit Period Error)
\r
137 (++) BroadcastMsgNoErrorBitGen (Error-bit generation in case of broadcast message error)
\r
138 (++) SignalFreeTimeOption (SFT Timer start definition)
\r
139 (++) OwnAddress (CEC device address)
\r
147 * @brief Initializes the CEC mode according to the specified
\r
148 * parameters in the CEC_InitTypeDef and creates the associated handle .
\r
149 * @param hcec: CEC handle
\r
150 * @retval HAL status
\r
152 HAL_StatusTypeDef HAL_CEC_Init(CEC_HandleTypeDef *hcec)
\r
154 uint32_t tmpreg = 0x0;
\r
156 /* Check the CEC handle allocation */
\r
162 /* Check the parameters */
\r
163 assert_param(IS_CEC_ALL_INSTANCE(hcec->Instance));
\r
164 assert_param(IS_CEC_SIGNALFREETIME(hcec->Init.SignalFreeTime));
\r
165 assert_param(IS_CEC_TOLERANCE(hcec->Init.Tolerance));
\r
166 assert_param(IS_CEC_BRERXSTOP(hcec->Init.BRERxStop));
\r
167 assert_param(IS_CEC_BREERRORBITGEN(hcec->Init.BREErrorBitGen));
\r
168 assert_param(IS_CEC_LBPEERRORBITGEN(hcec->Init.LBPEErrorBitGen));
\r
169 assert_param(IS_CEC_BROADCASTERROR_NO_ERRORBIT_GENERATION(hcec->Init.BroadcastMsgNoErrorBitGen));
\r
170 assert_param(IS_CEC_SFTOP(hcec->Init.SignalFreeTimeOption));
\r
171 assert_param(IS_CEC_OAR_ADDRESS(hcec->Init.OwnAddress));
\r
172 assert_param(IS_CEC_LISTENING_MODE(hcec->Init.ListenMode));
\r
173 assert_param(IS_CEC_ADDRESS(hcec->Init.InitiatorAddress));
\r
176 if(hcec->State == HAL_CEC_STATE_RESET)
\r
178 /* Allocate lock resource and initialize it */
\r
179 hcec->Lock = HAL_UNLOCKED;
\r
180 /* Init the low level hardware : GPIO, CLOCK */
\r
181 HAL_CEC_MspInit(hcec);
\r
184 hcec->State = HAL_CEC_STATE_BUSY;
\r
186 /* Disable the Peripheral */
\r
187 __HAL_CEC_DISABLE(hcec);
\r
189 tmpreg = hcec->Init.SignalFreeTime;
\r
190 tmpreg |= hcec->Init.Tolerance;
\r
191 tmpreg |= hcec->Init.BRERxStop;
\r
192 tmpreg |= hcec->Init.BREErrorBitGen;
\r
193 tmpreg |= hcec->Init.LBPEErrorBitGen;
\r
194 tmpreg |= hcec->Init.BroadcastMsgNoErrorBitGen;
\r
195 tmpreg |= hcec->Init.SignalFreeTimeOption;
\r
196 tmpreg |= (hcec->Init.OwnAddress << CEC_CFGR_OAR_LSB_POS);
\r
197 tmpreg |= hcec->Init.ListenMode;
\r
199 /* Write to CEC Control Register */
\r
200 MODIFY_REG(hcec->Instance->CFGR, CEC_CFGR_FIELDS, tmpreg);
\r
202 /* Enable the Peripheral */
\r
203 __HAL_CEC_ENABLE(hcec);
\r
205 hcec->State = HAL_CEC_STATE_READY;
\r
211 * @brief DeInitializes the CEC peripheral
\r
212 * @param hcec: CEC handle
\r
213 * @retval HAL status
\r
215 HAL_StatusTypeDef HAL_CEC_DeInit(CEC_HandleTypeDef *hcec)
\r
217 /* Check the CEC handle allocation */
\r
223 /* Check the parameters */
\r
224 assert_param(IS_CEC_ALL_INSTANCE(hcec->Instance));
\r
226 hcec->State = HAL_CEC_STATE_BUSY;
\r
228 /* DeInit the low level hardware */
\r
229 HAL_CEC_MspDeInit(hcec);
\r
230 /* Disable the Peripheral */
\r
231 __HAL_CEC_DISABLE(hcec);
\r
233 hcec->ErrorCode = HAL_CEC_ERROR_NONE;
\r
234 hcec->State = HAL_CEC_STATE_RESET;
\r
236 /* Process Unlock */
\r
237 __HAL_UNLOCK(hcec);
\r
243 * @brief CEC MSP Init
\r
244 * @param hcec: CEC handle
\r
247 __weak void HAL_CEC_MspInit(CEC_HandleTypeDef *hcec)
\r
249 /* NOTE : This function should not be modified, when the callback is needed,
\r
250 the HAL_CEC_MspInit can be implemented in the user file
\r
255 * @brief CEC MSP DeInit
\r
256 * @param hcec: CEC handle
\r
259 __weak void HAL_CEC_MspDeInit(CEC_HandleTypeDef *hcec)
\r
261 /* NOTE : This function should not be modified, when the callback is needed,
\r
262 the HAL_CEC_MspDeInit can be implemented in the user file
\r
270 /** @defgroup CEC_Exported_Functions_Group2 Input and Output operation functions
\r
271 * @brief CEC Transmit/Receive functions
\r
274 ===============================================================================
\r
275 ##### I/O operation functions #####
\r
276 ===============================================================================
\r
277 This subsection provides a set of functions allowing to manage the CEC data transfers.
\r
279 (#) The CEC handle must contain the initiator (TX side) and the destination (RX side)
\r
280 logical addresses (4-bit long addresses, 0xF for broadcast messages destination)
\r
282 (#) There are two mode of transfer:
\r
283 (+) Blocking mode: The communication is performed in polling mode.
\r
284 The HAL status of all data processing is returned by the same function
\r
285 after finishing transfer.
\r
286 (+) No-Blocking mode: The communication is performed using Interrupts.
\r
287 These API's return the HAL status.
\r
288 The end of the data processing will be indicated through the
\r
289 dedicated CEC IRQ when using Interrupt mode.
\r
290 The HAL_CEC_TxCpltCallback(), HAL_CEC_RxCpltCallback() user callbacks
\r
291 will be executed respectively at the end of the transmit or Receive process
\r
292 The HAL_CEC_ErrorCallback()user callback will be executed when a communication
\r
295 (#) Blocking mode API's are :
\r
296 (+) HAL_CEC_Transmit()
\r
297 (+) HAL_CEC_Receive()
\r
299 (#) Non-Blocking mode API's with Interrupt are :
\r
300 (+) HAL_CEC_Transmit_IT()
\r
301 (+) HAL_CEC_Receive_IT()
\r
302 (+) HAL_CEC_IRQHandler()
\r
304 (#) A set of Transfer Complete Callbacks are provided in No_Blocking mode:
\r
305 (+) HAL_CEC_TxCpltCallback()
\r
306 (+) HAL_CEC_RxCpltCallback()
\r
307 (+) HAL_CEC_ErrorCallback()
\r
314 * @brief Send data in blocking mode
\r
315 * @param hcec: CEC handle
\r
316 * @param DestinationAddress: destination logical address
\r
317 * @param pData: pointer to input byte data buffer
\r
318 * @param Size: amount of data to be sent in bytes (without counting the header).
\r
319 * 0 means only the header is sent (ping operation).
\r
320 * Maximum TX size is 15 bytes (1 opcode and up to 14 operands).
\r
321 * @param Timeout: Timeout duration.
\r
322 * @retval HAL status
\r
324 HAL_StatusTypeDef HAL_CEC_Transmit(CEC_HandleTypeDef *hcec, uint8_t DestinationAddress, uint8_t *pData, uint32_t Size, uint32_t Timeout)
\r
327 uint32_t tempisr = 0;
\r
328 uint32_t tickstart = 0;
\r
330 if((hcec->State == HAL_CEC_STATE_READY) && (__HAL_CEC_GET_TRANSMISSION_START_FLAG(hcec) == RESET))
\r
332 hcec->ErrorCode = HAL_CEC_ERROR_NONE;
\r
333 if((pData == NULL ) && (Size > 0))
\r
335 hcec->State = HAL_CEC_STATE_ERROR;
\r
339 assert_param(IS_CEC_ADDRESS(DestinationAddress));
\r
340 assert_param(IS_CEC_MSGSIZE(Size));
\r
342 /* Process Locked */
\r
345 hcec->State = HAL_CEC_STATE_BUSY_TX;
\r
347 hcec->TxXferCount = Size;
\r
349 /* case no data to be sent, sender is only pinging the system */
\r
352 /* Set TX End of Message (TXEOM) bit, must be set before writing data to TXDR */
\r
353 __HAL_CEC_LAST_BYTE_TX_SET(hcec);
\r
356 /* send header block */
\r
357 temp = ((uint32_t)hcec->Init.InitiatorAddress << CEC_INITIATOR_LSB_POS) | DestinationAddress;
\r
358 hcec->Instance->TXDR = temp;
\r
359 /* Set TX Start of Message (TXSOM) bit */
\r
360 __HAL_CEC_FIRST_BYTE_TX_SET(hcec);
\r
362 while (hcec->TxXferCount > 0)
\r
364 hcec->TxXferCount--;
\r
366 tickstart = HAL_GetTick();
\r
367 while(HAL_IS_BIT_CLR(hcec->Instance->ISR, CEC_FLAG_TXBR))
\r
369 if(Timeout != HAL_MAX_DELAY)
\r
371 if((HAL_GetTick() - tickstart) > Timeout)
\r
373 hcec->State = HAL_CEC_STATE_TIMEOUT;
\r
374 /* Process Unlocked */
\r
375 __HAL_UNLOCK(hcec);
\r
376 return HAL_TIMEOUT;
\r
380 /* check whether error occurred while waiting for TXBR to be set:
\r
381 * has Tx underrun occurred ?
\r
382 * has Tx error occurred ?
\r
383 * has Tx Missing Acknowledge error occurred ?
\r
384 * has Arbitration Loss error occurred ? */
\r
385 tempisr = hcec->Instance->ISR;
\r
386 if ((tempisr & (CEC_FLAG_TXUDR|CEC_FLAG_TXERR|CEC_FLAG_TXACKE|CEC_FLAG_ARBLST)) != 0)
\r
388 /* copy ISR for error handling purposes */
\r
389 hcec->ErrorCode = tempisr;
\r
390 /* clear all error flags by default */
\r
391 __HAL_CEC_CLEAR_FLAG(hcec, (CEC_FLAG_TXUDR|CEC_FLAG_TXERR|CEC_FLAG_TXACKE|CEC_FLAG_ARBLST));
\r
392 hcec->State = HAL_CEC_STATE_ERROR;
\r
393 __HAL_UNLOCK(hcec);
\r
397 /* TXBR to clear BEFORE writing TXDR register */
\r
398 __HAL_CEC_CLEAR_FLAG(hcec, CEC_FLAG_TXBR);
\r
399 if (hcec->TxXferCount == 0)
\r
401 /* if last byte transmission, set TX End of Message (TXEOM) bit */
\r
402 __HAL_CEC_LAST_BYTE_TX_SET(hcec);
\r
404 hcec->Instance->TXDR = *pData++;
\r
406 /* error check after TX byte write up */
\r
407 tempisr = hcec->Instance->ISR;
\r
408 if ((tempisr & (CEC_FLAG_TXUDR|CEC_FLAG_TXERR|CEC_FLAG_TXACKE|CEC_FLAG_ARBLST)) != 0)
\r
410 /* copy ISR for error handling purposes */
\r
411 hcec->ErrorCode = tempisr;
\r
412 /* clear all error flags by default */
\r
413 __HAL_CEC_CLEAR_FLAG(hcec, (CEC_FLAG_TXUDR|CEC_FLAG_TXERR|CEC_FLAG_TXACKE|CEC_FLAG_ARBLST));
\r
414 hcec->State = HAL_CEC_STATE_ERROR;
\r
415 __HAL_UNLOCK(hcec);
\r
418 } /* end while (while (hcec->TxXferCount > 0)) */
\r
421 /* if no error up to this point, check that transmission is
\r
422 * complete, that is wait until TXEOM is reset */
\r
423 tickstart = HAL_GetTick();
\r
425 while (HAL_IS_BIT_SET(hcec->Instance->CR, CEC_CR_TXEOM))
\r
427 if(Timeout != HAL_MAX_DELAY)
\r
429 if((HAL_GetTick() - tickstart) > Timeout)
\r
431 hcec->State = HAL_CEC_STATE_ERROR;
\r
432 __HAL_UNLOCK(hcec);
\r
433 return HAL_TIMEOUT;
\r
438 /* Final error check once all bytes have been transmitted */
\r
439 tempisr = hcec->Instance->ISR;
\r
440 if ((tempisr & (CEC_FLAG_TXUDR|CEC_FLAG_TXERR|CEC_FLAG_TXACKE)) != 0)
\r
442 /* copy ISR for error handling purposes */
\r
443 hcec->ErrorCode = tempisr;
\r
444 /* clear all error flags by default */
\r
445 __HAL_CEC_CLEAR_FLAG(hcec, (CEC_FLAG_TXUDR|CEC_FLAG_TXERR|CEC_FLAG_TXACKE));
\r
446 hcec->State = HAL_CEC_STATE_ERROR;
\r
447 __HAL_UNLOCK(hcec);
\r
451 hcec->State = HAL_CEC_STATE_READY;
\r
452 __HAL_UNLOCK(hcec);
\r
463 * @brief Receive data in blocking mode. Must be invoked when RXBR has been set.
\r
464 * @param hcec: CEC handle
\r
465 * @param pData: pointer to received data buffer.
\r
466 * @param Timeout: Timeout duration.
\r
467 * Note that the received data size is not known beforehand, the latter is known
\r
468 * when the reception is complete and is stored in hcec->RxXferSize.
\r
469 * hcec->RxXferSize is the sum of opcodes + operands (0 to 14 operands max).
\r
470 * If only a header is received, hcec->RxXferSize = 0
\r
471 * @retval HAL status
\r
473 HAL_StatusTypeDef HAL_CEC_Receive(CEC_HandleTypeDef *hcec, uint8_t *pData, uint32_t Timeout)
\r
476 uint32_t tickstart = 0;
\r
478 if (hcec->State == HAL_CEC_STATE_READY)
\r
480 hcec->ErrorCode = HAL_CEC_ERROR_NONE;
\r
481 if (pData == NULL )
\r
483 hcec->State = HAL_CEC_STATE_ERROR;
\r
487 hcec->RxXferSize = 0;
\r
488 /* Process Locked */
\r
492 /* Rx loop until CEC_ISR_RXEND is set */
\r
493 while (HAL_IS_BIT_CLR(hcec->Instance->ISR, CEC_FLAG_RXEND))
\r
495 tickstart = HAL_GetTick();
\r
496 /* Wait for next byte to be received */
\r
497 while (HAL_IS_BIT_CLR(hcec->Instance->ISR, CEC_FLAG_RXBR))
\r
499 if(Timeout != HAL_MAX_DELAY)
\r
501 if((HAL_GetTick() - tickstart) > Timeout)
\r
503 hcec->State = HAL_CEC_STATE_TIMEOUT;
\r
504 __HAL_UNLOCK(hcec);
\r
505 return HAL_TIMEOUT;
\r
508 /* any error so far ?
\r
509 * has Rx Missing Acknowledge occurred ?
\r
510 * has Rx Long Bit Period error occurred ?
\r
511 * has Rx Short Bit Period error occurred ?
\r
512 * has Rx Bit Rising error occurred ?
\r
513 * has Rx Overrun error occurred ? */
\r
514 temp = (uint32_t) (hcec->Instance->ISR);
\r
515 if ((temp & (CEC_FLAG_RXACKE|CEC_FLAG_LBPE|CEC_FLAG_SBPE|CEC_FLAG_BRE|CEC_FLAG_RXOVR)) != 0)
\r
517 /* copy ISR for error handling purposes */
\r
518 hcec->ErrorCode = temp;
\r
519 /* clear all error flags by default */
\r
520 __HAL_CEC_CLEAR_FLAG(hcec,(CEC_FLAG_RXACKE|CEC_FLAG_LBPE|CEC_FLAG_SBPE|CEC_FLAG_BRE|CEC_FLAG_RXOVR));
\r
521 hcec->State = HAL_CEC_STATE_ERROR;
\r
522 __HAL_UNLOCK(hcec);
\r
525 } /* while (HAL_IS_BIT_CLR(hcec->Instance->ISR, CEC_ISR_RXBR)) */
\r
528 /* read received data */
\r
529 *pData++ = hcec->Instance->RXDR;
\r
530 temp = (uint32_t) (hcec->Instance->ISR);
\r
531 /* end of message ? */
\r
532 if ((temp & CEC_ISR_RXEND) != 0)
\r
534 assert_param(IS_CEC_MSGSIZE(hcec->RxXferSize));
\r
535 __HAL_CEC_CLEAR_FLAG(hcec,CEC_FLAG_RXEND);
\r
536 hcec->State = HAL_CEC_STATE_READY;
\r
537 __HAL_UNLOCK(hcec);
\r
541 /* clear Rx-Byte Received flag */
\r
542 __HAL_CEC_CLEAR_FLAG(hcec,CEC_FLAG_RXBR);
\r
543 /* increment payload byte counter */
\r
544 hcec->RxXferSize++;
\r
545 } /* while (HAL_IS_BIT_CLR(hcec->Instance->ISR, CEC_ISR_RXEND)) */
\r
547 /* if the instructions below are executed, it means RXEND was set when RXBR was
\r
548 * set for the first time:
\r
549 * the code within the "while (HAL_IS_BIT_CLR(hcec->Instance->ISR, CEC_ISR_RXEND))"
\r
550 * loop has not been executed and this means a single byte has been sent */
\r
551 *pData++ = hcec->Instance->RXDR;
\r
552 /* only one header is received: RxXferSize is set to 0 (no operand, no opcode) */
\r
553 hcec->RxXferSize = 0;
\r
554 __HAL_CEC_CLEAR_FLAG(hcec, CEC_FLAG_RXEND);
\r
556 hcec->State = HAL_CEC_STATE_READY;
\r
557 __HAL_UNLOCK(hcec);
\r
567 * @brief Send data in interrupt mode
\r
568 * @param hcec: CEC handle
\r
569 * @param DestinationAddress: destination logical address
\r
570 * @param pData: pointer to input byte data buffer
\r
571 * @param Size: amount of data to be sent in bytes (without counting the header).
\r
572 * 0 means only the header is sent (ping operation).
\r
573 * Maximum TX size is 15 bytes (1 opcode and up to 14 operands).
\r
574 * @retval HAL status
\r
576 HAL_StatusTypeDef HAL_CEC_Transmit_IT(CEC_HandleTypeDef *hcec, uint8_t DestinationAddress, uint8_t *pData, uint32_t Size)
\r
579 /* if the IP isn't already busy and if there is no previous transmission
\r
580 already pending due to arbitration lost */
\r
581 if (((hcec->State == HAL_CEC_STATE_READY) || (hcec->State == HAL_CEC_STATE_STANDBY_RX))
\r
582 && (__HAL_CEC_GET_TRANSMISSION_START_FLAG(hcec) == RESET))
\r
584 if((pData == NULL ) && (Size > 0))
\r
586 hcec->State = HAL_CEC_STATE_ERROR;
\r
590 assert_param(IS_CEC_ADDRESS(DestinationAddress));
\r
591 assert_param(IS_CEC_MSGSIZE(Size));
\r
593 /* Process Locked */
\r
595 hcec->pTxBuffPtr = pData;
\r
596 hcec->State = HAL_CEC_STATE_BUSY_TX;
\r
597 hcec->ErrorCode = HAL_CEC_ERROR_NONE;
\r
599 /* Disable Peripheral to write CEC_IER register */
\r
600 __HAL_CEC_DISABLE(hcec);
\r
602 /* Enable the following two CEC Transmission interrupts as
\r
603 * well as the following CEC Transmission Errors interrupts:
\r
604 * Tx Byte Request IT
\r
605 * End of Transmission IT
\r
606 * Tx Missing Acknowledge IT
\r
608 * Tx-Buffer Underrun IT
\r
609 * Tx arbitration lost */
\r
610 __HAL_CEC_ENABLE_IT(hcec, CEC_IT_TXBR|CEC_IT_TXEND|CEC_IER_TX_ALL_ERR);
\r
612 /* Enable the Peripheral */
\r
613 __HAL_CEC_ENABLE(hcec);
\r
615 /* initialize the number of bytes to send,
\r
616 * 0 means only one header is sent (ping operation) */
\r
617 hcec->TxXferCount = Size;
\r
619 /* Process Unlocked */
\r
620 __HAL_UNLOCK(hcec);
\r
622 /* in case of no payload (Size = 0), sender is only pinging the system;
\r
623 * Set TX End of Message (TXEOM) bit, must be set before writing data to TXDR */
\r
626 __HAL_CEC_LAST_BYTE_TX_SET(hcec);
\r
629 /* send header block */
\r
630 temp = ((uint32_t)hcec->Init.InitiatorAddress << CEC_INITIATOR_LSB_POS) | DestinationAddress;
\r
631 hcec->Instance->TXDR = temp;
\r
632 /* Set TX Start of Message (TXSOM) bit */
\r
633 __HAL_CEC_FIRST_BYTE_TX_SET(hcec);
\r
637 /* if the IP is already busy or if there is a previous transmission
\r
638 already pending due to arbitration loss */
\r
639 else if ((hcec->State == HAL_CEC_STATE_BUSY_TX)
\r
640 || (__HAL_CEC_GET_TRANSMISSION_START_FLAG(hcec) != RESET))
\r
643 /* set state to BUSY TX, in case it wasn't set already (case
\r
644 * of transmission new attempt after arbitration loss) */
\r
645 if (hcec->State != HAL_CEC_STATE_BUSY_TX)
\r
647 hcec->State = HAL_CEC_STATE_BUSY_TX;
\r
650 /* if all data have been sent */
\r
651 if(hcec->TxXferCount == 0)
\r
653 /* Disable Peripheral to write CEC_IER register */
\r
654 __HAL_CEC_DISABLE(hcec);
\r
656 /* Disable the CEC Transmission Interrupts */
\r
657 __HAL_CEC_DISABLE_IT(hcec, CEC_IT_TXBR|CEC_IT_TXEND);
\r
658 /* Disable the CEC Transmission Error Interrupts */
\r
659 __HAL_CEC_DISABLE_IT(hcec, CEC_IER_TX_ALL_ERR);
\r
661 /* Enable the Peripheral */
\r
662 __HAL_CEC_ENABLE(hcec);
\r
664 __HAL_CEC_CLEAR_FLAG(hcec, CEC_FLAG_TXBR|CEC_FLAG_TXEND);
\r
666 hcec->State = HAL_CEC_STATE_READY;
\r
667 /* Call the Process Unlocked before calling the Tx call back API to give the possibility to
\r
668 start again the Transmission under the Tx call back API */
\r
669 __HAL_UNLOCK(hcec);
\r
671 HAL_CEC_TxCpltCallback(hcec);
\r
677 if (hcec->TxXferCount == 1)
\r
679 /* if this is the last byte transmission, set TX End of Message (TXEOM) bit */
\r
680 __HAL_CEC_LAST_BYTE_TX_SET(hcec);
\r
682 /* clear Tx-Byte request flag */
\r
683 __HAL_CEC_CLEAR_FLAG(hcec, CEC_FLAG_TXBR);
\r
684 hcec->Instance->TXDR = *hcec->pTxBuffPtr++;
\r
685 hcec->TxXferCount--;
\r
687 /* Process Unlocked */
\r
688 __HAL_UNLOCK(hcec);
\r
700 * @brief Receive data in interrupt mode.
\r
701 * @param hcec: CEC handle
\r
702 * @param pData: pointer to received data buffer.
\r
703 * Note that the received data size is not known beforehand, the latter is known
\r
704 * when the reception is complete and is stored in hcec->RxXferSize.
\r
705 * hcec->RxXferSize is the sum of opcodes + operands (0 to 14 operands max).
\r
706 * If only a header is received, hcec->RxXferSize = 0
\r
707 * @retval HAL status
\r
709 HAL_StatusTypeDef HAL_CEC_Receive_IT(CEC_HandleTypeDef *hcec, uint8_t *pData)
\r
711 if(hcec->State == HAL_CEC_STATE_READY)
\r
713 if(pData == NULL )
\r
715 hcec->State = HAL_CEC_STATE_ERROR;
\r
719 /* Process Locked */
\r
721 hcec->RxXferSize = 0;
\r
722 hcec->pRxBuffPtr = pData;
\r
723 hcec->ErrorCode = HAL_CEC_ERROR_NONE;
\r
724 /* the IP is moving to a ready to receive state */
\r
725 hcec->State = HAL_CEC_STATE_STANDBY_RX;
\r
727 /* Disable Peripheral to write CEC_IER register */
\r
728 __HAL_CEC_DISABLE(hcec);
\r
730 /* Enable the following CEC Reception Error Interrupts:
\r
732 * Rx bit rising error
\r
733 * Rx short bit period error
\r
734 * Rx long bit period error
\r
735 * Rx missing acknowledge */
\r
736 __HAL_CEC_ENABLE_IT(hcec, CEC_IER_RX_ALL_ERR);
\r
738 /* Process Unlocked */
\r
739 __HAL_UNLOCK(hcec);
\r
741 /* Enable the following two CEC Reception interrupts:
\r
742 * Rx Byte Received IT
\r
743 * End of Reception IT */
\r
744 __HAL_CEC_ENABLE_IT(hcec, CEC_IT_RXBR|CEC_IT_RXEND);
\r
746 __HAL_CEC_ENABLE(hcec);
\r
757 * @brief Get size of the received frame.
\r
758 * @param hcec: CEC handle
\r
759 * @retval Frame size
\r
761 uint32_t HAL_CEC_GetReceivedFrameSize(CEC_HandleTypeDef *hcec)
\r
763 return hcec->RxXferSize;
\r
767 * @brief This function handles CEC interrupt requests.
\r
768 * @param hcec: CEC handle
\r
771 void HAL_CEC_IRQHandler(CEC_HandleTypeDef *hcec)
\r
773 /* save interrupts register for further error or interrupts handling purposes */
\r
774 hcec->ErrorCode = hcec->Instance->ISR;
\r
775 /* CEC TX missing acknowledge error interrupt occurred -------------------------------------*/
\r
776 if((__HAL_CEC_GET_FLAG(hcec, CEC_FLAG_TXACKE) != RESET) && (__HAL_CEC_GET_IT_SOURCE(hcec, CEC_IT_TXACKE) != RESET))
\r
778 __HAL_CEC_CLEAR_FLAG(hcec, CEC_FLAG_TXACKE);
\r
779 hcec->State = HAL_CEC_STATE_ERROR;
\r
782 /* CEC transmit error interrupt occurred --------------------------------------*/
\r
783 if((__HAL_CEC_GET_FLAG(hcec, CEC_FLAG_TXERR) != RESET) && (__HAL_CEC_GET_IT_SOURCE(hcec, CEC_IT_TXERR) != RESET))
\r
785 __HAL_CEC_CLEAR_FLAG(hcec, CEC_FLAG_TXERR);
\r
786 hcec->State = HAL_CEC_STATE_ERROR;
\r
789 /* CEC TX underrun error interrupt occurred --------------------------------------*/
\r
790 if((__HAL_CEC_GET_FLAG(hcec, CEC_FLAG_TXUDR) != RESET) && (__HAL_CEC_GET_IT_SOURCE(hcec, CEC_IT_TXUDR) != RESET))
\r
792 __HAL_CEC_CLEAR_FLAG(hcec, CEC_FLAG_TXUDR);
\r
793 hcec->State = HAL_CEC_STATE_ERROR;
\r
796 /* CEC TX arbitration error interrupt occurred --------------------------------------*/
\r
797 if((__HAL_CEC_GET_FLAG(hcec, CEC_FLAG_ARBLST) != RESET) && (__HAL_CEC_GET_IT_SOURCE(hcec, CEC_IT_ARBLST) != RESET))
\r
799 __HAL_CEC_CLEAR_FLAG(hcec, CEC_FLAG_ARBLST);
\r
800 hcec->State = HAL_CEC_STATE_ERROR;
\r
803 /* CEC RX overrun error interrupt occurred --------------------------------------*/
\r
804 if((__HAL_CEC_GET_FLAG(hcec, CEC_FLAG_RXOVR) != RESET) && (__HAL_CEC_GET_IT_SOURCE(hcec, CEC_IT_RXOVR) != RESET))
\r
806 __HAL_CEC_CLEAR_FLAG(hcec, CEC_FLAG_RXOVR);
\r
807 hcec->State = HAL_CEC_STATE_ERROR;
\r
810 /* CEC RX bit rising error interrupt occurred --------------------------------------*/
\r
811 if((__HAL_CEC_GET_FLAG(hcec, CEC_FLAG_BRE) != RESET) && (__HAL_CEC_GET_IT_SOURCE(hcec, CEC_IT_BRE) != RESET))
\r
813 __HAL_CEC_CLEAR_FLAG(hcec, CEC_FLAG_BRE);
\r
814 hcec->State = HAL_CEC_STATE_ERROR;
\r
817 /* CEC RX short bit period error interrupt occurred --------------------------------------*/
\r
818 if((__HAL_CEC_GET_FLAG(hcec, CEC_FLAG_SBPE) != RESET) && (__HAL_CEC_GET_IT_SOURCE(hcec, CEC_IT_SBPE) != RESET))
\r
820 __HAL_CEC_CLEAR_FLAG(hcec, CEC_FLAG_SBPE);
\r
821 hcec->State = HAL_CEC_STATE_ERROR;
\r
824 /* CEC RX long bit period error interrupt occurred --------------------------------------*/
\r
825 if((__HAL_CEC_GET_FLAG(hcec, CEC_FLAG_LBPE) != RESET) && (__HAL_CEC_GET_IT_SOURCE(hcec, CEC_IT_LBPE) != RESET))
\r
827 __HAL_CEC_CLEAR_FLAG(hcec, CEC_FLAG_LBPE);
\r
828 hcec->State = HAL_CEC_STATE_ERROR;
\r
831 /* CEC RX missing acknowledge error interrupt occurred --------------------------------------*/
\r
832 if((__HAL_CEC_GET_FLAG(hcec, CEC_FLAG_RXACKE) != RESET) && (__HAL_CEC_GET_IT_SOURCE(hcec, CEC_IT_RXACKE) != RESET))
\r
834 __HAL_CEC_CLEAR_FLAG(hcec, CEC_FLAG_RXACKE);
\r
835 hcec->State = HAL_CEC_STATE_ERROR;
\r
838 if ((hcec->ErrorCode & CEC_ISR_ALL_ERROR) != 0)
\r
840 HAL_CEC_ErrorCallback(hcec);
\r
843 /* CEC RX byte received interrupt ---------------------------------------------------*/
\r
844 if((__HAL_CEC_GET_FLAG(hcec, CEC_FLAG_RXBR) != RESET) && (__HAL_CEC_GET_IT_SOURCE(hcec, CEC_IT_RXBR) != RESET))
\r
846 /* RXBR IT is cleared during HAL_CEC_Transmit_IT processing */
\r
847 CEC_Receive_IT(hcec);
\r
850 /* CEC RX end received interrupt ---------------------------------------------------*/
\r
851 if((__HAL_CEC_GET_FLAG(hcec, CEC_FLAG_RXEND) != RESET) && (__HAL_CEC_GET_IT_SOURCE(hcec, CEC_IT_RXEND) != RESET))
\r
853 /* RXBR IT is cleared during HAL_CEC_Transmit_IT processing */
\r
854 CEC_Receive_IT(hcec);
\r
858 /* CEC TX byte request interrupt ------------------------------------------------*/
\r
859 if((__HAL_CEC_GET_FLAG(hcec, CEC_FLAG_TXBR) != RESET) &&(__HAL_CEC_GET_IT_SOURCE(hcec, CEC_IT_TXBR) != RESET))
\r
861 /* TXBR IT is cleared during HAL_CEC_Transmit_IT processing */
\r
862 CEC_Transmit_IT(hcec);
\r
865 /* CEC TX end interrupt ------------------------------------------------*/
\r
866 if((__HAL_CEC_GET_FLAG(hcec, CEC_FLAG_TXEND) != RESET) &&(__HAL_CEC_GET_IT_SOURCE(hcec, CEC_IT_TXEND) != RESET))
\r
868 /* TXEND IT is cleared during HAL_CEC_Transmit_IT processing */
\r
869 CEC_Transmit_IT(hcec);
\r
874 * @brief Tx Transfer completed callback
\r
875 * @param hcec: CEC handle
\r
878 __weak void HAL_CEC_TxCpltCallback(CEC_HandleTypeDef *hcec)
\r
880 /* NOTE : This function should not be modified, when the callback is needed,
\r
881 the HAL_CEC_TxCpltCallback can be implemented in the user file
\r
886 * @brief Rx Transfer completed callback
\r
887 * @param hcec: CEC handle
\r
890 __weak void HAL_CEC_RxCpltCallback(CEC_HandleTypeDef *hcec)
\r
892 /* NOTE : This function should not be modified, when the callback is needed,
\r
893 the HAL_CEC_TxCpltCallback can be implemented in the user file
\r
898 * @brief CEC error callbacks
\r
899 * @param hcec: CEC handle
\r
902 __weak void HAL_CEC_ErrorCallback(CEC_HandleTypeDef *hcec)
\r
904 /* NOTE : This function should not be modified, when the callback is needed,
\r
905 the HAL_CEC_ErrorCallback can be implemented in the user file
\r
912 /** @defgroup CEC_Exported_Functions_Group3 Peripheral Control function
\r
913 * @brief CEC control functions
\r
916 ===============================================================================
\r
917 ##### Peripheral Control function #####
\r
918 ===============================================================================
\r
920 This subsection provides a set of functions allowing to control the CEC.
\r
921 (+) HAL_CEC_GetState() API can be helpful to check in run-time the state of the CEC peripheral.
\r
926 * @brief return the CEC state
\r
927 * @param hcec: CEC handle
\r
928 * @retval HAL state
\r
930 HAL_CEC_StateTypeDef HAL_CEC_GetState(CEC_HandleTypeDef *hcec)
\r
932 return hcec->State;
\r
936 * @brief Return the CEC error code
\r
937 * @param hcec : pointer to a CEC_HandleTypeDef structure that contains
\r
938 * the configuration information for the specified CEC.
\r
939 * @retval CEC Error Code
\r
941 uint32_t HAL_CEC_GetError(CEC_HandleTypeDef *hcec)
\r
943 return hcec->ErrorCode;
\r
951 * @brief Send data in interrupt mode
\r
952 * @param hcec: CEC handle.
\r
953 * Function called under interruption only, once
\r
954 * interruptions have been enabled by HAL_CEC_Transmit_IT()
\r
955 * @retval HAL status
\r
957 static HAL_StatusTypeDef CEC_Transmit_IT(CEC_HandleTypeDef *hcec)
\r
959 /* if the IP is already busy or if there is a previous transmission
\r
960 already pending due to arbitration loss */
\r
961 if ((hcec->State == HAL_CEC_STATE_BUSY_TX)
\r
962 || (__HAL_CEC_GET_TRANSMISSION_START_FLAG(hcec) != RESET))
\r
965 /* set state to BUSY TX, in case it wasn't set already (case
\r
966 * of transmission new attempt after arbitration loss) */
\r
967 if (hcec->State != HAL_CEC_STATE_BUSY_TX)
\r
969 hcec->State = HAL_CEC_STATE_BUSY_TX;
\r
972 /* if all data have been sent */
\r
973 if(hcec->TxXferCount == 0)
\r
975 /* Disable Peripheral to write CEC_IER register */
\r
976 __HAL_CEC_DISABLE(hcec);
\r
978 /* Disable the CEC Transmission Interrupts */
\r
979 __HAL_CEC_DISABLE_IT(hcec, CEC_IT_TXBR|CEC_IT_TXEND);
\r
980 /* Disable the CEC Transmission Error Interrupts */
\r
981 __HAL_CEC_DISABLE_IT(hcec, CEC_IER_TX_ALL_ERR);
\r
983 /* Enable the Peripheral */
\r
984 __HAL_CEC_ENABLE(hcec);
\r
986 __HAL_CEC_CLEAR_FLAG(hcec,CEC_FLAG_TXBR|CEC_FLAG_TXEND);
\r
988 hcec->State = HAL_CEC_STATE_READY;
\r
989 /* Call the Process Unlocked before calling the Tx call back API to give the possibility to
\r
990 start again the Transmission under the Tx call back API */
\r
991 __HAL_UNLOCK(hcec);
\r
993 HAL_CEC_TxCpltCallback(hcec);
\r
999 if (hcec->TxXferCount == 1)
\r
1001 /* if this is the last byte transmission, set TX End of Message (TXEOM) bit */
\r
1002 __HAL_CEC_LAST_BYTE_TX_SET(hcec);
\r
1004 /* clear Tx-Byte request flag */
\r
1005 __HAL_CEC_CLEAR_FLAG(hcec,CEC_FLAG_TXBR);
\r
1006 hcec->Instance->TXDR = *hcec->pTxBuffPtr++;
\r
1007 hcec->TxXferCount--;
\r
1009 /* Process Unlocked */
\r
1010 __HAL_UNLOCK(hcec);
\r
1023 * @brief Receive data in interrupt mode.
\r
1024 * @param hcec: CEC handle.
\r
1025 * Function called under interruption only, once
\r
1026 * interruptions have been enabled by HAL_CEC_Receive_IT()
\r
1027 * @retval HAL status
\r
1029 static HAL_StatusTypeDef CEC_Receive_IT(CEC_HandleTypeDef *hcec)
\r
1033 /* Three different conditions are tested to carry out the RX IT processing:
\r
1034 * - the IP is in reception stand-by (the IP state is HAL_CEC_STATE_STANDBY_RX) and
\r
1035 * the reception of the first byte is starting
\r
1036 * - a message reception is already on-going (the IP state is HAL_CEC_STATE_BUSY_RX)
\r
1037 * and a new byte is being received
\r
1038 * - a transmission has just been started (the IP state is HAL_CEC_STATE_BUSY_TX)
\r
1039 * but has been interrupted by a new message reception or discarded due to
\r
1040 * arbitration loss: the reception of the first or higher priority message
\r
1041 * (the arbitration winner) is starting */
\r
1042 if ((hcec->State == HAL_CEC_STATE_STANDBY_RX)
\r
1043 || (hcec->State == HAL_CEC_STATE_BUSY_RX)
\r
1044 || (hcec->State == HAL_CEC_STATE_BUSY_TX))
\r
1046 /* reception is starting */
\r
1047 hcec->State = HAL_CEC_STATE_BUSY_RX;
\r
1048 tempisr = (uint32_t) (hcec->Instance->ISR);
\r
1049 if ((tempisr & CEC_FLAG_RXBR) != 0)
\r
1051 /* Process Locked */
\r
1053 /* read received byte */
\r
1054 *hcec->pRxBuffPtr++ = hcec->Instance->RXDR;
\r
1055 /* if last byte has been received */
\r
1056 if ((tempisr & CEC_FLAG_RXEND) != 0)
\r
1059 __HAL_CEC_CLEAR_FLAG(hcec, CEC_FLAG_RXBR|CEC_FLAG_RXEND);
\r
1060 /* RX interrupts are not disabled at this point.
\r
1061 * Indeed, to disable the IT, the IP must be disabled first
\r
1062 * which resets the TXSOM flag. In case of arbitration loss,
\r
1063 * this leads to a transmission abort.
\r
1064 * Therefore, RX interruptions disabling if so required,
\r
1065 * is done in HAL_CEC_RxCpltCallback */
\r
1067 /* IP state is moved to READY.
\r
1068 * If the IP must remain in standby mode to listen
\r
1069 * any new message, it is up to HAL_CEC_RxCpltCallback
\r
1070 * to move it again to HAL_CEC_STATE_STANDBY_RX */
\r
1071 hcec->State = HAL_CEC_STATE_READY;
\r
1073 /* Call the Process Unlocked before calling the Rx call back API */
\r
1074 __HAL_UNLOCK(hcec);
\r
1075 HAL_CEC_RxCpltCallback(hcec);
\r
1079 __HAL_CEC_CLEAR_FLAG(hcec, CEC_FLAG_RXBR);
\r
1081 hcec->RxXferSize++;
\r
1082 /* Process Unlocked */
\r
1083 __HAL_UNLOCK(hcec);
\r
1100 #endif /* HAL_CEC_MODULE_ENABLED */
\r
1109 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
\r