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