LV08-01-I2C子系统-02-I2CTools

发表于 分类于 ， ， 本文字数： 4.7k 阅读时长 ≈ 17 分钟

了解下I2C-Tools。若笔记中有错误或者不合适的地方，欢迎批评指正😃。

点击查看使用工具及版本
PC端开发环境 Windows Windows11
Ubuntu Ubuntu20.04.2的64位版本
VMware® Workstation 17 Pro 17.6.0 build-24238078
终端软件 MobaXterm(Professional Edition v23.0 Build 5042 (license))
Win32DiskImager Win32DiskImager v1.0
Linux开发板环境 Linux开发板 正点原子 i.MX6ULL Linux 阿尔法开发板
uboot NXP官方提供的uboot，使用的uboot版本为U-Boot 2019.04
linux内核 linux-4.19.71(NXP官方提供)
点击查看本文参考资料
分类 网址 说明
官方网站 https://www.arm.com/ ARM官方网站，在这里我们可以找到Cotex-Mx以及ARMVx的一些文档
https://www.nxp.com.cn/ NXP官方网站
https://www.nxpic.org.cn/NXP 官方社区
https://u-boot.readthedocs.io/en/latest/u-boot官网
https://www.kernel.org/linux内核官网
点击查看相关文件下载
分类 网址 说明
NXP https://github.com/nxp-imx NXP imx开发资源GitHub组织，里边会有u-boot和linux内核的仓库
nxp-imx/linux-imx/releases/tag/v4.19.71 NXP linux内核仓库tags中的v4.19.71
nxp-imx/uboot-imx/releases/tag/rel_imx_4.19.35_1.1.0 NXP u-boot仓库tags中的rel_imx_4.19.35_1.1.0
I.MX6ULL i.MX 6ULL Applications Processors for Industrial Products I.MX6ULL 芯片手册（datasheet，可以在线查看）
i.MX 6ULL Applications ProcessorReference Manual I.MX6ULL 参考手册（下载后才能查看，需要登录NXP官网）
Source Code https://elixir.bootlin.com/linux/latest/source linux kernel源码
kernel/git/stable/linux.git - Linux kernel stable tree linux kernel源码(官网,tag 4.19.71)
https://elixir.bootlin.com/u-boot/latest/source uboot源码

一、参考资料

1. Linux驱动程序

i2c-dev.c - drivers/i2c/i2c-dev.c

2. I2C-Tools

这个工具官网在：I2C Tools - Linux i2c Wiki

image-20250324193337385

github仓库在这里：GitHub - oudream/i2c-tools

下载页面在这里：Index of /pub/software/utils/i2c-tools/

二、I2C-Tools简介

1. I2C-Tools是什么？

i2c-tools工具是一个专门调试i2c的，开源，可获取挂载的设备及设备地址，还可以在对应的设备指定寄存器设置值或者获取值等功能。通过这个工具，我们无需编写驱动程序即可访问I2C设备。

image-20250324195139434

对于APP访问硬件肯定是需要驱动程序的，对于I2C设备，内核提供了驱动程序 i2c-dev.c - drivers/i2c/i2c-dev.c，通过它可以直接使用下面的I2C控制器驱动程序来访问I2C设备。基本框架如下：

image-20210224172517485

i2c-tools是一套好用的工具，也是一套示例代码。

2. I2C-Tools的访问I2C设备的2种方式

I2C-Tools可以通过SMBus来访问I2C设备，也可以使用一般的I2C协议来访问I2C设备。使用一句话概括I2C传输：APP通过I2C Controller与I2C Device传输数据。在APP里，有这几个问题：

  • 怎么指定I2C控制器？

i2c-dev.c提供为每个I2C控制器(I2C Bus、I2C Adapter)都生成一个设备节点：/dev/i2c-0、/dev/i2c-1等

open某个/dev/i2c-X节点，就是去访问该I2C控制器下的设备

  • 怎么指定I2C设备？通过ioctl指定I2C设备的地址

（1）I2C_SLAVE

1
ioctl(file,  I2C_SLAVE, address)

如果该设备已经有了对应的设备驱动程序，则返回失败。

（2）I2C_SLAVE_FORCE

1
ioctl(file,  I2C_SLAVE_FORCE, address)

如果该设备已经有了对应的设备驱动程序，但是还是想通过i2c-dev驱动来访问它，则使用这个ioctl来指定I2C设备地址。

  • 怎么传输数据？

（1）一般的I2C方式：ioctl(file, I2C_RDWR, &rdwr)

（2）SMBus方式：ioctl(file, I2C_SMBUS, &args)

3. 交叉编译

  • 设置交叉编译工具
