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