drv.h

   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
   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 // clang-format off
  20 /* Use flags */
  21 #define BO_USE_NONE                     0
  22 #define BO_USE_SCANOUT                  (1ull << 0)
  23 #define BO_USE_CURSOR                   (1ull << 1)
  24 #define BO_USE_CURSOR_64X64             BO_USE_CURSOR
  25 #define BO_USE_RENDERING                (1ull << 2)
  26 /* Skip for GBM_BO_USE_WRITE */
  27 #define BO_USE_LINEAR                   (1ull << 4)
  28 #define BO_USE_TEXTURE                  (1ull << 5)
  29 #define BO_USE_CAMERA_WRITE             (1ull << 6)
  30 #define BO_USE_CAMERA_READ              (1ull << 7)
  31 #define BO_USE_PROTECTED                (1ull << 8)
  32 #define BO_USE_SW_READ_OFTEN            (1ull << 9)
  33 #define BO_USE_SW_READ_RARELY           (1ull << 10)
  34 #define BO_USE_SW_WRITE_OFTEN           (1ull << 11)
  35 #define BO_USE_SW_WRITE_RARELY          (1ull << 12)
  36 #define BO_USE_HW_VIDEO_DECODER         (1ull << 13)
  37 #define BO_USE_HW_VIDEO_ENCODER         (1ull << 14)
  38 #define BO_USE_RENDERSCRIPT             (1ull << 15)
  39
  40 /* Quirks for allocating a buffer. */
  41 #define BO_QUIRK_NONE                   0
  42 #define BO_QUIRK_DUMB32BPP              (1ull << 0)
  43
  44 /* Map flags */
  45 #define BO_MAP_NONE 0
  46 #define BO_MAP_READ (1 << 0)
  47 #define BO_MAP_WRITE (1 << 1)
  48 #define BO_MAP_READ_WRITE (BO_MAP_READ | BO_MAP_WRITE)
  49
  50 /* This is our extension to <drm_fourcc.h>.  We need to make sure we don't step
  51  * on the namespace of already defined formats, which can be done by using invalid
  52  * fourcc codes.
  53  */
  54 #define DRM_FORMAT_NONE                         fourcc_code('0', '0', '0', '0')
  55 #define DRM_FORMAT_YVU420_ANDROID               fourcc_code('9', '9', '9', '7')
  56 #define DRM_FORMAT_FLEX_IMPLEMENTATION_DEFINED  fourcc_code('9', '9', '9', '8')
  57 #define DRM_FORMAT_FLEX_YCbCr_420_888           fourcc_code('9', '9', '9', '9')
  58
  59 /* This is a 10-bit bayer format for private reprocessing on MediaTek ISP. It's
  60  * a private RAW format that other DRM drivers will never support and thus
  61  * making it not upstreamable (i.e., defined in official DRM headers). */
  62 #define DRM_FORMAT_MTISP_SXYZW10                fourcc_code('M', 'B', '1', '0')
  63
  64 // TODO(crbug.com/958181): remove this definition once drm_fourcc.h contains it.
  65 #ifndef DRM_FORMAT_P010
  66 #define DRM_FORMAT_P010 fourcc_code('P', '0', '1', '0')
  67 #endif
  68
  69 // clang-format on
  70 struct driver;
  71 struct bo;
  72 struct combination;
  73
  74 union bo_handle {
  75         void *ptr;
  76         int32_t s32;
  77         uint32_t u32;
  78         int64_t s64;
  79         uint64_t u64;
  80 };
  81
  82 struct drv_import_fd_data {
  83         int fds[DRV_MAX_PLANES];
  84         uint32_t strides[DRV_MAX_PLANES];
  85         uint32_t offsets[DRV_MAX_PLANES];
  86         uint64_t format_modifiers[DRV_MAX_PLANES];
  87         uint32_t width;
  88         uint32_t height;
  89         uint32_t format;
  90         uint64_t use_flags;
  91 };
  92
  93 struct vma {
  94         void *addr;
  95         size_t length;
  96         uint32_t handle;
  97         uint32_t map_flags;
  98         int32_t refcount;
  99         uint32_t map_strides[DRV_MAX_PLANES];
 100         void *priv;
 101 };
 102
 103 struct rectangle {
 104         uint32_t x;
 105         uint32_t y;
 106         uint32_t width;
 107         uint32_t height;
 108 };
 109
 110 struct mapping {
 111         struct vma *vma;
 112         struct rectangle rect;
 113         uint32_t refcount;
 114 };
 115
 116 struct driver *drv_create(int fd);
 117
 118 void drv_destroy(struct driver *drv);
 119
 120 int drv_get_fd(struct driver *drv);
 121
 122 const char *drv_get_name(struct driver *drv);
 123
 124 struct combination *drv_get_combination(struct driver *drv, uint32_t format, uint64_t use_flags);
 125
 126 struct bo *drv_bo_new(struct driver *drv, uint32_t width, uint32_t height, uint32_t format,
 127                       uint64_t use_flags);
 128
 129 struct bo *drv_bo_create(struct driver *drv, uint32_t width, uint32_t height, uint32_t format,
 130                          uint64_t use_flags);
 131
 132 struct bo *drv_bo_create_with_modifiers(struct driver *drv, uint32_t width, uint32_t height,
 133                                         uint32_t format, const uint64_t *modifiers, uint32_t count);
 134
 135 void drv_bo_destroy(struct bo *bo);
 136
 137 struct bo *drv_bo_import(struct driver *drv, struct drv_import_fd_data *data);
 138
 139 void *drv_bo_map(struct bo *bo, const struct rectangle *rect, uint32_t map_flags,
 140                  struct mapping **map_data, size_t plane);
 141
 142 int drv_bo_unmap(struct bo *bo, struct mapping *mapping);
 143
 144 int drv_bo_invalidate(struct bo *bo, struct mapping *mapping);
 145
 146 int drv_bo_flush_or_unmap(struct bo *bo, struct mapping *mapping);
 147
 148 uint32_t drv_bo_get_width(struct bo *bo);
 149
 150 uint32_t drv_bo_get_height(struct bo *bo);
 151
 152 size_t drv_bo_get_num_planes(struct bo *bo);
 153
 154 union bo_handle drv_bo_get_plane_handle(struct bo *bo, size_t plane);
 155
 156 int drv_bo_get_plane_fd(struct bo *bo, size_t plane);
 157
 158 uint32_t drv_bo_get_plane_offset(struct bo *bo, size_t plane);
 159
 160 uint32_t drv_bo_get_plane_size(struct bo *bo, size_t plane);
 161
 162 uint32_t drv_bo_get_plane_stride(struct bo *bo, size_t plane);
 163
 164 uint64_t drv_bo_get_plane_format_modifier(struct bo *bo, size_t plane);
 165
 166 uint32_t drv_bo_get_format(struct bo *bo);
 167
 168 uint32_t drv_bytes_per_pixel_from_format(uint32_t format, size_t plane);
 169
 170 uint32_t drv_stride_from_format(uint32_t format, uint32_t width, size_t plane);
 171
 172 uint32_t drv_resolve_format(struct driver *drv, uint32_t format, uint64_t use_flags);
 173
 174 size_t drv_num_planes_from_format(uint32_t format);
 175
 176 uint32_t drv_num_buffers_per_bo(struct bo *bo);
 177
 178 #define drv_log(format, ...)                                                                       \
 179         do {                                                                                       \
 180                 drv_log_prefix("minigbm", __FILE__, __LINE__, format, ##__VA_ARGS__);              \
 181         } while (0)
 182
 183 __attribute__((format(printf, 4, 5))) void drv_log_prefix(const char *prefix, const char *file,
 184                                                           int line, const char *format, ...);
 185
 186 #ifdef __cplusplus
 187 }
 188 #endif
 189
 190 #endif