HAL库学习笔记-11 I2C

前言

前边的几篇笔记将STM32HAL片内主要外设的用法总结了一下，然而我们需要很多外围电路进行拓展，比如我们需要外接存储器进行文件或数据存储，需要LCD屏进行交互等待，这些外接设备需要和芯片进行通信，这些通信协议是接下来几篇的内容。

一、I2C协议简介

I2C通信协议(Inter-Integrated Circuit)是由飞利浦公司开发的。由于它引脚少，硬件实现简单，可扩展性强，不需要和USART、CAN等通讯协议一样的外部收发设备，现在被广泛地使用在系统内多个集成电路间的通讯。

I2C物理层

在这里插入图片描述
如图所示是I2C通讯设备之间常用的连接方式。有如下几个特点：

它是一个支持多设备的总线。“总线”指多个设备共用的信号线。在一个I2C总线中，可连接多个I2C通讯设备，支持多个通讯主机及多个通讯从机。
一个I2C总线只使用两条总线线路，一条双向串行数据线(SDA)，一条串行时钟线(SCL)。数据线即用来表示数据，时钟线用于数据收发同步。
每个连接到总线的设备都有一个独立的地址，主机可以利用这个地址进行不同设备之间的访问。
总线通过上拉电阻接到电源。当I2C设备空闲时，会输出高阻态。而当所有设备都空闲，都输出高阻态时，由上拉电阻把总线拉成高电平。
多个主机同时使用总线时，为了防止数据冲突，会利用仲裁方式决定由哪个设备占用总线。
具有三种传输模式：标准模式传输速率为100kbit/s，快速模式为400kbit/s，高速模式下可达3.4Mbit/s。但目前大多I2C设备不支持高速模式。
连接到相同总线的IC数量收到总线的最大电容400pF限制。

I2C协议层

I2C的协议定义了通讯的起始和停止信号、数据有效性、响应、仲裁、时钟同步和地址广播等环节。

1.基本读写过程

主机写数据到从机通讯复合模式
上述三图分别表示：主机向从机写数据；主机由从机中读取数据；复合通讯
图例：图中阴影格表示数据由主机传输至从机，空白格表示数据由从机传输至主机
S ：传输开始信号； SLAVE_ADDRESS: 从机地址；P ：停止传输信号
R/W：传输方向选择位，1 为读，0 为写；A/A：应答(ACK)或非应答(NACK)信号
这些图表示的是主机和从机通讯时，SDA 线的数据包序列。
其中S 表示由主机的I2C 接口产生的传输起始信号(S)，这时连接到I2C 总线上的所有从机都会接收到这个信号。
起始信号产生后，所有从机就开始等待主机紧接下来广播的从机地址信号(SLAVE_ADDRESS)。在I2C 总线上，每个设备的地址都是唯一的，当主机广播的地址与某个设备地址相同时，这个设备就被选中了，没被选中的设备将会忽略之后的数据信号。根据I2C 协议，这个从机地址可以是7 位或10 位。
在地址位之后，是传输方向的选择位，该位为0 时，表示后面的数据传输方向是由主机传输至从机，即主机向从机写数据。该位为1 时，则相反，即主机由从机读数据。
从机接收到匹配的地址后，主机或从机会返回一个应答(ACK)或非应答(NACK)信号，只有接收到应答信号后，主机才能继续发送或接收数据。
若配置的方向传输位为写数据方向，即第一幅图的情况，广播完地址，接收到应答信号后，主机开始正式向从机传输数据(DATA)，数据包的大小为8 位，主机每发送完一个字节数据，都要等待从机的应答信号(ACK)，重复这个过程，可以向从机传输N 个数据，这个N 没有大小限制。当数据传输结束时，主机向从机发送一个停止传输信号§，表示不再传输数据。
若配置的方向传输位为读数据方向，即第二幅图的情况，广播完地址，接收到应答信号后，从机开始向主机返回数据(DATA)，数据包大小也为8 位，从机每发送完一个数据，都会等待主机的应答信号(ACK)，重复这个过程，可以返回N 个数据，这个N 也没有大小限制。当主机希望停止接收数据时，就向从机返回一个非应答信号(NACK)，则从机自动停止数据传输。
除了基本的读写，I2C 通讯更常用的是复合格式，即第三幅图的情况，该传输过程有两次起始信号(S)。一般在第一次传输中，主机通过 SLAVE_ADDRESS 寻找到从设备后，发送一段“数据”，这段数据通常用于表示从设备内部的寄存器或存储器地址(注意区分它与SLAVE_ADDRESS 的区别)；在第二次的传输中，对该地址的内容进行读或写。也就是说，第一次通讯是告诉从机读写地址，第二次则是读写的实际内容。

