Linux TWI開發指南

1 前言

1.1 文檔簡介

介紹 Sunxi 平臺上 TWI 驅動接口與調試方法，為 TWI 模塊開發提供參考。

1.2 目標讀者

TWI 模塊內核層以及應用層的開發、維護人員。

1.3 適用范圍

表1-1：適用產品列表

內核版本	驅動文件
Linux-4.9	i2c-sunxi.c
Linux-5.4	i2c-sunxi.c

2 模塊介紹

2.1 模塊功能介紹

全志公司的 twi 總線兼容 i2c 總線協議，是一種簡單、雙向二線制同步串行總線。它只需要兩根線即可在連接于總線上的器件之間傳送信息。TWI 控制器支持的標準通信速率為 100kbps，最高通信速率可以達到 400kbps。全志的 twi 控制器支持一下功能：

? 支持主機模式和從機模式；

? 主機模式下支持 dma 傳輸；

? 主機模式下在多個主機的模式下支持總線仲裁；

? 主機模式下支持時鐘同步，位和字節等待；

? 從機模式下支持地址檢測中斷；

? 支持 7bit 從機地址和 10bit 從機地址；

? 支持常規的 i2c 協議模式和自定義傳輸模式；

sunxi 平臺支持多路 TWI，包含 TWI 與 S_TWI。

2.2 相關術語介紹

2.2.1 硬件術語

表 2-1: 硬件術語

相關術語	解釋說明
TWI	Two Wire Interface，全志平臺兼容 I2C 標準協議的總線控制器

2.2.2 軟件術語

表 2-2: 軟件術語

相關術語	相關術語
Sunxi	全志科技使用的 linux 開發平臺
I2C_dapter	linux 內核中 I2C 總線適配器的抽象定義.IIC 總線的控制器，在物理上連接若干個 I2C 設備
I2C_algorithm	linux 內核中 I2C 總線通信的抽象定義。描述 I2C 總線適配器與 I2C 設備之間的通信方法
I2C Client	linux 內核中 I2C 設備的抽象定義
I2C Driver	linux 內核中 I2C 設備驅動的抽象定義

2.3 模塊配置介紹

在不同的 Sunxi 硬件平臺中，TWI 控制器的數目不同；但對于同一塊板子上的每一個 TWI 控制器來說, 模塊配置類似，本小節展示 Sunxi 平臺上的 TWI0 控制器配置（其他 TWI 控制器配置類似）。

2.3.1 device tree 默認配置

設備樹中存在的是該類芯片所有平臺的模塊配置，設備樹文件的路徑為：{linux-ver}/arch/arm64（32 位平臺為 arm）/boot/dts/sunxi(32 位系統無這目錄)/xxxx.dtsi(CHIP 為研發代號，如sun50iw10p1 等), TWI 總線的設備樹配置如下所示：

twi0: twi@0x05002000{

#address-cells = <1>;

#size-cells = <0>;

compatible = "allwinner,sun50i-twi"; //具體的設備，用于驅動和設備的綁定

device_type = "twi0"; //設備節點名稱，用于sys_config.fex匹配

reg = <0x0 0x05002000 0x0 0x400>; //TWI0總線寄存器配置

interrupts = ; //TWI0總線中斷號、中斷類型

clocks = <&clk_twi0>; //設備使用的時鐘

clock-frequency = <400000>; //TWI0控制器的時鐘頻率

pinctrl-names = "default", "sleep"; //TWI0控制器使用的Pin腳名稱，其中default為正常通 信時的引腳配置，sleep為睡眠時的引腳配置

pinctrl-0 = <&twi0_pins_a>; //TWI0控制器default時使用的pin腳配置

pinctrl-1 = <&twi0_pins_b>; //TWI0控制器sleep時使用的pin腳配置

twi_drv_used = <1>; //使用DMA傳輸數據

status = "disabled"; //TWI0控制器是否使能

};

在 linux-5.4 中，TWI 的配置與 linux-4.9 內核配置有些不同，區別主要體現在 clock 和 dma 的配置上：

