设备树相关的函数和简单教程

ForestShy

于 2023-11-10 14:01:36 发布

阅读量372

点赞数 5

分类专栏： Linux驱动 #学习成长文章标签：驱动开发 linux 笔记

本文链接：https://blog.csdn.net/qq_59278733/article/details/134331497

版权

#学习成长同时被 2 个专栏收录

14 篇文章 0 订阅

订阅专栏

Linux驱动

10 篇文章 0 订阅

订阅专栏

内核中设备树相关的头文件介绍

设备树的处理过程是：dtb - > device_node - > platform_device。

1. 处理 DTB

of_fdt.h                   //dtb文件的相关操作函数，我们一般用不到
//因为dtb文件在内核中已经被转换为device_node树（它更易于使用）

2. 处理 device_node

of.h                       // 提供设备树的一般处理函数，
// 比如 of_property_read_u32(读取某个属性的u32值)，
// of_get_child_count(获取某个device_node的子节点树)

of_address.h                // 地址相关的函数，
// 比如 of_get_address(获取reg属性中的addr,size值)
// of_match_device(从matches数组中取出与当前设备最匹配的一项)

of_dma.h                    // 设备树中DMA相关属性的函数
of_gpio.h                   // GPIO相关的函数
of_graph.h                  // GPU相关驱动中用到的函数，从设备树中获取GPU信息
of_iommu.h                  // 很少用到
of_irq.h                    // 中断相关的函数
of_mdio.h                   // MDIO(Ethernet PHY) API
of_net.h                    // OF helpers for network devices.
of_pci.h                    // PCI相关函数
of_pdt.h                    // 很少用到
of_reserver_mem.h           // reserved_mem 的相关函数

3. 处理 platform_device

of_platform.h         // 把 device_node 转换为 platform_device 时用到的函数，
                      // 比如 of_device_alloc(根据 device_node 分配设置 platform_device ),
                      // of_find_device_by_node(根据 device_node 查找到 platform_device),
                      // of_platform_bus_probe(处理 device_node 及它的子节点)

of_device.h           // 设备相关的函数，比如 of_match_device

platform_device 相关的函数

of_platform.h 中声明了很多函数，但是作为驱动开发者，我们只使用其中的 1、2 个。其他的都是给内核自己使用的，内核使用它们来处理设备树，转换得到 platform_device。

1. of_find_device_by_node

函数原型是：

extern struct platform_device *of_find_device_by_node(struct device_node *np);

设备树中的每一个节点，在内核里的都有一个 device_node；你可以使用 device_node 去找到对应的 platform_device。

2. platform_get_resource

这个函数跟设备树没什么关系，但是设备树的节点被转换为 platform_device 后，设备树中的 reg 属性、interrupts 属性也会被转换为“resource”。

这时，可以使用这个函数取出这些资源。
函数原型为：

