136 IIC驱动框架简介

一、iic物理总线

I2C 是很常见的一种总线协议， 由 NXP 公司设计的。
I2C 使用两条线在主控制器和从机之间进行数据通信。一条是 SCL(串行时钟线)，另外一条是 SDA(串行数据线)：
这两条数据线需要接上拉电阻，总线空闲的时候 SCL 和 SDA 处于高电平。
I2C 总线标准模式下速度可以达到 100Kb/S，快速模式下可以达到 400Kb/S。 I2C 总线工作是按照一定的协议来运行的，接下
来就看一下 I2C 协议。
SCL：时钟线，数据收发同步
SDA：数据线，具体数据

支持一主多从：
1、一个主机可以和多个从机通信；
2、各从设备地址独立，主机通过设备地址来区分从机。
3、标准模式传输速率为100kbit/s，快速模式为400kbit/s

SDA 和 SCL 这两根线必须要接一个上拉电阻，一般是 4.7K。其余的 I2C 从设备都挂接到 SDA 和 SCL 这两根线上，这样主设备（主控制器）就可以通过 SDA 和 SCL 这两根线来访问多个 I2C设备。

二、常见iic设备

eeprom：指带电可擦可编程只读存储器。是一种掉电后数据不丢失的存储芯片。 EEPROM 可以在电脑上或专用设备上擦除已有信息，重新编程。
触摸芯片
温湿度传感器
mpu6050（姿态传感器）
等等

三、框架图

• 引入设备树后，与平台总线相配合。对于设备树中的设备结点，一般会被解析成为平台总线中的平台设备。
  i2c外面再包装一层平台总线，如此来使用设备树方式。
  在设备树结点转化成平台设备后，再进一步转换成为i2c设备（然后注册到i2c总线上）。
  若i2c设备和i2c驱动能成功配对，那么在i2c总线的probe函数里面创建字符设备驱动，然后给字符设备驱动设置一个字符设备操作接口fops，在fops中有一个i2c核心函数（用于控制i2c设备函数）。
  i2c适配器就是i2c控制器，大部分场合使用芯片自带的i2c适配器即可。
  一个芯片内部可能有多个i2c控制器，每个适配器的配置不同，每个适配器都被抽象成一个独立的结构体。
  i2c适配器结构体中的Algorithm含有多个硬件操作的函数指针

• I2C核心
  提供I2C总线驱动和设备驱动的注册方法、注销方法、I2C通信硬件无关代码

• I2C 总线驱动
  主要包含I2C硬件体系结构中适配器(iic控制器)的控制，用于I2C 读写时序
  主要数据结构：I2C_adapter、i2c_algorithm

• I2C设备驱动
  通过I2C适配器与CPU交换数据
  主要数据结构：i2c_driver和i2c_client

四、核心数据结构

1、i2c_adapter结构体

抽象为/表示：一个i2c控制器
平台设备
include/linux/i2c.h

// 此结构体对应一个i2c控制器
struct i2c_adapter
 {
	struct module *owner;
	unsigned int class;		  /* classes to allow probing for */
	const struct i2c_algorithm *algo; /* the algorithm to access the bus */
	void *algo_data;

	...
};

• 相关API
  其实下面 构建i2c_adapter结构体 和 注册i2c_adapter 已经由nxp搞定了。

// 一个系统里可能有多个适配器，一个适配器对应一个编号
//  注册一个i2c_adapter，系统分配编号
int i2c_add_adapter(struct i2c_adapter *adapter)
// 注册一个i2c_adapter，自己指定编号
int i2c_add_numbered_adapter(struct i2c_adapter *adapter)
// 注销一个i2c_adapter
void i2c_del_adapter(struct i2c_adapter * adap)

2、i2c_algorithm结构体

include/linux/i2c.h
此结构体包含一系列函数指针

struct i2c_algorithm
{
	// 最重要，负责产生i2c通信时序，已经由nxp实现
	int (*master_xfer)(struct i2c_adapter *adap, struct i2c_msg *msgs,
			   int num);
	int (*smbus_xfer) (struct i2c_adapter *adap, u16 addr,
			   unsigned short flags, char read_write,
			   u8 command, int size, union i2c_smbus_data *data);

	/* To determine what the adapter supports */
	u32 (*functionality) (struct i2c_adapter *);

#if IS_ENABLED(CONFIG_I2C_SLAVE)
	int (*reg_slave)(struct i2c_client *client);
	int (*unreg_slave)(struct i2c_client *client);
#endif
};