twi0: twi@0x05002000{

#address-cells = <1>;

#size-cells = <0>;

compatible = "allwinner,sun20i-twi"; //具體的設備，用于驅動和設備的綁定

device_type = "twi0"; //設備節點名稱，用于sys_config.fex匹配

reg = <0x0 0x02502000 0x0 0x400>; //TWI0總線寄存器配置

interrupts-extended= <&plic0 25 IRQ_TYPE_LEVEL_HIGH>; //TWI0總線中斷號、中斷類

clocks = <&ccu CLK_BUS_I2C0>;//twi控器使用的時鐘

resets = <&ccu RST_BUS_I2C0>;//twi控器使用的reset時鐘

clock-names = "bus";

clock-frequency = <400000>; //TWI0控制器的時鐘頻率

dmas = <&dma 43>, <&dma 43>;//TWI0控制器的dma通道號

dma-names = "tx", "rx";

status = "disabled";//TWI0控制器是否使能

};

為了在 TWI 總線驅動代碼中區分每一個 TWI 控制器，需要在 Device Tree 中的 aliases 節點中為每一個 TWI 節點指定別名：

aliases {

soc_twi0 = &twi0;

soc_twi1 = &twi1;

soc_twi2 = &twi2;

soc_twi3 = &twi3;

...

};

別名形式為字符串 “twi” 加連續編號的數字，在 TWI 總線驅動程序中可以通過 of_alias_get_id()函數獲取對應 TWI 控制器的數字編號，從而區別每一個 TWI 控制器。

其中 twi0_pins_a, twi0_pins_b 為 TWI 的引腳配置的配置節點。linux4.9 中 該 配 置 的 路 徑 為 arch/arm64（32 位 平 臺 為 arm）/boot/dts/sunxi/xxxxpinctrl.dtsi(CHIP 為研發代號，如 sun50iw10p1 等)，具體配置如下所示：

twi0_pins_a: twi0@0 {

allwinner,pins = "PD14", "PD15"; //TWI控制器使用的引腳

allwinner,pname = "twi0_scl", "twi0_sda"; //TWI控制器的引腳功能說明

allwinner,function = "twi0"; //引腳功能描述

allwinner,muxsel = <4>; //引腳復用功能配置

allwinner,drive = <0>; //io驅動能力

allwinner,pull = <0>; //內部電阻狀態

};

?

twi0_pins_b: twi0@1 {

allwinner,pins = "PD14", "PD15";

allwinner,function = "io_disabled";

allwinner,muxsel = <7>;

allwinner,drive = <1>;

allwinner,pull = <0>;

};

linux-5.4 中該配置的路徑為 arch/arm64（32 位平臺為 arm）/boot/dts/sunxi/xxxx.dtsi(CHIP為研發代號，如 sun50iw10p1 等)，具體如下所示：

twi0_pins_a: twi0@0 {

pins = "PH0", "PH1";

function = "twi0";

drive-strength = <10>;

};

twi0_pins_b: twi0@1 {

pins = "PH0", "PH1";

function = "gpio_in";

}

另外 clk_twi0 為時鐘的配置。

在 linux-4.9 中， 路 徑 為 arch/arm64（32 位 平 臺 為 arm）/boot/dts/sunxi/XXXXclk.dtsi(CHIP 為研發代號，如 sun50iw10p1 等)，具體配置如下所示：

clk_twi0: twi0 {

#clock-cells = <0>;

compatible = "allwinner,periph-clock";

clock-output-names = "twi0"; //指定clock名稱，用于匹配clock配置

};

在 linux-5.4 中，無需配置。

2.3.2 board.dts 板級配置

board.dts 用于保存每一個板級平臺的設備信息（如 demo 板，perf1 板，ver1 板等等），里面的配置信息會覆蓋上面的 device tree 默認配置信息。board.dts 的路徑為 longan/device/config/chips/IC/configs/BOARD/board.dts,

在 linux-4.9 中，對應 board.dts 里面 TWI0 的具體配置如下：

twi0_pins_a: twi0@0 {

allwinner,pins = "PA0", "PA1";

allwinner,pname = "twi0_scl", "twi0_sda";

allwinner,function = "twi0";

allwinner,muxsel = <4>;

allwinner,drive = <1>;

allwinner,pull = <0>;

};

?

twi0_pins_b: twi0@1 {

allwinner,pins = "PA0", "PA1";

allwinner,function = "io_disabled";

allwinner,muxsel = <7>;

allwinner,drive = <1>;

allwinner,pull = <0>;

};

?

twi0: twi@0x05002000{

clock-frequency = <400000>; //i2c時鐘頻率為400K

pinctrl-0 = <&twi0_pins_a>;

pinctrl-1 = <&twi0_pins_b>;

status = "okay"; //使能TWI0

};

