OSDN Git Service

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