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