在 linux-5.4 中，對應 board.dts 里面 TWI0 的具體配置如下：

&twi0 {

clock-frequency = <400000>;

pinctrl-0 = <&twi0_pins_a>;

pinctrl-1 = <&twi0_pins_b>;

pinctrl-names = "default", "sleep";

status = "disabled";

eeprom@50 {

compatible = "atmel,24c16";

reg = <0x50>;

status = "disabled";

};

};

其中，TWI 速率由 “clock-frequency” 屬性配置，最大支持 400K。

對于 TWI 設備，可以把設備節點填充作為 Device Tree 中相應 TWI 控制器的子節點。TWI 控制器驅動的 probe 函數透過 of_i2c_register_devices() ，自動展開作為其子節點的 TWI 設備。

對于 twi0 中引用的 pin 口，具體的配置如下：

twi0_pins_a: twi0@0 { pins = "PB10", "PB11"; /*sck sda*/ function = "twi0"; drive-strength = <10>; }; twi0_pins_b: twi0@1 { pins = "PB10", "PB11"; function = "gpio_in"; };

2.3.3 kernel menuconfig 配置

在 longan 中，linux-4.9 在 命 令 行 進 入 內 核 根 目 錄 (/kernel/linux-4.9)， 執 行 make ARCH=arm64 menuconfig (32 位平臺執行：make ARCH=arm menuconfig) 進入配置主界面，并按以下步驟操作 (linux-5.4 在根目錄中執行./build.sh menuconfig)在 tina 中，可以直接在根目錄里面執行 make kernel_menuconfig 進入 menuconfig 配置界面。

? 1. 選擇 Device Drivers 選項進入下一級配置，如下圖所示。

圖 2-1: Device Driver

? 2. 選擇 I2C support 選項，進入下一級配置，如下圖所示。

圖 2-2: I2C support

? 3. 配置用戶 I2C 接口，選擇 I2C device interface，如下圖所示。

圖 2-3: I2C device interface

? 4. 選擇 I2C HardWare Bus support 選項，進入下一級配置，如下圖所示。

圖 2-4: I2C HardWare Bus support

? 5. 選擇 SUNXI I2C controller 選項，可選擇直接編譯進內核，也可編譯成模塊。如下圖所示。

圖 2-5: SUNXI I2C controller

2.4 源碼模塊結構

I2C 總線驅動的源代碼位于內核在 drivers/i2c/busses 目錄下：

kernel/linux-4.9/drivers/i2c/ ├── busses │ ├── i2c-sunxi.c // Sunxi平臺的I2C控制器驅動代碼 │ ├── i2c-sunxi.h // 為Sunxi平臺的I2C控制器驅動定義了一些宏、數據結構 │ ├── i2c-sunxi-test.c // Sunxi平臺的i2c設備測試代碼,5.4下暫未適配 ├── i2c-core.c // I2C子系統核心文件,提供相關的接口函數 ├── i2c-dev.c // I2C子系統的設備相關文件，用以注冊相關的設備文件，方便調試

2.5 驅動框架介紹

圖 2-6: TWI 模塊結構框圖

Linux 中 I2C 體系結構上圖所示，圖中用分割線分成了三個層次：1. 用戶空間，包括所有使用I2C 設備的應用程序；2. 內核，也就是驅動部分；3. 硬件，指實際物理設備，包括了 I2C 控制器和 I2C 外設。

其中，Linux 內核中的 I2C 驅動程序從邏輯上又可以分為 6 個部分：

I2C framework 提供一種 “訪問 I2C slave devices” 的方法。由于這些 slave devices 由I2C controller 控制，因而主要由 I2C controller 驅動實現這一目標。

經過 I2C framework 的抽象，用戶可以不用關心 I2C 總線的技術細節，只需要調用系統的接口，就可以與外部設備進行通信。正常情況下，外部設備是位于內核態的其它 driver（如觸摸屏，攝像頭等等）。I2C framework 也通過字符設備向用戶空間提供類似的接口，用戶空間程序可以通過該接口訪問從設備信息。

在 I2C framework 內部，有 I2C core、I2C busses、I2C algos 和 I2C muxes 四個模塊。

I2C core 使用 I2C adapter 和 I2C algorithm 兩個子模塊抽象 I2C controller 的功能，使用 I2C client 和 I2C driver 抽象 I2C slave device 的功能（對應設備模型中的 device 和 device driver）。另外，基于 I2C 協議，通過 smbus 模塊實現 SMBus（System Management Bus，系統管理總線）的功能。

