浅谈linux - 设备树应用示例

概述

在上一篇文章《浅谈linux - 描述硬件的文件设备树》已经详细介绍过设备树（device tree）的相关内容和使用方法，我们知道设备树主要用来解决kernel中的大量冗余硬编码的问题，实现内核和硬件的分离。

本文主要向读者展示设备树在实际项目中的应用，让读者充分掌握设备树在实际中的使用方法。

接口

查找设备节点

/**
 * @根据节点路径查找节点
 * @path: 节点的全路径，从根节点‘/’开始
 * @成功返回找到的节点，失败返回 NULL
 */
static inline struct device_node *of_find_node_by_path(const char *path);

获取节点指定属性信息

/**
 * @获取节点指定属性值，值只有一个元素（非数组），且数据类型为u32时使用
 * @np: 节点        propname：属性名，如：compatible、reg等     out_value/out_string：保存值
 * @成功返回0，-EINVAL 表示属性不存在， -ENODATA 表示没有要读取的数据， -EOVERFLOW 表示属性值列表太小
 */
static inline int of_property_read_u32(const struct device_node *np, const char *propname, u32 *out_value);


/**
 * @当节点属性有多个元素（数组）时，获取节点指定属性值，u32类型数据读取
 * @np: 节点        propname：属性名，如：compatible、reg等     out_value：保存值       sz:数组元素个数
 * @成功返回0，-EINVAL 表示属性不存在， -ENODATA 表示没有要读取的数据， -EOVERFLOW 表示属性值列表太小
 */
extern int of_property_read_u32_array(const struct device_node *np, const char *propname, u32 *out_values, size_t sz);

直接内存地址映射，将节点reg信息中的内存地址直接映射到虚拟地址

/**
 * 直接内存映射，位置：linux/of_address.h
 * @node：节点  index：reg属性中要完成内存映射的段，如果reg属性只有一段的话index就设置为0
 * @映射完成后的地址
**/
void __iomem *of_iomap(struct device_node *node, int index);

物理地址到虚拟地址的映射与解除映射

/* ioremap用于物理地址到虚拟地址的映射，iounmap用于解除映射 */
extern void __iomem *__ioremap(phys_addr_t phys_addr, size_t size, pgprot_t prot);
extern void __iounmap(volatile void __iomem *addr);

#define ioremap(addr, size)        __ioremap((addr), (size), __pgprot(PROT_DEVICE_nGnRE))
#define iounmap                    __iounmap

注意：寄存器地址映射包含两种方法。

a. 调用of_iomap完成reg中的寄存器地址直接映射。 

b. 先获取reg信息，再调用ioremap完成地址映射。

/* 设备树中寄存器地址映射方法1 */
unsigned int tmp_reg[REG_NUM * 2];

/* 查找reg属性，对应为寄存器地址信息 */ 
if (of_property_read_u32_array(np, "reg", tmp_reg, REG_NUM*2) == 0) 
    return;

/* 地址映射 */ 
for (i=0; i<REG_NUM; i++) 
    reg_buf[i] = ioremap(tmp_reg[2*i], tmp_reg[2*i+1]);

/* 设备树中寄存器地址映射方法2 */    
/* 查找寄存器地址并映射 */ 
for (i=0; i<REG_NUM; i++)
    reg_buf[i] = of_iomap(np, i);

示例

★示例将LED设备硬件信息编译到设备树，通过bootloder传递给内核，驱动通过内核提供的相关接口获取硬件资源，并完成LED相关操作。

★示例采用正点原子的阿尔法开发板进行验证，关于硬件寄存器等操作在之前的文章《浅谈linux - 地址映射ioremap》已经详细介绍过，不清楚的读者可以前往查看。

★包含驱动头文件devtree.h和源文件devtree.c、设备树源文件atomic.dts（只截取了测试部分的设备树内容）、应用测试程序main.c以及编译规则文件Makefile（均已验证通过）。

 devtree.h

/**
 * @Filename : devtree.h
 * @Revision : $Revision: 1.00 $
 * @Author : Feng(更多编程相关的知识和源码见微信公众号：不只会拍照的程序猿，欢迎订阅)
 * @Description : 设备树驱动示例
**/
#ifndef __DEVTREE_H__
#define __DEVTREE_H__