1
2
3
export ARCH=arm
export CROSS_COMPILE=arm-linux-gnueabihf-
export PATH=$PATH:/home/sumu/2software/gcc-arm-linux-gnueabihf-8.3.0/bin
  • 修改I2C-Tools的Makefile指定交叉编译工具链
1
2
3
4
5
6
7
CC      ?= gcc
AR      ?= ar
STRIP   ?= strip
#改为(指定交叉编译工具链前缀, 去掉问号)：
CC      = $(CROSS_COMPILE)gcc
AR      = $(CROSS_COMPILE)ar
STRIP   = $(CROSS_COMPILE)strip

在Makefile中，“?=”在第一次设置变量时才会起效果，如果之前设置过该变量，则不会起效果。

  • 执行make即可。
1
2
3
make
# 或者我们之前添加过交叉编译工具刀环境变量的话，可以直接执行以下命令
make cc=arm-linux-gnueabihf-gcc AR=arm-linux-gnueabihf-ar STRIP=arm-linux-gnueabihf-strip

执行make时，是动态链接，需要把libi2c.so也放到单板上：

1
sudo cp -avf libi2c.so libi2c.so.0 libi2c.so.0.1.1 ~/4nfs/imx6ull_rootfs/lib/

想静态链接的话，执行：make USE_STATIC_LIB=1。

三、使用I2C-Tools

使用一句话概括I2C传输：APP通过 I2C Controller 与 I2C Device传输数据。所以使用 I2C-Tools 时也需要指定：

  • 哪个I2C控制器(或称为I2C BUS、I2C Adapter)
  • 哪个I2C设备(设备地址)
  • 数据：读还是写、数据本身

1. i2cdetect：I2C检测

1.1 使用说明

1
2
3
4
5
6
7
8
9
# 列出当前的I2C Adapter(或称为I2C Bus、I2C Controller)
i2cdetect -l

# 打印某个I2C Adapter的Functionalities, I2CBUS为0、1、2等整数
i2cdetect -F I2CBUS

# 看看有哪些I2C设备, I2CBUS为0、1、2等整数
i2cdetect -y -a I2CBUS

注意：i2cdetect 的工作原理是对指定的 I2C 总线上的每个地址发送一个读请求，并根据设备的响应来判断该地址上是否有设备存在。如果设备存在并且响应，i2cdetect 会显示该地址；如果没有响应，则显示 *–*。此外，如果地址已经被内核驱动程序使用，则显示 UU

1.2 使用实例

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
# i2cdetect -l
i2c-1   i2c             STM32F7 I2C(0x40013000)                 I2C adapter
i2c-2   i2c             STM32F7 I2C(0x5c002000)                 I2C adapter
i2c-0   i2c             STM32F7 I2C(0x40012000)                 I2C adapter

# i2cdetect -F 0
Functionalities implemented by /dev/i2c-0:
I2C                              yes
SMBus Quick Command              yes
SMBus Send Byte                  yes
SMBus Receive Byte               yes
SMBus Write Byte                 yes
SMBus Read Byte                  yes
SMBus Write Word                 yes
SMBus Read Word                  yes
SMBus Process Call               yes
SMBus Block Write                yes
SMBus Block Read                 yes
SMBus Block Process Call         yes
SMBus PEC                        yes
I2C Block Write                  yes
I2C Block Read                   yes

# i2cdetect -y -a 0  
     0  1  2  3  4  5  6  7  8  9  a  b  c  d  e  f
00: 00 -- -- -- -- -- -- -- -- -- -- -- -- -- -- --
10: -- -- -- -- -- -- -- -- -- -- UU -- -- -- 1e --
20: -- -- UU -- -- -- -- -- -- -- -- -- -- -- -- --
30: -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --
40: -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --
50: -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --
60: -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --
70: -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --
# 说明：--表示没有该地址对应的设备, UU表示有该设备并且它已经有驱动程序,数值表示有该设备但是没有对应的设备驱动

2. i2cget：I2C读

2.1 使用说明如下

1
2
3
4
5
6
7
8
9
# i2cget
Usage: i2cget [-f] [-y] [-a] I2CBUS CHIP-ADDRESS [DATA-ADDRESS [MODE]]
  I2CBUS is an integer or an I2C bus name
  ADDRESS is an integer (0x03 - 0x77, or 0x00 - 0x7f if -a is given)
  MODE is one of:
    b (read byte data, default)
    w (read word data)
    c (write byte/read byte)
    Append p for SMBus PEC

2.2 使用示例

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
# 读一个字节: I2CBUS为0、1、2等整数, 表示I2C Bus; CHIP-ADDRESS表示设备地址
i2cget -f -y I2CBUS CHIP-ADDRESS