I2C busses 是各個 I2C controller drivers 的集合，位于 drivers/i2c/busses/目錄下，i2c-sunxi-test.c、i2c-sunxi.c、i2c-sunxi.h。

I2C algos 包含了一些通用的 I2C algorithm，所謂的 algorithm，是指 I2C 協議的通信方法，用于實現 I2C 的 read/write 指令，一般情況下，都是由硬件實現，不需要特別關注該目錄。

3 模塊接口說明

3.1 i2c-core 接口

3.1.1 i2c_transfer()

函數原型：int i2c_transfer(struct i2c_adapter *adap, struct i2c_msg *msgs, int num)

作用：完成 I2C 總線和 I2C 設備之間的一定數目的 I2C message 交互。

參數：

adap：指向所屬的 I2C 總線控制器；

msgs：i2c_msg 類型的指針；

num：表示一次需要處理幾個 I2C msg

返回：

>0：已經處理的 msg 個數；

<0：失敗；

3.1.2 i2c_master_recv()

函數原型：int i2c_master_recv(const struct i2c_client *client, char *buf, int count)

作用：通過封裝 i2c_transfer() 完成一次 I2c 接收操作。

參數：

client：指向當前 I2C 設備的實例；

buf：用于保存接收到的數據緩存；

count：數據緩存 buf 的長度

返回：

>0：成功接收的字節數；

<0：失敗；

3.1.3 i2c_master_send()

函數原型：int i2c_master_send(const struct i2c_client *client, const char *buf, int count)

作用：通過封裝 i2c_transfer() 完成一次 I2c 發送操作。

參數：

client：指向當前 I2C 從設備的實例；

buf：要發送的數據；

count：要發送的數據長度

返回：

>0：成功發送的字節數；

<0：失敗；

3.1.4 i2c_smbus_read_byte()

函數原型：s32 i2c_smbus_read_byte(const struct i2c_client *client)

作用：從 I2C 總線讀取一個字節。（內部是通過 i2c_transfer() 實現，以下幾個接口同。）

參數：

client：指向當前的 I2C 從設備

返回：

>0：讀取到的數據；

<0：失敗；

3.1.5 i2c_smbus_write_byte()

函數原型：s32 i2c_smbus_write_byte(const struct i2c_client *client, u8 value)

作用：從 I2C 總線寫入一個字節。

參數：

client：指向當前的 I2C 從設備；

value：要寫入的數值

返回：

0：成功；

<0：失敗；

3.1.6 i2c_smbus_read_byte_data()

函數原型：s32 i2c_smbus_read_byte_data(const struct i2c_client *client, u8 command)

作用：從 I2C 設備指定偏移處讀取一個字節。

參數：

client：指向當前的 I2C 從設備；

command：I2C 協議數據的第 0 字節命令碼（即偏移值）；

返回：

>0：讀取到的數據；

<0：失敗；

3.1.7 i2c_smbus_write_byte_data()

函數原型：s32 i2c_smbus_write_byte_data(const struct i2c_client *client, u8 command,u8 value)

作用：從 I2C 設備指定偏移處寫入一個字節。

參數：

client：指向當前的 I2C 從設備；

command：I2C 協議數據的第 0 字節命令碼（即偏移值）；

value：要寫入的數值；

返回：

0：成功；

<0：失敗；

3.1.8 i2c_smbus_read_word_data()

函數原型：s32 i2c_smbus_read_word_data(const struct i2c_client *client, u8 command)

作用：從 I2C 設備指定偏移處讀取一個 word 數據（兩個字節，適用于 I2C 設備寄存器是 16 位的情況）。

參數：

client：指向當前的 I2C 從設備；

command：I2C 協議數據的第 0 字節命令碼（即偏移值）；

返回：

>0：讀取到的數據；

<0：失敗；

3.1.9 i2c_smbus_write_word_data()

函數原型：s32 i2c_smbus_write_word_data(const struct i2c_client *client, u8 command,u16 value)

作用：從 I2C 設備指定偏移處寫入一個 word 數據（兩個字節）。

參數：

client：指向當前的 I2C 從設備；

command：I2C 協議數據的第 0 字節命令碼（即偏移值）；

value：要寫入的數值

返回：

0：成功；

<0：失敗；

3.1.10 i2c_smbus_read_block_data()

