1. Tổng quan
Với sự phát triển của khoa học công nghệ, trong hệ thống nhúng (embedded system), ngày càng có nhiều phần cứng được ra đời và sử dụng. Việc xác định và cấu hình các thiết bị phần cứng có thể trở nên phức tạp. Do đó, cần có một phương pháp chuẩn hóa nào đó mô tả thông phần cứng giúp người lập trình viên hiểu thông tin mô tả phần cứng chỉ theo 1 hướng xác định.
Ví dụ: Cùng với một thanh ghi trong vi điều khiển, các lập trình viên có thể define thanh ghi đó bằng các tên khác nhau khiến việc đọc và phát triển source code khó khăn.
Device tree (DT) giúp giải quyết vấn đề này bằng cách cung cấp một phương tiện mô tả cấu hình phần cứng của hệ thống. Deviece tree là một file môt tả cấu trúc cây, ở đó thì các device được đại diện bằng các node. Mỗi node có các trường, các trường có thể được gán giá trị hoặc để trống.
Device tree có thể mô tả các thông tin sau:
- Số lượng và loại CPU
- Địa chỉ cơ bản và kích thước bộ nhớ SoC
- Các đường bus và kết nối ngoại vi với SoC
- Ngắt và bộ điều khiển ngắt
- Bộ điều khiển GPIO và trạng thái của GPIO
Về cơ bản, Device tree giúp nhúng thông tin cấu hình phần cứng vào mã của kernel. Sau khi hệ thống khởi động, bootloader sẽ chuyển Device tree vào Linux kernel và dựa vào thông tin các device được khai báo trong Device tree, các thiết bị được khởi tạo như platform_device, spi_device. i2c-device,…Bên cạnh đó, các thông tin về bộ nhớ, ngắt, tài nguyên mà deivce sử dụng cũng được chuyển đến kernel và kernel sẽ liên kết các thông tin này với device tương ứng.
Để tìm hiểu chi tiếp về Device Tree, có thể truy cập vào: The Devicetree Project
Công dụng của Device Tree
Device Tree cho phép dễ dàng thay đổi cấu trúc phần cứng của hệ thống mà không cần sửa đổi mã nguồn driver.
Device Tree giúp tách rời thông tin phần cứng từ mã nguồn kernel, làm cho kernel trở nên chuyên biệt hóa và dễ tái sử dụng trên nhiều nền tảng phần cứng.
2. Cơ bản về Device Tree source
DTS (Device Tree Source)
File có định dạng .dts là một file mô tả Device Tree ở định dạng văn bản. Trong ARM Linuxx, tệp .dts tương ứng với kiến trúc ARM và thường được đặt trong thư mục /arch/arm/boot/dts/.
DTSI (Device Tree Source Include)
Với một hệ thống SoC cơ bản sẽ tương ứng với nhiều board khác nhau, nên sẽ có nhiều thành phần phổ biến vầ Device Tree sẽ lưu trữ các thành phần phổ biến đó trong file có định dạng .dtsi . Các file này tương ứng với các file thư viện trong lập trình C.
DTC (Device Tree Compiler)
DTC là công cụ biên dịch DTS và có thể chuyển đổi các file .dts thành file có định dạng .dtb và công cụ này có sẵn trong mã nguồn kernel. Khi Linux Kernel bật Device Tree, trình biên dịch DTC sẽ thực hiện biên dịch DTS khi kernel được biên dịch.
DTB (Devce Tree Blob)
File có định dạng .dtb là file Device Tree được biểu diễn ở dạng mã nhị phân được biên dịch từ file .dts thông qua DTC
Việc biên dịch ngược từ .dtb sang .dts cũng có thể thực hiện được:
|
1 |
dtc -I dtb -O dts am335x-boneblack.dtb > output.txt |
3. Các kiểu dữ liệu và thuộc cơ bản trong Device Tree
Một số kiểu dữ liệu sử dụng trong DT bao gồm:
- Chuỗi, nằm trong dấu ngoặc kép “string”. Ta có thể sử dụng dấu phẩy để tạo một danh sách các chuỗi.
- Số nguyên dương 32-bit, nằm trong dấu ngoặc nhọn <data>.
- Dữ liệu boolean, là một trường trống. Nếu nó được khai báo trong device tree tức giá trị là true, nếu không được khai báo thì tức là false.
Đơn vị cơ bản của Device Tree là node, được lắp ráp thành cấu trúc dạng cây, chỉ có một node cha cho mỗi node ngoại trừ node gốc. Chỉ có một node gốc trong cây thiết bị và mỗi node chứa một số giá trị thuộc tính mô tả một số đặc điểm của node.
Xét vị dụ về một đoạn source trong file .dts bao gồm các thành phần sau
- Node gốc: \
- Node cho device: ví dụ uart@0xab010000
- Tên node: uart
- Địa chỉ của device: 0xab010000
- Node con của node cpus: cpu@0
Trước khi chúng ta bắt đầu tìm hiểu về các API có thể được sử dụng để lấy ra dữ liệu từ các thuốc tính trong node, ta cùng tìm hiểu về định dạng cơ bản của một node cũng như các thuộc tính thường xuyên sử dụng.
<node-name>[@<unit-address>]
node-name: là một chuỗi có chiều dài tối đa 31 kí tự tuân theo quy chuẩn của C
unit-adress: (có thể có hoặc không)
- Địa chỉ của modul phần cứng, nó phụ thuộc loại bus trong không gian chứa phần cứng đó
- Địa chỉ này phải khớp với địa chỉ đầu tiên trong trường “reg”
Ví dụ:
|
1 2 3 4 5 6 7 8 9 10 11 12 |
i2c@021a0000 { compatible = "fsl,imx6q-i2c", "fsl,imx21-i2c"; reg = <0x021a0000 0x4000>; [...] expander@20 { compatible = "microchip,mcp23017"; reg = <20>; [...] }; }; |
Trong đoạn trích DT trên, bộ điều khiển I2C (i2c@021a0000) là một thiết bị được ánh xạ vào vùng nhớ. Do đó, phần địa chỉ node tương ứng với phần đầu của vùng nhớ nó ánh xạ tới. Tuy nhiên expander là một thiết bị I2C nên phần địa chỉ của node tương ứng với địa chỉ I2C trên bus của nó.
model
Trường model là kiểu dữ liệu chuỗi kí tự, nó xác định tên nhà sản xuất cũng như số hiệu model của thiết bị.
Trường này được khuyến khích dưới dạng “manufactuer, model”
compatible
Trường compatible có thể bao gồm 1 chuỗi hoặc nhiều chuỗi.
Là chuỗi string dùng để mapping giữa device node và driver, driver và device node phải có chung 1 chuỗi compatible khi đăng kí device node.
Định địa chỉ device: reg, #address-cells và #size-cells
Mỗi device được gán vào ít nhất một node trên DT. Có một số trường thông thường mà loại thiết bị nào cũng có, đặc biệt là các thiết bị nằm trên bus mà kernel biết (như SPI, I2C, platform, MDIO…). Các trường đó là reg, #address-cells và #size-cells. Mục đích của 3 trường này là định địa chỉ của chúng trên bus:
- #size-cells: chỉ ra có bao nhiêu 32-bit cell được sử dụng để đaị diện cho kích thước địa chỉ của device.
- #address-cells: chỉ ra có bao nhiêu 32-bit cell được dùng để đại diện cho địa chỉ.
Trường reg là một danh sách các cặp giá trị thường là địa chỉ của IO register block, thường bao gồm offset và length:
reg = <adress0 size0 [address1 size1] [address2 size2] …>
mỗi cặp giá trị address và cell đại diện cho vùng địa chỉ mà device sử dụng.
Ví dụ vơi GPIO0 trên beaglebone black:
|
1 |
reg = <0x44E07000 0x1000>; |
Các device sẽ thừa kế #size-cells và #address-cells của các node cha (thông thường là các node đại diện cho bus controller).
status
Trường status giúp kernel nhận biến để load driver điều khiển thiết bị. Do đôi khi trong trạng thái “disable” để tiết kiệm năng lượng. Muốn enble thiết bị ta set giá trị cuả trường status là “okay”.
4. Đăng ký và sử dụng device node
Đăng ký device node
Trong thực tế, để đăng kí một device node. Đa số sử dụng kiểu of match table:
- Driver đăng ký bảng of match table có chứa các chuỗi compatible
- Device node có trường competible (trùng với chuỗi compatible trong driver)
Driver sử dụng DT có 2 hàm probe và remove cũng có chức năng tương tự như với hàm init và hàm exit trong các driver thông thường. Tuy nhiên cần có thêm một số điều kiện:
- Hàm probe được gọi ra khi thỏa mãn hai điều kiện: driver được load lên với câu lệnh insmod và 2 chuỗi compatible trong bảng of match table của driver và trong deivce node (có trường status = “okay”) phải trùng nhau. Hàm probe của driver được gọi và truyền vào con trỏ chứa device node
- Hàm remove được gọi ra khi unload driver
Hai hàm trên của được khai báo trong driver thông qua struct: (xét ví dụ blink_led)
|
1 2 3 4 5 6 7 8 9 |
static struct platform_driver blink_led_driver = { .probe = blink_led_driver_probe, .remove = blink_led_driver_remove, .driver = { .name = "blink_led", // tên của device .of_match_table = blink_led_of_match, }, }; |
Kết hợp với macro sau để đăng kí driver với hệ điều hành:
|
1 |
module_platform_driver(blink_led_driver |
Các API lấy thông tin từ device node
Kernel cung cấp API để lấy tài nguyên của thiết bị như vùng nhớ, ngắt, DMA chanel, clock,… từ các trường trong device node:
|
1 |
struct resource *platform_get_resource(struct platform_device *pdev, unsigned int type, unsigned int num); |
- pdev: Con trỏ đến cấu trúc platform_device đại diện cho thiết bị.
- type: Loại tài nguyên cần truy xuất, ví dụ: IORESOURCE_MEM cho tài nguyên bộ nhớ hoặc IORESOURCE_IO cho tài nguyên I/O.
- num: Số thứ tự của tài nguyên cần truy xuất, có thể là 0, 1, 2, …
Tài nguyên được trả về struct resource:
|
1 2 3 4 5 6 7 8 |
struct resource { resource_size_t start; resource_size_t end; const char *name; unsigned long flags; [...] }; |
- start: Tùy thuộc vào tài nguyên, đây có thể là địa chỉ bắt đầu của một vùng bộ nhớ, IRQ line number, số kênh DMA hoặc offset thanh ghi
- end: là điểm cuối của vùng nhớ hoặc là điểm cuối của offset thanh ghi. Trong trường hợp kênh IRQ hoặc DMA, hầu hết các giá trị bắt đầu và kết thúc đều giống nhau.
- name: Tên của tài nguyên, thường được sử dụng để mô tả mục đích của tài nguyên.
- flags: Các cờ đặc tả tài nguyên, như IORESOURCE_MEM cho tài nguyên bộ nhớ, IORESOURCE_IO cho tài nguyên I/O, và các cờ khác.
Ví dụ một đoạn code trong hàm probe với trường “reg” (đại diện cho vùng nhớ)
|
1 2 3 4 5 6 7 8 9 10 11 12 13 |
// chứa tài nguyên bộ nhớ của thiết bị struct resource *res; res = platform_get_resource(pdev, IORESOURCE_MEM, 0); if (res != NULL) { // Xử lý thông tin tài nguyên bộ nhớ pr_info("Start Address: 0x%llx\n", (unsigned long long)res->start); pr_info("End Address: 0x%llx\n", (unsigned long long)res->end); } else { pr_info("Memory resource not found.\n"); } |
Ngoài ra, kernel cũng cung cấp các API để người dùng có thể lấy dữ liệu từ các trường tự định nghĩa trong devie node
- Dữ liệu kiểu kí tự hoặc chuỗi kí tự:
|
1 2 3 4 5 6 7 |
// đọc chuỗi từ một trường int of_property_read_string(const struct device_node *np, const char *propname, const char **out_string); // đọc chuỗi từ một index cụ thể int of_property_read_string_index(const struct device_node *np, const char *propname, int index, const char **output); // đọc một mảng các chuỗi int of_property_read_string_array( const struct device_node *np, const char *propname, const char **out_strs, size_t sz); |
- Dữ liệu kiểu số nguyên:
|
1 2 3 4 5 6 7 8 9 |
// đọc số 32 byte từ một trường int of_property_read_u32(const struct device_node *np, const char *propname, u32 *out_value); // đọc số 32 byte từ 1 index trong mảng int of_property_read_u32_index( const struct device_node *np, const char *propname, u32 index, u32 *out_value); // đọc một mảng các số 32 byte int of_property_read_u32_array( const struct device_node *np, const char *propname, u32 *out_values, size_t sz); |
5. Tính ghi đè
Trong Device Tree, chúng ta có thể sửa đổi thông tin các node bằng cách thêm thông tin các trường ở bên dưới phần đã khai báo node thông qua nhãn hoặc thay đổi hoàn toàn node. Với trường hợp trùng lặp (node hoặc thuộc tính trong node), nội dung được khai báo sau trong quá trình biên dịch luôn được ưu tiên.
Ta xét ví dụ sau:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 |
bus@2100000 { /* AIPS2 */ [...] i2c1: i2c@21a0000 { [...] status = "disabled"; }; }; [...] &i2c1 { [...] status = "okay"; }; |
Chúng ta sẽ thấy rằng kết quả từ quá trình biên dịch sẽ là thuộc tính trạng thái có giá trị “okay”.
Tóm lại, các định nghĩa sau luôn ghi đè lên các định nghĩa trước đó. Để ghi đè toàn bộ nút, bạn chỉ cần tạo lại chúng giống như cách bạn làm đối với các thuộc tính.
5. Ví dụ bink led
Ta xét một ví dụ với node device tree mô tả LED như sau:
Với các trường tự định nghĩa:
led_regs = <A B C D E>;
- A: Số thứ tự của chân
- B: địa chỉ của GPIO_SETDATAOUT_OFFSET
- C: địa chỉ của GPIO_CLEARDATAOUT_OFFSET
- D: địa chỉ của GPIO_OE_OFFSET
- E: địa chỉ của GPIO_DATAOUT
led_config = <A B>;
- A: số lần nháy
- B: khoảng cách giữa 2 lần nháy, tính bằng giây
Chương trình driver:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 |
#include <linux/module.h> /* Needed by all modules */ #include <linux/kernel.h> /* Needed for KERN_INFO */ #include <linux/time.h> #include <linux/io.h> #include <linux/delay.h> #include <linux/of.h> #include <linux/fs.h> #include <linux/cdev.h> #include <linux/device.h> #include <linux/kdev_t.h> #include <linux/uaccess.h> #include <linux/platform_device.h> #include <linux/slab.h> #include <linux/mod_devicetable.h> #include <linux/of_device.h> #include <linux/platform_device.h> #include <linux/device.h> #include <linux/miscdevice.h> // đăng ký thông tin device tree node mà driver muốn diềud khiển static const struct of_device_id blink_led_of_match[] = { {.compatible = "led-example0"}, { /* Sentinel */}, }; void __iomem *base_addr; int blink_led_driver_probe(struct platform_device *pdev) { struct device_node *of_node = NULL; uint32_t led_config[2]; uint32_t reg_array[2]; uint32_t led_regs[5]; of_property_read_u32_array(of_node, "led_config", led_config, 2); of_property_read_u32_array(of_node, "reg", reg_array, 2); of_property_read_u32_array(of_node, "led_regs", led_regs, 5); // in ra các trường pr_info("led_config: %08x %08x %08x %08x\n", led_config[0], led_config[1]); pr_info("led_regs: %08x %08x %08x %08x %08x", led_regs[0], led_regs[1], led_regs[2], led_regs[3], led_regs[4]); // map địa chỉ vật lý với địa chỉ ảo trên process base_addr = ioremap(reg_array[0], reg_array[1]); //enable output mode for GPIO0_31 reg_data = readl_relaxed(base_addr + led_regs[3]); // đọc từ thanh ghi reg_data &= (~(led_regs[0])); writel_relaxed(reg_data, base_addr + led_regs[3]); //ghi vào thanh ghi //blink led n = led_config[0]; while (n > 0) { writel_relaxed(led_regs[0], base_addr + led_regs[1]); // bật led msleep(led_config[1] * HZ); writel_relaxed(led_regs[0], base_addr + led_regs[2]); // tắt led msleep(led_config[1] * HZ); n--; } return 0; } int blink_led_driver_remove(struct platform_device *pdev) { pr_info("Good bye device tree\n"); return 0; } // chứa thông tin của device và tên hàm đăng kí với hệ thống static struct platform_driver blink_led_driver = { .probe = blink_led_driver_probe, .remove = blink_led_driver_remove, .driver = { .name = "blink_led", .of_match_table = blink_led_of_match, }, }; // đăng kí driver với hệ thống module_platform_driver(blink_led_driver); MODULE_LICENSE("GPL"); MODULE_DESCRIPTION("Blink Led kernel module"); |