I2c子系统

1. 理解I2C协议的基础知识

协议概述
I2C（Inter-Integrated Circuit）是一种广泛使用的串行通信协议，通常用于短距离、低速的通信。它由Philips（现为NXP）在1982年发明，主要用于在集成电路（IC）之间进行通信。I2C协议的优点包括：
简单的总线结构：只需要两根信号线。
多主从设备支持：允许多个主设备和从设备共用同一条总线。
灵活性：支持各种速率，适用于不同的应用场景。
I2C适用于多种场景，包括：

微控制器和传感器之间的数据通信。
存储设备（如EEPROM）和处理器之间的数据传输。
显示设备（如LCD屏幕）的控制。
总线结构
I2C总线由两条主要信号线组成：

SDA（数据线）：用于传输数据。
SCL（时钟线）：用于同步数据传输。
在I2C总线上，多个设备可以通过唯一的地址进行通信。每个设备可以作为主设备或从设备。主设备发起通信并控制时钟信号，从设备响应主设备的请求。

信号线
SDA（Serial Data Line）：双向数据线，传输数据位。
SCL（Serial Clock Line）：单向时钟线，由主设备生成时钟信号，同步数据传输。

3. 熟悉I2C的工作原理

传输模式
I2C支持多种传输模式，包括：

标准模式（Standard Mode）：最高速率为100 kbps。
快速模式（Fast Mode）：最高速率为400 kbps。
高速模式（High-Speed Mode）：最高速率为3.4 Mbps。
地址格式
I2C设备的地址有两种格式：

7位地址：最常用的地址格式，支持128个设备地址。
10位地址：扩展地址格式，支持更多设备，但较少使用。
设备地址在传输时包括一个读/写位，用于指示主设备是要读取还是写入数据。

数据传输
I2C的数据传输过程包括以下几个步骤：

起始条件（Start Condition）：主设备拉低SDA线并保持SCL线高电平，表示通信开始。
地址传输（Address Transfer）：主设备发送从设备地址和读/写位，从设备响应。
数据传输（Data Transfer）：数据按字节传输，每个字节后跟一个ACK/NACK位。
停止条件（Stop Condition）：主设备拉高SDA线并保持SCL线高电平，表示通信结束。
ACK/NACK机制
ACK（Acknowledge）：确认信号，由接收方（通常是从设备）发送，表示数据已成功接收。
NACK（Not Acknowledge）：非确认信号，表示数据接收失败或没有更多数据要发送。

在C语言中，当我们将一个非零的值赋值给一个布尔类型或等效的引脚定义时，该值会被解释为1。这是因为在C语言中，任何非零值都被视为“真”，即等效于1。

4传输方法

I2C 数据传输格式
起始条件（Start Condition）:

主设备拉低 SDA 线，同时保持 SCL 线为高电平。起始条件表示一次数据传输的开始。
地址传输（Address Transfer）:

传输从设备地址，这是一个 7 位或 10 位的地址。通常使用 7 位地址。
在 7 位地址的情况下，地址后面紧跟一个 R/W 位（第8位），表示读（1）或写（0）操作。
总共传输 8 位数据：7 位地址 + 1 位 R/W 位。
ACK/NACK 位（Acknowledge/Not Acknowledge Bit）:
从设备收到地址后，会在第9个时钟周期发送 ACK（低电平）或 NACK（高电平），表示地址是否匹配。
数据传输（Data Transfer）:

数据按字节传输，每字节 8 位。
每字节后面紧跟一个 ACK/NACK 位。接收方在每个字节传输结束后发送 ACK（低电平）表示数据接收成功，或者发送 NACK（高电平）表示数据接收失败或传输结束。
读/写数据传输可以是多个字节。
停止条件（Stop Condition）:
主设备拉高 SDA 线，同时保持 SCL 线为高电平。停止条件表示一次数据传输的结束。

5、总结