2. 通讯的起始和停止信号

在这里插入图片描述
当SCL是高电平时SDA线从高电平向低电平切换，这个情况表示通讯的起始。当SCL是高电平时SDA线由低电平向高电平切换，表示通讯的停止。起始和停止信号一般由主机产生。

3. 数据有效性

在这里插入图片描述
SDA数据线在SCL 的每个时钟周期传输一位数据。传输时，SCL 为高电平的时候SDA 表示的数据有效，即此时的SDA 为高电平时表示数据“1”，为低电平时表示数据“0”。当SCL为低电平时，SDA 的数据无效，一般在这个时候SDA 进行电平切换，为下一次表示数据做好准备。每次数据传输都以字节为单位，每次传输的字节数不受限制。

4. 地址及数据方向

I2C 总线上的每个设备都有自己的独立地址，主机发起通讯时，通过SDA 信号线发送设备地址(SLAVE_ADDRESS)来查找从机。I2C 协议规定设备地址可以是7 位或10 位，实际中7 位的地址应用比较广泛。紧跟设备地址的一个数据位用来表示数据传输方向，它是数据方向位(R/W)，第8 位或第11 位。数据方向位为“1”时表示主机由从机读数据，该位为“0”时表示主机向从机写数据。读数据方向时，主机会释放对SDA 信号线的控制，由从机控制SDA 信号线，主机接收信号，写数据方向时，SDA 由主机控制，从机接收信号。

5. 应答信号

I2C 的数据和地址传输都带响应。响应包括“应答(ACK)”和“非应答(NACK)”两种信号。作为数据接收端时，当设备(无论主从机)接收到I2C 传输的一个字节数据或地址后，若希望对方继续发送数据，则需要向对方发送“应答(ACK)”信号，发送方会继续发送下一个数据；若接收端希望结束数据传输，则向对方发送“非应答(NACK)”信号，发送方接收到该信号后会产生一个停止信号，结束信号传输。
在这里插入图片描述
如图所示，传输时主机产生时钟，在第9 个时钟时，数据发送端会释放SDA 的控制权，由数据接收端控制SDA，若SDA 为高电平，表示非应答信号(NACK)，低电平表示应答信号(ACK)。

二、STM32的I2C特性及架构

直接控制STM32 的两个GPIO 引脚，分别用作SCL 及SDA，按照上述信号的时序要求，直接像控制LED 灯那样控制引脚的输出(若是接收数据时则读取SDA 电平)，就可以实现I2C 通讯。这种遵循协议的标准通讯称之为“软件模拟协议”方式。
相对地，还有“硬件协议”方式，STM32 的I2C 片上外设专门负责实现I2C 通讯协议，只要配置好该外设，它就会自动根据协议要求产生通讯信号，收发数据并缓存起来，CPU只要检测该外设的状态和访问数据寄存器，就能完成数据收发。这种由硬件外设处理I2C协议的方式减轻了CPU 的工作，且使软件设计更加简单。
STM32 的I2C 外设可用作通讯的主机及从机，支持100Kbit/s 和400Kbit/s 的速率，支持7 位、10 位设备地址，支持DMA 数据传输，并具有数据校验功能。它的I2C 外设还支持SMBus2.0 协议，SMBus 协议与I2C 类似，主要应用于笔记本电脑的电池管理中。

STM32 I2C架构解析

在这里插入图片描述

1.逻辑引脚

I2C的所有硬件架构都是根据图中左侧SCL线和SDA线展开的，STM32芯片有多个I2C外设，它们的I2C通讯信号引出到不同的GPIO引脚商，使用时必须配置到这些指定的引脚，这些引脚在CubeMX中可自动配置，也可查阅数据手册，手动配置。高级芯片还具有滤波器功能，能够有效过滤尖刺噪声。

2.时钟控制逻辑

SCL 线的时钟信号，由I2C 接口根据时钟控制寄存器(CCR)控制，控制的参数主要为时
钟频率。配置I2C 的CCR 寄存器可修改通讯速率相关的参数。

3.数据控制逻辑