/**
 * platform_get_resource - get a resource for a device
 * @dev : platform device
 * @type : resource type   // 取哪类资源？IORESOURCE_MEM、IORESOURCE_REG、IORESOURCE_IRQ等
 * @num : resource index   // 这类资源中的哪一个？
 * /
struct resource *platform_get_resource(struct platform_device *dev,unsigned int type,
                                                unsigned int num);

对于设备树节点中的 reg 属性，它对应 IORESOURCE_MEM 类型的资源；
对于设备树节点中的 interrupts 属性，它对应 IORESOURCE_IRQ 类型的资源。

有些节点不会生成 platform_device，怎么访问他们

内核会把 deb 文件解析出一系列的 device_node 结构体，我们可以直接访问这些 device_node。
内核源码 incldue/linux/of.h 中声明了 device_node 和属性 property 的操作函数，如下：
在这里插入图片描述

1. 找到节点

of_find_node_by_path
根据路径找到节点，比如 “/” 就对应根节点，“/memory” 对应 memory 节点。
函数原型：

struct inline struct device_node *of_find_node_by_path(const char *path);

of_find_node_by_name
根据名字找到节点，节点如果定义了 name 属性，那我们可以根据名字找到它。
函数原型：

extern struct device_node *of_find_node_by_name(
                           struct device_node *from,const char *name);

参数 from 表示从哪一个节点开始寻找，传入 NULL 表示从根节点开始寻找。

但是在设备树的官方规范中不建议使用 “name” 属性，所以这个函数也不建议使用。
3. of_find_node_by_type
根据类型找到节点，节点如果定义了 device_type 属性，那么我们可以根据类型找到它。
函数原型：

extern struct device_node *of_find_by_type(struct device_node *from
                                                  ,const char *type);

参数 from 表示从哪一个节点开始寻找，传入 NULL 表示从根节点开始寻找。

但是在设备树的官方规范中不建议使用 “device_type ” 属性，所以这函数也不建议使用。
4. of_find_compatible_node
根据 compatible 找到节点，节点如果定义了 compatible 属性，那么我们可以根据 compatible 属性找到它。
函数原型：

extern struct device_node *of_find_compatible_node(
								struct device_node *from,const char *type
							                    	,const char *compat);

参数 from 表示从哪个节点开始寻找，传入 NULL 表示根节点开始。
参数 compat 是一个字符串，用来指定 compatible 属性的值；
参数 type 是一个字符串，用来指定 device_type 属性的值，可以传入 NULL。

of_find_node_by_phandle
根据 phandle 找到节点。dts 文件被编译成 dtb 文件时，每一个节点都有一个数字 ID，这些数字 ID 彼此不同。可以使用数字 ID 来找到 device_node。这些数字 ID 就是 phandle。
函数原型：

extern struct device_node *of_find_node_by_phandle(phandle handle);

of_get_parent
找到 device_node 的父节点。
函数原型：

extern struct device_node *of_get_parent(const struct device_node *node);

参数 from 表示从哪一个节点开始寻找，传入 NULL 表示从根节点开始寻找。

of_get_next_parent
这个函数名比较奇怪，怎么可能有 “next parent”？
它实际上也是找到 device_node 的父节点，跟 of_get_parent 的返回结果是一样的。
差别在于它调用下列函数，把 node 节点的引用计数减少了 1. 这意味着调用 of_get_next_parent 之后，你不再需要调用 of_node_put 释放 node 节点。

of_node_put(node);

函数原型：

extern struct device_node *of_get_next_parent(struct device_node *node);

of_get_next_child
取出下一个子节点。
函数原型：

extern struct device_node *of_get_next_child(const struct device_node *node,
                                                 struct device_node *prev);

参数 node 表示父节点；
prev 表示上一个子节点，设为 NULL 表示想找第 1 个子节点。
不断调用 of_get_next_child 时，不断更新 pre 参数，就可以得到所有的子节点。

of_get_next_available_child
取出下一个 “可用” 的子节点，有些节点的 status 是 “disabled”，那就会跳过这些节点。
函数原型：

struct device_node *of_get_next_available_child(const struct device_node *node,
                                                  struct device_node *prev);

of_get_child_by_name
根据名字取出子节点。
函数原型：

extern struct device_node *of_get_child_by_name(const struct device_node *node,
                                                         const char *name);

参数 node 表示父节点；
name 表示子节点的名字。

2. 找到属性 – of_find_property

内核源码 include/linux/of.h 中声明了 device_node 的操作函数，当然也包括属性的操作函数：of_find_property
找到节点中的属性。
函数原型：

extern struct property *of_find_property(const struct device_node *np,
                                          const char *name,
                                          int *lenp);

参数 np 表示节点，我们要在这个节点中找到名为 name 的属性。
lenp 用来保存这个属性的长度，即它的值的长度。
在设备树中，节点大概是这样：

xxx_node {
	xxx_pp_name = "hello";
};

上述节点中，“xxx_pp_name” 就是属性的名字，值的长度是 6。

3. 获取属性的值

of_get_property
根据名字找到节点的属性，并且返回它的值。
函数原型：

/* 
 * Find a property with a given name for a given node
 * and return the value.
 * /
const void *of_get_property(const struct device_node *np,const char *name,int *lenp);

参数 np 表示节点，我们要在这个节点中找到名为 name 的属性，然后返回它的值。
lenp 用来保存这个属性的长度，即它的值的长度。

of_property_count_elems_of_size
根据名字找到节点的属性，确定它的值有多少个元素（elem）。
函数原型：

* of_property_count_elems_of_size - Count the number of elements in a property
*
* @np: device node from which the property value is to be read.
* @property: name of the property to be searched.
* @elem_size: size of the individual element
*
* Search for a property in a device node and count the number of elements of size 
* elem_size in it. Returns number of elements on sucess, -EINVAL if the property does not * exist or its length does not match a multiple of elem_size and -ENODATA if the property * does not have a value.
*/
int of_property_count_elems_of_size(const struct device_node *np,
                                    const char *property,
                                    int elem_size);

