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