DRM应用程序进阶 （atomic-plane）

前言

在上一篇《DRM应用程序进阶（atomic-crtc）》文章中，我们学习了如何通过libdrm的atomic接口实现modeseting的操作。本篇，我们将一起来学习如何通过atomic接口，来实现 drmModeSetPlane() 相同的操作。

Atomic Commit

plane update的atomic操作如下：

drmModeAtomicAddProperty(req, plane_id, property_crtc_id, crtc_id);
drmModeAtomicAddProperty(req, plane_id, property_fb_id, fb_id);
drmModeAtomicAddProperty(req, plane_id, property_crtc_x, crtc_x);
drmModeAtomicAddProperty(req, plane_id, property_crtc_y, crtc_y);
drmModeAtomicAddProperty(req, plane_id, property_crtc_w, crtc_w);
drmModeAtomicAddProperty(req, plane_id, property_crtc_h, crtc_h);
drmModeAtomicAddProperty(req, plane_id, property_src_x, src_x);
drmModeAtomicAddProperty(req, plane_id, property_src_y, src_y);
drmModeAtomicAddProperty(req, plane_id, property_src_w, src_w << 16);
drmModeAtomicAddProperty(req, plane_id, property_src_h, src_h << 16);
drmModeAtomicCommit(fd, req, flags, NULL);

以上各项参数与drmModeSetPlane() 的参数一一对应：

drmModeSetPlane(fd, plane_id, crtc_id, fb_id, flags,
                crtc_x, crtc_y, crtc_w, crtc_h,
                src_x << 16, src_y << 16, src_w << 16, src_h << 16)

其中，参数 flags 可以是如下值的组合：

• DRM_MODE_PAGE_FLIP_EVENT: 请求底层驱动发送PAGE_FLIP事件，上层应用需要调用 drmHandleEvent() 来接收并处理相应事件，详见《最简单的DRM应用程序 （page-flip）》。
• DRM_MODE_ATOMIC_TEST_ONLY: 仅用于试探本次commit操作是否能成功，不会操作真正的硬件寄存器。不能和 DRM_MODE_PAGE_FLIP_EVENT 同时使用。
• DRM_MODE_ATOMIC_NONBLOCK: 允许本次commit操作异步执行，即无需等待上一次commit操作彻底执行完成，就可以发起本次操作。drmModeAtomicCommit() 默认以BLOCK（同步）方式执行。
• DRM_MODE_ATOMIC_ALLOW_MODESET: 告诉底层驱动，本次commit操作修改到了modeseting相关的参数，需要执行一次full modeset动作。

当然，flags 参数为0也是可以的。

drmModeAtomicCommit() 与 drmModeSetPlane() 对比，具有如下优势：

drmModeAtomicCommit	drmModeSetPlane
支持异步调用	只能同步调用
一次调用可以更新多个plane	每次调用只能更新1个plane
支持test功能，提前预知调用结果	不支持

Property Commit

如果你从事过Android底层开发，你会发现在Android external/libdrm 的某些release分支上，会多出 drmModePropertySetAdd()、drmModePropertySetCommit() 等这类函数接口，而在libdrm的社区主线仓库mesa/drm中，其实是找不到这样的接口的。该接口最初由Ville Syrjälä 和 Sean Paul于2012年提交到libdrm的一个临时分支上，后来又被cherry-pick到Android的libdrm仓库中，点此链接查看提交记录。

伪代码

pset = drmModePropertySetAlloc();
drmModePropertySetAdd(pset, object_id, property_id, property_value);
drmModePropertySetCommit(fd, flags, data, pset);
drmModePropertySetFree(pset);

由于这些接口的用法同主线中的Atomic接口大同小异，因此不做详细描述。

参考代码

基于上一篇 modeset-atomic-crtc 程序，我们使用atomic接口替换 drmModeSetPlane() 函数，具体如下：

modeset-atomic-plane.c

#define _GNU_SOURCE
#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 <time.h>
#include <unistd.h>
#include <xf86drm.h>
#include <xf86drmMode.h>