I2C 的SDA 信号主要连接到数据移位寄存器上，数据移位寄存器的数据来源及目标是数据寄存器(DR)、地址寄存器(OAR)、PEC 寄存器以及SDA 数据线。当向外发送数据的时候，数据移位寄存器以“数据寄存器”为数据源，把数据一位一位地通过SDA 信号线发送出去；当从外部接收数据的时候，数据移位寄存器把SDA 信号线采样到的数据一位一位地存储到“数据寄存器”中。若使能了数据校验，接收到的数据会经过PCE 计算器运算，运算结果存储在“PEC 寄存器”中。当STM32 的I2C 工作在从机模式的时候，接收到设备地址信号时，数据移位寄存器会把接收到的地址与STM32 的自身的“I2C 地址寄存器”的值作比较，以便响应主机的寻址。STM32 的自身I2C 地址可通过修改“自身地址寄存器”修改，支持同时使用两个I2C 设备地址，两个地址分别存储在OAR1 和OAR2 中。

4.整体控制逻辑

整体控制逻辑负责协调整个I2C 外设，控制逻辑的工作模式根据我们配置的“控制寄存器(CR1/CR2)”的参数而改变。在外设工作时，控制逻辑会根据外设的工作状态修改“状态寄存器(SR1 和SR2)”，我们只要读取这些寄存器相关的寄存器位，就可以了解I2C的工作状态了。除此之外，控制逻辑还根据要求，负责控制产生I2C 中断信号、DMA 请求及各种I2C 的通讯信号(起始、停止、响应信号等)。

STM32 I2C外设通讯过程

使用I2C 外设通讯时，在通讯的不同阶段它会对“状态寄存器(SR1 及SR2)”的不同数据位写入参数，我们通过读取这些寄存器标志来了解通讯状态。

1.主发送器

在这里插入图片描述
图中的是“主发送器”流程，即作为I2C 通讯的主机端时，向外发送数据时的过程。
主发送器发送流程及事件说明如下：

控制产生起始信号(S)，当发生起始信号后，它产生事件“EV5”，并会对SR1 寄存器的“SB”位置1，表示起始信号已经发送；
紧接着发送设备地址并等待应答信号，若有从机应答，则产生事件“EV6”及“EV8”，这时SR1 寄存器的“ADDR”位及“TXE”位被置1，ADDR 为1 表示地址已经发送，TXE 为1 表示数据寄存器为空；
以上步骤正常执行并对ADDR 位清零后，我们往I2C 的“数据寄存器DR”写入要发送的数据，这时TXE 位会被重置0，表示数据寄存器非空，I2C 外设通过SDA 信号线一位位把数据发送出去后，又会产生“EV8”事件，即TXE 位被置1，重复这个过程，就可以发送多个字节数据了；
当我们发送数据完成后，控制I2C 设备产生一个停止信号§，这个时候会产生EV2 事件，SR1 的TXE 位及BTF 位都被置1，表示通讯结束。
假如我们使能了I2C 中断，以上所有事件产生时，都会产生I2C 中断信号，进入同一个中断服务函数，到I2C 中断服务程序后，再通过检查寄存器位来了解是哪一个事件。

2.主接收器

在这里插入图片描述
再来分析主接收器过程，即作为I2C 通讯的主机端时，从外部接收数据的过程。
主接收器接收流程及事件说明如下：

控制产生起始信号(S)，同主发送流程，起始信号(S)是由主机端产生的，当发生起始信号后，它产生事件“EV5”，并会对SR1 寄存器的“SB”位置1，表示起始信号已经发送；
紧接着发送设备地址并等待应答信号，若有从机应答，则产生事件“EV6”这时SR1 寄存器的“ADDR”位被置1，表示地址已经发送。
从机端接收到地址后，开始向主机端发送数据。当主机接收到这些数据后，会产生“EV7”事件，SR1 寄存器的RXNE 被置1，表示接收数据寄存器非空，我们读取该寄存器后，可对数据寄存器清空，以便接收下一次数据。此时我们可以控制I2C 发送应答信号(ACK)或非应答信号(NACK)，若应答，则重复以上步骤接收数据，若非应答，则停止传输；
发送非应答信号后，产生停止信号§，结束传输。
在发送和接收过程中，有的事件不只是标志了我们上面提到的状态位，还可能同时标志主机状态之类的状态位，而且读了之后还需要清除标志位，比较复杂。我们可使用STM32HAL 库函数来直接检测这些事件的复合标志，降低编程难度。

三、STM32 HAL库中的I2C

1.I2C初始化结构体

跟其它外设一样，STM32 HAL 库提供了I2C 初始化结构体及初始化函数来配置I2C 外设。初始化结构体及函数定义在库文件“ STM32F4xx_hal_i2c.h ” 及“STM32F4xx_hal_i2c.c”中，编程时我们可以结合这两个文件内的注释使用或参考库帮助文档。
代码如下（示例）：

