drv.h

   1 /*
   2  * Copyright (c) 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
   7 #ifndef DRV_H_
   8 #define DRV_H_
   9
  10 #ifdef __cplusplus
  11 extern "C" {
  12 #endif
  13
  14 #include <drm_fourcc.h>
  15 #include <stdint.h>
  16
  17 #define DRV_MAX_PLANES 4
  18
  19 /* Use flags */
  20 #define BO_USE_NONE                     0
  21 #define BO_USE_SCANOUT                  (1ull << 0)
  22 #define BO_USE_CURSOR                   (1ull << 1)
  23 #define BO_USE_CURSOR_64X64             BO_USE_CURSOR
  24 #define BO_USE_RENDERING                (1ull << 2)
  25 #define BO_USE_LINEAR                   (1ull << 3)
  26 #define BO_USE_SW_READ_NEVER            (1ull << 4)
  27 #define BO_USE_SW_READ_RARELY           (1ull << 5)
  28 #define BO_USE_SW_READ_OFTEN            (1ull << 6)
  29 #define BO_USE_SW_WRITE_NEVER           (1ull << 7)
  30 #define BO_USE_SW_WRITE_RARELY          (1ull << 8)
  31 #define BO_USE_SW_WRITE_OFTEN           (1ull << 9)
  32 #define BO_USE_EXTERNAL_DISP            (1ull << 10)
  33 #define BO_USE_PROTECTED                (1ull << 11)
  34 #define BO_USE_HW_VIDEO_ENCODER         (1ull << 12)
  35 #define BO_USE_HW_CAMERA_WRITE          (1ull << 13)
  36 #define BO_USE_HW_CAMERA_READ           (1ull << 14)
  37 #define BO_USE_HW_CAMERA_ZSL            (1ull << 15)
  38 #define BO_USE_RENDERSCRIPT             (1ull << 16)
  39
  40 /* This is our extension to <drm_fourcc.h>.  We need to make sure we don't step
  41  * on the namespace of already defined formats, which can be done by using invalid
  42  * fourcc codes.
  43  */
  44
  45 #define DRM_FORMAT_NONE                         fourcc_code('0', '0', '0', '0')
  46 #define DRM_FORMAT_FLEX_IMPLEMENTATION_DEFINED  fourcc_code('9', '9', '9', '8')
  47 #define DRM_FORMAT_FLEX_YCbCr_420_888           fourcc_code('9', '9', '9', '9')
  48
  49 struct driver;
  50 struct bo;
  51
  52 union bo_handle {
  53         void *ptr;
  54         int32_t s32;
  55         uint32_t u32;
  56         int64_t s64;
  57         uint64_t u64;
  58 };
  59
  60 struct drv_import_fd_data {
  61         int fds[DRV_MAX_PLANES];
  62         uint32_t strides[DRV_MAX_PLANES];
  63         uint32_t offsets[DRV_MAX_PLANES];
  64         uint32_t sizes[DRV_MAX_PLANES];
  65         uint64_t format_modifiers[DRV_MAX_PLANES];
  66         uint32_t width;
  67         uint32_t height;
  68         uint32_t format;
  69 };
  70
  71 struct driver *
  72 drv_create(int fd);
  73
  74 void
  75 drv_destroy(struct driver *drv);
  76
  77 int
  78 drv_get_fd(struct driver *drv);
  79
  80 const char *
  81 drv_get_name(struct driver *drv);
  82
  83 int
  84 drv_is_combination_supported(struct driver *drv, uint32_t format,
  85                              uint64_t usage, uint64_t modifier);
  86
  87 struct bo *
  88 drv_bo_new(struct driver *drv, uint32_t width, uint32_t height,
  89            uint32_t format);
  90
  91 struct bo *
  92 drv_bo_create(struct driver *drv, uint32_t width, uint32_t height,
  93               uint32_t format, uint64_t flags);
  94
  95 void
  96 drv_bo_destroy(struct bo *bo);
  97
  98 struct bo *
  99 drv_bo_import(struct driver *drv, struct drv_import_fd_data *data);
 100
 101 void *
 102 drv_bo_map(struct bo *bo, uint32_t x, uint32_t y, uint32_t width,
 103            uint32_t height, uint32_t flags, void **map_data, size_t plane);
 104
 105 int
 106 drv_bo_unmap(struct bo *bo, void *map_data);
 107
 108 uint32_t
 109 drv_bo_get_width(struct bo *bo);
 110
 111 uint32_t
 112 drv_bo_get_height(struct bo *bo);
 113
 114 uint32_t
 115 drv_bo_get_stride_or_tiling(struct bo *bo);
 116
 117 size_t
 118 drv_bo_get_num_planes(struct bo *bo);
 119
 120 union bo_handle
 121 drv_bo_get_plane_handle(struct bo *bo, size_t plane);
 122
 123 int
 124 drv_bo_get_plane_fd(struct bo *bo, size_t plane);
 125
 126 uint32_t
 127 drv_bo_get_plane_offset(struct bo *bo, size_t plane);
 128
 129 uint32_t
 130 drv_bo_get_plane_size(struct bo *bo, size_t plane);
 131
 132 uint32_t
 133 drv_bo_get_plane_stride(struct bo *bo, size_t plane);
 134
 135 uint64_t
 136 drv_bo_get_plane_format_modifier(struct bo *bo, size_t plane);
 137
 138 uint32_t
 139 drv_bo_get_format(struct bo *bo);
 140
 141 uint32_t
 142 drv_resolve_format(struct driver *drv, uint32_t format);
 143
 144 int
 145 drv_stride_from_format(uint32_t format, uint32_t width, size_t plane);
 146
 147 size_t
 148 drv_num_planes_from_format(uint32_t format);
 149
 150 uint32_t
 151 drv_size_from_format(uint32_t format, uint32_t stride, uint32_t height,
 152                      size_t plane);
 153
 154 uint32_t
 155 drv_num_buffers_per_bo(struct bo *bo);
 156
 157 #ifdef __cplusplus
 158 }
 159 #endif
 160
 161 #endif