stm32f469/stm32f469i-disco/Drivers/STM32F4xx_HAL_Driver/Inc/stm32f4xx_hal_i2c.h
Go to the documentation of this file.
1 
20 /* Define to prevent recursive inclusion -------------------------------------*/
21 #ifndef __STM32F4xx_HAL_I2C_H
22 #define __STM32F4xx_HAL_I2C_H
23 
24 #ifdef __cplusplus
25 extern "C" {
26 #endif
27 
28 /* Includes ------------------------------------------------------------------*/
29 #include "stm32f4xx_hal_def.h"
30 
39 /* Exported types ------------------------------------------------------------*/
48 typedef struct
49 {
50  uint32_t ClockSpeed;
53  uint32_t DutyCycle;
56  uint32_t OwnAddress1;
59  uint32_t AddressingMode;
62  uint32_t DualAddressMode;
65  uint32_t OwnAddress2;
68  uint32_t GeneralCallMode;
71  uint32_t NoStretchMode;
74 } I2C_InitTypeDef;
75 
107 typedef enum
108 {
109  HAL_I2C_STATE_RESET = 0x00U,
110  HAL_I2C_STATE_READY = 0x20U,
111  HAL_I2C_STATE_BUSY = 0x24U,
112  HAL_I2C_STATE_BUSY_TX = 0x21U,
113  HAL_I2C_STATE_BUSY_RX = 0x22U,
114  HAL_I2C_STATE_LISTEN = 0x28U,
115  HAL_I2C_STATE_BUSY_TX_LISTEN = 0x29U,
117  HAL_I2C_STATE_BUSY_RX_LISTEN = 0x2AU,
119  HAL_I2C_STATE_ABORT = 0x60U,
120  HAL_I2C_STATE_TIMEOUT = 0xA0U,
121  HAL_I2C_STATE_ERROR = 0xE0U
123 } HAL_I2C_StateTypeDef;
124 
147 typedef enum
148 {
149  HAL_I2C_MODE_NONE = 0x00U,
150  HAL_I2C_MODE_MASTER = 0x10U,
151  HAL_I2C_MODE_SLAVE = 0x20U,
152  HAL_I2C_MODE_MEM = 0x40U
154 } HAL_I2C_ModeTypeDef;
155 
164 #define HAL_I2C_ERROR_NONE 0x00000000U
165 #define HAL_I2C_ERROR_BERR 0x00000001U
166 #define HAL_I2C_ERROR_ARLO 0x00000002U
167 #define HAL_I2C_ERROR_AF 0x00000004U
168 #define HAL_I2C_ERROR_OVR 0x00000008U
169 #define HAL_I2C_ERROR_DMA 0x00000010U
170 #define HAL_I2C_ERROR_TIMEOUT 0x00000020U
171 #define HAL_I2C_ERROR_SIZE 0x00000040U
172 #define HAL_I2C_ERROR_DMA_PARAM 0x00000080U
173 #define HAL_I2C_WRONG_START 0x00000200U
174 #if (USE_HAL_I2C_REGISTER_CALLBACKS == 1)
175 #define HAL_I2C_ERROR_INVALID_CALLBACK 0x00000100U
176 #endif /* USE_HAL_I2C_REGISTER_CALLBACKS */
177 
185 #if (USE_HAL_I2C_REGISTER_CALLBACKS == 1)
186 typedef struct __I2C_HandleTypeDef
187 #else
188 typedef struct
189 #endif /* USE_HAL_I2C_REGISTER_CALLBACKS */
190 {
191  I2C_TypeDef *Instance;
193  I2C_InitTypeDef Init;
195  uint8_t *pBuffPtr;
197  uint16_t XferSize;
199  __IO uint16_t XferCount;
201  __IO uint32_t XferOptions;
203  __IO uint32_t PreviousState;
206  DMA_HandleTypeDef *hdmatx;
208  DMA_HandleTypeDef *hdmarx;
210  HAL_LockTypeDef Lock;
212  __IO HAL_I2C_StateTypeDef State;
214  __IO HAL_I2C_ModeTypeDef Mode;
216  __IO uint32_t ErrorCode;
218  __IO uint32_t Devaddress;
220  __IO uint32_t Memaddress;
222  __IO uint32_t MemaddSize;
224  __IO uint32_t EventCount;
227 #if (USE_HAL_I2C_REGISTER_CALLBACKS == 1)
228  void (* MasterTxCpltCallback)(struct __I2C_HandleTypeDef *hi2c);
229  void (* MasterRxCpltCallback)(struct __I2C_HandleTypeDef *hi2c);
230  void (* SlaveTxCpltCallback)(struct __I2C_HandleTypeDef *hi2c);
231  void (* SlaveRxCpltCallback)(struct __I2C_HandleTypeDef *hi2c);
232  void (* ListenCpltCallback)(struct __I2C_HandleTypeDef *hi2c);
233  void (* MemTxCpltCallback)(struct __I2C_HandleTypeDef *hi2c);
234  void (* MemRxCpltCallback)(struct __I2C_HandleTypeDef *hi2c);
235  void (* ErrorCallback)(struct __I2C_HandleTypeDef *hi2c);
236  void (* AbortCpltCallback)(struct __I2C_HandleTypeDef *hi2c);
238  void (* AddrCallback)(struct __I2C_HandleTypeDef *hi2c, uint8_t TransferDirection, uint16_t AddrMatchCode);
240  void (* MspInitCallback)(struct __I2C_HandleTypeDef *hi2c);
241  void (* MspDeInitCallback)(struct __I2C_HandleTypeDef *hi2c);
243 #endif /* USE_HAL_I2C_REGISTER_CALLBACKS */
244 } I2C_HandleTypeDef;
245 
246 #if (USE_HAL_I2C_REGISTER_CALLBACKS == 1)
247 
250 typedef enum
251 {
252  HAL_I2C_MASTER_TX_COMPLETE_CB_ID = 0x00U,
253  HAL_I2C_MASTER_RX_COMPLETE_CB_ID = 0x01U,
254  HAL_I2C_SLAVE_TX_COMPLETE_CB_ID = 0x02U,
255  HAL_I2C_SLAVE_RX_COMPLETE_CB_ID = 0x03U,
256  HAL_I2C_LISTEN_COMPLETE_CB_ID = 0x04U,
257  HAL_I2C_MEM_TX_COMPLETE_CB_ID = 0x05U,
258  HAL_I2C_MEM_RX_COMPLETE_CB_ID = 0x06U,
259  HAL_I2C_ERROR_CB_ID = 0x07U,
260  HAL_I2C_ABORT_CB_ID = 0x08U,
262  HAL_I2C_MSPINIT_CB_ID = 0x09U,
263  HAL_I2C_MSPDEINIT_CB_ID = 0x0AU
265 } HAL_I2C_CallbackIDTypeDef;
266 
270 typedef void (*pI2C_CallbackTypeDef)(I2C_HandleTypeDef *hi2c);
271 typedef void (*pI2C_AddrCallbackTypeDef)(I2C_HandleTypeDef *hi2c, uint8_t TransferDirection, uint16_t AddrMatchCode);
273 #endif /* USE_HAL_I2C_REGISTER_CALLBACKS */
274 
281 /* Exported constants --------------------------------------------------------*/
282 
290 #define I2C_DUTYCYCLE_2 0x00000000U
291 #define I2C_DUTYCYCLE_16_9 I2C_CCR_DUTY
292 
299 #define I2C_ADDRESSINGMODE_7BIT 0x00004000U
300 #define I2C_ADDRESSINGMODE_10BIT (I2C_OAR1_ADDMODE | 0x00004000U)
301 
308 #define I2C_DUALADDRESS_DISABLE 0x00000000U
309 #define I2C_DUALADDRESS_ENABLE I2C_OAR2_ENDUAL
310 
317 #define I2C_GENERALCALL_DISABLE 0x00000000U
318 #define I2C_GENERALCALL_ENABLE I2C_CR1_ENGC
319 
326 #define I2C_NOSTRETCH_DISABLE 0x00000000U
327 #define I2C_NOSTRETCH_ENABLE I2C_CR1_NOSTRETCH
328 
335 #define I2C_MEMADD_SIZE_8BIT 0x00000001U
336 #define I2C_MEMADD_SIZE_16BIT 0x00000010U
337 
344 #define I2C_DIRECTION_RECEIVE 0x00000000U
345 #define I2C_DIRECTION_TRANSMIT 0x00000001U
346 
353 #define I2C_FIRST_FRAME 0x00000001U
354 #define I2C_FIRST_AND_NEXT_FRAME 0x00000002U
355 #define I2C_NEXT_FRAME 0x00000004U
356 #define I2C_FIRST_AND_LAST_FRAME 0x00000008U
357 #define I2C_LAST_FRAME_NO_STOP 0x00000010U
358 #define I2C_LAST_FRAME 0x00000020U
359 
360 /* List of XferOptions in usage of :
361  * 1- Restart condition in all use cases (direction change or not)
362  */
363 #define I2C_OTHER_FRAME (0x00AA0000U)
364 #define I2C_OTHER_AND_LAST_FRAME (0xAA000000U)
365 
375 #define I2C_IT_BUF I2C_CR2_ITBUFEN
376 #define I2C_IT_EVT I2C_CR2_ITEVTEN
377 #define I2C_IT_ERR I2C_CR2_ITERREN
378 
386 #define I2C_FLAG_OVR 0x00010800U
387 #define I2C_FLAG_AF 0x00010400U
388 #define I2C_FLAG_ARLO 0x00010200U
389 #define I2C_FLAG_BERR 0x00010100U
390 #define I2C_FLAG_TXE 0x00010080U
391 #define I2C_FLAG_RXNE 0x00010040U
392 #define I2C_FLAG_STOPF 0x00010010U
393 #define I2C_FLAG_ADD10 0x00010008U
394 #define I2C_FLAG_BTF 0x00010004U
395 #define I2C_FLAG_ADDR 0x00010002U
396 #define I2C_FLAG_SB 0x00010001U
397 #define I2C_FLAG_DUALF 0x00100080U
398 #define I2C_FLAG_GENCALL 0x00100010U
399 #define I2C_FLAG_TRA 0x00100004U
400 #define I2C_FLAG_BUSY 0x00100002U
401 #define I2C_FLAG_MSL 0x00100001U
402 
410 /* Exported macros -----------------------------------------------------------*/
411 
420 #if (USE_HAL_I2C_REGISTER_CALLBACKS == 1)
421 #define __HAL_I2C_RESET_HANDLE_STATE(__HANDLE__) do{ \
422  (__HANDLE__)->State = HAL_I2C_STATE_RESET; \
423  (__HANDLE__)->MspInitCallback = NULL; \
424  (__HANDLE__)->MspDeInitCallback = NULL; \
425  } while(0)
426 #else
427 #define __HAL_I2C_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_I2C_STATE_RESET)
428 #endif
429 
439 #define __HAL_I2C_ENABLE_IT(__HANDLE__, __INTERRUPT__) SET_BIT((__HANDLE__)->Instance->CR2,(__INTERRUPT__))
440 #define __HAL_I2C_DISABLE_IT(__HANDLE__, __INTERRUPT__) CLEAR_BIT((__HANDLE__)->Instance->CR2, (__INTERRUPT__))
441 
451 #define __HAL_I2C_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__) ((((__HANDLE__)->Instance->CR2 & (__INTERRUPT__)) == (__INTERRUPT__)) ? SET : RESET)
452 
476 #define __HAL_I2C_GET_FLAG(__HANDLE__, __FLAG__) ((((uint8_t)((__FLAG__) >> 16U)) == 0x01U) ? \
477  (((((__HANDLE__)->Instance->SR1) & ((__FLAG__) & I2C_FLAG_MASK)) == ((__FLAG__) & I2C_FLAG_MASK)) ? SET : RESET) : \
478  (((((__HANDLE__)->Instance->SR2) & ((__FLAG__) & I2C_FLAG_MASK)) == ((__FLAG__) & I2C_FLAG_MASK)) ? SET : RESET))
479 
490 #define __HAL_I2C_CLEAR_FLAG(__HANDLE__, __FLAG__) ((__HANDLE__)->Instance->SR1 = ~((__FLAG__) & I2C_FLAG_MASK))
491 
497 #define __HAL_I2C_CLEAR_ADDRFLAG(__HANDLE__) \
498  do{ \
499  __IO uint32_t tmpreg = 0x00U; \
500  tmpreg = (__HANDLE__)->Instance->SR1; \
501  tmpreg = (__HANDLE__)->Instance->SR2; \
502  UNUSED(tmpreg); \
503  } while(0)
504 
509 #define __HAL_I2C_CLEAR_STOPFLAG(__HANDLE__) \
510  do{ \
511  __IO uint32_t tmpreg = 0x00U; \
512  tmpreg = (__HANDLE__)->Instance->SR1; \
513  SET_BIT((__HANDLE__)->Instance->CR1, I2C_CR1_PE); \
514  UNUSED(tmpreg); \
515  } while(0)
516 
521 #define __HAL_I2C_ENABLE(__HANDLE__) SET_BIT((__HANDLE__)->Instance->CR1, I2C_CR1_PE)
522 
527 #define __HAL_I2C_DISABLE(__HANDLE__) CLEAR_BIT((__HANDLE__)->Instance->CR1, I2C_CR1_PE)
528 
533 /* Include I2C HAL Extension module */
534 #include "stm32f4xx_hal_i2c_ex.h"
535 
536 /* Exported functions --------------------------------------------------------*/
544 /* Initialization and de-initialization functions******************************/
545 HAL_StatusTypeDef HAL_I2C_Init(I2C_HandleTypeDef *hi2c);
546 HAL_StatusTypeDef HAL_I2C_DeInit(I2C_HandleTypeDef *hi2c);
547 void HAL_I2C_MspInit(I2C_HandleTypeDef *hi2c);
548 void HAL_I2C_MspDeInit(I2C_HandleTypeDef *hi2c);
549 
550 /* Callbacks Register/UnRegister functions ***********************************/
551 #if (USE_HAL_I2C_REGISTER_CALLBACKS == 1)
552 HAL_StatusTypeDef HAL_I2C_RegisterCallback(I2C_HandleTypeDef *hi2c, HAL_I2C_CallbackIDTypeDef CallbackID, pI2C_CallbackTypeDef pCallback);
553 HAL_StatusTypeDef HAL_I2C_UnRegisterCallback(I2C_HandleTypeDef *hi2c, HAL_I2C_CallbackIDTypeDef CallbackID);
554 
555 HAL_StatusTypeDef HAL_I2C_RegisterAddrCallback(I2C_HandleTypeDef *hi2c, pI2C_AddrCallbackTypeDef pCallback);
556 HAL_StatusTypeDef HAL_I2C_UnRegisterAddrCallback(I2C_HandleTypeDef *hi2c);
557 #endif /* USE_HAL_I2C_REGISTER_CALLBACKS */
558 
565 /* IO operation functions ****************************************************/
566 /******* Blocking mode: Polling */
567 HAL_StatusTypeDef HAL_I2C_Master_Transmit(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint8_t *pData, uint16_t Size, uint32_t Timeout);
568 HAL_StatusTypeDef HAL_I2C_Master_Receive(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint8_t *pData, uint16_t Size, uint32_t Timeout);
569 HAL_StatusTypeDef HAL_I2C_Slave_Transmit(I2C_HandleTypeDef *hi2c, uint8_t *pData, uint16_t Size, uint32_t Timeout);
570 HAL_StatusTypeDef HAL_I2C_Slave_Receive(I2C_HandleTypeDef *hi2c, uint8_t *pData, uint16_t Size, uint32_t Timeout);
571 HAL_StatusTypeDef HAL_I2C_Mem_Write(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint16_t MemAddress, uint16_t MemAddSize, uint8_t *pData, uint16_t Size, uint32_t Timeout);
572 HAL_StatusTypeDef HAL_I2C_Mem_Read(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint16_t MemAddress, uint16_t MemAddSize, uint8_t *pData, uint16_t Size, uint32_t Timeout);
573 HAL_StatusTypeDef HAL_I2C_IsDeviceReady(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint32_t Trials, uint32_t Timeout);
574 
575 /******* Non-Blocking mode: Interrupt */
576 HAL_StatusTypeDef HAL_I2C_Master_Transmit_IT(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint8_t *pData, uint16_t Size);
577 HAL_StatusTypeDef HAL_I2C_Master_Receive_IT(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint8_t *pData, uint16_t Size);
578 HAL_StatusTypeDef HAL_I2C_Slave_Transmit_IT(I2C_HandleTypeDef *hi2c, uint8_t *pData, uint16_t Size);
579 HAL_StatusTypeDef HAL_I2C_Slave_Receive_IT(I2C_HandleTypeDef *hi2c, uint8_t *pData, uint16_t Size);
580 HAL_StatusTypeDef HAL_I2C_Mem_Write_IT(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint16_t MemAddress, uint16_t MemAddSize, uint8_t *pData, uint16_t Size);
581 HAL_StatusTypeDef HAL_I2C_Mem_Read_IT(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint16_t MemAddress, uint16_t MemAddSize, uint8_t *pData, uint16_t Size);
582 
583 HAL_StatusTypeDef HAL_I2C_Master_Seq_Transmit_IT(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint8_t *pData, uint16_t Size, uint32_t XferOptions);
584 HAL_StatusTypeDef HAL_I2C_Master_Seq_Receive_IT(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint8_t *pData, uint16_t Size, uint32_t XferOptions);
585 HAL_StatusTypeDef HAL_I2C_Slave_Seq_Transmit_IT(I2C_HandleTypeDef *hi2c, uint8_t *pData, uint16_t Size, uint32_t XferOptions);
586 HAL_StatusTypeDef HAL_I2C_Slave_Seq_Receive_IT(I2C_HandleTypeDef *hi2c, uint8_t *pData, uint16_t Size, uint32_t XferOptions);
587 HAL_StatusTypeDef HAL_I2C_EnableListen_IT(I2C_HandleTypeDef *hi2c);
588 HAL_StatusTypeDef HAL_I2C_DisableListen_IT(I2C_HandleTypeDef *hi2c);
589 HAL_StatusTypeDef HAL_I2C_Master_Abort_IT(I2C_HandleTypeDef *hi2c, uint16_t DevAddress);
590 
591 /******* Non-Blocking mode: DMA */
592 HAL_StatusTypeDef HAL_I2C_Master_Transmit_DMA(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint8_t *pData, uint16_t Size);
593 HAL_StatusTypeDef HAL_I2C_Master_Receive_DMA(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint8_t *pData, uint16_t Size);
594 HAL_StatusTypeDef HAL_I2C_Slave_Transmit_DMA(I2C_HandleTypeDef *hi2c, uint8_t *pData, uint16_t Size);
595 HAL_StatusTypeDef HAL_I2C_Slave_Receive_DMA(I2C_HandleTypeDef *hi2c, uint8_t *pData, uint16_t Size);
596 HAL_StatusTypeDef HAL_I2C_Mem_Write_DMA(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint16_t MemAddress, uint16_t MemAddSize, uint8_t *pData, uint16_t Size);
597 HAL_StatusTypeDef HAL_I2C_Mem_Read_DMA(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint16_t MemAddress, uint16_t MemAddSize, uint8_t *pData, uint16_t Size);
598 
599 HAL_StatusTypeDef HAL_I2C_Master_Seq_Transmit_DMA(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint8_t *pData, uint16_t Size, uint32_t XferOptions);
600 HAL_StatusTypeDef HAL_I2C_Master_Seq_Receive_DMA(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint8_t *pData, uint16_t Size, uint32_t XferOptions);
601 HAL_StatusTypeDef HAL_I2C_Slave_Seq_Transmit_DMA(I2C_HandleTypeDef *hi2c, uint8_t *pData, uint16_t Size, uint32_t XferOptions);
602 HAL_StatusTypeDef HAL_I2C_Slave_Seq_Receive_DMA(I2C_HandleTypeDef *hi2c, uint8_t *pData, uint16_t Size, uint32_t XferOptions);
610 /******* I2C IRQHandler and Callbacks used in non blocking modes (Interrupt and DMA) */
611 void HAL_I2C_EV_IRQHandler(I2C_HandleTypeDef *hi2c);
612 void HAL_I2C_ER_IRQHandler(I2C_HandleTypeDef *hi2c);
613 void HAL_I2C_MasterTxCpltCallback(I2C_HandleTypeDef *hi2c);
614 void HAL_I2C_MasterRxCpltCallback(I2C_HandleTypeDef *hi2c);
615 void HAL_I2C_SlaveTxCpltCallback(I2C_HandleTypeDef *hi2c);
616 void HAL_I2C_SlaveRxCpltCallback(I2C_HandleTypeDef *hi2c);
617 void HAL_I2C_AddrCallback(I2C_HandleTypeDef *hi2c, uint8_t TransferDirection, uint16_t AddrMatchCode);
618 void HAL_I2C_ListenCpltCallback(I2C_HandleTypeDef *hi2c);
619 void HAL_I2C_MemTxCpltCallback(I2C_HandleTypeDef *hi2c);
620 void HAL_I2C_MemRxCpltCallback(I2C_HandleTypeDef *hi2c);
621 void HAL_I2C_ErrorCallback(I2C_HandleTypeDef *hi2c);
622 void HAL_I2C_AbortCpltCallback(I2C_HandleTypeDef *hi2c);
630 /* Peripheral State, Mode and Error functions *********************************/
631 HAL_I2C_StateTypeDef HAL_I2C_GetState(I2C_HandleTypeDef *hi2c);
632 HAL_I2C_ModeTypeDef HAL_I2C_GetMode(I2C_HandleTypeDef *hi2c);
633 uint32_t HAL_I2C_GetError(I2C_HandleTypeDef *hi2c);
634 
642 /* Private types -------------------------------------------------------------*/
643 /* Private variables ---------------------------------------------------------*/
644 /* Private constants ---------------------------------------------------------*/
648 #define I2C_FLAG_MASK 0x0000FFFFU
649 #define I2C_MIN_PCLK_FREQ_STANDARD 2000000U
650 #define I2C_MIN_PCLK_FREQ_FAST 4000000U
655 /* Private macros ------------------------------------------------------------*/
656 
660 #define I2C_MIN_PCLK_FREQ(__PCLK__, __SPEED__) (((__SPEED__) <= 100000U) ? ((__PCLK__) < I2C_MIN_PCLK_FREQ_STANDARD) : ((__PCLK__) < I2C_MIN_PCLK_FREQ_FAST))
661 #define I2C_CCR_CALCULATION(__PCLK__, __SPEED__, __COEFF__) (((((__PCLK__) - 1U)/((__SPEED__) * (__COEFF__))) + 1U) & I2C_CCR_CCR)
662 #define I2C_FREQRANGE(__PCLK__) ((__PCLK__)/1000000U)
663 #define I2C_RISE_TIME(__FREQRANGE__, __SPEED__) (((__SPEED__) <= 100000U) ? ((__FREQRANGE__) + 1U) : ((((__FREQRANGE__) * 300U) / 1000U) + 1U))
664 #define I2C_SPEED_STANDARD(__PCLK__, __SPEED__) ((I2C_CCR_CALCULATION((__PCLK__), (__SPEED__), 2U) < 4U)? 4U:I2C_CCR_CALCULATION((__PCLK__), (__SPEED__), 2U))
665 #define I2C_SPEED_FAST(__PCLK__, __SPEED__, __DUTYCYCLE__) (((__DUTYCYCLE__) == I2C_DUTYCYCLE_2)? I2C_CCR_CALCULATION((__PCLK__), (__SPEED__), 3U) : (I2C_CCR_CALCULATION((__PCLK__), (__SPEED__), 25U) | I2C_DUTYCYCLE_16_9))
666 #define I2C_SPEED(__PCLK__, __SPEED__, __DUTYCYCLE__) (((__SPEED__) <= 100000U)? (I2C_SPEED_STANDARD((__PCLK__), (__SPEED__))) : \
667  ((I2C_SPEED_FAST((__PCLK__), (__SPEED__), (__DUTYCYCLE__)) & I2C_CCR_CCR) == 0U)? 1U : \
668  ((I2C_SPEED_FAST((__PCLK__), (__SPEED__), (__DUTYCYCLE__))) | I2C_CCR_FS))
669 
670 #define I2C_7BIT_ADD_WRITE(__ADDRESS__) ((uint8_t)((__ADDRESS__) & (uint8_t)(~I2C_OAR1_ADD0)))
671 #define I2C_7BIT_ADD_READ(__ADDRESS__) ((uint8_t)((__ADDRESS__) | I2C_OAR1_ADD0))
672 
673 #define I2C_10BIT_ADDRESS(__ADDRESS__) ((uint8_t)((uint16_t)((__ADDRESS__) & (uint16_t)0x00FF)))
674 #define I2C_10BIT_HEADER_WRITE(__ADDRESS__) ((uint8_t)((uint16_t)((uint16_t)(((uint16_t)((__ADDRESS__) & (uint16_t)0x0300)) >> 7) | (uint16_t)0x00F0)))
675 #define I2C_10BIT_HEADER_READ(__ADDRESS__) ((uint8_t)((uint16_t)((uint16_t)(((uint16_t)((__ADDRESS__) & (uint16_t)0x0300)) >> 7) | (uint16_t)(0x00F1))))
676 
677 #define I2C_MEM_ADD_MSB(__ADDRESS__) ((uint8_t)((uint16_t)(((uint16_t)((__ADDRESS__) & (uint16_t)0xFF00)) >> 8)))
678 #define I2C_MEM_ADD_LSB(__ADDRESS__) ((uint8_t)((uint16_t)((__ADDRESS__) & (uint16_t)0x00FF)))
679 
683 #define IS_I2C_DUTY_CYCLE(CYCLE) (((CYCLE) == I2C_DUTYCYCLE_2) || \
684  ((CYCLE) == I2C_DUTYCYCLE_16_9))
685 #define IS_I2C_ADDRESSING_MODE(ADDRESS) (((ADDRESS) == I2C_ADDRESSINGMODE_7BIT) || \
686  ((ADDRESS) == I2C_ADDRESSINGMODE_10BIT))
687 #define IS_I2C_DUAL_ADDRESS(ADDRESS) (((ADDRESS) == I2C_DUALADDRESS_DISABLE) || \
688  ((ADDRESS) == I2C_DUALADDRESS_ENABLE))
689 #define IS_I2C_GENERAL_CALL(CALL) (((CALL) == I2C_GENERALCALL_DISABLE) || \
690  ((CALL) == I2C_GENERALCALL_ENABLE))
691 #define IS_I2C_NO_STRETCH(STRETCH) (((STRETCH) == I2C_NOSTRETCH_DISABLE) || \
692  ((STRETCH) == I2C_NOSTRETCH_ENABLE))
693 #define IS_I2C_MEMADD_SIZE(SIZE) (((SIZE) == I2C_MEMADD_SIZE_8BIT) || \
694  ((SIZE) == I2C_MEMADD_SIZE_16BIT))
695 #define IS_I2C_CLOCK_SPEED(SPEED) (((SPEED) > 0U) && ((SPEED) <= 400000U))
696 #define IS_I2C_OWN_ADDRESS1(ADDRESS1) (((ADDRESS1) & 0xFFFFFC00U) == 0U)
697 #define IS_I2C_OWN_ADDRESS2(ADDRESS2) (((ADDRESS2) & 0xFFFFFF01U) == 0U)
698 #define IS_I2C_TRANSFER_OPTIONS_REQUEST(REQUEST) (((REQUEST) == I2C_FIRST_FRAME) || \
699  ((REQUEST) == I2C_FIRST_AND_NEXT_FRAME) || \
700  ((REQUEST) == I2C_NEXT_FRAME) || \
701  ((REQUEST) == I2C_FIRST_AND_LAST_FRAME) || \
702  ((REQUEST) == I2C_LAST_FRAME) || \
703  ((REQUEST) == I2C_LAST_FRAME_NO_STOP) || \
704  IS_I2C_TRANSFER_OTHER_OPTIONS_REQUEST(REQUEST))
705 
706 #define IS_I2C_TRANSFER_OTHER_OPTIONS_REQUEST(REQUEST) (((REQUEST) == I2C_OTHER_FRAME) || \
707  ((REQUEST) == I2C_OTHER_AND_LAST_FRAME))
708 
709 #define I2C_CHECK_FLAG(__ISR__, __FLAG__) ((((__ISR__) & ((__FLAG__) & I2C_FLAG_MASK)) == ((__FLAG__) & I2C_FLAG_MASK)) ? SET : RESET)
710 #define I2C_CHECK_IT_SOURCE(__CR1__, __IT__) ((((__CR1__) & (__IT__)) == (__IT__)) ? SET : RESET)
711 
719 /* Private functions ---------------------------------------------------------*/
736 #ifdef __cplusplus
737 }
738 #endif
739 
740 
741 #endif /* __STM32F4xx_HAL_I2C_H */
742 
743 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
HAL_I2C_MemTxCpltCallback
void HAL_I2C_MemTxCpltCallback(I2C_HandleTypeDef *hi2c)
HAL_I2C_STATE_BUSY_TX_LISTEN
@ HAL_I2C_STATE_BUSY_TX_LISTEN
Definition: stm32f469/stm32f469i-disco/Drivers/STM32F4xx_HAL_Driver/Inc/stm32f4xx_hal_i2c.h:115
HAL_I2C_Init
HAL_StatusTypeDef HAL_I2C_Init(I2C_HandleTypeDef *hi2c)
__IO
#define __IO
Definition: imxrt1050/imxrt1050-evkb/CMSIS/core_cm7.h:237
HAL_I2C_STATE_BUSY_RX
@ HAL_I2C_STATE_BUSY_RX
Definition: stm32f469/stm32f469i-disco/Drivers/STM32F4xx_HAL_Driver/Inc/stm32f4xx_hal_i2c.h:113
HAL_StatusTypeDef
HAL_StatusTypeDef
HAL Status structures definition
Definition: stm32f407/stm32f407g-disc1/Drivers/STM32F4xx_HAL_Driver/Inc/stm32f4xx_hal_def.h:40
__I2C_HandleTypeDef::ErrorCode
__IO uint32_t ErrorCode
Definition: stm32f7xx_hal_i2c.h:215
HAL_I2C_ER_IRQHandler
void HAL_I2C_ER_IRQHandler(I2C_HandleTypeDef *hi2c)
HAL_I2C_GetState
HAL_I2C_StateTypeDef HAL_I2C_GetState(I2C_HandleTypeDef *hi2c)
HAL_I2C_Slave_Seq_Receive_DMA
HAL_StatusTypeDef HAL_I2C_Slave_Seq_Receive_DMA(I2C_HandleTypeDef *hi2c, uint8_t *pData, uint16_t Size, uint32_t XferOptions)
HAL_I2C_GetMode
HAL_I2C_ModeTypeDef HAL_I2C_GetMode(I2C_HandleTypeDef *hi2c)
__DMA_HandleTypeDef
DMA handle Structure definition.
Definition: stm32f407/stm32f407g-disc1/Drivers/STM32F4xx_HAL_Driver/Inc/stm32f4xx_hal_dma.h:139
HAL_I2C_Master_Transmit
HAL_StatusTypeDef HAL_I2C_Master_Transmit(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint8_t *pData, uint16_t Size, uint32_t Timeout)
HAL_I2C_Slave_Transmit_DMA
HAL_StatusTypeDef HAL_I2C_Slave_Transmit_DMA(I2C_HandleTypeDef *hi2c, uint8_t *pData, uint16_t Size)
HAL_I2C_Slave_Receive_IT
HAL_StatusTypeDef HAL_I2C_Slave_Receive_IT(I2C_HandleTypeDef *hi2c, uint8_t *pData, uint16_t Size)
HAL_I2C_Mem_Read_DMA
HAL_StatusTypeDef HAL_I2C_Mem_Read_DMA(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint16_t MemAddress, uint16_t MemAddSize, uint8_t *pData, uint16_t Size)
HAL_I2C_Master_Abort_IT
HAL_StatusTypeDef HAL_I2C_Master_Abort_IT(I2C_HandleTypeDef *hi2c, uint16_t DevAddress)
HAL_I2C_ListenCpltCallback
void HAL_I2C_ListenCpltCallback(I2C_HandleTypeDef *hi2c)
HAL_I2C_Slave_Seq_Receive_IT
HAL_StatusTypeDef HAL_I2C_Slave_Seq_Receive_IT(I2C_HandleTypeDef *hi2c, uint8_t *pData, uint16_t Size, uint32_t XferOptions)
__I2C_HandleTypeDef::XferSize
uint16_t XferSize
Definition: stm32f7xx_hal_i2c.h:194
HAL_I2C_STATE_RESET
@ HAL_I2C_STATE_RESET
Definition: stm32f469/stm32f469i-disco/Drivers/STM32F4xx_HAL_Driver/Inc/stm32f4xx_hal_i2c.h:109
I2C_TypeDef
Inter-integrated Circuit Interface.
Definition: stm32f407xx.h:557
HAL_I2C_Master_Transmit_IT
HAL_StatusTypeDef HAL_I2C_Master_Transmit_IT(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint8_t *pData, uint16_t Size)
HAL_LockTypeDef
HAL_LockTypeDef
HAL Lock structures definition
Definition: stm32f407/stm32f407g-disc1/Drivers/STM32F4xx_HAL_Driver/Inc/stm32f4xx_hal_def.h:51
__I2C_HandleTypeDef::XferCount
__IO uint16_t XferCount
Definition: stm32f7xx_hal_i2c.h:196
HAL_I2C_EV_IRQHandler
void HAL_I2C_EV_IRQHandler(I2C_HandleTypeDef *hi2c)
HAL_I2C_Mem_Write
HAL_StatusTypeDef HAL_I2C_Mem_Write(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint16_t MemAddress, uint16_t MemAddSize, uint8_t *pData, uint16_t Size, uint32_t Timeout)
HAL_I2C_Slave_Transmit_IT
HAL_StatusTypeDef HAL_I2C_Slave_Transmit_IT(I2C_HandleTypeDef *hi2c, uint8_t *pData, uint16_t Size)
HAL_I2C_EnableListen_IT
HAL_StatusTypeDef HAL_I2C_EnableListen_IT(I2C_HandleTypeDef *hi2c)
HAL_I2C_MODE_SLAVE
@ HAL_I2C_MODE_SLAVE
Definition: stm32f469/stm32f469i-disco/Drivers/STM32F4xx_HAL_Driver/Inc/stm32f4xx_hal_i2c.h:151
HAL_I2C_StateTypeDef
HAL_I2C_StateTypeDef
Definition: stm32f469/stm32f469i-disco/Drivers/STM32F4xx_HAL_Driver/Inc/stm32f4xx_hal_i2c.h:107
HAL_I2C_STATE_BUSY
@ HAL_I2C_STATE_BUSY
Definition: stm32f469/stm32f469i-disco/Drivers/STM32F4xx_HAL_Driver/Inc/stm32f4xx_hal_i2c.h:111
HAL_I2C_STATE_BUSY_RX_LISTEN
@ HAL_I2C_STATE_BUSY_RX_LISTEN
Definition: stm32f469/stm32f469i-disco/Drivers/STM32F4xx_HAL_Driver/Inc/stm32f4xx_hal_i2c.h:117
__I2C_HandleTypeDef::Instance
I2C_TypeDef * Instance
Definition: stm32f7xx_hal_i2c.h:188
HAL_I2C_STATE_TIMEOUT
@ HAL_I2C_STATE_TIMEOUT
Definition: stm32f469/stm32f469i-disco/Drivers/STM32F4xx_HAL_Driver/Inc/stm32f4xx_hal_i2c.h:120
HAL_I2C_STATE_READY
@ HAL_I2C_STATE_READY
Definition: stm32f469/stm32f469i-disco/Drivers/STM32F4xx_HAL_Driver/Inc/stm32f4xx_hal_i2c.h:110
HAL_I2C_Master_Seq_Transmit_DMA
HAL_StatusTypeDef HAL_I2C_Master_Seq_Transmit_DMA(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint8_t *pData, uint16_t Size, uint32_t XferOptions)
HAL_I2C_AbortCpltCallback
void HAL_I2C_AbortCpltCallback(I2C_HandleTypeDef *hi2c)
HAL_I2C_STATE_BUSY_TX
@ HAL_I2C_STATE_BUSY_TX
Definition: stm32f469/stm32f469i-disco/Drivers/STM32F4xx_HAL_Driver/Inc/stm32f4xx_hal_i2c.h:112
HAL_I2C_MasterRxCpltCallback
void HAL_I2C_MasterRxCpltCallback(I2C_HandleTypeDef *hi2c)
stm32f4xx_hal_def.h
This file contains HAL common defines, enumeration, macros and structures definitions.
HAL_I2C_STATE_ERROR
@ HAL_I2C_STATE_ERROR
Definition: stm32f469/stm32f469i-disco/Drivers/STM32F4xx_HAL_Driver/Inc/stm32f4xx_hal_i2c.h:121
stm32f4xx_hal_i2c_ex.h
Header file of I2C HAL Extension module.
HAL_I2C_Master_Seq_Receive_DMA
HAL_StatusTypeDef HAL_I2C_Master_Seq_Receive_DMA(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint8_t *pData, uint16_t Size, uint32_t XferOptions)
HAL_I2C_Slave_Seq_Transmit_DMA
HAL_StatusTypeDef HAL_I2C_Slave_Seq_Transmit_DMA(I2C_HandleTypeDef *hi2c, uint8_t *pData, uint16_t Size, uint32_t XferOptions)
HAL_I2C_SlaveTxCpltCallback
void HAL_I2C_SlaveTxCpltCallback(I2C_HandleTypeDef *hi2c)
HAL_I2C_IsDeviceReady
HAL_StatusTypeDef HAL_I2C_IsDeviceReady(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint32_t Trials, uint32_t Timeout)
__I2C_HandleTypeDef::pBuffPtr
uint8_t * pBuffPtr
Definition: stm32f7xx_hal_i2c.h:192
__I2C_HandleTypeDef::XferOptions
__IO uint32_t XferOptions
Definition: stm32f7xx_hal_i2c.h:198
HAL_I2C_MspInit
void HAL_I2C_MspInit(I2C_HandleTypeDef *hi2c)
HAL_I2C_DisableListen_IT
HAL_StatusTypeDef HAL_I2C_DisableListen_IT(I2C_HandleTypeDef *hi2c)
HAL_I2C_AddrCallback
void HAL_I2C_AddrCallback(I2C_HandleTypeDef *hi2c, uint8_t TransferDirection, uint16_t AddrMatchCode)
__I2C_HandleTypeDef::State
__IO HAL_I2C_StateTypeDef State
Definition: stm32f7xx_hal_i2c.h:211
HAL_I2C_Slave_Receive
HAL_StatusTypeDef HAL_I2C_Slave_Receive(I2C_HandleTypeDef *hi2c, uint8_t *pData, uint16_t Size, uint32_t Timeout)
HAL_I2C_Master_Receive_IT
HAL_StatusTypeDef HAL_I2C_Master_Receive_IT(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint8_t *pData, uint16_t Size)
HAL_I2C_MODE_MASTER
@ HAL_I2C_MODE_MASTER
Definition: stm32f469/stm32f469i-disco/Drivers/STM32F4xx_HAL_Driver/Inc/stm32f4xx_hal_i2c.h:150
I2C_HandleTypeDef
Definition: stm32f407/stm32f407g-disc1/Drivers/STM32F4xx_HAL_Driver/Inc/stm32f4xx_hal_i2c.h:188
HAL_I2C_STATE_LISTEN
@ HAL_I2C_STATE_LISTEN
Definition: stm32f469/stm32f469i-disco/Drivers/STM32F4xx_HAL_Driver/Inc/stm32f4xx_hal_i2c.h:114
HAL_I2C_Mem_Write_DMA
HAL_StatusTypeDef HAL_I2C_Mem_Write_DMA(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint16_t MemAddress, uint16_t MemAddSize, uint8_t *pData, uint16_t Size)
HAL_I2C_Master_Transmit_DMA
HAL_StatusTypeDef HAL_I2C_Master_Transmit_DMA(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint8_t *pData, uint16_t Size)
I2C_InitTypeDef
Definition: stm32f407/stm32f407g-disc1/Drivers/STM32F4xx_HAL_Driver/Inc/stm32f4xx_hal_i2c.h:48
I2C_HandleTypeDef
struct __I2C_HandleTypeDef I2C_HandleTypeDef
HAL_I2C_Slave_Receive_DMA
HAL_StatusTypeDef HAL_I2C_Slave_Receive_DMA(I2C_HandleTypeDef *hi2c, uint8_t *pData, uint16_t Size)
HAL_I2C_GetError
uint32_t HAL_I2C_GetError(I2C_HandleTypeDef *hi2c)
HAL_I2C_Slave_Transmit
HAL_StatusTypeDef HAL_I2C_Slave_Transmit(I2C_HandleTypeDef *hi2c, uint8_t *pData, uint16_t Size, uint32_t Timeout)
HAL_I2C_Master_Receive
HAL_StatusTypeDef HAL_I2C_Master_Receive(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint8_t *pData, uint16_t Size, uint32_t Timeout)
HAL_I2C_Mem_Write_IT
HAL_StatusTypeDef HAL_I2C_Mem_Write_IT(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint16_t MemAddress, uint16_t MemAddSize, uint8_t *pData, uint16_t Size)
HAL_I2C_Mem_Read
HAL_StatusTypeDef HAL_I2C_Mem_Read(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint16_t MemAddress, uint16_t MemAddSize, uint8_t *pData, uint16_t Size, uint32_t Timeout)
HAL_I2C_STATE_ABORT
@ HAL_I2C_STATE_ABORT
Definition: stm32f469/stm32f469i-disco/Drivers/STM32F4xx_HAL_Driver/Inc/stm32f4xx_hal_i2c.h:119
HAL_I2C_MODE_MEM
@ HAL_I2C_MODE_MEM
Definition: stm32f469/stm32f469i-disco/Drivers/STM32F4xx_HAL_Driver/Inc/stm32f4xx_hal_i2c.h:152
HAL_I2C_Slave_Seq_Transmit_IT
HAL_StatusTypeDef HAL_I2C_Slave_Seq_Transmit_IT(I2C_HandleTypeDef *hi2c, uint8_t *pData, uint16_t Size, uint32_t XferOptions)
__I2C_HandleTypeDef::Mode
__IO HAL_I2C_ModeTypeDef Mode
Definition: stm32f7xx_hal_i2c.h:213
__I2C_HandleTypeDef::Init
I2C_InitTypeDef Init
Definition: stm32f7xx_hal_i2c.h:190
HAL_I2C_ErrorCallback
void HAL_I2C_ErrorCallback(I2C_HandleTypeDef *hi2c)
__I2C_HandleTypeDef
Definition: stm32f7xx_hal_i2c.h:186
HAL_I2C_MspDeInit
void HAL_I2C_MspDeInit(I2C_HandleTypeDef *hi2c)
HAL_I2C_Master_Seq_Receive_IT
HAL_StatusTypeDef HAL_I2C_Master_Seq_Receive_IT(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint8_t *pData, uint16_t Size, uint32_t XferOptions)
HAL_I2C_Master_Receive_DMA
HAL_StatusTypeDef HAL_I2C_Master_Receive_DMA(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint8_t *pData, uint16_t Size)
HAL_I2C_ModeTypeDef
HAL_I2C_ModeTypeDef
Definition: stm32f469/stm32f469i-disco/Drivers/STM32F4xx_HAL_Driver/Inc/stm32f4xx_hal_i2c.h:147
HAL_I2C_Mem_Read_IT
HAL_StatusTypeDef HAL_I2C_Mem_Read_IT(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint16_t MemAddress, uint16_t MemAddSize, uint8_t *pData, uint16_t Size)
HAL_I2C_Master_Seq_Transmit_IT
HAL_StatusTypeDef HAL_I2C_Master_Seq_Transmit_IT(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint8_t *pData, uint16_t Size, uint32_t XferOptions)
__I2C_HandleTypeDef::Lock
HAL_LockTypeDef Lock
Definition: stm32f7xx_hal_i2c.h:209
HAL_I2C_DeInit
HAL_StatusTypeDef HAL_I2C_DeInit(I2C_HandleTypeDef *hi2c)
HAL_I2C_MODE_NONE
@ HAL_I2C_MODE_NONE
Definition: stm32f469/stm32f469i-disco/Drivers/STM32F4xx_HAL_Driver/Inc/stm32f4xx_hal_i2c.h:149
HAL_I2C_SlaveRxCpltCallback
void HAL_I2C_SlaveRxCpltCallback(I2C_HandleTypeDef *hi2c)
HAL_I2C_MasterTxCpltCallback
void HAL_I2C_MasterTxCpltCallback(I2C_HandleTypeDef *hi2c)
__I2C_HandleTypeDef::hdmatx
DMA_HandleTypeDef * hdmatx
Definition: stm32f7xx_hal_i2c.h:205
HAL_I2C_MemRxCpltCallback
void HAL_I2C_MemRxCpltCallback(I2C_HandleTypeDef *hi2c)
__I2C_HandleTypeDef::PreviousState
__IO uint32_t PreviousState
Definition: stm32f7xx_hal_i2c.h:201
__I2C_HandleTypeDef::hdmarx
DMA_HandleTypeDef * hdmarx
Definition: stm32f7xx_hal_i2c.h:207

picovoice_driver
Author(s):
autogenerated on Fri Apr 1 2022 02:14:52