《rt-thread驅動框架分析》-i2c驅動

驅動分析

I2C設備驅動框架圖：

1. 我們先RT-Thread的I2C框架圖（這是我自己理解的框架圖，如果不對的地方，請指出）：

• 上圖是我分析的RTT的I2C框架圖。主要分為三層，驅動層-核心層-設備層。如果你分析過Linux的I2C框架，它的層次也是這樣子。所以你了解了RTT的I2C之後再去看Linux的I2C框架，其實問題不大。
• 驅動層：分為硬體I2C驅動和軟體I2C驅動。
• 核心層： ①其中bit_ops是RTT為軟體I2C提供的中間層，它的作用：為底層模擬I2C驅動提供回調接口，為核心層提供統一I2C通信接口。②而硬體I2C則直接對接核心層，提供統一I2C通信接口。③RTT在核心層上，也像pin驅動那樣，封裝了一套API(虛線箭頭)，供用戶直接使用。④dev是提供RTT設備驅動框架的統一的API（實現箭頭）。⑤注意的是：模擬I2C驅動到核心層，增加了一層中間層。
• 設備層：設備就是雜七雜八的使用I2C的總線的設備。而這些設備可以選擇使用RTT驅動框架的API，也可以選擇RTT封裝好的API。

1. 通過上述的描述，可能還沒了解的很清晰。下面我根據兩種不同方式的驅動，兩種不同的API，逐一分析，並且會結合試驗來驗證。

driver 層：

• RT-Thread的I2C驅動，分為兩種類型：硬體I2C和軟體I2C。在stm32的BSP中提供了軟體I2C的驅動，不過為了全面介紹，硬體I2C的對接，作者也進行簡單的對接和實現。

軟體I2C：

1. 軟體I2C的層次圖：

1. drv_soft_i2c層: 主要進行軟體I2C所用到scl引腳，sda引腳初始化。scl引腳和sda引腳的獲取電平和設置電平接口和延時函數（udelay）。並對接bit_opt層提供的操作結構體：struct rt_i2c_bit_ops。並通過rt_i2c_bit_add_bus註冊，提供給bit_opt層回調。

• struct rt_i2c_bit_ops結構體：

struct rt_i2c_bit_ops{ void *data; void (*set_sda)(void *data, rt_int32_t state); void (*set_scl)(void *data, rt_int32_t state); rt_int32_t (*get_sda)(void *data); rt_int32_t (*get_scl)(void *data); void (*udelay)(rt_uint32_t us); rt_uint32_t delay_us; rt_uint32_t timeout;};

函數指針 功能 void (set_sda)(void data, rt_int32_t state) 設置SDA電平 void (set_scl)(void data, rt_int32_t state); 設置SCL電平 rt_int32_t (get_sda)(void data); 獲取SDA電平 rt_int32_t (get_scl)(void data); 獲取SCL電平 void (*udelay)(rt_uint32_t us); 軟體I2C時序所需要的的延時函數

• rt_i2c_bit_add_bus接口，主要註冊軟體I2C的引腳操作的回調函數。

1. bit_opt層：可以歸納為驅動層。其主要實現軟體I2C的時序等邏輯，並提供對應的I2C的收發處理函數，為drv_soft_i2c層提供提供了（struct rt_i2c_bit_ops）註冊接口和（rt_i2c_bit_add_bus）接口，為i2c_core層提供主機模式的數據處理函數。bit_opt層主要對接到i2c_core層提供操作結構體：struct rt_i2c_bus_device_ops以及i2c總線的註冊函數rt_i2c_bus_device_register：

• struct rt_i2c_bus_device_ops結構體：

struct rt_i2c_bus_device_ops{ rt_size_t (*master_xfer)(struct rt_i2c_bus_device *bus, struct rt_i2c_msg msgs[], rt_uint32_t num); rt_size_t (*slave_xfer)(struct rt_i2c_bus_device *bus, struct rt_i2c_msg msgs[], rt_uint32_t num); rt_err_t (*i2c_bus_control)(struct rt_i2c_bus_device *bus, rt_uint32_t, rt_uint32_t);};

函數指針 功能 master_xfer 主機模式的數據收發 slave_xfer 從機模式的數據收發 i2c_bus_control i2c總線的的操作參數等設置

• rt_i2c_bus_device_register接口：主要註冊I2C總線和收發數據的回調函數。