• 对应一套具体的通信方法

• master_xfer：产生I2C通信时序，nxp官方已经写好了

3、struct i2c_client

include/linux/i2c.h
用来表示一个i2c设备
linux kernel会根据设备树自动生成此结构体，然后注册到i2c总线

struct i2c_client
{
	unsigned short flags;		/* div., see below		*/
	// i2c 设备地址
	unsigned short addr;		/* chip address - NOTE: 7bit	*/
	// i2c 设备名字
	char name[I2C_NAME_SIZE];
	struct i2c_adapter *adapter;	/* the adapter we sit on	*/
	// 继承一个
	struct device dev;		/* the device structure		*/
	int init_irq;			/* irq set at initialization	*/
	int irq;			/* irq issued by device		*/
	struct list_head detected;
#if IS_ENABLED(CONFIG_I2C_SLAVE)
	i2c_slave_cb_t slave_cb;	/* callback for slave mode	*/
#endif
};

4、struct i2c_driver

include/linux/i2c.h
表示i2c驱动，一个i2c驱动可以供多个i2c设备使用
此结构体需要我们自己构建

struct i2c_driver
{
	unsigned int class;

	/* Standard driver model interfaces */
	// 设备驱动匹配后，会执行此回调函数
	int (*probe)(struct i2c_client *, const struct i2c_device_id *);
	int (*remove)(struct i2c_client *);
	...
	struct device_driver driver;
	// 设备驱动的匹配的传统方式，引入设备树后少用
	const struct i2c_device_id *id_table;
	...
}

• 相关API

// 注册一个i2c_driver到i2c总线
int i2c_add_driver (struct i2c_driver *driver)
//  注销一个i2c_driver，从i2c总线删除
void i2c_del_driver(struct i2c_driver *driver)

五、I2C 总线驱动分析

1、i2c总线注册

系统上电后，i2c总线会被注册。
drivers/i2c/i2c-core-base.c

static int __init i2c_init(void)
{
	int retval;
	...
	// 注册一个新的总线，参数1详见下
	retval = bus_register(&i2c_bus_type);
	if (retval)
		return retval;

	is_registered = true;
	...
	retval = i2c_add_driver(&dummy_driver);
	if (retval)
		goto class_err;

	if (IS_ENABLED(CONFIG_OF_DYNAMIC))
		WARN_ON(of_reconfig_notifier_register(&i2c_of_notifier));
	if (IS_ENABLED(CONFIG_ACPI))
		WARN_ON(acpi_reconfig_notifier_register(&i2c_acpi_notifier));

	return 0;
	...
}

2、i2c总线定义

struct bus_type i2c_bus_type =
{
	.name		= "i2c",
	// 匹配规则，详见下
	.match		= i2c_device_match,
	.probe		= i2c_device_probe,
	.remove		= i2c_device_remove,
	.shutdown	= i2c_device_shutdown,
};

3、i2c设备和i2c驱动匹配规则

static int i2c_device_match(struct device *dev, struct device_driver *drv)
{
	struct i2c_client	*client = i2c_verify_client(dev);
	struct i2c_driver	*driver;


	/* Attempt an OF style match */
	// 设备树匹配，现在常用
	if (i2c_of_match_device(drv->of_match_table, client))
		return 1;

	/* Then ACPI style match */
	if (acpi_driver_match_device(dev, drv))
		return 1;

	driver = to_i2c_driver(drv);

	/* Finally an I2C match */
	// 传统匹配方式，现在很少用
	if (i2c_match_id(driver->id_table, client))
		return 1;

	return 0;
}

• of_driver_match_device：设备树匹配方式
  比较 I2C 设备节点的 compatible 属性和 of_device_id 中的 compatible 属性

• acpi_driver_match_device ： ACPI 匹配方式

• i2c_match_id：i2c总线传统匹配方式

  • 比较 I2C设备名字和 i2c驱动的id_table->name 字段是否相等

4、设备树节点

i2c总线驱动作为一个平台设备驱动，设备树文件中的i2c控制器节点作为平台设备，二者通过平台总线来配对。

arch/arm/boot/dts/imx6ull.dtsi

// i2c适配器节点
i2c1: i2c@21a0000
{
	#address-cells = <1>;
	#size-cells = <0>;
	// 匹配的i2c驱动：i2c-imx.c
	compatible = "fsl,imx6ul-i2c", "fsl,imx21-i2c";
	// i2c控制器的寄存器组
	reg = <0x21a0000 0x4000>;
	interrupts = <GIC_SPI 36 IRQ_TYPE_LEVEL_HIGH>;
	clocks = <&clks IMX6UL_CLK_I2C1>;
	status = "disabled";
};

