linux中of系列函数

查找节点的of函数

1.通过节点名字查找指定的节点
of_find_node_by_name

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

from：要开始查找的节点
name：节点名字

2.通过 device_type 属性查找指定的节点
of_find_node_by_type

struct device_node *of_find_node_by_type(struct device_node *from, const char *type);

from： 开始查找的节点，如果为 NULL 表示从根节点开始查找整个设备树。 type： 要查找的节点对应的 type 字符串，也就是
type 属性值。

3.根据 device_type 和 compatible 这两个属性查找指定的节点
of_find_compatible_node

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

from： 开始查找的节点，如果为 NULL 表示从根节点开始查找整个设备树。 type： 要查找的节点对应的 type 字符串，也就是
device_type 属性值，可以为 NULL，表示忽略掉 device_type 属性。
compatible： 要查找的节点所对应的 compatible 属性列表。
返回值： 找到的节点，如果为 NULL 表示查找失败

4.通过 of_device_id 匹配表来查找指定的节点
of_find_matching_node_and_match

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

from： 开始查找的节点，如果为 NULL 表示从根节点开始查找整个设备树。
matches： of_device_id 匹配表，也就是在此匹配表里面查找节点。
match： 找到的匹配的 of_device_id。
返回值： 找到的节点，如果为 NULL表示查找失败。

5.通过路径来查找指定的节点
of_find_node_by_path

inline struct device_node *of_find_node_by_path(const char *path);

path： 带有全路径的节点名，可以使用节点的别名，比如“/backlight”就是 backlight 这个节点的全路径。
返回值：找到的节点，如果为 NULL 表示查找失败

6.用于获取指定节点的父节点
of_get_parent

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

node： 需要查找父节点的子节点；
返回值： 返回父节点；

7.查找子节点
of_get_next_child

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

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

提取属性的of函数

1.用于查找指定的属性，
of_find_property

property *of_find_property(const struct device_node *np, const char *name, int *lenp);

np： 设备节点；
name： 属性名字；
lenp： 属性值的字节数；
返回值： 找到的属性。

2.用于获取属性中元素的数量
of_property_count_elems_of_size
比如 reg 属性值是一个数组，那么使用此函数可以获取到这个数组的大小，此函数原型如下：

int of_property_count_elems_of_size(const struct device_node *np, const char *propname, int elem_size);

np： 设备节点。
proname： 需要统计元素数量的属性名字。
elem_size： 元素长度。
返回值： 得到的属性元素数量。

3.从属性中查找并读取 u8 数组
of_property_read_u8_array

int of_property_read_u8_array(const struct device_node *np,const char *propname, u8 *out_values, size_t sz)

np： 设备节点；
proname： 要读取的属性名字；
out_values： 指向返回值的指针，仅当返回值为 0 时才修改；
sz： 要读取的数组元素数；
返回值： 0 读取成功，负值，读取失败， -EINVAL 表示属性不存在。-ENODATA 表示没有要读取的数据， -EOVERFLOW 表示属性值列表太小。

4.读取 u8类型属性值
of_property_read_u8

int of_property_read_u8(const struct device_node *np, const char *propname, u8 *out_value)

np： 设备节点。
proname： 要读取的属性名字。
out_value： 读取到的数组值。
返回值： 0，读取成功，负值，读取失败，
-EINVAL 表示属性不存在， -ENODATA 表示没有要读取的数据， -EOVERFLOW 表示属性值列表太小。

5.读取属性中字符串值
of_property_read_string

int of_property_read_string(struct device_node *np, const char *propname, const char *out_string);

np： 设备节点。
proname： 要读取的属性名字。
out_string： 读取到的字符串值。
返回值： 0，读取成功，负值，读取失败。

6.获取 #address-cells 属性值
of_n_addr_cells

int of_n_addr_cells(struct device_node *np);

np： 设备节点。
返回值： 获取到的#address-cells 属性值。

7.获取 #size-cells 属性值
of_n_size_cells

int of_n_size_cells(struct device_node *np);

np： 设备节点。
返回值： 获取到的#size-cells 属性值。

其他常用的io函数

1.用于获取地址相关属性
of_get_address
主要是“reg”或者“assigned-addresses”属性 值，函数属性如下：

const __be32 *of_get_address(struct device_node *dev, int index, u64 *size, unsigned int *flags);

dev： 设备节点。
index： 要读取的地址标号。 size： 地址长度。
flags： 参数，比如 IORESOURCE_IO、IORESOURCE_MEM 等
返回值： 读取到的地址数据首地址，为 NULL 的话表示读取失败。

2.从设备树读取到的地址转换为物理地址
of_translate_address

u64 of_translate_address(struct device_node *dev, const __be32 *in_addr);

dev： 设备节点。
in_addr： 要转换的地址。
返回值： 得到的物理地址，如果为 OF_BAD_ADDR 的话表示转换失败。

3.从设备树里面提取资源值
of_address_to_resource
本质上就是将 reg 属性值，然后将其转换为 resource 结构体类型。

int of_address_to_resource(struct device_node *dev, int index, struct resource *r);

dev： 设备节点。
index： 地址资源标号。
r： 得到的 resource 类型的资源值。
返回值： 0，成功；负值，失败。

4.直接内存映射
of_iomap
以前我们会通过 ioremap来完成物理地址到虚拟地址的映射，采用设备树以后就可以直接通过 of_iomap来获取内存地址所对应的虚拟地址，不需要使用 ioremap了。该函数的原型如下：

void __iomem *of_iomap(struct device_node *np, int index);

np： 设备节点。
index： reg 属性中要完成内存映射的段，如果 reg 属性只有一段的话 index 就设置为 0。
返回值：经过内存映射后的虚拟内存首地址，如果为 NULL 的话表示内存映射失败。

GPIO相关

1.of_gpio_named_count
用于获取设备树某个属性里面定义了几个 GPIO 信息

int of_gpio_named_count(struct device_node *np, const char *propname)

np：设备节点
propname：要统计的gpio属性
返回值：正确返回统计的gpio数量，错误返回负数

2.of_gpio_count
统计gpios 这个属性的 GPIO 数量

int of_gpio_count(struct device_node *np)

np：设备节点
返回值：正确返回统计的gpio数量，错误返回负数

3.of_get_named_gpio
用于获取 GPIO 编号

int of_get_named_gpio(struct device_node *np, const char *propname, int index)

np：设备节点
propname：包含要获取 GPIO 信息的属性名
index：GPIO 索引
返回值：正确返回获取到的GPIO编号，错误返回负数