函數原型：s32 i2c_smbus_read_block_data(const struct i2c_client *client, u8 command,u8 *values)

作用：從 I2C 設備指定偏移處讀取一塊數據。

參數：

client：指向當前的 I2C 從設備；

command：I2C 協議數據的第 0 字節命令碼（即偏移值）；

values：用于保存讀取到的數據；

返回：

>0：讀取到的數據長度；

<0：失敗；

3.1.11 i2c_smbus_write_block_data()

函數原型：s32 i2c_smbus_write_block_data(const struct i2c_client *client, u8 command,u8 length, const u8 *values)

作用：從 I2C 設備指定偏移處寫入一塊數據（長度最大 32 字節）。

參數：

client：指向當前的 I2C 從設備；

command：I2C 協議數據的第 0 字節命令碼（即偏移值）；

length：要寫入的數據長度；

values：要寫入的數據；

返回：

0：成功；

<0：失敗；

3.2 i2c 用戶態調用接口

i2c 的操作在內核中是當做字符設備來操作的，可以通過利用文件讀寫接口（open，write，read，ioctrl）等操作內核目錄中的/dev/i2c-* 文件來條用相關的接口，i2c 相關的操作定義在i2c-dev.c 里面，本節將介紹比較重要的幾個接口：

3.2.1 i2cdev_open()

函數原型：static int i2cdev_open(struct inode *inode, struct file *file)

作用：程序（C 語言等）使用 open(file) 時調用的函數。打開一個 i2c 設備，可以像文件讀寫的方式往 i2c 設備中讀寫數據

參數：

inode：inode 節點；

file：file 結構體；

返回：文件描述符

3.2.2 i2cdev_read()

函數原型：static ssize_t i2cdev_read(struct file *file, char __user *buf, size_t count,loff_t *offset)

作用：程序（C 語言等）調用 read() 時調用的函數。像往文件里面讀數據一樣從 i2c 設備中讀數據。底層調用 i2c_xfer 傳輸數據

參數：

file：file 結構體；

buf，寫數據 buf；

offset, 文件偏移。

返回：

非空：返回讀取的字節數；

<0：失敗；

3.2.3 i2cdev_write()

函數原型：static ssize_t i2cdev_write(struct file *file, const char __user *buf,size_t count, loff_t *offset)

作用：程序（C 語言等）調用 write() 時調用的函數。像往文件里面寫數據一樣往 i2c 設備中寫數據。底層調用 i2c_xfer 傳輸數據

參數：

file：file 結構體；

buf：讀數據 buf；

offset, 文件偏移。

返回：

0：成功；

<0：失敗；

3.2.4 i2cdev_ioctl()

函數原型：static long i2cdev_ioctl(struct file *file, unsigned int cmd, unsigned long arg)

作用：程序（C 語言等）調用 ioctl() 時調用的函數。像對文件管理 i/o 一樣對 i2c 設備管理。該功能比較強大，可以修改 i2c 設備的地址，往 i2 設備里面讀寫數據，使用 smbus 等等，詳細的可以查閱該函數。

參數：

file：file 結構體；

cmd：指令；

arg：其他參數。

返回：

0：成功；

<0：失敗；

4 模塊使用范例

4.1 利用 i2c-core 接口讀寫 TWI 設備

在內核源碼中有現成的 i2c 設備驅動實例：tina/lichee/kernel/linux-5.4/drivers/misc/eeprom/at24.c, 這是一個 EEPROM 的 I2C 設備驅動，為了驗證 I2C 總線驅動，所以其中通過 sysfs 節點實現讀寫訪問。下面對這個文件的一些關鍵點進行展示介紹：

