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