RK3568驱动指南｜第七期-设备树-第66章of操作函数实验：获取设备树节点

瑞芯微RK3568芯片是一款定位中高端的通用型SOC，采用22nm制程工艺，搭载一颗四核Cortex-A55处理器和Mali G52 2EE 图形处理器。RK3568 支持4K 解码和 1080P 编码，支持SATA/PCIE/USB3.0 外围接口。RK3568内置独立NPU，可用于轻量级人工智能应用。RK3568 支持安卓 11 和 linux 系统，主要面向物联网网关、NVR 存储、工控平板、工业检测、工控盒、卡拉 OK、云终端、车载中控等行业。

​
【公众号】迅为电子

【粉丝群】824412014（加群获取驱动文档+例程）

【视频观看】嵌入式学习之Linux驱动（第七期_设备树_全新升级）_基于RK3568

【购买链接】迅为RK3568开发板瑞芯微Linux安卓鸿蒙ARM核心板人工智能AI主板

---

第66章of操作函数实验：获取设备树节点

在上一章节的学习中，我们学习了设备树下platform_device和platform_driver匹配，现在也只是让他们匹配在了一起，但这样显然是不够的，为了完成一些和硬件相关的需求，我们还需要获取到在设备树中编写的一些属性，那驱动是如何获取设备树中的属性呢，让我们一起进入后续章节的学习吧。

66.1 of操作：获取设备树节点

在Linux内核源码中提供了一系列的of操作函数来帮助我们获取到设备树中编写的属性，

在内核中以device_node结构体来对设备树进行描述，所以of操作函数实际上就是获取device_node结构体，所以接下来我们学习的of操作函数的返回值都是device_node结构体，关于device_node结构体的具体内容已经在63.1小节讲解过了，这里不再进行赘述。

66.1.1 of_find_node_by_name函数

of_find_node_by_name 是Linux内核中用于通过节点名称查找设备树节点的函数。下面是对of_find_node_by_name 函数的详细介绍：

函数原型：

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

头文件：

#include <linux/of.h>

函数作用：
该函数通过指定的节点名称在设备树中进行查找，返回匹配的节点的 struct device_node 指针。

参数含义：

from：指定起始节点，表示从哪个节点开始查找。如果 from 参数为 NULL，则从设备树的根节点开始查找。

name：要查找的节点名称。

返回值：

如果找到匹配的节点，则返回对应的 struct device_node 指针。

如果未找到匹配的节点，则返回 NULL。

会在接下来的实验小节中，对该函数进行实际演示。

66.1.2 of_find_node_by_path函数

of_find_node_by_path 是Linux内核中用于通过节点路径查找设备树节点的函数。下面是对of_find_node_by_path函数的详细介绍：

函数原型：

struct device_node *of_find_node_by_path(const char *path);

头文件：

#include <linux/of.h>

函数作用：
该函数根据节点路径在设备树中进行查找，返回匹配的节点的 struct device_node 指针。

参数含义：

path：节点的路径，以斜杠分隔的字符串表示。路径格式为设备树节点的绝对路径，例如 /topeet/myLed。

返回值：

如果找到匹配的节点，则返回对应的 struct device_node 指针。

如果未找到匹配的节点，则返回 NULL。

of_find_node_by_path 函数通过节点路径在设备树中进行查找。路径是设备树节点从根节点到目标节点的完整路径。可以通过指定正确的路径来准确地访问设备树中的特定节点。

使用 of_find_node_by_path 函数时，可以直接传递节点的完整路径作为 path 参数，函数会在设备树中查找匹配的节点。这对于已知节点路径的情况非常有用。

66.1.3 of_get_parent函数

在Linux内核中，of_get_parent 函数用于获取设备树节点的父节点。下面是对of_get_parent函数的详细介绍：

函数原型：

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

头文件：

#include <linux/of.h>

函数作用：
该函数接收一个指向设备树节点的指针 node，并返回该节点的父节点的指针。

参数含义：

node：要获取父节点的设备树节点指针。

返回值：

如果找到匹配的节点，则返回对应的 struct device_node 指针。

如果未找到匹配的节点，则返回 NULL。

使用 of_get_parent 函数时，可以将特定的设备树节点作为参数传递给函数，然后它将返回该节点的父节点。这对于在设备树中导航和访问节点之间的层次关系非常有用。

父节点在设备树中表示了节点之间的层次结构关系。通过获取父节点，你可以访问上一级节点的属性和配置信息，从而更好地理解设备树中的节点之间的关系。

66.1.4 of_get_next_child函数

