Linux裝置樹語法詳解

阿新 • • 發佈：2018-12-14

概念

Linux核心從3.x開始引入裝置樹的概念，用於實現驅動程式碼與裝置資訊相分離。在裝置樹出現以前，所有關於裝置的具體資訊都要寫在驅動裡，一旦外圍裝置變化，驅動程式碼就要重寫。引入了裝置樹之後，驅動程式碼只負責處理驅動的邏輯，而關於裝置的具體資訊存放到裝置樹檔案中，這樣，如果只是硬體介面資訊的變化而沒有驅動邏輯的變化，驅動開發者只需要修改裝置樹檔案資訊，不需要改寫驅動程式碼。比如在ARM Linux內，一個.dts(device tree source)檔案對應一個ARM的machine，一般放置在核心的"arch/arm/boot/dts/"目錄內，比如exynos4412參考板的板級裝置樹檔案就是"arch/arm/boot/dts/exynos4412-origen.dts"

。這個檔案可以通過$make dtbs命令編譯成二進位制的.dtb檔案供核心驅動使用。

基於同樣的軟體分層設計的思想，由於一個SoC可能對應多個machine，如果每個machine的裝置樹都寫成一個完全獨立的.dts檔案，那麼勢必相當一些.dts檔案有重複的部分，為了解決這個問題，Linux裝置樹目錄把一個SoC公用的部分或者多個machine共同的部分提煉為相應的.dtsi檔案。這樣每個.dts就只有自己差異的部分，公有的部分只需要"include"相應的.dtsi檔案, 這樣就是整個裝置樹的管理更加有序。我這裡用`Linux4.8.5原始碼自帶的dm9000網絡卡為例來分析裝置樹的使用和移植。這個網絡卡的裝置樹節點資訊在"Documentation/devicetree/bindings/net/davicom-dm9000.txt"

有詳細說明，其網絡卡驅動原始碼是"drivers/net/ethernet/davicom/dm9000.c"。

裝置樹框架

裝置樹用樹狀結構描述裝置資訊，它有以下幾種特性

每個裝置樹檔案都有一個根節點，每個裝置都是一個節點。
節點間可以巢狀，形成父子關係，這樣就可以方便的描述裝置間的關係。
每個裝置的屬性都用一組key-value對(鍵值對)來描述。
每個屬性的描述用;結束

所以，一個裝置樹的基本框架可以寫成下面這個樣子，一般來說，/表示板子，它的子節點node1表示SoC上的某個控制器，控制器中的子節點node2表示掛接在這個控制器上的裝置(們)。

/{                                  //根節點
    node1{                          //node1是節點名，是/的子節點
        key=value;                  //node1的屬性
        ...
        node2{                      //node2是node1的子節點
            key=value;              //node2的屬性
            ...
        }
    }                               //node1的描述到此為止
    node3{
        key=value;
        ...
    }
}

節點名

理論個節點名只要是長度不超過31個字元的ASCII字串即可，此外 Linux核心還約定裝置名應寫成形如<name>[@<unit_address>]的形式，其中name就是裝置名，最長可以是31個字元長度。unit_address一般是裝置地址，用來唯一標識一個節點，下面就是典型節點名的寫法

上面的節點名是firmware，節點路徑是/[email protected],這點要注意，因為根據節點名查詢節點的API的引數是不能有"@xxx"這部分的。

Linux中的裝置樹還包括幾個特殊的節點，比如chosen，chosen節點不描述一個真實裝置，而是用於firmware傳遞一些資料給OS，比如bootloader傳遞核心啟動引數給核心

引用

當我們找一個節點的時候，我們必須書寫完整的節點路徑，這樣當一個節點巢狀比較深的時候就不是很方便，所以，裝置樹允許我們用下面的形式為節點標註引用(起別名)，藉以省去冗長的路徑。這樣就可以實現類似函式呼叫的效果。編譯裝置樹的時候，相同的節點的不同屬性資訊都會被合併，相同節點的相同的屬性會被重寫，使用引用可以避免移植者四處找節點，直接在板級.dts增改即可。

下面的例子中就是直接引用了dtsi中的一個節點，並向其中新增/修改新的屬性資訊

KEY

在裝置樹中，鍵值對是描述屬性的方式，比如，Linux驅動中可以通過裝置節點中的"compatible"這個屬性查詢裝置節點。 Linux裝置樹語法中定義了一些具有規範意義的屬性，包括：compatible, address, interrupt等，這些資訊能夠在核心初始化找到節點的時候，自動解析生成相應的裝置資訊。此外，還有一些Linux核心定義好的，一類裝置通用的有預設意義的屬性，這些屬性一般不能被核心自動解析生成相應的裝置資訊，但是核心已經編寫的相應的解析提取函式，常見的有 "mac_addr"，"gpio"，"clock"，"power"。"regulator" 等等。

compatible

裝置節點中對應的節點資訊已經被核心構造成struct platform_device。驅動可以通過相應的函式從中提取資訊。compatible屬性是用來查詢節點的方法之一，另外還可以通過節點名或節點路徑查詢指定節點。dm9000驅動中就是使用下面這個函式通過裝置節點中的"compatible"屬性提取相應的資訊，所以二者的字串需要嚴格匹配。在下面的這個dm9000的例子中，我們在相應的板級dts中找到了這樣的程式碼塊：然後我們取核心原始碼中找到dm9000的網絡卡驅動，從中可以發現這個驅動是使用的裝置樹描述的裝置資訊(這不廢話麼，顯然用裝置樹好處多多)。我們可以找到它用來描述裝置資訊的結構體，可以看出，驅動中用於匹配的結構使用的compatible和裝置樹中一模一樣，否則就可能無法匹配，這裡另外的一點是struct of_device_id陣列的最後一個成員一定是空，因為相關的操作API會讀取這個陣列直到遇到一個空。

address

(幾乎)所有的裝置都需要與CPU的IO口相連，所以其IO埠資訊就需要在裝置節點節點中說明。常用的屬性有

#address-cells，用來描述子節點"reg"屬性的地址表中用來描述首地址的cell的數量，
#size-cells，用來描述子節點"reg"屬性的地址表中用來描述地址長度的cell的數量。

有了這兩個屬性，子節點中的"reg"就可以描述一塊連續的地址區域。下例中，父節點中指定了#address-cells = <2>;#size-cells = <1>，則子節點dev-bootscs0中的reg中的前兩個數表示一個地址,即MBUS_ID(0xf0, 0x01)和0x1045C，最後一個數的表示地址跨度，即是0x4

interrupts

一個計算機系統中大量裝置都是通過中斷請求CPU服務的，所以裝置節點中就需要在指定中斷號。常用的屬性有

interrupt-controller 一個空屬性用來宣告這個node接收中斷訊號，即這個node是一箇中斷控制器。
#interrupt-cells，是中斷控制器節點的屬性，用來標識這個控制器需要幾個單位做中斷描述符,用來描述子節點中"interrupts"屬性使用了父節點中的interrupts屬性的具體的哪個值。一般，如果父節點的該屬性的值是3，則子節點的interrupts一個cell的三個32bits整數值分別為:<中斷域中斷觸發方式>,如果父節點的該屬性是2，則是<中斷觸發方式>
interrupt-parent,標識此裝置節點屬於哪一個中斷控制器，如果沒有設定這個屬性，會自動依附父節點的
interrupts,一箇中斷識別符號列表，表示每一箇中斷輸出訊號

裝置樹中中斷的部分涉及的部分比較多，interrupt-controller表示這個節點是一箇中斷控制器，需要注意的是，一個SoC中可能有不止一箇中斷控制器，這就會涉及到裝置樹中斷組織的很多概念，下面是在檔案"arch/arm/boot/dts/exynos4.dtsi"中對exynos4412的中斷控制器(GIC)節點描述：

要說interrupt-parent，就得首先講講Linux裝置管理中對中斷的設計思路演變。隨著linux kernel的發展，在核心中將interrupt controller抽象成irqchip這個概念越來越流行，甚至GPIO controller也可以被看出一個interrupt controller chip，這樣，系統中至少有兩個中斷控制器了，另外，在硬體上，隨著系統複雜度加大，外設中斷資料增加，實際上系統可以需要多箇中斷控制器進行級聯，形成事實上的硬體中斷處理結構：

在這種趨勢下，核心中原本的中斷源直接到中斷號的方式已經很難繼續發展了，為了解決這些問題，linux kernel的大牛們就創造了irq domain(中斷域)這個概念。domain在核心中有很多，除了irqdomain，還有power domain，clock domain等等，所謂domain，就是領域，範圍的意思，也就是說，任何的定義出了這個範圍就沒有意義了。如上所述，系統中所有的interrupt controller會形成樹狀結構，對於每個interrupt controller都可以連線若干個外設的中斷請求（interrupt source，中斷源），interrupt controller會對連線其上的interrupt source（根據其在Interrupt controller中物理特性）進行編號（也就是HW interrupt ID了）。有了irq domain這個概念之後，這個編號僅僅限制在本interrupt controller範圍內，有了這樣的設計，CPU(Linux 核心)就可以根據級聯的規則一級一級的找到想要訪問的中斷。當然，通常我們關心的只是核心中的中斷號，具體這個中斷號是怎麼找到相應的中斷源的，我們作為程式設計師往往不需要關心，除了在寫裝置樹的時候，裝置樹就是要描述嵌入式軟體開發中涉及的所有硬體資訊，所以，裝置樹就需要準確的描述硬體上處理中斷的這種樹狀結構，如此，就有了我們的interrupt-parant這樣的概念：用來連線這樣的樹狀結構的上下級，用於表示這個中斷歸屬於哪個interrupt controller，比如，一個接在GPIO上的按鍵，它的組織形式就是：

中斷源--interrupt parent-->GPIO--interrupt parent-->GIC1--interrupt parent-->GIC2--...-->CPU

有了parant，我們就可以使用一級一級的偏移量來最終獲得當前中斷的絕對編號，這裡，可以看出，在我板子上的dm9000的的裝置節點中，它的"interrupt-parent"引用了"exynos4x12-pinctrl.dtsi"（被板級裝置樹的exynos4412.dtsi包含）中的gpx0節點：

而在gpx0節點中，指定了"#interrupt-cells = <2>;"，所以在dm9000中的屬性"interrupts = <6 4>;"表示dm9000的的中斷在作為irq parant的gpx0中的中斷偏移量，即gpx0中的屬性"interrupts"中的"<0 22 0>"，通過查閱exynos4412的手冊知道，對應的中斷號是EINT[6]。

gpio

gpio也是最常見的IO口，常用的屬性有

"gpio-controller"，用來說明該節點描述的是一個gpio控制器
"#gpio-cells"，用來描述gpio使用節點的屬性一個cell的內容，即 `屬性 = <&引用GPIO節點別名 GPIO標號工作模式>

