1 /*
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.
5 */
6
7 #include "drv_helpers.h"
8
9 #include <assert.h>
10 #include <errno.h>
11 #include <stdio.h>
12 #include <stdlib.h>
13 #include <string.h>
14 #include <sys/mman.h>
15 #include <sys/types.h>
16 #include <unistd.h>
17 #include <xf86drm.h>
18
19 #include "drv_priv.h"
20 #include "util.h"
21
22 struct planar_layout {
23 size_t num_planes;
24 int horizontal_subsampling[DRV_MAX_PLANES];
25 int vertical_subsampling[DRV_MAX_PLANES];
26 int bytes_per_pixel[DRV_MAX_PLANES];
27 };
28
29 // clang-format off
30
31 static const struct planar_layout packed_1bpp_layout = {
32 .num_planes = 1,
33 .horizontal_subsampling = { 1 },
34 .vertical_subsampling = { 1 },
35 .bytes_per_pixel = { 1 }
36 };
37
38 static const struct planar_layout packed_2bpp_layout = {
39 .num_planes = 1,
40 .horizontal_subsampling = { 1 },
41 .vertical_subsampling = { 1 },
42 .bytes_per_pixel = { 2 }
43 };
44
45 static const struct planar_layout packed_3bpp_layout = {
46 .num_planes = 1,
47 .horizontal_subsampling = { 1 },
48 .vertical_subsampling = { 1 },
49 .bytes_per_pixel = { 3 }
50 };
51
52 static const struct planar_layout packed_4bpp_layout = {
53 .num_planes = 1,
54 .horizontal_subsampling = { 1 },
55 .vertical_subsampling = { 1 },
56 .bytes_per_pixel = { 4 }
57 };
58
59 static const struct planar_layout packed_8bpp_layout = {
60 .num_planes = 1,
61 .horizontal_subsampling = { 1 },
62 .vertical_subsampling = { 1 },
63 .bytes_per_pixel = { 8 }
64 };
65
66 static const struct planar_layout biplanar_yuv_420_layout = {
67 .num_planes = 2,
68 .horizontal_subsampling = { 1, 2 },
69 .vertical_subsampling = { 1, 2 },
70 .bytes_per_pixel = { 1, 2 }
71 };
72
73 static const struct planar_layout triplanar_yuv_420_layout = {
74 .num_planes = 3,
75 .horizontal_subsampling = { 1, 2, 2 },
76 .vertical_subsampling = { 1, 2, 2 },
77 .bytes_per_pixel = { 1, 1, 1 }
78 };
79
80 static const struct planar_layout biplanar_yuv_p010_layout = {
81 .num_planes = 2,
82 .horizontal_subsampling = { 1, 2 },
83 .vertical_subsampling = { 1, 2 },
84 .bytes_per_pixel = { 2, 4 }
85 };
86
87 // clang-format on
88
layout_from_format(uint32_t format)89 static const struct planar_layout *layout_from_format(uint32_t format)
90 {
91 switch (format) {
92 case DRM_FORMAT_BGR233:
93 case DRM_FORMAT_C8:
94 case DRM_FORMAT_R8:
95 case DRM_FORMAT_RGB332:
96 return &packed_1bpp_layout;
97
98 case DRM_FORMAT_R16:
99 return &packed_2bpp_layout;
100
101 case DRM_FORMAT_YVU420:
102 case DRM_FORMAT_YVU420_ANDROID:
103 return &triplanar_yuv_420_layout;
104
105 case DRM_FORMAT_NV12:
106 case DRM_FORMAT_NV21:
107 return &biplanar_yuv_420_layout;
108
109 case DRM_FORMAT_P010:
110 return &biplanar_yuv_p010_layout;
111
112 case DRM_FORMAT_ABGR1555:
113 case DRM_FORMAT_ABGR4444:
114 case DRM_FORMAT_ARGB1555:
115 case DRM_FORMAT_ARGB4444:
116 case DRM_FORMAT_BGR565:
117 case DRM_FORMAT_BGRA4444:
118 case DRM_FORMAT_BGRA5551:
119 case DRM_FORMAT_BGRX4444:
120 case DRM_FORMAT_BGRX5551:
121 case DRM_FORMAT_GR88:
122 case DRM_FORMAT_RG88:
123 case DRM_FORMAT_RGB565:
124 case DRM_FORMAT_RGBA4444:
125 case DRM_FORMAT_RGBA5551:
126 case DRM_FORMAT_RGBX4444:
127 case DRM_FORMAT_RGBX5551:
128 case DRM_FORMAT_UYVY:
129 case DRM_FORMAT_VYUY:
130 case DRM_FORMAT_XBGR1555:
131 case DRM_FORMAT_XBGR4444:
132 case DRM_FORMAT_XRGB1555:
133 case DRM_FORMAT_XRGB4444:
134 case DRM_FORMAT_YUYV:
135 case DRM_FORMAT_YVYU:
136 case DRM_FORMAT_MTISP_SXYZW10:
137 return &packed_2bpp_layout;
138
139 case DRM_FORMAT_BGR888:
140 case DRM_FORMAT_RGB888:
141 return &packed_3bpp_layout;
142
143 case DRM_FORMAT_ABGR2101010:
144 case DRM_FORMAT_ABGR8888:
145 case DRM_FORMAT_ARGB2101010:
146 case DRM_FORMAT_ARGB8888:
147 case DRM_FORMAT_AYUV:
148 case DRM_FORMAT_BGRA1010102:
149 case DRM_FORMAT_BGRA8888:
150 case DRM_FORMAT_BGRX1010102:
151 case DRM_FORMAT_BGRX8888:
152 case DRM_FORMAT_RGBA1010102:
153 case DRM_FORMAT_RGBA8888:
154 case DRM_FORMAT_RGBX1010102:
155 case DRM_FORMAT_RGBX8888:
156 case DRM_FORMAT_XBGR2101010:
157 case DRM_FORMAT_XBGR8888:
158 case DRM_FORMAT_XRGB2101010:
159 case DRM_FORMAT_XRGB8888:
160 return &packed_4bpp_layout;
161
162 case DRM_FORMAT_ABGR16161616F:
163 return &packed_8bpp_layout;
164
165 default:
166 drv_log("UNKNOWN FORMAT %d\n", format);
167 return NULL;
168 }
169 }
170
drv_num_planes_from_format(uint32_t format)171 size_t drv_num_planes_from_format(uint32_t format)
172 {
173 const struct planar_layout *layout = layout_from_format(format);
174
175 /*
176 * drv_bo_new calls this function early to query number of planes and
177 * considers 0 planes to mean unknown format, so we have to support
178 * that. All other layout_from_format() queries can assume that the
179 * format is supported and that the return value is non-NULL.
180 */
181
182 return layout ? layout->num_planes : 0;
183 }
184
drv_num_planes_from_modifier(struct driver * drv,uint32_t format,uint64_t modifier)185 size_t drv_num_planes_from_modifier(struct driver *drv, uint32_t format, uint64_t modifier)
186 {
187 size_t planes = drv_num_planes_from_format(format);
188
189 /* Disallow unsupported formats. */
190 if (!planes)
191 return 0;
192
193 if (drv->backend->num_planes_from_modifier && modifier != DRM_FORMAT_MOD_INVALID &&
194 modifier != DRM_FORMAT_MOD_LINEAR)
195 return drv->backend->num_planes_from_modifier(drv, format, modifier);
196
197 return planes;
198 }
199
drv_height_from_format(uint32_t format,uint32_t height,size_t plane)200 uint32_t drv_height_from_format(uint32_t format, uint32_t height, size_t plane)
201 {
202 const struct planar_layout *layout = layout_from_format(format);
203
204 assert(plane < layout->num_planes);
205
206 return DIV_ROUND_UP(height, layout->vertical_subsampling[plane]);
207 }
208
drv_vertical_subsampling_from_format(uint32_t format,size_t plane)209 uint32_t drv_vertical_subsampling_from_format(uint32_t format, size_t plane)
210 {
211 const struct planar_layout *layout = layout_from_format(format);
212
213 assert(plane < layout->num_planes);
214
215 return layout->vertical_subsampling[plane];
216 }
217
drv_bytes_per_pixel_from_format(uint32_t format,size_t plane)218 uint32_t drv_bytes_per_pixel_from_format(uint32_t format, size_t plane)
219 {
220 const struct planar_layout *layout = layout_from_format(format);
221
222 assert(plane < layout->num_planes);
223
224 return layout->bytes_per_pixel[plane];
225 }
226
227 /*
228 * This function returns the stride for a given format, width and plane.
229 */
drv_stride_from_format(uint32_t format,uint32_t width,size_t plane)230 uint32_t drv_stride_from_format(uint32_t format, uint32_t width, size_t plane)
231 {
232 const struct planar_layout *layout = layout_from_format(format);
233 assert(plane < layout->num_planes);
234
235 uint32_t plane_width = DIV_ROUND_UP(width, layout->horizontal_subsampling[plane]);
236 uint32_t stride = plane_width * layout->bytes_per_pixel[plane];
237
238 /*
239 * The stride of Android YV12 buffers is required to be aligned to 16 bytes
240 * (see <system/graphics.h>).
241 */
242 if (format == DRM_FORMAT_YVU420_ANDROID)
243 stride = (plane == 0) ? ALIGN(stride, 32) : ALIGN(stride, 16);
244
245 return stride;
246 }
247
drv_size_from_format(uint32_t format,uint32_t stride,uint32_t height,size_t plane)248 uint32_t drv_size_from_format(uint32_t format, uint32_t stride, uint32_t height, size_t plane)
249 {
250 return stride * drv_height_from_format(format, height, plane);
251 }
252
subsample_stride(uint32_t stride,uint32_t format,size_t plane)253 static uint32_t subsample_stride(uint32_t stride, uint32_t format, size_t plane)
254 {
255 if (plane != 0) {
256 switch (format) {
257 case DRM_FORMAT_YVU420:
258 case DRM_FORMAT_YVU420_ANDROID:
259 stride = DIV_ROUND_UP(stride, 2);
260 break;
261 }
262 }
263
264 return stride;
265 }
266
267 /*
268 * This function fills in the buffer object given the driver aligned stride of
269 * the first plane, height and a format. This function assumes there is just
270 * one kernel buffer per buffer object.
271 */
drv_bo_from_format(struct bo * bo,uint32_t stride,uint32_t aligned_height,uint32_t format)272 int drv_bo_from_format(struct bo *bo, uint32_t stride, uint32_t aligned_height, uint32_t format)
273 {
274 uint32_t padding[DRV_MAX_PLANES] = { 0 };
275 return drv_bo_from_format_and_padding(bo, stride, aligned_height, format, padding);
276 }
277
drv_bo_from_format_and_padding(struct bo * bo,uint32_t stride,uint32_t aligned_height,uint32_t format,uint32_t padding[DRV_MAX_PLANES])278 int drv_bo_from_format_and_padding(struct bo *bo, uint32_t stride, uint32_t aligned_height,
279 uint32_t format, uint32_t padding[DRV_MAX_PLANES])
280 {
281 size_t p, num_planes;
282 uint32_t offset = 0;
283
284 num_planes = drv_num_planes_from_format(format);
285 assert(num_planes);
286
287 /*
288 * HAL_PIXEL_FORMAT_YV12 requires that (see <system/graphics.h>):
289 * - the aligned height is same as the buffer's height.
290 * - the chroma stride is 16 bytes aligned, i.e., the luma's strides
291 * is 32 bytes aligned.
292 */
293 if (format == DRM_FORMAT_YVU420_ANDROID) {
294 assert(aligned_height == bo->meta.height);
295 assert(stride == ALIGN(stride, 32));
296 }
297
298 for (p = 0; p < num_planes; p++) {
299 bo->meta.strides[p] = subsample_stride(stride, format, p);
300 bo->meta.sizes[p] =
301 drv_size_from_format(format, bo->meta.strides[p], aligned_height, p) +
302 padding[p];
303 bo->meta.offsets[p] = offset;
304 offset += bo->meta.sizes[p];
305 }
306
307 bo->meta.total_size = offset;
308 return 0;
309 }
310
drv_dumb_bo_create_ex(struct bo * bo,uint32_t width,uint32_t height,uint32_t format,uint64_t use_flags,uint64_t quirks)311 int drv_dumb_bo_create_ex(struct bo *bo, uint32_t width, uint32_t height, uint32_t format,
312 uint64_t use_flags, uint64_t quirks)
313 {
314 int ret;
315 size_t plane;
316 uint32_t aligned_width, aligned_height;
317 struct drm_mode_create_dumb create_dumb = { 0 };
318
319 aligned_width = width;
320 aligned_height = height;
321 switch (format) {
322 case DRM_FORMAT_R16:
323 /* HAL_PIXEL_FORMAT_Y16 requires that the buffer's width be 16 pixel
324 * aligned. See hardware/interfaces/graphics/common/1.0/types.hal. */
325 aligned_width = ALIGN(width, 16);
326 break;
327 case DRM_FORMAT_YVU420_ANDROID:
328 /* HAL_PIXEL_FORMAT_YV12 requires that the buffer's height not
329 * be aligned. Update 'height' so that drv_bo_from_format below
330 * uses the non-aligned height. */
331 height = bo->meta.height;
332
333 /* Align width to 32 pixels, so chroma strides are 16 bytes as
334 * Android requires. */
335 aligned_width = ALIGN(width, 32);
336
337 /* Adjust the height to include room for chroma planes. */
338 aligned_height = 3 * DIV_ROUND_UP(height, 2);
339 break;
340 case DRM_FORMAT_YVU420:
341 case DRM_FORMAT_NV12:
342 case DRM_FORMAT_NV21:
343 case DRM_FORMAT_P010:
344 /* Adjust the height to include room for chroma planes */
345 aligned_height = 3 * DIV_ROUND_UP(height, 2);
346 break;
347 default:
348 break;
349 }
350
351 if (quirks & BO_QUIRK_DUMB32BPP) {
352 aligned_width =
353 DIV_ROUND_UP(aligned_width * layout_from_format(format)->bytes_per_pixel[0], 4);
354 create_dumb.bpp = 32;
355 } else {
356 create_dumb.bpp = layout_from_format(format)->bytes_per_pixel[0] * 8;
357 }
358 create_dumb.width = aligned_width;
359 create_dumb.height = aligned_height;
360 create_dumb.flags = 0;
361
362 ret = drmIoctl(bo->drv->fd, DRM_IOCTL_MODE_CREATE_DUMB, &create_dumb);
363 if (ret) {
364 drv_log("DRM_IOCTL_MODE_CREATE_DUMB failed (%d, %d)\n", bo->drv->fd, errno);
365 return -errno;
366 }
367
368 drv_bo_from_format(bo, create_dumb.pitch, height, format);
369
370 for (plane = 0; plane < bo->meta.num_planes; plane++)
371 bo->handles[plane].u32 = create_dumb.handle;
372
373 bo->meta.total_size = create_dumb.size;
374 return 0;
375 }
376
drv_dumb_bo_create(struct bo * bo,uint32_t width,uint32_t height,uint32_t format,uint64_t use_flags)377 int drv_dumb_bo_create(struct bo *bo, uint32_t width, uint32_t height, uint32_t format,
378 uint64_t use_flags)
379 {
380 return drv_dumb_bo_create_ex(bo, width, height, format, use_flags, BO_QUIRK_NONE);
381 }
382
drv_dumb_bo_destroy(struct bo * bo)383 int drv_dumb_bo_destroy(struct bo *bo)
384 {
385 int ret;
386 struct drm_mode_destroy_dumb destroy_dumb = { 0 };
387
388 destroy_dumb.handle = bo->handles[0].u32;
389 ret = drmIoctl(bo->drv->fd, DRM_IOCTL_MODE_DESTROY_DUMB, &destroy_dumb);
390 if (ret) {
391 drv_log("DRM_IOCTL_MODE_DESTROY_DUMB failed (handle=%x)\n", bo->handles[0].u32);
392 return -errno;
393 }
394
395 return 0;
396 }
397
drv_gem_bo_destroy(struct bo * bo)398 int drv_gem_bo_destroy(struct bo *bo)
399 {
400 struct drm_gem_close gem_close;
401 int ret, error = 0;
402 size_t plane, i;
403
404 for (plane = 0; plane < bo->meta.num_planes; plane++) {
405 for (i = 0; i < plane; i++)
406 if (bo->handles[i].u32 == bo->handles[plane].u32)
407 break;
408 /* Make sure close hasn't already been called on this handle */
409 if (i != plane)
410 continue;
411
412 memset(&gem_close, 0, sizeof(gem_close));
413 gem_close.handle = bo->handles[plane].u32;
414
415 ret = drmIoctl(bo->drv->fd, DRM_IOCTL_GEM_CLOSE, &gem_close);
416 if (ret) {
417 drv_log("DRM_IOCTL_GEM_CLOSE failed (handle=%x) error %d\n",
418 bo->handles[plane].u32, ret);
419 error = -errno;
420 }
421 }
422
423 return error;
424 }
425
drv_prime_bo_import(struct bo * bo,struct drv_import_fd_data * data)426 int drv_prime_bo_import(struct bo *bo, struct drv_import_fd_data *data)
427 {
428 int ret;
429 size_t plane;
430 struct drm_prime_handle prime_handle;
431
432 for (plane = 0; plane < bo->meta.num_planes; plane++) {
433 memset(&prime_handle, 0, sizeof(prime_handle));
434 prime_handle.fd = data->fds[plane];
435
436 ret = drmIoctl(bo->drv->fd, DRM_IOCTL_PRIME_FD_TO_HANDLE, &prime_handle);
437
438 if (ret) {
439 drv_log("DRM_IOCTL_PRIME_FD_TO_HANDLE failed (fd=%u)\n", prime_handle.fd);
440
441 /*
442 * Need to call GEM close on planes that were opened,
443 * if any. Adjust the num_planes variable to be the
444 * plane that failed, so GEM close will be called on
445 * planes before that plane.
446 */
447 bo->meta.num_planes = plane;
448 drv_gem_bo_destroy(bo);
449 return -errno;
450 }
451
452 bo->handles[plane].u32 = prime_handle.handle;
453 }
454 bo->meta.tiling = data->tiling;
455
456 return 0;
457 }
458
drv_dumb_bo_map(struct bo * bo,struct vma * vma,size_t plane,uint32_t map_flags)459 void *drv_dumb_bo_map(struct bo *bo, struct vma *vma, size_t plane, uint32_t map_flags)
460 {
461 int ret;
462 size_t i;
463 struct drm_mode_map_dumb map_dumb;
464
465 memset(&map_dumb, 0, sizeof(map_dumb));
466 map_dumb.handle = bo->handles[plane].u32;
467
468 ret = drmIoctl(bo->drv->fd, DRM_IOCTL_MODE_MAP_DUMB, &map_dumb);
469 if (ret) {
470 drv_log("DRM_IOCTL_MODE_MAP_DUMB failed\n");
471 return MAP_FAILED;
472 }
473
474 for (i = 0; i < bo->meta.num_planes; i++)
475 if (bo->handles[i].u32 == bo->handles[plane].u32)
476 vma->length += bo->meta.sizes[i];
477
478 return mmap(0, vma->length, drv_get_prot(map_flags), MAP_SHARED, bo->drv->fd,
479 map_dumb.offset);
480 }
481
drv_bo_munmap(struct bo * bo,struct vma * vma)482 int drv_bo_munmap(struct bo *bo, struct vma *vma)
483 {
484 return munmap(vma->addr, vma->length);
485 }
486
drv_get_prot(uint32_t map_flags)487 int drv_get_prot(uint32_t map_flags)
488 {
489 return (BO_MAP_WRITE & map_flags) ? PROT_WRITE | PROT_READ : PROT_READ;
490 }
491
drv_add_combination(struct driver * drv,const uint32_t format,struct format_metadata * metadata,uint64_t use_flags)492 void drv_add_combination(struct driver *drv, const uint32_t format,
493 struct format_metadata *metadata, uint64_t use_flags)
494 {
495 struct combination combo = { .format = format,
496 .metadata = *metadata,
497 .use_flags = use_flags };
498
499 drv_array_append(drv->combos, &combo);
500 }
501
drv_add_combinations(struct driver * drv,const uint32_t * formats,uint32_t num_formats,struct format_metadata * metadata,uint64_t use_flags)502 void drv_add_combinations(struct driver *drv, const uint32_t *formats, uint32_t num_formats,
503 struct format_metadata *metadata, uint64_t use_flags)
504 {
505 uint32_t i;
506
507 for (i = 0; i < num_formats; i++) {
508 struct combination combo = { .format = formats[i],
509 .metadata = *metadata,
510 .use_flags = use_flags };
511
512 drv_array_append(drv->combos, &combo);
513 }
514 }
515
drv_modify_combination(struct driver * drv,uint32_t format,struct format_metadata * metadata,uint64_t use_flags)516 void drv_modify_combination(struct driver *drv, uint32_t format, struct format_metadata *metadata,
517 uint64_t use_flags)
518 {
519 uint32_t i;
520 struct combination *combo;
521 /* Attempts to add the specified flags to an existing combination. */
522 for (i = 0; i < drv_array_size(drv->combos); i++) {
523 combo = (struct combination *)drv_array_at_idx(drv->combos, i);
524 if (combo->format == format && combo->metadata.tiling == metadata->tiling &&
525 combo->metadata.modifier == metadata->modifier)
526 combo->use_flags |= use_flags;
527 }
528 }
529
drv_modify_linear_combinations(struct driver * drv)530 int drv_modify_linear_combinations(struct driver *drv)
531 {
532 /*
533 * All current drivers can scanout linear XRGB8888/ARGB8888 as a primary
534 * plane and as a cursor.
535 */
536 drv_modify_combination(drv, DRM_FORMAT_XRGB8888, &LINEAR_METADATA,
537 BO_USE_CURSOR | BO_USE_SCANOUT);
538 drv_modify_combination(drv, DRM_FORMAT_ARGB8888, &LINEAR_METADATA,
539 BO_USE_CURSOR | BO_USE_SCANOUT);
540 return 0;
541 }
542
543 /*
544 * Pick the best modifier from modifiers, according to the ordering
545 * given by modifier_order.
546 */
drv_pick_modifier(const uint64_t * modifiers,uint32_t count,const uint64_t * modifier_order,uint32_t order_count)547 uint64_t drv_pick_modifier(const uint64_t *modifiers, uint32_t count,
548 const uint64_t *modifier_order, uint32_t order_count)
549 {
550 uint32_t i, j;
551
552 for (i = 0; i < order_count; i++) {
553 for (j = 0; j < count; j++) {
554 if (modifiers[j] == modifier_order[i]) {
555 return modifiers[j];
556 }
557 }
558 }
559
560 return DRM_FORMAT_MOD_LINEAR;
561 }
562
563 /*
564 * Search a list of modifiers to see if a given modifier is present
565 */
drv_has_modifier(const uint64_t * list,uint32_t count,uint64_t modifier)566 bool drv_has_modifier(const uint64_t *list, uint32_t count, uint64_t modifier)
567 {
568 uint32_t i;
569 for (i = 0; i < count; i++)
570 if (list[i] == modifier)
571 return true;
572
573 return false;
574 }
575
drv_resolve_format_and_use_flags_helper(struct driver * drv,uint32_t format,uint64_t use_flags,uint32_t * out_format,uint64_t * out_use_flags)576 void drv_resolve_format_and_use_flags_helper(struct driver *drv, uint32_t format,
577 uint64_t use_flags, uint32_t *out_format,
578 uint64_t *out_use_flags)
579 {
580 *out_format = format;
581 *out_use_flags = use_flags;
582 switch (format) {
583 case DRM_FORMAT_FLEX_IMPLEMENTATION_DEFINED:
584 /* Common camera implementation defined format. */
585 if (use_flags & (BO_USE_CAMERA_READ | BO_USE_CAMERA_WRITE)) {
586 *out_format = DRM_FORMAT_NV12;
587 } else {
588 /* HACK: See b/28671744 */
589 *out_format = DRM_FORMAT_XBGR8888;
590 *out_use_flags &= ~BO_USE_HW_VIDEO_ENCODER;
591 }
592 break;
593 case DRM_FORMAT_FLEX_YCbCr_420_888:
594 /* Common flexible video format. */
595 *out_format = DRM_FORMAT_NV12;
596 break;
597 case DRM_FORMAT_YVU420_ANDROID:
598 *out_use_flags &= ~BO_USE_SCANOUT;
599 break;
600 default:
601 break;
602 }
603 }
604