在Linux内核中，of_get_next_child 函数用于获取设备树节点的下一个子节点。下面是对of_get_next_child 函数的详细介绍：

函数原型：

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

头文件：

#include <linux/of.h>

函数作用：
该函数接收两个参数：node 是当前节点，prev 是上一个子节点。它返回下一个子节点的指针。

参数含义：

node：当前节点，用于指定要获取子节点的起始节点。

prev：上一个子节点，用于指定从哪个子节点开始获取下一个子节点。如果为 NULL，则从起始节点的第一个子节点开始。

返回值：

如果找到匹配的节点，则返回对应的 struct device_node 指针。

如果未找到匹配的节点，则返回 NULL。

使用 of_get_next_child 函数时，可以传递当前节点以及上一个子节点作为参数。函数将从上一个子节点的下一个节点开始，查找并返回下一个子节点。

设备树中的子节点表示了节点之间的层次关系。通过获取子节点，你可以遍历和访问当前节点的所有子节点，以便进一步处理它们的属性和配置信息。

64.1.5 of_ find_ compatible_ node函数

当设备树中存在多个设备节点，需要根据设备的兼容性字符串进行匹配时，可以使用 of_find_compatible_node 函数。该函数用于在设备树中查找与指定兼容性字符串匹配的节点。

函数原型：

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

头文件：

#include <linux/of.h>

函数作用：
在设备树中查找与指定兼容性字符串匹配的节点。

参数含义：

from：指定起始节点，表示从哪个节点开始查找。如果 from 参数为 NULL，则从设备树的根节点开始查找。

type：要匹配的设备类型字符串，通常是 compatible 属性中的一部分。

compatible：要匹配的兼容性字符串，通常是设备树节点的 compatible 属性中的值。

返回值：

如果找到匹配的节点，则返回对应的 struct device_node 指针。

如果未找到匹配的节点，则返回 NULL。

使用 of_find_compatible_node 函数时，可以指定起始节点和需要匹配的设备类型字符串以及兼容性字符串。函数会从起始节点开始遍历设备树，查找与指定兼容性字符串匹配的节点，并返回匹配节点的指针。
64.1.6 of_ find matching node_ and_ match函数

在Linux内核中，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);

头文件：

#include <linux/of.h>

函数作用：
根据给定的of_device_id匹配表在设备树中查找匹配的节点。

参数含义：

from：表示从哪个节点开始搜索。通常将上一次调用该函数返回的节点作为参数传递给from，以便从上一次的下一个节点开始搜索。如果要从设备树的根节点开始搜索，可以将from参数设置为NULL。

matches：指向一个of_device_id类型的匹配表，该表包含要搜索的匹配项。

match：用于输出匹配到的of_device_id条目的指针。

返回值：

如果找到匹配的节点，则返回对应的 struct device_node 指针。

如果未找到匹配的节点，则返回 NULL。

of_find_matching_node_and_match函数在设备树中遍历节点，对每个节点使用__of_match_node函数进行匹配。如果找到匹配的节点，将返回该节点的指针，并将match指针更新为匹配到的of_device_id条目，函数会自动增加匹配节点的引用计数。以下是使用of_find_matching_node_and_match函数的示例代码： 

#include <linux/of.h>

static const struct of_device_id my_match_table[] = {
    { .compatible = "vendor,device" },
    { /* sentinel */ }
};

const struct of_device_id *match;
struct device_node *np;

// 从根节点开始查找匹配的节点
np = of_find_matching_node_and_match(NULL, my_match_table, &match);

在上述示例中，我们定义了一个of_device_id匹配表my_match_table，其中包含了一个兼容性字符串为"vendor,device"的匹配项。然后，我们使用of_find_matching_node_and_match函数从根节点开始查找匹配的节点。

66.2实验程序编写

本实验驱动对应的网盘路径为：iTOP-RK3568开发板【底板V1.7版本】\03_【iTOP-RK3568开发板】指南教程\02_Linux驱动配套资料\04_Linux驱动例程\55_of_01。

本小节驱动程序是由上一章程序修改而来，相较于源程序只是在probe函数中添加了本章节学习的of操作相关代码，用来获取设备树节点。

编写完成的platform_driver.c代码如下所示：

#include <linux/module.h>
#include <linux/platform_device.h>
#include <linux/mod_devicetable.h>
#include <linux/of.h>

struct device_node *mydevice_node;      
const struct of_device_id *mynode_match;
struct of_device_id mynode_of_match[] = {
	{.compatible="my devicetree"},
	{},
};

