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