设备树DTS 学习：5-基于设备树的驱动编写实战

背景

讲完设备树的有关概念以及语法以后，我们接下来就让 我们的驱动 使用 设备树。
ref ： 《内核学习笔记14：内核设备树学习》、《u-boot对设备树的支持》

测试代码

本文使用的设备树节点如下：

/ {
// 专门用于测试dts的示例，没实例用途
    // 名称可以有“,”、“-”，如“ll,i2c-enable”
    myfoo {
        compatible = "ll,jimkent-foo";
        status = "okay"; // string
        enable; // bool，无须值
        myvalue = <250>; // 默认是32位，如果使用8位读取，结果为0
        value = /bits/ 8 <88>; // 8位单独赋值
        value16 = /bits/ 16 <166>; // 16位单独赋值
        a-cell = <1 2 3 4 5>; // 数组
        // 子节点
        foo {
            label = "foo";
            note = "this is foo";
        };
        bar {
            label = "bar";
            note = "this is bar";
        };
    };
 
 // 其中compatible与驱动使用的名称必须一致（这样才能匹配上）。其它内容比较简单，分别是字符串、布尔类型、不同位数的数值、数组、子节点。
}

驱动实例如下：

/**
 * @file   foo_drv.c
 * @author Late Lee <latelee@163.com>
 * @date   Wed Jun  7 22:21:19 2019
 * 
 * @brief  测试dts示例
 * 
 * @note   读取dts的值，学习dts。代码有部分警告，不影响
 */

#include <linux/module.h>
#include <linux/kernel.h>       /**< printk() */
#include <linux/init.h>

#include <linux/types.h>        /**< size_t */
#include <linux/errno.h>        /**< error codes */
#include <linux/string.h>

#include <linux/of.h>
#include <linux/of_device.h>

static int foo_remove(struct platform_device *dev)
{
    printk(KERN_NOTICE "remove...\n");

    return 0;
}

static int foo_probe(struct platform_device *dev)
{
    int ret = 0;
    struct device_node* np = dev->dev.of_node;
    struct device_node* child = NULL;
    const char* str = NULL;
    bool enable = false;
    u8 value = 0;
    u16 value16 = 0;
    u32 value32 = 0;
    
    // 测试dts读取API
    if(np == NULL)
    {
        pr_info("of_node is NULL\n");
        return 0;
    }
    
    of_property_read_string(np, "status", &str); // 读字符串

    enable = of_property_read_bool(np, "enable"); // bool类型，可判断某字段存在不存在
    of_property_read_u32(np, "myvalue", &value32); // 一般地，都使用u32读取数值
    of_property_read_u8(np, "value", &value);
    of_property_read_u16(np, "value16", &value16);
    
    u32 data[3] = {0};
	u32 tag = 0;
    // a-cell是一个数组，默认读第1个。
    of_property_read_u32(np, "a-cell", &tag);
    // 也可以读取指定大小的数组（不一定是全部的）
    of_property_read_u32_array(np, "a-cell", data, ARRAY_SIZE(data));
    
    printk("of read status: %s enable: %d value: %d %d %d\n", str, enable, value, value16, value32);
    printk("of read tag: %d data: %d %d %d\n", tag, data[0], data[1], data[2]);
    
    // 获取子节点个数
    int count = of_get_available_child_count(np);
    
    // 遍历所有子节点，按格式读取属性
    int index = 0;
    for_each_available_child_of_node(np,child)
    {
        const char* label = of_get_property(child,"label",NULL) ? : child->name;
        const char* note = of_get_property(child,"note",NULL) ? : child->name;
        printk("of read: label: %s note: %s\n", label, note);
    }
    return ret;
}

static struct of_device_id foo_of_match[] = {
	{ .compatible = "ll,jimkent-foo", },
	{ /* sentinel */ }
};

static struct platform_driver foo_driver = {
	.driver = {
		.name = "foo",
		.of_match_table = of_match_ptr(foo_of_match),
	},
	.probe  = foo_probe,
    .remove = foo_remove,
};

static int __init foo_drv_init(void)
{
    int ret = 0;

    ret = platform_driver_register(&foo_driver);
    if (ret)
    {
        pr_info("platform_driver_register failed!\n");
        return ret;
    }
    
    pr_info("Init OK!\n");
    
    return ret;
}

static void __exit foo_drv_exit(void)
{
    platform_driver_unregister(&foo_driver);
}

module_init(foo_drv_init);
module_exit(foo_drv_exit);

MODULE_AUTHOR("Late Lee");
MODULE_DESCRIPTION("Simple platform driver");
MODULE_LICENSE("GPL");
MODULE_ALIAS("platform:foo");

示例的代码是一个简单的模板，除了学习dts外，没什么用处。但是可以以此展开复杂的、有实际用途的驱动。
与以前的platform驱动不同，platform_driver中指定of_match_table，foo_of_match结构体的.compatible必须与设备树的compatible一致。

本驱动涉及到的读取设备树节点信息的函数如下，更多函数，参考内核源码的include/linux/of.h头文件：

of_property_read_string // 读取字符串
of_property_read_bool // 判断某个字段是否存在，无须赋值
of_property_read_u8 // 读取8比特
of_property_read_u16 // 读取16比特
of_property_read_u32 // 读取32比特

如果存在多个子节点，用of_get_available_child_count获取个数（可用于开辟内存），然后调用for_each_available_child_of_node遍历所有子节点，注意，of_get_property与of_property_read_string有相同效果。只是用法不同而已。