2 * Copyright 2014 The Chromium OS Authors. All rights reserved.
3 * Use of this source code is governed by a BSD-style license that can be
4 * found in the LICENSE file.
15 #include <xf86drmMode.h>
21 struct planar_layout {
23 int horizontal_subsampling[DRV_MAX_PLANES];
24 int vertical_subsampling[DRV_MAX_PLANES];
25 int bytes_per_pixel[DRV_MAX_PLANES];
30 static const struct planar_layout packed_1bpp_layout = {
32 .horizontal_subsampling = { 1 },
33 .vertical_subsampling = { 1 },
34 .bytes_per_pixel = { 1 }
37 static const struct planar_layout packed_2bpp_layout = {
39 .horizontal_subsampling = { 1 },
40 .vertical_subsampling = { 1 },
41 .bytes_per_pixel = { 2 }
44 static const struct planar_layout packed_3bpp_layout = {
46 .horizontal_subsampling = { 1 },
47 .vertical_subsampling = { 1 },
48 .bytes_per_pixel = { 3 }
51 static const struct planar_layout packed_4bpp_layout = {
53 .horizontal_subsampling = { 1 },
54 .vertical_subsampling = { 1 },
55 .bytes_per_pixel = { 4 }
58 static const struct planar_layout packed_8bpp_layout = {
60 .horizontal_subsampling = { 1 },
61 .vertical_subsampling = { 1 },
62 .bytes_per_pixel = { 8 }
65 static const struct planar_layout biplanar_yuv_420_layout = {
67 .horizontal_subsampling = { 1, 2 },
68 .vertical_subsampling = { 1, 2 },
69 .bytes_per_pixel = { 1, 2 }
72 static const struct planar_layout triplanar_yuv_420_layout = {
74 .horizontal_subsampling = { 1, 2, 2 },
75 .vertical_subsampling = { 1, 2, 2 },
76 .bytes_per_pixel = { 1, 1, 1 }
81 static const struct planar_layout *layout_from_format(uint32_t format)
84 case DRM_FORMAT_BGR233:
87 case DRM_FORMAT_RGB332:
88 return &packed_1bpp_layout;
90 case DRM_FORMAT_YVU420:
91 case DRM_FORMAT_YVU420_ANDROID:
92 return &triplanar_yuv_420_layout;
96 return &biplanar_yuv_420_layout;
98 case DRM_FORMAT_ABGR1555:
99 case DRM_FORMAT_ABGR4444:
100 case DRM_FORMAT_ARGB1555:
101 case DRM_FORMAT_ARGB4444:
102 case DRM_FORMAT_BGR565:
103 case DRM_FORMAT_BGRA4444:
104 case DRM_FORMAT_BGRA5551:
105 case DRM_FORMAT_BGRX4444:
106 case DRM_FORMAT_BGRX5551:
107 case DRM_FORMAT_GR88:
108 case DRM_FORMAT_RG88:
109 case DRM_FORMAT_RGB565:
110 case DRM_FORMAT_RGBA4444:
111 case DRM_FORMAT_RGBA5551:
112 case DRM_FORMAT_RGBX4444:
113 case DRM_FORMAT_RGBX5551:
114 case DRM_FORMAT_UYVY:
115 case DRM_FORMAT_VYUY:
116 case DRM_FORMAT_XBGR1555:
117 case DRM_FORMAT_XBGR4444:
118 case DRM_FORMAT_XRGB1555:
119 case DRM_FORMAT_XRGB4444:
120 case DRM_FORMAT_YUYV:
121 case DRM_FORMAT_YVYU:
122 return &packed_2bpp_layout;
124 case DRM_FORMAT_BGR888:
125 case DRM_FORMAT_RGB888:
126 return &packed_3bpp_layout;
128 case DRM_FORMAT_ABGR2101010:
129 case DRM_FORMAT_ABGR8888:
130 case DRM_FORMAT_ARGB2101010:
131 case DRM_FORMAT_ARGB8888:
132 case DRM_FORMAT_AYUV:
133 case DRM_FORMAT_BGRA1010102:
134 case DRM_FORMAT_BGRA8888:
135 case DRM_FORMAT_BGRX1010102:
136 case DRM_FORMAT_BGRX8888:
137 case DRM_FORMAT_RGBA1010102:
138 case DRM_FORMAT_RGBA8888:
139 case DRM_FORMAT_RGBX1010102:
140 case DRM_FORMAT_RGBX8888:
141 case DRM_FORMAT_XBGR2101010:
142 case DRM_FORMAT_XBGR8888:
143 case DRM_FORMAT_XRGB2101010:
144 case DRM_FORMAT_XRGB8888:
145 return &packed_4bpp_layout;
147 case DRM_FORMAT_XBGR16161616:
148 return &packed_8bpp_layout;
151 drv_log("UNKNOWN FORMAT %d\n", format);
156 size_t drv_num_planes_from_format(uint32_t format)
158 const struct planar_layout *layout = layout_from_format(format);
161 * drv_bo_new calls this function early to query number of planes and
162 * considers 0 planes to mean unknown format, so we have to support
163 * that. All other layout_from_format() queries can assume that the
164 * format is supported and that the return value is non-NULL.
167 return layout ? layout->num_planes : 0;
170 uint32_t drv_height_from_format(uint32_t format, uint32_t height, size_t plane)
172 const struct planar_layout *layout = layout_from_format(format);
174 assert(plane < layout->num_planes);
176 return DIV_ROUND_UP(height, layout->vertical_subsampling[plane]);
179 uint32_t drv_bytes_per_pixel_from_format(uint32_t format, size_t plane)
181 const struct planar_layout *layout = layout_from_format(format);
183 assert(plane < layout->num_planes);
185 return layout->bytes_per_pixel[plane];
188 uint32_t drv_bo_get_stride_in_pixels(struct bo *bo)
190 uint32_t bytes_per_pixel = drv_bytes_per_pixel_from_format(bo->format, 0);
191 return DIV_ROUND_UP(bo->strides[0], bytes_per_pixel);
195 * This function returns the stride for a given format, width and plane.
197 uint32_t drv_stride_from_format(uint32_t format, uint32_t width, size_t plane)
199 const struct planar_layout *layout = layout_from_format(format);
200 assert(plane < layout->num_planes);
202 uint32_t plane_width = DIV_ROUND_UP(width, layout->horizontal_subsampling[plane]);
203 uint32_t stride = plane_width * layout->bytes_per_pixel[plane];
206 * The stride of Android YV12 buffers is required to be aligned to 16 bytes
207 * (see <system/graphics.h>).
209 if (format == DRM_FORMAT_YVU420_ANDROID)
210 stride = (plane == 0) ? ALIGN(stride, 32) : ALIGN(stride, 16);
215 uint32_t drv_size_from_format(uint32_t format, uint32_t stride, uint32_t height, size_t plane)
217 return stride * drv_height_from_format(format, height, plane);
220 static uint32_t subsample_stride(uint32_t stride, uint32_t format, size_t plane)
224 case DRM_FORMAT_YVU420:
225 case DRM_FORMAT_YVU420_ANDROID:
226 stride = DIV_ROUND_UP(stride, 2);
235 * This function fills in the buffer object given the driver aligned stride of
236 * the first plane, height and a format. This function assumes there is just
237 * one kernel buffer per buffer object.
239 int drv_bo_from_format(struct bo *bo, uint32_t stride, uint32_t aligned_height, uint32_t format)
242 size_t p, num_planes;
245 num_planes = drv_num_planes_from_format(format);
249 * HAL_PIXEL_FORMAT_YV12 requires that (see <system/graphics.h>):
250 * - the aligned height is same as the buffer's height.
251 * - the chroma stride is 16 bytes aligned, i.e., the luma's strides
252 * is 32 bytes aligned.
254 if (format == DRM_FORMAT_YVU420_ANDROID) {
255 assert(aligned_height == bo->height);
256 assert(stride == ALIGN(stride, 32));
259 for (p = 0; p < num_planes; p++) {
260 bo->strides[p] = subsample_stride(stride, format, p);
261 bo->sizes[p] = drv_size_from_format(format, bo->strides[p], aligned_height, p);
262 bo->offsets[p] = offset;
263 offset += bo->sizes[p];
266 bo->total_size = offset;
270 int drv_dumb_bo_create(struct bo *bo, uint32_t width, uint32_t height, uint32_t format,
275 uint32_t aligned_width, aligned_height;
276 struct drm_mode_create_dumb create_dumb;
278 aligned_width = width;
279 aligned_height = height;
280 if (format == DRM_FORMAT_YVU420_ANDROID) {
282 * Align width to 32 pixels, so chroma strides are 16 bytes as
285 aligned_width = ALIGN(width, 32);
288 if (format == DRM_FORMAT_YVU420_ANDROID || format == DRM_FORMAT_YVU420) {
289 aligned_height = 3 * DIV_ROUND_UP(height, 2);
292 memset(&create_dumb, 0, sizeof(create_dumb));
293 create_dumb.height = aligned_height;
294 create_dumb.width = aligned_width;
295 create_dumb.bpp = layout_from_format(format)->bytes_per_pixel[0] * 8;
296 create_dumb.flags = 0;
298 ret = drmIoctl(bo->drv->fd, DRM_IOCTL_MODE_CREATE_DUMB, &create_dumb);
300 drv_log("DRM_IOCTL_MODE_CREATE_DUMB failed (%d, %d)\n", bo->drv->fd, errno);
304 drv_bo_from_format(bo, create_dumb.pitch, height, format);
306 for (plane = 0; plane < bo->num_planes; plane++)
307 bo->handles[plane].u32 = create_dumb.handle;
309 bo->total_size = create_dumb.size;
313 int drv_dumb_bo_destroy(struct bo *bo)
315 struct drm_mode_destroy_dumb destroy_dumb;
318 memset(&destroy_dumb, 0, sizeof(destroy_dumb));
319 destroy_dumb.handle = bo->handles[0].u32;
321 ret = drmIoctl(bo->drv->fd, DRM_IOCTL_MODE_DESTROY_DUMB, &destroy_dumb);
323 drv_log("DRM_IOCTL_MODE_DESTROY_DUMB failed (handle=%x)\n", bo->handles[0].u32);
330 int drv_gem_bo_destroy(struct bo *bo)
332 struct drm_gem_close gem_close;
336 for (plane = 0; plane < bo->num_planes; plane++) {
337 for (i = 0; i < plane; i++)
338 if (bo->handles[i].u32 == bo->handles[plane].u32)
340 /* Make sure close hasn't already been called on this handle */
344 memset(&gem_close, 0, sizeof(gem_close));
345 gem_close.handle = bo->handles[plane].u32;
347 ret = drmIoctl(bo->drv->fd, DRM_IOCTL_GEM_CLOSE, &gem_close);
349 drv_log("DRM_IOCTL_GEM_CLOSE failed (handle=%x) error %d\n",
350 bo->handles[plane].u32, ret);
358 int drv_prime_bo_import(struct bo *bo, struct drv_import_fd_data *data)
362 struct drm_prime_handle prime_handle;
364 for (plane = 0; plane < bo->num_planes; plane++) {
365 memset(&prime_handle, 0, sizeof(prime_handle));
366 prime_handle.fd = data->fds[plane];
368 ret = drmIoctl(bo->drv->fd, DRM_IOCTL_PRIME_FD_TO_HANDLE, &prime_handle);
371 drv_log("DRM_IOCTL_PRIME_FD_TO_HANDLE failed (fd=%u)\n", prime_handle.fd);
374 * Need to call GEM close on planes that were opened,
375 * if any. Adjust the num_planes variable to be the
376 * plane that failed, so GEM close will be called on
377 * planes before that plane.
379 bo->num_planes = plane;
380 drv_gem_bo_destroy(bo);
384 bo->handles[plane].u32 = prime_handle.handle;
387 for (plane = 0; plane < bo->num_planes; plane++) {
388 pthread_mutex_lock(&bo->drv->driver_lock);
389 drv_increment_reference_count(bo->drv, bo, plane);
390 pthread_mutex_unlock(&bo->drv->driver_lock);
396 void *drv_dumb_bo_map(struct bo *bo, struct vma *vma, size_t plane, uint32_t map_flags)
400 struct drm_mode_map_dumb map_dumb;
402 memset(&map_dumb, 0, sizeof(map_dumb));
403 map_dumb.handle = bo->handles[plane].u32;
405 ret = drmIoctl(bo->drv->fd, DRM_IOCTL_MODE_MAP_DUMB, &map_dumb);
407 drv_log("DRM_IOCTL_MODE_MAP_DUMB failed\n");
411 for (i = 0; i < bo->num_planes; i++)
412 if (bo->handles[i].u32 == bo->handles[plane].u32)
413 vma->length += bo->sizes[i];
415 return mmap(0, vma->length, drv_get_prot(map_flags), MAP_SHARED, bo->drv->fd,
419 int drv_bo_munmap(struct bo *bo, struct vma *vma)
421 return munmap(vma->addr, vma->length);
424 int drv_mapping_destroy(struct bo *bo)
428 struct mapping *mapping;
432 * This function is called right before the buffer is destroyed. It will free any mappings
433 * associated with the buffer.
437 for (plane = 0; plane < bo->num_planes; plane++) {
438 while (idx < drv_array_size(bo->drv->mappings)) {
439 mapping = (struct mapping *)drv_array_at_idx(bo->drv->mappings, idx);
440 if (mapping->vma->handle != bo->handles[plane].u32) {
445 if (!--mapping->vma->refcount) {
446 ret = bo->drv->backend->bo_unmap(bo, mapping->vma);
448 drv_log("munmap failed\n");
455 /* This shrinks and shifts the array, so don't increment idx. */
456 drv_array_remove(bo->drv->mappings, idx);
463 int drv_get_prot(uint32_t map_flags)
465 return (BO_MAP_WRITE & map_flags) ? PROT_WRITE | PROT_READ : PROT_READ;
468 uintptr_t drv_get_reference_count(struct driver *drv, struct bo *bo, size_t plane)
473 if (!drmHashLookup(drv->buffer_table, bo->handles[plane].u32, &count))
474 num = (uintptr_t)(count);
479 void drv_increment_reference_count(struct driver *drv, struct bo *bo, size_t plane)
481 uintptr_t num = drv_get_reference_count(drv, bo, plane);
483 /* If a value isn't in the table, drmHashDelete is a no-op */
484 drmHashDelete(drv->buffer_table, bo->handles[plane].u32);
485 drmHashInsert(drv->buffer_table, bo->handles[plane].u32, (void *)(num + 1));
488 void drv_decrement_reference_count(struct driver *drv, struct bo *bo, size_t plane)
490 uintptr_t num = drv_get_reference_count(drv, bo, plane);
492 drmHashDelete(drv->buffer_table, bo->handles[plane].u32);
495 drmHashInsert(drv->buffer_table, bo->handles[plane].u32, (void *)(num - 1));
498 uint32_t drv_log_base2(uint32_t value)
508 void drv_add_combinations(struct driver *drv, const uint32_t *formats, uint32_t num_formats,
509 struct format_metadata *metadata, uint64_t use_flags)
513 for (i = 0; i < num_formats; i++) {
514 struct combination combo = { .format = formats[i],
515 .metadata = *metadata,
516 .use_flags = use_flags };
518 drv_array_append(drv->combos, &combo);
522 void drv_modify_combination(struct driver *drv, uint32_t format, struct format_metadata *metadata,
526 struct combination *combo;
527 /* Attempts to add the specified flags to an existing combination. */
528 for (i = 0; i < drv_array_size(drv->combos); i++) {
529 combo = (struct combination *)drv_array_at_idx(drv->combos, i);
530 if (combo->format == format && combo->metadata.tiling == metadata->tiling &&
531 combo->metadata.modifier == metadata->modifier)
532 combo->use_flags |= use_flags;
536 struct drv_array *drv_query_kms(struct driver *drv)
538 struct drv_array *kms_items;
539 uint64_t plane_type, use_flag;
542 drmModePlanePtr plane;
543 drmModePropertyPtr prop;
544 drmModePlaneResPtr resources;
545 drmModeObjectPropertiesPtr props;
547 kms_items = drv_array_init(sizeof(struct kms_item));
552 * The ability to return universal planes is only complete on
553 * ChromeOS kernel versions >= v3.18. The SET_CLIENT_CAP ioctl
554 * therefore might return an error code, so don't check it. If it
555 * fails, it'll just return the plane list as overlay planes, which is
556 * fine in our case (our drivers already have cursor bits set).
557 * modetest in libdrm does the same thing.
559 drmSetClientCap(drv->fd, DRM_CLIENT_CAP_UNIVERSAL_PLANES, 1);
561 resources = drmModeGetPlaneResources(drv->fd);
565 for (i = 0; i < resources->count_planes; i++) {
566 plane = drmModeGetPlane(drv->fd, resources->planes[i]);
570 props = drmModeObjectGetProperties(drv->fd, plane->plane_id, DRM_MODE_OBJECT_PLANE);
574 for (j = 0; j < props->count_props; j++) {
575 prop = drmModeGetProperty(drv->fd, props->props[j]);
577 if (strcmp(prop->name, "type") == 0) {
578 plane_type = props->prop_values[j];
581 drmModeFreeProperty(prop);
585 switch (plane_type) {
586 case DRM_PLANE_TYPE_OVERLAY:
587 case DRM_PLANE_TYPE_PRIMARY:
588 use_flag = BO_USE_SCANOUT;
590 case DRM_PLANE_TYPE_CURSOR:
591 use_flag = BO_USE_CURSOR;
597 for (j = 0; j < plane->count_formats; j++) {
599 for (k = 0; k < drv_array_size(kms_items); k++) {
600 struct kms_item *item = drv_array_at_idx(kms_items, k);
601 if (item->format == plane->formats[j] &&
602 item->modifier == DRM_FORMAT_MOD_LINEAR) {
603 item->use_flags |= use_flag;
610 struct kms_item item = { .format = plane->formats[j],
611 .modifier = DRM_FORMAT_MOD_LINEAR,
612 .use_flags = use_flag };
614 drv_array_append(kms_items, &item);
618 drmModeFreeObjectProperties(props);
619 drmModeFreePlane(plane);
622 drmModeFreePlaneResources(resources);
624 if (kms_items && !drv_array_size(kms_items)) {
625 drv_array_destroy(kms_items);
632 int drv_modify_linear_combinations(struct driver *drv)
635 struct kms_item *item;
636 struct combination *combo;
637 struct drv_array *kms_items;
640 * All current drivers can scanout linear XRGB8888/ARGB8888 as a primary
641 * plane and as a cursor. Some drivers don't support
642 * drmModeGetPlaneResources, so add the combination here. Note that the
643 * kernel disregards the alpha component of ARGB unless it's an overlay
646 drv_modify_combination(drv, DRM_FORMAT_XRGB8888, &LINEAR_METADATA,
647 BO_USE_CURSOR | BO_USE_SCANOUT);
648 drv_modify_combination(drv, DRM_FORMAT_ARGB8888, &LINEAR_METADATA,
649 BO_USE_CURSOR | BO_USE_SCANOUT);
651 kms_items = drv_query_kms(drv);
655 for (i = 0; i < drv_array_size(kms_items); i++) {
656 item = (struct kms_item *)drv_array_at_idx(kms_items, i);
657 for (j = 0; j < drv_array_size(drv->combos); j++) {
658 combo = drv_array_at_idx(drv->combos, j);
659 if (item->format == combo->format)
660 combo->use_flags |= BO_USE_SCANOUT;
664 drv_array_destroy(kms_items);
669 * Pick the best modifier from modifiers, according to the ordering
670 * given by modifier_order.
672 uint64_t drv_pick_modifier(const uint64_t *modifiers, uint32_t count,
673 const uint64_t *modifier_order, uint32_t order_count)
677 for (i = 0; i < order_count; i++) {
678 for (j = 0; j < count; j++) {
679 if (modifiers[j] == modifier_order[i]) {
685 return DRM_FORMAT_MOD_LINEAR;