#include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #define EEPROM_ATTR(_name) { .attr = { .name = #_name,.mode = 0444 }, .show = _name_00_show, } struct i2c_client *this_client; static const struct i2c_device_id at24_ids[] = { { "24c16", 0 }, { /* END OF LIST */ } }; MODULE_DEVICE_TABLE(i2c, at24_ids); static int eeprom_i2c_rxdata(char *rxdata, int length) { int ret; struct i2c_msg msgs[] = { { .addr = this_client->addr, .flags = 0, .len = 1, .buf = &rxdata[0], }, { .addr = this_client->addr, .flags = I2C_M_RD, .len = length, .buf = &rxdata[1], }, }; ret = i2c_transfer(this_client->adapter, msgs, 2); if (ret < 0) ? ? pr_info("%s i2c read eeprom error: %dn", __func__, ret); ? ? ? ?return ret; } ? ? static int eeprom_i2c_txdata(char *txdata, int length) { ? ?int ret; ? ?struct i2c_msg msg[] = { ? ? ? ?{ ? ? ? ? ? ?.addr = this_client->addr, .flags = 0, .len = length, .buf = txdata, }, }; ret = i2c_transfer(this_client->adapter, msg, 1); if (ret < 0) ? ?pr_err("%s i2c write eeprom error: %dn", __func__, ret); ? ? ? ?return 0; } static ssize_t read_show(struct kobject *kobj, struct kobj_attribute *attr, char *buf) { ? ?int i; ? ?u8 rxdata[4]; ? ?rxdata[0] = 0x1; ? ?eeprom_i2c_rxdata(rxdata, 3); ? ? ? ?for(i=0;i<4;i++) ? ?printk("rxdata[%d]: 0x%xn", i, rxdata[i]); ? ? ? ?return sprintf(buf, "%sn", "read end!"); } static ssize_t write_show(struct kobject *kobj, struct kobj_attribute *attr, char *buf) { ? ?int i; ? ?static u8 txdata[4] = {0x1, 0xAA, 0xBB, 0xCC}; ? ?for(i=0;i<4;i++) ? ? printk("txdata[%d]: 0x%xn", i, txdata[i]); ? ? ? ?eeprom_i2c_txdata(txdata,4); ? ? ? ?txdata[1]++; ? ?txdata[2]++; ? ?txdata[3]++; ? ? ? ?return sprintf(buf, "%sn", "write end!"); } static struct kobj_attribute read = EEPROM_ATTR(read); static struct kobj_attribute write = EEPROM_ATTR(write); static const struct attribute *test_attrs[] = { ? ?&read.attr, ? ?&write.attr, ? ?NULL, }; static int at24_probe(struct i2c_client *client, const struct i2c_device_id *id) { ? ?int err; ? ?this_client = client; ? ?printk("1..at24_probe n"); ? ?err = sysfs_create_files(&client->dev.kobj,test_attrs); printk("2..at24_probe n"); if(err){ printk("sysfs_create_files failedn"); } printk("3..at24_probe n"); return 0; } static int at24_remove(struct i2c_client *client) { return 0; } static struct i2c_driver at24_driver = { .driver = { .name = "at24", .owner = THIS_MODULE, }, .probe = at24_probe, .remove = at24_remove, .id_table = at24_ids, }; static int __init at24_init(void) { printk("%s %dn", __func__, __LINE__); return i2c_add_driver(&at24_driver); } module_init(at24_init); static void __exit at24_exit(void) { printk("%s()%d - n", __func__, __LINE__); i2c_del_driver(&at24_driver); } module_exit(at24_exit);

4.2 利用用戶態接口讀寫 TWI 設備

如果配置了 i2c devices interface，可以直接利用文件讀寫函數來操作 I2C 設備。下面這個程序直接讀取 /dev/i2c-* 來讀寫 i2c 設備：

#include #include #include #include #define CHIP "/dev/i2c-1" #define CHIP_ADDR 0x50 int main() { unsigned char rddata; unsigned char rdaddr[2] = {0, 0}; /* 將要讀取的數據在芯片中的偏移量 */ unsigned char wrbuf[3] = {0, 0, 0x3c}; /* 要寫的數據，頭兩字節為偏移量 */ printf("hello, this is i2c testern"); int fd = open(CHIP, O_RDWR); if (fd < 0) ? ?{ ? ? ? ?printf("open "CHIP"failedn"); ? ? ? ?goto exit; ? ?} ? ?if (ioctl(fd, I2C_SLAVE_FORCE, CHIP_ADDR) < 0) ? ?{ /* 設置芯片地址 */ ? ? ? ?printf("oictl:set slave address failedn"); ? ? ? ?goto close; ? ?} ? ?printf("input a char you want to write to E2PROMn"); ? ?wrbuf[2] = getchar(); ? ?printf("write return:%d, write data:%xn", write(fd, wrbuf, 3), wrbuf[2]); ? ?sleep(1); ? ?printf("write address return: %dn",write(fd, rdaddr, 2)); /* 讀取之前首先設置讀取的偏移量 */ ? ?printf("read data return:%dn", read(fd, &rddata, 1)); ? ?printf("rddata: %cn", rddata); ? ?close(fd); ? ? exit: ? ?return 0; }

5 FAQ

