drv.c

   1 /*
   2  * Copyright 2016 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 #include <assert.h>
   7 #include <errno.h>
   8 #include <fcntl.h>
   9 #include <pthread.h>
  10 #include <stdint.h>
  11 #include <stdio.h>
  12 #include <stdlib.h>
  13 #include <string.h>
  14 #include <sys/mman.h>
  15 #include <xf86drm.h>
  16
  17 #include "drv_priv.h"
  18 #include "helpers.h"
  19 #include "util.h"
  20
  21 #ifdef DRV_AMDGPU
  22 extern struct backend backend_amdgpu;
  23 #endif
  24 extern struct backend backend_cirrus;
  25 extern struct backend backend_evdi;
  26 #ifdef DRV_EXYNOS
  27 extern struct backend backend_exynos;
  28 #endif
  29 extern struct backend backend_gma500;
  30 #ifdef DRV_I915
  31 extern struct backend backend_i915;
  32 #endif
  33 #ifdef DRV_MARVELL
  34 extern struct backend backend_marvell;
  35 #endif
  36 #ifdef DRV_MEDIATEK
  37 extern struct backend backend_mediatek;
  38 #endif
  39 extern struct backend backend_nouveau;
  40 #ifdef DRV_ROCKCHIP
  41 extern struct backend backend_rockchip;
  42 #endif
  43 #ifdef DRV_TEGRA
  44 extern struct backend backend_tegra;
  45 #endif
  46 extern struct backend backend_udl;
  47 #ifdef DRV_VC4
  48 extern struct backend backend_vc4;
  49 #endif
  50 extern struct backend backend_vgem;
  51 extern struct backend backend_virtio_gpu;
  52
  53 static struct backend *drv_get_backend(int fd)
  54 {
  55         drmVersionPtr drm_version;
  56         unsigned int i;
  57
  58         drm_version = drmGetVersion(fd);
  59
  60         if (!drm_version)
  61                 return NULL;
  62
  63         struct backend *backend_list[] = {
  64 #ifdef DRV_AMDGPU
  65                 &backend_amdgpu,
  66 #endif
  67                 &backend_cirrus,
  68                 &backend_evdi,
  69 #ifdef DRV_EXYNOS
  70                 &backend_exynos,
  71 #endif
  72                 &backend_gma500,
  73 #ifdef DRV_I915
  74                 &backend_i915,
  75 #endif
  76 #ifdef DRV_MARVELL
  77                 &backend_marvell,
  78 #endif
  79 #ifdef DRV_MEDIATEK
  80                 &backend_mediatek,
  81 #endif
  82                 &backend_nouveau,
  83 #ifdef DRV_ROCKCHIP
  84                 &backend_rockchip,
  85 #endif
  86 #ifdef DRV_TEGRA
  87                 &backend_tegra,
  88 #endif
  89                 &backend_udl,
  90 #ifdef DRV_VC4
  91                 &backend_vc4,
  92 #endif
  93                 &backend_vgem,
  94                 &backend_virtio_gpu,
  95         };
  96
  97         for(i = 0; i < ARRAY_SIZE(backend_list); i++)
  98                 if (!strcmp(drm_version->name, backend_list[i]->name)) {
  99                         drmFreeVersion(drm_version);
 100                         return backend_list[i];
 101                 }
 102
 103         drmFreeVersion(drm_version);
 104         return NULL;
 105 }
 106
 107 struct driver *drv_create(int fd)
 108 {
 109         struct driver *drv;
 110         int ret;
 111
 112         drv = (struct driver *) calloc(1, sizeof(*drv));
 113
 114         if (!drv)
 115                 return NULL;
 116
 117         drv->fd = fd;
 118         drv->backend = drv_get_backend(fd);
 119
 120         if (!drv->backend)
 121                 goto free_driver;
 122
 123         if (pthread_mutex_init(&drv->driver_lock, NULL))
 124                 goto free_driver;
 125
 126         drv->buffer_table = drmHashCreate();
 127         if (!drv->buffer_table)
 128                 goto free_lock;
 129
 130         drv->map_table = drmHashCreate();
 131         if (!drv->map_table)
 132                 goto free_buffer_table;
 133
 134         /* Start with a power of 2 number of allocations. */
 135         drv->backend->combos.allocations = 2;
 136         drv->backend->combos.size = 0;
 137         drv->backend->combos.data = calloc(drv->backend->combos.allocations,
 138                                            sizeof(struct combination));
 139         if (!drv->backend->combos.data)
 140                 goto free_map_table;
 141
 142         if (drv->backend->init) {
 143                 ret = drv->backend->init(drv);
 144                 if (ret) {
 145                         free(drv->backend->combos.data);
 146                         goto free_map_table;
 147                 }
 148         }
 149
 150         return drv;
 151
 152 free_map_table:
 153         drmHashDestroy(drv->map_table);
 154 free_buffer_table:
 155         drmHashDestroy(drv->buffer_table);
 156 free_lock:
 157         pthread_mutex_destroy(&drv->driver_lock);
 158 free_driver:
 159         free(drv);
 160         return NULL;
 161 }
 162
 163 void drv_destroy(struct driver *drv)
 164 {
 165         pthread_mutex_lock(&drv->driver_lock);
 166
 167         if (drv->backend->close)
 168                 drv->backend->close(drv);
 169
 170         drmHashDestroy(drv->buffer_table);
 171         drmHashDestroy(drv->map_table);
 172
 173         free(drv->backend->combos.data);
 174
 175         pthread_mutex_unlock(&drv->driver_lock);
 176         pthread_mutex_destroy(&drv->driver_lock);
 177
 178         free(drv);
 179 }
 180
 181 int drv_get_fd(struct driver *drv)
 182 {
 183         return drv->fd;
 184 }
 185
 186 const char *
 187 drv_get_name(struct driver *drv)
 188 {
 189         return drv->backend->name;
 190 }
 191
 192 struct combination *drv_get_combination(struct driver *drv, uint32_t format,
 193                                         uint64_t usage)
 194 {
 195         struct combination *curr, *best;
 196
 197         if (format == DRM_FORMAT_NONE || usage == BO_USE_NONE)
 198                 return 0;
 199
 200         best = NULL;
 201         uint32_t i;
 202         for (i = 0; i < drv->backend->combos.size; i++) {
 203                 curr = &drv->backend->combos.data[i];
 204                 if ((format == curr->format) && usage == (curr->usage & usage))
 205                         if (!best ||
 206                             best->metadata.priority < curr->metadata.priority)
 207                                 best = curr;
 208         }
 209
 210         return best;
 211 }
 212
 213 struct bo *drv_bo_new(struct driver *drv, uint32_t width, uint32_t height,
 214                       uint32_t format)
 215 {
 216
 217         struct bo *bo;
 218         bo = (struct bo *) calloc(1, sizeof(*bo));
 219
 220         if (!bo)
 221                 return NULL;
 222
 223         bo->drv = drv;
 224         bo->width = width;
 225         bo->height = height;
 226         bo->format = format;
 227         bo->num_planes = drv_num_planes_from_format(format);
 228
 229         if (!bo->num_planes) {
 230                 free(bo);
 231                 return NULL;
 232         }
 233
 234         return bo;
 235 }
 236
 237 struct bo *drv_bo_create(struct driver *drv, uint32_t width, uint32_t height,
 238                          uint32_t format, uint64_t flags)
 239 {
 240         int ret;
 241         size_t plane;
 242         struct bo *bo;
 243
 244         bo = drv_bo_new(drv, width, height, format);
 245
 246         if (!bo)
 247                 return NULL;
 248
 249         ret = drv->backend->bo_create(bo, width, height, format, flags);
 250
 251         if (ret) {
 252                 free(bo);
 253                 return NULL;
 254         }
 255
 256         pthread_mutex_lock(&drv->driver_lock);
 257
 258         for (plane = 0; plane < bo->num_planes; plane++)
 259                 drv_increment_reference_count(drv, bo, plane);
 260
 261         pthread_mutex_unlock(&drv->driver_lock);
 262
 263         return bo;
 264 }
 265
 266 struct bo *drv_bo_create_with_modifiers(struct driver *drv,
 267                                         uint32_t width, uint32_t height,
 268                                         uint32_t format,
 269                                         const uint64_t *modifiers, uint32_t count)
 270 {
 271         int ret;
 272         size_t plane;
 273         struct bo *bo;
 274
 275         if (!drv->backend->bo_create_with_modifiers) {
 276                 errno = ENOENT;
 277                 return NULL;
 278         }
 279
 280         bo = drv_bo_new(drv, width, height, format);
 281
 282         if (!bo)
 283                 return NULL;
 284
 285         ret = drv->backend->bo_create_with_modifiers(bo, width, height,
 286                                                      format, modifiers, count);
 287
 288         if (ret) {
 289                 free(bo);
 290                 return NULL;
 291         }
 292
 293         pthread_mutex_lock(&drv->driver_lock);
 294
 295         for (plane = 0; plane < bo->num_planes; plane++)
 296                 drv_increment_reference_count(drv, bo, plane);
 297
 298         pthread_mutex_unlock(&drv->driver_lock);
 299
 300         return bo;
 301 }
 302
 303
 304 void drv_bo_destroy(struct bo *bo)
 305 {
 306         size_t plane;
 307         uintptr_t total = 0;
 308         struct driver *drv = bo->drv;
 309
 310         pthread_mutex_lock(&drv->driver_lock);
 311
 312         for (plane = 0; plane < bo->num_planes; plane++)
 313                 drv_decrement_reference_count(drv, bo, plane);
 314
 315         for (plane = 0; plane < bo->num_planes; plane++)
 316                 total += drv_get_reference_count(drv, bo, plane);
 317
 318         pthread_mutex_unlock(&drv->driver_lock);
 319
 320         if (total == 0)
 321                 bo->drv->backend->bo_destroy(bo);
 322
 323         free(bo);
 324 }
 325
 326 struct bo *drv_bo_import(struct driver *drv, struct drv_import_fd_data *data)
 327 {
 328         int ret;
 329         size_t plane;
 330         struct bo *bo;
 331
 332         bo = drv_bo_new(drv, data->width, data->height, data->format);
 333
 334         if (!bo)
 335                 return NULL;
 336
 337         ret = drv->backend->bo_import(bo, data);
 338         if (ret) {
 339                 free(bo);
 340                 return NULL;
 341         }
 342
 343         for (plane = 0; plane < bo->num_planes; plane++) {
 344                 bo->strides[plane] = data->strides[plane];
 345                 bo->offsets[plane] = data->offsets[plane];
 346                 bo->sizes[plane] = data->sizes[plane];
 347                 bo->format_modifiers[plane] = data->format_modifiers[plane];
 348                 bo->total_size += data->sizes[plane];
 349         }
 350
 351         return bo;
 352 }
 353
 354 void *drv_bo_map(struct bo *bo, uint32_t x, uint32_t y, uint32_t width,
 355                  uint32_t height, uint32_t flags, void **map_data, size_t plane)
 356 {
 357         void *ptr;
 358         uint8_t *addr;
 359         size_t offset;
 360         struct map_info *data;
 361
 362         assert(width > 0);
 363         assert(height > 0);
 364         assert(x + width <= drv_bo_get_width(bo));
 365         assert(y + height <= drv_bo_get_height(bo));
 366
 367         pthread_mutex_lock(&bo->drv->driver_lock);
 368
 369         if (!drmHashLookup(bo->drv->map_table, bo->handles[plane].u32, &ptr)) {
 370                 data = (struct map_info *) ptr;
 371                 data->refcount++;
 372                 goto success;
 373         }
 374
 375         data = calloc(1, sizeof(*data));
 376         addr = bo->drv->backend->bo_map(bo, data, plane);
 377         if (addr == MAP_FAILED) {
 378                 *map_data = NULL;
 379                 free(data);
 380                 pthread_mutex_unlock(&bo->drv->driver_lock);
 381                 return MAP_FAILED;
 382         }
 383
 384         data->refcount = 1;
 385         data->addr = addr;
 386         data->handle = bo->handles[plane].u32;
 387         drmHashInsert(bo->drv->map_table, bo->handles[plane].u32,
 388                       (void *) data);
 389
 390 success:
 391         *map_data = (void *) data;
 392         offset = drv_bo_get_plane_stride(bo, plane) * y;
 393         offset += drv_stride_from_format(bo->format, x, plane);
 394         addr = (uint8_t *) data->addr;
 395         addr += drv_bo_get_plane_offset(bo, plane) + offset;
 396         pthread_mutex_unlock(&bo->drv->driver_lock);
 397
 398         return (void *) addr;
 399 }
 400
 401 int drv_bo_unmap(struct bo *bo, void *map_data)
 402 {
 403         struct map_info *data = map_data;
 404         int ret = 0;
 405
 406         assert(data);
 407         assert(data->refcount >= 0);
 408
 409         pthread_mutex_lock(&bo->drv->driver_lock);
 410
 411         if (!--data->refcount) {
 412                 if (bo->drv->backend->bo_unmap)
 413                         ret = bo->drv->backend->bo_unmap(bo, data);
 414                 else
 415                         ret = munmap(data->addr, data->length);
 416                 drmHashDelete(bo->drv->map_table, data->handle);
 417                 free(data);
 418         }
 419
 420         pthread_mutex_unlock(&bo->drv->driver_lock);
 421
 422         return ret;
 423 }
 424
 425 uint32_t drv_bo_get_width(struct bo *bo)
 426 {
 427         return bo->width;
 428 }
 429
 430 uint32_t drv_bo_get_height(struct bo *bo)
 431 {
 432         return bo->height;
 433 }
 434
 435 uint32_t drv_bo_get_stride_or_tiling(struct bo *bo)
 436 {
 437         return bo->tiling ? bo->tiling : drv_bo_get_plane_stride(bo, 0);
 438 }
 439
 440 size_t drv_bo_get_num_planes(struct bo *bo)
 441 {
 442         return bo->num_planes;
 443 }
 444
 445 union bo_handle drv_bo_get_plane_handle(struct bo *bo, size_t plane)
 446 {
 447         return bo->handles[plane];
 448 }
 449
 450 #ifndef DRM_RDWR
 451 #define DRM_RDWR O_RDWR
 452 #endif
 453
 454 int drv_bo_get_plane_fd(struct bo *bo, size_t plane)
 455 {
 456
 457         int ret, fd;
 458         assert(plane < bo->num_planes);
 459
 460         ret = drmPrimeHandleToFD(bo->drv->fd, bo->handles[plane].u32,
 461                                  DRM_CLOEXEC | DRM_RDWR, &fd);
 462
 463         return (ret) ? ret : fd;
 464
 465 }
 466
 467 uint32_t drv_bo_get_plane_offset(struct bo *bo, size_t plane)
 468 {
 469         assert(plane < bo->num_planes);
 470         return bo->offsets[plane];
 471 }
 472
 473 uint32_t drv_bo_get_plane_size(struct bo *bo, size_t plane)
 474 {
 475         assert(plane < bo->num_planes);
 476         return bo->sizes[plane];
 477 }
 478
 479 uint32_t drv_bo_get_plane_stride(struct bo *bo, size_t plane)
 480 {
 481         assert(plane < bo->num_planes);
 482         return bo->strides[plane];
 483 }
 484
 485 uint64_t drv_bo_get_plane_format_modifier(struct bo *bo, size_t plane)
 486 {
 487         assert(plane < bo->num_planes);
 488         return bo->format_modifiers[plane];
 489 }
 490
 491 uint32_t drv_bo_get_format(struct bo *bo)
 492 {
 493         return bo->format;
 494 }
 495
 496 uint32_t drv_resolve_format(struct driver *drv, uint32_t format)
 497 {
 498         if (drv->backend->resolve_format)
 499                 return drv->backend->resolve_format(format);
 500
 501         return format;
 502 }
 503
 504 /*
 505  * This function returns the stride for a given format, width and plane.
 506  */
 507 int drv_stride_from_format(uint32_t format, uint32_t width, size_t plane)
 508 {
 509         int stride = width * DIV_ROUND_UP(drv_bpp_from_format(format, plane),
 510                                           8);
 511
 512         /*
 513          * Only downsample for certain multiplanar formats which have horizontal
 514          * subsampling for chroma planes.  Only formats supported by our drivers
 515          * are listed here -- add more as needed.
 516          */
 517         if (plane != 0) {
 518                 switch (format) {
 519                 case DRM_FORMAT_NV12:
 520                 case DRM_FORMAT_YVU420:
 521                         stride = stride / 2;
 522                         break;
 523                 }
 524         }
 525
 526         return stride;
 527 }
 528
 529 size_t drv_num_planes_from_format(uint32_t format)
 530 {
 531         switch (format) {
 532         case DRM_FORMAT_ABGR1555:
 533         case DRM_FORMAT_ABGR2101010:
 534         case DRM_FORMAT_ABGR4444:
 535         case DRM_FORMAT_ABGR8888:
 536         case DRM_FORMAT_ARGB1555:
 537         case DRM_FORMAT_ARGB2101010:
 538         case DRM_FORMAT_ARGB4444:
 539         case DRM_FORMAT_ARGB8888:
 540         case DRM_FORMAT_AYUV:
 541         case DRM_FORMAT_BGR233:
 542         case DRM_FORMAT_BGR565:
 543         case DRM_FORMAT_BGR888:
 544         case DRM_FORMAT_BGRA1010102:
 545         case DRM_FORMAT_BGRA4444:
 546         case DRM_FORMAT_BGRA5551:
 547         case DRM_FORMAT_BGRA8888:
 548         case DRM_FORMAT_BGRX1010102:
 549         case DRM_FORMAT_BGRX4444:
 550         case DRM_FORMAT_BGRX5551:
 551         case DRM_FORMAT_BGRX8888:
 552         case DRM_FORMAT_C8:
 553         case DRM_FORMAT_GR88:
 554         case DRM_FORMAT_R8:
 555         case DRM_FORMAT_RG88:
 556         case DRM_FORMAT_RGB332:
 557         case DRM_FORMAT_RGB565:
 558         case DRM_FORMAT_RGB888:
 559         case DRM_FORMAT_RGBA1010102:
 560         case DRM_FORMAT_RGBA4444:
 561         case DRM_FORMAT_RGBA5551:
 562         case DRM_FORMAT_RGBA8888:
 563         case DRM_FORMAT_RGBX1010102:
 564         case DRM_FORMAT_RGBX4444:
 565         case DRM_FORMAT_RGBX5551:
 566         case DRM_FORMAT_RGBX8888:
 567         case DRM_FORMAT_UYVY:
 568         case DRM_FORMAT_VYUY:
 569         case DRM_FORMAT_XBGR1555:
 570         case DRM_FORMAT_XBGR2101010:
 571         case DRM_FORMAT_XBGR4444:
 572         case DRM_FORMAT_XBGR8888:
 573         case DRM_FORMAT_XRGB1555:
 574         case DRM_FORMAT_XRGB2101010:
 575         case DRM_FORMAT_XRGB4444:
 576         case DRM_FORMAT_XRGB8888:
 577         case DRM_FORMAT_YUYV:
 578         case DRM_FORMAT_YVYU:
 579                 return 1;
 580         case DRM_FORMAT_NV12:
 581                 return 2;
 582         case DRM_FORMAT_YVU420:
 583                 return 3;
 584         }
 585
 586         fprintf(stderr, "drv: UNKNOWN FORMAT %d\n", format);
 587         return 0;
 588 }
 589
 590 uint32_t drv_size_from_format(uint32_t format, uint32_t stride,
 591                               uint32_t height, size_t plane)
 592 {
 593         assert(plane < drv_num_planes_from_format(format));
 594         uint32_t vertical_subsampling;
 595
 596         switch (format) {
 597         case DRM_FORMAT_NV12:
 598         case DRM_FORMAT_YVU420:
 599                 vertical_subsampling = (plane == 0) ? 1 : 2;
 600                 break;
 601         default:
 602                 vertical_subsampling = 1;
 603         }
 604
 605         return stride * DIV_ROUND_UP(height, vertical_subsampling);
 606 }
 607
 608 uint32_t drv_num_buffers_per_bo(struct bo *bo)
 609 {
 610         uint32_t count = 0;
 611         size_t plane, p;
 612
 613         for (plane = 0; plane < bo->num_planes; plane++) {
 614                 for (p = 0; p < plane; p++)
 615                         if (bo->handles[p].u32 == bo->handles[plane].u32)
 616                                 break;
 617                 if (p == plane)
 618                         count++;
 619         }
 620
 621         return count;
 622 }