#include <linux/init.h>
#include <linux/module.h>
#include <linux/platform_device.h>
#include <linux/fs.h>
#include <linux/miscdevice.h>
#include <linux/uaccess.h> 
#include <linux/io.h> //ioremap/iounmap
#include "chrdev.h"
#include <linux/device.h>
#include <linux/of.h>
#include <linux/of_address.h>
#include <linux/of_gpio.h>

#define LED_ON  0x100001
#define LED_OFF 0x100002

/* 寄存器数组偏移 */
#define REG_NUM    5
#define CCM_CCGR1_BASE                 0
#define SW_MUX_GPIO1_IO03_BASE    1
#define SW_PAD_GPIO1_IO03_BASE    2
#define GPIO1_DR_BASE             3
#define GPIO1_GDIR_BASE         4

/* 驱动类定义 */
struct class_led {
    struct class_chrdev *chrdev;     /* 字符设备对象 */
    void __iomem *reg[REG_NUM];      /* 保存映射后的寄存器信息 */
    struct device_node *np;          /* 设备树中的节点 */
    unsigned int pin;                /* 引脚信息 */
    unsigned int reg_buf[REG_NUM*2]; /* 保存reg信息 */
};

#endif

 devtree.c

/**
 * @Filename : devtree.c
 * @Revision : $Revision: 1.00 $
 * @Author : Feng(更多编程相关的知识和源码见微信公众号：不只会拍照的程序猿，欢迎订阅)
 * @Description : 设备树驱动示例
**/
#include "devtree.h"

struct class_led fengled;

/**
 * @LED控制
 * @cmd: LED_ON打开LED，else关闭LED
 */
static long led_ioctl(struct file *file, unsigned int cmd, unsigned long buf);

static struct file_operations led_fops = {
    .unlocked_ioctl = led_ioctl
};

/**
 * @打开LED
 * @addr: 寄存器地址     pin：引脚号
 */
static void _led_on(void __iomem * addr, int pin)
{
    unsigned int val = readl(addr);

    val &= ~(1 << pin);
    writel(val, addr);

    printk("led on...\n");
}

/**
 * @关闭LED
 * @addr: 寄存器地址     pin：引脚号
 */
static void _led_off(void __iomem * addr, int pin)
{
    unsigned int val = readl(addr);

    val |= (1 << pin);
    writel(val, addr);

    printk("led off...\n");
}

/**
 * @初始化LED相关寄存器
 * @addr: 寄存器地址（虚拟地址）     pin：引脚号
 */
static void _led_init(void __iomem *reg[], int pin)
{
    unsigned int val;

    /* 使能 GPIO1 时钟 */
    val = readl(reg[CCM_CCGR1_BASE]);
    val &= ~(3 << 26);
    val |= (3 << 26);
    writel(val, reg[CCM_CCGR1_BASE]);

     /* 设置 GPIO1_IO03 的复用功能，将其复用为GPIO1_IO03，最后设置 IO 属性。*/
    writel(5, reg[SW_MUX_GPIO1_IO03_BASE]);
    /* 寄存器 SW_PAD_GPIO1_IO03 设置 IO 属性 */
    writel(0x10B0, reg[SW_PAD_GPIO1_IO03_BASE]);

    /* 设置 GPIO1_IO03 为输出功能 */
    val = readl(reg[GPIO1_GDIR_BASE]);
    val &= ~(1 << pin);
    val |= (1 << pin);
    writel(val, reg[GPIO1_GDIR_BASE]);

    /* 默认关闭 LED */
    val = readl(reg[GPIO1_DR_BASE]);
    val |= (1 << pin);
    writel(val, reg[GPIO1_DR_BASE]);
}

/**
 * @查找设备树，获取设备硬件信息
 * @np: 设备节点        reg_buf：保存映射后的寄存器信息     pin：保存引脚信息
 * @成功返回0，失败返回-1
 */
