设备树相关
查找节点的of函数
of_find_node_by_name
struct device_node *of_find_node_by_name(struct device_node *from, const char *name);
通过节点名字查找指定的节点
from：要开始查找的节点name：节点名字
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 表示查找失败。
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，表示忽略掉 device_type 属性。
compatible： 要查找的节点所对应的 compatible 属性列表。
返回值： 找到的节点，如果为 NULL 表示查找失败
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 表示查找失败
of_find_node_by_path
过路径来查找指定的节点，函数原型如下：
inline struct device_node *of_find_node_by_path(const char *path);
函数参数和返回值含义如下：
path：带有全路径的节点名，可以使用节点的别名，比如“/backlight”就是 backlight 这个节点的全路径。返回值：找到的节点，如果为 NULL 表示查找失败
查找父子节点的函数
of_get_parent
用于获取指定节点的父节点，原型如下：
struct device_node *of_get_parent(const struct device_node *node);
函数参数和返回值含义如下：
node：需要查找父节点的子节点；返回值：返回父节点；
of_get_next_child
用迭代的查找子节点，函数原型如下：
struct device_node *of_get_next_child(const struct device_node *node, struct device_node *prev);
函数参数和返回值含义如下：
node：父节点；prev：前一个子节点，也就是从哪一个子节点开始迭代的查找下一个子节点。可以设置为NULL，表示从第一个子节点开始。返回值：找到的下一个子节点。
提取属性的of函数
of_find_property
用于查找指定的属性，函数原型如下：
property *of_find_property(const struct device_node *np, const char *name, int *lenp);
函数参数和返回值含义如下：
np：设备节点；name：属性名字；lenp：属性值的字节数；
返回值： 找到的属性。
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：元素长度。
返回值： 得到的属性元素数量。
of_property_read_u8_array
从属性中查找并读取 u8 数组，此函数原型如下：
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 表示属性值列表太小。
of_property_read_u8
读取 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 表示属性值列表太小。
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，读取成功，负值，读取失败。
of_n_addr_cells
用于获取 #address-cells 属性值，函数原型如下：
int of_n_addr_cells(struct device_node *np);
函数参数和返回值含义如下：
np：设备节点。返回值：获取到的#address-cells 属性值。
of_n_size_cells
用于获取 #size-cells 属性值，函数原型如下：
int of_n_size_cells(struct device_node *np);
函数参数和返回值含义如下：
np：设备节点。
返回值： 获取到的#size-cells 属性值。
其他常用of函数
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 的话表示读取失败。
of_translate_address
负责将从设备树读取到的地址转换为物理地址，函数原型如下：
u64 of_translate_address(struct device_node *dev, const __be32 *in_addr);
函数参数和返回值含义如下：
dev：设备节点。in_addr：要转换的地址。
返回值： 得到的物理地址，如果为 OF_BAD_ADDR 的话表示转换失败。
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，成功；负值，失败。
of_iomap
用于直接内存映射，以前我们会通过 ioremap来完成物理地址到虚拟地址的映射，采用设备树以后就可以直接通过 of_iomap来获取内存地址所对应的虚拟地址，不需要使用 ioremap了。该函数的原型如下：
void __iomem *of_iomap(struct device_node *np, int index);
函数参数和返回值含义如下：
np：设备节点。index：reg 属性中要完成内存映射的段，如果 reg 属性只有一段的话 index 就设置为 0。返回值：经过内存映射后的虚拟内存首地址，如果为 NULL 的话表示内存映射失败。
GPIO相关
GPIO子系统相关函数
gpio_request
申请一个GPIO
int gpio_request(unsigned gpio, const char *label)
gpio：管脚号；
label：管脚名，可以为空（NULL）
返回值：成功返回0，失败返回错误码
gpio_free
释放注册的GPIO
void gpio_free(unsigned gpio)
gpio：管脚号
gpio_direction_input
设置GPIO为输入，函数原型如下：
int gpio_direction_input(unsigned gpio)
gpio：管脚号
返回值：成功返回0，失败返回错误码
gpio_get_value
获取GPIO输入值，函数原型如下：
int gpio_get_value(unsigned gpio)
gpio：管脚号
返回值：0或1
gpio_set_value
设置GPIO控制值，函数原型如下：
void gpio_set_value(unsigned gpio, int value)
gpio：管脚号；
value：控制值，0或1
与GPIO相关的of函数
of_gpio_named_count
用于获取设备树某个属性里面定义了几个 GPIO 信息，函数原型如下：
int of_gpio_named_count(struct device_node *np, const char *propname)
np：设备节点
propname：要统计的gpio属性
返回值：正确返回统计的gpio数量，错误返回负数
of_gpio_count
用于统计gpios 这个属性的 GPIO 数量，函数原型如下：
int of_gpio_count(struct device_node *np)
np：设备节点
返回值：正确返回统计的gpio数量，错误返回负数
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编号，错误返回负数
devm相关
clock
devm_clk_get
用于获取时钟源，函数原型如下：
struct clk *devm_clk_get(struct device *dev, const char *id);
dev：device设备
id：时钟源名字，可以为NULL
返回值：正确返回struct clk指针，错误返回NULL
devm_clk_put
用于释放时钟源，函数原型如下：
void devm_clk_put(struct device * dev, struct clk * clk);
dev：device设备
id：时钟源名字
iomap
devm_ioremap_resource
先申请，后映射物理内存，函数原型如下：
void __iomem *devm_ioremap_resource(struct device *dev, const struct resource *res);
dev：device设备
res：resource资源
返回值：成功返回虚拟地址指针，识别返回错误码
devm_iounmap
释放之前映射的地址，函数原型如下：
void devm_iounmap(struct device *dev, void __iomem *addr);
dev：device设备
addr：要释放的虚拟地址
irq
devm_request_irq
用于注册中断服务函数，函数原型如下：
int devm_request_irq(struct device *dev, unsigned int irq, irq_handle_t handle, unsigned int flags, const char *name, void* dev_id);
dev：device设备
irq：中断号，可以通过platform_get_irq获得
handle：中断处理函数
flags：中断触发方式，上升沿/下降沿等
name：中断名称
dev_id：中断共享时用到，一般设置为结构体或NULL
devm_free_irq
用于释放devm_request_irq注册的中断，函数原型如下：
void devm_free_irq(struct device *dev, unsigned int irq, void *dev_id)
dev：device设备
irq：中断号，与devm_request_irq注册的对应
dev_id：与devm_request_irq注册的对应
mem
devm_kmalloc
分配的内存物理上连续（虚拟上也连续），只能在低端内存分配（直接内存映射区），函数原型如下：
void *kmalloc(size_t size, gfp_t gfp)；
size：分配的大小
gfp：申请内存的类型标志
devm_kzalloc
与devm_kmalloc类似，只不过devm_kzalloc会对申请到的内存内容清零，函数原型如下：
void * devm_kzalloc (struct device * dev, size_t size, gfp_t gfp);
dev：device设备
size：申请内存的大小
gfp：申请内存的类型标志
devm_kfree
devm_kmalloc()和devm_kzalloc()申请的内存必须调用devm_kfree()释放，函数原型如下：
void devm_kfree(struct device *dev, void *p);
dev：device设备
p：内存指针
pinctrl
devm_pinctrl_get
用于获取pin操作句柄，函数原型如下：
struct pinctrl * devm_pinctrl_get(struct device *dev);
dev：device设备
返回值：pinctrl句柄
devm_pinctrl_put
用于释放pin操作句柄，函数原型如下：
void devm_pinctrl_put(struct pinctrl *p);
p：pinctrl句柄
以上就是比较常用的一些接口，当然像devm的接口还有很多，这里只列举clock、mem等会经常用到的接口。
end
关注我，回复【加群】，进入嵌入式技术交流群，一起交流学习~
猜你喜欢：
