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 biplanar_yuv_420_layout = {
60 .horizontal_subsampling = { 1, 2 },
61 .vertical_subsampling = { 1, 2 },
62 .bytes_per_pixel = { 1, 2 }
65 static const struct planar_layout triplanar_yuv_420_layout = {
67 .horizontal_subsampling = { 1, 2, 2 },
68 .vertical_subsampling = { 1, 2, 2 },
69 .bytes_per_pixel = { 1, 1, 1 }
74 static const struct planar_layout *layout_from_format(uint32_t format)
77 case DRM_FORMAT_BGR233:
80 case DRM_FORMAT_RGB332:
81 return &packed_1bpp_layout;
83 case DRM_FORMAT_YVU420:
84 case DRM_FORMAT_YVU420_ANDROID:
85 return &triplanar_yuv_420_layout;
89 return &biplanar_yuv_420_layout;
91 case DRM_FORMAT_ABGR1555:
92 case DRM_FORMAT_ABGR4444:
93 case DRM_FORMAT_ARGB1555:
94 case DRM_FORMAT_ARGB4444:
95 case DRM_FORMAT_BGR565:
96 case DRM_FORMAT_BGRA4444:
97 case DRM_FORMAT_BGRA5551:
98 case DRM_FORMAT_BGRX4444:
99 case DRM_FORMAT_BGRX5551:
100 case DRM_FORMAT_GR88:
101 case DRM_FORMAT_RG88:
102 case DRM_FORMAT_RGB565:
103 case DRM_FORMAT_RGBA4444:
104 case DRM_FORMAT_RGBA5551:
105 case DRM_FORMAT_RGBX4444:
106 case DRM_FORMAT_RGBX5551:
107 case DRM_FORMAT_UYVY:
108 case DRM_FORMAT_VYUY:
109 case DRM_FORMAT_XBGR1555:
110 case DRM_FORMAT_XBGR4444:
111 case DRM_FORMAT_XRGB1555:
112 case DRM_FORMAT_XRGB4444:
113 case DRM_FORMAT_YUYV:
114 case DRM_FORMAT_YVYU:
115 return &packed_2bpp_layout;
117 case DRM_FORMAT_BGR888:
118 case DRM_FORMAT_RGB888:
119 return &packed_3bpp_layout;
121 case DRM_FORMAT_ABGR2101010:
122 case DRM_FORMAT_ABGR8888:
123 case DRM_FORMAT_ARGB2101010:
124 case DRM_FORMAT_ARGB8888:
125 case DRM_FORMAT_AYUV:
126 case DRM_FORMAT_BGRA1010102:
127 case DRM_FORMAT_BGRA8888:
128 case DRM_FORMAT_BGRX1010102:
129 case DRM_FORMAT_BGRX8888:
130 case DRM_FORMAT_RGBA1010102:
131 case DRM_FORMAT_RGBA8888:
132 case DRM_FORMAT_RGBX1010102:
133 case DRM_FORMAT_RGBX8888:
134 case DRM_FORMAT_XBGR2101010:
135 case DRM_FORMAT_XBGR8888:
136 case DRM_FORMAT_XRGB2101010:
137 case DRM_FORMAT_XRGB8888:
138 return &packed_4bpp_layout;
141 drv_log("UNKNOWN FORMAT %d\n", format);
146 size_t drv_num_planes_from_format(uint32_t format)
148 const struct planar_layout *layout = layout_from_format(format);
151 * drv_bo_new calls this function early to query number of planes and
152 * considers 0 planes to mean unknown format, so we have to support
153 * that. All other layout_from_format() queries can assume that the
154 * format is supported and that the return value is non-NULL.
157 return layout ? layout->num_planes : 0;
160 uint32_t drv_height_from_format(uint32_t format, uint32_t height, size_t plane)
162 const struct planar_layout *layout = layout_from_format(format);
164 assert(plane < layout->num_planes);
166 return DIV_ROUND_UP(height, layout->vertical_subsampling[plane]);
169 uint32_t drv_bytes_per_pixel_from_format(uint32_t format, size_t plane)
171 const struct planar_layout *layout = layout_from_format(format);
173 assert(plane < layout->num_planes);
175 return layout->bytes_per_pixel[plane];
179 * This function returns the stride for a given format, width and plane.
181 uint32_t drv_stride_from_format(uint32_t format, uint32_t width, size_t plane)
183 const struct planar_layout *layout = layout_from_format(format);
184 assert(plane < layout->num_planes);
186 uint32_t plane_width = DIV_ROUND_UP(width, layout->horizontal_subsampling[plane]);
187 uint32_t stride = plane_width * layout->bytes_per_pixel[plane];
190 * The stride of Android YV12 buffers is required to be aligned to 16 bytes
191 * (see <system/graphics.h>).
193 if (format == DRM_FORMAT_YVU420_ANDROID)
194 stride = (plane == 0) ? ALIGN(stride, 32) : ALIGN(stride, 16);
199 uint32_t drv_size_from_format(uint32_t format, uint32_t stride, uint32_t height, size_t plane)
201 return stride * drv_height_from_format(format, height, plane);
204 static uint32_t subsample_stride(uint32_t stride, uint32_t format, size_t plane)
208 case DRM_FORMAT_YVU420:
209 case DRM_FORMAT_YVU420_ANDROID:
210 stride = DIV_ROUND_UP(stride, 2);
219 * This function fills in the buffer object given the driver aligned stride of
220 * the first plane, height and a format. This function assumes there is just
221 * one kernel buffer per buffer object.
223 int drv_bo_from_format(struct bo *bo, uint32_t stride, uint32_t aligned_height, uint32_t format)
226 size_t p, num_planes;
229 num_planes = drv_num_planes_from_format(format);
233 * HAL_PIXEL_FORMAT_YV12 requires that (see <system/graphics.h>):
234 * - the aligned height is same as the buffer's height.
235 * - the chroma stride is 16 bytes aligned, i.e., the luma's strides
236 * is 32 bytes aligned.
238 if (format == DRM_FORMAT_YVU420_ANDROID) {
239 assert(aligned_height == bo->height);
240 assert(stride == ALIGN(stride, 32));
243 for (p = 0; p < num_planes; p++) {
244 bo->strides[p] = subsample_stride(stride, format, p);
245 bo->sizes[p] = drv_size_from_format(format, bo->strides[p], aligned_height, p);
246 bo->offsets[p] = offset;
247 offset += bo->sizes[p];
250 bo->total_size = offset;
254 int drv_dumb_bo_create(struct bo *bo, uint32_t width, uint32_t height, uint32_t format,
259 uint32_t aligned_width, aligned_height;
260 struct drm_mode_create_dumb create_dumb;
262 aligned_width = width;
263 aligned_height = height;
265 case DRM_FORMAT_YVU420_ANDROID:
266 /* Align width to 32 pixels, so chroma strides are 16 bytes as
267 * Android requires. */
268 aligned_width = ALIGN(width, 32);
269 /* Adjust the height to include room for chroma planes.
271 * HAL_PIXEL_FORMAT_YV12 requires that the buffer's height not
273 aligned_height = 3 * DIV_ROUND_UP(bo->height, 2);
275 case DRM_FORMAT_YVU420:
276 case DRM_FORMAT_NV12:
277 /* Adjust the height to include room for chroma planes */
278 aligned_height = 3 * DIV_ROUND_UP(height, 2);
284 memset(&create_dumb, 0, sizeof(create_dumb));
285 create_dumb.height = aligned_height;
286 create_dumb.width = aligned_width;
287 create_dumb.bpp = layout_from_format(format)->bytes_per_pixel[0] * 8;
288 create_dumb.flags = 0;
290 ret = drmIoctl(bo->drv->fd, DRM_IOCTL_MODE_CREATE_DUMB, &create_dumb);
292 drv_log("DRM_IOCTL_MODE_CREATE_DUMB failed (%d, %d)\n", bo->drv->fd, errno);
296 drv_bo_from_format(bo, create_dumb.pitch, height, format);
298 for (plane = 0; plane < bo->num_planes; plane++)
299 bo->handles[plane].u32 = create_dumb.handle;
301 bo->total_size = create_dumb.size;
305 int drv_dumb_bo_destroy(struct bo *bo)
307 struct drm_mode_destroy_dumb destroy_dumb;
310 memset(&destroy_dumb, 0, sizeof(destroy_dumb));
311 destroy_dumb.handle = bo->handles[0].u32;
313 ret = drmIoctl(bo->drv->fd, DRM_IOCTL_MODE_DESTROY_DUMB, &destroy_dumb);
315 drv_log("DRM_IOCTL_MODE_DESTROY_DUMB failed (handle=%x)\n", bo->handles[0].u32);
322 int drv_gem_bo_destroy(struct bo *bo)
324 struct drm_gem_close gem_close;
328 for (plane = 0; plane < bo->num_planes; plane++) {
329 for (i = 0; i < plane; i++)
330 if (bo->handles[i].u32 == bo->handles[plane].u32)
332 /* Make sure close hasn't already been called on this handle */
336 memset(&gem_close, 0, sizeof(gem_close));
337 gem_close.handle = bo->handles[plane].u32;
339 ret = drmIoctl(bo->drv->fd, DRM_IOCTL_GEM_CLOSE, &gem_close);
341 drv_log("DRM_IOCTL_GEM_CLOSE failed (handle=%x) error %d\n",
342 bo->handles[plane].u32, ret);
350 int drv_prime_bo_import(struct bo *bo, struct drv_import_fd_data *data)
354 struct drm_prime_handle prime_handle;
356 for (plane = 0; plane < bo->num_planes; plane++) {
357 memset(&prime_handle, 0, sizeof(prime_handle));
358 prime_handle.fd = data->fds[plane];
360 ret = drmIoctl(bo->drv->fd, DRM_IOCTL_PRIME_FD_TO_HANDLE, &prime_handle);
363 drv_log("DRM_IOCTL_PRIME_FD_TO_HANDLE failed (fd=%u)\n", prime_handle.fd);
366 * Need to call GEM close on planes that were opened,
367 * if any. Adjust the num_planes variable to be the
368 * plane that failed, so GEM close will be called on
369 * planes before that plane.
371 bo->num_planes = plane;
372 drv_gem_bo_destroy(bo);
376 bo->handles[plane].u32 = prime_handle.handle;
382 void *drv_dumb_bo_map(struct bo *bo, struct vma *vma, size_t plane, uint32_t map_flags)
386 struct drm_mode_map_dumb map_dumb;
388 memset(&map_dumb, 0, sizeof(map_dumb));
389 map_dumb.handle = bo->handles[plane].u32;
391 ret = drmIoctl(bo->drv->fd, DRM_IOCTL_MODE_MAP_DUMB, &map_dumb);
393 drv_log("DRM_IOCTL_MODE_MAP_DUMB failed\n");
397 for (i = 0; i < bo->num_planes; i++)
398 if (bo->handles[i].u32 == bo->handles[plane].u32)
399 vma->length += bo->sizes[i];
401 return mmap(0, vma->length, drv_get_prot(map_flags), MAP_SHARED, bo->drv->fd,
405 int drv_bo_munmap(struct bo *bo, struct vma *vma)
407 return munmap(vma->addr, vma->length);
410 int drv_mapping_destroy(struct bo *bo)
414 struct mapping *mapping;
418 * This function is called right before the buffer is destroyed. It will free any mappings
419 * associated with the buffer.
423 for (plane = 0; plane < bo->num_planes; plane++) {
424 while (idx < drv_array_size(bo->drv->mappings)) {
425 mapping = (struct mapping *)drv_array_at_idx(bo->drv->mappings, idx);
426 if (mapping->vma->handle != bo->handles[plane].u32) {
431 if (!--mapping->vma->refcount) {
432 ret = bo->drv->backend->bo_unmap(bo, mapping->vma);
434 drv_log("munmap failed\n");
441 /* This shrinks and shifts the array, so don't increment idx. */
442 drv_array_remove(bo->drv->mappings, idx);
449 int drv_get_prot(uint32_t map_flags)
451 return (BO_MAP_WRITE & map_flags) ? PROT_WRITE | PROT_READ : PROT_READ;
454 uintptr_t drv_get_reference_count(struct driver *drv, struct bo *bo, size_t plane)
459 if (!drmHashLookup(drv->buffer_table, bo->handles[plane].u32, &count))
460 num = (uintptr_t)(count);
465 void drv_increment_reference_count(struct driver *drv, struct bo *bo, size_t plane)
467 uintptr_t num = drv_get_reference_count(drv, bo, plane);
469 /* If a value isn't in the table, drmHashDelete is a no-op */
470 drmHashDelete(drv->buffer_table, bo->handles[plane].u32);
471 drmHashInsert(drv->buffer_table, bo->handles[plane].u32, (void *)(num + 1));
474 void drv_decrement_reference_count(struct driver *drv, struct bo *bo, size_t plane)
476 uintptr_t num = drv_get_reference_count(drv, bo, plane);
478 drmHashDelete(drv->buffer_table, bo->handles[plane].u32);
481 drmHashInsert(drv->buffer_table, bo->handles[plane].u32, (void *)(num - 1));
484 void drv_add_combination(struct driver *drv, const uint32_t format,
485 struct format_metadata *metadata, uint64_t use_flags)
487 struct combination combo = { .format = format,
488 .metadata = *metadata,
489 .use_flags = use_flags };
491 drv_array_append(drv->combos, &combo);
494 void drv_add_combinations(struct driver *drv, const uint32_t *formats, uint32_t num_formats,
495 struct format_metadata *metadata, uint64_t use_flags)
499 for (i = 0; i < num_formats; i++) {
500 struct combination combo = { .format = formats[i],
501 .metadata = *metadata,
502 .use_flags = use_flags };
504 drv_array_append(drv->combos, &combo);
508 void drv_modify_combination(struct driver *drv, uint32_t format, struct format_metadata *metadata,
512 struct combination *combo;
513 /* Attempts to add the specified flags to an existing combination. */
514 for (i = 0; i < drv_array_size(drv->combos); i++) {
515 combo = (struct combination *)drv_array_at_idx(drv->combos, i);
516 if (combo->format == format && combo->metadata.tiling == metadata->tiling &&
517 combo->metadata.modifier == metadata->modifier)
518 combo->use_flags |= use_flags;
522 struct drv_array *drv_query_kms(struct driver *drv)
524 struct drv_array *kms_items;
525 uint64_t plane_type, use_flag;
528 drmModePlanePtr plane;
529 drmModePropertyPtr prop;
530 drmModePlaneResPtr resources;
531 drmModeObjectPropertiesPtr props;
533 kms_items = drv_array_init(sizeof(struct kms_item));
538 * The ability to return universal planes is only complete on
539 * ChromeOS kernel versions >= v3.18. The SET_CLIENT_CAP ioctl
540 * therefore might return an error code, so don't check it. If it
541 * fails, it'll just return the plane list as overlay planes, which is
542 * fine in our case (our drivers already have cursor bits set).
543 * modetest in libdrm does the same thing.
545 drmSetClientCap(drv->fd, DRM_CLIENT_CAP_UNIVERSAL_PLANES, 1);
547 resources = drmModeGetPlaneResources(drv->fd);
551 for (i = 0; i < resources->count_planes; i++) {
552 plane = drmModeGetPlane(drv->fd, resources->planes[i]);
556 props = drmModeObjectGetProperties(drv->fd, plane->plane_id, DRM_MODE_OBJECT_PLANE);
560 for (j = 0; j < props->count_props; j++) {
561 prop = drmModeGetProperty(drv->fd, props->props[j]);
563 if (strcmp(prop->name, "type") == 0) {
564 plane_type = props->prop_values[j];
567 drmModeFreeProperty(prop);
571 switch (plane_type) {
572 case DRM_PLANE_TYPE_OVERLAY:
573 case DRM_PLANE_TYPE_PRIMARY:
574 use_flag = BO_USE_SCANOUT;
576 case DRM_PLANE_TYPE_CURSOR:
577 use_flag = BO_USE_CURSOR;
583 for (j = 0; j < plane->count_formats; j++) {
585 for (k = 0; k < drv_array_size(kms_items); k++) {
586 struct kms_item *item = drv_array_at_idx(kms_items, k);
587 if (item->format == plane->formats[j] &&
588 item->modifier == DRM_FORMAT_MOD_LINEAR) {
589 item->use_flags |= use_flag;
596 struct kms_item item = { .format = plane->formats[j],
597 .modifier = DRM_FORMAT_MOD_LINEAR,
598 .use_flags = use_flag };
600 drv_array_append(kms_items, &item);
604 drmModeFreeObjectProperties(props);
605 drmModeFreePlane(plane);
608 drmModeFreePlaneResources(resources);
610 if (kms_items && !drv_array_size(kms_items)) {
611 drv_array_destroy(kms_items);
618 int drv_modify_linear_combinations(struct driver *drv)
621 struct kms_item *item;
622 struct combination *combo;
623 struct drv_array *kms_items;
626 * All current drivers can scanout linear XRGB8888/ARGB8888 as a primary
627 * plane and as a cursor. Some drivers don't support
628 * drmModeGetPlaneResources, so add the combination here. Note that the
629 * kernel disregards the alpha component of ARGB unless it's an overlay
632 drv_modify_combination(drv, DRM_FORMAT_XRGB8888, &LINEAR_METADATA,
633 BO_USE_CURSOR | BO_USE_SCANOUT);
634 drv_modify_combination(drv, DRM_FORMAT_ARGB8888, &LINEAR_METADATA,
635 BO_USE_CURSOR | BO_USE_SCANOUT);
637 kms_items = drv_query_kms(drv);
641 for (i = 0; i < drv_array_size(kms_items); i++) {
642 item = (struct kms_item *)drv_array_at_idx(kms_items, i);
643 for (j = 0; j < drv_array_size(drv->combos); j++) {
644 combo = drv_array_at_idx(drv->combos, j);
645 if (item->format == combo->format)
646 combo->use_flags |= BO_USE_SCANOUT;
650 drv_array_destroy(kms_items);
655 * Pick the best modifier from modifiers, according to the ordering
656 * given by modifier_order.
658 uint64_t drv_pick_modifier(const uint64_t *modifiers, uint32_t count,
659 const uint64_t *modifier_order, uint32_t order_count)
663 for (i = 0; i < order_count; i++) {
664 for (j = 0; j < count; j++) {
665 if (modifiers[j] == modifier_order[i]) {
671 return DRM_FORMAT_MOD_LINEAR;