5.1 調試方法

5.1.1 調試工具

5.1.1.1 i2c-tools 調試工具

i2c-tools 是一個開源工具，專門用來調試 I2C 設備。可以用 i2c-tools 來獲取 i2c 設備的相關信息（默認集成在內核里面），并且讀寫相關的 i2c 設備的數據。i2c-tools 主要是通過讀寫/dev/i2c-* 文件獲取 I2C 設備，所以需要在 kernel/linux-4.9 的 menuconfig 里面把 I2C的 device interface 節點打開，具體的 i2c-tools 使用方法如下。

i2cdetect -l //獲取i2c設備信息 i2cdump -y i2c-number i2c-reg //把相關的i2c設備數據dump出來，如i2cdump -y 1 0x50 i2cget -y i2c-number i2c-reg data_rege //讀取i2c設備某個地址的數據，如i2cget -y 1 0x50 1 i2cset -y i2c-number i2c-reg data_rege data //往i2c設備某個地址寫數據，如i2cset -y 1 0x50 1 1

5.1.2 調試節點

5.1.2.1 /sys/module/i2c_sunxi/parameters/transfer_debug

此節點文件的功能是打開某個 TWI 通道通信過程的調試信息。缺省值是-1，不會打印任何通道的通信調試信息。

打開通道 x 通信過程調試信息的方法：

echo x > /sys/module/i2c_sunxi/parameters/transfer_debug

關閉通信過程調試信息的方法：

echo -1 > /sys/module/i2c_sunxi/parameters/transfer_debug

5.1.2.2 /sys/devices/soc.2/1c2ac00.twi.0/info

此節點文件可以打印出當前 TWI 通道的一些硬件資源信息。

cat /sys/devices/soc.2/1c2ac00.twi.0/info

5.1.2.3 /sys/devices/soc.2/1c2ac00.twi/status

此節點文件可以打印出當前 TWI 通道的一些運行狀態信息，包括控制器的各寄存器值。

cat /sys/devices/soc.2/1c2ac00.twi/status

5.2 常見問題

5.2.1 TWI 數據未完全發送

問題現象：incomplete xfer。具體的 log 如下所示：

[ 1658.926643] sunxi_i2c_do_xfer()1936 - [i2c0] incomplete xfer (status: 0x20, dev addr: 0x50) [ 1658.926643] sunxi_i2c_do_xfer()1936 - [i2c0] incomplete xfer (status: 0x48, dev addr: 0x50)

問題分析：此錯誤表示主控已經發送了數據（status 值為 0x20 時，表示發送了 SLAVE ADDR + WRITE；status 值為 0x48 時，表示發送了 SLAVE ADDR + READ），但是設備沒有回ACK，這表明設備無響應，應該檢查是否未接設備、接觸不良、設備損壞和上電時序不正確導致的設備未就緒等問題。

問題排查步驟：

? 步驟 1：通過設備樹里面的配置信息，核對引腳配置是否正確。每組 TWI 都有好幾組引腳配置。

? 步驟 2：更換 TWI 總線下的設備為 at24c16，用 i2ctools 讀寫 at24c16 看看是否成功，成功則表明總線工作正常。

? 步驟 3：排查設備是否可以正常工作以及設備與 I2C 之間的硬件接口是否完好。

? 步驟 4：詳細了解當前需要操作的設備的初始化方法，工作時序，使用方法，排查因初始化設備不正確導致通訊失敗。

? 步驟 5：用示波器檢查 TWI 引腳輸出波形，查看波形是否匹配。

5.2.2 TWI 起始信號無法發送

問題現象：START can’t sendout!。具體的 log 如下所示：

sunxi_i2c_do_xfer()1865 - [i2c1] START can't sendout!

問題分析：此錯誤表示 TWI 無法發送起始信號，一般跟 TWI 總線的引腳配置以及時鐘配置有關。應該檢查引腳配置是否正確，時鐘配置是否正確，引腳是否存在上拉電阻等等。

問題排查步驟：

? 步驟 1：重新啟動內核，通過查看 log，分析 TWI 是否成功初始化，如若存在引腳配置問題，應核對引腳信息是否正確。

? 步驟 2：根據原理圖，查看 TWI-SCK 和 TWI-SDA 是否經過合適的上拉電阻接到 3.3v 電壓。

? 步驟 3：用萬用表量 SDA 與 SCL 初始電壓，看電壓是否在 3.3V 附近（斷開此 TWI 控制器所有外設硬件連接與軟件通訊進程）。

