一、linux驱动开发-2.1-设备树

一、设备树简介

        描述设备树的文件叫DTS（Device Tree Source），采用树形结构描述板级设备，比如CPU数量，IIC、spi接口上接了什么设备。

        一般情况下，用.dts文件描述板级信息，即开发板上有哪些IIC，SPI设备；用.dtsi描述SOC级信息，即SOC上CPU，主频，外设控制器信息，作为公共文件被各dts调用。

DTS是设备树源码文件，经过DTC工具编译成DTB文件，之后使用.dtb文件

二、DTS语法

2.1、设备节点

       设备树采用树形结构来描述板子上的设备信息，每个设备都是一个节点，每个节点通过键值对来描述节点信息。

        每个设备树文件只有一个根节点，/表示根节点。

        节点命名格式如下：

/*
label：节点标签，通过&label访问节点，可以省略
node-name：节点名字，描述节点的功能
unit-address：一般表示设备的地址或寄存器地址，没有的话可以不要
*/
label:node-name@unit-address

设备树源码中常用的几种数据形式：

①、字符串

compatible="arm,cortex-a7";

②、32位无符号数字

//设置为0
reg=<0>;
//设置为一组值
reg=<0 0x12345 100>

③、字符串列表

字符串之间用“，”隔开

compatible="fsl,imx6ull-gpmi-nand","fsl,imx6ul-gpmi-nand";

 2.2、标准属性

       每个节点都是具体的设备，节点又是由一堆属性组成，不同的设备的属性不同，可以自定义属性，但是有很多属性都是标准属性，很多驱动都会使用这些标准属性。下面是几个常用的标准属性。

2.2.1、compatible属性

       compatible属性的值是一个字符串列表，用于将设备和驱动绑定起来，来选择设备所要用的驱动程序。格式如下：

/*
@manufacture：厂商
@model：模块对应的驱动名字
*/
"manufacturer,model"

       比如说有个音频芯片采用WM8960，该节点的compatible属性值如下：

compatible = "fsl,imx6ul-evk-wm8960","fsl,imx-audio-wm8960";

       其中“fsl”表示厂商是飞思卡尔，“imx6ul-evk-wm8960”和“imx-audio-wm8960”表示驱动模块的名字，找的时候首先使用第一个值在内核里找，找不到就使用第二个值找。

2.2.2、model属性

       描述设备模块信息，比如叫什么名字，例

model="wm8960-audio";

2.2.3、status属性

        表示设备状态，可选状态如下：

status值列表

"okay"	设备可操作
"disable"	当前设备不可操作，未来可以变成可操作
"fail"	不可操作
"fail-sss"	不可操作，sss指检测到的错误内容

2.2.4、#address-cells和#size-cell属性

        这两个属性值都是无符号32位整形，#address-cells 和#size-cells 这两个属性可以用在任何拥有子节点的设备中，用于描述子节点的地址信息。#address-cells 属性值决定了子节点 reg 属性中地址信息所占用的字长(32 位)，#size-cells 属性值决定了子节点 reg 属性中长度信息所占的字长(32 位)。#address-cells 和#size-cells 表明了子节点应该如何编写 reg 属性值，一般 reg 属性都是和地址有关的内容，和地址相关的信息有两种：起始地址和地址长度，reg 属性的格式一为：

reg = <address1 length1 address2 length2 address3 length3……>

        每个“address length”组合表示一个地址范围，其中 address 是起始地址，length 是地址长度，#address-cells 表明 address 这个数据所占用的字长，#size-cells 表明 length 这个数据所占用的字长，比如：

spi4 {
    compatible = "spi-gpio";
    #address-cells = <1>;
    #size-cells = <0>;

    gpio_spi: gpio_spi@0 {
        compatible = "fairchild,74hc595";
        reg = <0>;
       };
    };

aips3: aips-bus@02200000 {
    compatible = "fsl,aips-bus", "simple-bus";
    #address-cells = <1>;
    #size-cells = <1>;

    dcp: dcp@02280000 {
        compatible = "fsl,imx6sl-dcp";
        reg = <0x02280000 0x4000>;
        };
    };

 2.2.5、reg属性

       reg属性值一般是(address, length)对，用于描述设备地址空间资源信息，一般都是某个外设的寄存器地址范围信息。

2.2.6、ranges属性

       ranges属性值可以为空或者按照(child-bus-address,parent-bus-address,length)格式编写的数字矩阵，ranges 是一个地址映射/转换表，ranges 属性每个项目由子地址、父地址和地址空间长度这三部分组成：
       child-bus-address：子总线地址空间的物理地址，由父节点的#address-cells 确定此物理地址所占用的字长。
       parent-bus-address ：父总线地址空间的物理地址，同样由父节点的#address-cells 确定此物理地址所占用的字长。
       length ：子地址空间的长度，由父节点的#size-cells 确定此地址长度所占用的字长。

       如果 ranges 属性值为空值，说明子地址空间和父地址空间完全相同，不需要进行地址转换，

