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