设备树常用 OF 操作函数说明一

一. 简介

设备树描述了设备的详细信息，这些信息包括数字类型的、字符串类型的、数组类型的，我们在编写驱动时，需要获取到这些信息。

驱动如何获取到设备树中节点信息？

Linux 内核给我们提供了一系列的函数，来获取设备树中的节点或者属性信息，这一系列的函数都有一个统一的前缀 “ of_ ”，所以在很多资 料里面也被叫做 OF 函数。

二.  设备树常用 OF操作函数

在驱动开发时，需要获取设备树的设备节点信息，例如，设备树使用 reg 属性描述了某个外设的寄存器地址为 0X02005482，长度为 0X400，我们在编写驱动时需要获取到 reg 属性的这两个信息，然后初始化外设。

Linux 内核给我们提供了 一系列的函数来获取设备树中的节点或者属性信息，这些 OF 函数原型都定义在 include/linux/of.h 文件中。 下面来了解一下这些 OF 函数。

1. 查找节点的 OF 函数

设备都是以节点的形式“挂”到设备树上的，因此要想获取这个设备的其他属性信息，必须先获取到这个设备的节点。

Linux 内核使用 device_node 结构体来描述一个节点，此结构体定 义在文件 include/linux/of.h 中，定义如下：

struct device_node {
	const char *name;
	const char *type;
	phandle phandle;
	const char *full_name;
	struct fwnode_handle fwnode;

	struct	property *properties;
	struct	property *deadprops;	/* removed properties */
	struct	device_node *parent;
	struct	device_node *child;
	struct	device_node *sibling;
	struct	kobject kobj;
	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
};

与查找节点有关的 OF 函数有 5 个，我们依次来看一下。

(1)  of_find_node_by_name 函数

of_find_node_by_name 函数通过节点名字查找指定的节点，函数原型如下：

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

函数参数和返回值含义如下：

from ：开始查找的节点，如果为 NULL， 表示从根节点开始查找整个设备树。

name ：要查找的节点名字。

返回值： 找到的节点，如果为 NULL 表示查找失败。

(2)  of_find_node_by_type 函数

of_find_node_by_type 函数通过 device_type 属性查找指定的节点，函数原型如下：

 struct device_node *of_find_node_by_type(struct device_node *from,
	const char *type);

函数参数和返回值含义如下：

from ：开始查找的节点，如果为 NULL 表示从根节点开始查找整个设备树。

type ：要查找的节点对应的 type 字符串，也就是 device_type 属性值。

返回值： 找到的节点，如果为 NULL 表示查找失败。

(3) of_find_compatible_node 函数

of_find_compatible_node 函数根据 device_type 和 compatible 这两个属性查找指定的节点， 函数原型如下：

struct device_node *of_find_compatible_node(struct device_node *from,
const char *type, 
const char *compatible)

(4) of_find_matching_node_and_match 函数

of_find_matching_node_and_match 函数通过 of_device_id 匹配表来查找指定的节点，函数原

型如下：

struct device_node *of_find_matching_node_and_match(struct device_node *from,
 const struct of_device_id *matches,
 const struct of_device_id **match)

函数参数和返回值含义如下：

from ：开始查找的节点，如果为 NULL 表示从根节点开始查找整个设备树。

matches ： of_device_id 匹配表，也就是在此匹配表里面查找节点。

match ： 找到的匹配的 of_device_id 。

返回值： 找到的节点，如果为 NULL 表示查找失败

(5) of_find_node_by_path 函数

of_find_node_by_path 函数通过路径来查找指定的节点，函数原型如下：

inline struct device_node *of_find_node_by_path(const char *path)

函数参数和返回值含义如下：

path ：带有全路径的节点名，可以使用节点的别名，比如“ /backlight ”就是 backlight 这个

节点的全路径。

返回值： 找到的节点，如果为 NULL 表示查找失败

2. 查找父/子节点的 OF 函数

Linux 内核提供了几个查找节点对应的父节点或子节点的 OF 函数，我们依次来看一下。

(1) of_get_parent 函数

of_get_parent 函数用于获取指定节点的父节点 ( 如果有父节点的话 ) ，函数原型如下：

struct device_node *of_get_parent(const struct device_node *node)

函数参数和返回值含义如下：

node ：要查找的父节点的节点。

返回值： 找到的父节点。

(2) of_get_next_child 函数

of_get_next_child 函数用迭代的方式查找子节点，函数原型如下：

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

函数参数和返回值含义如下：

node ：父节点。

prev ：前一个子节点，也就是从哪一个子节点开始迭代的查找下一个子节点。可以设置为

NULL ，表示从第一个子节点开始。

返回值： 找到的下一个子节点。

下一篇文章继续学习Linux内核提供的 设备树常用 OF操作函数。