5、i2c_imx_probe()函数

drivers/i2c/busses/i2c-imx.c

// 此函数内部完成i2c适配器的注册
// 主要工作两点：
//1. 初始化i2c_adapter，设置i2c_algorithm为i2c_imx_algo，向内核注册i2c_adapter
//2. 初始化i2c1控制器相关的寄存器
static int i2c_imx_probe(struct platform_device *pdev)
{
	const struct of_device_id *of_id = of_match_device(i2c_imx_dt_ids,
							   &pdev->dev);
	struct imx_i2c_struct *i2c_imx;
	struct resource *res;
	struct imxi2c_platform_data *pdata = dev_get_platdata(&pdev->dev);
	void __iomem *base;
	int irq, ret;
	dma_addr_t phy_addr;
	
	...
	// 获取设备树中的寄存器地址信息（起始地址、范围），保存到res结构体
	res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
	// 映射到虚拟地址
	base = devm_ioremap_resource(&pdev->dev, res);
	// 物理地址
	phy_addr = (dma_addr_t)res->start;
	i2c_imx = devm_kzalloc(&pdev->dev, sizeof(*i2c_imx), GFP_KERNEL);
	...
	// 此成员记录硬件操作相关的代码，产生时序（关键一步，初始化操作）
	i2c_imx->adapter.algo		= &i2c_imx_algo;
	...
	// 要操作的寄存器的虚拟地址
	i2c_imx->base			= base;
	...
	// 向内核注册adapter适配器
	ret = i2c_add_numbered_adapter(&i2c_imx->adapter);
	...
}

6、i2c_imx_algo结构体变量

drivers/i2c/busses/i2c-imx.c

static const struct i2c_algorithm i2c_imx_algo =
{
	// 重要，产生i2c时序，进行数据收发
	// 最终就是通过此函数来完成与i2c设备通信的
	.master_xfer	= i2c_imx_xfer,
	// 查询i2c协议通信类型
	.functionality	= i2c_imx_func,
};

• i2c_imx_xfer：iic通信函数
• i2c_imx_func：查询iic通信协议类型

7、i2c_imx_func()函数

drivers/i2c/busses/i2c-imx.c

// 用于返回此i2c适配器支持什么样的通信协议
static u32 i2c_imx_func(struct i2c_adapter *adapter)
{
	// 每一个宏代表一个具体的i2c通信协议
	return I2C_FUNC_I2C | I2C_FUNC_SMBUS_EMUL
		| I2C_FUNC_SMBUS_READ_BLOCK_DATA;
}

8、i2c_imx_xfer()函数

drivers/i2c/busses/i2c-imx.c

static int i2c_imx_xfer(struct i2c_adapter *adapter,
						struct i2c_msg *msgs, int num)
{
	unsigned int i, temp;
	int result;
	bool is_lastmsg = false;
	bool enable_runtime_pm = false;
	struct imx_i2c_struct *i2c_imx = i2c_get_adapdata(adapter);
	...
	// 让i2c控制器发出一个i2c启动信号
	result = i2c_imx_start(i2c_imx);
	...
		// 数据的收发在for循环里面，每个for循环发送或接收一个字节
		for (i = 0; i < num; i++) {
		if (i == num - 1)
			is_lastmsg = true;

		if (i) {
			dev_dbg(&i2c_imx->adapter.dev,
				"<%s> repeated start\n", __func__);
			temp = imx_i2c_read_reg(i2c_imx, IMX_I2C_I2CR);
			temp |= I2CR_RSTA;
			imx_i2c_write_reg(temp, i2c_imx, IMX_I2C_I2CR);
			// 判断i2c总线是否处于忙碌状态
			result = i2c_imx_bus_busy(i2c_imx, 1);
			if (result)
				goto fail0;
		}
	...
		// 判断是要读数据还是写数据
		if (msgs[i].flags & I2C_M_RD)
			result = i2c_imx_read(i2c_imx, &msgs[i], is_lastmsg);
		else {
			if (i2c_imx->dma && msgs[i].len >= DMA_THRESHOLD)
				result = i2c_imx_dma_write(i2c_imx, &msgs[i]);
			else
				result = i2c_imx_write(i2c_imx, &msgs[i]);
		}
		if (result)
			goto fail0;
	}

fail0:
	/* Stop I2C transfer */
	i2c_imx_stop(i2c_imx);
	...
}