1. 程式人生 > >轉載:Linux核心 裝置樹操作常用API

轉載:Linux核心 裝置樹操作常用API

Linux裝置樹語法詳解一文中介紹了裝置樹的語法,這裡主要介紹核心中提供的操作裝置樹的API,這些API通常都在"include/of.h"中宣告。 device_node,核心中用下面的這個結構描述裝置樹中的一個節點,後面的API都需要一個device_node物件作為引數傳入。

//include/of.h

  struct device_node {
          const char *name;
          const char *type;
          phandle phandle;
          const char *full_`name;
  
          struct  property *properties;
          struct  property *deadprops;    /* removed properties */
          struct  device_node *parent;
          struct  device_node *child;
          struct  device_node *sibling;
          struct  device_node *next;      /* next device of same type */
          struct  device_node *allnext;   /* next in list of all nodes */
          struct  proc_dir_entry *pde;    /* this node's proc directory */
          struct  kref kref;
          unsigned long _flags;
          void    *data;
  #if defined(CONFIG_SPARC)
          const char *path_component_name;
          unsigned int unique_id;
          struct of_irq_controller *irq_trans;
  #endif
  };

struct device_node ---->節點名 ---->裝置型別 ---->全路徑節點名 ---->父節點指標 ---->子節點指標

查詢節點API /**

  • of_find_compatible_node - 通過compatible屬性查詢指定節點
  • @from - 指向開始路徑的節點,如果為NULL,則從根節點開始
  • @type - device_type裝置型別,可以為NULL
  • @compat - 指向節點的compatible屬性的值(字串)的首地址
  • 成功:得到節點的首地址;失敗:NULL */ struct device_node *of_find_compatible_node(struct device_node *from,const char type, const char compat); /
  • of_find_matching_node - 通過compatible屬性查詢指定節點
  • @from - 指向開始路徑的節點,如果為NULL,則從根節點開始
  • @matches - 指向裝置ID表,注意ID表必須以NULL結束
  • 範例: const struct of_device_id mydemo_of_match[] = { { .compatible = “fs4412,mydemo”, }, {} };
  • 成功:得到節點的首地址;失敗:NULL */

struct device_node *of_find_matching_node(struct device_node *from,const struct of_device_id *matches);

/**

  • of_find_node_by_path - 通過路徑查詢指定節點
  • @path - 帶全路徑的節點名,也可以是節點的別名
  • 成功:得到節點的首地址;失敗:NULL */ struct device_node of_find_node_by_path(const char path); /
  • of_find_node_by_name - 通過節點名查詢指定節點
  • @from - 開始查詢節點,如果為NULL,則從根節點開始
  • @name- 節點名
  • 成功:得到節點的首地址;失敗:NULL */ struct device_node *of_find_node_by_name(struct device_node from,const char name); 提取通用屬性API /
  • of_find_property - 提取指定屬性的值
  • @np - 裝置節點指標
  • @name - 屬性名稱
  • @lenp - 屬性值的位元組數
  • 成功:屬性值的首地址;失敗:NULL */ struct property *of_find_property(const struct device_node *np, const char name, int lenp); /
  • of_property_count_elems_of_size - 得到屬性值中資料的數量
  • @np - 裝置節點指標
  • @propname - 屬性名稱
  • @elem_size - 每個資料的單位(位元組數)
  • 成功:屬性值的資料個數;失敗:負數,絕對值是錯誤碼 */ int of_property_count_elems_of_size(const struct device_node np,const char propname, int elem_size); /
  • of_property_read_u32_index - 得到屬性值中指定標號的32位資料值
  • @np - 裝置節點指標
  • @propname - 屬性名稱
  • @index - 屬性值中指定資料的標號
  • @out_value - 輸出引數,得到指定資料的值
  • 成功:0;失敗:負數,絕對值是錯誤碼 */ int of_property_read_u32_index(const struct device_node *np, const char propname, u32 index, u32 out_value); /
  • of_property_read_string - 提取字串(屬性值)
  • @np - 裝置節點指標
  • @propname - 屬性名稱
  • @out_string - 輸出引數,指向字串(屬性值)
  • 成功:0;失敗:負數,絕對值是錯誤碼 */ int of_property_read_string(struct device_node *np, const char *propname, const char out_string); 提取addr屬性API /
  • of_n_addr_cells - 提取預設屬性“#address-cells”的值
  • @np - 裝置節點指標
  • 成功:地址的數量;失敗:負數,絕對值是錯誤碼 / int of_n_addr_cells(struct device_node np); /
  • of_n_size_cells - 提取預設屬性“#size-cells”的值
  • @np - 裝置節點指標
  • 成功:地址長度的數量;失敗:負數,絕對值是錯誤碼 / int of_n_size_cells(struct device_node np); /
  • of_get_address - 提取I/O口地址
  • @np - 裝置節點指標
  • @index - 地址的標號
  • @size - 輸出引數,I/O口地址的長度
  • @flags - 輸出引數,型別(IORESOURCE_IO、IORESOURCE_MEM)
  • 成功:I/O口地址的首地址;失敗:NULL */ __be32 *of_get_address(struct device_node *dev, int index, u64 size, unsigned int flags); /
  • of_translate_address - 從裝置樹中提取I/O口地址轉換成實體地址
  • @np - 裝置節點指標
  • @in_addr - 裝置樹提取的I/O地址
  • 成功:實體地址;失敗:OF_BAD_ADDR */ u64 of_translate_address(struct device_node dev, const __be32 in_addr); /
  • of_iomap - 提取I/O口地址並對映成虛擬地址
  • @np - 裝置節點指標
  • @index - I/O地址的標號
  • 成功:對映好虛擬地址;失敗:NULL */ void __iomem of_iomap(struct device_node np, int index); /
  • 功能:提取I/O口地址並申請I/O資源及對映成虛擬地址
  • @np - 裝置節點指標
  • @index - I/O地址的標號
  • @name - 裝置名,申請I/O地址時使用
  • 成功:對映好虛擬地址;失敗:NULL */ void __iomem *of_io_request_and_map(struct device_node np, int index, const char name); 提取resource屬性API /
  • of_address_to_resource - 從裝置樹中提取資源resource(I/O地址)
  • @np - 裝置節點指標
  • @index - I/O地址資源的標號
  • @r - 輸出引數,指向資源resource(I/O地址)
  • 成功:0;失敗:負數,絕對值是錯誤碼 */ int of_address_to_resource(struct device_node dev, int index, struct resource r); 提取GPIO屬性API /
  • include/of_gpio.h
  • of_get_named_gpio - 從裝置樹中提取gpio口
  • @np - 裝置節點指標
  • @propname - 屬性名
  • @index - gpio口引腳標號
  • 成功:得到GPIO口編號;失敗:負數,絕對值是錯誤碼 */ int of_get_named_gpio(struct device_node np, const char propname, int index); 提取irq屬性API /
  • of_irq_count從裝置樹中提取中斷的數量
  • @np - 裝置節點指標
  • 成功:大於等於0,實際中斷數量,0則表示沒有中斷 / int of_irq_count(struct device_node dev); /
  • of_irq_get - 從裝置樹中提取中斷號
  • @np - 裝置節點指標
  • @index - 要提取的中斷號的標號
  • 成功:中斷號;失敗:負數,其絕對值是錯誤碼 int of_irq_get(struct device_node dev, int index); 提取其他屬性API /*
  • of_get_mac_address - 從裝置樹中提取MAC地址
  • @np - 裝置節點指標
  • @成功:MAC(6位元組)的首地址;失敗:NULL */ void *of_get_mac_address(struct device_node *np);