总结一下数据传输的关键点：
数据稳定性：在 SCL 的高电平期间，SDA 上的数据必须保持稳定，不发生变化。这是因为在 SCL 的高电平时，数据被接收方读取。
数据变化时机：SDA 上的数据变化应在 SCL 的低电平期间进行，这样数据在 SCL 的下一个高电平到来之前已经稳定，确保数据的正确读取。
数据有效性：数据在 SCL 为高电平时被视为有效，此时数据被从设备读取。
每一次发送数据过后都需要收一个ack来确认数据是否收到
在I2C中，0110这个数据是先发送最高位，然后再发送低位。（高位先发送）
四，总线仲裁
多设备仲裁方式：比特级仲裁，优先级仲裁
同步传输：所有的主设备在同一个时钟信号下同步传输数据。
发送和监控：每个主设备在发送数据位时，同时监控总线上的实际电平。
如果主设备发送的是高电平（1），但检测到总线上的电平是低电平（0），则表明有其他主设备发送了低电平（0），并且该主设备失去了仲裁。
低电平优先：在I2C总线中，低电平（0）比高电平（1）优先。
因此，当一个主设备检测到它发送的高电平（1）与总线上的实际电平（0）不一致时，它会停止传输，让发送低电平（0）的主设备继续传输。
地址优先级仲裁：
可以设置地址的优先级

6、ii2c子系统

在Linux内核中

