Linux驱动开发不得不知的of_函数

在Linux驱动开发中，of_系列函数（也称OF函数）是连接驱动与设备树的桥梁，用于在驱动代码中查找设备节点、读取硬件配置信息。本文汇总了最常用的OF函数及其实例，帮助快速上手。

1. 查找/获取节点（定位硬件）

这类函数用于获取设备节点的句柄（struct device_node *），是后续一切操作的前提。

实例：

// 方式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. 查找父子节点（遍历层级）

拿到一个节点后，要操作它的上层或下层节点时使用。

实例: 遍历父节点下的所有可用子节点：

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", &reg)) {
        pr_info("child reg = 0x%x\n", reg);
    }
}
// 注意：for_each_child_of_node在循环内部会自动对child引用计数加1，
// 循环结束后需要手动 of_node_put(child) 来释放

3. 提取属性值（读取信息）

这是最常用的一大类，用于读取设备树中{}内的键值对。

3.1整数类属性提取函数

3.2 字符串类属性提取函数

3.3 通用类属性提取函数

3.4 特殊类属性提取函数

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和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 状态检查

4.3 引用解析

4.4 平台设备绑定

4.5 兼容性检查

参数说明： 1.device 要检查的设备节点指针 2.compat 兼容性字符串，如 "arm,pl011" 3.返回值 返回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); // 用完记得释放引用
}

🎯总结：使用时的黄金法则

1. 获取节点后必须释放：所有of_find_*、of_get_*、of_parse_phandle得到的；device_node *，在不用时必须调用of_node_put(np)，否则会导致引用计数泄漏；
2. 遍历子节点注意引用：使用for_each_child_of_node时，循环内部已经增加了引用，循环结束后需要手动of_node_put(child)，或者在循环内部break时先of_node_put再break；
3. 优先用compatible查找：路径容易变化，name不唯一，compatible是最可靠的方式，也是Linux驱动模型的标准做法；
4. 驱动需要访问寄存器时使用 of_iomap(np, 0)最简洁；
5. 需要获取物理地址给DMA时使用of_address_to_resource(np, 0, &res) 或 platform_get_resource(pdev, IORESOURCE_MEM, 0);
6. 需要手动处理地址转换时使用of_translate_address(np, addr_cell),一般很少需要；
7. 只想读取原始地址值（调试）时使用of_get_address(np, 0, &size, &flags)；
8. 验证设备兼容性时使用of_device_is_compatible(np, compat)；
9. 检查设备是否启用时使用of_device_is_available(np)。