1@page i2c i2c
2
3**[更正文档](https://gitee.com/alios-things/i2c/edit/master/README.md)**      **[贡献说明](https://help.aliyun.com/document_detail/302301.html)**
4
5# 概述
6> I2C VFS驱动子系统，该驱动的目的是给应用或组件提供通过VFS形式（open/close/ioctl）访问I2C控制器驱动对上层提供服务的接口。
7> 该组件初始化过程中，会根据hardware/chip/<chip_name>/package.yaml中定义的CONFIG_I2C_NUM来依此创建如下名称的设备节点：
8
9* /dev/i2c0
10* /dev/i2c1
11* ...
12* /dev/i2c[CONFIG_I2C_NUM - 1]
13
14> I2C VFS驱动子系统内部会将open/close/ioctl请求转换成对应硬件的HAL层接口调用，通过HAL层接口控制主控芯片对I2C控制器的参数（从设备地址、CLK等）的设定或发起I2C 读或写操作请求。
15
16## 版权信息
17> Apache license v2.0
18
19## 目录结构
20```tree
21│── src
22│   └── i2c_dev.c      # I2C VFS驱动程序源代码
23├── example            # I2C VFS驱动程序使用案例
24│   └── i2c_example.c  # 通过I2C VFS接口进行I2C通信的案例文件
25├── include            # I2C驱动子系统对外提供头文件目录
26│   ├── aos
27│   │   └── hal
28│   │       └── i2c.h  # AOS HAL API头文件声明，本文件中的API是给厂商对接HAL API的原型声明
29│   └── vfsdev
30│       └── i2c_dev.h  # I2C VFS驱动子系统对应用/组件提供的接口声明文件
31└── package.yaml       # I2C VFS驱动子系统的组件配置文件
32
33```
34
35## 依赖组件
36* base     # 最底层核心驱动模型、驱动自动加载机制以及Device VFS core
37* vfs      # VFS API抽象库
38* epoll    # 增强型多路复用IO接口 - epoll机制所在库
39
40# 常用配置
41> 本组件可以通过CONFIG_I2C_NUM配置对上层提供设备节点的数量，CONFIG_I2C_NUM代表芯片内部的I2C控制器的数量。
42> CONFIG_I2C_NUM默认是在hardware/chip/<chip_name>/package.yaml中的**define**节点进行配置。
43> 如果没有定义CONFIG_I2C_NUM，则代码中会定义默认对外输出的设备节点数量。
44> 设备节点数量: 默认4个, 如需修改，在hardware/chip/<chip_name>/package.yaml中修改CONFIG_I2C_NUM配置
45```yaml
46define:
47  CONFIG_I2C_NUM: 2
48```
49
50# API说明
51## 打开设备节点
52```c
53int open(const char *pathname, int flags);
54```
55
56|args                                    |description|
57|:-----                                  |:----|
58|pathname                                |I2C控制器外设VFS路径|
59|flags                                   |目前固定为0值|
60
61兼容POSIX标准的open接口。其中参数*pathname*为*/dev/i2c*加i2c控制器序号，例如*/dev/i2c0*。
62
63## 关闭设备节点
64```c
65int close(int fd);
66```
67兼容POSIX标准的close接口。
68
69## I2C 参数设置
70### I2C 数据传输频率
71arg为指向io_i2c_control_u的指针。
72
73```c
74int ioctl(int fd, IOC_I2C_SET_FREQ, unsigned long arg);
75
76// 假如和从设备通信clock频率为100k, 则用如下代码对其进行设置
77io_i2c_control_u c;
78c.freq = 100000; // set i2c clock frequence to 100k
79ioctl (fd, IOC_I2C_SET_FREQ, &c);
80
81```
82
83### I2C 地址模式、角色及从设备地址设置
84arg为指向io_i2c_control_u的指针。
85
86```c
87int ioctl(int fd, IOC_I2C_SET_CONFIG, unsigned long arg);
88
89// 假如从设备地址为0x40, 地址宽度为7-bit, 则使用如下代码对其进行设置
90io_i2c_control_u c;
91c.c.addr = 0x40;     // I2C从设备地址设置为0x40
92c.c.addr_width = 0;  // I2C从设备地址宽度为7-bit
93c.c.role = 1;        // i2c master模式
94ioctl (fd, IOC_I2C_SET_CONFIG, &c);
95
96```
97
98### I2C 数据收发
99
100arg为指向io_i2c_data_t的指针。
101
102```c
103int ioctl(int fd, int cmd, unsigned long arg);
104
105```
106其中cmd取值及其意义说明如下：
107
108|cmd                  |功能                                       |
109|:-----               |:----                                     |
110|IOC_I2C_MASTER_RX    |控制I2C控制器从外部I2C从设备读取数据           |
111|IOC_I2C_MASTER_TX    |控制I2C控制器向外部I2C从设备发送数据           |
112|IOC_I2C_MEM_RX       |控制I2C控制器从外部I2C存储类型的从设备读取数据   |
113|IOC_I2C_MEM_TX       |控制I2C控制器向外部I2C存储类型从设备发送数据     |
114
115io_i2c_data_t 结构体变量说明如下:
116
117|变量|说明                                         |
118|:-----     |:----                                |
119|addr       | 此次读写操作对应的i2c送设备地址          |
120|length     | 此次读写操作要读写数据的长度             |
121|data       | 写操作：指向要发送数据的首地址；读操作：指向接收数据存放内存块首地址 |
122|maddr      | 此次内存操作要读写的memory地址，只有在ioctl cmd id为IOC_I2C_MEM_TX/IOC_I2C_MEM_RX时有效 |
123|mlength    | 此次内存操作要读写的memory的长度，只有在ioctl cmd id为IOC_I2C_MEM_TX/IOC_I2C_MEM_RX时有效 |
124|timeout    | 此次操作的超时时间，单位：ms |
125
126# 使用示例
127组件使用示例相关的代码下载、编译和固件烧录均依赖AliOS Things配套的开发工具，所以首先需要参考[《AliOS Things集成开发环境使用说明之搭建开发环境》](https://help.aliyun.com/document_detail/302378.html)，下载安装。
128待开发环境搭建完成后，可以按照以下步骤进行示例的测试。
129
130## 步骤1 创建或打开工程
131
132**打开已有工程**
133
134如果用于测试的案例工程已存在，可参考[《AliOS Things集成开发环境使用说明之打开工程》](https://help.aliyun.com/document_detail/302381.html)打开已有工程。
135
136**创建新的工程**
137
138组件的示例代码可以通过编译链接到AliOS Things的任意案例（solution）来运行，这里选择helloworld_demo案例。helloworld_demo案例相关的源代码下载可参考[《AliOS Things集成开发环境使用说明之创建工程》](https://help.aliyun.com/document_detail/302379.html)。
139
140## 步骤2 添加组件
141> 如果芯片内部含有I2C控制器，则芯片厂在操作系统对接的时候已经将I2C组件添加在了芯片级别配置文件“hardware/chip/<chip_name>/package.yaml”中，此配置主要包含“设置组件依赖关系”及“设置芯片内部所含I2C控制器数量”两个配置。
142```yaml
143# 设置组件依赖关系
144depends:
145  - i2c: master
146
147# 设置芯片内部所含I2C控制器数量
148define:
149  CONFIG_I2C_NUM: 2
150```
151
152## 步骤3 下载组件
153
154在已安装了  的开发环境工具栏中，选择Terminal -> New Terminal启动终端，并且默认工作路径为当前工程的workspace，此时在终端命令行中输入：
155
156```shell
157
158aos install i2c
159
160```
161
162上述命令执行成功后，组件源码则被下载到了./components/drivers/peripheral/i2c路径中。
163
164## 步骤4 添加示例
165
166在i2c组件的package.yaml中添加[example示例代码](https://gitee.com/alios-things/i2c/tree/master/example)：
167
168```yaml
169source_file:
170
171I2C device driver
172#i2c VFS driver
173  - src/i2c_dev.c ? <CONFIG_U_I2C_DEV>
174#i2c VFS driver example
175- example/i2c_example.c ? <CONFIG_U_I2C_DEV>
176```
177
178## 步骤5 编译固件
179
180在示例代码已经添加至组件的配置文件，并且helloworld_demo已添加了对该组件的依赖后，就可以编译helloworld_demo案例来生成固件了，具体编译方法可参考[《AliOS Things集成开发环境使用说明之编译固件》](https://help.aliyun.com/document_detail/302384.html)。
181
182## 步骤6 烧录固件
183
184helloworld_demo案例的固件生成后，可参考[《AliOS Things集成开发环境使用说明之烧录固件》](https://help.aliyun.com/document_detail/302383.html)来烧录固件。
185
186## 步骤7 打开串口
187
188固件烧录完成后，可以通过串口查看示例的运行结果，打开串口的具体方法可参考[《AliOS Things集成开发环境使用说明之查看日志》](https://help.aliyun.com/document_detail/302382.html)。
189
190当串口终端打开成功后，可在串口中输入help来查看已添加的测试命令。
191
192## 步骤8 测试示例
193**CLI命令行输入：**
194```shell
195# 向挂载在I2C通道1上面的SI7006温湿度传感器（从设备地址）发送一个0xF5的指令，控制其量测温度
196i2c_write 1 64 245 1
197```
198
199> 关键日志
200```shell
201i2c comp write test success!
202```
203
204**CLI命令行输入：**
205```shell
206# 向挂载在I2C通道1上面的SI7006温湿度传感器（从设备地址）发送读2个字节数据的指令
207i2c_read 1 64 2
208```
209
210> 关键日志
211```shell
212i2c comp read test success!
213```
214
215# 注意事项
216> I2C是总线类型的bus，进行i2c组件读写测试，必须确保i2c总线上面有外挂i2c 从设备，并且i2c控制器id、i2c从设备地址、写入数据及长度信息都正确才能得到正确的执行结果；以上任一信息出错，执行i2c_read/i2c_write 都可能得到错误的执行结果。
217
218# FAQ
219> I2C总线协议的介绍可参考视频学习：https://www.bilibili.com/video/BV1zb4y197h6/
220
221