参数 np 表示节点，我们要在这个节点中找到名为 propname 的属性，然后返回下列结果：

return prop->lenth / elem_size;

在设备树中，节点大概是这样：

xxx_node {
	xxx_pp_name = <0x50000000 1024> <0x60000000 2048>;
};

调用 of_property_count_elems_of_size(np,"xxx_pp_name",8) 时，返回值是 2；
调用 of_property_count_elems_of_size(np,"xxx_pp_name",4) 时，返回值是 4；

读整数 u32/u64
函数原型为：

static inline int of_property_read_u32(const struct device_node *np,
                                        const char *propname,
                                        u32 *out_value);

extern int of_property_read_u64(const struct device_node *np,
                                const char *propname,
                                u64 *out_value);

在设备树中，节点大概是这样：

xxx_node {
	name1 = <0x50000000>;
	name2 = <0x50000000 0x60000000>;
};

调用 of_property_read_u32(np, "name1", &val) 时， val 将得到值 0x50000000
调用 of_property_read_u64(np, "name2", &val) 时， val 将得到值 0x6000000050000000 。

读某个整数 u32/u64
函数原型为：

extern int of_property_read_u32_index(const struct device_node *np,
                                        const char *propname,
                                        u32 index,u32 *out_value);

在设备树中，节点大概是这样：

xxx_node {
	name2 = <0x50000000 0x60000000>;
};

调用 of_property_read_u32(np, "name2", &val) 时， val 将得到值 0x60000000。

读数组
函数原型为：

int of_property_read_variable_u8_array(const struct device_node *np,
										cons t char *propname,
										u8 *out_values,
										size_t sz_min, size_t sz_max);

int of_property_read_variable_u16_array(const struct device_node *np,
										const char *propname,
										u16 *out_values,
										size_t sz_min, size_t sz_max);

int of_property_read_variable_u32_array(const str uct device_node *np,
										const char *propname,
										u32 *out_values,
										size_t sz_min, size_t sz_max);

int of_property_read_variable_u64_array(const struct device_node *np,
										const char *propname,
										u64 *out_values,
										size_t sz_min, size_t sz_max);

在设备树中，节点大概是这样：

xxx_node {
	name2 = <0x50000012 0x60000034>;
};

上述例子中属性 name2 的值，长度为 8.

调用 of_property_read_variable_u8_array(np, “name2”, out_values, 1, 10) 时，out_values 中将会保存这 8 个字节：0x12,0x00,0x00,0x50,0x34,0x00,0x00,0x60。
调用 of_property_read_variable_u16_array(np, “name2”, out_values, 1, 10) 时，out_values 中将会保存这 4 个 16 位个字节：0x0012,0x5000,0x0034,0x6000。
总之，这些函数要么能取到全部的数值，要么一个数值都取不到；
如果值的长度在 sz_min 和 sz_max 之间，就返回全部的数值；
否则一个数值都不返回。

读字符串
函数原型为：

int of_property_read_string(const struct device_node *np,
                            const char *propname,
                            const char **out_string);