Commit | Line | Data |
---|---|---|
43968d7b 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_PLANE_H__ | |
24 | #define __DRM_PLANE_H__ | |
25 | ||
26 | #include <linux/list.h> | |
27 | #include <linux/ctype.h> | |
28 | #include <drm/drm_mode_object.h> | |
80f690e9 | 29 | #include <drm/drm_color_mgmt.h> |
b88ac005 DV |
30 | #include <drm/drm_rect.h> |
31 | #include <drm/drm_modeset_lock.h> | |
d78aa650 | 32 | #include <drm/drm_util.h> |
43968d7b DV |
33 | |
34 | struct drm_crtc; | |
fceffb32 | 35 | struct drm_printer; |
34a2ab5e | 36 | struct drm_modeset_acquire_ctx; |
43968d7b DV |
37 | |
38 | /** | |
39 | * struct drm_plane_state - mutable plane state | |
2e784a91 DV |
40 | * |
41 | * Please not that the destination coordinates @crtc_x, @crtc_y, @crtc_h and | |
42 | * @crtc_w and the source coordinates @src_x, @src_y, @src_h and @src_w are the | |
43 | * raw coordinates provided by userspace. Drivers should use | |
44 | * drm_atomic_helper_check_plane_state() and only use the derived rectangles in | |
45 | * @src and @dst to program the hardware. | |
43968d7b DV |
46 | */ |
47 | struct drm_plane_state { | |
2e784a91 | 48 | /** @plane: backpointer to the plane */ |
43968d7b DV |
49 | struct drm_plane *plane; |
50 | ||
3835b46e GP |
51 | /** |
52 | * @crtc: | |
53 | * | |
54 | * Currently bound CRTC, NULL if disabled. Do not this write directly, | |
55 | * use drm_atomic_set_crtc_for_plane() | |
56 | */ | |
57 | struct drm_crtc *crtc; | |
58 | ||
59 | /** | |
60 | * @fb: | |
61 | * | |
62 | * Currently bound framebuffer. Do not write this directly, use | |
63 | * drm_atomic_set_fb_for_plane() | |
64 | */ | |
65 | struct drm_framebuffer *fb; | |
66 | ||
67 | /** | |
68 | * @fence: | |
69 | * | |
30d23f22 DV |
70 | * Optional fence to wait for before scanning out @fb. The core atomic |
71 | * code will set this when userspace is using explicit fencing. Do not | |
1b94f477 | 72 | * write this field directly for a driver's implicit fence, use |
30d23f22 DV |
73 | * drm_atomic_set_fence_for_plane() to ensure that an explicit fence is |
74 | * preserved. | |
75 | * | |
76 | * Drivers should store any implicit fence in this from their | |
2e784a91 | 77 | * &drm_plane_helper_funcs.prepare_fb callback. See drm_gem_fb_prepare_fb() |
30d23f22 | 78 | * and drm_gem_fb_simple_display_pipe_prepare_fb() for suitable helpers. |
3835b46e | 79 | */ |
f54d1867 | 80 | struct dma_fence *fence; |
43968d7b | 81 | |
3835b46e GP |
82 | /** |
83 | * @crtc_x: | |
84 | * | |
85 | * Left position of visible portion of plane on crtc, signed dest | |
86 | * location allows it to be partially off screen. | |
87 | */ | |
88 | ||
89 | int32_t crtc_x; | |
90 | /** | |
91 | * @crtc_y: | |
92 | * | |
93 | * Upper position of visible portion of plane on crtc, signed dest | |
94 | * location allows it to be partially off screen. | |
95 | */ | |
96 | int32_t crtc_y; | |
43968d7b | 97 | |
2e784a91 DV |
98 | /** @crtc_w: width of visible portion of plane on crtc */ |
99 | /** @crtc_h: height of visible portion of plane on crtc */ | |
43968d7b DV |
100 | uint32_t crtc_w, crtc_h; |
101 | ||
2e784a91 DV |
102 | /** |
103 | * @src_x: left position of visible portion of plane within plane (in | |
104 | * 16.16 fixed point). | |
105 | */ | |
106 | uint32_t src_x; | |
107 | /** | |
108 | * @src_y: upper position of visible portion of plane within plane (in | |
109 | * 16.16 fixed point). | |
110 | */ | |
111 | uint32_t src_y; | |
112 | /** @src_w: width of visible portion of plane (in 16.16) */ | |
113 | /** @src_h: height of visible portion of plane (in 16.16) */ | |
43968d7b DV |
114 | uint32_t src_h, src_w; |
115 | ||
2e784a91 DV |
116 | /** |
117 | * @alpha: | |
118 | * Opacity of the plane with 0 as completely transparent and 0xffff as | |
119 | * completely opaque. See drm_plane_create_alpha_property() for more | |
120 | * details. | |
121 | */ | |
ae0e2826 | 122 | u16 alpha; |
b972cece SP |
123 | |
124 | /** | |
125 | * @pixel_blend_mode: | |
126 | * The alpha blending equation selection, describing how the pixels from | |
127 | * the current plane are composited with the background. Value can be | |
128 | * one of DRM_MODE_BLEND_* | |
129 | */ | |
a5ec8332 | 130 | uint16_t pixel_blend_mode; |
ae0e2826 | 131 | |
2e784a91 DV |
132 | /** |
133 | * @rotation: | |
134 | * Rotation of the plane. See drm_plane_create_rotation_property() for | |
135 | * more details. | |
136 | */ | |
43968d7b DV |
137 | unsigned int rotation; |
138 | ||
2e784a91 DV |
139 | /** |
140 | * @zpos: | |
141 | * Priority of the given plane on crtc (optional). | |
142 | * | |
8f6ea27b SS |
143 | * User-space may set mutable zpos properties so that multiple active |
144 | * planes on the same CRTC have identical zpos values. This is a | |
145 | * user-space bug, but drivers can solve the conflict by comparing the | |
146 | * plane object IDs; the plane with a higher ID is stacked on top of a | |
147 | * plane with a lower ID. | |
2e784a91 DV |
148 | * |
149 | * See drm_plane_create_zpos_property() and | |
150 | * drm_plane_create_zpos_immutable_property() for more details. | |
151 | */ | |
43968d7b | 152 | unsigned int zpos; |
2e784a91 DV |
153 | |
154 | /** | |
155 | * @normalized_zpos: | |
156 | * Normalized value of zpos: unique, range from 0 to N-1 where N is the | |
157 | * number of active planes for given crtc. Note that the driver must set | |
158 | * &drm_mode_config.normalize_zpos or call drm_atomic_normalize_zpos() to | |
159 | * update this before it can be trusted. | |
160 | */ | |
43968d7b DV |
161 | unsigned int normalized_zpos; |
162 | ||
80f690e9 JS |
163 | /** |
164 | * @color_encoding: | |
165 | * | |
166 | * Color encoding for non RGB formats | |
167 | */ | |
168 | enum drm_color_encoding color_encoding; | |
169 | ||
170 | /** | |
171 | * @color_range: | |
172 | * | |
173 | * Color range for non RGB formats | |
174 | */ | |
175 | enum drm_color_range color_range; | |
176 | ||
d3b21767 LS |
177 | /** |
178 | * @fb_damage_clips: | |
179 | * | |
180 | * Blob representing damage (area in plane framebuffer that changed | |
181 | * since last plane update) as an array of &drm_mode_rect in framebuffer | |
182 | * coodinates of the attached framebuffer. Note that unlike plane src, | |
183 | * damage clips are not in 16.16 fixed point. | |
184 | */ | |
185 | struct drm_property_blob *fb_damage_clips; | |
186 | ||
fec74874 ML |
187 | /** |
188 | * @src: | |
189 | * | |
190 | * source coordinates of the plane (in 16.16). | |
191 | * | |
192 | * When using drm_atomic_helper_check_plane_state(), | |
193 | * the coordinates are clipped, but the driver may choose | |
194 | * to use unclipped coordinates instead when the hardware | |
195 | * performs the clipping automatically. | |
196 | */ | |
197 | /** | |
198 | * @dst: | |
199 | * | |
200 | * clipped destination coordinates of the plane. | |
201 | * | |
202 | * When using drm_atomic_helper_check_plane_state(), | |
203 | * the coordinates are clipped, but the driver may choose | |
204 | * to use unclipped coordinates instead when the hardware | |
205 | * performs the clipping automatically. | |
206 | */ | |
43968d7b DV |
207 | struct drm_rect src, dst; |
208 | ||
3835b46e GP |
209 | /** |
210 | * @visible: | |
211 | * | |
212 | * Visibility of the plane. This can be false even if fb!=NULL and | |
213 | * crtc!=NULL, due to clipping. | |
43968d7b DV |
214 | */ |
215 | bool visible; | |
216 | ||
21a01abb | 217 | /** |
669c9215 ML |
218 | * @commit: Tracks the pending commit to prevent use-after-free conditions, |
219 | * and for async plane updates. | |
21a01abb | 220 | * |
669c9215 | 221 | * May be NULL. |
21a01abb ML |
222 | */ |
223 | struct drm_crtc_commit *commit; | |
224 | ||
2e784a91 | 225 | /** @state: backpointer to global drm_atomic_state */ |
43968d7b DV |
226 | struct drm_atomic_state *state; |
227 | }; | |
228 | ||
1638d30c RC |
229 | static inline struct drm_rect |
230 | drm_plane_state_src(const struct drm_plane_state *state) | |
231 | { | |
232 | struct drm_rect src = { | |
233 | .x1 = state->src_x, | |
234 | .y1 = state->src_y, | |
235 | .x2 = state->src_x + state->src_w, | |
236 | .y2 = state->src_y + state->src_h, | |
237 | }; | |
238 | return src; | |
239 | } | |
240 | ||
241 | static inline struct drm_rect | |
242 | drm_plane_state_dest(const struct drm_plane_state *state) | |
243 | { | |
244 | struct drm_rect dest = { | |
245 | .x1 = state->crtc_x, | |
246 | .y1 = state->crtc_y, | |
247 | .x2 = state->crtc_x + state->crtc_w, | |
248 | .y2 = state->crtc_y + state->crtc_h, | |
249 | }; | |
250 | return dest; | |
251 | } | |
252 | ||
43968d7b DV |
253 | /** |
254 | * struct drm_plane_funcs - driver plane control functions | |
255 | */ | |
256 | struct drm_plane_funcs { | |
257 | /** | |
258 | * @update_plane: | |
259 | * | |
260 | * This is the legacy entry point to enable and configure the plane for | |
261 | * the given CRTC and framebuffer. It is never called to disable the | |
262 | * plane, i.e. the passed-in crtc and fb paramters are never NULL. | |
263 | * | |
264 | * The source rectangle in frame buffer memory coordinates is given by | |
265 | * the src_x, src_y, src_w and src_h parameters (as 16.16 fixed point | |
266 | * values). Devices that don't support subpixel plane coordinates can | |
267 | * ignore the fractional part. | |
268 | * | |
269 | * The destination rectangle in CRTC coordinates is given by the | |
270 | * crtc_x, crtc_y, crtc_w and crtc_h parameters (as integer values). | |
271 | * Devices scale the source rectangle to the destination rectangle. If | |
272 | * scaling is not supported, and the source rectangle size doesn't match | |
273 | * the destination rectangle size, the driver must return a | |
274 | * -<errorname>EINVAL</errorname> error. | |
275 | * | |
276 | * Drivers implementing atomic modeset should use | |
277 | * drm_atomic_helper_update_plane() to implement this hook. | |
278 | * | |
279 | * RETURNS: | |
280 | * | |
281 | * 0 on success or a negative error code on failure. | |
282 | */ | |
283 | int (*update_plane)(struct drm_plane *plane, | |
284 | struct drm_crtc *crtc, struct drm_framebuffer *fb, | |
285 | int crtc_x, int crtc_y, | |
286 | unsigned int crtc_w, unsigned int crtc_h, | |
287 | uint32_t src_x, uint32_t src_y, | |
34a2ab5e DV |
288 | uint32_t src_w, uint32_t src_h, |
289 | struct drm_modeset_acquire_ctx *ctx); | |
43968d7b DV |
290 | |
291 | /** | |
292 | * @disable_plane: | |
293 | * | |
294 | * This is the legacy entry point to disable the plane. The DRM core | |
295 | * calls this method in response to a DRM_IOCTL_MODE_SETPLANE IOCTL call | |
296 | * with the frame buffer ID set to 0. Disabled planes must not be | |
297 | * processed by the CRTC. | |
298 | * | |
299 | * Drivers implementing atomic modeset should use | |
300 | * drm_atomic_helper_disable_plane() to implement this hook. | |
301 | * | |
302 | * RETURNS: | |
303 | * | |
304 | * 0 on success or a negative error code on failure. | |
305 | */ | |
19315294 DV |
306 | int (*disable_plane)(struct drm_plane *plane, |
307 | struct drm_modeset_acquire_ctx *ctx); | |
43968d7b DV |
308 | |
309 | /** | |
310 | * @destroy: | |
311 | * | |
312 | * Clean up plane resources. This is only called at driver unload time | |
313 | * through drm_mode_config_cleanup() since a plane cannot be hotplugged | |
314 | * in DRM. | |
315 | */ | |
316 | void (*destroy)(struct drm_plane *plane); | |
317 | ||
318 | /** | |
319 | * @reset: | |
320 | * | |
321 | * Reset plane hardware and software state to off. This function isn't | |
322 | * called by the core directly, only through drm_mode_config_reset(). | |
323 | * It's not a helper hook only for historical reasons. | |
324 | * | |
325 | * Atomic drivers can use drm_atomic_helper_plane_reset() to reset | |
326 | * atomic state using this hook. | |
327 | */ | |
328 | void (*reset)(struct drm_plane *plane); | |
329 | ||
330 | /** | |
331 | * @set_property: | |
332 | * | |
333 | * This is the legacy entry point to update a property attached to the | |
334 | * plane. | |
335 | * | |
43968d7b | 336 | * This callback is optional if the driver does not support any legacy |
144a7999 DV |
337 | * driver-private properties. For atomic drivers it is not used because |
338 | * property handling is done entirely in the DRM core. | |
43968d7b DV |
339 | * |
340 | * RETURNS: | |
341 | * | |
342 | * 0 on success or a negative error code on failure. | |
343 | */ | |
344 | int (*set_property)(struct drm_plane *plane, | |
345 | struct drm_property *property, uint64_t val); | |
346 | ||
347 | /** | |
348 | * @atomic_duplicate_state: | |
349 | * | |
350 | * Duplicate the current atomic state for this plane and return it. | |
d574528a | 351 | * The core and helpers guarantee that any atomic state duplicated with |
43968d7b | 352 | * this hook and still owned by the caller (i.e. not transferred to the |
d574528a DV |
353 | * driver by calling &drm_mode_config_funcs.atomic_commit) will be |
354 | * cleaned up by calling the @atomic_destroy_state hook in this | |
355 | * structure. | |
43968d7b | 356 | * |
ba1f665f HM |
357 | * This callback is mandatory for atomic drivers. |
358 | * | |
ea0dd85a | 359 | * Atomic drivers which don't subclass &struct drm_plane_state should use |
43968d7b DV |
360 | * drm_atomic_helper_plane_duplicate_state(). Drivers that subclass the |
361 | * state structure to extend it with driver-private state should use | |
362 | * __drm_atomic_helper_plane_duplicate_state() to make sure shared state is | |
363 | * duplicated in a consistent fashion across drivers. | |
364 | * | |
d574528a | 365 | * It is an error to call this hook before &drm_plane.state has been |
43968d7b DV |
366 | * initialized correctly. |
367 | * | |
368 | * NOTE: | |
369 | * | |
370 | * If the duplicate state references refcounted resources this hook must | |
371 | * acquire a reference for each of them. The driver must release these | |
372 | * references again in @atomic_destroy_state. | |
373 | * | |
374 | * RETURNS: | |
375 | * | |
376 | * Duplicated atomic state or NULL when the allocation failed. | |
377 | */ | |
378 | struct drm_plane_state *(*atomic_duplicate_state)(struct drm_plane *plane); | |
379 | ||
380 | /** | |
381 | * @atomic_destroy_state: | |
382 | * | |
383 | * Destroy a state duplicated with @atomic_duplicate_state and release | |
384 | * or unreference all resources it references | |
ba1f665f HM |
385 | * |
386 | * This callback is mandatory for atomic drivers. | |
43968d7b DV |
387 | */ |
388 | void (*atomic_destroy_state)(struct drm_plane *plane, | |
389 | struct drm_plane_state *state); | |
390 | ||
391 | /** | |
392 | * @atomic_set_property: | |
393 | * | |
394 | * Decode a driver-private property value and store the decoded value | |
395 | * into the passed-in state structure. Since the atomic core decodes all | |
396 | * standardized properties (even for extensions beyond the core set of | |
397 | * properties which might not be implemented by all drivers) this | |
398 | * requires drivers to subclass the state structure. | |
399 | * | |
400 | * Such driver-private properties should really only be implemented for | |
401 | * truly hardware/vendor specific state. Instead it is preferred to | |
402 | * standardize atomic extension and decode the properties used to expose | |
403 | * such an extension in the core. | |
404 | * | |
405 | * Do not call this function directly, use | |
406 | * drm_atomic_plane_set_property() instead. | |
407 | * | |
408 | * This callback is optional if the driver does not support any | |
409 | * driver-private atomic properties. | |
410 | * | |
411 | * NOTE: | |
412 | * | |
413 | * This function is called in the state assembly phase of atomic | |
414 | * modesets, which can be aborted for any reason (including on | |
415 | * userspace's request to just check whether a configuration would be | |
416 | * possible). Drivers MUST NOT touch any persistent state (hardware or | |
417 | * software) or data structures except the passed in @state parameter. | |
418 | * | |
419 | * Also since userspace controls in which order properties are set this | |
420 | * function must not do any input validation (since the state update is | |
421 | * incomplete and hence likely inconsistent). Instead any such input | |
422 | * validation must be done in the various atomic_check callbacks. | |
423 | * | |
424 | * RETURNS: | |
425 | * | |
426 | * 0 if the property has been found, -EINVAL if the property isn't | |
427 | * implemented by the driver (which shouldn't ever happen, the core only | |
428 | * asks for properties attached to this plane). No other validation is | |
429 | * allowed by the driver. The core already checks that the property | |
430 | * value is within the range (integer, valid enum value, ...) the driver | |
431 | * set when registering the property. | |
432 | */ | |
433 | int (*atomic_set_property)(struct drm_plane *plane, | |
434 | struct drm_plane_state *state, | |
435 | struct drm_property *property, | |
436 | uint64_t val); | |
437 | ||
438 | /** | |
439 | * @atomic_get_property: | |
440 | * | |
441 | * Reads out the decoded driver-private property. This is used to | |
442 | * implement the GETPLANE IOCTL. | |
443 | * | |
444 | * Do not call this function directly, use | |
445 | * drm_atomic_plane_get_property() instead. | |
446 | * | |
447 | * This callback is optional if the driver does not support any | |
448 | * driver-private atomic properties. | |
449 | * | |
450 | * RETURNS: | |
451 | * | |
452 | * 0 on success, -EINVAL if the property isn't implemented by the | |
453 | * driver (which should never happen, the core only asks for | |
454 | * properties attached to this plane). | |
455 | */ | |
456 | int (*atomic_get_property)(struct drm_plane *plane, | |
457 | const struct drm_plane_state *state, | |
458 | struct drm_property *property, | |
459 | uint64_t *val); | |
460 | /** | |
461 | * @late_register: | |
462 | * | |
463 | * This optional hook can be used to register additional userspace | |
464 | * interfaces attached to the plane like debugfs interfaces. | |
465 | * It is called late in the driver load sequence from drm_dev_register(). | |
466 | * Everything added from this callback should be unregistered in | |
467 | * the early_unregister callback. | |
468 | * | |
469 | * Returns: | |
470 | * | |
471 | * 0 on success, or a negative error code on failure. | |
472 | */ | |
473 | int (*late_register)(struct drm_plane *plane); | |
474 | ||
475 | /** | |
476 | * @early_unregister: | |
477 | * | |
478 | * This optional hook should be used to unregister the additional | |
479 | * userspace interfaces attached to the plane from | |
559bdaf7 | 480 | * @late_register. It is called from drm_dev_unregister(), |
43968d7b DV |
481 | * early in the driver unload sequence to disable userspace access |
482 | * before data structures are torndown. | |
483 | */ | |
484 | void (*early_unregister)(struct drm_plane *plane); | |
fceffb32 RC |
485 | |
486 | /** | |
487 | * @atomic_print_state: | |
488 | * | |
ea0dd85a | 489 | * If driver subclasses &struct drm_plane_state, it should implement |
fceffb32 RC |
490 | * this optional hook for printing additional driver specific state. |
491 | * | |
492 | * Do not call this directly, use drm_atomic_plane_print_state() | |
493 | * instead. | |
494 | */ | |
495 | void (*atomic_print_state)(struct drm_printer *p, | |
496 | const struct drm_plane_state *state); | |
e6fc3b68 BW |
497 | |
498 | /** | |
499 | * @format_mod_supported: | |
500 | * | |
501 | * This optional hook is used for the DRM to determine if the given | |
502 | * format/modifier combination is valid for the plane. This allows the | |
503 | * DRM to generate the correct format bitmask (which formats apply to | |
8fb756df EA |
504 | * which modifier), and to valdiate modifiers at atomic_check time. |
505 | * | |
506 | * If not present, then any modifier in the plane's modifier | |
507 | * list is allowed with any of the plane's formats. | |
e6fc3b68 BW |
508 | * |
509 | * Returns: | |
510 | * | |
511 | * True if the given modifier is valid for that format on the plane. | |
512 | * False otherwise. | |
513 | */ | |
514 | bool (*format_mod_supported)(struct drm_plane *plane, uint32_t format, | |
515 | uint64_t modifier); | |
43968d7b DV |
516 | }; |
517 | ||
532b3671 DV |
518 | /** |
519 | * enum drm_plane_type - uapi plane type enumeration | |
520 | * | |
521 | * For historical reasons not all planes are made the same. This enumeration is | |
522 | * used to tell the different types of planes apart to implement the different | |
523 | * uapi semantics for them. For userspace which is universal plane aware and | |
524 | * which is using that atomic IOCTL there's no difference between these planes | |
525 | * (beyong what the driver and hardware can support of course). | |
526 | * | |
527 | * For compatibility with legacy userspace, only overlay planes are made | |
528 | * available to userspace by default. Userspace clients may set the | |
529 | * DRM_CLIENT_CAP_UNIVERSAL_PLANES client capability bit to indicate that they | |
530 | * wish to receive a universal plane list containing all plane types. See also | |
531 | * drm_for_each_legacy_plane(). | |
226714dc DV |
532 | * |
533 | * WARNING: The values of this enum is UABI since they're exposed in the "type" | |
534 | * property. | |
532b3671 | 535 | */ |
43968d7b | 536 | enum drm_plane_type { |
226714dc DV |
537 | /** |
538 | * @DRM_PLANE_TYPE_OVERLAY: | |
539 | * | |
540 | * Overlay planes represent all non-primary, non-cursor planes. Some | |
541 | * drivers refer to these types of planes as "sprites" internally. | |
542 | */ | |
543 | DRM_PLANE_TYPE_OVERLAY, | |
544 | ||
532b3671 DV |
545 | /** |
546 | * @DRM_PLANE_TYPE_PRIMARY: | |
547 | * | |
548 | * Primary planes represent a "main" plane for a CRTC. Primary planes | |
549 | * are the planes operated upon by CRTC modesetting and flipping | |
d574528a DV |
550 | * operations described in the &drm_crtc_funcs.page_flip and |
551 | * &drm_crtc_funcs.set_config hooks. | |
532b3671 | 552 | */ |
43968d7b | 553 | DRM_PLANE_TYPE_PRIMARY, |
532b3671 DV |
554 | |
555 | /** | |
556 | * @DRM_PLANE_TYPE_CURSOR: | |
557 | * | |
558 | * Cursor planes represent a "cursor" plane for a CRTC. Cursor planes | |
559 | * are the planes operated upon by the DRM_IOCTL_MODE_CURSOR and | |
560 | * DRM_IOCTL_MODE_CURSOR2 IOCTLs. | |
561 | */ | |
43968d7b DV |
562 | DRM_PLANE_TYPE_CURSOR, |
563 | }; | |
564 | ||
565 | ||
566 | /** | |
567 | * struct drm_plane - central DRM plane control structure | |
268bc24e DV |
568 | * |
569 | * Planes represent the scanout hardware of a display block. They receive their | |
570 | * input data from a &drm_framebuffer and feed it to a &drm_crtc. Planes control | |
571 | * the color conversion, see `Plane Composition Properties`_ for more details, | |
572 | * and are also involved in the color conversion of input pixels, see `Color | |
573 | * Management Properties`_ for details on that. | |
43968d7b DV |
574 | */ |
575 | struct drm_plane { | |
268bc24e | 576 | /** @dev: DRM device this plane belongs to */ |
43968d7b | 577 | struct drm_device *dev; |
268bc24e DV |
578 | |
579 | /** | |
580 | * @head: | |
581 | * | |
582 | * List of all planes on @dev, linked from &drm_mode_config.plane_list. | |
583 | * Invariant over the lifetime of @dev and therefore does not need | |
584 | * locking. | |
585 | */ | |
43968d7b DV |
586 | struct list_head head; |
587 | ||
268bc24e | 588 | /** @name: human readable name, can be overwritten by the driver */ |
43968d7b DV |
589 | char *name; |
590 | ||
591 | /** | |
592 | * @mutex: | |
593 | * | |
d574528a DV |
594 | * Protects modeset plane state, together with the &drm_crtc.mutex of |
595 | * CRTC this plane is linked to (when active, getting activated or | |
596 | * getting disabled). | |
c9e42b72 DV |
597 | * |
598 | * For atomic drivers specifically this protects @state. | |
43968d7b DV |
599 | */ |
600 | struct drm_modeset_lock mutex; | |
601 | ||
268bc24e | 602 | /** @base: base mode object */ |
43968d7b DV |
603 | struct drm_mode_object base; |
604 | ||
268bc24e DV |
605 | /** |
606 | * @possible_crtcs: pipes this plane can be bound to constructed from | |
607 | * drm_crtc_mask() | |
608 | */ | |
43968d7b | 609 | uint32_t possible_crtcs; |
268bc24e | 610 | /** @format_types: array of formats supported by this plane */ |
43968d7b | 611 | uint32_t *format_types; |
268bc24e | 612 | /** @format_count: Size of the array pointed at by @format_types. */ |
43968d7b | 613 | unsigned int format_count; |
268bc24e DV |
614 | /** |
615 | * @format_default: driver hasn't supplied supported formats for the | |
616 | * plane. Used by the drm_plane_init compatibility wrapper only. | |
617 | */ | |
43968d7b DV |
618 | bool format_default; |
619 | ||
268bc24e | 620 | /** @modifiers: array of modifiers supported by this plane */ |
e6fc3b68 | 621 | uint64_t *modifiers; |
268bc24e | 622 | /** @modifier_count: Size of the array pointed at by @modifier_count. */ |
e6fc3b68 BW |
623 | unsigned int modifier_count; |
624 | ||
2e2b96ef | 625 | /** |
268bc24e DV |
626 | * @crtc: |
627 | * | |
628 | * Currently bound CRTC, only meaningful for non-atomic drivers. For | |
629 | * atomic drivers this is forced to be NULL, atomic drivers should | |
630 | * instead check &drm_plane_state.crtc. | |
2e2b96ef | 631 | */ |
43968d7b | 632 | struct drm_crtc *crtc; |
2e2b96ef DV |
633 | |
634 | /** | |
268bc24e DV |
635 | * @fb: |
636 | * | |
637 | * Currently bound framebuffer, only meaningful for non-atomic drivers. | |
638 | * For atomic drivers this is forced to be NULL, atomic drivers should | |
639 | * instead check &drm_plane_state.fb. | |
2e2b96ef | 640 | */ |
43968d7b DV |
641 | struct drm_framebuffer *fb; |
642 | ||
268bc24e DV |
643 | /** |
644 | * @old_fb: | |
645 | * | |
646 | * Temporary tracking of the old fb while a modeset is ongoing. Only | |
647 | * used by non-atomic drivers, forced to be NULL for atomic drivers. | |
648 | */ | |
43968d7b DV |
649 | struct drm_framebuffer *old_fb; |
650 | ||
268bc24e | 651 | /** @funcs: plane control functions */ |
43968d7b DV |
652 | const struct drm_plane_funcs *funcs; |
653 | ||
268bc24e | 654 | /** @properties: property tracking for this plane */ |
43968d7b DV |
655 | struct drm_object_properties properties; |
656 | ||
268bc24e | 657 | /** @type: Type of plane, see &enum drm_plane_type for details. */ |
43968d7b DV |
658 | enum drm_plane_type type; |
659 | ||
660 | /** | |
661 | * @index: Position inside the mode_config.list, can be used as an array | |
662 | * index. It is invariant over the lifetime of the plane. | |
663 | */ | |
664 | unsigned index; | |
665 | ||
268bc24e | 666 | /** @helper_private: mid-layer private data */ |
43968d7b DV |
667 | const struct drm_plane_helper_funcs *helper_private; |
668 | ||
c9e42b72 DV |
669 | /** |
670 | * @state: | |
671 | * | |
672 | * Current atomic state for this plane. | |
673 | * | |
674 | * This is protected by @mutex. Note that nonblocking atomic commits | |
675 | * access the current plane state without taking locks. Either by going | |
676 | * through the &struct drm_atomic_state pointers, see | |
77ac3b00 ML |
677 | * for_each_oldnew_plane_in_state(), for_each_old_plane_in_state() and |
678 | * for_each_new_plane_in_state(). Or through careful ordering of atomic | |
679 | * commit operations as implemented in the atomic helpers, see | |
680 | * &struct drm_crtc_commit. | |
c9e42b72 | 681 | */ |
43968d7b DV |
682 | struct drm_plane_state *state; |
683 | ||
268bc24e DV |
684 | /** |
685 | * @alpha_property: | |
686 | * Optional alpha property for this plane. See | |
687 | * drm_plane_create_alpha_property(). | |
688 | */ | |
ae0e2826 | 689 | struct drm_property *alpha_property; |
268bc24e DV |
690 | /** |
691 | * @zpos_property: | |
692 | * Optional zpos property for this plane. See | |
693 | * drm_plane_create_zpos_property(). | |
694 | */ | |
43968d7b | 695 | struct drm_property *zpos_property; |
268bc24e DV |
696 | /** |
697 | * @rotation_property: | |
698 | * Optional rotation property for this plane. See | |
699 | * drm_plane_create_rotation_property(). | |
700 | */ | |
d138dd3c | 701 | struct drm_property *rotation_property; |
a5ec8332 LL |
702 | /** |
703 | * @blend_mode_property: | |
704 | * Optional "pixel blend mode" enum property for this plane. | |
705 | * Blend mode property represents the alpha blending equation selection, | |
706 | * describing how the pixels from the current plane are composited with | |
707 | * the background. | |
708 | */ | |
709 | struct drm_property *blend_mode_property; | |
80f690e9 JS |
710 | |
711 | /** | |
712 | * @color_encoding_property: | |
713 | * | |
714 | * Optional "COLOR_ENCODING" enum property for specifying | |
715 | * color encoding for non RGB formats. | |
716 | * See drm_plane_create_color_properties(). | |
717 | */ | |
718 | struct drm_property *color_encoding_property; | |
719 | /** | |
720 | * @color_range_property: | |
721 | * | |
722 | * Optional "COLOR_RANGE" enum property for specifying | |
723 | * color range for non RGB formats. | |
724 | * See drm_plane_create_color_properties(). | |
725 | */ | |
726 | struct drm_property *color_range_property; | |
43968d7b DV |
727 | }; |
728 | ||
729 | #define obj_to_plane(x) container_of(x, struct drm_plane, base) | |
730 | ||
e6fc3b68 | 731 | __printf(9, 10) |
43968d7b DV |
732 | int drm_universal_plane_init(struct drm_device *dev, |
733 | struct drm_plane *plane, | |
5cd57a46 | 734 | uint32_t possible_crtcs, |
43968d7b DV |
735 | const struct drm_plane_funcs *funcs, |
736 | const uint32_t *formats, | |
737 | unsigned int format_count, | |
e6fc3b68 | 738 | const uint64_t *format_modifiers, |
43968d7b DV |
739 | enum drm_plane_type type, |
740 | const char *name, ...); | |
91faa047 DV |
741 | int drm_plane_init(struct drm_device *dev, |
742 | struct drm_plane *plane, | |
743 | uint32_t possible_crtcs, | |
744 | const struct drm_plane_funcs *funcs, | |
745 | const uint32_t *formats, unsigned int format_count, | |
746 | bool is_primary); | |
747 | void drm_plane_cleanup(struct drm_plane *plane); | |
43968d7b DV |
748 | |
749 | /** | |
750 | * drm_plane_index - find the index of a registered plane | |
751 | * @plane: plane to find index for | |
752 | * | |
753 | * Given a registered plane, return the index of that plane within a DRM | |
754 | * device's list of planes. | |
755 | */ | |
62f77ad0 | 756 | static inline unsigned int drm_plane_index(const struct drm_plane *plane) |
43968d7b DV |
757 | { |
758 | return plane->index; | |
759 | } | |
62f77ad0 VS |
760 | |
761 | /** | |
762 | * drm_plane_mask - find the mask of a registered plane | |
763 | * @plane: plane to find mask for | |
764 | */ | |
765 | static inline u32 drm_plane_mask(const struct drm_plane *plane) | |
766 | { | |
767 | return 1 << drm_plane_index(plane); | |
768 | } | |
769 | ||
91faa047 DV |
770 | struct drm_plane * drm_plane_from_index(struct drm_device *dev, int idx); |
771 | void drm_plane_force_disable(struct drm_plane *plane); | |
43968d7b DV |
772 | |
773 | int drm_mode_plane_set_obj_prop(struct drm_plane *plane, | |
774 | struct drm_property *property, | |
775 | uint64_t value); | |
776 | ||
777 | /** | |
778 | * drm_plane_find - find a &drm_plane | |
779 | * @dev: DRM device | |
e7e62c7e | 780 | * @file_priv: drm file to check for lease against. |
43968d7b DV |
781 | * @id: plane id |
782 | * | |
783 | * Returns the plane with @id, NULL if it doesn't exist. Simple wrapper around | |
784 | * drm_mode_object_find(). | |
785 | */ | |
786 | static inline struct drm_plane *drm_plane_find(struct drm_device *dev, | |
418da172 | 787 | struct drm_file *file_priv, |
43968d7b DV |
788 | uint32_t id) |
789 | { | |
790 | struct drm_mode_object *mo; | |
418da172 | 791 | mo = drm_mode_object_find(dev, file_priv, id, DRM_MODE_OBJECT_PLANE); |
43968d7b DV |
792 | return mo ? obj_to_plane(mo) : NULL; |
793 | } | |
794 | ||
795 | /** | |
796 | * drm_for_each_plane_mask - iterate over planes specified by bitmask | |
797 | * @plane: the loop cursor | |
798 | * @dev: the DRM device | |
799 | * @plane_mask: bitmask of plane indices | |
800 | * | |
801 | * Iterate over all planes specified by bitmask. | |
802 | */ | |
803 | #define drm_for_each_plane_mask(plane, dev, plane_mask) \ | |
804 | list_for_each_entry((plane), &(dev)->mode_config.plane_list, head) \ | |
62f77ad0 | 805 | for_each_if ((plane_mask) & drm_plane_mask(plane)) |
43968d7b | 806 | |
532b3671 DV |
807 | /** |
808 | * drm_for_each_legacy_plane - iterate over all planes for legacy userspace | |
809 | * @plane: the loop cursor | |
810 | * @dev: the DRM device | |
811 | * | |
812 | * Iterate over all legacy planes of @dev, excluding primary and cursor planes. | |
813 | * This is useful for implementing userspace apis when userspace is not | |
d574528a | 814 | * universal plane aware. See also &enum drm_plane_type. |
532b3671 | 815 | */ |
43968d7b DV |
816 | #define drm_for_each_legacy_plane(plane, dev) \ |
817 | list_for_each_entry(plane, &(dev)->mode_config.plane_list, head) \ | |
818 | for_each_if (plane->type == DRM_PLANE_TYPE_OVERLAY) | |
819 | ||
532b3671 DV |
820 | /** |
821 | * drm_for_each_plane - iterate over all planes | |
822 | * @plane: the loop cursor | |
823 | * @dev: the DRM device | |
824 | * | |
825 | * Iterate over all planes of @dev, include primary and cursor planes. | |
826 | */ | |
43968d7b DV |
827 | #define drm_for_each_plane(plane, dev) \ |
828 | list_for_each_entry(plane, &(dev)->mode_config.plane_list, head) | |
829 | ||
e7afb623 VS |
830 | bool drm_any_plane_has_format(struct drm_device *dev, |
831 | u32 format, u64 modifier); | |
d3b21767 LS |
832 | /** |
833 | * drm_plane_get_damage_clips_count - Returns damage clips count. | |
834 | * @state: Plane state. | |
835 | * | |
836 | * Simple helper to get the number of &drm_mode_rect clips set by user-space | |
837 | * during plane update. | |
838 | * | |
839 | * Return: Number of clips in plane fb_damage_clips blob property. | |
840 | */ | |
841 | static inline unsigned int | |
842 | drm_plane_get_damage_clips_count(const struct drm_plane_state *state) | |
843 | { | |
844 | return (state && state->fb_damage_clips) ? | |
845 | state->fb_damage_clips->length/sizeof(struct drm_mode_rect) : 0; | |
846 | } | |
847 | ||
848 | /** | |
849 | * drm_plane_get_damage_clips - Returns damage clips. | |
850 | * @state: Plane state. | |
851 | * | |
d2780b1f DR |
852 | * Note that this function returns uapi type &drm_mode_rect. Drivers might |
853 | * instead be interested in internal &drm_rect which can be obtained by calling | |
854 | * drm_helper_get_plane_damage_clips(). | |
d3b21767 LS |
855 | * |
856 | * Return: Damage clips in plane fb_damage_clips blob property. | |
857 | */ | |
858 | static inline struct drm_mode_rect * | |
859 | drm_plane_get_damage_clips(const struct drm_plane_state *state) | |
860 | { | |
861 | return (struct drm_mode_rect *)((state && state->fb_damage_clips) ? | |
862 | state->fb_damage_clips->data : NULL); | |
863 | } | |
43968d7b DV |
864 | |
865 | #endif |