Commit | Line | Data |
---|---|---|
7520a277 DV |
1 | /* |
2 | * Copyright (c) 2016 Intel Corporation | |
3 | * | |
4 | * Permission to use, copy, modify, distribute, and sell this software and its | |
5 | * documentation for any purpose is hereby granted without fee, provided that | |
6 | * the above copyright notice appear in all copies and that both that copyright | |
7 | * notice and this permission notice appear in supporting documentation, and | |
8 | * that the name of the copyright holders not be used in advertising or | |
9 | * publicity pertaining to distribution of the software without specific, | |
10 | * written prior permission. The copyright holders make no representations | |
11 | * about the suitability of this software for any purpose. It is provided "as | |
12 | * is" without express or implied warranty. | |
13 | * | |
14 | * THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, | |
15 | * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO | |
16 | * EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY SPECIAL, INDIRECT OR | |
17 | * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, | |
18 | * DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER | |
19 | * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE | |
20 | * OF THIS SOFTWARE. | |
21 | */ | |
22 | ||
23 | #ifndef __DRM_FRAMEBUFFER_H__ | |
24 | #define __DRM_FRAMEBUFFER_H__ | |
25 | ||
26 | #include <linux/list.h> | |
27 | #include <linux/ctype.h> | |
949619f3 | 28 | #include <drm/drm_mode_object.h> |
7520a277 DV |
29 | |
30 | struct drm_framebuffer; | |
31 | struct drm_file; | |
32 | struct drm_device; | |
33 | ||
34 | /** | |
35 | * struct drm_framebuffer_funcs - framebuffer hooks | |
36 | */ | |
37 | struct drm_framebuffer_funcs { | |
38 | /** | |
39 | * @destroy: | |
40 | * | |
41 | * Clean up framebuffer resources, specifically also unreference the | |
42 | * backing storage. The core guarantees to call this function for every | |
d574528a DV |
43 | * framebuffer successfully created by calling |
44 | * &drm_mode_config_funcs.fb_create. Drivers must also call | |
7520a277 DV |
45 | * drm_framebuffer_cleanup() to release DRM core resources for this |
46 | * framebuffer. | |
47 | */ | |
48 | void (*destroy)(struct drm_framebuffer *framebuffer); | |
49 | ||
50 | /** | |
51 | * @create_handle: | |
52 | * | |
53 | * Create a buffer handle in the driver-specific buffer manager (either | |
ea0dd85a | 54 | * GEM or TTM) valid for the passed-in &struct drm_file. This is used by |
7520a277 DV |
55 | * the core to implement the GETFB IOCTL, which returns (for |
56 | * sufficiently priviledged user) also a native buffer handle. This can | |
57 | * be used for seamless transitions between modesetting clients by | |
58 | * copying the current screen contents to a private buffer and blending | |
59 | * between that and the new contents. | |
60 | * | |
61 | * GEM based drivers should call drm_gem_handle_create() to create the | |
62 | * handle. | |
63 | * | |
64 | * RETURNS: | |
65 | * | |
66 | * 0 on success or a negative error code on failure. | |
67 | */ | |
68 | int (*create_handle)(struct drm_framebuffer *fb, | |
69 | struct drm_file *file_priv, | |
70 | unsigned int *handle); | |
71 | /** | |
72 | * @dirty: | |
73 | * | |
74 | * Optional callback for the dirty fb IOCTL. | |
75 | * | |
76 | * Userspace can notify the driver via this callback that an area of the | |
77 | * framebuffer has changed and should be flushed to the display | |
78 | * hardware. This can also be used internally, e.g. by the fbdev | |
79 | * emulation, though that's not the case currently. | |
80 | * | |
81 | * See documentation in drm_mode.h for the struct drm_mode_fb_dirty_cmd | |
82 | * for more information as all the semantics and arguments have a one to | |
83 | * one mapping on this function. | |
84 | * | |
85 | * RETURNS: | |
86 | * | |
87 | * 0 on success or a negative error code on failure. | |
88 | */ | |
89 | int (*dirty)(struct drm_framebuffer *framebuffer, | |
90 | struct drm_file *file_priv, unsigned flags, | |
91 | unsigned color, struct drm_clip_rect *clips, | |
92 | unsigned num_clips); | |
93 | }; | |
94 | ||
750fb8c4 DV |
95 | /** |
96 | * struct drm_framebuffer - frame buffer object | |
97 | * | |
98 | * Note that the fb is refcounted for the benefit of driver internals, | |
99 | * for example some hw, disabling a CRTC/plane is asynchronous, and | |
100 | * scanout does not actually complete until the next vblank. So some | |
101 | * cleanup (like releasing the reference(s) on the backing GEM bo(s)) | |
102 | * should be deferred. In cases like this, the driver would like to | |
103 | * hold a ref to the fb even though it has already been removed from | |
a4a69da0 TR |
104 | * userspace perspective. See drm_framebuffer_get() and |
105 | * drm_framebuffer_put(). | |
750fb8c4 DV |
106 | * |
107 | * The refcount is stored inside the mode object @base. | |
108 | */ | |
7520a277 | 109 | struct drm_framebuffer { |
750fb8c4 DV |
110 | /** |
111 | * @dev: DRM device this framebuffer belongs to | |
112 | */ | |
7520a277 | 113 | struct drm_device *dev; |
750fb8c4 | 114 | /** |
d574528a DV |
115 | * @head: Place on the &drm_mode_config.fb_list, access protected by |
116 | * &drm_mode_config.fb_lock. | |
7520a277 DV |
117 | */ |
118 | struct list_head head; | |
750fb8c4 DV |
119 | |
120 | /** | |
121 | * @base: base modeset object structure, contains the reference count. | |
122 | */ | |
7520a277 | 123 | struct drm_mode_object base; |
8d44e9e6 ML |
124 | |
125 | /** | |
126 | * @comm: Name of the process allocating the fb, used for fb dumping. | |
127 | */ | |
128 | char comm[TASK_COMM_LEN]; | |
129 | ||
e14c23c6 VS |
130 | /** |
131 | * @format: framebuffer format information | |
132 | */ | |
133 | const struct drm_format_info *format; | |
750fb8c4 DV |
134 | /** |
135 | * @funcs: framebuffer vfunc table | |
136 | */ | |
7520a277 | 137 | const struct drm_framebuffer_funcs *funcs; |
750fb8c4 DV |
138 | /** |
139 | * @pitches: Line stride per buffer. For userspace created object this | |
140 | * is copied from drm_mode_fb_cmd2. | |
141 | */ | |
7520a277 | 142 | unsigned int pitches[4]; |
750fb8c4 DV |
143 | /** |
144 | * @offsets: Offset from buffer start to the actual pixel data in bytes, | |
145 | * per buffer. For userspace created object this is copied from | |
146 | * drm_mode_fb_cmd2. | |
147 | * | |
148 | * Note that this is a linear offset and does not take into account | |
149 | * tiling or buffer laytou per @modifier. It meant to be used when the | |
150 | * actual pixel data for this framebuffer plane starts at an offset, | |
151 | * e.g. when multiple planes are allocated within the same backing | |
152 | * storage buffer object. For tiled layouts this generally means it | |
153 | * @offsets must at least be tile-size aligned, but hardware often has | |
154 | * stricter requirements. | |
155 | * | |
156 | * This should not be used to specifiy x/y pixel offsets into the buffer | |
157 | * data (even for linear buffers). Specifying an x/y pixel offset is | |
ea0dd85a | 158 | * instead done through the source rectangle in &struct drm_plane_state. |
750fb8c4 | 159 | */ |
7520a277 | 160 | unsigned int offsets[4]; |
750fb8c4 | 161 | /** |
bae781b2 | 162 | * @modifier: Data layout modifier. This is used to describe |
750fb8c4 DV |
163 | * tiling, or also special layouts (like compression) of auxiliary |
164 | * buffers. For userspace created object this is copied from | |
165 | * drm_mode_fb_cmd2. | |
166 | */ | |
bae781b2 | 167 | uint64_t modifier; |
750fb8c4 DV |
168 | /** |
169 | * @width: Logical width of the visible area of the framebuffer, in | |
170 | * pixels. | |
171 | */ | |
7520a277 | 172 | unsigned int width; |
750fb8c4 DV |
173 | /** |
174 | * @height: Logical height of the visible area of the framebuffer, in | |
175 | * pixels. | |
176 | */ | |
7520a277 | 177 | unsigned int height; |
750fb8c4 DV |
178 | /** |
179 | * @flags: Framebuffer flags like DRM_MODE_FB_INTERLACED or | |
180 | * DRM_MODE_FB_MODIFIERS. | |
181 | */ | |
7520a277 | 182 | int flags; |
750fb8c4 DV |
183 | /** |
184 | * @hot_x: X coordinate of the cursor hotspot. Used by the legacy cursor | |
185 | * IOCTL when the driver supports cursor through a DRM_PLANE_TYPE_CURSOR | |
186 | * universal plane. | |
187 | */ | |
7520a277 | 188 | int hot_x; |
750fb8c4 DV |
189 | /** |
190 | * @hot_y: Y coordinate of the cursor hotspot. Used by the legacy cursor | |
191 | * IOCTL when the driver supports cursor through a DRM_PLANE_TYPE_CURSOR | |
192 | * universal plane. | |
193 | */ | |
7520a277 | 194 | int hot_y; |
750fb8c4 | 195 | /** |
d574528a | 196 | * @filp_head: Placed on &drm_file.fbs, protected by &drm_file.fbs_lock. |
750fb8c4 | 197 | */ |
7520a277 | 198 | struct list_head filp_head; |
4c3dbb2c NT |
199 | /** |
200 | * @obj: GEM objects backing the framebuffer, one per plane (optional). | |
201 | * | |
202 | * This is used by the GEM framebuffer helpers, see e.g. | |
203 | * drm_gem_fb_create(). | |
204 | */ | |
205 | struct drm_gem_object *obj[4]; | |
7520a277 DV |
206 | }; |
207 | ||
afb21ea6 DV |
208 | #define obj_to_fb(x) container_of(x, struct drm_framebuffer, base) |
209 | ||
7520a277 DV |
210 | int drm_framebuffer_init(struct drm_device *dev, |
211 | struct drm_framebuffer *fb, | |
212 | const struct drm_framebuffer_funcs *funcs); | |
213 | struct drm_framebuffer *drm_framebuffer_lookup(struct drm_device *dev, | |
418da172 | 214 | struct drm_file *file_priv, |
7520a277 DV |
215 | uint32_t id); |
216 | void drm_framebuffer_remove(struct drm_framebuffer *fb); | |
217 | void drm_framebuffer_cleanup(struct drm_framebuffer *fb); | |
218 | void drm_framebuffer_unregister_private(struct drm_framebuffer *fb); | |
219 | ||
220 | /** | |
a4a69da0 TR |
221 | * drm_framebuffer_get - acquire a framebuffer reference |
222 | * @fb: DRM framebuffer | |
223 | * | |
224 | * This function increments the framebuffer's reference count. | |
225 | */ | |
226 | static inline void drm_framebuffer_get(struct drm_framebuffer *fb) | |
227 | { | |
228 | drm_mode_object_get(&fb->base); | |
229 | } | |
230 | ||
231 | /** | |
232 | * drm_framebuffer_put - release a framebuffer reference | |
233 | * @fb: DRM framebuffer | |
234 | * | |
235 | * This function decrements the framebuffer's reference count and frees the | |
236 | * framebuffer if the reference count drops to zero. | |
237 | */ | |
238 | static inline void drm_framebuffer_put(struct drm_framebuffer *fb) | |
239 | { | |
240 | drm_mode_object_put(&fb->base); | |
241 | } | |
242 | ||
243 | /** | |
244 | * drm_framebuffer_reference - acquire a framebuffer reference | |
245 | * @fb: DRM framebuffer | |
7520a277 | 246 | * |
a4a69da0 TR |
247 | * This is a compatibility alias for drm_framebuffer_get() and should not be |
248 | * used by new code. | |
7520a277 DV |
249 | */ |
250 | static inline void drm_framebuffer_reference(struct drm_framebuffer *fb) | |
251 | { | |
a4a69da0 | 252 | drm_framebuffer_get(fb); |
7520a277 DV |
253 | } |
254 | ||
255 | /** | |
a4a69da0 TR |
256 | * drm_framebuffer_unreference - release a framebuffer reference |
257 | * @fb: DRM framebuffer | |
7520a277 | 258 | * |
a4a69da0 TR |
259 | * This is a compatibility alias for drm_framebuffer_put() and should not be |
260 | * used by new code. | |
7520a277 DV |
261 | */ |
262 | static inline void drm_framebuffer_unreference(struct drm_framebuffer *fb) | |
263 | { | |
a4a69da0 | 264 | drm_framebuffer_put(fb); |
7520a277 DV |
265 | } |
266 | ||
267 | /** | |
268 | * drm_framebuffer_read_refcount - read the framebuffer reference count. | |
269 | * @fb: framebuffer | |
270 | * | |
271 | * This functions returns the framebuffer's reference count. | |
272 | */ | |
6ff1086e | 273 | static inline uint32_t drm_framebuffer_read_refcount(const struct drm_framebuffer *fb) |
7520a277 | 274 | { |
2c935bc5 | 275 | return kref_read(&fb->base.refcount); |
7520a277 | 276 | } |
afb21ea6 DV |
277 | |
278 | /** | |
389f78b3 CW |
279 | * drm_framebuffer_assign - store a reference to the fb |
280 | * @p: location to store framebuffer | |
281 | * @fb: new framebuffer (maybe NULL) | |
282 | * | |
283 | * This functions sets the location to store a reference to the framebuffer, | |
284 | * unreferencing the framebuffer that was previously stored in that location. | |
285 | */ | |
286 | static inline void drm_framebuffer_assign(struct drm_framebuffer **p, | |
287 | struct drm_framebuffer *fb) | |
288 | { | |
289 | if (fb) | |
a4a69da0 | 290 | drm_framebuffer_get(fb); |
389f78b3 | 291 | if (*p) |
a4a69da0 | 292 | drm_framebuffer_put(*p); |
389f78b3 CW |
293 | *p = fb; |
294 | } | |
295 | ||
296 | /* | |
afb21ea6 DV |
297 | * drm_for_each_fb - iterate over all framebuffers |
298 | * @fb: the loop cursor | |
299 | * @dev: the DRM device | |
300 | * | |
d574528a DV |
301 | * Iterate over all framebuffers of @dev. User must hold |
302 | * &drm_mode_config.fb_lock. | |
afb21ea6 DV |
303 | */ |
304 | #define drm_for_each_fb(fb, dev) \ | |
305 | for (WARN_ON(!mutex_is_locked(&(dev)->mode_config.fb_lock)), \ | |
306 | fb = list_first_entry(&(dev)->mode_config.fb_list, \ | |
307 | struct drm_framebuffer, head); \ | |
308 | &fb->head != (&(dev)->mode_config.fb_list); \ | |
309 | fb = list_next_entry(fb, head)) | |
8f8f6a6c VS |
310 | |
311 | int drm_framebuffer_plane_width(int width, | |
312 | const struct drm_framebuffer *fb, int plane); | |
313 | int drm_framebuffer_plane_height(int height, | |
314 | const struct drm_framebuffer *fb, int plane); | |
315 | ||
7520a277 | 316 | #endif |