DRM GEM 驱动程序开发（dumb）

前言

在上一篇《关于 DRM 中 DUMB 和 PRIME 名字的由来》 文章中，我们知道了 dumb buffer 名字的由来。本篇，我们将一起来写一个最简单的 GEM 驱动程序。

驱动程序

#include <drm/drmP.h>
#include <drm/drm_gem_cma_helper.h>

static struct drm_device drm;

static const struct file_operations mygem_fops = {
        .owner = THIS_MODULE,
        .open = drm_open,
        .release = drm_release,
        .unlocked_ioctl = drm_ioctl,
        .poll = drm_poll,
        .read = drm_read,
        .mmap = drm_gem_cma_mmap,
};

static struct drm_driver mygem_driver = {
        .driver_features        = DRIVER_GEM,
        .fops                   = &mygem_fops,

        .dumb_create            = drm_gem_cma_dumb_create,
        .gem_vm_ops             = &drm_gem_cma_vm_ops,
        .gem_free_object_unlocked = drm_gem_cma_free_object,

        .name                   = "my-gem",
        .desc                   = "My GEM Driver",
        .date                   = "20200601",
        .major                  = 1,
        .minor                  = 0,
};

static int __init mygem_init(void)
{
        drm_dev_init(&drm, &mygem_driver, NULL);
        drm_dev_register(&drm, 0);

        return 0;
}

module_init(mygem_init);

测试程序

#include <errno.h>
#include <fcntl.h>
#include <stdbool.h>
#include <stdint.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <sys/mman.h>
#include <unistd.h>
#include <xf86drm.h>
#include <xf86drmMode.h>

int main(int argc, char **argv)
{
        int fd;
        char *vaddr;
        struct drm_mode_create_dumb create_req = {};
        struct drm_mode_destroy_dumb destroy_req = {};
        struct drm_mode_map_dumb map_req = {};

        fd = open("/dev/dri/card0", O_RDWR);

        create_req.bpp = 32;
        create_req.width = 240;
        create_req.height = 320;
        drmIoctl(fd, DRM_IOCTL_MODE_CREATE_DUMB, &create_req);
        printf("create dumb: handle = %u, pitch = %u, size = %llu\n",
                create_req.handle, create_req.pitch, create_req.size);

        map_req.handle = create_req.handle;
        drmIoctl(fd, DRM_IOCTL_MODE_MAP_DUMB, &map_req);
        printf("get mmap offset 0x%llx\n", map_req.offset);

        vaddr = mmap(0, create_req.size, PROT_WRITE, MAP_SHARED, fd, map_req.offset);
        strcpy(vaddr, "This is a dumb buffer!");
        munmap(vaddr, create_req.size);

        vaddr = mmap(0, create_req.size, PROT_READ, MAP_SHARED, fd, map_req.offset);
        printf("read from mmap: %s\n", vaddr);
        munmap(vaddr, create_req.size);

        getchar();

        destroy_req.handle = create_req.handle;
        drmIoctl(fd, DRM_IOCTL_MODE_DESTROY_DUMB, &destroy_req);
        close(fd);

        return 0;
}   

描述：先创建一个 dumb buffer，然后将其 mmap 到 user-space，往里写入一串字符串，然后重新映射，读取并打印 buffer 中的内容。

运行结果

root@ubuntu:~# ./dumb 
create dumb: handle = 1, pitch = 960, size = 307200
get mmap offset 0x10000000
read from mmap: This is a dumb buffer!

驱动讲解

1. DRIVER_GEM：该 feature 告诉 DRM 框架本驱动支持 GEM 操作，如 buffer 的分配和释放，以及 GEM OPEN/FLINK/CLOSE 等操作。
2. dumb_create：分配 dumb buffer 的回调接口，主要完成三件事：
   （1）创建 gem object
   （2）创建 gem handle
   （3）分配物理 buffer （也可以等到后面再分配）
   本例中直接使用 CMA helper 函数实现，该函数内部会分配最终的物理 buffer。
3. mmap：创建 dumb buffer 的目的就是要拿去给 CPU 画图，因此没有 mmap 的 dumb buffer 是没有灵魂的，所以必须实现。通常使用 drm_gem_mmap() 来实现。
4. gem_vm_ops：主要为 mmap 服务，必须实现。下一篇文章会对它做详细介绍。

通常在看 DRM 文档时，还会提到 dumb_map_offset 和 dumb_destroy 这两个接口，分别对应各自的 ioctl 函数。如果驱动没有实现这两个回调接口， 那么 DRM 框架会使用默认的 drm_gem_dumb_map_offset() 和 drm_gem_dumb_destroy() 代替。

为什么要执行 DRM_IOCTL_MODE_MAP_DUMB ？

许多人刚开始写 dumb buffer 应用程序时都会困惑，明明有 mmap 函数，为什么中间要再插一脚 DRM_IOCTL_MODE_MAP_DUMB ？光看名字很容易让人误以为该 ioctl 是在执行 mmap 的动作，那为什么要添加这个 ioctl 呢？

要回答这个问题其实很简单，设想一下，假如你当前创建了2个 dumb buffer，你要对其中一个做 mmap 操作，请问 mmap 函数应该如何知道你当前要操作的是哪个 buffer ？因为你当前使用的是 card0 的 fd，而不是 dumb buffer 的 fd，所以你没法通过 fd 来对其进行区分。而 size 和 flag 这些参数都不能随意修改，因此只能通过 offset 参数来 workaround，从而告诉 mmap 当前具体要操作的是哪个 dumb buffer。

所以，对 drm device 进行 mmap 操作时，传进去的 offset 参数并不是真正的内存偏移量，而是一个 gem object 的索引值。通过该索引值，drm 驱动就可以准确定位到当前具体要操作的是哪个 gem object，进而获取到与该 object 相对应的物理 buffer，并对其做真正的 mmap 操作。

那如何知道某个 gem object 的索引值呢？所以才有了 DRM_IOCTL_MODE_MAP_DUMB ！你给它一个 gem handle，它返回给你一个 offset，就这么简单！而该 ioctl 对应的底层实现就是前面提到的 dumb_map_offset 回调接口。（个人认为该 ioctl 的名字改成 DRM_IOCTL_MODE_CREATE_MAP_OFFSET 可能会更好一点 :-）

这也是为什么上面的示例运行结果中，获取到的 offset 值为 0x10000000，而不是我们通常认为的偏移 0，原因就在于此（DRM 文档中将其称为 fake offset，即伪偏移）。

总结

1. 哪里有 dumb_create，哪里就有 mmap。
2. 哪里有 mmap，哪里就有 gem_vm_ops。
3. mmap 中的 offset 参数是个假的。
4. 没有 DRIVER_MODESET，DRIVER_GEM 一样可以做成一个独立的 DRM 驱动。

源码下载

Github: driver，test

参考资料

1. 杨枫_mind CSDN 博客
2. DRM Memory Management

文章汇总： DRM (Direct Rendering Manager) 学习简介