// 平台设备的初始化函数
static int my_platform_probe(struct platform_device *pdev)
{
    printk(KERN_INFO "my_platform_probe: Probing platform device\n");

    // 通过节点名称查找设备树节点
    mydevice_node = of_find_node_by_name(NULL, "myLed");
	printk("mydevice node is %s\n", mydevice_node->name);
    
	// 通过节点路径查找设备树节点
    mydevice_node = of_find_node_by_path("/topeet/myLed");
    printk("mydevice node is %s\n", mydevice_node->name);
        
    // 获取父节点
    mydevice_node = of_get_parent(mydevice_node);
    printk("myled's parent node is %s\n", mydevice_node->name);
            
    // 获取子节点
    mydevice_node = of_get_next_child(mydevice_node, NULL);
    printk("myled's sibling node is %s\n", mydevice_node->name);

	// 使用compatible值查找节点
	mydevice_node=of_find_compatible_node(NULL ,NULL, "my devicetree");
	printk("mydevice node is %s\n" , mydevice_node->name);
	
	//根据给定的of_device_id匹配表在设备树中查找匹配的节点
	mydevice_node=of_find_matching_node_and_match(NULL , mynode_of_match, &mynode_match);
	printk("mydevice node is %s\n" ,mydevice_node->name);
	return 0;
}

// 平台设备的移除函数
static int my_platform_remove(struct platform_device *pdev)
{
    printk(KERN_INFO "my_platform_remove: Removing platform device\n");

    // 清理设备特定的操作
    // ...

    return 0;
}


const struct of_device_id of_match_table_id[]  = {
	{.compatible="my devicetree"},
};

// 定义平台驱动结构体
static struct platform_driver my_platform_driver = {
    .probe = my_platform_probe,
    .remove = my_platform_remove,
    .driver = {
        .name = "my_platform_device",
        .owner = THIS_MODULE,
		.of_match_table =  of_match_table_id,
    },
};

// 模块初始化函数
static int __init my_platform_driver_init(void)
{
    int ret;

    // 注册平台驱动
    ret = platform_driver_register(&my_platform_driver);
    if (ret) {
        printk(KERN_ERR "Failed to register platform driver\n");
        return ret;
    }

    printk(KERN_INFO "my_platform_driver: Platform driver initialized\n");

    return 0;
}

// 模块退出函数
static void __exit my_platform_driver_exit(void)
{
    // 注销平台驱动
    platform_driver_unregister(&my_platform_driver);
    printk(KERN_INFO "my_platform_driver: Platform driver exited\n");
}

module_init(my_platform_driver_init);
module_exit(my_platform_driver_exit);

MODULE_LICENSE("GPL");
MODULE_AUTHOR("topeet");

66.3 运行测试

66.3.1 编译驱动程序

在上一小节中的platform_driver.c代码同一目录下创建 Makefile 文件，Makefile 文件内容如下所示：

export ARCH=arm64#设置平台架构
export CROSS_COMPILE=aarch64-linux-gnu-#交叉编译器前缀
obj-m += platform_driver.o    #此处要和你的驱动源文件同名
KDIR :=/home/topeet/Linux/linux_sdk/kernel    #这里是你的内核目录                                                                                                                            
PWD ?= $(shell pwd)
all:
    make -C $(KDIR) M=$(PWD) modules    #make操作
clean:
    make -C $(KDIR) M=$(PWD) clean    #make clean操作

对于Makefile的内容注释已在上图添加，保存退出之后，来到存放platform_driver.c和Makefile文件目录下，如下图（图66-1）所示：

图 66-1

然后使用命令“make”进行驱动的编译，编译完成如下图（图66-2）所示：

图 66-2

编译完生成platform_driver.ko目标文件，如下图（图66-3）所示：

至此驱动模块就编译成功了。

66.3.2 运行测试

在进行实验之前，首先要确保开发板烧写的是我们在65.2.1小节中编译出来的boot.img，开发板启动之后，使用以下命令进行驱动模块的加载，如下图（图66-4）所示：

insmod platform_driver.ko

可以看到总共有4个打印，前两个打印都是查找的myLed节点，第三个打印是查找的myLed的父节点，也就是topeet节点，第四个打印是查找的topeet的子节点，也就又回到了myLed节点。第5个打印是通过compatible属性查找到的myLed节点，第6个打印是通过of_device_id匹配表查找到的myLed节点.

然后使用以下命令进行驱动模块的卸载，如下图（图66-5）所示：

rmmod platform_driver.ko

图 66-5

至此，使用of操作函数获取设备树节点实验就完成了。

---