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