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