1. 軟體I2C驅動總結：rt-thread的軟體I2C，如果要對接其他平臺，只需要對接好結構體：struct rt_i2c_bit_ops。而軟體I2C的邏輯完全不用理會，全部由bit_opt層管理。

硬體I2C

1. 硬體I2C的層次圖：

1. drv_hw_i2c層：沒有軟體I2C的bit_opt層，而是直接對接i2c_core層提供的結構體：struct rt_i2c_bus_device_ops。作者為了簡單說明，寫了個例子（簡單粗暴的例子）：

struct rt_i2c_bus_device i2c1_bus;I2C_HandleTypeDef hi2c1;static rt_err_t i2c_hw_init(void){ hi2c1.Instance = I2C1; hi2c1.Init.ClockSpeed = 100000; hi2c1.Init.DutyCycle = I2C_DUTYCYCLE_2; hi2c1.Init.OwnAddress1 = 0; hi2c1.Init.AddressingMode = I2C_ADDRESSINGMODE_7BIT; hi2c1.Init.DualAddressMode = I2C_DUALADDRESS_DISABLE; hi2c1.Init.OwnAddress2 = 0; hi2c1.Init.GeneralCallMode = I2C_GENERALCALL_DISABLE; hi2c1.Init.NoStretchMode = I2C_NOSTRETCH_DISABLE; if (HAL_I2C_Init(&hi2c1) != HAL_OK) { Error_Handler(); } return RT_EOK;}static rt_size_t i2c_xfer(struct rt_i2c_bus_device *bus, struct rt_i2c_msg msgs[], rt_uint32_t num){ struct rt_i2c_msg *msg; rt_int32_t i, ret; for(i = 0; i< num; i++) { msg = &msgs[i]; if(msg->flags & RT_I2C_RD) { HAL_I2C_Master_Receive(&hi2c1, msg->addr, msg->buf, msg->len, 100); } else { HAL_I2C_Master_Transmit(&hi2c1, msg->addr, msg->buf, msg->len, 100); } } ret = i; return ret;}static const struct rt_i2c_bus_device_ops i2c_bus_ops ={ i2c_xfer, RT_NULL, RT_NULL};int rt_i2c_hw_init(void){ i2c_hw_init(); i2c1_bus.ops = &i2c_bus_ops; rt_i2c_bus_device_register(&i2c1_bus, "hw_i2c"); return RT_EOK;}INIT_DEVICE_EXPORT(rt_i2c_hw_init);

1. 以上硬體I2C對接，我只是對接了master_xfer。
2. 硬體I2C驅動總結：如果你是採用硬體I2C，那麼就不需要去關乎bit_opt層，其實通過上面的描述，你不難理解bit_opt層和drv_hw_i2c層其實對接都是i2c_core層的結構。這也是我為什麼把bit_opt層歸納為驅動層來講解了。

core 層：

1. i2c_core層為驅動層提供結構體：struct rt_i2c_bus_device_ops。為設備層提供I2C的數據收發處理函數。
2. 其實i2c_core層主要是封裝了一層API直接提供給用戶層設備調用。

函數 說明 rt_i2c_bus_device_find 查找i2c總線 rt_i2c_transfer 主機模式的i2c數據傳輸 rt_i2c_master_send 主機模式的i2c數據發送 rt_i2c_master_recv 主機模式的i2c數據接受

1. 其中rt_i2c_master_send函數和rt_i2c_master_recv函數是調用rt_i2c_transfer函數，而rt_i2c_transfer函數是調用master_xfer回調函數。如果你是使用這些接口，那麼device層可以不用理會。

device 層：

1. i2c_dev層，對接rt-thread設備驅動框架。提供read，write，control函數。並通過函數rt_device_register註冊到設備驅動框架。下面我也會使用這些接口來實現控制OLED。

函數 說明 i2c_bus_device_read I2C讀操作 i2c_bus_device_write I2C寫操作 i2c_bus_device_control I2C總線的控制

軟體I2C設計：

• 關鍵代碼, 注意軟體I2C的地址需要偏移一位：