# 读某个地址上的一个字节: 
#    I2CBUS为0、1、2等整数, 表示I2C Bus
#    CHIP-ADDRESS表示设备地址
#    DATA-ADDRESS: 芯片上寄存器地址
#    MODE：有2个取值, b-使用`SMBus Read Byte`先发出DATA-ADDRESS, 再读一个字节, 中间无P信号
#                   c-先write byte, 在read byte，中间有P信号 
i2cget -f -y I2CBUS CHIP-ADDRESS DATA-ADDRESS MODE  

# 读某个地址上的2个字节: 
#    I2CBUS为0、1、2等整数, 表示I2C Bus
#    CHIP-ADDRESS表示设备地址
#    DATA-ADDRESS: 芯片上寄存器地址
#    MODE：w-表示先发出DATA-ADDRESS，再读2个字节
i2cget -f -y I2CBUS CHIP-ADDRESS DATA-ADDRESS MODE

3. i2cset：I2C写

3.1 使用说明

1
2
3
4
5
6
7
8
9
10
11
# i2cset
Usage: i2cset [-f] [-y] [-m MASK] [-r] [-a] I2CBUS CHIP-ADDRESS DATA-ADDRESS [VALUE] ... [MODE]
  I2CBUS is an integer or an I2C bus name
  ADDRESS is an integer (0x03 - 0x77, or 0x00 - 0x7f if -a is given)
  MODE is one of:
    c (byte, no value)
    b (byte data, default)
    w (word data)
  i (I2C block data)
    s (SMBus block data)
    Append p for SMBus PEC

3.2 使用示例

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
# 写一个字节: I2CBUS为0、1、2等整数, 表示I2C Bus; CHIP-ADDRESS表示设备地址
#           DATA-ADDRESS就是要写的数据
i2cset -f -y I2CBUS CHIP-ADDRESS DATA-ADDRESS

# 给address写1个字节(address, value):
#           I2CBUS为0、1、2等整数, 表示I2C Bus; CHIP-ADDRESS表示设备地址
#           DATA-ADDRESS: 8位芯片寄存器地址; 
#           VALUE: 8位数值
#           MODE: 可以省略，也可以写为b
i2cset -f -y I2CBUS CHIP-ADDRESS DATA-ADDRESS VALUE [b]

# 给address写2个字节(address, value):
#           I2CBUS为0、1、2等整数, 表示I2C Bus; CHIP-ADDRESS表示设备地址
#           DATA-ADDRESS: 8位芯片寄存器地址; 
#           VALUE: 16位数值
#           MODE: w
i2cset -f -y I2CBUS CHIP-ADDRESS DATA-ADDRESS VALUE w

# SMBus Block Write：给address写N个字节的数据
#   发送的数据有：address, N, value1, value2, ..., valueN
#   跟`I2C Block Write`相比, 需要发送长度N
#           I2CBUS为0、1、2等整数, 表示I2C Bus; CHIP-ADDRESS表示设备地址
#           DATA-ADDRESS: 8位芯片寄存器地址; 
#           VALUE1~N: N个8位数值
#           MODE: s
i2cset -f -y I2CBUS CHIP-ADDRESS DATA-ADDRESS VALUE1 ... VALUEN s

# I2C Block Write：给address写N个字节的数据
#   发送的数据有：address, value1, value2, ..., valueN
#   跟`SMBus Block Write`相比, 不需要发送长度N
#           I2CBUS为0、1、2等整数, 表示I2C Bus; CHIP-ADDRESS表示设备地址
#           DATA-ADDRESS: 8位芯片寄存器地址; 
#           VALUE1~N: N个8位数值
#           MODE: i
i2cset -f -y I2CBUS CHIP-ADDRESS DATA-ADDRESS VALUE1 ... VALUEN i

4. i2ctransfer：I2C传输(不是基于SMBus)

4.1 使用说明

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
# i2ctransfer
Usage: i2ctransfer [-f] [-y] [-v] [-V] [-a] I2CBUS DESC [DATA] [DESC [DATA]]...
  I2CBUS is an integer or an I2C bus name
  DESC describes the transfer in the form: {r|w}LENGTH[@address]
    1) read/write-flag 2) LENGTH (range 0-65535) 3) I2C address (use last one if omitted)
  DATA are LENGTH bytes for a write message. They can be shortened by a suffix:
    = (keep value constant until LENGTH)
    + (increase value by 1 until LENGTH)
    - (decrease value by 1 until LENGTH)
    p (use pseudo random generator until LENGTH with value as seed)

Example (bus 0, read 8 byte at offset 0x64 from EEPROM at 0x50):
  # i2ctransfer 0 w1@0x50 0x64 r8
Example (same EEPROM, at offset 0x42 write 0xff 0xfe ... 0xf0):
  # i2ctransfer 0 w17@0x50 0x42 0xff-

4.2 使用实例

1
2
3
4
5
6
7
8
9
10
11
# Example (bus 0, read 8 byte at offset 0x64 from EEPROM at 0x50):
i2ctransfer -f -y 0 w1@0x50 0x64 r8

