有上一篇文章,我們了解了dts的背景知識和相關基礎,這次我們對應實際設備進行一下相關分析。
DTS設備樹的匹配過程
一個dts文件確定一個項目,多個項目可以包含同一個dtsi文件。找到該項目對應的dts文件即找到了該設備樹的根節點。
kernel\arch\arm\boot\dts\qcom\sdm630-mtp.dts
- /* Copyright (c) 2017, The Linux Foundation. All rights reserved.
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License version 2 and
- * only version 2 as published by the Free Software Foundation.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- */
- /dts-v1/;
- #include "sdm630.dtsi"
- #include "sdm630-mtp.dtsi"
- //#include "sdm660-external-codec.dtsi"
- #include "sdm660-internal-codec.dtsi"
- #include "synaptics-dsx-i2c.dtsi"
- / {
- model = "Qualcomm Technologies, Inc. SDM 630 PM660 + PM660L MTP";
- compatible = "qcom,sdm630-mtp", "qcom,sdm630", "qcom,mtp";
- qcom,board-id = <8 0>;
- qcom,pmic-id = <0x0001001b 0x0101011a 0x0 0x0>,
- <0x0001001b 0x0201011a 0x0 0x0>;
- };
- &tavil_snd {
- qcom,msm-mbhc-moist-cfg = <0>, <0>, <3>;
- };
當然devicetree的根節點也是需要和板子進行匹配的,這個匹配信息存放在sbl(second boot loader)中,對應dts文件中描述的board-id(上面代碼中的qcom,board-id屬性),通過共享內存傳遞給bootloader,由bootloader將此board-id匹配dts文件(devicetree的根節點文件),將由dtc編譯后的dts文件(dtb文件)加載到內存,然后在kernel中展開dts樹,並且掛載dts樹上的所有設備。
(ps:cat /proc/cmdline 查看cmdline)
Dts中相關符號的含義
/ 根節點
@ 如果設備有地址,則由此符號指定
& 引用節點
: 冒號前的label是為了方便引用給節點起的別名,此label一般使用為&label
, 屬性名稱中可以包含逗號。如compatible屬性的名字 組成方式為"[manufacturer], [model]",加入廠商名是為了避免重名。自定義屬性名中通常也要有廠商名,並以逗號分隔。
# #並不表示注釋。如 #address-cells ,#size-cells 用來決定reg屬性的格式。
空屬性並不一定表示沒有賦值。如 interrupt-controller 一個空屬性用來聲明這個node接收中斷信號
數據類型
“” 引號中的為字符串,字符串數組:”strint1”,”string2”,”string3”
< > 尖括號中的為32位整形數字,整形數組<12 3 4>
[ ] 方括號中的為32位十六進制數,十六機制數據[0x11 0x12 0x13] 其中0x可省略
構成節點名的有效字符:
0-9 | a-z | A-Z | , | . | _ | + | - |
構成屬性名的有效字符:
0-9 | a-z | A-Z | , | . | _ | + | ? | # |
DTS中幾個難理解的屬性的解釋
a. 地址
設備的地址特性根據一下幾個屬性來控制:
- reg
- #address-cells
- #size-cells
reg意為region,區域。格式為:
- reg = <address1length1 [address2 length2] [address3 length3]>;
父類的address-cells和size-cells決定了子類的相關屬性要包含多少個cell,如果子節點有特殊需求的話,可以自己再定義,這樣就可以擺脫父節點的控制。
address-cells決定了address1/2/3包含幾個cell,size-cells決定了length1/2/3包含了幾個cell。本地模塊例如:
- spi@10115000{
- compatible = "arm,pl022";
- reg = <0x10115000 0x1000 >;
- };
位於0x10115000的SPI設備申請地址空間,起始地址為0x10115000,長度為0x1000,即屬於這個SPI設備的地址范圍是0x10115000~0x10116000。
實際應用中,有另外一種情況,就是通過外部芯片片選激活模塊。例如,掛載在外部總線上,需要通過片選線工作的一些模塊:
- external-bus{
- #address-cells = <2>
- #size-cells = <1>;
- ethernet@0,0 {
- compatible = "smc,smc91c111";
- reg = <0 0 0x1000>;
- };
- i2c@1,0 {
- compatible ="acme,a1234-i2c-bus";
- #address-cells = <1>;
- #size-cells = <0>;
- reg = <1 0 0x1000>;
- rtc@58 {
- compatible ="maxim,ds1338";
- reg = <58>;
- };
- };
- flash@2,0 {
- compatible ="samsung,k8f1315ebm", "cfi-flash";
- reg = <2 0 0x4000000>;
- };
- };
external-bus使用兩個cell來描述地址,一個是片選序號,另一個是片選序號上的偏移量。而地址空間長度依然用一個cell來描述。所以以上的子設備們都需要3個cell來描述地址空間屬性——片選、偏移量、地址長度。在上個例子中,有一個例外,就是i2c控制器模塊下的rtc模塊。因為I2C設備只是被分配在一個地址上,不需要其他任何空間,所以只需要一個address的cell就可以描述完整,不需要size-cells。
當需要描述的設備不是本地設備時,就需要描述一個從設備地址空間到CPU地址空間的映射關系,這里就需要用到ranges屬性。還是以上邊的external-bus舉例:
- #address-cells= <1>;
- #size-cells= <1>;
- ...
- external-bus{
- #address-cells = <2>
- #size-cells = <1>;
- ranges = <0 0 0x10100000 0x10000 // Chipselect 1,Ethernet
- 1 0 0x10160000 0x10000 // Chipselect 2, i2c controller
- 2 0 0x30000000 0x1000000>; // Chipselect 3, NOR Flash
- };
ranges屬性為一個地址轉換表。表中的每一行都包含了子地址、父地址、在自地址空間內的區域大小。他們的大小(包含的cell)分別由子節點的address-cells的值、父節點的address-cells的值和子節點的size-cells來決定。以第一行為例:
· 0 0 兩個cell,由子節點external-bus的address-cells=<2>決定;
· 0x10100000 一個cell,由父節點的address-cells=<1>決定;
· 0x10000 一個cell,由子節點external-bus的size-cells=<1>決定。
最終第一行說明的意思就是:片選0,偏移0(選中了網卡),被映射到CPU地址空間的0x10100000~0x10110000中,地址長度為0x10000。
b. 中斷
描述中斷連接需要四個屬性:
1. interrupt-controller 一個空屬性用來聲明這個node接收中斷信號;
2. #interrupt-cells 這是中斷控制器節點的屬性,用來標識這個控制器需要幾個單位做中斷描述符;
3. interrupt-parent 標識此設備節點屬於哪一個中斷控制器,如果沒有設置這個屬性,會自動依附父節點的;
4. interrupts 一個中斷標識符列表,表示每一個中斷輸出信號。
如果有兩個,第一個是中斷號,第二個是中斷類型,如高電平、低電平、邊緣觸發等觸發特性。對於給定的中斷控制器,應該仔細閱讀相關文檔來確定其中斷標識該如何解析。一般如下:
二個cell的情況
第一個值: 該中斷位於他的中斷控制器的索引;
第二個值:觸發的type
固定的取值如下:
1 = low-to-high edge triggered
2 = high-to-low edge triggered
4 = active high level-sensitive
8 = active low level-sensitive
三個cell的情況
第一個值:中斷號
第二個值:觸發的類型
第三個值:優先級,0級是最高的,7級是最低的;其中0級的中斷系統當做 FIQ處理。
c. 其他
除了以上規則外,也可以自己加一些自定義的屬性和子節點,但是一定要符合以下的幾個規則:
1. 新的設備屬性一定要以廠家名字做前綴,這樣就可以避免他們會和當前的標准屬性存在命名沖突問題;
2. 新加的屬性具體含義以及子節點必須加以文檔描述,這樣設備驅動開發者就知道怎么解釋這些數據了。描述文檔中必須特別說明compatible的value的意義,應該有什么屬性,可以有哪個(些)子節點,以及這代表了什么設備。每個獨立的compatible都應該由單獨的解釋。
新添加的這些要發送到devicetree-discuss@lists.ozlabs.org郵件列表中進行review,並且檢查是否會在將來引發其他的問題。
DTS設備樹描述文件中什么代表總線,什么代表設備
一個含有compatible屬性的節點就是一個設備。包含一組設備節點的父節點即為總線。
由DTS到device_register的過程
dts描述的設備樹是如何通過register_device進行設備掛載的呢?我們來進行一下代碼分析
在arch/arm/mach-******/******.c找到DT_MACHINE_START 和 MACHINE_END 宏, 如下:
- DT_MACHINE_START(******_DT, "************* SoC (Flattened DeviceTree)")
- .atag_offset = 0x100,
- .dt_compat =******_dt_compat, // 匹配dts
- .map_io =******_map_io, // 板級地址內存映射, linux mmu
- .init_irq =irqchip_init, // 板級中斷初始化.
- .init_time =******_timer_and_clk_init, // 板級時鍾初始化,如ahb,apb等
- .init_machine = ******_dt_init, // 這里是解析dts文件入口.
- .restart =******_restart, // 重啟, 看門狗寄存器相關可以在這里設置
- MACHINE_END
其中.dt_compat = ******_dt_compat 這個結構體是匹配是哪個dts文件, 如:
- static const charchar * constconst ******_dt_compat[] = {
- "******,******-soc",
- NULL
- };
這個"******,******-soc" 字符串可以在我們的dts的根節點下可以找到.
好了, 我們來看看init_machine = ******_dt_init 這個回調函數.
1. arch/arm/mach-******/******.c : void __init ******_dt_init(void)
******_dt_init(void) --> of_platform_populate(NULL,of_default_bus_match_table, NULL, NULL);
of_default_bus_match_table 這個是structof_device_id的全局變量.
- const struct of_device_id of_default_bus_match_table[] = {
- { .compatible = "simple-bus",},
- #ifdef CONFIG_ARM_AMBA
- { .compatible = "arm,amba-bus",},
- #endif /* CONFIG_ARM_AMBA */
- {} /* Empty terminated list */
- };
我們設計dts時, 把一些需要指定寄存器基地址的設備放到以compatible = "simple-bus"為匹配項的設備節點下. 下面會有介紹為什么.
2. drivers/of/platform.c : int of_platform_populate(...)
of_platform_populate(...) --> of_platform_bus_create(...)
// 在這之前, 會有of_get_property(bus,"compatible", NULL)
// 檢查是否有compatible, 如果沒有, 返回, 繼續下一個, 也就是說沒有compatible, 這個設備不會被注冊
- for_each_child_of_node(root, child) {
- printk("[%s %s %d]child->name = %s, child->full_name = %s\n", __FILE__, __func__,__LINE__, child->name, child->full_name);
- rc = of_platform_bus_create(child,matches, lookup, parent, true);
- if (rc)
- break;
- }
論詢dts根節點下的子設備, 每個子設備都要of_platform_bus_create(...);
全部完成后, 通過 of_node_put(root);釋放根節點, 因為已經處理完畢;
3. drivers/of/platform.c : of_platform_bus_create(bus, ...)
- dev = of_platform_device_create_pdata(bus, bus_id,platform_data, parent); // 我們跳到 3-1步去運行
- if (!dev || !of_match_node(matches, bus)) // 就是匹配
- // dt_compat = ******_dt_compat, 也就是 compatible = "simple-bus",
- // 如果匹配成功, 以本節點為父節點, 繼續輪詢本節點下的所有子節點
- return 0;
- for_each_child_of_node(bus, child) {
- pr_debug(" create child:%s\n", child->full_name);
- rc = of_platform_bus_create(child,matches, lookup, &dev->dev, strict); // dev->dev以本節點為父節點, 我們跳到 3-2-1步去運行
- if (rc) {
- of_node_put(child);
- break;
- }
- }
3-1. drivers/of/platform.c : of_platform_device_create_pdata(...)
- if (!of_device_is_available(np)) // 查看節點是否有效, 如果節點有'status'屬性, 必須是okay或者是ok, 才是有效, 沒有'status'屬性, 也有效
- return NULL;
- dev = of_device_alloc(np, bus_id, parent); // alloc設備, 設備初始化. 返回dev, 所有的設備都可認為是platform_device, 跳到3-1-1看看函數做了什么事情
- if (!dev)
- return NULL;
- #if defined(CONFIG_MICROBLAZE)
- dev->archdata.dma_mask = 0xffffffffUL;
- #endif
- dev->dev.coherent_dma_mask =DMA_BIT_MASK(32); // dev->dev 是 struct device. 繼續初始化
- dev->dev.bus =&platform_bus_type; //
- dev->dev.platform_data =platform_data;
- printk("[%s %s %d] of_device_add(device register)np->name = %s\n", __FILE__, __func__, __LINE__, np->name);
- if (of_device_add(dev) != 0){ // 注冊device,of_device_add(...) --> device_add(...) // This is part 2 ofdevice_register()
- platform_device_put(dev);
- return NULL;
- }
3-1-1. drivers/of/platform.c : of_device_alloc(...)
1) alloc platform_device *dev
2) 如果有reg和interrupts的相關屬性, 運行of_address_to_resource 和of_irq_to_resource_table, 加入到dev->resource
- dev->num_resources = num_reg +num_irq;
- dev->resource = res;
- for (i = 0; i < num_reg; i++, res++) {
- rc = of_address_to_resource(np,i, res);
- /*printk("[%s %s %d] res->name = %s, res->start = 0x%X, res->end =0x%X\n", __FILE__, __func__, __LINE__, res->name, res->start,res->end); */
- WARN_ON(rc);
- }
- WARN_ON(of_irq_to_resource_table(np, res,num_irq) != num_irq);
3) dev->dev.of_node = of_node_get(np);
// 這個node屬性里有compatible屬性, 這個屬性從dts來, 后續driver匹配device時, 就是通過這一屬性進匹配
// 我們可以通過添加下面一句話來查看compatible.
// printk("[%s %s %d]bus->name = %s, of_get_property(...) = %s\n", __FILE__, __func__,__LINE__, np->name, (char*)of_get_property(np, "compatible",NULL));
// node 再給dev, 后續給驅動注冊使用.
4) 運行 of_device_make_bus_id 設定device的名字, 如: soc.2 或 ac000000.serial 等
3-2. drivers/of/platform.c :
以 compatible = "simple-bus"的節點的子節點都會以這個節點作為父節點在這步注冊設備.
至此從dts文件的解析到最終調用of_device_add進行設備注冊的過程就比較清晰了。
查看掛載上的所有設備
cd /sys/devices/ 查看注冊成功的設備 對應devicetree中的設備描述節點