static int _led_dts_info_get(struct device_node *np, 
                            void __iomem *reg_buf[], unsigned int *pin)
{
    int i;

    /* 从根目录开始查找指定的设备节点 */ 
    if ((np = of_find_node_by_path("/feng_alpha_led@020C406C")) == NULL) {
        printk("feng_alpha_led@020C406C node not found...\n");
        return -1;
    } else {
        printk("feng_alpha_led@020C406C node found...\n");
    }

#if 0
    unsigned int tmp_reg[REG_NUM * 2];

    /* 查找reg属性，对应为寄存器地址信息 */ 
    if (of_property_read_u32_array(np, "reg", tmp_reg, REG_NUM*2) == 0) {
        printk("reg:");
        for (i=0; i<REG_NUM*2; i++)
            printk("0x%x ", tmp_reg[i]);
        printk("\n");       
    } else {
        printk("reg not found...\n");
    }

    /* 地址映射 */ 
    for (i=0; i<REG_NUM; i++) 
        reg_buf[i] = ioremap(tmp_reg[2*i], tmp_reg[2*i+1]);
#else
    /* 查找寄存器地址并映射 */ 
    for (i=0; i<REG_NUM; i++)
        reg_buf[i] = of_iomap(np, i);
#endif
    /* 查找pin属性，对应为引脚信息 */ 
    if (of_property_read_u32(np, "pin", pin) == 0)
        printk("pin[%d] is found...\n", *pin);
    else
        printk("pin is not found...\n");

    return 0;
}

/**
 * @LED控制
 * @cmd: LED_ON打开LED，else关闭LED
 */
static long led_ioctl(struct file *file, unsigned int cmd, unsigned long buf)
{
    if (cmd == LED_ON) 
        _led_on(fengled.reg[GPIO1_DR_BASE], fengled.pin);
     else 
         _led_off(fengled.reg[GPIO1_DR_BASE], fengled.pin);

    return 0;
}

/**
 * @模块入口函数
 */
static int __init led_drv_init(void)
{
    /* 查找设备树，获取硬件信息，完成内存地址映射 */
    if (_led_dts_info_get(fengled.np, fengled.reg, &fengled.pin) == -1) {
        printk("not found hardware message...\n");
        return -1;
    }

    _led_init(fengled.reg, fengled.pin);    /* 初始化LED */

    /* 注册设备 */
    if ((fengled.chrdev = chrdev_create("cls_dtled", "chr_dtled", 
                                    "feng_dtled", &led_fops)) == NULL) {
        printk("create char device error...\n");
        return -1;
    }

    return 0;
}

/**
 * @模块出口函数
 */
static void __exit led_drv_exit(void)
{
    int i;

    /* 解除内存地址映射 */
    for (i=0; i<REG_NUM; i++)
        iounmap(fengled.reg[i]);

    /* 释放设备 */
    chrdev_destroy(fengled.chrdev);

    printk("platform drv remove...\n");
}

module_init(led_drv_init);
module_exit(led_drv_exit);
MODULE_LICENSE("GPL");

/* 调用modinfo xx(模块名)查看 */
MODULE_AUTHOR("feng");         /* 模块的作者 */
MODULE_VERSION ("1.00");       /* 模块版本号 */
/* MODULE_DESCRIPTION("xxxxx");   模块描述 */
/* MODULE_ALIAS("xxx");           模块别名 */

 atomic.dts

feng_alpha_led@020C406C {
    #address-cells = <1>;
    #size-cells = <1>;
    compatible = "atkalpha-led";
    reg = < 
        0X020C406C 0X04 /* CCM_CCGR1_BASE */
        0X020E0068 0X04 /* SW_MUX_GPIO1_IO03_BASE */
        0X020E02F4 0X04 /* SW_PAD_GPIO1_IO03_BASE */
        0X0209C000 0X04 /* GPIO1_DR_BASE */
        0X0209C004 0X04 /* GPIO1_GDIR_BASE */
    >; 
    pin = <3>;
};

 main.c

/**
 * @Filename : main.c
 * @Revision : $Revision: 1.00 $
 * @Author : Feng(更多编程相关的知识和源码见微信公众号：不只会拍照的程序猿，欢迎订阅)
 * @Description : led设备应用示例
**/

/*调试宏*/
#define DEBUG

#ifdef DEBUG
#define pr_debug(fmt, ...) printf(fmt, ##__VA_ARGS__)
#else
#define pr_debug(fmt, ...) 
#endif

/*头文件*/
#include <stdio.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <sys/ioctl.h>
#include <fcntl.h>
#include <string.h>