? 步驟 4：核查引腳配置以及 clk 配置是否進行正確設置。

? 步驟 5：測試 PIN 的功能是否正常，利用寄存器讀寫的方式，將 PIN 功能直接設為 INPUT 功能（echo [reg] [val] > /sys/class/sunxi_dump/write），然后將 PIN 上拉和接地改變 PIN狀態，讀 PIN 的狀態 (echo [reg,reg] > /sys/class/sunxi_dump/dump;cat dump)，看是否匹配。

? 步驟 6：測試 CLK 的功能是否正常，利用寄存器讀寫的方式，將 TWI 的 CLK gating 等打開，（echo [reg] [val] > /sys/class/sunxi_dump/write），然后讀取相應 TWI 的寄存器信息，讀 TWI 寄存器的數據（echo [reg] ,[len]> /sys/class/sunxi_dump/dump)，查看寄存器數據是否正常。

5.2.3 TWI 終止信號無法發送

問題現象：STOP can’t sendout。具體的 log 如下所示：

twi_stop()511 - [i2c4] STOP can't sendout! sunxi_i2c_core_process()1726 - [i2c4] STOP failed!

問題分析：此錯誤表示 TWI 無法發送終止信號，一般跟 TWI 總線的引腳配置。應該檢查引腳配置是否正確，引腳電壓是否穩定等等。

問題排查步驟：

? 步驟 1：根據原理圖，查看 TWI-SCK 和 TWI-SDA 是否經過合適的上拉電阻接到 3.3v 電壓。

? 步驟 2：用萬用表量 SDA 與 SCL 初始電壓，看電壓是否在 3.3V 附近（斷開此 TWI 控制器所有外設硬件連接與軟件通訊進程）。

? 步驟 3：測試 PIN 的功能是否正常，利用寄存器讀寫的方式，將 PIN 功能直接設為 INPUT 功能（echo [reg] [val] > /sys/class/sunxi_dump/write），然后將 PIN 上拉和接地改變 PIN狀態，讀 PIN 的狀態 (echo [reg,reg] > /sys/class/sunxi_dump/dump;cat dump)，看是否匹配。

? 步驟 4: 查看設備樹配置，把其他用到 SCK/SDA 引腳的節點關閉，重新測試 I2C 通信功能。

5.2.4 TWI 傳送超時

問題現象：xfer timeout。具體的 log 如下所示：

[123.681219] sunxi_i2c_do_xfer()1914 - [i2c3] xfer timeout (dev addr:0x50)

問題分析: 此錯誤表示主控已經發送完起始信號，但是在與設備通信的過程中無法正常完成數據發送與接收，導致最終沒有發出終止信號來結束 I2C 傳輸，導致的傳輸超時問題。應該檢查引腳配置是否正常，CLK 配置是否正常，TWI 寄存器數據是否正常，是否有其他設備干擾，中斷是否正常等問題。

問題排查步驟：

? 步驟 1：核實 TWI 控制器配置是否正確。

? 步驟 2：根據原理圖，查看 TWI-SCK 和 TWI-SDA 是否經過合適的上拉電阻接到 3.3v 電壓。

? 步驟 3：用萬用表量 SDA 與 SCL 初始電壓，看電壓是否在 3.3V 附近（斷開此 TWI 控制器所有外設硬件連接與軟件通訊進程）。

? 步驟 4：關閉其他 TWI 設備，重新進行燒錄測試 TWI 功能是否正常。

? 步驟 4：測試 PIN 的功能是否正常，利用寄存器讀寫的方式，將 PIN 功能直接設為 INPUT 功能（echo [reg] [val] > /sys/class/sunxi_dump/write），然后將 PIN 上拉和接地改變 PIN狀態，讀 PIN 的狀態 (echo [reg,reg] > /sys/class/sunxi_dump/dump;cat dump)，看是否匹配。

? 步驟 5：測試 CLK 的功能是否正常，利用寄存器讀寫的方式，將 TWI 的 CLK gating 等打開，（echo [reg] [val] > /sys/class/sunxi_dump/write），然后讀取相應 TWI 的寄存器信息，讀 TWI 寄存器的數據（echo [reg] ,[len]> /sys/class/sunxi_dump/dump)，查看寄存器數據是否正常。

? 步驟 7：根據相關的 LOG 跟蹤 TWI 代碼執行流程，分析報錯原因。