设备树常用的OF操作函数

设备树常用的OF操作函数

1、查找节点的OF函数

• 设备都是以节点的形式挂到设备树上的，因此想要获取这个设备的其他属性信息，必须先获取到这个设备的节点。
• linux内核使用device_node结构体来描述一个节点，该结构体定义在include/linux/of.h中。
• 定义如下：

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 属性 */
	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
};

1.1 of_find_node_by_name函数

• of_find_node_by_name函数通过节点名字查找指定的节点。

struct device_node *of_find_node_by_name(struct device_node *from,const char *name);
/***************************************************
 *函数参数及返回值的含义：
 *from:开始查找的节点，如果为NULL表示从根节点开始查找整个设备树。
 *name:要查找的节点的名字。
 *返回值:找到的节点；如果为NULL，查找失败。
 ***************************************************/

1.2 of_find_node_by_type函数

• of_find_node_by_type函数通过device_type查找指定的节点。

struct device_node *of_find_node_by_type(struct device_node *from,const char *type);
/***************************************************
 *函数参数及返回值的含义：
 *from:开始查找的节点，如果为NULL表示从根节点开始查找整个设备树。
 *type:要查找的节点对应的type字符串，即device_type属性值。
 *返回值:找到的节点；如果为NULL，查找失败。
 ***************************************************/

1.3 of_find_compatible_node函数

• of_find_compatible_node函数通过device_type和compatible两个属性查找指定的节点。

struct device_node *of_find_compatible_node(struct device_node *from,const char *type,const char *compatible);
/***************************************************
 *函数参数及返回值的含义：
 *from:开始查找的节点，如果为NULL表示从根节点开始查找整个设备树。
 *type:要查找的节点对应的type字符串，即device_type属性值;也可以为NULL,表示可以忽略该属性。
 *compatible:要查找的节点对应的compatible属性列表。
 *返回值:找到的节点；如果为NULL，查找失败。
 ***************************************************/

1.4 of_find_matching_node_and_match函数

• of_find_matching_node_and_match函数通过of_device_id匹配表来查找指定的节点。

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，查找失败。
 ***************************************************/

1.5 of_find_node_by_path函数

• of_find_node_by_path函数通过路径查找指定的节点。

inline struct device_node *of_find_node_by_path(const char *path);
/***************************************************
 *函数参数及返回值的含义：
 *path:带有全路径的节点名，可以使用节点的别名，比如“/backlight”就是 backlight 这个节点的全路径
 *返回值:找到的节点；如果为NULL，查找失败。
 ***************************************************/

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

2.1 of_get_parent函数

• of_get_parent函数用于获取指定节点的父节点（如果存在父节点）。

struct device_node *of_get_parent(const struct device_node *node);
/***************************************************
 *函数参数及返回值的含义：
 *node:需要查找父节点的节点。
 *返回值:找到的父节点。
 ***************************************************/

2.2 of_get_next_child函数

• of_get_next_child函数用迭代的方法查找子节点。

struct device_node *of_get_next_child(const struct device_node *node,struct device_node *prev);
/***************************************************
 *函数参数及返回值的含义：
 *node:父节点。
 *prev:前一个子节点，表示从哪一个子节点开始查找下一个子节点；可以设置为NULL，表示从第一个子节点开始查找。
 *返回值:找到的下一个子节点。
 ***************************************************/

3、提取属性值的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;
};

3.1 of_find_property函数

• of_find_property函数用于查找指定的属性。

property *of_find_property(const struct device_node *np,const char *name,int *lenp);
/***************************************************
 *函数参数及返回值的含义：
 *np:设备节点。
 *name:属性名字。
 *lenp:属性值的字节数。
 *返回值:找到的属性。
 ***************************************************/

3.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:设备节点。
 *propname:需要统计元素数量的属性名字。
 *elem_size:元素的长度。
 *返回值:得到的属性元素的数量。
 ***************************************************/

3.3 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:设备节点。
 *propname:需要读取的属性名字。
 *out_string:读取到的字符串值。
 *返回值:0，读取成功；负数，读取失败。
 ***************************************************/

4、其他常用的OF函数

4.1 of_device_is_compatible函数

• of_device_is_compatible函数用于查看节点的compatible属性是否包含compat指定的字符串，即检查设备节点的兼容性。

int of_device_is_compatible(const struct device_node *device,const char *compat);
/***************************************************
 *函数参数及返回值的含义：
 *device:设备节点。
 *compat:要查看的字符串。
 *返回值:0，节点兼容属性中不包含要查看的字符串；正数，节点兼容属性中包含要查看的字符串。
 ***************************************************/

4.2 of_translate_address函数

• of_translate_address函数用于将从设备树读取到的地址转换为物理地址。

u64 of_translate_address(struct device_node *dev,const __be32 *in_addr);
/***************************************************
 *函数参数及返回值的含义：
 *dev:设备节点。
 *in_addr:要转换的地址。
 *返回值:得到的物理地址；如果为OF_BAD_ADDR表示转换失败。
 ***************************************************/