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