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 /* 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 #define BO_USE_TEXTURE                  (1ull << 17)
  40
  41 /* This is our extension to <drm_fourcc.h>.  We need to make sure we don't step
  42  * on the namespace of already defined formats, which can be done by using invalid
  43  * fourcc codes.
  44  */
  45
  46 #define DRM_FORMAT_NONE                         fourcc_code('0', '0', '0', '0')
  47 #define DRM_FORMAT_FLEX_IMPLEMENTATION_DEFINED  fourcc_code('9', '9', '9', '8')
  48 #define DRM_FORMAT_FLEX_YCbCr_420_888           fourcc_code('9', '9', '9', '9')
  49
  50 #define BO_COMMON_USE_MASK BO_USE_LINEAR | BO_USE_RENDERING | \
  51                            BO_USE_SW_READ_OFTEN | BO_USE_SW_WRITE_OFTEN | \
  52                            BO_USE_SW_READ_RARELY | BO_USE_SW_WRITE_RARELY | \
  53                            BO_USE_TEXTURE
  54 struct driver;
  55 struct bo;
  56 struct combination;
  57
  58 union bo_handle {
  59         void *ptr;
  60         int32_t s32;
  61         uint32_t u32;
  62         int64_t s64;
  63         uint64_t u64;
  64 };
  65
  66 struct drv_import_fd_data {
  67         int fds[DRV_MAX_PLANES];
  68         uint32_t strides[DRV_MAX_PLANES];
  69         uint32_t offsets[DRV_MAX_PLANES];
  70         uint32_t sizes[DRV_MAX_PLANES];
  71         uint64_t format_modifiers[DRV_MAX_PLANES];
  72         uint32_t width;
  73         uint32_t height;
  74         uint32_t format;
  75 };
  76
  77 struct driver *
  78 drv_create(int fd);
  79
  80 void
  81 drv_destroy(struct driver *drv);
  82
  83 int
  84 drv_get_fd(struct driver *drv);
  85
  86 const char *
  87 drv_get_name(struct driver *drv);
  88
  89 struct combination *
  90 drv_get_combination(struct driver *drv, uint32_t format, uint64_t usage);
  91
  92 struct bo *
  93 drv_bo_new(struct driver *drv, uint32_t width, uint32_t height,
  94            uint32_t format);
  95
  96 struct bo *
  97 drv_bo_create(struct driver *drv, uint32_t width, uint32_t height,
  98               uint32_t format, uint64_t flags);
  99
 100 struct bo *
 101 drv_bo_create_with_modifiers(struct driver *drv,
 102                              uint32_t width, uint32_t height,
 103                              uint32_t format,
 104                              const uint64_t *modifiers, uint32_t count);
 105
 106 void
 107 drv_bo_destroy(struct bo *bo);
 108
 109 struct bo *
 110 drv_bo_import(struct driver *drv, struct drv_import_fd_data *data);
 111
 112 void *
 113 drv_bo_map(struct bo *bo, uint32_t x, uint32_t y, uint32_t width,
 114            uint32_t height, uint32_t flags, void **map_data, size_t plane);
 115
 116 int
 117 drv_bo_unmap(struct bo *bo, void *map_data);
 118
 119 uint32_t
 120 drv_bo_get_width(struct bo *bo);
 121
 122 uint32_t
 123 drv_bo_get_height(struct bo *bo);
 124
 125 uint32_t
 126 drv_bo_get_stride_or_tiling(struct bo *bo);
 127
 128 size_t
 129 drv_bo_get_num_planes(struct bo *bo);
 130
 131 union bo_handle
 132 drv_bo_get_plane_handle(struct bo *bo, size_t plane);
 133
 134 int
 135 drv_bo_get_plane_fd(struct bo *bo, size_t plane);
 136
 137 uint32_t
 138 drv_bo_get_plane_offset(struct bo *bo, size_t plane);
 139
 140 uint32_t
 141 drv_bo_get_plane_size(struct bo *bo, size_t plane);
 142
 143 uint32_t
 144 drv_bo_get_plane_stride(struct bo *bo, size_t plane);
 145
 146 uint64_t
 147 drv_bo_get_plane_format_modifier(struct bo *bo, size_t plane);
 148
 149 uint32_t
 150 drv_bo_get_format(struct bo *bo);
 151
 152 uint32_t
 153 drv_resolve_format(struct driver *drv, uint32_t format);
 154
 155 int
 156 drv_stride_from_format(uint32_t format, uint32_t width, size_t plane);
 157
 158 size_t
 159 drv_num_planes_from_format(uint32_t format);
 160
 161 uint32_t
 162 drv_size_from_format(uint32_t format, uint32_t stride, uint32_t height,
 163                      size_t plane);
 164
 165 uint32_t
 166 drv_num_buffers_per_bo(struct bo *bo);
 167
 168 #ifdef __cplusplus
 169 }
 170 #endif
 171
 172 #endif