struct buffer_object {
	uint32_t width;
	uint32_t height;
	uint32_t pitch;
	uint32_t handle;
	uint32_t size;
	uint8_t *vaddr;
	uint32_t fb_id;
};

struct buffer_object buf;

static int modeset_create_fb(int fd, struct buffer_object *bo)
{
	struct drm_mode_create_dumb create = {};
 	struct drm_mode_map_dumb map = {};

	create.width = bo->width;
	create.height = bo->height;
	create.bpp = 32;
	drmIoctl(fd, DRM_IOCTL_MODE_CREATE_DUMB, &create);

	bo->pitch = create.pitch;
	bo->size = create.size;
	bo->handle = create.handle;
	drmModeAddFB(fd, bo->width, bo->height, 24, 32, bo->pitch,
			   bo->handle, &bo->fb_id);

	map.handle = create.handle;
	drmIoctl(fd, DRM_IOCTL_MODE_MAP_DUMB, &map);

	bo->vaddr = mmap(0, create.size, PROT_READ | PROT_WRITE,
			MAP_SHARED, fd, map.offset);

	memset(bo->vaddr, 0xff, bo->size);

	return 0;
}

static void modeset_destroy_fb(int fd, struct buffer_object *bo)
{
	struct drm_mode_destroy_dumb destroy = {};

	drmModeRmFB(fd, bo->fb_id);

	munmap(bo->vaddr, bo->size);

	destroy.handle = bo->handle;
	drmIoctl(fd, DRM_IOCTL_MODE_DESTROY_DUMB, &destroy);
}

static uint32_t get_property_id(int fd, drmModeObjectProperties *props,
				const char *name)
{
	drmModePropertyPtr property;
	uint32_t i, id = 0;

	for (i = 0; i < props->count_props; i++) {
		property = drmModeGetProperty(fd, props->props[i]);
		if (!strcmp(property->name, name))
			id = property->prop_id;
		drmModeFreeProperty(property);

		if (id)
			break;
	}

	return id;
}