typedef struct
{
  uint32_t ClockSpeed;       //设置SCL 时钟频率，此值要低于40 0000
  uint32_t DutyCycle;        /*指定时钟占空比，可选low/high = 2:1 及16:9 模式 */
  uint32_t OwnAddress1;      /*指定自身的I2C 设备地址1，可以是 7-bit 或者10-bit*/
  uint32_t AddressingMode;   /*指定地址的长度模式，可以是7bit 模式或者10bit 模式*/
  uint32_t DualAddressMode;  /*设置双地址模式 */
  uint32_t OwnAddress2;      /*指定自身的I2C 设备地址2，只能是 7-bit */
  uint32_t GeneralCallMode;  /*!< 指定广播呼叫模式 */
  uint32_t NoStretchMode;    /*!指定禁止时钟延长模式*/
} I2C_InitTypeDef;

这些结构体成员说明如下，其中括号内的文字是对应参数在STM32 HAL 库中定义的
宏：

ClockSpeed: 本成员设置的是I2C 的传输速率，在调用初始化函数时，函数会根据我们输入的数值写入到I2C 的时钟控制寄存器CCR。
DutyCycle: 本成员设置的是I2C 的SCL 线时钟的占空比。该配置有两个选择，分别为低电平时间比高电平时间为2：1 ( I2C_DutyCycle_2)和16：9 (I2C_DutyCycle_16_9)。其实这两个模式的比例差别并不大，一般要求都不会如此严格，这里随便选就可以了。
OwnAddress1:本成员配置的是STM32 的I2C 设备自身地址1，每个连接到I2C 总线上的设备都要有一个自己的地址，作为主机也不例外。地址可设置为7 位或10 位(受下面AddressingMode 成员决定)，只要该地址是I2C 总线上唯一的即可。STM32 的I2C 外设可同时使用两个地址，即同时对两个地址作出响应，这个结构成员I2C_OwnAddress1 配置的是默认的、OAR1 寄存器存储的地址，若需要设置第二个地址寄存器OAR2，可使用DualAddressMode成员使能，然后设置OwnAddress2 成员即可，OAR2 不支持10 位地址。
AddressingMode：本成员选择I2C 的寻址模式是7 位还是10 位地址。这需要根据实际连接到I2C 总线上设备的地址进行选择，这个成员的配置也影响到OwnAddress1 成员，只有这里设置成10位模式时， OwnAddress1 才支持10 位地址。
DualAddressMode：本成员决定是否使能双地址模式
OwnAddress2：本成员配置的是STM32 的I2C 设备自身地址2，每个连接到I2C 总线上的设备都要有一个自己的地址，作为主机也不例外。地址可设置为7 位，只要该地址是I2C 总线上唯一的即可。
GeneralCallMode：本成员是关于I2C 从模式时的广播呼叫模式设置。
NoStretchMode：本成员是关于I2C 禁止时钟延长模式设置，用于在从模式下禁止时钟延长。它在主模式下必须保持关闭。
配置完这些结构体成员值，调用库函数HAL_I2C_Init 即可把结构体的配置写入到寄存
器中。
以上这些参数配置均可在CubeMX中完成。
注意：I2C的引脚要初始化成复用开漏模式。

2.接口函数

如下为轮询查找的接口函数，同样也有中断和DMA方式的接口函数。

HAL_StatusTypeDef HAL_I2C_Master_Transmit(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint8_t *pData, uint16_t Size, uint32_t Timeout);
HAL_StatusTypeDef HAL_I2C_Master_Receive(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint8_t *pData, uint16_t Size, uint32_t Timeout);
HAL_StatusTypeDef HAL_I2C_Slave_Transmit(I2C_HandleTypeDef *hi2c, uint8_t *pData, uint16_t Size, uint32_t Timeout);
HAL_StatusTypeDef HAL_I2C_Slave_Receive(I2C_HandleTypeDef *hi2c, uint8_t *pData, uint16_t Size, uint32_t Timeout);
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_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_StatusTypeDef HAL_I2C_IsDeviceReady(I2C_HandleTypeDef *hi2c, uint16_t DevAddress, uint32_t Trials, uint32_t Timeout);

一般情况下我们使用外部模块时，是用来采集数据的，那么I2C外设作为主机与外部模块进行通讯，向外部传感器读取数据。通过CubeMX配置完成后，调用读写函数完成具体操作即可。