OSDN Git Service

minigbm: Consolidate format info in new struct planar_layout
[android-x86/external-minigbm.git] / helpers.c
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 <assert.h>
8 #include <errno.h>
9 #include <stdbool.h>
10 #include <stdio.h>
11 #include <stdlib.h>
12 #include <string.h>
13 #include <sys/mman.h>
14 #include <xf86drm.h>
15 #include <xf86drmMode.h>
16
17 #include "drv_priv.h"
18 #include "helpers.h"
19 #include "util.h"
20
21 struct planar_layout {
22         size_t num_planes;
23         int horizontal_subsampling[DRV_MAX_PLANES];
24         int vertical_subsampling[DRV_MAX_PLANES];
25         int bytes_per_pixel[DRV_MAX_PLANES];
26 };
27
28 // clang-format off
29
30 static const struct planar_layout packed_1bpp_layout = {
31         .num_planes = 1,
32         .horizontal_subsampling = { 1 },
33         .vertical_subsampling = { 1 },
34         .bytes_per_pixel = { 1 }
35 };
36
37 static const struct planar_layout packed_2bpp_layout = {
38         .num_planes = 1,
39         .horizontal_subsampling = { 1 },
40         .vertical_subsampling = { 1 },
41         .bytes_per_pixel = { 2 }
42 };
43
44 static const struct planar_layout packed_3bpp_layout = {
45         .num_planes = 1,
46         .horizontal_subsampling = { 1 },
47         .vertical_subsampling = { 1 },
48         .bytes_per_pixel = { 3 }
49 };
50
51 static const struct planar_layout packed_4bpp_layout = {
52         .num_planes = 1,
53         .horizontal_subsampling = { 1 },
54         .vertical_subsampling = { 1 },
55         .bytes_per_pixel = { 4 }
56 };
57
58 static const struct planar_layout biplanar_yuv_420_layout = {
59         .num_planes = 2,
60         .horizontal_subsampling = { 1, 2 },
61         .vertical_subsampling = { 1, 2 },
62         .bytes_per_pixel = { 1, 2 }
63 };
64
65 static const struct planar_layout triplanar_yuv_420_layout = {
66         .num_planes = 3,
67         .horizontal_subsampling = { 1, 2, 2 },
68         .vertical_subsampling = { 1, 2, 2 },
69         .bytes_per_pixel = { 1, 1, 1 }
70 };
71
72 // clang-format on
73
74 static const struct planar_layout *layout_from_format(uint32_t format)
75 {
76         switch (format) {
77         case DRM_FORMAT_BGR233:
78         case DRM_FORMAT_C8:
79         case DRM_FORMAT_R8:
80         case DRM_FORMAT_RGB332:
81                 return &packed_1bpp_layout;
82
83         case DRM_FORMAT_YVU420:
84         case DRM_FORMAT_YVU420_ANDROID:
85                 return &triplanar_yuv_420_layout;
86
87         case DRM_FORMAT_NV12:
88         case DRM_FORMAT_NV21:
89                 return &biplanar_yuv_420_layout;
90
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;
116
117         case DRM_FORMAT_BGR888:
118         case DRM_FORMAT_RGB888:
119                 return &packed_3bpp_layout;
120
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;
139
140         default:
141                 drv_log("UNKNOWN FORMAT %d\n", format);
142                 return NULL;
143         }
144 }
145
146 size_t drv_num_planes_from_format(uint32_t format)
147 {
148         const struct planar_layout *layout = layout_from_format(format);
149
150         /*
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.
155          */
156
157         return layout ? layout->num_planes : 0;
158 }
159
160 uint32_t drv_height_from_format(uint32_t format, uint32_t height, size_t plane)
161 {
162         const struct planar_layout *layout = layout_from_format(format);
163
164         assert(plane < layout->num_planes);
165
166         return DIV_ROUND_UP(height, layout->vertical_subsampling[plane]);
167 }
168
169 uint32_t drv_bytes_per_pixel_from_format(uint32_t format, size_t plane)
170 {
171         const struct planar_layout *layout = layout_from_format(format);
172
173         assert(plane < layout->num_planes);
174
175         return layout->bytes_per_pixel[plane];
176 }
177
178 uint32_t drv_bo_get_stride_in_pixels(struct bo *bo)
179 {
180         uint32_t bytes_per_pixel = drv_bytes_per_pixel_from_format(bo->format, 0);
181         return DIV_ROUND_UP(bo->strides[0], bytes_per_pixel);
182 }
183
184 /*
185  * This function returns the stride for a given format, width and plane.
186  */
187 uint32_t drv_stride_from_format(uint32_t format, uint32_t width, size_t plane)
188 {
189         const struct planar_layout *layout = layout_from_format(format);
190         assert(plane < layout->num_planes);
191
192         uint32_t plane_width =
193                 DIV_ROUND_UP(width, layout->horizontal_subsampling[plane]);
194         uint32_t stride = plane_width * layout->bytes_per_pixel[plane];
195
196         /*
197          * The stride of Android YV12 buffers is required to be aligned to 16 bytes
198          * (see <system/graphics.h>).
199          */
200         if (format == DRM_FORMAT_YVU420_ANDROID)
201                 stride = (plane == 0) ? ALIGN(stride, 32) : ALIGN(stride, 16);
202
203         return stride;
204 }
205
206 uint32_t drv_size_from_format(uint32_t format, uint32_t stride, uint32_t height, size_t plane)
207 {
208         return stride * drv_height_from_format(format, height, plane);
209 }
210
211 static uint32_t subsample_stride(uint32_t stride, uint32_t format, size_t plane)
212 {
213         if (plane != 0) {
214                 switch (format) {
215                 case DRM_FORMAT_YVU420:
216                 case DRM_FORMAT_YVU420_ANDROID:
217                         stride = DIV_ROUND_UP(stride, 2);
218                         break;
219                 }
220         }
221
222         return stride;
223 }
224
225 /*
226  * This function fills in the buffer object given the driver aligned stride of
227  * the first plane, height and a format. This function assumes there is just
228  * one kernel buffer per buffer object.
229  */
230 int drv_bo_from_format(struct bo *bo, uint32_t stride, uint32_t aligned_height, uint32_t format)
231 {
232
233         size_t p, num_planes;
234         uint32_t offset = 0;
235
236         num_planes = drv_num_planes_from_format(format);
237         assert(num_planes);
238
239         /*
240          * HAL_PIXEL_FORMAT_YV12 requires that (see <system/graphics.h>):
241          *  - the aligned height is same as the buffer's height.
242          *  - the chroma stride is 16 bytes aligned, i.e., the luma's strides
243          *    is 32 bytes aligned.
244          */
245         if (format == DRM_FORMAT_YVU420_ANDROID) {
246                 assert(aligned_height == bo->height);
247                 assert(stride == ALIGN(stride, 32));
248         }
249
250         for (p = 0; p < num_planes; p++) {
251                 bo->strides[p] = subsample_stride(stride, format, p);
252                 bo->sizes[p] = drv_size_from_format(format, bo->strides[p], aligned_height, p);
253                 bo->offsets[p] = offset;
254                 offset += bo->sizes[p];
255         }
256
257         bo->total_size = offset;
258         return 0;
259 }
260
261 int drv_dumb_bo_create(struct bo *bo, uint32_t width, uint32_t height, uint32_t format,
262                        uint64_t use_flags)
263 {
264         int ret;
265         size_t plane;
266         uint32_t aligned_width, aligned_height;
267         struct drm_mode_create_dumb create_dumb;
268
269         aligned_width = width;
270         aligned_height = height;
271         if (format == DRM_FORMAT_YVU420_ANDROID) {
272                 /*
273                  * Align width to 32 pixels, so chroma strides are 16 bytes as
274                  * Android requires.
275                  */
276                 aligned_width = ALIGN(width, 32);
277         }
278
279         if (format == DRM_FORMAT_YVU420_ANDROID || format == DRM_FORMAT_YVU420) {
280                 aligned_height = 3 * DIV_ROUND_UP(height, 2);
281         }
282
283         memset(&create_dumb, 0, sizeof(create_dumb));
284         create_dumb.height = aligned_height;
285         create_dumb.width = aligned_width;
286         create_dumb.bpp = layout_from_format(format)->bytes_per_pixel[0] * 8;
287         create_dumb.flags = 0;
288
289         ret = drmIoctl(bo->drv->fd, DRM_IOCTL_MODE_CREATE_DUMB, &create_dumb);
290         if (ret) {
291                 drv_log("DRM_IOCTL_MODE_CREATE_DUMB failed (%d, %d)\n", bo->drv->fd, errno);
292                 return ret;
293         }
294
295         drv_bo_from_format(bo, create_dumb.pitch, height, format);
296
297         for (plane = 0; plane < bo->num_planes; plane++)
298                 bo->handles[plane].u32 = create_dumb.handle;
299
300         bo->total_size = create_dumb.size;
301         return 0;
302 }
303
304 int drv_dumb_bo_destroy(struct bo *bo)
305 {
306         struct drm_mode_destroy_dumb destroy_dumb;
307         int ret;
308
309         memset(&destroy_dumb, 0, sizeof(destroy_dumb));
310         destroy_dumb.handle = bo->handles[0].u32;
311
312         ret = drmIoctl(bo->drv->fd, DRM_IOCTL_MODE_DESTROY_DUMB, &destroy_dumb);
313         if (ret) {
314                 drv_log("DRM_IOCTL_MODE_DESTROY_DUMB failed (handle=%x)\n", bo->handles[0].u32);
315                 return ret;
316         }
317
318         return 0;
319 }
320
321 int drv_gem_bo_destroy(struct bo *bo)
322 {
323         struct drm_gem_close gem_close;
324         int ret, error = 0;
325         size_t plane, i;
326
327         for (plane = 0; plane < bo->num_planes; plane++) {
328                 for (i = 0; i < plane; i++)
329                         if (bo->handles[i].u32 == bo->handles[plane].u32)
330                                 break;
331                 /* Make sure close hasn't already been called on this handle */
332                 if (i != plane)
333                         continue;
334
335                 memset(&gem_close, 0, sizeof(gem_close));
336                 gem_close.handle = bo->handles[plane].u32;
337
338                 ret = drmIoctl(bo->drv->fd, DRM_IOCTL_GEM_CLOSE, &gem_close);
339                 if (ret) {
340                         drv_log("DRM_IOCTL_GEM_CLOSE failed (handle=%x) error %d\n",
341                                 bo->handles[plane].u32, ret);
342                         error = ret;
343                 }
344         }
345
346         return error;
347 }
348
349 int drv_prime_bo_import(struct bo *bo, struct drv_import_fd_data *data)
350 {
351         int ret;
352         size_t plane;
353         struct drm_prime_handle prime_handle;
354
355         for (plane = 0; plane < bo->num_planes; plane++) {
356                 memset(&prime_handle, 0, sizeof(prime_handle));
357                 prime_handle.fd = data->fds[plane];
358
359                 ret = drmIoctl(bo->drv->fd, DRM_IOCTL_PRIME_FD_TO_HANDLE, &prime_handle);
360
361                 if (ret) {
362                         drv_log("DRM_IOCTL_PRIME_FD_TO_HANDLE failed (fd=%u)\n", prime_handle.fd);
363
364                         /*
365                          * Need to call GEM close on planes that were opened,
366                          * if any. Adjust the num_planes variable to be the
367                          * plane that failed, so GEM close will be called on
368                          * planes before that plane.
369                          */
370                         bo->num_planes = plane;
371                         drv_gem_bo_destroy(bo);
372                         return ret;
373                 }
374
375                 bo->handles[plane].u32 = prime_handle.handle;
376         }
377
378         for (plane = 0; plane < bo->num_planes; plane++) {
379                 pthread_mutex_lock(&bo->drv->driver_lock);
380                 drv_increment_reference_count(bo->drv, bo, plane);
381                 pthread_mutex_unlock(&bo->drv->driver_lock);
382         }
383
384         return 0;
385 }
386
387 void *drv_dumb_bo_map(struct bo *bo, struct vma *vma, size_t plane, uint32_t map_flags)
388 {
389         int ret;
390         size_t i;
391         struct drm_mode_map_dumb map_dumb;
392
393         memset(&map_dumb, 0, sizeof(map_dumb));
394         map_dumb.handle = bo->handles[plane].u32;
395
396         ret = drmIoctl(bo->drv->fd, DRM_IOCTL_MODE_MAP_DUMB, &map_dumb);
397         if (ret) {
398                 drv_log("DRM_IOCTL_MODE_MAP_DUMB failed\n");
399                 return MAP_FAILED;
400         }
401
402         for (i = 0; i < bo->num_planes; i++)
403                 if (bo->handles[i].u32 == bo->handles[plane].u32)
404                         vma->length += bo->sizes[i];
405
406         return mmap(0, vma->length, drv_get_prot(map_flags), MAP_SHARED, bo->drv->fd,
407                     map_dumb.offset);
408 }
409
410 int drv_bo_munmap(struct bo *bo, struct vma *vma)
411 {
412         return munmap(vma->addr, vma->length);
413 }
414
415 int drv_mapping_destroy(struct bo *bo)
416 {
417         int ret;
418         size_t plane;
419         struct mapping *mapping;
420         uint32_t idx;
421
422         /*
423          * This function is called right before the buffer is destroyed. It will free any mappings
424          * associated with the buffer.
425          */
426
427         idx = 0;
428         for (plane = 0; plane < bo->num_planes; plane++) {
429                 while (idx < drv_array_size(bo->drv->mappings)) {
430                         mapping = (struct mapping *)drv_array_at_idx(bo->drv->mappings, idx);
431                         if (mapping->vma->handle != bo->handles[plane].u32) {
432                                 idx++;
433                                 continue;
434                         }
435
436                         if (!--mapping->vma->refcount) {
437                                 ret = bo->drv->backend->bo_unmap(bo, mapping->vma);
438                                 if (ret) {
439                                         drv_log("munmap failed\n");
440                                         return ret;
441                                 }
442
443                                 free(mapping->vma);
444                         }
445
446                         /* This shrinks and shifts the array, so don't increment idx. */
447                         drv_array_remove(bo->drv->mappings, idx);
448                 }
449         }
450
451         return 0;
452 }
453
454 int drv_get_prot(uint32_t map_flags)
455 {
456         return (BO_MAP_WRITE & map_flags) ? PROT_WRITE | PROT_READ : PROT_READ;
457 }
458
459 uintptr_t drv_get_reference_count(struct driver *drv, struct bo *bo, size_t plane)
460 {
461         void *count;
462         uintptr_t num = 0;
463
464         if (!drmHashLookup(drv->buffer_table, bo->handles[plane].u32, &count))
465                 num = (uintptr_t)(count);
466
467         return num;
468 }
469
470 void drv_increment_reference_count(struct driver *drv, struct bo *bo, size_t plane)
471 {
472         uintptr_t num = drv_get_reference_count(drv, bo, plane);
473
474         /* If a value isn't in the table, drmHashDelete is a no-op */
475         drmHashDelete(drv->buffer_table, bo->handles[plane].u32);
476         drmHashInsert(drv->buffer_table, bo->handles[plane].u32, (void *)(num + 1));
477 }
478
479 void drv_decrement_reference_count(struct driver *drv, struct bo *bo, size_t plane)
480 {
481         uintptr_t num = drv_get_reference_count(drv, bo, plane);
482
483         drmHashDelete(drv->buffer_table, bo->handles[plane].u32);
484
485         if (num > 0)
486                 drmHashInsert(drv->buffer_table, bo->handles[plane].u32, (void *)(num - 1));
487 }
488
489 uint32_t drv_log_base2(uint32_t value)
490 {
491         int ret = 0;
492
493         while (value >>= 1)
494                 ++ret;
495
496         return ret;
497 }
498
499 void drv_add_combinations(struct driver *drv, const uint32_t *formats, uint32_t num_formats,
500                           struct format_metadata *metadata, uint64_t use_flags)
501 {
502         uint32_t i;
503
504         for (i = 0; i < num_formats; i++) {
505                 struct combination combo = { .format = formats[i],
506                                              .metadata = *metadata,
507                                              .use_flags = use_flags };
508
509                 drv_array_append(drv->combos, &combo);
510         }
511 }
512
513 void drv_modify_combination(struct driver *drv, uint32_t format, struct format_metadata *metadata,
514                             uint64_t use_flags)
515 {
516         uint32_t i;
517         struct combination *combo;
518         /* Attempts to add the specified flags to an existing combination. */
519         for (i = 0; i < drv_array_size(drv->combos); i++) {
520                 combo = (struct combination *)drv_array_at_idx(drv->combos, i);
521                 if (combo->format == format && combo->metadata.tiling == metadata->tiling &&
522                     combo->metadata.modifier == metadata->modifier)
523                         combo->use_flags |= use_flags;
524         }
525 }
526
527 struct drv_array *drv_query_kms(struct driver *drv)
528 {
529         struct drv_array *kms_items;
530         uint64_t plane_type, use_flag;
531         uint32_t i, j, k;
532
533         drmModePlanePtr plane;
534         drmModePropertyPtr prop;
535         drmModePlaneResPtr resources;
536         drmModeObjectPropertiesPtr props;
537
538         kms_items = drv_array_init(sizeof(struct kms_item));
539         if (!kms_items)
540                 goto out;
541
542         /*
543          * The ability to return universal planes is only complete on
544          * ChromeOS kernel versions >= v3.18.  The SET_CLIENT_CAP ioctl
545          * therefore might return an error code, so don't check it.  If it
546          * fails, it'll just return the plane list as overlay planes, which is
547          * fine in our case (our drivers already have cursor bits set).
548          * modetest in libdrm does the same thing.
549          */
550         drmSetClientCap(drv->fd, DRM_CLIENT_CAP_UNIVERSAL_PLANES, 1);
551
552         resources = drmModeGetPlaneResources(drv->fd);
553         if (!resources)
554                 goto out;
555
556         for (i = 0; i < resources->count_planes; i++) {
557                 plane = drmModeGetPlane(drv->fd, resources->planes[i]);
558                 if (!plane)
559                         goto out;
560
561                 props = drmModeObjectGetProperties(drv->fd, plane->plane_id, DRM_MODE_OBJECT_PLANE);
562                 if (!props)
563                         goto out;
564
565                 for (j = 0; j < props->count_props; j++) {
566                         prop = drmModeGetProperty(drv->fd, props->props[j]);
567                         if (prop) {
568                                 if (strcmp(prop->name, "type") == 0) {
569                                         plane_type = props->prop_values[j];
570                                 }
571
572                                 drmModeFreeProperty(prop);
573                         }
574                 }
575
576                 switch (plane_type) {
577                 case DRM_PLANE_TYPE_OVERLAY:
578                 case DRM_PLANE_TYPE_PRIMARY:
579                         use_flag = BO_USE_SCANOUT;
580                         break;
581                 case DRM_PLANE_TYPE_CURSOR:
582                         use_flag = BO_USE_CURSOR;
583                         break;
584                 default:
585                         assert(0);
586                 }
587
588                 for (j = 0; j < plane->count_formats; j++) {
589                         bool found = false;
590                         for (k = 0; k < drv_array_size(kms_items); k++) {
591                                 struct kms_item *item = drv_array_at_idx(kms_items, k);
592                                 if (item->format == plane->formats[j] &&
593                                     item->modifier == DRM_FORMAT_MOD_LINEAR) {
594                                         item->use_flags |= use_flag;
595                                         found = true;
596                                         break;
597                                 }
598                         }
599
600                         if (!found) {
601                                 struct kms_item item = { .format = plane->formats[j],
602                                                          .modifier = DRM_FORMAT_MOD_LINEAR,
603                                                          .use_flags = use_flag };
604
605                                 drv_array_append(kms_items, &item);
606                         }
607                 }
608
609                 drmModeFreeObjectProperties(props);
610                 drmModeFreePlane(plane);
611         }
612
613         drmModeFreePlaneResources(resources);
614 out:
615         if (kms_items && !drv_array_size(kms_items)) {
616                 drv_array_destroy(kms_items);
617                 return NULL;
618         }
619
620         return kms_items;
621 }
622
623 int drv_modify_linear_combinations(struct driver *drv)
624 {
625         uint32_t i, j;
626         struct kms_item *item;
627         struct combination *combo;
628         struct drv_array *kms_items;
629
630         /*
631          * All current drivers can scanout linear XRGB8888/ARGB8888 as a primary
632          * plane and as a cursor. Some drivers don't support
633          * drmModeGetPlaneResources, so add the combination here. Note that the
634          * kernel disregards the alpha component of ARGB unless it's an overlay
635          * plane.
636          */
637         drv_modify_combination(drv, DRM_FORMAT_XRGB8888, &LINEAR_METADATA,
638                                BO_USE_CURSOR | BO_USE_SCANOUT);
639         drv_modify_combination(drv, DRM_FORMAT_ARGB8888, &LINEAR_METADATA,
640                                BO_USE_CURSOR | BO_USE_SCANOUT);
641
642         kms_items = drv_query_kms(drv);
643         if (!kms_items)
644                 return 0;
645
646         for (i = 0; i < drv_array_size(kms_items); i++) {
647                 item = (struct kms_item *)drv_array_at_idx(kms_items, i);
648                 for (j = 0; j < drv_array_size(drv->combos); j++) {
649                         combo = drv_array_at_idx(drv->combos, j);
650                         if (item->format == combo->format)
651                                 combo->use_flags |= BO_USE_SCANOUT;
652                 }
653         }
654
655         drv_array_destroy(kms_items);
656         return 0;
657 }
658
659 /*
660  * Pick the best modifier from modifiers, according to the ordering
661  * given by modifier_order.
662  */
663 uint64_t drv_pick_modifier(const uint64_t *modifiers, uint32_t count,
664                            const uint64_t *modifier_order, uint32_t order_count)
665 {
666         uint32_t i, j;
667
668         for (i = 0; i < order_count; i++) {
669                 for (j = 0; j < count; j++) {
670                         if (modifiers[j] == modifier_order[i]) {
671                                 return modifiers[j];
672                         }
673                 }
674         }
675
676         return DRM_FORMAT_MOD_LINEAR;
677 }