在 Linux 驱动开发 中，of_ 系列函数（也常写作 OF 函数）是连接驱动代码与设备树的桥梁，负责在驱动中查找设备节点、读取硬件配置信息。下面汇总最常用的 of_ 函数及其实例，帮你快速上手。
1. 查找/获取节点（定位硬件）
这类函数用于获取设备节点的句柄（struct device_node *），是后续一切操作的前提。
| 函数 |
说明 |
典型场景 |
of_find_node_by_name(struct device_node *from, const char *name) |
通过节点名称查找，from 为 NULL 表示从根节点开始。 |
不推荐，名字可能不唯一。 |
of_find_node_by_path(const char *path) |
通过完整路径查找，如 "/soc/i2c@12345678"。 |
路径明确且稳定时使用。 |
of_find_compatible_node(struct device_node *from, const char *type, const char *compatible) |
最推荐。通过 compatible 属性查找。 |
驱动与设备树匹配的标准方式。 |
of_find_node_by_phandle(phandle handle) |
通过数字句柄（phandle）查找节点。 |
较少直接使用，通常用于解析引用。 |
of_find_node_with_property(struct device_node *from, const char *prop_name) |
查找包含某个特定属性的节点。 |
用于遍历系统中所有具备某特征（如 status = "okay"）的节点。 |
实例：
// 方式1：通过路径查找
struct device_node *np = of_find_node_by_path("/leds/led@0");
// 方式2：通过compatible查找（最常用）
np = of_find_compatible_node(NULL, NULL, "gpio-leds");
2. 查找父子节点（遍历层级）
拿到一个节点后，要操作它的上层或下层节点时使用。
| 函数 |
说明 |
典型场景 |
of_get_parent(const struct device_node *node) |
获取当前节点的父节点。 |
需要访问上级总线或控制器信息时。 |
of_get_next_child(const struct device_node *node, struct device_node *prev) |
遍历子节点，prev 为 NULL 时获取第一个子节点。 |
遍历某个节点下的所有子设备（如 I2C 总线上的多个从设备）。 |
of_get_available_child_count(const struct device_node *node) |
统计 status 为 "okay" 的子节点个数。 |
检查有多少个可用的子设备。 |
for_each_child_of_node(parent, child) |
内核提供的遍历宏，比手动调用更安全、简洁。 |
强烈推荐在循环遍历子节点时使用。 |
实例：遍历父节点下的所有可用子节点
struct device_node *child;
struct device_node *parent = np; // 假设np是父节点
for_each_child_of_node(parent, child) {
// 处理每个子节点，如读取其reg属性
u32 reg;
if (!of_property_read_u32(child, "reg", ®)) {
pr_info("child reg = 0x%x\n", reg);
}
}
// 注意：for_each_child_of_node在循环内部会自动对child引用计数加1，
// 循环结束后需要手动 of_node_put(child) 来释放
3. 提取属性值（读取信息）
这是最常用的一大类，用于读取设备树节点属性中的键值对。
3.1 整数类属性提取函数
| 函数 |
说明 |
典型场景 |
of_property_read_u8/u16/u32/u64(np, propname, &val) |
读取单个整数。 |
读取寄存器地址、引脚号、标志位等。 |
of_property_read_u32_array(np, propname, out_val, sz) |
读取整数数组，需指定读取个数 sz。 |
读取 reg 属性中的地址 + 长度组合。 |
of_property_count_elems_of_size(np, propname, size) |
统计属性中元素的个数（按指定字节大小）。 |
读取数组前先获取长度，动态分配缓冲区。 |
3.2 字符串类属性提取函数
| 函数 |
说明 |
典型场景 |
of_property_read_string(np, propname, &out_string) |
读取字符串属性，输出为 const char *。 |
读取 compatible、label、status 等。 |
of_property_match_string(np, propname, string) |
在字符串数组中查找指定字符串，返回索引。 |
用于解析 pinmux 等属性。 |
3.3 通用类属性提取函数
| 函数 |
说明 |
典型场景 |
of_property_read_bool(np, propname) |
检查属性是否存在（不关心值）。 |
用于开关标志，如 dma-coherent;。 |
of_property_read_variable_u32_array |
读取长度可变的数组，自动获取长度。 |
避免手动调用 count + read 两步。 |
3.4 特殊类属性提取函数
| 函数 |
说明 |
典型场景 |
of_get_mac_address(np) |
专门用于读取 MAC 地址。 |
网卡驱动获取 MAC。 |
of_get_named_gpio(np, propname, index) |
读取 GPIO 编号（已废弃，改用 gpiod 系列）。 |
旧驱动中常见，新代码建议用 gpiod_get。 |
3.5 实例（综合读取）
// 假设设备树节点如下：
// mydev {
// compatible = "my,device";
// reg = <0x10000000 0x1000>;
// clock-frequency = <50000000>;
// label = "uart0";
// };
u32 addr, size, freq;
const char *label;
// 读取数组：reg = <address, size>
of_property_read_u32_array(np, "reg", &addr, 1); // 读地址
of_property_read_u32_array(np, "reg", &size, 2); // 读size（注意index从1开始，但更安全是用count）
// 更严谨的做法：先读数组
u32 reg_data[2];
if (of_property_read_u32_array(np, "reg", reg_data, 2) == 0) {
addr = reg_data[0];
size = reg_data[1];
}
// 读取单个整数
of_property_read_u32(np, "clock-frequency", &freq);
// 读取字符串
of_property_read_string(np, "label", &label);
4. 其他常用辅助函数
这些函数用于地址转换、状态检查、引用解析等。
4.1 地址映射/转换
| 函数 |
说明 |
典型场景 |
of_iomap(np, index) |
将设备树节点中 reg 属性的第 index 段地址映射为内核虚拟地址，返回 void __iomem *。它替代 ioremap，自动处理 reg 中的地址和长度。 |
驱动最常使用的地址处理函数。 |
of_address_to_resource(np, index, &res) |
将 reg 属性转换为 struct resource 结构体。 |
用于 platform 设备注册时填充资源。 |
const __be32 *of_get_address(struct device_node *dev, int index, u64 *size, unsigned int *flags) |
获取 reg 属性中第 index 个地址段的原始地址值（设备树中的地址，未经转换），返回指向该地址的指针。 |
需要读取原始地址值的场合。 |
u64 of_translate_address(struct device_node *dev, const __be32 *in_addr) |
将设备树中的总线地址转换为 CPU 物理地址。它会沿着设备树向上遍历，处理所有 ranges 属性，最终得到 CPU 可见的物理地址；如果设备在根节点下（没有总线转换），返回的地址与 of_get_address 相同。 |
处理带地址映射（如 PCI、DMA 控制器）设备的关键函数。 |
函数比对：
| 函数 |
返回值 |
是否转换地址 |
是否映射 |
使用场景 |
of_get_address |
原始地址指针（大端） |
❌ |
❌ |
需要读取原始地址值的场合 |
of_translate_address |
CPU 物理地址（u64） |
✅ |
❌ |
需要物理地址传给 DMA 或其他硬件 |
of_iomap |
虚拟地址（__iomem *） |
✅ |
✅ |
最常用，驱动需要访问寄存器 |
注意事项
- 地址转换的时机：
of_iomap 和 of_address_to_resource 最常用，已经封装了地址转换逻辑，普通驱动无需手动调用 of_translate_address。
- 大小端转换：
of_get_address 返回的是大端序数据，需要使用 of_read_number() 或 be32_to_cpu() 转换。
- 映射的释放：使用
of_iomap 映射后，必须使用 iounmap() 释放，否则会导致内核内存泄漏。
- 兼容性检查的替代：在
platform_driver 中，of_match_device 已经在 probe 之前完成了兼容性检查，因此 probe 函数中通常不需要再调用 of_device_is_compatible。
- 引用计数管理：所有通过
of_find_* 获取的 device_node *，必须在不再使用时调用 of_node_put() 释放引用。
📝 示例1
struct device_node *np;
const __be32 *addr_cell;
u64 cpu_pa;
np = of_find_node_by_path("/soc/bus@20000000/device@30000000");
if (np) {
// 获取reg中的原始地址
addr_cell = of_get_address(np, 0, NULL, NULL);
if (addr_cell) {
// 将总线地址转换为CPU物理地址
cpu_pa = of_translate_address(np, addr_cell);
if (cpu_pa != OF_BAD_ADDR) {
pr_info("CPU physical address: 0x%llx\n", cpu_pa);
} else {
pr_err("Failed to translate address\n");
}
}
of_node_put(np);
}
📝 示例2：读取地址并映射的完整流程
#include <linux/of_address.h>
#include <linux/of_platform.h>
static int my_probe(struct platform_device *pdev)
{
struct device_node *np = pdev->dev.of_node;
struct resource res;
void __iomem *base;
u64 cpu_pa;
const __be32 *addr;
int ret;
// 方式1（推荐）：直接使用of_iomap
base = of_iomap(np, 0);
if (!base) {
dev_err(&pdev->dev, "Failed to iomap registers\n");
return -ENOMEM;
}
dev_info(&pdev->dev, "Registers mapped at %p\n", base);
// 方式2：如果需要物理地址，使用of_address_to_resource或of_translate_address
ret = of_address_to_resource(np, 0, &res);
if (!ret) {
dev_info(&pdev->dev, "Physical address: 0x%llx, size: 0x%llx\n",
(u64)res.start, (u64)resource_size(&res));
}
// 方式3：手动获取并转换（不常用，但用于理解原理）
addr = of_get_address(np, 0, NULL, NULL);
if (addr) {
cpu_pa = of_translate_address(np, addr);
if (cpu_pa != OF_BAD_ADDR) {
dev_info(&pdev->dev, "Translated PA: 0x%llx\n", cpu_pa);
}
}
// 检查兼容性（通常不需要，因为probe已经匹配过了）
if (of_device_is_compatible(np, "my,special-device")) {
dev_info(&pdev->dev, "This is a special device, enabling extra features\n");
// 执行特殊初始化
}
// 存储base指针到驱动私有数据中
// ...
return 0;
}
4.2 状态检查
| 函数 |
说明 |
典型场景 |
of_device_is_available(np) |
检查 status 属性是否为 "okay"（或不存在）。 |
驱动应只操作可用的节点。 |
4.3 引用解析
| 函数 |
说明 |
典型场景 |
of_parse_phandle(np, propname, index) |
解析属性中的 phandle 引用，返回被引用的节点指针。 |
用于解析 interrupt-parent 或 dmas 等引用。 |
of_property_count_strings(np, propname) |
统计字符串数组属性的元素个数。 |
用于解析多个字符串的列表。 |
4.4 平台设备绑定
| 函数 |
说明 |
典型场景 |
of_platform_device_create(np, NULL, NULL) |
将设备树节点注册为 platform_device。 |
常用于总线驱动动态创建子设备。 |
of_match_device(matches, dev) |
将设备与 of_device_id 表匹配。 |
在 probe 中验证是否匹配。 |
4.5 兼容性检查
| 函数 |
说明 |
典型场景 |
int of_device_is_compatible(const struct device_node *device, const char *compat) |
检查设备节点是否兼容指定的字符串。 |
驱动在 probe 之外手动验证节点身份的重要工具。 |
参数说明：
device：要检查的设备节点指针compat：兼容性字符串，如 "arm,pl011"- 返回值：返回
1 表示兼容，0 表示不兼容
使用实例：
struct device_node *np = of_find_node_by_path("/serial@101f0000");
if (np) {
if (of_device_is_compatible(np, "arm,pl011")) {
pr_info("This is an ARM PL011 UART\n");
// 执行特定于PL011的初始化
} else if (of_device_is_compatible(np, "ns16550")) {
pr_info("This is a NS16550 UART\n");
// 执行特定于NS16550的初始化
}
of_node_put(np);
}
特别注意：该函数会检查节点的 compatible 属性列表中是否包含给定的字符串（注意不是完全相等，而是匹配列表中的某一项）。在平台驱动模型中，该函数通常由内核自动调用（通过 of_match_device），但在手动遍历节点时非常有用。
综合使用实例
// 检查设备是否可用
if (!of_device_is_available(np)) {
return -ENODEV;
}
// 映射地址（自动取reg[0]）
void __iomem *base = of_iomap(np, 0);
if (!base) {
pr_err("ioremap failed\n");
return -ENOMEM;
}
// 解析中断父节点
struct device_node *irq_parent = of_parse_phandle(np, "interrupt-parent", 0);
if (irq_parent) {
pr_info("Interrupt parent found\n");
of_node_put(irq_parent); // 用完记得释放引用
}
🎯 总结：使用时的黄金法则
- 获取节点后必须释放：所有
of_find_*、of_get_*、of_parse_phandle 得到的 device_node *，在不用时必须调用 of_node_put(np)，否则会导致引用计数泄漏；
- 遍历子节点注意引用：使用
for_each_child_of_node 时，循环内部已经增加了引用，循环结束后需要手动 of_node_put(child)，或者在循环内部 break 时先 of_node_put 再 break；
- 优先用
compatible 查找：路径容易变化，name 不唯一，compatible 是最可靠的方式，也是 Linux 驱动模型的标准做法；
- 驱动需要访问寄存器时使用
of_iomap(np, 0) 最简洁；
- 需要获取物理地址给 DMA 时使用
of_address_to_resource(np, 0, &res) 或 platform_get_resource(pdev, IORESOURCE_MEM, 0)；
- 需要手动处理地址转换时使用
of_translate_address(np, addr_cell)，一般很少需要；
- 只想读取原始地址值（调试）时使用
of_get_address(np, 0, &size, &flags)；
- 验证设备兼容性时使用
of_device_is_compatible(np, compat)；
- 检查设备是否启用时使用
of_device_is_available(np)。
更多 Linux 内核与设备树相关的内容，也可以在云栈社区继续查阅。
发表于 前天 06:48
|
查看: 1|
回复: 0