i2c整体结构图
在i2c子系统中被分为4层，下面一层为上面一层提供服务，I²C device driver:是用于管理和操作挂载在 I²C 总线上的设备的驱动程序.
I2C Core:就是I2C核心层:提供统一的访问函数，比如i2c_transfer、i2c_smbus_xfer等, 实现`I2C总线-设备-驱动模型，管理：I2C设备(i2c_client)、I2C设备驱动(i2c_driver)、I2C控制器(i2c_adapter)
i2c controller adapter:可以理解为实现总线驱动，以及操作寄存器发送i2c信号。
6.1、i2c设备驱动
在写i2c设备驱动的驱动时候主要是两个结构体，一个是i2c_client一个是i2c_driver,这个和前面讲的platform总线模型是一样的，i2c_client和i2c_driver也是抽象出来了一个虚拟总线（struct bus_type）,在这里只讲述关于设备树和i2c_driver的注册方法，i2c_client可以直接修改设备树里面的文件，供内核解析设备树文件，并生成i2c_client，i2c_client会和i2c_driver进行匹配，如果匹配上就会调用i2c_driver里面的probe函数进行其他的操作（通常是初始化一个file_opreation结构体进行其他的操作）。i2c_client在生成驱动之前，I2c设备先会从设备树里面获得i2c adapter的总线，解析i2c adapter的总线的信息，匹配对应的驱动，然后又会去生成i2c client(挂载在这个总线下的设备)的信息，匹配对应的i2c client的驱动，在i2c client的驱动里面会注册对应的i2c adapter供上层应用调用。
下面是注册一个i2c设备的驱动和设备树
设备树
在对应的i2c总线下面加入子节点

ap3216c@1e {
			compatible = "lite-on,ap3216c";
			reg = <0x1e>;
		};

上面会自动生成i2c client,下面会生成i2c driver对应的驱动

#include "asm/uaccess.h"
#include "linux/delay.h"
#include "linux/i2c.h"
#include <linux/module.h>
#include <linux/poll.h>

#include <linux/fs.h>
#include <linux/errno.h>
#include <linux/miscdevice.h>
#include <linux/kernel.h>
#include <linux/major.h>
#include <linux/mutex.h>
#include <linux/proc_fs.h>
#include <linux/seq_file.h>
#include <linux/stat.h>
#include <linux/init.h>
#include <linux/device.h>
#include <linux/tty.h>
#include <linux/kmod.h>
#include <linux/gfp.h>
#include <linux/gpio/consumer.h>
#include <linux/platform_device.h>
#include <linux/of_gpio.h>
#include <linux/of_irq.h>
#include <linux/interrupt.h>
#include <linux/irq.h>
#include <linux/slab.h>
#include <linux/fcntl.h>
#include <linux/timer.h>

/* 主设备号                                                                 */
static int major = 0;
static struct class *my_i2c_class;

static struct i2c_client *g_client;

static DECLARE_WAIT_QUEUE_HEAD(gpio_wait);
struct fasync_struct *i2c_fasync;


/* 实现对应的open/read/write等函数，填入file_operations结构体                   */
static ssize_t i2c_drv_read (struct file *file, char __user *buf, size_t size, loff_t *offset)
{
	int err;
	unsigned char *kern_buf;
	struct i2c_msg msgs[2];

	/* 从0读取size字节 */

	kern_buf = kmalloc(size, GFP_KERNEL);

	/* 初始化i2c_msg 
	 * 1. 发起一次写操作: 把0发给AT24C02, 表示要从0地址读数据
	 * 2. 发起一次读操作: 得到数据
	 */
	msgs[0].addr  = g_client->addr;
	msgs[0].flags = 0;  /* 写操作 */
	msgs[0].buf   = kern_buf;
	kern_buf[0]   = 0; /* 把数据0发给设备 */
	msgs[0].len   = 1;

	msgs[1].addr  = g_client->addr;
	msgs[1].flags = I2C_M_RD;  /* 读操作 */
	msgs[1].buf   = kern_buf;
	msgs[1].len   = size;

	err = i2c_transfer(g_client->adapter, msgs, 2);

	/* copy_to_user  */
	err = copy_to_user(buf, kern_buf, size);

	kfree(kern_buf);
	
	return size;
}

static ssize_t i2c_drv_write(struct file *file, const char __user *buf, size_t size, loff_t *offset)
{
	int err;
	unsigned char kern_buf[9];
	struct i2c_msg msgs[1];
	int len;
	unsigned char addr = 0;

	/* 把size字节的数据写入地址0 */

	//kern_buf = kmalloc(size+1, GFP_KERNEL);

	while (size > 0)
	{
		if (size > 8)
			len = 8;
		else
			len = size;

		size -= len;

		/* copy_from_user  */
		err = copy_from_user(kern_buf+1, buf, len);
		buf += len;


		/* 初始化i2c_msg 
		* 1. 发起一次写操作: 把0发给AT24C02, 表示要从0地址读数据
		* 2. 发起一次读操作: 得到数据
		*/
		msgs[0].addr  = g_client->addr;
		msgs[0].flags = 0;  /* 写操作 */
		msgs[0].buf   = kern_buf;
		kern_buf[0]   = addr;  /* 写AT24C02的地址 */
		msgs[0].len   = len+1;
		addr += len;
		//直接发送at24的内存地址和写在里面的这个数据地址占1字节，数据占8字节
		err = i2c_transfer(g_client->adapter, msgs, 1);

		mdelay(20);
	}

	//kfree(kern_buf);
	
	return size;    
}


static unsigned int i2c_drv_poll(struct file *fp, poll_table * wait)
{
	//printk("%s %s line %d\n", __FILE__, __FUNCTION__, __LINE__);
	poll_wait(fp, &gpio_wait, wait);
	//return is_key_buf_empty() ? 0 : POLLIN | POLLRDNORM;
	return 0;
}

static int i2c_drv_fasync(int fd, struct file *file, int on)
{
	if (fasync_helper(fd, file, on, &i2c_fasync) >= 0)
		return 0;
	else
		return -EIO;
}


/* 定义自己的file_operations结构体                                              */
static struct file_operations i2c_drv_fops = {
	.owner	 = THIS_MODULE,
	.read    = i2c_drv_read,
	.write   = i2c_drv_write,
	.poll    = i2c_drv_poll,
	.fasync  = i2c_drv_fasync,
};


static int i2c_drv_probe(struct i2c_client *client,
			const struct i2c_device_id *id)
{
	// struct device_node *np = client->dev.of_node;
	// struct i2c_adapter *adapter = client->adapter;

	/* 记录client */
	g_client = client;

	/* 注册字符设备 */
	/* 注册file_operations 	*/
	major = register_chrdev(0, "100ask_i2c", &i2c_drv_fops);  /* /dev/gpio_desc */

	my_i2c_class = class_create(THIS_MODULE, "100ask_i2c_class");
	if (IS_ERR(my_i2c_class)) {
		printk("%s %s line %d\n", __FILE__, __FUNCTION__, __LINE__);
		unregister_chrdev(major, "100ask_i2c");
		return PTR_ERR(my_i2c_class);
	}

	device_create(my_i2c_class, NULL, MKDEV(major, 0), NULL, "myi2c"); /* /dev/myi2c */
	
	return 0;
}

static int i2c_drv_remove(struct i2c_client *client)
{
	/* 反注册字符设备 */
	device_destroy(my_i2c_class, MKDEV(major, 0));
	class_destroy(my_i2c_class);
	unregister_chrdev(major, "100ask_i2c");

	return 0;
}

static const struct of_device_id myi2c_dt_match[] = {
	{ .compatible = "100ask,i2cdev" },
	{},
};

static const struct i2c_device_id at24c02_ids[] = {
	{ "xxxxyyy",	(kernel_ulong_t)NULL },
	{ /* END OF LIST */ }
};
static struct i2c_driver my_i2c_driver = {
	.driver = {
		   .name = "100ask_i2c_drv",
		   .owner = THIS_MODULE,
		   .of_match_table = myi2c_dt_match,
	},
	.probe = i2c_drv_probe,
	.remove = i2c_drv_remove,
	.id_table = at24c02_ids,
};


static int __init i2c_drv_init(void)
{
	/* 注册i2c_driver */
	return i2c_add_driver(&my_i2c_driver);
}

static void __exit i2c_drv_exit(void)
{
	/* 反注册i2c_driver */
	i2c_del_driver(&my_i2c_driver);
}

/* 7. 其他完善：提供设备信息，自动创建设备节点                                     */

module_init(i2c_drv_init);
module_exit(i2c_drv_exit);

MODULE_LICENSE("GPL");

MODULE_LICENSE("GPL");

在上面的代码中提供了i2c设备驱动的框架，以及上层调用下层的的接口file_opreation结构体，在上面用的是smbus协议来传输数据他是比i2c协议更加严格的时序。在i2c里面使用的是i2c_transfer来传输数据和读取数据，而传输的数据又用的是i2c_msg 来组装这个消息：
int i2c_transfer(struct i2c_adapter *adap, struct i2c_msg *msgs, int num);//进行数据传输
adap：指向 I2C 适配器（i2c_adapter）结构的指针。这个结构代表了一个 I2C 总线控制器。
msgs：指向一个 i2c_msg 结构数组的指针。每个 i2c_msg 结构代表一个要传输的数据块。
num：要传输的 i2c_msg 结构的数量。
返回值
成功时返回传输的 i2c_msg 数量。
失败时返回负值的错误码。

struct i2c_msg {
__u16 addr; /* 从设备地址 /
__u16 flags; / 控制标志 /0代表写，I2C_M_RD代表读
__u16 len; / 消息长度 */
__u8 buf; / 指向消息数据的指针 */
};

i2c_transfer的原理，i2c_transfer的原理，他会先去找到这个i2c设备的适配器在从i2c_adapter里面找到对应的i2c_algorithm 这个结构体里面的master_xfer来真正的操控i2c控制器硬件里面的寄存器取发送数据和接收数据。
i2c adapter适配器驱动
i2c adapter可以理解为为系统增加一个总线，这里实现一个虚拟的i2c总线，实现虚拟的总线最主要的是实现master_xfer这个函数，代码如下：

#include <linux/completion.h>
#include <linux/debugfs.h>
#include <linux/delay.h>
#include <linux/gpio/consumer.h>
//#include <linux/i2c-algo-bit.h>
#include <linux/i2c.h>
#include <linux/init.h>
#include <linux/interrupt.h>
#include <linux/module.h>
#include <linux/of.h>
//#include <linux/platform_data/i2c-gpio.h>
#include <linux/platform_device.h>
#include <linux/slab.h>

static struct i2c_adapter *g_adapter;

static unsigned char eeprom_buffer[512];
static int eeprom_cur_addr = 0;
static void eeprom_emulate_xfer(struct i2c_adapter *i2c_adap, struct i2c_msg *msg)
{
	int i;
	if (msg->flags & I2C_M_RD)
	{
		for (i = 0; i < msg->len; i++)
		{
			msg->buf[i] = eeprom_buffer[eeprom_cur_addr++];
			if (eeprom_cur_addr == 512)
				eeprom_cur_addr = 0;
		}
	}
	elsej  
	{
		if (msg->len >= 1)
		{
			eeprom_cur_addr = msg->buf[0];
			for (i = 1; i < msg->len; i++)
			{
				eeprom_buffer[eeprom_cur_addr++] = msg->buf[i];
				if (eeprom_cur_addr == 512)
					eeprom_cur_addr = 0;
			}
		}
	}
}

static int i2c_bus_virtual_master_xfer(struct i2c_adapter *i2c_adap,
		    struct i2c_msg msgs[], int num)
{
	int i;

	// emulate eeprom , addr = 0x50
	for (i = 0; i < num; i++)
	{
		if (msgs[i].addr == 0x50)
		{
			eeprom_emulate_xfer(i2c_adap, &msgs[i]);
		}
		else
		{
			i = -EIO;
			break;
		}
	}
	
	return i;
}

static u32 i2c_bus_virtual_func(struct i2c_adapter *adap)
{
	return I2C_FUNC_I2C | I2C_FUNC_NOSTART | I2C_FUNC_SMBUS_EMUL |
	       I2C_FUNC_SMBUS_READ_BLOCK_DATA |
	       I2C_FUNC_SMBUS_BLOCK_PROC_CALL |
	       I2C_FUNC_PROTOCOL_MANGLING;
}


const struct i2c_algorithm i2c_bus_virtual_algo = {
	.master_xfer   = i2c_bus_virtual_master_xfer,
	.functionality = i2c_bus_virtual_func,
};


static int i2c_bus_virtual_probe(struct platform_device *pdev)
{
	/* get info from device tree, to set i2c_adapter/hardware  */
	
	/* alloc, set, register i2c_adapter */
	g_adapter = kzalloc(sizeof(*g_adapter), GFP_KERNEL);

	g_adapter->owner = THIS_MODULE;
	g_adapter->class = I2C_CLASS_HWMON | I2C_CLASS_SPD;
	g_adapter->nr = -1;
	snprintf(g_adapter->name, sizeof(g_adapter->name), "i2c-bus-virtual");

	g_adapter->algo = &i2c_bus_virtual_algo;

	i2c_add_adapter(g_adapter); // i2c_add_numbered_adapter(g_adapter);
	
	return 0;
}

static int i2c_bus_virtual_remove(struct platform_device *pdev)
{
	i2c_del_adapter(g_adapter);
	return 0;
}
static const struct of_device_id i2c_bus_virtual_dt_ids[] = {
	{ .compatible = "100ask,i2c-bus-virtual", },
	{ /* sentinel */ }
};

static struct platform_driver i2c_bus_virtual_driver = {
	.driver		= {
		.name	= "i2c-gpio",
		.of_match_table	= of_match_ptr(i2c_bus_virtual_dt_ids),
	},
	.probe		= i2c_bus_virtual_probe,
	.remove		= i2c_bus_virtual_remove,
};


static int __init i2c_bus_virtual_init(void)
{
	int ret;

	printk("%s %s %d\n", __FILE__, __FUNCTION__, __LINE__);
	ret = platform_driver_register(&i2c_bus_virtual_driver);
	if (ret)
		printk(KERN_ERR "i2c-gpio: probe failed: %d\n", ret);

	return ret;
}
module_init(i2c_bus_virtual_init);

static void __exit i2c_bus_virtual_exit(void)
{
	printk("%s %s %d\n", __FILE__, __FUNCTION__, __LINE__);
	platform_driver_unregister(&i2c_bus_virtual_driver);
}
module_exit(i2c_bus_virtual_exit);

MODULE_AUTHOR("www.100ask.net");
MODULE_LICENSE("GPL");