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.
14 #include <xf86drmMode.h>
20 struct planar_layout {
22 int horizontal_subsampling[DRV_MAX_PLANES];
23 int vertical_subsampling[DRV_MAX_PLANES];
24 int bytes_per_pixel[DRV_MAX_PLANES];
29 static const struct planar_layout packed_1bpp_layout = {
31 .horizontal_subsampling = { 1 },
32 .vertical_subsampling = { 1 },
33 .bytes_per_pixel = { 1 }
36 static const struct planar_layout packed_2bpp_layout = {
38 .horizontal_subsampling = { 1 },
39 .vertical_subsampling = { 1 },
40 .bytes_per_pixel = { 2 }
43 static const struct planar_layout packed_3bpp_layout = {
45 .horizontal_subsampling = { 1 },
46 .vertical_subsampling = { 1 },
47 .bytes_per_pixel = { 3 }
50 static const struct planar_layout packed_4bpp_layout = {
52 .horizontal_subsampling = { 1 },
53 .vertical_subsampling = { 1 },
54 .bytes_per_pixel = { 4 }
57 static const struct planar_layout packed_8bpp_layout = {
59 .horizontal_subsampling = { 1 },
60 .vertical_subsampling = { 1 },
61 .bytes_per_pixel = { 8 }
64 static const struct planar_layout biplanar_yuv_420_layout = {
66 .horizontal_subsampling = { 1, 2 },
67 .vertical_subsampling = { 1, 2 },
68 .bytes_per_pixel = { 1, 2 }
71 static const struct planar_layout triplanar_yuv_420_layout = {
73 .horizontal_subsampling = { 1, 2, 2 },
74 .vertical_subsampling = { 1, 2, 2 },
75 .bytes_per_pixel = { 1, 1, 1 }
78 static const struct planar_layout biplanar_yuv_p010_layout = {
80 .horizontal_subsampling = { 1, 2 },
81 .vertical_subsampling = { 1, 2 },
82 .bytes_per_pixel = { 2, 4 }
87 static const struct planar_layout *layout_from_format(uint32_t format)
90 case DRM_FORMAT_BGR233:
93 case DRM_FORMAT_RGB332:
94 return &packed_1bpp_layout;
96 case DRM_FORMAT_YVU420:
97 case DRM_FORMAT_YVU420_ANDROID:
98 return &triplanar_yuv_420_layout;
100 case DRM_FORMAT_NV12:
101 case DRM_FORMAT_NV21:
102 return &biplanar_yuv_420_layout;
104 case DRM_FORMAT_P010:
105 return &biplanar_yuv_p010_layout;
107 case DRM_FORMAT_ABGR1555:
108 case DRM_FORMAT_ABGR4444:
109 case DRM_FORMAT_ARGB1555:
110 case DRM_FORMAT_ARGB4444:
111 case DRM_FORMAT_BGR565:
112 case DRM_FORMAT_BGRA4444:
113 case DRM_FORMAT_BGRA5551:
114 case DRM_FORMAT_BGRX4444:
115 case DRM_FORMAT_BGRX5551:
116 case DRM_FORMAT_GR88:
117 case DRM_FORMAT_RG88:
118 case DRM_FORMAT_RGB565:
119 case DRM_FORMAT_RGBA4444:
120 case DRM_FORMAT_RGBA5551:
121 case DRM_FORMAT_RGBX4444:
122 case DRM_FORMAT_RGBX5551:
123 case DRM_FORMAT_UYVY:
124 case DRM_FORMAT_VYUY:
125 case DRM_FORMAT_XBGR1555:
126 case DRM_FORMAT_XBGR4444:
127 case DRM_FORMAT_XRGB1555:
128 case DRM_FORMAT_XRGB4444:
129 case DRM_FORMAT_YUYV:
130 case DRM_FORMAT_YVYU:
131 return &packed_2bpp_layout;
133 case DRM_FORMAT_BGR888:
134 case DRM_FORMAT_RGB888:
135 return &packed_3bpp_layout;
137 case DRM_FORMAT_ABGR2101010:
138 case DRM_FORMAT_ABGR8888:
139 case DRM_FORMAT_ARGB2101010:
140 case DRM_FORMAT_ARGB8888:
141 case DRM_FORMAT_AYUV:
142 case DRM_FORMAT_BGRA1010102:
143 case DRM_FORMAT_BGRA8888:
144 case DRM_FORMAT_BGRX1010102:
145 case DRM_FORMAT_BGRX8888:
146 case DRM_FORMAT_RGBA1010102:
147 case DRM_FORMAT_RGBA8888:
148 case DRM_FORMAT_RGBX1010102:
149 case DRM_FORMAT_RGBX8888:
150 case DRM_FORMAT_XBGR2101010:
151 case DRM_FORMAT_XBGR8888:
152 case DRM_FORMAT_XRGB2101010:
153 case DRM_FORMAT_XRGB8888:
154 return &packed_4bpp_layout;
156 case DRM_FORMAT_ABGR16161616F:
157 return &packed_8bpp_layout;
160 drv_log("UNKNOWN FORMAT %d\n", format);
165 size_t drv_num_planes_from_format(uint32_t format)
167 const struct planar_layout *layout = layout_from_format(format);
170 * drv_bo_new calls this function early to query number of planes and
171 * considers 0 planes to mean unknown format, so we have to support
172 * that. All other layout_from_format() queries can assume that the
173 * format is supported and that the return value is non-NULL.
176 return layout ? layout->num_planes : 0;
179 uint32_t drv_height_from_format(uint32_t format, uint32_t height, size_t plane)
181 const struct planar_layout *layout = layout_from_format(format);
183 assert(plane < layout->num_planes);
185 return DIV_ROUND_UP(height, layout->vertical_subsampling[plane]);
188 uint32_t drv_bytes_per_pixel_from_format(uint32_t format, size_t plane)
190 const struct planar_layout *layout = layout_from_format(format);
192 assert(plane < layout->num_planes);
194 return layout->bytes_per_pixel[plane];
198 * This function returns the stride for a given format, width and plane.
200 uint32_t drv_stride_from_format(uint32_t format, uint32_t width, size_t plane)
202 const struct planar_layout *layout = layout_from_format(format);
203 assert(plane < layout->num_planes);
205 uint32_t plane_width = DIV_ROUND_UP(width, layout->horizontal_subsampling[plane]);
206 uint32_t stride = plane_width * layout->bytes_per_pixel[plane];
209 * The stride of Android YV12 buffers is required to be aligned to 16 bytes
210 * (see <system/graphics.h>).
212 if (format == DRM_FORMAT_YVU420_ANDROID)
213 stride = (plane == 0) ? ALIGN(stride, 32) : ALIGN(stride, 16);
218 uint32_t drv_size_from_format(uint32_t format, uint32_t stride, uint32_t height, size_t plane)
220 return stride * drv_height_from_format(format, height, plane);
223 static uint32_t subsample_stride(uint32_t stride, uint32_t format, size_t plane)
227 case DRM_FORMAT_YVU420:
228 case DRM_FORMAT_YVU420_ANDROID:
229 stride = DIV_ROUND_UP(stride, 2);
238 * This function fills in the buffer object given the driver aligned stride of
239 * the first plane, height and a format. This function assumes there is just
240 * one kernel buffer per buffer object.
242 int drv_bo_from_format(struct bo *bo, uint32_t stride, uint32_t aligned_height, uint32_t format)
245 size_t p, num_planes;
248 num_planes = drv_num_planes_from_format(format);
252 * HAL_PIXEL_FORMAT_YV12 requires that (see <system/graphics.h>):
253 * - the aligned height is same as the buffer's height.
254 * - the chroma stride is 16 bytes aligned, i.e., the luma's strides
255 * is 32 bytes aligned.
257 if (format == DRM_FORMAT_YVU420_ANDROID) {
258 assert(aligned_height == bo->meta.height);
259 assert(stride == ALIGN(stride, 32));
262 for (p = 0; p < num_planes; p++) {
263 bo->meta.strides[p] = subsample_stride(stride, format, p);
265 drv_size_from_format(format, bo->meta.strides[p], aligned_height, p);
266 bo->meta.offsets[p] = offset;
267 offset += bo->meta.sizes[p];
270 bo->meta.total_size = offset;
274 int drv_dumb_bo_create(struct bo *bo, uint32_t width, uint32_t height, uint32_t format,
279 uint32_t aligned_width, aligned_height;
280 struct drm_mode_create_dumb create_dumb;
282 aligned_width = width;
283 aligned_height = height;
285 case DRM_FORMAT_YVU420_ANDROID:
286 /* Align width to 32 pixels, so chroma strides are 16 bytes as
287 * Android requires. */
288 aligned_width = ALIGN(width, 32);
289 /* Adjust the height to include room for chroma planes.
291 * HAL_PIXEL_FORMAT_YV12 requires that the buffer's height not
293 aligned_height = 3 * DIV_ROUND_UP(bo->meta.height, 2);
295 case DRM_FORMAT_YVU420:
296 case DRM_FORMAT_NV12:
297 /* Adjust the height to include room for chroma planes */
298 aligned_height = 3 * DIV_ROUND_UP(height, 2);
304 memset(&create_dumb, 0, sizeof(create_dumb));
305 create_dumb.height = aligned_height;
306 create_dumb.width = aligned_width;
307 create_dumb.bpp = layout_from_format(format)->bytes_per_pixel[0] * 8;
308 create_dumb.flags = 0;
310 ret = drmIoctl(bo->drv->fd, DRM_IOCTL_MODE_CREATE_DUMB, &create_dumb);
312 drv_log("DRM_IOCTL_MODE_CREATE_DUMB failed (%d, %d)\n", bo->drv->fd, errno);
316 drv_bo_from_format(bo, create_dumb.pitch, height, format);
318 for (plane = 0; plane < bo->meta.num_planes; plane++)
319 bo->handles[plane].u32 = create_dumb.handle;
321 bo->meta.total_size = create_dumb.size;
325 int drv_dumb_bo_destroy(struct bo *bo)
327 struct drm_mode_destroy_dumb destroy_dumb;
330 memset(&destroy_dumb, 0, sizeof(destroy_dumb));
331 destroy_dumb.handle = bo->handles[0].u32;
333 ret = drmIoctl(bo->drv->fd, DRM_IOCTL_MODE_DESTROY_DUMB, &destroy_dumb);
335 drv_log("DRM_IOCTL_MODE_DESTROY_DUMB failed (handle=%x)\n", bo->handles[0].u32);
342 int drv_gem_bo_destroy(struct bo *bo)
344 struct drm_gem_close gem_close;
348 for (plane = 0; plane < bo->meta.num_planes; plane++) {
349 for (i = 0; i < plane; i++)
350 if (bo->handles[i].u32 == bo->handles[plane].u32)
352 /* Make sure close hasn't already been called on this handle */
356 memset(&gem_close, 0, sizeof(gem_close));
357 gem_close.handle = bo->handles[plane].u32;
359 ret = drmIoctl(bo->drv->fd, DRM_IOCTL_GEM_CLOSE, &gem_close);
361 drv_log("DRM_IOCTL_GEM_CLOSE failed (handle=%x) error %d\n",
362 bo->handles[plane].u32, ret);
370 int drv_prime_bo_import(struct bo *bo, struct drv_import_fd_data *data)
374 struct drm_prime_handle prime_handle;
376 for (plane = 0; plane < bo->meta.num_planes; plane++) {
377 memset(&prime_handle, 0, sizeof(prime_handle));
378 prime_handle.fd = data->fds[plane];
380 ret = drmIoctl(bo->drv->fd, DRM_IOCTL_PRIME_FD_TO_HANDLE, &prime_handle);
383 drv_log("DRM_IOCTL_PRIME_FD_TO_HANDLE failed (fd=%u)\n", prime_handle.fd);
386 * Need to call GEM close on planes that were opened,
387 * if any. Adjust the num_planes variable to be the
388 * plane that failed, so GEM close will be called on
389 * planes before that plane.
391 bo->meta.num_planes = plane;
392 drv_gem_bo_destroy(bo);
396 bo->handles[plane].u32 = prime_handle.handle;
402 void *drv_dumb_bo_map(struct bo *bo, struct vma *vma, size_t plane, uint32_t map_flags)
406 struct drm_mode_map_dumb map_dumb;
408 memset(&map_dumb, 0, sizeof(map_dumb));
409 map_dumb.handle = bo->handles[plane].u32;
411 ret = drmIoctl(bo->drv->fd, DRM_IOCTL_MODE_MAP_DUMB, &map_dumb);
413 drv_log("DRM_IOCTL_MODE_MAP_DUMB failed\n");
417 for (i = 0; i < bo->meta.num_planes; i++)
418 if (bo->handles[i].u32 == bo->handles[plane].u32)
419 vma->length += bo->meta.sizes[i];
421 return mmap(0, vma->length, drv_get_prot(map_flags), MAP_SHARED, bo->drv->fd,
425 int drv_bo_munmap(struct bo *bo, struct vma *vma)
427 return munmap(vma->addr, vma->length);
430 int drv_mapping_destroy(struct bo *bo)
434 struct mapping *mapping;
438 * This function is called right before the buffer is destroyed. It will free any mappings
439 * associated with the buffer.
443 for (plane = 0; plane < bo->meta.num_planes; plane++) {
444 while (idx < drv_array_size(bo->drv->mappings)) {
445 mapping = (struct mapping *)drv_array_at_idx(bo->drv->mappings, idx);
446 if (mapping->vma->handle != bo->handles[plane].u32) {
451 if (!--mapping->vma->refcount) {
452 ret = bo->drv->backend->bo_unmap(bo, mapping->vma);
454 drv_log("munmap failed\n");
461 /* This shrinks and shifts the array, so don't increment idx. */
462 drv_array_remove(bo->drv->mappings, idx);
469 int drv_get_prot(uint32_t map_flags)
471 return (BO_MAP_WRITE & map_flags) ? PROT_WRITE | PROT_READ : PROT_READ;
474 uintptr_t drv_get_reference_count(struct driver *drv, struct bo *bo, size_t plane)
479 if (!drmHashLookup(drv->buffer_table, bo->handles[plane].u32, &count))
480 num = (uintptr_t)(count);
485 void drv_increment_reference_count(struct driver *drv, struct bo *bo, size_t plane)
487 uintptr_t num = drv_get_reference_count(drv, bo, plane);
489 /* If a value isn't in the table, drmHashDelete is a no-op */
490 drmHashDelete(drv->buffer_table, bo->handles[plane].u32);
491 drmHashInsert(drv->buffer_table, bo->handles[plane].u32, (void *)(num + 1));
494 void drv_decrement_reference_count(struct driver *drv, struct bo *bo, size_t plane)
496 uintptr_t num = drv_get_reference_count(drv, bo, plane);
498 drmHashDelete(drv->buffer_table, bo->handles[plane].u32);
501 drmHashInsert(drv->buffer_table, bo->handles[plane].u32, (void *)(num - 1));
504 void drv_add_combination(struct driver *drv, const uint32_t format,
505 struct format_metadata *metadata, uint64_t use_flags)
507 struct combination combo = { .format = format,
508 .metadata = *metadata,
509 .use_flags = use_flags };
511 drv_array_append(drv->combos, &combo);
514 void drv_add_combinations(struct driver *drv, const uint32_t *formats, uint32_t num_formats,
515 struct format_metadata *metadata, uint64_t use_flags)
519 for (i = 0; i < num_formats; i++) {
520 struct combination combo = { .format = formats[i],
521 .metadata = *metadata,
522 .use_flags = use_flags };
524 drv_array_append(drv->combos, &combo);
528 void drv_modify_combination(struct driver *drv, uint32_t format, struct format_metadata *metadata,
532 struct combination *combo;
533 /* Attempts to add the specified flags to an existing combination. */
534 for (i = 0; i < drv_array_size(drv->combos); i++) {
535 combo = (struct combination *)drv_array_at_idx(drv->combos, i);
536 if (combo->format == format && combo->metadata.tiling == metadata->tiling &&
537 combo->metadata.modifier == metadata->modifier)
538 combo->use_flags |= use_flags;
542 struct drv_array *drv_query_kms(struct driver *drv)
544 struct drv_array *kms_items;
545 uint64_t plane_type = UINT64_MAX;
549 drmModePlanePtr plane;
550 drmModePropertyPtr prop;
551 drmModePlaneResPtr resources;
552 drmModeObjectPropertiesPtr props;
554 kms_items = drv_array_init(sizeof(struct kms_item));
559 * The ability to return universal planes is only complete on
560 * ChromeOS kernel versions >= v3.18. The SET_CLIENT_CAP ioctl
561 * therefore might return an error code, so don't check it. If it
562 * fails, it'll just return the plane list as overlay planes, which is
563 * fine in our case (our drivers already have cursor bits set).
564 * modetest in libdrm does the same thing.
566 drmSetClientCap(drv->fd, DRM_CLIENT_CAP_UNIVERSAL_PLANES, 1);
568 resources = drmModeGetPlaneResources(drv->fd);
572 for (i = 0; i < resources->count_planes; i++) {
573 plane_type = UINT64_MAX;
574 plane = drmModeGetPlane(drv->fd, resources->planes[i]);
578 props = drmModeObjectGetProperties(drv->fd, plane->plane_id, DRM_MODE_OBJECT_PLANE);
582 for (j = 0; j < props->count_props; j++) {
583 prop = drmModeGetProperty(drv->fd, props->props[j]);
585 if (strcmp(prop->name, "type") == 0) {
586 plane_type = props->prop_values[j];
589 drmModeFreeProperty(prop);
593 switch (plane_type) {
594 case DRM_PLANE_TYPE_OVERLAY:
595 case DRM_PLANE_TYPE_PRIMARY:
596 use_flag = BO_USE_SCANOUT;
598 case DRM_PLANE_TYPE_CURSOR:
599 use_flag = BO_USE_CURSOR;
605 for (j = 0; j < plane->count_formats; j++) {
607 for (k = 0; k < drv_array_size(kms_items); k++) {
608 struct kms_item *item = drv_array_at_idx(kms_items, k);
609 if (item->format == plane->formats[j] &&
610 item->modifier == DRM_FORMAT_MOD_LINEAR) {
611 item->use_flags |= use_flag;
618 struct kms_item item = { .format = plane->formats[j],
619 .modifier = DRM_FORMAT_MOD_LINEAR,
620 .use_flags = use_flag };
622 drv_array_append(kms_items, &item);
626 drmModeFreeObjectProperties(props);
627 drmModeFreePlane(plane);
630 drmModeFreePlaneResources(resources);
632 if (kms_items && !drv_array_size(kms_items)) {
633 drv_array_destroy(kms_items);
640 int drv_modify_linear_combinations(struct driver *drv)
643 struct kms_item *item;
644 struct combination *combo;
645 struct drv_array *kms_items;
648 * All current drivers can scanout linear XRGB8888/ARGB8888 as a primary
649 * plane and as a cursor. Some drivers don't support
650 * drmModeGetPlaneResources, so add the combination here. Note that the
651 * kernel disregards the alpha component of ARGB unless it's an overlay
654 drv_modify_combination(drv, DRM_FORMAT_XRGB8888, &LINEAR_METADATA,
655 BO_USE_CURSOR | BO_USE_SCANOUT);
656 drv_modify_combination(drv, DRM_FORMAT_ARGB8888, &LINEAR_METADATA,
657 BO_USE_CURSOR | BO_USE_SCANOUT);
659 kms_items = drv_query_kms(drv);
663 for (i = 0; i < drv_array_size(kms_items); i++) {
664 item = (struct kms_item *)drv_array_at_idx(kms_items, i);
665 for (j = 0; j < drv_array_size(drv->combos); j++) {
666 combo = drv_array_at_idx(drv->combos, j);
667 if (item->format == combo->format)
668 combo->use_flags |= BO_USE_SCANOUT;
672 drv_array_destroy(kms_items);
677 * Pick the best modifier from modifiers, according to the ordering
678 * given by modifier_order.
680 uint64_t drv_pick_modifier(const uint64_t *modifiers, uint32_t count,
681 const uint64_t *modifier_order, uint32_t order_count)
685 for (i = 0; i < order_count; i++) {
686 for (j = 0; j < count; j++) {
687 if (modifiers[j] == modifier_order[i]) {
693 return DRM_FORMAT_MOD_LINEAR;
697 * Search a list of modifiers to see if a given modifier is present
699 bool drv_has_modifier(const uint64_t *list, uint32_t count, uint64_t modifier)
702 for (i = 0; i < count; i++)
703 if (list[i] == modifier)