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 | ||
b88ac005 DV |
23 | #include <linux/slab.h> |
24 | #include <linux/uaccess.h> | |
25 | ||
43968d7b | 26 | #include <drm/drm_plane.h> |
b88ac005 DV |
27 | #include <drm/drm_drv.h> |
28 | #include <drm/drm_print.h> | |
29 | #include <drm/drm_framebuffer.h> | |
30 | #include <drm/drm_file.h> | |
31 | #include <drm/drm_crtc.h> | |
32 | #include <drm/drm_fourcc.h> | |
0a1b813f | 33 | #include <drm/drm_managed.h> |
b88ac005 | 34 | #include <drm/drm_vblank.h> |
43968d7b DV |
35 | |
36 | #include "drm_crtc_internal.h" | |
37 | ||
532b3671 DV |
38 | /** |
39 | * DOC: overview | |
40 | * | |
0ae865ef | 41 | * A plane represents an image source that can be blended with or overlaid on |
532b3671 DV |
42 | * top of a CRTC during the scanout process. Planes take their input data from a |
43 | * &drm_framebuffer object. The plane itself specifies the cropping and scaling | |
a3d0d834 | 44 | * of that image, and where it is placed on the visible area of a display |
532b3671 DV |
45 | * pipeline, represented by &drm_crtc. A plane can also have additional |
46 | * properties that specify how the pixels are positioned and blended, like | |
47 | * rotation or Z-position. All these properties are stored in &drm_plane_state. | |
48 | * | |
51342cc0 SP |
49 | * Unless explicitly specified (via CRTC property or otherwise), the active area |
50 | * of a CRTC will be black by default. This means portions of the active area | |
51 | * which are not covered by a plane will be black, and alpha blending of any | |
52 | * planes with the CRTC background will blend with black at the lowest zpos. | |
53 | * | |
532b3671 | 54 | * To create a plane, a KMS drivers allocates and zeroes an instances of |
ea0dd85a | 55 | * &struct drm_plane (possibly as part of a larger structure) and registers it |
532b3671 DV |
56 | * with a call to drm_universal_plane_init(). |
57 | * | |
97ecfff4 SS |
58 | * Each plane has a type, see enum drm_plane_type. A plane can be compatible |
59 | * with multiple CRTCs, see &drm_plane.possible_crtcs. | |
9999587b | 60 | * |
96962e3d SS |
61 | * Each CRTC must have a unique primary plane userspace can attach to enable |
62 | * the CRTC. In other words, userspace must be able to attach a different | |
63 | * primary plane to each CRTC at the same time. Primary planes can still be | |
64 | * compatible with multiple CRTCs. There must be exactly as many primary planes | |
65 | * as there are CRTCs. | |
66 | * | |
9999587b SS |
67 | * Legacy uAPI doesn't expose the primary and cursor planes directly. DRM core |
68 | * relies on the driver to set the primary and optionally the cursor plane used | |
69 | * for legacy IOCTLs. This is done by calling drm_crtc_init_with_planes(). All | |
2200736a | 70 | * drivers must provide one primary plane per CRTC to avoid surprising legacy |
9999587b | 71 | * userspace too much. |
532b3671 DV |
72 | */ |
73 | ||
77a71abb SS |
74 | /** |
75 | * DOC: standard plane properties | |
76 | * | |
77 | * DRM planes have a few standardized properties: | |
78 | * | |
97ecfff4 SS |
79 | * type: |
80 | * Immutable property describing the type of the plane. | |
81 | * | |
82 | * For user-space which has enabled the &DRM_CLIENT_CAP_ATOMIC capability, | |
83 | * the plane type is just a hint and is mostly superseded by atomic | |
84 | * test-only commits. The type hint can still be used to come up more | |
85 | * easily with a plane configuration accepted by the driver. | |
86 | * | |
87 | * The value of this property can be one of the following: | |
88 | * | |
89 | * "Primary": | |
90 | * To light up a CRTC, attaching a primary plane is the most likely to | |
91 | * work if it covers the whole CRTC and doesn't have scaling or | |
92 | * cropping set up. | |
93 | * | |
94 | * Drivers may support more features for the primary plane, user-space | |
95 | * can find out with test-only atomic commits. | |
96 | * | |
97 | * Some primary planes are implicitly used by the kernel in the legacy | |
98 | * IOCTLs &DRM_IOCTL_MODE_SETCRTC and &DRM_IOCTL_MODE_PAGE_FLIP. | |
99 | * Therefore user-space must not mix explicit usage of any primary | |
100 | * plane (e.g. through an atomic commit) with these legacy IOCTLs. | |
101 | * | |
102 | * "Cursor": | |
103 | * To enable this plane, using a framebuffer configured without scaling | |
104 | * or cropping and with the following properties is the most likely to | |
105 | * work: | |
106 | * | |
107 | * - If the driver provides the capabilities &DRM_CAP_CURSOR_WIDTH and | |
108 | * &DRM_CAP_CURSOR_HEIGHT, create the framebuffer with this size. | |
109 | * Otherwise, create a framebuffer with the size 64x64. | |
110 | * - If the driver doesn't support modifiers, create a framebuffer with | |
111 | * a linear layout. Otherwise, use the IN_FORMATS plane property. | |
112 | * | |
113 | * Drivers may support more features for the cursor plane, user-space | |
114 | * can find out with test-only atomic commits. | |
115 | * | |
116 | * Some cursor planes are implicitly used by the kernel in the legacy | |
117 | * IOCTLs &DRM_IOCTL_MODE_CURSOR and &DRM_IOCTL_MODE_CURSOR2. | |
118 | * Therefore user-space must not mix explicit usage of any cursor | |
119 | * plane (e.g. through an atomic commit) with these legacy IOCTLs. | |
120 | * | |
121 | * Some drivers may support cursors even if no cursor plane is exposed. | |
122 | * In this case, the legacy cursor IOCTLs can be used to configure the | |
123 | * cursor. | |
124 | * | |
125 | * "Overlay": | |
126 | * Neither primary nor cursor. | |
127 | * | |
128 | * Overlay planes are the only planes exposed when the | |
129 | * &DRM_CLIENT_CAP_UNIVERSAL_PLANES capability is disabled. | |
130 | * | |
77a71abb SS |
131 | * IN_FORMATS: |
132 | * Blob property which contains the set of buffer format and modifier | |
a7ecf003 SS |
133 | * pairs supported by this plane. The blob is a struct |
134 | * drm_format_modifier_blob. Without this property the plane doesn't | |
135 | * support buffers with modifiers. Userspace cannot change this property. | |
bfebd42d DV |
136 | * |
137 | * Note that userspace can check the &DRM_CAP_ADDFB2_MODIFIERS driver | |
138 | * capability for general modifier support. If this flag is set then every | |
139 | * plane will have the IN_FORMATS property, even when it only supports | |
140 | * DRM_FORMAT_MOD_LINEAR. Before linux kernel release v5.1 there have been | |
141 | * various bugs in this area with inconsistencies between the capability | |
142 | * flag and per-plane properties. | |
9677547d VS |
143 | * |
144 | * SIZE_HINTS: | |
145 | * Blob property which contains the set of recommended plane size | |
146 | * which can used for simple "cursor like" use cases (eg. no scaling). | |
147 | * Using these hints frees userspace from extensive probing of | |
148 | * supported plane sizes through atomic/setcursor ioctls. | |
149 | * | |
150 | * The blob contains an array of struct drm_plane_size_hint, in | |
151 | * order of preference. For optimal usage userspace should pick | |
152 | * the first size that satisfies its own requirements. | |
153 | * | |
154 | * Drivers should only attach this property to planes that | |
155 | * support a very limited set of sizes. | |
156 | * | |
157 | * Note that property value 0 (ie. no blob) is reserved for potential | |
158 | * future use. Current userspace is expected to ignore the property | |
159 | * if the value is 0, and fall back to some other means (eg. | |
160 | * &DRM_CAP_CURSOR_WIDTH and &DRM_CAP_CURSOR_HEIGHT) to determine | |
161 | * the appropriate plane size to use. | |
77a71abb SS |
162 | */ |
163 | ||
43968d7b DV |
164 | static unsigned int drm_num_planes(struct drm_device *dev) |
165 | { | |
166 | unsigned int num = 0; | |
167 | struct drm_plane *tmp; | |
168 | ||
169 | drm_for_each_plane(tmp, dev) { | |
170 | num++; | |
171 | } | |
172 | ||
173 | return num; | |
174 | } | |
175 | ||
db1689aa BW |
176 | static inline u32 * |
177 | formats_ptr(struct drm_format_modifier_blob *blob) | |
178 | { | |
179 | return (u32 *)(((char *)blob) + blob->formats_offset); | |
180 | } | |
181 | ||
182 | static inline struct drm_format_modifier * | |
183 | modifiers_ptr(struct drm_format_modifier_blob *blob) | |
184 | { | |
185 | return (struct drm_format_modifier *)(((char *)blob) + blob->modifiers_offset); | |
186 | } | |
187 | ||
188 | static int create_in_format_blob(struct drm_device *dev, struct drm_plane *plane) | |
189 | { | |
190 | const struct drm_mode_config *config = &dev->mode_config; | |
191 | struct drm_property_blob *blob; | |
192 | struct drm_format_modifier *mod; | |
193 | size_t blob_size, formats_size, modifiers_size; | |
194 | struct drm_format_modifier_blob *blob_data; | |
195 | unsigned int i, j; | |
196 | ||
197 | formats_size = sizeof(__u32) * plane->format_count; | |
198 | if (WARN_ON(!formats_size)) { | |
199 | /* 0 formats are never expected */ | |
200 | return 0; | |
201 | } | |
202 | ||
203 | modifiers_size = | |
204 | sizeof(struct drm_format_modifier) * plane->modifier_count; | |
205 | ||
206 | blob_size = sizeof(struct drm_format_modifier_blob); | |
207 | /* Modifiers offset is a pointer to a struct with a 64 bit field so it | |
208 | * should be naturally aligned to 8B. | |
209 | */ | |
210 | BUILD_BUG_ON(sizeof(struct drm_format_modifier_blob) % 8); | |
211 | blob_size += ALIGN(formats_size, 8); | |
212 | blob_size += modifiers_size; | |
213 | ||
214 | blob = drm_property_create_blob(dev, blob_size, NULL); | |
215 | if (IS_ERR(blob)) | |
216 | return -1; | |
217 | ||
11b83e3f | 218 | blob_data = blob->data; |
db1689aa BW |
219 | blob_data->version = FORMAT_BLOB_CURRENT; |
220 | blob_data->count_formats = plane->format_count; | |
221 | blob_data->formats_offset = sizeof(struct drm_format_modifier_blob); | |
222 | blob_data->count_modifiers = plane->modifier_count; | |
223 | ||
224 | blob_data->modifiers_offset = | |
225 | ALIGN(blob_data->formats_offset + formats_size, 8); | |
226 | ||
227 | memcpy(formats_ptr(blob_data), plane->format_types, formats_size); | |
228 | ||
db1689aa BW |
229 | mod = modifiers_ptr(blob_data); |
230 | for (i = 0; i < plane->modifier_count; i++) { | |
231 | for (j = 0; j < plane->format_count; j++) { | |
d14f0c20 JE |
232 | if (!plane->funcs->format_mod_supported || |
233 | plane->funcs->format_mod_supported(plane, | |
db1689aa BW |
234 | plane->format_types[j], |
235 | plane->modifiers[i])) { | |
aadd4148 | 236 | mod->formats |= 1ULL << j; |
db1689aa BW |
237 | } |
238 | } | |
239 | ||
240 | mod->modifier = plane->modifiers[i]; | |
241 | mod->offset = 0; | |
242 | mod->pad = 0; | |
243 | mod++; | |
244 | } | |
245 | ||
db1689aa BW |
246 | drm_object_attach_property(&plane->base, config->modifiers_property, |
247 | blob->base.id); | |
248 | ||
249 | return 0; | |
250 | } | |
251 | ||
4653f9d0 MB |
252 | /** |
253 | * DOC: hotspot properties | |
254 | * | |
255 | * HOTSPOT_X: property to set mouse hotspot x offset. | |
256 | * HOTSPOT_Y: property to set mouse hotspot y offset. | |
257 | * | |
258 | * When the plane is being used as a cursor image to display a mouse pointer, | |
259 | * the "hotspot" is the offset within the cursor image where mouse events | |
260 | * are expected to go. | |
261 | * | |
262 | * Positive values move the hotspot from the top-left corner of the cursor | |
263 | * plane towards the right and bottom. | |
264 | * | |
265 | * Most display drivers do not need this information because the | |
266 | * hotspot is not actually connected to anything visible on screen. | |
267 | * However, this is necessary for display drivers like the para-virtualized | |
268 | * drivers (eg qxl, vbox, virtio, vmwgfx), that are attached to a user console | |
269 | * with a mouse pointer. Since these consoles are often being remoted over a | |
270 | * network, they would otherwise have to wait to display the pointer movement to | |
271 | * the user until a full network round-trip has occurred. New mouse events have | |
272 | * to be sent from the user's console, over the network to the virtual input | |
273 | * devices, forwarded to the desktop for processing, and then the cursor plane's | |
274 | * position can be updated and sent back to the user's console over the network. | |
275 | * Instead, with the hotspot information, the console can anticipate the new | |
276 | * location, and draw the mouse cursor there before the confirmation comes in. | |
277 | * To do that correctly, the user's console must be able predict how the | |
278 | * desktop will process mouse events, which normally requires the desktop's | |
279 | * mouse topology information, ie where each CRTC sits in the mouse coordinate | |
280 | * space. This is typically sent to the para-virtualized drivers using some | |
281 | * driver-specific method, and the driver then forwards it to the console by | |
282 | * way of the virtual display device or hypervisor. | |
283 | * | |
284 | * The assumption is generally made that there is only one cursor plane being | |
285 | * used this way at a time, and that the desktop is feeding all mouse devices | |
286 | * into the same global pointer. Para-virtualized drivers that require this | |
287 | * should only be exposing a single cursor plane, or find some other way | |
288 | * to coordinate with a userspace desktop that supports multiple pointers. | |
289 | * If the hotspot properties are set, the cursor plane is therefore assumed to be | |
290 | * used only for displaying a mouse cursor image, and the position of the combined | |
291 | * cursor plane + offset can therefore be used for coordinating with input from a | |
292 | * mouse device. | |
293 | * | |
294 | * The cursor will then be drawn either at the location of the plane in the CRTC | |
295 | * console, or as a free-floating cursor plane on the user's console | |
296 | * corresponding to their desktop mouse position. | |
297 | * | |
298 | * DRM clients which would like to work correctly on drivers which expose | |
299 | * hotspot properties should advertise DRM_CLIENT_CAP_CURSOR_PLANE_HOTSPOT. | |
300 | * Setting this property on drivers which do not special case | |
301 | * cursor planes will return EOPNOTSUPP, which can be used by userspace to | |
302 | * gauge requirements of the hardware/drivers they're running on. Advertising | |
303 | * DRM_CLIENT_CAP_CURSOR_PLANE_HOTSPOT implies that the userspace client will be | |
304 | * correctly setting the hotspot properties. | |
305 | */ | |
306 | ||
8f7179a1 ZR |
307 | /** |
308 | * drm_plane_create_hotspot_properties - creates the mouse hotspot | |
309 | * properties and attaches them to the given cursor plane | |
310 | * | |
311 | * @plane: drm cursor plane | |
312 | * | |
313 | * This function enables the mouse hotspot property on a given | |
4653f9d0 MB |
314 | * cursor plane. Look at the documentation for hotspot properties |
315 | * to get a better understanding for what they're used for. | |
8f7179a1 ZR |
316 | * |
317 | * RETURNS: | |
318 | * Zero for success or -errno | |
319 | */ | |
320 | static int drm_plane_create_hotspot_properties(struct drm_plane *plane) | |
321 | { | |
322 | struct drm_property *prop_x; | |
323 | struct drm_property *prop_y; | |
324 | ||
325 | drm_WARN_ON(plane->dev, | |
326 | !drm_core_check_feature(plane->dev, | |
327 | DRIVER_CURSOR_HOTSPOT)); | |
328 | ||
329 | prop_x = drm_property_create_signed_range(plane->dev, 0, "HOTSPOT_X", | |
330 | INT_MIN, INT_MAX); | |
331 | if (IS_ERR(prop_x)) | |
332 | return PTR_ERR(prop_x); | |
333 | ||
334 | prop_y = drm_property_create_signed_range(plane->dev, 0, "HOTSPOT_Y", | |
335 | INT_MIN, INT_MAX); | |
336 | if (IS_ERR(prop_y)) { | |
337 | drm_property_destroy(plane->dev, prop_x); | |
338 | return PTR_ERR(prop_y); | |
339 | } | |
340 | ||
341 | drm_object_attach_property(&plane->base, prop_x, 0); | |
342 | drm_object_attach_property(&plane->base, prop_y, 0); | |
343 | plane->hotspot_x_property = prop_x; | |
344 | plane->hotspot_y_property = prop_y; | |
345 | ||
346 | return 0; | |
347 | } | |
348 | ||
0a1b813f PZ |
349 | __printf(9, 0) |
350 | static int __drm_universal_plane_init(struct drm_device *dev, | |
351 | struct drm_plane *plane, | |
352 | uint32_t possible_crtcs, | |
353 | const struct drm_plane_funcs *funcs, | |
354 | const uint32_t *formats, | |
355 | unsigned int format_count, | |
356 | const uint64_t *format_modifiers, | |
357 | enum drm_plane_type type, | |
358 | const char *name, va_list ap) | |
43968d7b DV |
359 | { |
360 | struct drm_mode_config *config = &dev->mode_config; | |
8be57683 TE |
361 | static const uint64_t default_modifiers[] = { |
362 | DRM_FORMAT_MOD_LINEAR, | |
363 | }; | |
e6fc3b68 | 364 | unsigned int format_modifier_count = 0; |
43968d7b DV |
365 | int ret; |
366 | ||
2a8d3eac VS |
367 | /* plane index is used with 32bit bitmasks */ |
368 | if (WARN_ON(config->num_total_plane >= 32)) | |
369 | return -EINVAL; | |
370 | ||
4b674dd6 SP |
371 | /* |
372 | * First driver to need more than 64 formats needs to fix this. Each | |
373 | * format is encoded as a bit and the current code only supports a u64. | |
374 | */ | |
375 | if (WARN_ON(format_count > 64)) | |
376 | return -EINVAL; | |
377 | ||
ba1f665f HM |
378 | WARN_ON(drm_drv_uses_atomic_modeset(dev) && |
379 | (!funcs->atomic_destroy_state || | |
380 | !funcs->atomic_duplicate_state)); | |
381 | ||
2135ea7a | 382 | ret = drm_mode_object_add(dev, &plane->base, DRM_MODE_OBJECT_PLANE); |
43968d7b DV |
383 | if (ret) |
384 | return ret; | |
385 | ||
386 | drm_modeset_lock_init(&plane->mutex); | |
387 | ||
388 | plane->base.properties = &plane->properties; | |
389 | plane->dev = dev; | |
390 | plane->funcs = funcs; | |
391 | plane->format_types = kmalloc_array(format_count, sizeof(uint32_t), | |
392 | GFP_KERNEL); | |
393 | if (!plane->format_types) { | |
394 | DRM_DEBUG_KMS("out of memory when allocating plane\n"); | |
395 | drm_mode_object_unregister(dev, &plane->base); | |
396 | return -ENOMEM; | |
397 | } | |
398 | ||
e6fc3b68 BW |
399 | if (format_modifiers) { |
400 | const uint64_t *temp_modifiers = format_modifiers; | |
948de842 | 401 | |
e6fc3b68 BW |
402 | while (*temp_modifiers++ != DRM_FORMAT_MOD_INVALID) |
403 | format_modifier_count++; | |
8be57683 TE |
404 | } else { |
405 | if (!dev->mode_config.fb_modifiers_not_supported) { | |
406 | format_modifiers = default_modifiers; | |
407 | format_modifier_count = ARRAY_SIZE(default_modifiers); | |
408 | } | |
e6fc3b68 BW |
409 | } |
410 | ||
bfebd42d | 411 | /* autoset the cap and check for consistency across all planes */ |
8be57683 TE |
412 | drm_WARN_ON(dev, config->fb_modifiers_not_supported && |
413 | format_modifier_count); | |
890880dd | 414 | |
e6fc3b68 BW |
415 | plane->modifier_count = format_modifier_count; |
416 | plane->modifiers = kmalloc_array(format_modifier_count, | |
417 | sizeof(format_modifiers[0]), | |
418 | GFP_KERNEL); | |
419 | ||
420 | if (format_modifier_count && !plane->modifiers) { | |
421 | DRM_DEBUG_KMS("out of memory when allocating plane\n"); | |
422 | kfree(plane->format_types); | |
423 | drm_mode_object_unregister(dev, &plane->base); | |
424 | return -ENOMEM; | |
425 | } | |
426 | ||
43968d7b | 427 | if (name) { |
43968d7b | 428 | plane->name = kvasprintf(GFP_KERNEL, name, ap); |
43968d7b DV |
429 | } else { |
430 | plane->name = kasprintf(GFP_KERNEL, "plane-%d", | |
431 | drm_num_planes(dev)); | |
432 | } | |
433 | if (!plane->name) { | |
434 | kfree(plane->format_types); | |
e6fc3b68 | 435 | kfree(plane->modifiers); |
43968d7b DV |
436 | drm_mode_object_unregister(dev, &plane->base); |
437 | return -ENOMEM; | |
438 | } | |
439 | ||
440 | memcpy(plane->format_types, formats, format_count * sizeof(uint32_t)); | |
441 | plane->format_count = format_count; | |
e6fc3b68 BW |
442 | memcpy(plane->modifiers, format_modifiers, |
443 | format_modifier_count * sizeof(format_modifiers[0])); | |
43968d7b DV |
444 | plane->possible_crtcs = possible_crtcs; |
445 | plane->type = type; | |
446 | ||
447 | list_add_tail(&plane->head, &config->plane_list); | |
448 | plane->index = config->num_total_plane++; | |
43968d7b DV |
449 | |
450 | drm_object_attach_property(&plane->base, | |
451 | config->plane_type_property, | |
452 | plane->type); | |
453 | ||
454 | if (drm_core_check_feature(dev, DRIVER_ATOMIC)) { | |
455 | drm_object_attach_property(&plane->base, config->prop_fb_id, 0); | |
96260142 | 456 | drm_object_attach_property(&plane->base, config->prop_in_fence_fd, -1); |
43968d7b DV |
457 | drm_object_attach_property(&plane->base, config->prop_crtc_id, 0); |
458 | drm_object_attach_property(&plane->base, config->prop_crtc_x, 0); | |
459 | drm_object_attach_property(&plane->base, config->prop_crtc_y, 0); | |
460 | drm_object_attach_property(&plane->base, config->prop_crtc_w, 0); | |
461 | drm_object_attach_property(&plane->base, config->prop_crtc_h, 0); | |
462 | drm_object_attach_property(&plane->base, config->prop_src_x, 0); | |
463 | drm_object_attach_property(&plane->base, config->prop_src_y, 0); | |
464 | drm_object_attach_property(&plane->base, config->prop_src_w, 0); | |
465 | drm_object_attach_property(&plane->base, config->prop_src_h, 0); | |
466 | } | |
8f7179a1 ZR |
467 | if (drm_core_check_feature(dev, DRIVER_CURSOR_HOTSPOT) && |
468 | type == DRM_PLANE_TYPE_CURSOR) { | |
469 | drm_plane_create_hotspot_properties(plane); | |
470 | } | |
43968d7b | 471 | |
8be57683 | 472 | if (format_modifier_count) |
db1689aa BW |
473 | create_in_format_blob(dev, plane); |
474 | ||
43968d7b DV |
475 | return 0; |
476 | } | |
0a1b813f PZ |
477 | |
478 | /** | |
479 | * drm_universal_plane_init - Initialize a new universal plane object | |
480 | * @dev: DRM device | |
481 | * @plane: plane object to init | |
482 | * @possible_crtcs: bitmask of possible CRTCs | |
483 | * @funcs: callbacks for the new plane | |
484 | * @formats: array of supported formats (DRM_FORMAT\_\*) | |
485 | * @format_count: number of elements in @formats | |
486 | * @format_modifiers: array of struct drm_format modifiers terminated by | |
487 | * DRM_FORMAT_MOD_INVALID | |
488 | * @type: type of plane (overlay, primary, cursor) | |
489 | * @name: printf style format string for the plane name, or NULL for default name | |
490 | * | |
491 | * Initializes a plane object of type @type. The &drm_plane_funcs.destroy hook | |
492 | * should call drm_plane_cleanup() and kfree() the plane structure. The plane | |
493 | * structure should not be allocated with devm_kzalloc(). | |
494 | * | |
495 | * Note: consider using drmm_universal_plane_alloc() instead of | |
496 | * drm_universal_plane_init() to let the DRM managed resource infrastructure | |
497 | * take care of cleanup and deallocation. | |
498 | * | |
8be57683 TE |
499 | * Drivers that only support the DRM_FORMAT_MOD_LINEAR modifier support may set |
500 | * @format_modifiers to NULL. The plane will advertise the linear modifier. | |
bfebd42d | 501 | * |
0a1b813f PZ |
502 | * Returns: |
503 | * Zero on success, error code on failure. | |
504 | */ | |
505 | int drm_universal_plane_init(struct drm_device *dev, struct drm_plane *plane, | |
506 | uint32_t possible_crtcs, | |
507 | const struct drm_plane_funcs *funcs, | |
508 | const uint32_t *formats, unsigned int format_count, | |
509 | const uint64_t *format_modifiers, | |
510 | enum drm_plane_type type, | |
511 | const char *name, ...) | |
512 | { | |
513 | va_list ap; | |
514 | int ret; | |
515 | ||
516 | WARN_ON(!funcs->destroy); | |
517 | ||
518 | va_start(ap, name); | |
519 | ret = __drm_universal_plane_init(dev, plane, possible_crtcs, funcs, | |
520 | formats, format_count, format_modifiers, | |
521 | type, name, ap); | |
522 | va_end(ap); | |
523 | return ret; | |
524 | } | |
43968d7b DV |
525 | EXPORT_SYMBOL(drm_universal_plane_init); |
526 | ||
0a1b813f PZ |
527 | static void drmm_universal_plane_alloc_release(struct drm_device *dev, void *ptr) |
528 | { | |
529 | struct drm_plane *plane = ptr; | |
530 | ||
531 | if (WARN_ON(!plane->dev)) | |
532 | return; | |
533 | ||
534 | drm_plane_cleanup(plane); | |
535 | } | |
536 | ||
537 | void *__drmm_universal_plane_alloc(struct drm_device *dev, size_t size, | |
538 | size_t offset, uint32_t possible_crtcs, | |
539 | const struct drm_plane_funcs *funcs, | |
540 | const uint32_t *formats, unsigned int format_count, | |
541 | const uint64_t *format_modifiers, | |
542 | enum drm_plane_type type, | |
543 | const char *name, ...) | |
544 | { | |
545 | void *container; | |
546 | struct drm_plane *plane; | |
547 | va_list ap; | |
548 | int ret; | |
549 | ||
550 | if (WARN_ON(!funcs || funcs->destroy)) | |
551 | return ERR_PTR(-EINVAL); | |
552 | ||
553 | container = drmm_kzalloc(dev, size, GFP_KERNEL); | |
554 | if (!container) | |
555 | return ERR_PTR(-ENOMEM); | |
556 | ||
557 | plane = container + offset; | |
558 | ||
559 | va_start(ap, name); | |
560 | ret = __drm_universal_plane_init(dev, plane, possible_crtcs, funcs, | |
561 | formats, format_count, format_modifiers, | |
562 | type, name, ap); | |
563 | va_end(ap); | |
564 | if (ret) | |
565 | return ERR_PTR(ret); | |
566 | ||
567 | ret = drmm_add_action_or_reset(dev, drmm_universal_plane_alloc_release, | |
568 | plane); | |
569 | if (ret) | |
570 | return ERR_PTR(ret); | |
571 | ||
572 | return container; | |
573 | } | |
574 | EXPORT_SYMBOL(__drmm_universal_plane_alloc); | |
e71def05 TZ |
575 | |
576 | void *__drm_universal_plane_alloc(struct drm_device *dev, size_t size, | |
577 | size_t offset, uint32_t possible_crtcs, | |
578 | const struct drm_plane_funcs *funcs, | |
579 | const uint32_t *formats, unsigned int format_count, | |
580 | const uint64_t *format_modifiers, | |
581 | enum drm_plane_type type, | |
582 | const char *name, ...) | |
583 | { | |
584 | void *container; | |
585 | struct drm_plane *plane; | |
586 | va_list ap; | |
587 | int ret; | |
588 | ||
589 | if (drm_WARN_ON(dev, !funcs)) | |
590 | return ERR_PTR(-EINVAL); | |
591 | ||
592 | container = kzalloc(size, GFP_KERNEL); | |
593 | if (!container) | |
594 | return ERR_PTR(-ENOMEM); | |
595 | ||
596 | plane = container + offset; | |
597 | ||
598 | va_start(ap, name); | |
599 | ret = __drm_universal_plane_init(dev, plane, possible_crtcs, funcs, | |
600 | formats, format_count, format_modifiers, | |
601 | type, name, ap); | |
602 | va_end(ap); | |
603 | if (ret) | |
604 | goto err_kfree; | |
605 | ||
606 | return container; | |
607 | ||
608 | err_kfree: | |
609 | kfree(container); | |
610 | return ERR_PTR(ret); | |
611 | } | |
612 | EXPORT_SYMBOL(__drm_universal_plane_alloc); | |
0a1b813f | 613 | |
43968d7b DV |
614 | int drm_plane_register_all(struct drm_device *dev) |
615 | { | |
4dc55525 LP |
616 | unsigned int num_planes = 0; |
617 | unsigned int num_zpos = 0; | |
43968d7b DV |
618 | struct drm_plane *plane; |
619 | int ret = 0; | |
620 | ||
621 | drm_for_each_plane(plane, dev) { | |
622 | if (plane->funcs->late_register) | |
623 | ret = plane->funcs->late_register(plane); | |
624 | if (ret) | |
625 | return ret; | |
4dc55525 LP |
626 | |
627 | if (plane->zpos_property) | |
628 | num_zpos++; | |
629 | num_planes++; | |
43968d7b DV |
630 | } |
631 | ||
4dc55525 LP |
632 | drm_WARN(dev, num_zpos && num_planes != num_zpos, |
633 | "Mixing planes with and without zpos property is invalid\n"); | |
634 | ||
43968d7b DV |
635 | return 0; |
636 | } | |
637 | ||
638 | void drm_plane_unregister_all(struct drm_device *dev) | |
639 | { | |
640 | struct drm_plane *plane; | |
641 | ||
642 | drm_for_each_plane(plane, dev) { | |
643 | if (plane->funcs->early_unregister) | |
644 | plane->funcs->early_unregister(plane); | |
645 | } | |
646 | } | |
647 | ||
43968d7b DV |
648 | /** |
649 | * drm_plane_cleanup - Clean up the core plane usage | |
650 | * @plane: plane to cleanup | |
651 | * | |
652 | * This function cleans up @plane and removes it from the DRM mode setting | |
653 | * core. Note that the function does *not* free the plane structure itself, | |
654 | * this is the responsibility of the caller. | |
655 | */ | |
656 | void drm_plane_cleanup(struct drm_plane *plane) | |
657 | { | |
658 | struct drm_device *dev = plane->dev; | |
659 | ||
661a3755 DV |
660 | drm_modeset_lock_fini(&plane->mutex); |
661 | ||
43968d7b | 662 | kfree(plane->format_types); |
e6fc3b68 | 663 | kfree(plane->modifiers); |
43968d7b DV |
664 | drm_mode_object_unregister(dev, &plane->base); |
665 | ||
666 | BUG_ON(list_empty(&plane->head)); | |
667 | ||
668 | /* Note that the plane_list is considered to be static; should we | |
669 | * remove the drm_plane at runtime we would have to decrement all | |
670 | * the indices on the drm_plane after us in the plane_list. | |
671 | */ | |
672 | ||
673 | list_del(&plane->head); | |
674 | dev->mode_config.num_total_plane--; | |
43968d7b DV |
675 | |
676 | WARN_ON(plane->state && !plane->funcs->atomic_destroy_state); | |
677 | if (plane->state && plane->funcs->atomic_destroy_state) | |
678 | plane->funcs->atomic_destroy_state(plane, plane->state); | |
679 | ||
680 | kfree(plane->name); | |
681 | ||
682 | memset(plane, 0, sizeof(*plane)); | |
683 | } | |
684 | EXPORT_SYMBOL(drm_plane_cleanup); | |
685 | ||
686 | /** | |
687 | * drm_plane_from_index - find the registered plane at an index | |
688 | * @dev: DRM device | |
689 | * @idx: index of registered plane to find for | |
690 | * | |
691 | * Given a plane index, return the registered plane from DRM device's | |
931c670d | 692 | * list of planes with matching index. This is the inverse of drm_plane_index(). |
43968d7b DV |
693 | */ |
694 | struct drm_plane * | |
695 | drm_plane_from_index(struct drm_device *dev, int idx) | |
696 | { | |
697 | struct drm_plane *plane; | |
698 | ||
699 | drm_for_each_plane(plane, dev) | |
700 | if (idx == plane->index) | |
701 | return plane; | |
702 | ||
703 | return NULL; | |
704 | } | |
705 | EXPORT_SYMBOL(drm_plane_from_index); | |
706 | ||
707 | /** | |
708 | * drm_plane_force_disable - Forcibly disable a plane | |
709 | * @plane: plane to disable | |
710 | * | |
711 | * Forces the plane to be disabled. | |
712 | * | |
713 | * Used when the plane's current framebuffer is destroyed, | |
714 | * and when restoring fbdev mode. | |
5fbef3ee DV |
715 | * |
716 | * Note that this function is not suitable for atomic drivers, since it doesn't | |
717 | * wire through the lock acquisition context properly and hence can't handle | |
718 | * retries or driver private locks. You probably want to use | |
719 | * drm_atomic_helper_disable_plane() or | |
720 | * drm_atomic_helper_disable_planes_on_crtc() instead. | |
43968d7b DV |
721 | */ |
722 | void drm_plane_force_disable(struct drm_plane *plane) | |
723 | { | |
724 | int ret; | |
725 | ||
726 | if (!plane->fb) | |
727 | return; | |
728 | ||
5fbef3ee DV |
729 | WARN_ON(drm_drv_uses_atomic_modeset(plane->dev)); |
730 | ||
43968d7b | 731 | plane->old_fb = plane->fb; |
19315294 | 732 | ret = plane->funcs->disable_plane(plane, NULL); |
43968d7b DV |
733 | if (ret) { |
734 | DRM_ERROR("failed to disable plane with busy fb\n"); | |
735 | plane->old_fb = NULL; | |
736 | return; | |
737 | } | |
738 | /* disconnect the plane from the fb and crtc: */ | |
a4a69da0 | 739 | drm_framebuffer_put(plane->old_fb); |
43968d7b DV |
740 | plane->old_fb = NULL; |
741 | plane->fb = NULL; | |
742 | plane->crtc = NULL; | |
743 | } | |
744 | EXPORT_SYMBOL(drm_plane_force_disable); | |
745 | ||
746 | /** | |
747 | * drm_mode_plane_set_obj_prop - set the value of a property | |
748 | * @plane: drm plane object to set property value for | |
749 | * @property: property to set | |
750 | * @value: value the property should be set to | |
751 | * | |
752 | * This functions sets a given property on a given plane object. This function | |
753 | * calls the driver's ->set_property callback and changes the software state of | |
754 | * the property if the callback succeeds. | |
755 | * | |
756 | * Returns: | |
757 | * Zero on success, error code on failure. | |
758 | */ | |
759 | int drm_mode_plane_set_obj_prop(struct drm_plane *plane, | |
760 | struct drm_property *property, | |
761 | uint64_t value) | |
762 | { | |
763 | int ret = -EINVAL; | |
764 | struct drm_mode_object *obj = &plane->base; | |
765 | ||
766 | if (plane->funcs->set_property) | |
767 | ret = plane->funcs->set_property(plane, property, value); | |
768 | if (!ret) | |
769 | drm_object_property_set_value(obj, property, value); | |
770 | ||
771 | return ret; | |
772 | } | |
773 | EXPORT_SYMBOL(drm_mode_plane_set_obj_prop); | |
774 | ||
43968d7b DV |
775 | int drm_mode_getplane_res(struct drm_device *dev, void *data, |
776 | struct drm_file *file_priv) | |
777 | { | |
778 | struct drm_mode_get_plane_res *plane_resp = data; | |
43968d7b DV |
779 | struct drm_plane *plane; |
780 | uint32_t __user *plane_ptr; | |
40d86701 | 781 | int count = 0; |
43968d7b DV |
782 | |
783 | if (!drm_core_check_feature(dev, DRIVER_MODESET)) | |
69fdf420 | 784 | return -EOPNOTSUPP; |
43968d7b | 785 | |
40d86701 | 786 | plane_ptr = u64_to_user_ptr(plane_resp->plane_id_ptr); |
43968d7b DV |
787 | |
788 | /* | |
789 | * This ioctl is called twice, once to determine how much space is | |
790 | * needed, and the 2nd time to fill it. | |
791 | */ | |
40d86701 DA |
792 | drm_for_each_plane(plane, dev) { |
793 | /* | |
794 | * Unless userspace set the 'universal planes' | |
795 | * capability bit, only advertise overlays. | |
796 | */ | |
797 | if (plane->type != DRM_PLANE_TYPE_OVERLAY && | |
798 | !file_priv->universal_planes) | |
799 | continue; | |
800 | ||
4e3b70da ZR |
801 | /* |
802 | * If we're running on a virtualized driver then, | |
803 | * unless userspace advertizes support for the | |
804 | * virtualized cursor plane, disable cursor planes | |
805 | * because they'll be broken due to missing cursor | |
806 | * hotspot info. | |
807 | */ | |
808 | if (plane->type == DRM_PLANE_TYPE_CURSOR && | |
809 | drm_core_check_feature(dev, DRIVER_CURSOR_HOTSPOT) && | |
810 | file_priv->atomic && | |
811 | !file_priv->supports_virtualized_cursor_plane) | |
812 | continue; | |
813 | ||
7de440db KP |
814 | if (drm_lease_held(file_priv, plane->base.id)) { |
815 | if (count < plane_resp->count_planes && | |
816 | put_user(plane->base.id, plane_ptr + count)) | |
817 | return -EFAULT; | |
818 | count++; | |
819 | } | |
43968d7b | 820 | } |
40d86701 | 821 | plane_resp->count_planes = count; |
43968d7b DV |
822 | |
823 | return 0; | |
824 | } | |
825 | ||
43968d7b DV |
826 | int drm_mode_getplane(struct drm_device *dev, void *data, |
827 | struct drm_file *file_priv) | |
828 | { | |
829 | struct drm_mode_get_plane *plane_resp = data; | |
830 | struct drm_plane *plane; | |
831 | uint32_t __user *format_ptr; | |
832 | ||
833 | if (!drm_core_check_feature(dev, DRIVER_MODESET)) | |
69fdf420 | 834 | return -EOPNOTSUPP; |
43968d7b | 835 | |
418da172 | 836 | plane = drm_plane_find(dev, file_priv, plane_resp->plane_id); |
43968d7b DV |
837 | if (!plane) |
838 | return -ENOENT; | |
839 | ||
840 | drm_modeset_lock(&plane->mutex, NULL); | |
7de440db | 841 | if (plane->state && plane->state->crtc && drm_lease_held(file_priv, plane->state->crtc->base.id)) |
de7b6be7 | 842 | plane_resp->crtc_id = plane->state->crtc->base.id; |
7de440db | 843 | else if (!plane->state && plane->crtc && drm_lease_held(file_priv, plane->crtc->base.id)) |
43968d7b DV |
844 | plane_resp->crtc_id = plane->crtc->base.id; |
845 | else | |
846 | plane_resp->crtc_id = 0; | |
847 | ||
de7b6be7 DS |
848 | if (plane->state && plane->state->fb) |
849 | plane_resp->fb_id = plane->state->fb->base.id; | |
850 | else if (!plane->state && plane->fb) | |
43968d7b DV |
851 | plane_resp->fb_id = plane->fb->base.id; |
852 | else | |
853 | plane_resp->fb_id = 0; | |
854 | drm_modeset_unlock(&plane->mutex); | |
855 | ||
856 | plane_resp->plane_id = plane->base.id; | |
7de440db KP |
857 | plane_resp->possible_crtcs = drm_lease_filter_crtcs(file_priv, |
858 | plane->possible_crtcs); | |
859 | ||
43968d7b DV |
860 | plane_resp->gamma_size = 0; |
861 | ||
862 | /* | |
863 | * This ioctl is called twice, once to determine how much space is | |
864 | * needed, and the 2nd time to fill it. | |
865 | */ | |
866 | if (plane->format_count && | |
867 | (plane_resp->count_format_types >= plane->format_count)) { | |
868 | format_ptr = (uint32_t __user *)(unsigned long)plane_resp->format_type_ptr; | |
869 | if (copy_to_user(format_ptr, | |
870 | plane->format_types, | |
871 | sizeof(uint32_t) * plane->format_count)) { | |
872 | return -EFAULT; | |
873 | } | |
874 | } | |
875 | plane_resp->count_format_types = plane->format_count; | |
876 | ||
877 | return 0; | |
878 | } | |
879 | ||
23163a7d VS |
880 | int drm_plane_check_pixel_format(struct drm_plane *plane, |
881 | u32 format, u64 modifier) | |
43968d7b DV |
882 | { |
883 | unsigned int i; | |
884 | ||
885 | for (i = 0; i < plane->format_count; i++) { | |
886 | if (format == plane->format_types[i]) | |
23163a7d | 887 | break; |
43968d7b | 888 | } |
23163a7d VS |
889 | if (i == plane->format_count) |
890 | return -EINVAL; | |
891 | ||
8fb756df EA |
892 | if (plane->funcs->format_mod_supported) { |
893 | if (!plane->funcs->format_mod_supported(plane, format, modifier)) | |
894 | return -EINVAL; | |
895 | } else { | |
896 | if (!plane->modifier_count) | |
897 | return 0; | |
23163a7d | 898 | |
8fb756df EA |
899 | for (i = 0; i < plane->modifier_count; i++) { |
900 | if (modifier == plane->modifiers[i]) | |
901 | break; | |
902 | } | |
903 | if (i == plane->modifier_count) | |
904 | return -EINVAL; | |
23163a7d | 905 | } |
23163a7d VS |
906 | |
907 | return 0; | |
43968d7b DV |
908 | } |
909 | ||
4dd4677c VS |
910 | static int __setplane_check(struct drm_plane *plane, |
911 | struct drm_crtc *crtc, | |
912 | struct drm_framebuffer *fb, | |
913 | int32_t crtc_x, int32_t crtc_y, | |
914 | uint32_t crtc_w, uint32_t crtc_h, | |
915 | uint32_t src_x, uint32_t src_y, | |
916 | uint32_t src_w, uint32_t src_h) | |
917 | { | |
918 | int ret; | |
919 | ||
920 | /* Check whether this plane is usable on this CRTC */ | |
921 | if (!(plane->possible_crtcs & drm_crtc_mask(crtc))) { | |
922 | DRM_DEBUG_KMS("Invalid crtc for plane\n"); | |
923 | return -EINVAL; | |
924 | } | |
925 | ||
926 | /* Check whether this plane supports the fb pixel format. */ | |
927 | ret = drm_plane_check_pixel_format(plane, fb->format->format, | |
928 | fb->modifier); | |
929 | if (ret) { | |
92f1d09c SA |
930 | DRM_DEBUG_KMS("Invalid pixel format %p4cc, modifier 0x%llx\n", |
931 | &fb->format->format, fb->modifier); | |
4dd4677c VS |
932 | return ret; |
933 | } | |
934 | ||
935 | /* Give drivers some help against integer overflows */ | |
936 | if (crtc_w > INT_MAX || | |
937 | crtc_x > INT_MAX - (int32_t) crtc_w || | |
938 | crtc_h > INT_MAX || | |
939 | crtc_y > INT_MAX - (int32_t) crtc_h) { | |
940 | DRM_DEBUG_KMS("Invalid CRTC coordinates %ux%u+%d+%d\n", | |
941 | crtc_w, crtc_h, crtc_x, crtc_y); | |
942 | return -ERANGE; | |
943 | } | |
944 | ||
945 | ret = drm_framebuffer_check_src_coords(src_x, src_y, src_w, src_h, fb); | |
946 | if (ret) | |
947 | return ret; | |
948 | ||
949 | return 0; | |
950 | } | |
951 | ||
e7afb623 VS |
952 | /** |
953 | * drm_any_plane_has_format - Check whether any plane supports this format and modifier combination | |
954 | * @dev: DRM device | |
955 | * @format: pixel format (DRM_FORMAT_*) | |
956 | * @modifier: data layout modifier | |
957 | * | |
958 | * Returns: | |
959 | * Whether at least one plane supports the specified format and modifier combination. | |
960 | */ | |
961 | bool drm_any_plane_has_format(struct drm_device *dev, | |
962 | u32 format, u64 modifier) | |
963 | { | |
964 | struct drm_plane *plane; | |
965 | ||
966 | drm_for_each_plane(plane, dev) { | |
967 | if (drm_plane_check_pixel_format(plane, format, modifier) == 0) | |
968 | return true; | |
969 | } | |
970 | ||
971 | return false; | |
972 | } | |
973 | EXPORT_SYMBOL(drm_any_plane_has_format); | |
974 | ||
43968d7b | 975 | /* |
ce0769e0 | 976 | * __setplane_internal - setplane handler for internal callers |
43968d7b | 977 | * |
ce0769e0 ML |
978 | * This function will take a reference on the new fb for the plane |
979 | * on success. | |
43968d7b DV |
980 | * |
981 | * src_{x,y,w,h} are provided in 16.16 fixed point format | |
982 | */ | |
983 | static int __setplane_internal(struct drm_plane *plane, | |
984 | struct drm_crtc *crtc, | |
985 | struct drm_framebuffer *fb, | |
986 | int32_t crtc_x, int32_t crtc_y, | |
987 | uint32_t crtc_w, uint32_t crtc_h, | |
988 | /* src_{x,y,w,h} values are 16.16 fixed point */ | |
989 | uint32_t src_x, uint32_t src_y, | |
232e8f70 DV |
990 | uint32_t src_w, uint32_t src_h, |
991 | struct drm_modeset_acquire_ctx *ctx) | |
43968d7b DV |
992 | { |
993 | int ret = 0; | |
994 | ||
e7695eb6 VS |
995 | WARN_ON(drm_drv_uses_atomic_modeset(plane->dev)); |
996 | ||
90422201 DB |
997 | /* No fb means shut it down */ |
998 | if (!fb) { | |
43968d7b | 999 | plane->old_fb = plane->fb; |
19315294 | 1000 | ret = plane->funcs->disable_plane(plane, ctx); |
43968d7b DV |
1001 | if (!ret) { |
1002 | plane->crtc = NULL; | |
1003 | plane->fb = NULL; | |
1004 | } else { | |
1005 | plane->old_fb = NULL; | |
1006 | } | |
1007 | goto out; | |
1008 | } | |
1009 | ||
4dd4677c VS |
1010 | ret = __setplane_check(plane, crtc, fb, |
1011 | crtc_x, crtc_y, crtc_w, crtc_h, | |
1012 | src_x, src_y, src_w, src_h); | |
43968d7b DV |
1013 | if (ret) |
1014 | goto out; | |
1015 | ||
1016 | plane->old_fb = plane->fb; | |
1017 | ret = plane->funcs->update_plane(plane, crtc, fb, | |
1018 | crtc_x, crtc_y, crtc_w, crtc_h, | |
34a2ab5e | 1019 | src_x, src_y, src_w, src_h, ctx); |
43968d7b | 1020 | if (!ret) { |
e7695eb6 VS |
1021 | plane->crtc = crtc; |
1022 | plane->fb = fb; | |
1023 | drm_framebuffer_get(plane->fb); | |
43968d7b DV |
1024 | } else { |
1025 | plane->old_fb = NULL; | |
1026 | } | |
1027 | ||
1028 | out: | |
43968d7b | 1029 | if (plane->old_fb) |
a4a69da0 | 1030 | drm_framebuffer_put(plane->old_fb); |
43968d7b DV |
1031 | plane->old_fb = NULL; |
1032 | ||
1033 | return ret; | |
1034 | } | |
1035 | ||
e7695eb6 VS |
1036 | static int __setplane_atomic(struct drm_plane *plane, |
1037 | struct drm_crtc *crtc, | |
1038 | struct drm_framebuffer *fb, | |
1039 | int32_t crtc_x, int32_t crtc_y, | |
1040 | uint32_t crtc_w, uint32_t crtc_h, | |
1041 | uint32_t src_x, uint32_t src_y, | |
1042 | uint32_t src_w, uint32_t src_h, | |
1043 | struct drm_modeset_acquire_ctx *ctx) | |
1044 | { | |
1045 | int ret; | |
1046 | ||
1047 | WARN_ON(!drm_drv_uses_atomic_modeset(plane->dev)); | |
1048 | ||
90422201 DB |
1049 | /* No fb means shut it down */ |
1050 | if (!fb) | |
e7695eb6 VS |
1051 | return plane->funcs->disable_plane(plane, ctx); |
1052 | ||
1053 | /* | |
1054 | * FIXME: This is redundant with drm_atomic_plane_check(), | |
1055 | * but the legacy cursor/"async" .update_plane() tricks | |
1056 | * don't call that so we still need this here. Should remove | |
1057 | * this when all .update_plane() implementations have been | |
1058 | * fixed to call drm_atomic_plane_check(). | |
1059 | */ | |
1060 | ret = __setplane_check(plane, crtc, fb, | |
1061 | crtc_x, crtc_y, crtc_w, crtc_h, | |
1062 | src_x, src_y, src_w, src_h); | |
1063 | if (ret) | |
1064 | return ret; | |
1065 | ||
1066 | return plane->funcs->update_plane(plane, crtc, fb, | |
1067 | crtc_x, crtc_y, crtc_w, crtc_h, | |
1068 | src_x, src_y, src_w, src_h, ctx); | |
1069 | } | |
1070 | ||
43968d7b DV |
1071 | static int setplane_internal(struct drm_plane *plane, |
1072 | struct drm_crtc *crtc, | |
1073 | struct drm_framebuffer *fb, | |
1074 | int32_t crtc_x, int32_t crtc_y, | |
1075 | uint32_t crtc_w, uint32_t crtc_h, | |
1076 | /* src_{x,y,w,h} values are 16.16 fixed point */ | |
1077 | uint32_t src_x, uint32_t src_y, | |
1078 | uint32_t src_w, uint32_t src_h) | |
1079 | { | |
232e8f70 | 1080 | struct drm_modeset_acquire_ctx ctx; |
43968d7b DV |
1081 | int ret; |
1082 | ||
b7ea04d2 SP |
1083 | DRM_MODESET_LOCK_ALL_BEGIN(plane->dev, ctx, |
1084 | DRM_MODESET_ACQUIRE_INTERRUPTIBLE, ret); | |
e7695eb6 VS |
1085 | |
1086 | if (drm_drv_uses_atomic_modeset(plane->dev)) | |
1087 | ret = __setplane_atomic(plane, crtc, fb, | |
1088 | crtc_x, crtc_y, crtc_w, crtc_h, | |
1089 | src_x, src_y, src_w, src_h, &ctx); | |
1090 | else | |
1091 | ret = __setplane_internal(plane, crtc, fb, | |
1092 | crtc_x, crtc_y, crtc_w, crtc_h, | |
1093 | src_x, src_y, src_w, src_h, &ctx); | |
232e8f70 | 1094 | |
77ef3857 | 1095 | DRM_MODESET_LOCK_ALL_END(plane->dev, ctx, ret); |
43968d7b DV |
1096 | |
1097 | return ret; | |
1098 | } | |
1099 | ||
43968d7b DV |
1100 | int drm_mode_setplane(struct drm_device *dev, void *data, |
1101 | struct drm_file *file_priv) | |
1102 | { | |
1103 | struct drm_mode_set_plane *plane_req = data; | |
1104 | struct drm_plane *plane; | |
1105 | struct drm_crtc *crtc = NULL; | |
1106 | struct drm_framebuffer *fb = NULL; | |
ce0769e0 | 1107 | int ret; |
43968d7b DV |
1108 | |
1109 | if (!drm_core_check_feature(dev, DRIVER_MODESET)) | |
69fdf420 | 1110 | return -EOPNOTSUPP; |
43968d7b DV |
1111 | |
1112 | /* | |
1113 | * First, find the plane, crtc, and fb objects. If not available, | |
1114 | * we don't bother to call the driver. | |
1115 | */ | |
418da172 | 1116 | plane = drm_plane_find(dev, file_priv, plane_req->plane_id); |
43968d7b DV |
1117 | if (!plane) { |
1118 | DRM_DEBUG_KMS("Unknown plane ID %d\n", | |
1119 | plane_req->plane_id); | |
1120 | return -ENOENT; | |
1121 | } | |
1122 | ||
1123 | if (plane_req->fb_id) { | |
418da172 | 1124 | fb = drm_framebuffer_lookup(dev, file_priv, plane_req->fb_id); |
43968d7b DV |
1125 | if (!fb) { |
1126 | DRM_DEBUG_KMS("Unknown framebuffer ID %d\n", | |
1127 | plane_req->fb_id); | |
1128 | return -ENOENT; | |
1129 | } | |
1130 | ||
418da172 | 1131 | crtc = drm_crtc_find(dev, file_priv, plane_req->crtc_id); |
43968d7b | 1132 | if (!crtc) { |
491ab470 | 1133 | drm_framebuffer_put(fb); |
43968d7b DV |
1134 | DRM_DEBUG_KMS("Unknown crtc ID %d\n", |
1135 | plane_req->crtc_id); | |
1136 | return -ENOENT; | |
1137 | } | |
1138 | } | |
1139 | ||
ce0769e0 ML |
1140 | ret = setplane_internal(plane, crtc, fb, |
1141 | plane_req->crtc_x, plane_req->crtc_y, | |
1142 | plane_req->crtc_w, plane_req->crtc_h, | |
1143 | plane_req->src_x, plane_req->src_y, | |
1144 | plane_req->src_w, plane_req->src_h); | |
1145 | ||
1146 | if (fb) | |
1147 | drm_framebuffer_put(fb); | |
1148 | ||
1149 | return ret; | |
43968d7b DV |
1150 | } |
1151 | ||
43968d7b DV |
1152 | static int drm_mode_cursor_universal(struct drm_crtc *crtc, |
1153 | struct drm_mode_cursor2 *req, | |
b95ff031 DV |
1154 | struct drm_file *file_priv, |
1155 | struct drm_modeset_acquire_ctx *ctx) | |
43968d7b DV |
1156 | { |
1157 | struct drm_device *dev = crtc->dev; | |
64c32b49 | 1158 | struct drm_plane *plane = crtc->cursor; |
43968d7b DV |
1159 | struct drm_framebuffer *fb = NULL; |
1160 | struct drm_mode_fb_cmd2 fbreq = { | |
1161 | .width = req->width, | |
1162 | .height = req->height, | |
1163 | .pixel_format = DRM_FORMAT_ARGB8888, | |
1164 | .pitches = { req->width * 4 }, | |
1165 | .handles = { req->handle }, | |
1166 | }; | |
1167 | int32_t crtc_x, crtc_y; | |
1168 | uint32_t crtc_w = 0, crtc_h = 0; | |
1169 | uint32_t src_w = 0, src_h = 0; | |
1170 | int ret = 0; | |
1171 | ||
64c32b49 VS |
1172 | BUG_ON(!plane); |
1173 | WARN_ON(plane->crtc != crtc && plane->crtc != NULL); | |
43968d7b DV |
1174 | |
1175 | /* | |
1176 | * Obtain fb we'll be using (either new or existing) and take an extra | |
1177 | * reference to it if fb != null. setplane will take care of dropping | |
1178 | * the reference if the plane update fails. | |
1179 | */ | |
1180 | if (req->flags & DRM_MODE_CURSOR_BO) { | |
1181 | if (req->handle) { | |
1182 | fb = drm_internal_framebuffer_create(dev, &fbreq, file_priv); | |
1183 | if (IS_ERR(fb)) { | |
1184 | DRM_DEBUG_KMS("failed to wrap cursor buffer in drm framebuffer\n"); | |
1185 | return PTR_ERR(fb); | |
1186 | } | |
bf2d5eb9 | 1187 | |
8f7179a1 ZR |
1188 | if (plane->hotspot_x_property && plane->state) |
1189 | plane->state->hotspot_x = req->hot_x; | |
1190 | if (plane->hotspot_y_property && plane->state) | |
1191 | plane->state->hotspot_y = req->hot_y; | |
43968d7b DV |
1192 | } else { |
1193 | fb = NULL; | |
1194 | } | |
1195 | } else { | |
a36c027d VS |
1196 | if (plane->state) |
1197 | fb = plane->state->fb; | |
1198 | else | |
1199 | fb = plane->fb; | |
1200 | ||
43968d7b | 1201 | if (fb) |
a4a69da0 | 1202 | drm_framebuffer_get(fb); |
43968d7b DV |
1203 | } |
1204 | ||
1205 | if (req->flags & DRM_MODE_CURSOR_MOVE) { | |
1206 | crtc_x = req->x; | |
1207 | crtc_y = req->y; | |
1208 | } else { | |
1209 | crtc_x = crtc->cursor_x; | |
1210 | crtc_y = crtc->cursor_y; | |
1211 | } | |
1212 | ||
1213 | if (fb) { | |
1214 | crtc_w = fb->width; | |
1215 | crtc_h = fb->height; | |
1216 | src_w = fb->width << 16; | |
1217 | src_h = fb->height << 16; | |
1218 | } | |
1219 | ||
e7695eb6 VS |
1220 | if (drm_drv_uses_atomic_modeset(dev)) |
1221 | ret = __setplane_atomic(plane, crtc, fb, | |
1222 | crtc_x, crtc_y, crtc_w, crtc_h, | |
1223 | 0, 0, src_w, src_h, ctx); | |
1224 | else | |
1225 | ret = __setplane_internal(plane, crtc, fb, | |
1226 | crtc_x, crtc_y, crtc_w, crtc_h, | |
1227 | 0, 0, src_w, src_h, ctx); | |
ce0769e0 ML |
1228 | |
1229 | if (fb) | |
1230 | drm_framebuffer_put(fb); | |
43968d7b DV |
1231 | |
1232 | /* Update successful; save new cursor position, if necessary */ | |
1233 | if (ret == 0 && req->flags & DRM_MODE_CURSOR_MOVE) { | |
1234 | crtc->cursor_x = req->x; | |
1235 | crtc->cursor_y = req->y; | |
1236 | } | |
1237 | ||
1238 | return ret; | |
1239 | } | |
1240 | ||
1241 | static int drm_mode_cursor_common(struct drm_device *dev, | |
1242 | struct drm_mode_cursor2 *req, | |
1243 | struct drm_file *file_priv) | |
1244 | { | |
1245 | struct drm_crtc *crtc; | |
b95ff031 | 1246 | struct drm_modeset_acquire_ctx ctx; |
43968d7b DV |
1247 | int ret = 0; |
1248 | ||
1249 | if (!drm_core_check_feature(dev, DRIVER_MODESET)) | |
69fdf420 | 1250 | return -EOPNOTSUPP; |
43968d7b DV |
1251 | |
1252 | if (!req->flags || (~DRM_MODE_CURSOR_FLAGS & req->flags)) | |
1253 | return -EINVAL; | |
1254 | ||
418da172 | 1255 | crtc = drm_crtc_find(dev, file_priv, req->crtc_id); |
43968d7b DV |
1256 | if (!crtc) { |
1257 | DRM_DEBUG_KMS("Unknown CRTC ID %d\n", req->crtc_id); | |
1258 | return -ENOENT; | |
1259 | } | |
1260 | ||
6c886e4a | 1261 | drm_modeset_acquire_init(&ctx, DRM_MODESET_ACQUIRE_INTERRUPTIBLE); |
b95ff031 DV |
1262 | retry: |
1263 | ret = drm_modeset_lock(&crtc->mutex, &ctx); | |
1264 | if (ret) | |
1265 | goto out; | |
43968d7b DV |
1266 | /* |
1267 | * If this crtc has a universal cursor plane, call that plane's update | |
1268 | * handler rather than using legacy cursor handlers. | |
1269 | */ | |
b95ff031 | 1270 | if (crtc->cursor) { |
2e064163 DV |
1271 | ret = drm_modeset_lock(&crtc->cursor->mutex, &ctx); |
1272 | if (ret) | |
1273 | goto out; | |
1274 | ||
204f640d DV |
1275 | if (!drm_lease_held(file_priv, crtc->cursor->base.id)) { |
1276 | ret = -EACCES; | |
1277 | goto out; | |
1278 | } | |
1279 | ||
b95ff031 DV |
1280 | ret = drm_mode_cursor_universal(crtc, req, file_priv, &ctx); |
1281 | goto out; | |
1282 | } | |
43968d7b DV |
1283 | |
1284 | if (req->flags & DRM_MODE_CURSOR_BO) { | |
1285 | if (!crtc->funcs->cursor_set && !crtc->funcs->cursor_set2) { | |
1286 | ret = -ENXIO; | |
1287 | goto out; | |
1288 | } | |
1289 | /* Turns off the cursor if handle is 0 */ | |
1290 | if (crtc->funcs->cursor_set2) | |
1291 | ret = crtc->funcs->cursor_set2(crtc, file_priv, req->handle, | |
1292 | req->width, req->height, req->hot_x, req->hot_y); | |
1293 | else | |
1294 | ret = crtc->funcs->cursor_set(crtc, file_priv, req->handle, | |
1295 | req->width, req->height); | |
1296 | } | |
1297 | ||
1298 | if (req->flags & DRM_MODE_CURSOR_MOVE) { | |
1299 | if (crtc->funcs->cursor_move) { | |
1300 | ret = crtc->funcs->cursor_move(crtc, req->x, req->y); | |
1301 | } else { | |
1302 | ret = -EFAULT; | |
1303 | goto out; | |
1304 | } | |
1305 | } | |
1306 | out: | |
b95ff031 | 1307 | if (ret == -EDEADLK) { |
6c886e4a ML |
1308 | ret = drm_modeset_backoff(&ctx); |
1309 | if (!ret) | |
1310 | goto retry; | |
b95ff031 DV |
1311 | } |
1312 | ||
1313 | drm_modeset_drop_locks(&ctx); | |
1314 | drm_modeset_acquire_fini(&ctx); | |
43968d7b DV |
1315 | |
1316 | return ret; | |
1317 | ||
1318 | } | |
1319 | ||
1320 | ||
43968d7b DV |
1321 | int drm_mode_cursor_ioctl(struct drm_device *dev, |
1322 | void *data, struct drm_file *file_priv) | |
1323 | { | |
1324 | struct drm_mode_cursor *req = data; | |
1325 | struct drm_mode_cursor2 new_req; | |
1326 | ||
1327 | memcpy(&new_req, req, sizeof(struct drm_mode_cursor)); | |
1328 | new_req.hot_x = new_req.hot_y = 0; | |
1329 | ||
1330 | return drm_mode_cursor_common(dev, &new_req, file_priv); | |
1331 | } | |
1332 | ||
532b3671 | 1333 | /* |
43968d7b DV |
1334 | * Set the cursor configuration based on user request. This implements the 2nd |
1335 | * version of the cursor ioctl, which allows userspace to additionally specify | |
1336 | * the hotspot of the pointer. | |
43968d7b DV |
1337 | */ |
1338 | int drm_mode_cursor2_ioctl(struct drm_device *dev, | |
1339 | void *data, struct drm_file *file_priv) | |
1340 | { | |
1341 | struct drm_mode_cursor2 *req = data; | |
1342 | ||
1343 | return drm_mode_cursor_common(dev, req, file_priv); | |
1344 | } | |
1345 | ||
43968d7b DV |
1346 | int drm_mode_page_flip_ioctl(struct drm_device *dev, |
1347 | void *data, struct drm_file *file_priv) | |
1348 | { | |
1349 | struct drm_mode_crtc_page_flip_target *page_flip = data; | |
1350 | struct drm_crtc *crtc; | |
64c32b49 | 1351 | struct drm_plane *plane; |
a36c027d | 1352 | struct drm_framebuffer *fb = NULL, *old_fb; |
43968d7b DV |
1353 | struct drm_pending_vblank_event *e = NULL; |
1354 | u32 target_vblank = page_flip->sequence; | |
29dc0d1d | 1355 | struct drm_modeset_acquire_ctx ctx; |
43968d7b DV |
1356 | int ret = -EINVAL; |
1357 | ||
1358 | if (!drm_core_check_feature(dev, DRIVER_MODESET)) | |
69fdf420 | 1359 | return -EOPNOTSUPP; |
43968d7b DV |
1360 | |
1361 | if (page_flip->flags & ~DRM_MODE_PAGE_FLIP_FLAGS) | |
1362 | return -EINVAL; | |
1363 | ||
1364 | if (page_flip->sequence != 0 && !(page_flip->flags & DRM_MODE_PAGE_FLIP_TARGET)) | |
1365 | return -EINVAL; | |
1366 | ||
1367 | /* Only one of the DRM_MODE_PAGE_FLIP_TARGET_ABSOLUTE/RELATIVE flags | |
1368 | * can be specified | |
1369 | */ | |
1370 | if ((page_flip->flags & DRM_MODE_PAGE_FLIP_TARGET) == DRM_MODE_PAGE_FLIP_TARGET) | |
1371 | return -EINVAL; | |
1372 | ||
1373 | if ((page_flip->flags & DRM_MODE_PAGE_FLIP_ASYNC) && !dev->mode_config.async_page_flip) | |
1374 | return -EINVAL; | |
1375 | ||
418da172 | 1376 | crtc = drm_crtc_find(dev, file_priv, page_flip->crtc_id); |
43968d7b DV |
1377 | if (!crtc) |
1378 | return -ENOENT; | |
1379 | ||
64c32b49 VS |
1380 | plane = crtc->primary; |
1381 | ||
204f640d DV |
1382 | if (!drm_lease_held(file_priv, plane->base.id)) |
1383 | return -EACCES; | |
1384 | ||
2adb29b1 DV |
1385 | if (crtc->funcs->page_flip_target) { |
1386 | u32 current_vblank; | |
1387 | int r; | |
1388 | ||
1389 | r = drm_crtc_vblank_get(crtc); | |
1390 | if (r) | |
1391 | return r; | |
1392 | ||
f4c0468e | 1393 | current_vblank = (u32)drm_crtc_vblank_count(crtc); |
2adb29b1 DV |
1394 | |
1395 | switch (page_flip->flags & DRM_MODE_PAGE_FLIP_TARGET) { | |
1396 | case DRM_MODE_PAGE_FLIP_TARGET_ABSOLUTE: | |
1397 | if ((int)(target_vblank - current_vblank) > 1) { | |
1398 | DRM_DEBUG("Invalid absolute flip target %u, " | |
1399 | "must be <= %u\n", target_vblank, | |
1400 | current_vblank + 1); | |
1401 | drm_crtc_vblank_put(crtc); | |
1402 | return -EINVAL; | |
1403 | } | |
1404 | break; | |
1405 | case DRM_MODE_PAGE_FLIP_TARGET_RELATIVE: | |
1406 | if (target_vblank != 0 && target_vblank != 1) { | |
1407 | DRM_DEBUG("Invalid relative flip target %u, " | |
1408 | "must be 0 or 1\n", target_vblank); | |
1409 | drm_crtc_vblank_put(crtc); | |
1410 | return -EINVAL; | |
1411 | } | |
1412 | target_vblank += current_vblank; | |
1413 | break; | |
1414 | default: | |
1415 | target_vblank = current_vblank + | |
1416 | !(page_flip->flags & DRM_MODE_PAGE_FLIP_ASYNC); | |
1417 | break; | |
1418 | } | |
1419 | } else if (crtc->funcs->page_flip == NULL || | |
1420 | (page_flip->flags & DRM_MODE_PAGE_FLIP_TARGET)) { | |
1421 | return -EINVAL; | |
1422 | } | |
1423 | ||
c2e4ff34 | 1424 | drm_modeset_acquire_init(&ctx, DRM_MODESET_ACQUIRE_INTERRUPTIBLE); |
29dc0d1d DV |
1425 | retry: |
1426 | ret = drm_modeset_lock(&crtc->mutex, &ctx); | |
1427 | if (ret) | |
1428 | goto out; | |
64c32b49 | 1429 | ret = drm_modeset_lock(&plane->mutex, &ctx); |
29dc0d1d DV |
1430 | if (ret) |
1431 | goto out; | |
29dc0d1d | 1432 | |
a36c027d VS |
1433 | if (plane->state) |
1434 | old_fb = plane->state->fb; | |
1435 | else | |
1436 | old_fb = plane->fb; | |
1437 | ||
1438 | if (old_fb == NULL) { | |
43968d7b DV |
1439 | /* The framebuffer is currently unbound, presumably |
1440 | * due to a hotplug event, that userspace has not | |
1441 | * yet discovered. | |
1442 | */ | |
1443 | ret = -EBUSY; | |
1444 | goto out; | |
1445 | } | |
1446 | ||
418da172 | 1447 | fb = drm_framebuffer_lookup(dev, file_priv, page_flip->fb_id); |
43968d7b DV |
1448 | if (!fb) { |
1449 | ret = -ENOENT; | |
1450 | goto out; | |
1451 | } | |
1452 | ||
a36c027d | 1453 | if (plane->state) { |
64c32b49 | 1454 | const struct drm_plane_state *state = plane->state; |
43968d7b DV |
1455 | |
1456 | ret = drm_framebuffer_check_src_coords(state->src_x, | |
1457 | state->src_y, | |
1458 | state->src_w, | |
1459 | state->src_h, | |
1460 | fb); | |
1461 | } else { | |
bf2d5eb9 VS |
1462 | ret = drm_crtc_check_viewport(crtc, crtc->x, crtc->y, |
1463 | &crtc->mode, fb); | |
43968d7b DV |
1464 | } |
1465 | if (ret) | |
1466 | goto out; | |
1467 | ||
a5e92ef3 BN |
1468 | /* |
1469 | * Only check the FOURCC format code, excluding modifiers. This is | |
1470 | * enough for all legacy drivers. Atomic drivers have their own | |
1471 | * checks in their ->atomic_check implementation, which will | |
1472 | * return -EINVAL if any hw or driver constraint is violated due | |
1473 | * to modifier changes. | |
1474 | */ | |
1475 | if (old_fb->format->format != fb->format->format) { | |
43968d7b DV |
1476 | DRM_DEBUG_KMS("Page flip is not allowed to change frame buffer format.\n"); |
1477 | ret = -EINVAL; | |
1478 | goto out; | |
1479 | } | |
1480 | ||
1481 | if (page_flip->flags & DRM_MODE_PAGE_FLIP_EVENT) { | |
1482 | e = kzalloc(sizeof *e, GFP_KERNEL); | |
1483 | if (!e) { | |
1484 | ret = -ENOMEM; | |
1485 | goto out; | |
1486 | } | |
bf2d5eb9 | 1487 | |
43968d7b DV |
1488 | e->event.base.type = DRM_EVENT_FLIP_COMPLETE; |
1489 | e->event.base.length = sizeof(e->event); | |
bd386e51 | 1490 | e->event.vbl.user_data = page_flip->user_data; |
b8a3365a | 1491 | e->event.vbl.crtc_id = crtc->base.id; |
bf2d5eb9 | 1492 | |
43968d7b DV |
1493 | ret = drm_event_reserve_init(dev, file_priv, &e->base, &e->event.base); |
1494 | if (ret) { | |
1495 | kfree(e); | |
031e5896 | 1496 | e = NULL; |
43968d7b DV |
1497 | goto out; |
1498 | } | |
1499 | } | |
1500 | ||
64c32b49 | 1501 | plane->old_fb = plane->fb; |
43968d7b DV |
1502 | if (crtc->funcs->page_flip_target) |
1503 | ret = crtc->funcs->page_flip_target(crtc, fb, e, | |
1504 | page_flip->flags, | |
41292b1f DV |
1505 | target_vblank, |
1506 | &ctx); | |
43968d7b | 1507 | else |
41292b1f DV |
1508 | ret = crtc->funcs->page_flip(crtc, fb, e, page_flip->flags, |
1509 | &ctx); | |
43968d7b DV |
1510 | if (ret) { |
1511 | if (page_flip->flags & DRM_MODE_PAGE_FLIP_EVENT) | |
1512 | drm_event_cancel_free(dev, &e->base); | |
1513 | /* Keep the old fb, don't unref it. */ | |
64c32b49 | 1514 | plane->old_fb = NULL; |
43968d7b | 1515 | } else { |
e00fb856 VS |
1516 | if (!plane->state) { |
1517 | plane->fb = fb; | |
1518 | drm_framebuffer_get(fb); | |
1519 | } | |
43968d7b DV |
1520 | } |
1521 | ||
1522 | out: | |
e86fa21b | 1523 | if (fb) |
a4a69da0 | 1524 | drm_framebuffer_put(fb); |
cb4daf27 | 1525 | fb = NULL; |
64c32b49 VS |
1526 | if (plane->old_fb) |
1527 | drm_framebuffer_put(plane->old_fb); | |
1528 | plane->old_fb = NULL; | |
29dc0d1d DV |
1529 | |
1530 | if (ret == -EDEADLK) { | |
c2e4ff34 ML |
1531 | ret = drm_modeset_backoff(&ctx); |
1532 | if (!ret) | |
1533 | goto retry; | |
29dc0d1d DV |
1534 | } |
1535 | ||
1536 | drm_modeset_drop_locks(&ctx); | |
1537 | drm_modeset_acquire_fini(&ctx); | |
43968d7b | 1538 | |
f9285434 DV |
1539 | if (ret && crtc->funcs->page_flip_target) |
1540 | drm_crtc_vblank_put(crtc); | |
1541 | ||
43968d7b DV |
1542 | return ret; |
1543 | } | |
5c759eda | 1544 | |
ba6cd766 DV |
1545 | /** |
1546 | * DOC: damage tracking | |
1547 | * | |
1548 | * FB_DAMAGE_CLIPS is an optional plane property which provides a means to | |
1549 | * specify a list of damage rectangles on a plane in framebuffer coordinates of | |
1550 | * the framebuffer attached to the plane. In current context damage is the area | |
1551 | * of plane framebuffer that has changed since last plane update (also called | |
1552 | * page-flip), irrespective of whether currently attached framebuffer is same as | |
1553 | * framebuffer attached during last plane update or not. | |
1554 | * | |
1555 | * FB_DAMAGE_CLIPS is a hint to kernel which could be helpful for some drivers | |
1556 | * to optimize internally especially for virtual devices where each framebuffer | |
1557 | * change needs to be transmitted over network, usb, etc. | |
1558 | * | |
1559 | * Since FB_DAMAGE_CLIPS is a hint so it is an optional property. User-space can | |
1560 | * ignore damage clips property and in that case driver will do a full plane | |
1561 | * update. In case damage clips are provided then it is guaranteed that the area | |
1562 | * inside damage clips will be updated to plane. For efficiency driver can do | |
1563 | * full update or can update more than specified in damage clips. Since driver | |
1564 | * is free to read more, user-space must always render the entire visible | |
1565 | * framebuffer. Otherwise there can be corruptions. Also, if a user-space | |
1566 | * provides damage clips which doesn't encompass the actual damage to | |
1567 | * framebuffer (since last plane update) can result in incorrect rendering. | |
1568 | * | |
1569 | * FB_DAMAGE_CLIPS is a blob property with the layout of blob data is simply an | |
1570 | * array of &drm_mode_rect. Unlike plane &drm_plane_state.src coordinates, | |
1571 | * damage clips are not in 16.16 fixed point. Similar to plane src in | |
1572 | * framebuffer, damage clips cannot be negative. In damage clip, x1/y1 are | |
1573 | * inclusive and x2/y2 are exclusive. While kernel does not error for overlapped | |
1574 | * damage clips, it is strongly discouraged. | |
1575 | * | |
1576 | * Drivers that are interested in damage interface for plane should enable | |
1577 | * FB_DAMAGE_CLIPS property by calling drm_plane_enable_fb_damage_clips(). | |
1578 | * Drivers implementing damage can use drm_atomic_helper_damage_iter_init() and | |
1579 | * drm_atomic_helper_damage_iter_next() helper iterator function to get damage | |
1580 | * rectangles clipped to &drm_plane_state.src. | |
017bdf8f JMC |
1581 | * |
1582 | * Note that there are two types of damage handling: frame damage and buffer | |
1583 | * damage, the type of damage handling implemented depends on a driver's upload | |
1584 | * target. Drivers implementing a per-plane or per-CRTC upload target need to | |
1585 | * handle frame damage, while drivers implementing a per-buffer upload target | |
1586 | * need to handle buffer damage. | |
1587 | * | |
1588 | * The existing damage helpers only support the frame damage type, there is no | |
1589 | * buffer age support or similar damage accumulation algorithm implemented yet. | |
1590 | * | |
1591 | * Only drivers handling frame damage can use the mentioned damage helpers to | |
1592 | * iterate over the damaged regions. Drivers that handle buffer damage, must set | |
1593 | * &drm_plane_state.ignore_damage_clips for drm_atomic_helper_damage_iter_init() | |
1594 | * to know that damage clips should be ignored and return &drm_plane_state.src | |
1595 | * as the damage rectangle, to force a full plane update. | |
1596 | * | |
1597 | * Drivers with a per-buffer upload target could compare the &drm_plane_state.fb | |
1598 | * of the old and new plane states to determine if the framebuffer attached to a | |
1599 | * plane has changed or not since the last plane update. If &drm_plane_state.fb | |
1600 | * has changed, then &drm_plane_state.ignore_damage_clips must be set to true. | |
1601 | * | |
1602 | * That is because drivers with a per-plane upload target, expect the backing | |
1603 | * storage buffer to not change for a given plane. If the upload buffer changes | |
1604 | * between page flips, the new upload buffer has to be updated as a whole. This | |
1605 | * can be improved in the future if support for frame damage is added to the DRM | |
1606 | * damage helpers, similarly to how user-space already handle this case as it is | |
1607 | * explained in the following documents: | |
1608 | * | |
1609 | * https://registry.khronos.org/EGL/extensions/KHR/EGL_KHR_swap_buffers_with_damage.txt | |
1610 | * https://emersion.fr/blog/2019/intro-to-damage-tracking/ | |
ba6cd766 DV |
1611 | */ |
1612 | ||
1613 | /** | |
1614 | * drm_plane_enable_fb_damage_clips - Enables plane fb damage clips property. | |
1615 | * @plane: Plane on which to enable damage clips property. | |
1616 | * | |
1617 | * This function lets driver to enable the damage clips property on a plane. | |
1618 | */ | |
1619 | void drm_plane_enable_fb_damage_clips(struct drm_plane *plane) | |
1620 | { | |
1621 | struct drm_device *dev = plane->dev; | |
1622 | struct drm_mode_config *config = &dev->mode_config; | |
1623 | ||
1624 | drm_object_attach_property(&plane->base, config->prop_fb_damage_clips, | |
1625 | 0); | |
1626 | } | |
1627 | EXPORT_SYMBOL(drm_plane_enable_fb_damage_clips); | |
1628 | ||
c7fcbf25 DV |
1629 | /** |
1630 | * drm_plane_get_damage_clips_count - Returns damage clips count. | |
1631 | * @state: Plane state. | |
1632 | * | |
1633 | * Simple helper to get the number of &drm_mode_rect clips set by user-space | |
1634 | * during plane update. | |
1635 | * | |
1636 | * Return: Number of clips in plane fb_damage_clips blob property. | |
1637 | */ | |
1638 | unsigned int | |
1639 | drm_plane_get_damage_clips_count(const struct drm_plane_state *state) | |
1640 | { | |
1641 | return (state && state->fb_damage_clips) ? | |
1642 | state->fb_damage_clips->length/sizeof(struct drm_mode_rect) : 0; | |
1643 | } | |
1644 | EXPORT_SYMBOL(drm_plane_get_damage_clips_count); | |
1645 | ||
1646 | struct drm_mode_rect * | |
1647 | __drm_plane_get_damage_clips(const struct drm_plane_state *state) | |
1648 | { | |
1649 | return (struct drm_mode_rect *)((state && state->fb_damage_clips) ? | |
1650 | state->fb_damage_clips->data : NULL); | |
1651 | } | |
1652 | ||
1653 | /** | |
1654 | * drm_plane_get_damage_clips - Returns damage clips. | |
1655 | * @state: Plane state. | |
1656 | * | |
1657 | * Note that this function returns uapi type &drm_mode_rect. Drivers might want | |
1658 | * to use the helper functions drm_atomic_helper_damage_iter_init() and | |
1659 | * drm_atomic_helper_damage_iter_next() or drm_atomic_helper_damage_merged() if | |
1660 | * the driver can only handle a single damage region at most. | |
1661 | * | |
1662 | * Return: Damage clips in plane fb_damage_clips blob property. | |
1663 | */ | |
1664 | struct drm_mode_rect * | |
1665 | drm_plane_get_damage_clips(const struct drm_plane_state *state) | |
1666 | { | |
1667 | struct drm_device *dev = state->plane->dev; | |
1668 | struct drm_mode_config *config = &dev->mode_config; | |
1669 | ||
1670 | /* check that drm_plane_enable_fb_damage_clips() was called */ | |
1671 | if (!drm_mode_obj_find_prop_id(&state->plane->base, | |
1672 | config->prop_fb_damage_clips->base.id)) | |
1673 | drm_warn_once(dev, "drm_plane_enable_fb_damage_clips() not called\n"); | |
1674 | ||
1675 | return __drm_plane_get_damage_clips(state); | |
1676 | } | |
1677 | EXPORT_SYMBOL(drm_plane_get_damage_clips); | |
1678 | ||
5c759eda PB |
1679 | struct drm_property * |
1680 | drm_create_scaling_filter_prop(struct drm_device *dev, | |
1681 | unsigned int supported_filters) | |
1682 | { | |
1683 | struct drm_property *prop; | |
1684 | static const struct drm_prop_enum_list props[] = { | |
1685 | { DRM_SCALING_FILTER_DEFAULT, "Default" }, | |
1686 | { DRM_SCALING_FILTER_NEAREST_NEIGHBOR, "Nearest Neighbor" }, | |
1687 | }; | |
1688 | unsigned int valid_mode_mask = BIT(DRM_SCALING_FILTER_DEFAULT) | | |
1689 | BIT(DRM_SCALING_FILTER_NEAREST_NEIGHBOR); | |
1690 | int i; | |
1691 | ||
1692 | if (WARN_ON((supported_filters & ~valid_mode_mask) || | |
1693 | ((supported_filters & BIT(DRM_SCALING_FILTER_DEFAULT)) == 0))) | |
1694 | return ERR_PTR(-EINVAL); | |
1695 | ||
1696 | prop = drm_property_create(dev, DRM_MODE_PROP_ENUM, | |
1697 | "SCALING_FILTER", | |
1698 | hweight32(supported_filters)); | |
1699 | if (!prop) | |
1700 | return ERR_PTR(-ENOMEM); | |
1701 | ||
1702 | for (i = 0; i < ARRAY_SIZE(props); i++) { | |
1703 | int ret; | |
1704 | ||
1705 | if (!(BIT(props[i].type) & supported_filters)) | |
1706 | continue; | |
1707 | ||
1708 | ret = drm_property_add_enum(prop, props[i].type, | |
1709 | props[i].name); | |
1710 | ||
1711 | if (ret) { | |
1712 | drm_property_destroy(dev, prop); | |
1713 | ||
1714 | return ERR_PTR(ret); | |
1715 | } | |
1716 | } | |
1717 | ||
1718 | return prop; | |
1719 | } | |
1720 | ||
1721 | /** | |
1722 | * drm_plane_create_scaling_filter_property - create a new scaling filter | |
1723 | * property | |
1724 | * | |
1725 | * @plane: drm plane | |
1726 | * @supported_filters: bitmask of supported scaling filters, must include | |
1727 | * BIT(DRM_SCALING_FILTER_DEFAULT). | |
1728 | * | |
1729 | * This function lets driver to enable the scaling filter property on a given | |
1730 | * plane. | |
1731 | * | |
1732 | * RETURNS: | |
1733 | * Zero for success or -errno | |
1734 | */ | |
1735 | int drm_plane_create_scaling_filter_property(struct drm_plane *plane, | |
1736 | unsigned int supported_filters) | |
1737 | { | |
1738 | struct drm_property *prop = | |
1739 | drm_create_scaling_filter_prop(plane->dev, supported_filters); | |
1740 | ||
1741 | if (IS_ERR(prop)) | |
1742 | return PTR_ERR(prop); | |
1743 | ||
1744 | drm_object_attach_property(&plane->base, prop, | |
1745 | DRM_SCALING_FILTER_DEFAULT); | |
1746 | plane->scaling_filter_property = prop; | |
1747 | ||
1748 | return 0; | |
1749 | } | |
1750 | EXPORT_SYMBOL(drm_plane_create_scaling_filter_property); | |
9677547d VS |
1751 | |
1752 | /** | |
105aa4c6 | 1753 | * drm_plane_add_size_hints_property - create a size hints property |
9677547d VS |
1754 | * |
1755 | * @plane: drm plane | |
1756 | * @hints: size hints | |
1757 | * @num_hints: number of size hints | |
1758 | * | |
1759 | * Create a size hints property for the plane. | |
1760 | * | |
1761 | * RETURNS: | |
1762 | * Zero for success or -errno | |
1763 | */ | |
1764 | int drm_plane_add_size_hints_property(struct drm_plane *plane, | |
1765 | const struct drm_plane_size_hint *hints, | |
1766 | int num_hints) | |
1767 | { | |
1768 | struct drm_device *dev = plane->dev; | |
1769 | struct drm_mode_config *config = &dev->mode_config; | |
1770 | struct drm_property_blob *blob; | |
1771 | ||
1772 | /* extending to other plane types needs actual thought */ | |
1773 | if (drm_WARN_ON(dev, plane->type != DRM_PLANE_TYPE_CURSOR)) | |
1774 | return -EINVAL; | |
1775 | ||
1776 | blob = drm_property_create_blob(dev, | |
1777 | array_size(sizeof(hints[0]), num_hints), | |
1778 | hints); | |
1779 | if (IS_ERR(blob)) | |
1780 | return PTR_ERR(blob); | |
1781 | ||
1782 | drm_object_attach_property(&plane->base, config->size_hints_property, | |
1783 | blob->base.id); | |
1784 | ||
1785 | return 0; | |
1786 | } | |
1787 | EXPORT_SYMBOL(drm_plane_add_size_hints_property); |