GPIO的設定同樣採用了上述偏移量的思想，比如下面的這個led的裝置書，表示使用GPX2組的第7個引腳：

驅動自定義key

針對具體的裝置，有部分屬性很難做到通用，需要驅動自己定義好，通過核心的屬性提取解析函式進行值的獲取，比如dm9000節點中的下面這句就是自定義的節點屬性，用以表示配置EEPROM不可用。

VALUE

dts描述一個鍵的值有多種方式，當然，一個鍵也可以沒有值

字串資訊

32bit無符號整型陣列資訊

二進位制數陣列

字串雜湊表

混合形式

上述幾種的混合形式

裝置樹/驅動移植例項

裝置樹就是為驅動服務的，配置好裝置樹之後還需要配置相應的驅動才能檢測配置是否正確。比如dm9000網絡卡，就需要首先將示例資訊掛接到我們的板級裝置樹上，並根據晶片手冊和電路原理圖將相應的屬性進行配置，再配置相應的驅動。需要注意的是，dm9000的地址線一般是接在片選線上的，所以裝置樹中就應該歸屬與相應片選線節點，我這裡用的exynos4412，接在了bank1，所以是"<0x50000000 0x2 0x50000004 0x2>" 最終的配置結果是：

勾選相應的選項將dm9000的驅動編譯進核心。

make menuconfig
[*] Networking support  --->
    Networking options  --->
        <*> Packet socket
        <*>Unix domain sockets 
        [*] TCP/IP networking
        [*]   IP: kernel level autoconfiguration
Device Drivers  --->
    [*] Network device support  --->
        [*]   Ethernet driver support (NEW)  --->
            <*>   DM9000 support
File systems  --->
    [*] Network File Systems (NEW)  --->
        <*>   NFS client support
        [*]     NFS client support for NFS version 3
        [*]       NFS client support for the NFSv3 ACL protocol extension
        [*]   Root file system on NFS

執行make uImage;make dtbs,tftp下載，成功載入nfs根檔案系統並進入系統，表示網絡卡移植成功

Linux裝置樹語法詳解

概念

裝置樹框架

節點名

引用