一. 简介
驱动开发时,需要获取设备树中设备节点信息,如何获取到设备树中节点信息?
Linux 内核给我们提供了一系列的函数,来获取设备树中的节点或者属性信息,这一系列的函数都有一个统一的前缀 “of_”,所以在很多资料里面也被叫做 OF 函数。
上一篇文章学习了一些 OF 函数,文章地址如下:
本文继续学习 设备树常用 OF操作函数。
二. 设备树常用 OF操作函数
节点的属性信息里面保存了驱动所需要的内容,因此对于属性值的提取非常重要,
Linux
内
核中使用结构体
property
表示属性,此结构体同样定义在文件
include/linux/of.h
中,内容如下:
struct property {
char *name; //属性名字
int length; //属性长度
void *value; //属性值
struct property *next; //下一个属性
unsigned long _flags;
unsigned int unique_id;
struct bin_attribute attr;
};
Linux
内核也提供了提取属性值的
OF
函数,我们依次来看一下。
1. 提取属性值的 OF 函数
(1) of_find_property 函数
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 函数
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) of_property_read_u32_index 函数
of_property_read_u32_index
函数用于从属性中获取指定标号的
u32
类型数据值
(
无符号
32
位
)
,比如,某个属性有多个
u32
类型的值,那么就可以使用此函数来获取指定标号的数据值,此
函数原型如下:
int of_property_read_u32_index(const struct device_node *np,
const char *propname,
u32 index,
u32 *out_value)
函数参数和返回值含义如下:
np
:设备节点。
proname
: 要读取的属性名字。
index
:要读取的值标号。
out_value
:读取到的值
返回值:
0
读取成功,负值,读取失败,
-EINVAL
表示属性不存在,
-ENODATA
表示没有
要读取的数据,
-EOVERFLOW
表示属性值列表太小。
(4) 读取数组数据的函数
of_property_read_u8_array
函数
of_property_read_u16_array
函数
of_property_read_u32_array
函数
of_property_read_u64_array
函数
这
4
个函数分别是读取属性中
u8
、
u16
、
u32
和
u64
类型的数组数据,比如大多数的
reg
属
性都是数组数据,可以使用这
4
个函数一次读取出
reg
属性中的所有数据。这四个函数的原型
如下:
int of_property_read_u8_array(const struct device_node *np,
const char *propname, u8 *out_values, size_t sz)
int of_property_read_u16_array(const struct device_node *np,
const char *propname, u16 *out_values, size_t sz)
int of_property_read_u32_array(const struct device_node *np,
const char *propname, u32 *out_values, size_t sz)
int of_property_read_u64_array(const struct device_node *np,
const char *propname, u64 *out_values, size_t sz)
函数参数和返回值含义如下:
np
:设备节点。
proname
: 要读取的属性名字。
out_value
:读取到的数组值,分别为
u8
、
u16
、
u32
和
u64
。
sz
:
要读取的数组元素数量。
返回值:
0
,读取成功,负值,读取失败,
-EINVAL
表示属性不存在,
-ENODATA
表示没
有要读取的数据,
-EOVERFLOW
表示属性值列表太小。
(5) 读取只有一个整形值的属性
of_property_read_u8
函数
of_property_read_u16
函数
of_property_read_u32
函数
of_property_read_u64
函数
有些属性只有一个整形值,这四个函数就是用于读取这种只有一个整形值的属性,分别用
于读取
u8
、
u16
、
u32
和
u64
类型属性值,函数原型如下:
int of_property_read_u8(const struct device_node *np, const char *propname, u8* out_value)
int of_property_read_u16(const struct device_node *np, const char *propname, u16* out_value)
int of_property_read_u32(const struct device_node *np, const char *propname, u32* out_value)
int of_property_read_u64(const struct device_node *np, const char *propname, u64* out_value)
函数参数和返回值含义如下:
np
:设备节点。
proname
: 要读取的属性名字。
out_value
:读取到的数组值。
返回值:
0
,读取成功,负值,读取失败,
-EINVAL
表示属性不存在,
-ENODATA
表示没
有要读取的数据,
-EOVERFLOW
表示属性值列表太小。
(6) of_property_read_string 函数
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
,读取成功,负值,读取失败。
(7) of_n_addr_cells 函数
of_n_addr_cells
函数用于获取
#address-cells
属性值,函数原型如下:
int of_n_addr_cells(struct device_node *np)
函数参数和返回值含义如下:
np
:设备节点。
返回值:
获取到的
#address-cells
属性值。
(8) of_n_size_cells 函数
of_size_cells
函数用于获取
#size-cells
属性值,函数原型如下:
int of_n_size_cells(struct device_node *np)
函数参数和返回值含义如下:
np
:设备节点。
返回值:
获取到的
#size-cells
属性值。