stm32g4xx_ll_i2c.h

转到此文件的文档。

/**
  ******************************************************************************
  * @file    stm32g4xx_ll_i2c.h
  * @author  MCD Application Team
  * @brief   I2C LL 模块的头文件。
  ******************************************************************************
  * @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_LL_I2C_H
#define STM32G4xx_LL_I2C_H

#ifdef __cplusplus
extern "C" {
#endif

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

/** @addtogroup STM32G4xx_LL_Driver
  * @{
  */

#if defined (I2C1) || defined (I2C2) || defined (I2C3) || defined (I2C4)

/** @defgroup I2C_LL I2C
  * @{
  */

/* Private types -------------------------------------------------------------*/
/* Private variables ---------------------------------------------------------*/

/* Private constants ---------------------------------------------------------*/
/** @defgroup I2C_LL_Private_Constants I2C 私有常量
  * @{
  */
/**
  * @}
  */

/* Private macros ------------------------------------------------------------*/
#if defined(USE_FULL_LL_DRIVER)
/** @defgroup I2C_LL_Private_Macros I2C 私有宏
  * @{
  */
/**
  * @}
  */
#endif /*USE_FULL_LL_DRIVER*/

/* Exported types ------------------------------------------------------------*/
#if defined(USE_FULL_LL_DRIVER)
/** @defgroup I2C_LL_ES_INIT I2C 导出的初始化结构体
  * @{
  */
typedef struct
{
  uint32_t PeripheralMode;      /*!< 指定外设模式。
                                     此参数可以是 @ref I2C_LL_EC_PERIPHERAL_MODE 的值。

                                     此功能可以使用单元函数
                                     @ref LL_I2C_SetMode() 进行修改。 */

  uint32_t Timing;              /*!< 指定 SDA 建立时间、保持时间以及 SCL 高电平、低电平周期值。
                                     此参数必须参考 STM32CubeMX 工具和
                                     辅助宏 @ref __LL_I2C_CONVERT_TIMINGS() 进行设置。

                                     此功能可以使用单元函数
                                     @ref LL_I2C_SetTiming() 进行修改。 */

  uint32_t AnalogFilter;        /*!< 使能或禁用模拟噪声滤波器。
                                     此参数可以是 @ref I2C_LL_EC_ANALOGFILTER_SELECTION 的值。

                                     此功能可以使用单元函数
                                     @ref LL_I2C_EnableAnalogFilter() 或 LL_I2C_DisableAnalogFilter() 进行修改。 */

  uint32_t DigitalFilter;       /*!< 配置数字噪声滤波器。
                                     此参数可以是 Min_Data = 0x00 和 Max_Data = 0x0F 之间的数字。

                                     此功能可以使用单元函数
                                     @ref LL_I2C_SetDigitalFilter() 进行修改。 */

  uint32_t OwnAddress1;         /*!< 指定设备自身地址 1。
                                     此参数必须是 Min_Data = 0x00 和 Max_Data = 0x3FF 之间的值。

                                     此功能可以使用单元函数
                                     @ref LL_I2C_SetOwnAddress1() 进行修改。 */

  uint32_t TypeAcknowledge;     /*!< 指定地址接收匹配码或下一个接收字节之后的应答或非应答条件。
                                     此参数可以是 @ref I2C_LL_EC_I2C_ACKNOWLEDGE 的值。

                                     此功能可以使用单元函数
                                     @ref LL_I2C_AcknowledgeNextData() 进行修改。 */


  uint32_t OwnAddrSize;         /*!< 指定设备自身地址 1 的大小（7 位或 10 位）。
                                     此参数可以是 @ref I2C_LL_EC_OWNADDRESS1 的值。

                                     此功能可以使用单元函数
                                     @ref LL_I2C_SetOwnAddress1() 进行修改。 */
} LL_I2C_InitTypeDef;
/**
  * @}
  */
#endif /*USE_FULL_LL_DRIVER*/

/* Exported constants --------------------------------------------------------*/
/** @defgroup I2C_LL_Exported_Constants I2C 导出的常量
  * @{
  */

/** @defgroup I2C_LL_EC_CLEAR_FLAG 清除标志定义
  * @brief    可与 LL_I2C_WriteReg 函数一起使用的标志定义
  * @{
  */
#define LL_I2C_ICR_ADDRCF                   I2C_ICR_ADDRCF          /*!< 地址匹配标志   */
#define LL_I2C_ICR_NACKCF                   I2C_ICR_NACKCF          /*!< 非应答标志   */
#define LL_I2C_ICR_STOPCF                   I2C_ICR_STOPCF          /*!< 停止检测标志    */
#define LL_I2C_ICR_BERRCF                   I2C_ICR_BERRCF          /*!< 总线错误标志         */
#define LL_I2C_ICR_ARLOCF                   I2C_ICR_ARLOCF          /*!< 仲裁丢失标志  */
#define LL_I2C_ICR_OVRCF                    I2C_ICR_OVRCF           /*!< 溢出/欠载标志  */
#define LL_I2C_ICR_PECCF                    I2C_ICR_PECCF           /*!< PEC 错误标志         */
#define LL_I2C_ICR_TIMOUTCF                 I2C_ICR_TIMOUTCF        /*!< 超时检测标志 */
#define LL_I2C_ICR_ALERTCF                  I2C_ICR_ALERTCF         /*!< 警报标志             */
/**
  * @}
  */

/** @defgroup I2C_LL_EC_GET_FLAG 获取标志定义
  * @brief    可与 LL_I2C_ReadReg 函数一起使用的标志定义
  * @{
  */
#define LL_I2C_ISR_TXE                      I2C_ISR_TXE             /*!< 发送数据寄存器为空        */
#define LL_I2C_ISR_TXIS                     I2C_ISR_TXIS            /*!< 发送中断状态           */
#define LL_I2C_ISR_RXNE                     I2C_ISR_RXNE            /*!< 接收数据寄存器非空     */
#define LL_I2C_ISR_ADDR                     I2C_ISR_ADDR            /*!< 地址匹配（从机模式）        */
#define LL_I2C_ISR_NACKF                    I2C_ISR_NACKF           /*!< 接收到非应答标志       */
#define LL_I2C_ISR_STOPF                    I2C_ISR_STOPF           /*!< 停止检测标志                 */