OSDN Git Service

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