struct rt_i2c_bus_device *i2c_bus;#define OLED_I2C_BUS_NAME "i2c1"#define OLED_ADDRESS 0x3cstatic rt_err_t write_reg(struct rt_i2c_bus_device *bus, rt_uint8_t reg, rt_uint8_t data){ rt_uint8_t buf[2]; struct rt_i2c_msg msgs; buf[0] = reg; buf[1] = data; msgs.addr = OLED_ADDRESS; msgs.flags = RT_I2C_WR; msgs.buf = buf; msgs.len = 2; /@@* 調用I2C設備接口傳輸數據 */ rt_i2c_transfer(bus, &msgs, 1); return RT_EOK;}static rt_err_t read_regs(struct rt_i2c_bus_device *bus, rt_uint8_t len, rt_uint8_t *buf){ struct rt_i2c_msg msgs; msgs.addr = OLED_ADDRESS; msgs.flags = RT_I2C_RD; msgs.buf = buf; msgs.len = len; /@@* 調用I2C設備接口傳輸數據 */ rt_i2c_transfer(bus, &msgs, 1); return RT_EOK;}int oled_init(void){ i2c_bus = rt_i2c_bus_device_find(OLED_I2C_BUS_NAME); if(i2c_bus == RT_NULL) { rt_kprintf("find i2c bus fail!\n"); return RT_ERROR; } rt_kprintf("find i2c bus success!\n"); ......}

• 效果圖：
  

硬體I2C設計：

• 關鍵代碼，注意硬體I2C的地址不需要偏移：

struct rt_i2c_bus_device *i2c_bus;#define OLED_I2C_BUS_NAME "hw_i2c"#define OLED_ADDRESS 0x78static rt_err_t write_reg(struct rt_i2c_bus_device *bus, rt_uint8_t reg, rt_uint8_t data){ rt_uint8_t buf[2]; struct rt_i2c_msg msgs; buf[0] = reg; buf[1] = data; msgs.addr = OLED_ADDRESS; msgs.flags = RT_I2C_WR; msgs.buf = buf; msgs.len = 2; /@@* 調用I2C設備接口傳輸數據 */ rt_i2c_transfer(bus, &msgs, 1); return RT_EOK;}static rt_err_t read_regs(struct rt_i2c_bus_device *bus, rt_uint8_t len, rt_uint8_t *buf){ struct rt_i2c_msg msgs; msgs.addr = OLED_ADDRESS; msgs.flags = RT_I2C_RD; msgs.buf = buf; msgs.len = len; /@@* 調用I2C設備接口傳輸數據 */ rt_i2c_transfer(bus, &msgs, 1); return RT_EOK;}int oled_init(void){ i2c_bus = rt_i2c_bus_device_find(OLED_I2C_BUS_NAME); if(i2c_bus == RT_NULL) { rt_kprintf("find i2c bus fail!\n"); return RT_ERROR; } rt_kprintf("find i2c bus success!\n"); ......}

使用驅動框架API實現：

• 關鍵代碼：

#define OLED_I2C_BUS_NAME "hw_i2c"struct rt_device *dev_i2c;#define OLED_ADDRESS 0x78static rt_err_t write_reg(struct rt_device *dev, rt_uint8_t reg, rt_uint8_t data){ rt_uint8_t buf[2]; rt_off_t pos; rt_uint16_t addr = OLED_ADDRESS; rt_uint16_t flags = RT_I2C_WR; buf[0] = reg; buf[1] = data; pos = (flags << 16) | addr; rt_device_write(dev, pos, buf, 2); return RT_EOK;}static rt_err_t read_regs(struct rt_device *dev, rt_uint8_t len, rt_uint8_t *buf){ rt_off_t pos; rt_uint16_t addr = OLED_ADDRESS; rt_uint16_t flags = RT_I2C_WR; pos = (flags << 16) | addr; rt_device_write(dev, pos, buf, 2); return RT_EOK;}int oled_init(void){ dev_i2c = rt_device_find(OLED_I2C_BUS_NAME); if(dev_i2c == RT_NULL) { rt_kprintf("find i2c bus fail!\n"); return RT_ERROR; } rt_kprintf("find i2c bus success!\n"); rt_device_open(dev_i2c, RT_DEVICE_OFLAG_RDWR); .... return RT_EOK;}

總結

• 有了I2C驅動框架，對於上層來說，不管硬體I2C還是軟體I2C調用接口都是一樣的。
• rt-thread為了方便，直接在核心層提供了一套API，這樣用戶層調用就更加方便。