2.3、根节点compatible属性

/ {
    model = "Freescale i.MX6 ULL 14x14 EVK Board";
    compatible = "fsl,imx6ull-14x14-evk", "fsl,imx6ull";
}

       通过根节点的 compatible 属性可以知道我们所使用的设备，一般第一个值描述了所使用的硬件设备名字，比如这里使用的是“imx6ull-14x14-evk”这个设备，第二个值描述了设备所使用的 SOC，比如这里使用的是“imx6ull”这颗 SOC。Linux 内核会通过根节点的 compoatible 属性查看是否支持此设备，如果支持的话设备就会启动 Linux 内核。

2.4、向节点追加或修改内容

       一般是在开发板的设备树文件.dts文件里添加，而不在.dtsi这个SOC头文件上加。比如现在要在i2C1节点上追加一个fxsl8471的子节点，如果直接在.dtsi文件上添加，那么所有引用.dtsi这个头文件的板子上都会添加这个子设备。比如在.dtsi文件上的I2C1节点信息如下：

//.dtsi文件
i2c1:i2c@021a0000 {
};

        在.dts中追加一个子节点，方法如下：

&i2c1 {
    /* 追加的内容 */
};

三、创建小型设备树模板

四、设备树在系统中的体现

       内核启动后会解析设备树中各个节点的信息，并且在根文件系统的/proc/device-tree目录下根据节点名字创建不同文件夹。

五、设备树常用OF函数

       linux内核使用device_node结构体来描述一个节点，定义如下：

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
};

5.1、查找节点

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

5.1.1、of_find_node_by_name

/*
@Description：通过节点名字找到指定的节点
@from：开始查找的节点，如果为NULL表示从根节点开始查找整个设备树
@name：要查找的节点名字
@return：找到的节点
*/
struct device_node *of_find_node_by_name(struct device_node *from,
                                         const char *name);

5.1.2、of_find_node_by_type

/*
@Description：通过 device_type 属性查找到指定的节点
@from：开始查找的节点，如果为NULL表示从根节点开始查找整个设备树
@type：要查找的节点对应的 type 字符串，也就是 device_type 属性值
@return：找到的节点
*/
struct device_node *of_find_node_by_type(struct device_node *from, 
                                         const char *type)

5.1.3、of_find_compatible_node

/*
@Description：根据 device_type 和 compatible 这两个属性查找指定的节点
@from：开始查找的节点，如果为NULL表示从根节点开始查找整个设备树
@type：要查找的节点对应的 type 字符串，也就是 device_type 属性值，可以为 
       NULL，表示忽略掉 device_type 属性
@compatible ：要查找的节点所对应的 compatible 属性列表
@return：找到的节点
*/
struct device_node *of_find_compatible_node(struct device_node *from,
                                            const char *type,
                                            const char *compatible)

5.1.4、of_find_matching_node_and_match

/*
@Description：通过 of_device_id 匹配表来查找指定的节点
@from：开始查找的节点，如果为NULL表示从根节点开始查找整个设备树
@matches：of_device_id 匹配表，也就是在此匹配表里面查找节点
@match ：找到的匹配的 of_device_id
@return：找到的节点
*/
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)

5.1.5、of_find_node_by_path

/*
@Description：通过路径来查找指定的节点
@path：带有全路径的节点名，可以使用节点的别名
@return：找到的节点
*/
inline struct device_node *of_find_node_by_path(const char *path)

5.2、查找父节点/子节点的OF函数

5.2.1、of_get_parent

/*
@node：要查找的父节点的节点
@return：找到的父节点的节点
*/
struct device_node *of_get_parent(const struct device_node *node)

5.2.2、 of_get_next_child

/*
@node：父节点
@prev：前一个子节点，也就是从哪一个子节点开始迭代的查找下一个子节点。可以设置为
NULL，表示从第一个子节点开始

@return：找到的下一个子节点
*/
struct device_node *of_get_next_child(const struct device_node *node,
                                      struct device_node *prev)

5.3、提取属性值的OF函数

5.3.1、of_find_property

/*
@np：设备节点
@name： 属性名字
@enp：属性值的字节数
@return：找到的属性
*/
property *of_find_property(const struct device_node *np,
                            const char *name,
                            int *lenp)

5.3.2、of_property_count_elems_of_size

/*
@np：设备节点
@proname： 需要统计元素数量的属性名字
@elem_size：元素长度
@return：得到的属性元素数量
*/
int of_property_count_elems_of_size(const struct device_node *np,
                                    const char *propname,
                                    int elem_size)

5.3.3、of_property_read_u32_index

5.4、其他

5.4.1、of_iomap

        用于直接虚拟内存映射，当采用设备树后就可以用，不用ioremap函数了。

/*
@Description：内存映射
@np：设备节点
@index：reg属性中要完成内存映射的段
@return：经过内存映射后的虚拟内存首地址
*/
void __iomem *of_iomap(struct device_node *np, int index)