int main(int argc, char **argv)
{
	int fd;
	drmModeConnector *conn;
	drmModeRes *res;
	drmModePlaneRes *plane_res;
	drmModeObjectProperties *props;
	drmModeAtomicReq *req;
	uint32_t conn_id;
	uint32_t crtc_id;
	uint32_t plane_id;
	uint32_t blob_id;
	uint32_t property_crtc_id;
	uint32_t property_mode_id;
	uint32_t property_active;
	uint32_t property_fb_id;
	uint32_t property_crtc_x;
	uint32_t property_crtc_y;
	uint32_t property_crtc_w;
	uint32_t property_crtc_h;
	uint32_t property_src_x;
	uint32_t property_src_y;
	uint32_t property_src_w;
	uint32_t property_src_h;

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

	res = drmModeGetResources(fd);
	crtc_id = res->crtcs[0];
	conn_id = res->connectors[0];

	drmSetClientCap(fd, DRM_CLIENT_CAP_UNIVERSAL_PLANES, 1);
	plane_res = drmModeGetPlaneResources(fd);
	plane_id = plane_res->planes[0];

	conn = drmModeGetConnector(fd, conn_id);
	buf.width = conn->modes[0].hdisplay;
	buf.height = conn->modes[0].vdisplay;

	modeset_create_fb(fd, &buf);

	drmSetClientCap(fd, DRM_CLIENT_CAP_ATOMIC, 1);

	props = drmModeObjectGetProperties(fd, conn_id,	DRM_MODE_OBJECT_CONNECTOR);
	property_crtc_id = get_property_id(fd, props, "CRTC_ID");
	drmModeFreeObjectProperties(props);

	props = drmModeObjectGetProperties(fd, crtc_id, DRM_MODE_OBJECT_CRTC);
	property_active = get_property_id(fd, props, "ACTIVE");
	property_mode_id = get_property_id(fd, props, "MODE_ID");
	drmModeFreeObjectProperties(props);

	drmModeCreatePropertyBlob(fd, &conn->modes[0],
				sizeof(conn->modes[0]), &blob_id);

	req = drmModeAtomicAlloc();
	drmModeAtomicAddProperty(req, crtc_id, property_active, 1);
	drmModeAtomicAddProperty(req, crtc_id, property_mode_id, blob_id);
	drmModeAtomicAddProperty(req, conn_id, property_crtc_id, crtc_id);
	drmModeAtomicCommit(fd, req, DRM_MODE_ATOMIC_ALLOW_MODESET, NULL);
	drmModeAtomicFree(req);

	printf("drmModeAtomicCommit SetCrtc\n");
	getchar();

    /* get plane properties */
	props = drmModeObjectGetProperties(fd, plane_id, DRM_MODE_OBJECT_PLANE);
	property_crtc_id = get_property_id(fd, props, "CRTC_ID");
	property_fb_id = get_property_id(fd, props, "FB_ID");
	property_crtc_x = get_property_id(fd, props, "CRTC_X");
	property_crtc_y = get_property_id(fd, props, "CRTC_Y");
	property_crtc_w = get_property_id(fd, props, "CRTC_W");
	property_crtc_h = get_property_id(fd, props, "CRTC_H");
	property_src_x = get_property_id(fd, props, "SRC_X");
	property_src_y = get_property_id(fd, props, "SRC_Y");
	property_src_w = get_property_id(fd, props, "SRC_W");
	property_src_h = get_property_id(fd, props, "SRC_H");
	drmModeFreeObjectProperties(props);

    /* atomic plane update */
	req = drmModeAtomicAlloc();
	drmModeAtomicAddProperty(req, plane_id, property_crtc_id, crtc_id);
	drmModeAtomicAddProperty(req, plane_id, property_fb_id, buf.fb_id);
	drmModeAtomicAddProperty(req, plane_id, property_crtc_x, 50);
	drmModeAtomicAddProperty(req, plane_id, property_crtc_y, 50);
	drmModeAtomicAddProperty(req, plane_id, property_crtc_w, 320);
	drmModeAtomicAddProperty(req, plane_id, property_crtc_h, 320);
	drmModeAtomicAddProperty(req, plane_id, property_src_x, 0);
	drmModeAtomicAddProperty(req, plane_id, property_src_y, 0);
	drmModeAtomicAddProperty(req, plane_id, property_src_w, 320 << 16);
	drmModeAtomicAddProperty(req, plane_id, property_src_h, 320 << 16);
	drmModeAtomicCommit(fd, req, 0, NULL);
	drmModeAtomicFree(req);

	printf("drmModeAtomicCommit SetPlane\n");
	getchar();

	modeset_destroy_fb(fd, &buf);

	drmModeFreeConnector(conn);
	drmModeFreePlaneResources(plane_res);
	drmModeFreeResources(res);

	close(fd);

	return 0;
}

提示：

1. 上面的两次 drmModeAtomicCommit() 操作可以合并成一次；
2. 无需频繁调用 drmModeAtomicAlloc() 、drmModeAtomicFree() ，可以在第一次commit之前Alloc，在最后一次commit之后free，也没问题；
3. plane update操作时，可以只add发生变化的property，其它未发生变化的properties即使没有被add，在commit时底层驱动仍然会取上一次的值来配置硬件寄存器。

运行结果

以上代码运行的效果如下（模拟效果）：

注意：程序运行之前，请确保没有其它应用或服务占用/dev/dri/card0节点，否则将出现 Permission Denied 错误。

描述：

1. 程序运行后，屏幕显示黑色，终端打印“drmModeAtomicCommit SetCrtc”信息，表明当前已经初始化好CRTC/ENCODER/CONNECTOR硬件；
2. 输入回车后，屏幕显示framebuffer的crop区域，同时终端打印“drmModeAtomicCommit SetPlane”；
3. 再次输入回车，显示黑屏，程序退出

源码下载

modeset-atomic-plane

参考资料

Android libdrm: atomictest.c
Google Chrome: drm-tests/atomictest.c
libdrm mainline: mesa/drm

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