# Example (bus 0, write 3 byte at offset 0x64 from EEPROM at 0x50):
i2ctransfer -f -y 0 w9@0x50 0x64 val1 val2 val3

# Example 
# first: (bus 0, write 3 byte at offset 0x64 from EEPROM at 0x50)
# and then: (bus 0, read 3 byte at offset 0x64 from EEPROM at 0x50)
i2ctransfer -f -y 0 w9@0x50 0x64 val1 val2 val3 r3@0x50  
i2ctransfer -f -y 0 w9@0x50 0x64 val1 val2 val3 r3 //如果设备地址不变,后面的设备地址可省略

四、AP3216C的操作

1. AP3216C简介

正点原子的开发板上有光感芯片AP3216C：

image-20250324233757890

I.MX6U-ALPHA 开发板上通过 I2C1 连接了一个三合一环境传感器： AP3216C， AP3216C是由敦南科技推出的一款传感器，其支持环境光强度(ALS)、接近距离(PS)和红外线强度(IR)这三个环境参数检测。该芯片可以通过 IIC 接口与主控制相连，并且支持中断。寄存器也比较简单：

image-20250324234208125

0X00 这个寄存器是模式控制寄存器，用来设置 AP3216C 的工作模式，一般开始先将其设置为 0X04，也就是先软件复位一次 AP3216C。接下来根据实际使用情况选择合适的工作模式，比如设置为 0X03，也就是开启 ALS+PS+IR。从 0X0A~0X0F 这 6 个寄存器就是数据寄存器，保存着 ALS、 PS 和 IR 这三个传感器获取到的数据值。如果同时打开 ALS、PS 和 IR 则读取间隔最少要 112.5ms，因为 AP3216C 完成一次转换需要 112.5ms。

我们编写程序会先检测 AP3216C 是否存在，一般的芯片是有个 ID 寄存器，通过读取 ID 寄存器判断 ID 是否正确就可以检测芯片是否存在。但是 AP3216C 没有 ID 寄存器，所以我们就可以通过向寄存器 0X00 写入一个值，然后再读取 0X00 寄存器，判断读出得到值和写入的是否相等，如果相等就表示 AP3216C 存在，否则的话 AP3216C 就不存在。

2. 硬件原理图

image-20250324234306894

3. 设备地址

AP3216 的设备地址为 0X1E ，这个我们可以看芯片手册：datasheet_my.pdf：

image-20250324234940023

4. 读写步骤

AP3216C是红外、光强、距离三合一的传感器，以读出光强、距离值为例，步骤如下：

  • 复位：往寄存器0写入0x4。
  • 使能：往寄存器0写入0x3。
  • 读光强：读寄存器0xC、0xD得到2字节的光强。
  • 读距离：读寄存器0xE、0xF得到2字节的距离值。

5. I2C-Tools的使用

5.1 i2cdetect

  • 列出当前的I2C Adapter(或称为I2C Bus、I2C Controller)
1
2
# i2cdetect -l
i2cdetect -l
image-20250324235328001
  • 打印某个I2C Adapter的Functionalities, I2CBUS为0、1、2等整数
1
2
3
# i2cdetect -F I2CBUS
i2cdetect -F 0
i2cdetect -F 1
image-20250324235435680
  • 看看有哪些I2C设备, I2CBUS为0、1、2等整数
1
2
3
#i2cdetect -y -a I2CBUS
i2cdetect -y -a 0
i2cdetect -y -a 1
image-20250324235723228 
1
2
3
-- ：表示没有该地址对应的设备
UU ：表示有该设备并且它已经有驱动程序
数值：表示有该设备但是没有对应的设备驱动

前面我们知道AP3216C接在I2C1上面，这里对应的是i2c-0。

5.2 使用SMBus协议

1
2
3
4
i2cset -f -y 0 0x1e 0 0x4 # 复位
i2cset -f -y 0 0x1e 0 0x3 # 使能
i2cget -f -y 0 0x1e 0xc w # 读光强
i2cget -f -y 0 0x1e 0xe w # 读距离
image-20250325000439916

5.3 使用I2C协议

1
2
3
4
i2ctransfer -f -y 0 w2@0x1e 0 0x4 # 复位
i2ctransfer -f -y 0 w2@0x1e 0 0x3 # 使能
i2ctransfer -f -y 0 w1@0x1e 0xc r2 # 读光强
i2ctransfer -f -y 0 w1@0x1e 0xe r2 # 读距离
image-20250325000549469

五、源码分析

1. 使用I2C方式

示例代码：i2ctransfer.c

image-20210224191404322

2. 使用SMBus方式

示例代码：i2cget.c、i2cset.c

image-20210224192345075