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