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