stm32g4xx_hal_i2c.h

转到此文件的文档。

/**
  ******************************************************************************
  * @file    stm32g4xx_hal_i2c.h
  * @author  MCD Application Team
  * @brief   I2C HAL 模块的头文件。
  ******************************************************************************
  * @attention
  *
  * Copyright (c) 2019 STMicroelectronics.
  * All rights reserved.
  *
  * This software is licensed under terms that can be found in the LICENSE file
  * in the root directory of this software component.
  * If no LICENSE file comes with this software, it is provided AS-IS.
  *
  ******************************************************************************
  */

/* Define to prevent recursive inclusion -------------------------------------*/
#ifndef STM32G4xx_HAL_I2C_H
#define STM32G4xx_HAL_I2C_H

#ifdef __cplusplus
extern "C" {
#endif

/* Includes ------------------------------------------------------------------*/
#include "stm32g4xx_hal_def.h"

/** @addtogroup STM32G4xx_HAL_Driver
  * @{
  */

/** @addtogroup I2C
  * @{
  */

/* Exported types ------------------------------------------------------------*/
/** @defgroup I2C_Exported_Types I2C 导出类型
  * @{
  */

/** @defgroup I2C_Configuration_Structure_definition I2C 配置结构体定义
  * @brief  I2C 配置结构体定义
  * @{
  */
typedef struct
{
  uint32_t Timing;              /*!< 指定 I2C_TIMINGR 寄存器的值。
                                     此参数通过参考手册中的 I2C 初始化部分计算得出 */
                                     */

  uint32_t OwnAddress1;         /*!< 指定第一个设备自身地址。
                                     此参数可以是 7 位或 10 位地址。 */

  uint32_t AddressingMode;      /*!< 指定选择 7 位还是 10 位寻址模式。
                                     此参数可以是 @ref I2C_ADDRESSING_MODE 的值 */

  uint32_t DualAddressMode;     /*!< 指定是否选择双地址模式。
                                     此参数可以是 @ref I2C_DUAL_ADDRESSING_MODE 的值 */

  uint32_t OwnAddress2;         /*!< 如果选择了双地址模式，指定第二个设备自身地址
                                     此参数可以是 7 位地址。 */

  uint32_t OwnAddress2Masks;    /*!< 如果选择了双地址模式，指定第二个设备自身地址的应答掩码地址。
                                     此参数可以是 @ref I2C_OWN_ADDRESS2_MASKS 的值 */


  uint32_t GeneralCallMode;     /*!< 指定是否选择通用呼叫模式。
                                     此参数可以是 @ref I2C_GENERAL_CALL_ADDRESSING_MODE 的值 */

  uint32_t NoStretchMode;       /*!< 指定是否选择无时钟拉伸模式。
                                     此参数可以是 @ref I2C_NOSTRETCH_MODE 的值 */

} I2C_InitTypeDef;

/**
  * @}
  */

/** @defgroup HAL_state_structure_definition HAL 状态结构体定义
  * @brief  HAL 状态结构体定义
  * @note  HAL I2C 状态值编码遵循以下描述的位图：\n
  *          b7-b6  错误信息\n
  *             00 : 无错误\n
  *             01 : 中止（中止用户请求进行中）\n
  *             10 : 超时\n
  *             11 : 错误\n
  *          b5     外设初始化状态\n
  *             0  : 复位（外设未初始化）\n
  *             1  : 初始化完成（外设已初始化并准备就绪。已调用 HAL I2C Init 函数）\n
  *          b4     （未使用）\n
  *             x  : 应设置为 0\n
  *          b3\n
  *             0  : 就绪或忙（无监听模式进行中）\n
  *             1  : 监听（外设处于地址监听模式）\n
  *          b2     内部处理状态\n
  *             0  : 就绪\n
  *             1  : 忙（外设忙于某些配置或内部操作）\n
  *          b1     接收状态\n
  *             0  : 就绪（无接收操作进行中）\n
  *             1  : 忙（接收操作进行中）\n
  *          b0     发送状态\n
  *             0  : 就绪（无发送操作进行中）\n
  *             1  : 忙（发送操作进行中）
  * @{
  */
typedef enum
{
  HAL_I2C_STATE_RESET             = 0x00U,   /*!< 外设尚未初始化         */
  HAL_I2C_STATE_READY             = 0x20U,   /*!< 外设已初始化并准备就绪  */
  HAL_I2C_STATE_BUSY              = 0x24U,   /*!< 内部处理正在进行中            */
  HAL_I2C_STATE_BUSY_TX           = 0x21U,   /*!< 数据发送过程正在进行中      */
  HAL_I2C_STATE_BUSY_RX           = 0x22U,   /*!< 数据接收过程正在进行中         */
  HAL_I2C_STATE_LISTEN            = 0x28U,   /*!< 地址监听模式正在进行中            */
  HAL_I2C_STATE_BUSY_TX_LISTEN    = 0x29U,   /*!< 地址监听模式和数据发送
                                                 过程正在进行中                         */
  HAL_I2C_STATE_BUSY_RX_LISTEN    = 0x2AU,   /*!< 地址监听模式和数据接收
                                                 过程正在进行中                         */
  HAL_I2C_STATE_ABORT             = 0x60U,   /*!< 中止用户请求进行中                */

} HAL_I2C_StateTypeDef;

/**
  * @}
  */

/** @defgroup HAL_mode_structure_definition HAL 模式结构体定义
  * @brief  HAL 模式结构体定义
  * @note  HAL I2C 模式值编码遵循以下描述的位图：\n
  *          b7     （未使用）\n
  *             x  : 应设置为 0\n
  *          b6\n
  *             0  : 无\n
  *             1  : 内存（HAL I2C 通信处于内存模式）\n
  *          b5\n
  *             0  : 无\n
  *             1  : 从机（HAL I2C 通信处于从机模式）\n
  *          b4\n
  *             0  : 无\n
  *             1  : 主机（HAL I2C 通信处于主机模式）\n
  *          b3-b2-b1-b0  （未使用）\n