OSDN Git Service

minigbm: use drv_add_combination when adding a single combination
[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 /*
179  * This function returns the stride for a given format, width and plane.
180  */
181 uint32_t drv_stride_from_format(uint32_t format, uint32_t width, size_t plane)
182 {
183         const struct planar_layout *layout = layout_from_format(format);
184         assert(plane < layout->num_planes);
185
186         uint32_t plane_width = DIV_ROUND_UP(width, layout->horizontal_subsampling[plane]);
187         uint32_t stride = plane_width * layout->bytes_per_pixel[plane];
188
189         /*
190          * The stride of Android YV12 buffers is required to be aligned to 16 bytes
191          * (see <system/graphics.h>).
192          */
193         if (format == DRM_FORMAT_YVU420_ANDROID)
194                 stride = (plane == 0) ? ALIGN(stride, 32) : ALIGN(stride, 16);
195
196         return stride;
197 }
198
199 uint32_t drv_size_from_format(uint32_t format, uint32_t stride, uint32_t height, size_t plane)
200 {
201         return stride * drv_height_from_format(format, height, plane);
202 }
203
204 static uint32_t subsample_stride(uint32_t stride, uint32_t format, size_t plane)
205 {
206         if (plane != 0) {
207                 switch (format) {
208                 case DRM_FORMAT_YVU420:
209                 case DRM_FORMAT_YVU420_ANDROID:
210                         stride = DIV_ROUND_UP(stride, 2);
211                         break;
212                 }
213         }
214
215         return stride;
216 }
217
218 /*
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.
222  */
223 int drv_bo_from_format(struct bo *bo, uint32_t stride, uint32_t aligned_height, uint32_t format)
224 {
225
226         size_t p, num_planes;
227         uint32_t offset = 0;
228
229         num_planes = drv_num_planes_from_format(format);
230         assert(num_planes);
231
232         /*
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.
237          */
238         if (format == DRM_FORMAT_YVU420_ANDROID) {
239                 assert(aligned_height == bo->height);
240                 assert(stride == ALIGN(stride, 32));
241         }
242
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];
248         }
249
250         bo->total_size = offset;
251         return 0;
252 }
253
254 int drv_dumb_bo_create(struct bo *bo, uint32_t width, uint32_t height, uint32_t format,
255                        uint64_t use_flags)
256 {
257         int ret;
258         size_t plane;
259         uint32_t aligned_width, aligned_height;
260         struct drm_mode_create_dumb create_dumb;
261
262         aligned_width = width;
263         aligned_height = height;
264         switch (format) {
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.
270                  *
271                  * HAL_PIXEL_FORMAT_YV12 requires that the buffer's height not
272                  * be aligned. */
273                 aligned_height = 3 * DIV_ROUND_UP(bo->height, 2);
274                 break;
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);
279                 break;
280         default:
281                 break;
282         }
283
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;
289
290         ret = drmIoctl(bo->drv->fd, DRM_IOCTL_MODE_CREATE_DUMB, &create_dumb);
291         if (ret) {
292                 drv_log("DRM_IOCTL_MODE_CREATE_DUMB failed (%d, %d)\n", bo->drv->fd, errno);
293                 return ret;
294         }
295
296         drv_bo_from_format(bo, create_dumb.pitch, height, format);
297
298         for (plane = 0; plane < bo->num_planes; plane++)
299                 bo->handles[plane].u32 = create_dumb.handle;
300
301         bo->total_size = create_dumb.size;
302         return 0;
303 }
304
305 int drv_dumb_bo_destroy(struct bo *bo)
306 {
307         struct drm_mode_destroy_dumb destroy_dumb;
308         int ret;
309
310         memset(&destroy_dumb, 0, sizeof(destroy_dumb));
311         destroy_dumb.handle = bo->handles[0].u32;
312
313         ret = drmIoctl(bo->drv->fd, DRM_IOCTL_MODE_DESTROY_DUMB, &destroy_dumb);
314         if (ret) {
315                 drv_log("DRM_IOCTL_MODE_DESTROY_DUMB failed (handle=%x)\n", bo->handles[0].u32);
316                 return ret;
317         }
318
319         return 0;
320 }
321
322 int drv_gem_bo_destroy(struct bo *bo)
323 {
324         struct drm_gem_close gem_close;
325         int ret, error = 0;
326         size_t plane, i;
327
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)
331                                 break;
332                 /* Make sure close hasn't already been called on this handle */
333                 if (i != plane)
334                         continue;
335
336                 memset(&gem_close, 0, sizeof(gem_close));
337                 gem_close.handle = bo->handles[plane].u32;
338
339                 ret = drmIoctl(bo->drv->fd, DRM_IOCTL_GEM_CLOSE, &gem_close);
340                 if (ret) {
341                         drv_log("DRM_IOCTL_GEM_CLOSE failed (handle=%x) error %d\n",
342                                 bo->handles[plane].u32, ret);
343                         error = ret;
344                 }
345         }
346
347         return error;
348 }
349
350 int drv_prime_bo_import(struct bo *bo, struct drv_import_fd_data *data)
351 {
352         int ret;
353         size_t plane;
354         struct drm_prime_handle prime_handle;
355
356         for (plane = 0; plane < bo->num_planes; plane++) {
357                 memset(&prime_handle, 0, sizeof(prime_handle));
358                 prime_handle.fd = data->fds[plane];
359
360                 ret = drmIoctl(bo->drv->fd, DRM_IOCTL_PRIME_FD_TO_HANDLE, &prime_handle);
361
362                 if (ret) {
363                         drv_log("DRM_IOCTL_PRIME_FD_TO_HANDLE failed (fd=%u)\n", prime_handle.fd);
364
365                         /*
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.
370                          */
371                         bo->num_planes = plane;
372                         drv_gem_bo_destroy(bo);
373                         return ret;
374                 }
375
376                 bo->handles[plane].u32 = prime_handle.handle;
377         }
378
379         return 0;
380 }
381
382 void *drv_dumb_bo_map(struct bo *bo, struct vma *vma, size_t plane, uint32_t map_flags)
383 {
384         int ret;
385         size_t i;
386         struct drm_mode_map_dumb map_dumb;
387
388         memset(&map_dumb, 0, sizeof(map_dumb));
389         map_dumb.handle = bo->handles[plane].u32;
390
391         ret = drmIoctl(bo->drv->fd, DRM_IOCTL_MODE_MAP_DUMB, &map_dumb);
392         if (ret) {
393                 drv_log("DRM_IOCTL_MODE_MAP_DUMB failed\n");
394                 return MAP_FAILED;
395         }
396
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];
400
401         return mmap(0, vma->length, drv_get_prot(map_flags), MAP_SHARED, bo->drv->fd,
402                     map_dumb.offset);
403 }
404
405 int drv_bo_munmap(struct bo *bo, struct vma *vma)
406 {
407         return munmap(vma->addr, vma->length);
408 }
409
410 int drv_mapping_destroy(struct bo *bo)
411 {
412         int ret;
413         size_t plane;
414         struct mapping *mapping;
415         uint32_t idx;
416
417         /*
418          * This function is called right before the buffer is destroyed. It will free any mappings
419          * associated with the buffer.
420          */
421
422         idx = 0;
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) {
427                                 idx++;
428                                 continue;
429                         }
430
431                         if (!--mapping->vma->refcount) {
432                                 ret = bo->drv->backend->bo_unmap(bo, mapping->vma);
433                                 if (ret) {
434                                         drv_log("munmap failed\n");
435                                         return ret;
436                                 }
437
438                                 free(mapping->vma);
439                         }
440
441                         /* This shrinks and shifts the array, so don't increment idx. */
442                         drv_array_remove(bo->drv->mappings, idx);
443                 }
444         }
445
446         return 0;
447 }
448
449 int drv_get_prot(uint32_t map_flags)
450 {
451         return (BO_MAP_WRITE & map_flags) ? PROT_WRITE | PROT_READ : PROT_READ;
452 }
453
454 uintptr_t drv_get_reference_count(struct driver *drv, struct bo *bo, size_t plane)
455 {
456         void *count;
457         uintptr_t num = 0;
458
459         if (!drmHashLookup(drv->buffer_table, bo->handles[plane].u32, &count))
460                 num = (uintptr_t)(count);
461
462         return num;
463 }
464
465 void drv_increment_reference_count(struct driver *drv, struct bo *bo, size_t plane)
466 {
467         uintptr_t num = drv_get_reference_count(drv, bo, plane);
468
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));
472 }
473
474 void drv_decrement_reference_count(struct driver *drv, struct bo *bo, size_t plane)
475 {
476         uintptr_t num = drv_get_reference_count(drv, bo, plane);
477
478         drmHashDelete(drv->buffer_table, bo->handles[plane].u32);
479
480         if (num > 0)
481                 drmHashInsert(drv->buffer_table, bo->handles[plane].u32, (void *)(num - 1));
482 }
483
484 void drv_add_combination(struct driver *drv, const uint32_t format,
485                          struct format_metadata *metadata, uint64_t use_flags)
486 {
487         struct combination combo = { .format = format,
488                                      .metadata = *metadata,
489                                      .use_flags = use_flags };
490
491         drv_array_append(drv->combos, &combo);
492 }
493
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)
496 {
497         uint32_t i;
498
499         for (i = 0; i < num_formats; i++) {
500                 struct combination combo = { .format = formats[i],
501                                              .metadata = *metadata,
502                                              .use_flags = use_flags };
503
504                 drv_array_append(drv->combos, &combo);
505         }
506 }
507
508 void drv_modify_combination(struct driver *drv, uint32_t format, struct format_metadata *metadata,
509                             uint64_t use_flags)
510 {
511         uint32_t i;
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;
519         }
520 }
521
522 struct drv_array *drv_query_kms(struct driver *drv)
523 {
524         struct drv_array *kms_items;
525         uint64_t plane_type, use_flag;
526         uint32_t i, j, k;
527
528         drmModePlanePtr plane;
529         drmModePropertyPtr prop;
530         drmModePlaneResPtr resources;
531         drmModeObjectPropertiesPtr props;
532
533         kms_items = drv_array_init(sizeof(struct kms_item));
534         if (!kms_items)
535                 goto out;
536
537         /*
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.
544          */
545         drmSetClientCap(drv->fd, DRM_CLIENT_CAP_UNIVERSAL_PLANES, 1);
546
547         resources = drmModeGetPlaneResources(drv->fd);
548         if (!resources)
549                 goto out;
550
551         for (i = 0; i < resources->count_planes; i++) {
552                 plane = drmModeGetPlane(drv->fd, resources->planes[i]);
553                 if (!plane)
554                         goto out;
555
556                 props = drmModeObjectGetProperties(drv->fd, plane->plane_id, DRM_MODE_OBJECT_PLANE);
557                 if (!props)
558                         goto out;
559
560                 for (j = 0; j < props->count_props; j++) {
561                         prop = drmModeGetProperty(drv->fd, props->props[j]);
562                         if (prop) {
563                                 if (strcmp(prop->name, "type") == 0) {
564                                         plane_type = props->prop_values[j];
565                                 }
566
567                                 drmModeFreeProperty(prop);
568                         }
569                 }
570
571                 switch (plane_type) {
572                 case DRM_PLANE_TYPE_OVERLAY:
573                 case DRM_PLANE_TYPE_PRIMARY:
574                         use_flag = BO_USE_SCANOUT;
575                         break;
576                 case DRM_PLANE_TYPE_CURSOR:
577                         use_flag = BO_USE_CURSOR;
578                         break;
579                 default:
580                         assert(0);
581                 }
582
583                 for (j = 0; j < plane->count_formats; j++) {
584                         bool found = false;
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;
590                                         found = true;
591                                         break;
592                                 }
593                         }
594
595                         if (!found) {
596                                 struct kms_item item = { .format = plane->formats[j],
597                                                          .modifier = DRM_FORMAT_MOD_LINEAR,
598                                                          .use_flags = use_flag };
599
600                                 drv_array_append(kms_items, &item);
601                         }
602                 }
603
604                 drmModeFreeObjectProperties(props);
605                 drmModeFreePlane(plane);
606         }
607
608         drmModeFreePlaneResources(resources);
609 out:
610         if (kms_items && !drv_array_size(kms_items)) {
611                 drv_array_destroy(kms_items);
612                 return NULL;
613         }
614
615         return kms_items;
616 }
617
618 int drv_modify_linear_combinations(struct driver *drv)
619 {
620         uint32_t i, j;
621         struct kms_item *item;
622         struct combination *combo;
623         struct drv_array *kms_items;
624
625         /*
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
630          * plane.
631          */
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);
636
637         kms_items = drv_query_kms(drv);
638         if (!kms_items)
639                 return 0;
640
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;
647                 }
648         }
649
650         drv_array_destroy(kms_items);
651         return 0;
652 }
653
654 /*
655  * Pick the best modifier from modifiers, according to the ordering
656  * given by modifier_order.
657  */
658 uint64_t drv_pick_modifier(const uint64_t *modifiers, uint32_t count,
659                            const uint64_t *modifier_order, uint32_t order_count)
660 {
661         uint32_t i, j;
662
663         for (i = 0; i < order_count; i++) {
664                 for (j = 0; j < count; j++) {
665                         if (modifiers[j] == modifier_order[i]) {
666                                 return modifiers[j];
667                         }
668                 }
669         }
670
671         return DRM_FORMAT_MOD_LINEAR;
672 }