#define LED_ON           0x100001
#define LED_OFF          0x100002

#define LED_DEV_FILE    "/dev/feng_dtled"

/**
 * @主函数
 * @用户输入/home/app/main on 1   打开LED
**/
int main(int argc, char *argv[])
{
    int fd;
    int num = 1;

    if (argc != 3)  {
        pr_debug("Usage: %s <on|off> <1|2|3|4>\n", argv[0]);
        return -1;
    }

    if ((fd = open(LED_DEV_FILE, O_RDWR)) < 0) {
        pr_debug("file open failed...\n");
        return -1;
    }

    num = strtoul(argv[2], NULL, 0);

    if (!strcmp(argv[1], "on"))
        ioctl(fd, LED_ON, &num);
    else if (!strcmp(argv[1], "off"))
        ioctl(fd, LED_OFF, &num);
    else
        pr_debug("input commend wrong...\n");

    close(fd);
    return 0;
}

 Makefile

#根文件所在目录
ROOTFS_DIR = /home/feng/atomic/rootfs

#交叉编译工具链
CROSS_COMPILE = arm-linux-gnueabihf-
CC = $(CROSS_COMPILE)gcc

#目标文件名
TAR_NAME = devtree

#应用程序名字
APP_NAME = led

#驱动目录路径
DRV_DIR = $(ROOTFS_DIR)/home/drv
DRV_DIR_LIB = $(ROOTFS_DIR)/lib/modules/4.1.15

#动态库目录路径
LIB_DIR = $(ROOTFS_DIR)/home/lib

#应用程序目录路径
APP_DIR = $(ROOTFS_DIR)/home/app

#KERNELRELEASE由内核makefile赋值
ifeq ($(KERNELRELEASE), )

#内核路径
KERNEL_DIR =/home/feng/atomic/resource/linux-imx-rel_imx_4.1.15_2.1.0_ga

#当前文件路径
CURR_DIR = $(shell pwd)

all:
    #编译模块
    make -C $(KERNEL_DIR) M=$(CURR_DIR) modules

    #编译应用程序
    -$(CC) -o $(APP_NAME) main.c

clean:
    #清除模块文件
    make -C $(KERNEL_DIR) M=$(CURR_DIR) clean

    #清除应用文件
    -rm $(APP_NAME)

install:
    #拷贝模块文件
    #cp -raf $(TAR_KEY_NAME)_drv.ko $(TAR_KEY_NAME)_dev.ko $(DRV_DIR)
    #cp -raf keyin.ko wq.ko timer.ko $(DRV_DIR_LIB)
    cp -raf *.ko $(DRV_DIR_LIB)

    #拷贝应用文件
    -cp -raf $(APP_NAME) $(APP_DIR)
else
#指定编译什么文件
obj-m += $(TAR_NAME).o chrdev.o
#obj-m += $(TAR_NAME).o 

endif

结论

1、进入内核目录，执行make dtbs命令编译设备树；然后执行./cp_kernel.sh命令，拷贝设备树文件到tftp目录。

feng:linux-imx-rel_imx_4.1.15_2.1.0_ga$ make dtbs
  CHK     include/config/kernel.release
  CHK     include/generated/uapi/linux/version.h
  CHK     include/generated/utsrelease.h
make[1]: “include/generated/mach-types.h”已是最新。
  CHK     include/generated/bounds.h
  CHK     include/generated/asm-offsets.h
  CALL    scripts/checksyscalls.sh
  DTC     arch/arm/boot/dts/atomic.dtb
feng:linux-imx-rel_imx_4.1.15_2.1.0_ga$ ./cp_kernel.sh 
feng:linux-imx-rel_imx_4.1.15_2.1.0_ga$ 

2、重启目标机，进入设备树目录（/proc/device-tree），查看相关设备节点是否挂载成功。

/ # cd /proc/device-tree/
/sys/firmware/devicetree/base # ls
#address-cells              feng_alpha_led@020C406C
#size-cells                 feng_alpha_pf_gpioled
aliases                     interrupt-controller@00a01000
backlight                   memory
chosen                      model
clocks                      name
compatible                  pxp_v4l2
cpus                        regulators
fdts@77777777               reserved-memory
feng_alpha_gpiobeep         soc
feng_alpha_gpiokey          sound
feng_alpha_gpioled          spi4
/sys/firmware/devicetree/base # 

3、进入设备节点目录，查看设备节点信息。

/sys/firmware/devicetree/base # cd feng_alpha_led@020C406C/
/sys/firmware/devicetree/base/feng_alpha_led@020C406C # ls
#address-cells  compatible      pin
#size-cells        name                reg
/sys/firmware/devicetree/base/feng_alpha_led@020C406C # cat compatible 
atkalpha-led/sys/firmware/devicetree/base/feng_alpha_led@020C406C # cat name
feng_alpha_led/sys/firmware/devicetree/base/feng_alpha_led@020C406C # 

4、进入模块目录，执行make命令编译模块；然后执行make install命令，拷贝模块到目标机指定目录。

feng:devtree$ make
#编译模块
make -C /home/feng/atomic/resource/linux-imx-rel_imx_4.1.15_2.1.0_ga M=/mnt/hgfs/Share/linux/atomic/driver/led/devtree modules
make[1]: 进入目录“/home/feng/atomic/resource/linux-imx-rel_imx_4.1.15_2.1.0_ga”
  CC [M]  /mnt/hgfs/Share/linux/atomic/driver/led/devtree/devtree.o
  CC [M]  /mnt/hgfs/Share/linux/atomic/driver/led/devtree/chrdev.o
  Building modules, stage 2.
  MODPOST 2 modules
  CC      /mnt/hgfs/Share/linux/atomic/driver/led/devtree/chrdev.mod.o
  LD [M]  /mnt/hgfs/Share/linux/atomic/driver/led/devtree/chrdev.ko
  CC      /mnt/hgfs/Share/linux/atomic/driver/led/devtree/devtree.mod.o
  LD [M]  /mnt/hgfs/Share/linux/atomic/driver/led/devtree/devtree.ko
make[1]: 离开目录“/home/feng/atomic/resource/linux-imx-rel_imx_4.1.15_2.1.0_ga”
#编译应用程序
arm-linux-gnueabihf-gcc -o led main.c
feng:devtree$ make install 
#拷贝模块文件
#cp -raf _drv.ko _dev.ko /home/feng/atomic/rootfs/home/drv
#cp -raf keyin.ko wq.ko timer.ko /home/feng/atomic/rootfs/lib/modules/4.1.15
cp -raf *.ko /home/feng/atomic/rootfs/lib/modules/4.1.15
#拷贝应用文件
cp -raf led /home/feng/atomic/rootfs/home/app
feng:devtree$ 

5、在目标机上执行modprobe命令加载模块。

注意：在模块加载之前，需要先调用depmod命令，生成模块依赖文件。

/ # depmod
/ # modprobe devtree.ko
feng_alpha_led@020C406C node found...
pin[3] is found...
register chrdev ok...
/ # 

6、在目标机上运行应用测试程序打开LED，观察开发板LED是否点亮。

/ # /home/app/led on 1
led on...
/ # 

7、在目标机上运行应用测试程序关闭LED，观察开发板LED是否熄灭。

/ # /home/app/led off 1
led off...
/ # 

8、在目标机上执行modprobe -r命令卸载模块。

/ # modprobe -r devtree.ko
platform drv remove...
/ # lsmod
Module                  Size  Used by    Tainted: G  
/ # 

9、综上、示例将LED设备信息编译到设备树，通过bootloader传递给内核，并在驱动中获取相关设备信息，完成LED驱动相关操作。

往期 · 推荐

浅谈linux - 字符设备框架

帮你自动化办公的python-自动提取pdf指定页（项目概述）

也没想象中那么神秘的数据结构-一种通用化的双向链表设计（底层源码）

也没想象中那么神秘的数据结构-一环扣一环的“链表”（双向链表）

我用C语言玩对象，偷偷关注着你的观察者模式（基类设计）

关注

更多精彩内容，请关注微信公众号：不只会拍照的程序猿，本人致力分享linux、设计模式、C语言、嵌入式、编程相关知识，也会抽空分享些摄影相关内容，同样也分享大量摄影、编程相关视频和源码，另外你若想要本文章源码请关注公众号：不只会拍照的程序猿，后台回复：linux驱动源码。