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
drm_num_planes(struct drm_device * dev)53 static 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
65 /**
66 * drm_universal_plane_init - Initialize a new universal plane object
67 * @dev: DRM device
68 * @plane: plane object to init
69 * @possible_crtcs: bitmask of possible CRTCs
70 * @funcs: callbacks for the new plane
71 * @formats: array of supported formats (DRM_FORMAT\_\*)
72 * @format_count: number of elements in @formats
73 * @type: type of plane (overlay, primary, cursor)
74 * @name: printf style format string for the plane name, or NULL for default name
75 *
76 * Initializes a plane object of type @type.
77 *
78 * Returns:
79 * Zero on success, error code on failure.
80 */
drm_universal_plane_init(struct drm_device * dev,struct drm_plane * plane,unsigned long possible_crtcs,const struct drm_plane_funcs * funcs,const uint32_t * formats,unsigned int format_count,enum drm_plane_type type,const char * name,...)81 int drm_universal_plane_init(struct drm_device *dev, struct drm_plane *plane,
82 unsigned long possible_crtcs,
83 const struct drm_plane_funcs *funcs,
84 const uint32_t *formats, unsigned int format_count,
85 enum drm_plane_type type,
86 const char *name, ...)
87 {
88 struct drm_mode_config *config = &dev->mode_config;
89 int ret;
90
91 ret = drm_mode_object_get(dev, &plane->base, DRM_MODE_OBJECT_PLANE);
92 if (ret)
93 return ret;
94
95 drm_modeset_lock_init(&plane->mutex);
96
97 plane->base.properties = &plane->properties;
98 plane->dev = dev;
99 plane->funcs = funcs;
100 plane->format_types = kmalloc_array(format_count, sizeof(uint32_t),
101 GFP_KERNEL);
102 if (!plane->format_types) {
103 DRM_DEBUG_KMS("out of memory when allocating plane\n");
104 drm_mode_object_unregister(dev, &plane->base);
105 return -ENOMEM;
106 }
107
108 if (name) {
109 va_list ap;
110
111 va_start(ap, name);
112 plane->name = kvasprintf(GFP_KERNEL, name, ap);
113 va_end(ap);
114 } else {
115 plane->name = kasprintf(GFP_KERNEL, "plane-%d",
116 drm_num_planes(dev));
117 }
118 if (!plane->name) {
119 kfree(plane->format_types);
120 drm_mode_object_unregister(dev, &plane->base);
121 return -ENOMEM;
122 }
123
124 memcpy(plane->format_types, formats, format_count * sizeof(uint32_t));
125 plane->format_count = format_count;
126 plane->possible_crtcs = possible_crtcs;
127 plane->type = type;
128
129 list_add_tail(&plane->head, &config->plane_list);
130 plane->index = config->num_total_plane++;
131 if (plane->type == DRM_PLANE_TYPE_OVERLAY)
132 config->num_overlay_plane++;
133
134 drm_object_attach_property(&plane->base,
135 config->plane_type_property,
136 plane->type);
137
138 if (drm_core_check_feature(dev, DRIVER_ATOMIC)) {
139 drm_object_attach_property(&plane->base, config->prop_fb_id, 0);
140 drm_object_attach_property(&plane->base, config->prop_in_fence_fd, -1);
141 drm_object_attach_property(&plane->base, config->prop_crtc_id, 0);
142 drm_object_attach_property(&plane->base, config->prop_crtc_x, 0);
143 drm_object_attach_property(&plane->base, config->prop_crtc_y, 0);
144 drm_object_attach_property(&plane->base, config->prop_crtc_w, 0);
145 drm_object_attach_property(&plane->base, config->prop_crtc_h, 0);
146 drm_object_attach_property(&plane->base, config->prop_src_x, 0);
147 drm_object_attach_property(&plane->base, config->prop_src_y, 0);
148 drm_object_attach_property(&plane->base, config->prop_src_w, 0);
149 drm_object_attach_property(&plane->base, config->prop_src_h, 0);
150 }
151
152 return 0;
153 }
154 EXPORT_SYMBOL(drm_universal_plane_init);
155
drm_plane_register_all(struct drm_device * dev)156 int drm_plane_register_all(struct drm_device *dev)
157 {
158 struct drm_plane *plane;
159 int ret = 0;
160
161 drm_for_each_plane(plane, dev) {
162 if (plane->funcs->late_register)
163 ret = plane->funcs->late_register(plane);
164 if (ret)
165 return ret;
166 }
167
168 return 0;
169 }
170
drm_plane_unregister_all(struct drm_device * dev)171 void drm_plane_unregister_all(struct drm_device *dev)
172 {
173 struct drm_plane *plane;
174
175 drm_for_each_plane(plane, dev) {
176 if (plane->funcs->early_unregister)
177 plane->funcs->early_unregister(plane);
178 }
179 }
180
181 /**
182 * drm_plane_init - Initialize a legacy plane
183 * @dev: DRM device
184 * @plane: plane object to init
185 * @possible_crtcs: bitmask of possible CRTCs
186 * @funcs: callbacks for the new plane
187 * @formats: array of supported formats (DRM_FORMAT\_\*)
188 * @format_count: number of elements in @formats
189 * @is_primary: plane type (primary vs overlay)
190 *
191 * Legacy API to initialize a DRM plane.
192 *
193 * New drivers should call drm_universal_plane_init() instead.
194 *
195 * Returns:
196 * Zero on success, error code on failure.
197 */
drm_plane_init(struct drm_device * dev,struct drm_plane * plane,unsigned long possible_crtcs,const struct drm_plane_funcs * funcs,const uint32_t * formats,unsigned int format_count,bool is_primary)198 int drm_plane_init(struct drm_device *dev, struct drm_plane *plane,
199 unsigned long possible_crtcs,
200 const struct drm_plane_funcs *funcs,
201 const uint32_t *formats, unsigned int format_count,
202 bool is_primary)
203 {
204 enum drm_plane_type type;
205
206 type = is_primary ? DRM_PLANE_TYPE_PRIMARY : DRM_PLANE_TYPE_OVERLAY;
207 return drm_universal_plane_init(dev, plane, possible_crtcs, funcs,
208 formats, format_count, type, NULL);
209 }
210 EXPORT_SYMBOL(drm_plane_init);
211
212 /**
213 * drm_plane_cleanup - Clean up the core plane usage
214 * @plane: plane to cleanup
215 *
216 * This function cleans up @plane and removes it from the DRM mode setting
217 * core. Note that the function does *not* free the plane structure itself,
218 * this is the responsibility of the caller.
219 */
drm_plane_cleanup(struct drm_plane * plane)220 void drm_plane_cleanup(struct drm_plane *plane)
221 {
222 struct drm_device *dev = plane->dev;
223
224 drm_modeset_lock_all(dev);
225 kfree(plane->format_types);
226 drm_mode_object_unregister(dev, &plane->base);
227
228 BUG_ON(list_empty(&plane->head));
229
230 /* Note that the plane_list is considered to be static; should we
231 * remove the drm_plane at runtime we would have to decrement all
232 * the indices on the drm_plane after us in the plane_list.
233 */
234
235 list_del(&plane->head);
236 dev->mode_config.num_total_plane--;
237 if (plane->type == DRM_PLANE_TYPE_OVERLAY)
238 dev->mode_config.num_overlay_plane--;
239 drm_modeset_unlock_all(dev);
240
241 WARN_ON(plane->state && !plane->funcs->atomic_destroy_state);
242 if (plane->state && plane->funcs->atomic_destroy_state)
243 plane->funcs->atomic_destroy_state(plane, plane->state);
244
245 kfree(plane->name);
246
247 memset(plane, 0, sizeof(*plane));
248 }
249 EXPORT_SYMBOL(drm_plane_cleanup);
250
251 /**
252 * drm_plane_from_index - find the registered plane at an index
253 * @dev: DRM device
254 * @idx: index of registered plane to find for
255 *
256 * Given a plane index, return the registered plane from DRM device's
257 * list of planes with matching index.
258 */
259 struct drm_plane *
drm_plane_from_index(struct drm_device * dev,int idx)260 drm_plane_from_index(struct drm_device *dev, int idx)
261 {
262 struct drm_plane *plane;
263
264 drm_for_each_plane(plane, dev)
265 if (idx == plane->index)
266 return plane;
267
268 return NULL;
269 }
270 EXPORT_SYMBOL(drm_plane_from_index);
271
272 /**
273 * drm_plane_force_disable - Forcibly disable a plane
274 * @plane: plane to disable
275 *
276 * Forces the plane to be disabled.
277 *
278 * Used when the plane's current framebuffer is destroyed,
279 * and when restoring fbdev mode.
280 */
drm_plane_force_disable(struct drm_plane * plane)281 void drm_plane_force_disable(struct drm_plane *plane)
282 {
283 int ret;
284
285 if (!plane->fb)
286 return;
287
288 plane->old_fb = plane->fb;
289 ret = plane->funcs->disable_plane(plane);
290 if (ret) {
291 DRM_ERROR("failed to disable plane with busy fb\n");
292 plane->old_fb = NULL;
293 return;
294 }
295 /* disconnect the plane from the fb and crtc: */
296 drm_framebuffer_unreference(plane->old_fb);
297 plane->old_fb = NULL;
298 plane->fb = NULL;
299 plane->crtc = NULL;
300 }
301 EXPORT_SYMBOL(drm_plane_force_disable);
302
303 /**
304 * drm_mode_plane_set_obj_prop - set the value of a property
305 * @plane: drm plane object to set property value for
306 * @property: property to set
307 * @value: value the property should be set to
308 *
309 * This functions sets a given property on a given plane object. This function
310 * calls the driver's ->set_property callback and changes the software state of
311 * the property if the callback succeeds.
312 *
313 * Returns:
314 * Zero on success, error code on failure.
315 */
drm_mode_plane_set_obj_prop(struct drm_plane * plane,struct drm_property * property,uint64_t value)316 int drm_mode_plane_set_obj_prop(struct drm_plane *plane,
317 struct drm_property *property,
318 uint64_t value)
319 {
320 int ret = -EINVAL;
321 struct drm_mode_object *obj = &plane->base;
322
323 if (plane->funcs->set_property)
324 ret = plane->funcs->set_property(plane, property, value);
325 if (!ret)
326 drm_object_property_set_value(obj, property, value);
327
328 return ret;
329 }
330 EXPORT_SYMBOL(drm_mode_plane_set_obj_prop);
331
drm_mode_getplane_res(struct drm_device * dev,void * data,struct drm_file * file_priv)332 int drm_mode_getplane_res(struct drm_device *dev, void *data,
333 struct drm_file *file_priv)
334 {
335 struct drm_mode_get_plane_res *plane_resp = data;
336 struct drm_mode_config *config;
337 struct drm_plane *plane;
338 uint32_t __user *plane_ptr;
339 int copied = 0;
340 unsigned num_planes;
341
342 if (!drm_core_check_feature(dev, DRIVER_MODESET))
343 return -EINVAL;
344
345 config = &dev->mode_config;
346
347 if (file_priv->universal_planes)
348 num_planes = config->num_total_plane;
349 else
350 num_planes = config->num_overlay_plane;
351
352 /*
353 * This ioctl is called twice, once to determine how much space is
354 * needed, and the 2nd time to fill it.
355 */
356 if (num_planes &&
357 (plane_resp->count_planes >= num_planes)) {
358 plane_ptr = (uint32_t __user *)(unsigned long)plane_resp->plane_id_ptr;
359
360 /* Plane lists are invariant, no locking needed. */
361 drm_for_each_plane(plane, dev) {
362 /*
363 * Unless userspace set the 'universal planes'
364 * capability bit, only advertise overlays.
365 */
366 if (plane->type != DRM_PLANE_TYPE_OVERLAY &&
367 !file_priv->universal_planes)
368 continue;
369
370 if (put_user(plane->base.id, plane_ptr + copied))
371 return -EFAULT;
372 copied++;
373 }
374 }
375 plane_resp->count_planes = num_planes;
376
377 return 0;
378 }
379
drm_mode_getplane(struct drm_device * dev,void * data,struct drm_file * file_priv)380 int drm_mode_getplane(struct drm_device *dev, void *data,
381 struct drm_file *file_priv)
382 {
383 struct drm_mode_get_plane *plane_resp = data;
384 struct drm_plane *plane;
385 uint32_t __user *format_ptr;
386
387 if (!drm_core_check_feature(dev, DRIVER_MODESET))
388 return -EINVAL;
389
390 plane = drm_plane_find(dev, plane_resp->plane_id);
391 if (!plane)
392 return -ENOENT;
393
394 drm_modeset_lock(&plane->mutex, NULL);
395 if (plane->crtc)
396 plane_resp->crtc_id = plane->crtc->base.id;
397 else
398 plane_resp->crtc_id = 0;
399
400 if (plane->fb)
401 plane_resp->fb_id = plane->fb->base.id;
402 else
403 plane_resp->fb_id = 0;
404 drm_modeset_unlock(&plane->mutex);
405
406 plane_resp->plane_id = plane->base.id;
407 plane_resp->possible_crtcs = plane->possible_crtcs;
408 plane_resp->gamma_size = 0;
409
410 /*
411 * This ioctl is called twice, once to determine how much space is
412 * needed, and the 2nd time to fill it.
413 */
414 if (plane->format_count &&
415 (plane_resp->count_format_types >= plane->format_count)) {
416 format_ptr = (uint32_t __user *)(unsigned long)plane_resp->format_type_ptr;
417 if (copy_to_user(format_ptr,
418 plane->format_types,
419 sizeof(uint32_t) * plane->format_count)) {
420 return -EFAULT;
421 }
422 }
423 plane_resp->count_format_types = plane->format_count;
424
425 return 0;
426 }
427
drm_plane_check_pixel_format(const struct drm_plane * plane,u32 format)428 int drm_plane_check_pixel_format(const struct drm_plane *plane, u32 format)
429 {
430 unsigned int i;
431
432 for (i = 0; i < plane->format_count; i++) {
433 if (format == plane->format_types[i])
434 return 0;
435 }
436
437 return -EINVAL;
438 }
439
440 /*
441 * setplane_internal - setplane handler for internal callers
442 *
443 * Note that we assume an extra reference has already been taken on fb. If the
444 * update fails, this reference will be dropped before return; if it succeeds,
445 * the previous framebuffer (if any) will be unreferenced instead.
446 *
447 * src_{x,y,w,h} are provided in 16.16 fixed point format
448 */
__setplane_internal(struct drm_plane * plane,struct drm_crtc * crtc,struct drm_framebuffer * fb,int32_t crtc_x,int32_t crtc_y,uint32_t crtc_w,uint32_t crtc_h,uint32_t src_x,uint32_t src_y,uint32_t src_w,uint32_t src_h)449 static int __setplane_internal(struct drm_plane *plane,
450 struct drm_crtc *crtc,
451 struct drm_framebuffer *fb,
452 int32_t crtc_x, int32_t crtc_y,
453 uint32_t crtc_w, uint32_t crtc_h,
454 /* src_{x,y,w,h} values are 16.16 fixed point */
455 uint32_t src_x, uint32_t src_y,
456 uint32_t src_w, uint32_t src_h)
457 {
458 int ret = 0;
459
460 /* No fb means shut it down */
461 if (!fb) {
462 plane->old_fb = plane->fb;
463 ret = plane->funcs->disable_plane(plane);
464 if (!ret) {
465 plane->crtc = NULL;
466 plane->fb = NULL;
467 } else {
468 plane->old_fb = NULL;
469 }
470 goto out;
471 }
472
473 /* Check whether this plane is usable on this CRTC */
474 if (!(plane->possible_crtcs & drm_crtc_mask(crtc))) {
475 DRM_DEBUG_KMS("Invalid crtc for plane\n");
476 ret = -EINVAL;
477 goto out;
478 }
479
480 /* Check whether this plane supports the fb pixel format. */
481 ret = drm_plane_check_pixel_format(plane, fb->pixel_format);
482 if (ret) {
483 char *format_name = drm_get_format_name(fb->pixel_format);
484 DRM_DEBUG_KMS("Invalid pixel format %s\n", format_name);
485 kfree(format_name);
486 goto out;
487 }
488
489 /* Give drivers some help against integer overflows */
490 if (crtc_w > INT_MAX ||
491 crtc_x > INT_MAX - (int32_t) crtc_w ||
492 crtc_h > INT_MAX ||
493 crtc_y > INT_MAX - (int32_t) crtc_h) {
494 DRM_DEBUG_KMS("Invalid CRTC coordinates %ux%u+%d+%d\n",
495 crtc_w, crtc_h, crtc_x, crtc_y);
496 ret = -ERANGE;
497 goto out;
498 }
499
500 ret = drm_framebuffer_check_src_coords(src_x, src_y, src_w, src_h, fb);
501 if (ret)
502 goto out;
503
504 plane->old_fb = plane->fb;
505 ret = plane->funcs->update_plane(plane, crtc, fb,
506 crtc_x, crtc_y, crtc_w, crtc_h,
507 src_x, src_y, src_w, src_h);
508 if (!ret) {
509 plane->crtc = crtc;
510 plane->fb = fb;
511 fb = NULL;
512 } else {
513 plane->old_fb = NULL;
514 }
515
516 out:
517 if (fb)
518 drm_framebuffer_unreference(fb);
519 if (plane->old_fb)
520 drm_framebuffer_unreference(plane->old_fb);
521 plane->old_fb = NULL;
522
523 return ret;
524 }
525
setplane_internal(struct drm_plane * plane,struct drm_crtc * crtc,struct drm_framebuffer * fb,int32_t crtc_x,int32_t crtc_y,uint32_t crtc_w,uint32_t crtc_h,uint32_t src_x,uint32_t src_y,uint32_t src_w,uint32_t src_h)526 static int setplane_internal(struct drm_plane *plane,
527 struct drm_crtc *crtc,
528 struct drm_framebuffer *fb,
529 int32_t crtc_x, int32_t crtc_y,
530 uint32_t crtc_w, uint32_t crtc_h,
531 /* src_{x,y,w,h} values are 16.16 fixed point */
532 uint32_t src_x, uint32_t src_y,
533 uint32_t src_w, uint32_t src_h)
534 {
535 int ret;
536
537 drm_modeset_lock_all(plane->dev);
538 ret = __setplane_internal(plane, crtc, fb,
539 crtc_x, crtc_y, crtc_w, crtc_h,
540 src_x, src_y, src_w, src_h);
541 drm_modeset_unlock_all(plane->dev);
542
543 return ret;
544 }
545
drm_mode_setplane(struct drm_device * dev,void * data,struct drm_file * file_priv)546 int drm_mode_setplane(struct drm_device *dev, void *data,
547 struct drm_file *file_priv)
548 {
549 struct drm_mode_set_plane *plane_req = data;
550 struct drm_plane *plane;
551 struct drm_crtc *crtc = NULL;
552 struct drm_framebuffer *fb = NULL;
553
554 if (!drm_core_check_feature(dev, DRIVER_MODESET))
555 return -EINVAL;
556
557 /*
558 * First, find the plane, crtc, and fb objects. If not available,
559 * we don't bother to call the driver.
560 */
561 plane = drm_plane_find(dev, plane_req->plane_id);
562 if (!plane) {
563 DRM_DEBUG_KMS("Unknown plane ID %d\n",
564 plane_req->plane_id);
565 return -ENOENT;
566 }
567
568 if (plane_req->fb_id) {
569 fb = drm_framebuffer_lookup(dev, plane_req->fb_id);
570 if (!fb) {
571 DRM_DEBUG_KMS("Unknown framebuffer ID %d\n",
572 plane_req->fb_id);
573 return -ENOENT;
574 }
575
576 crtc = drm_crtc_find(dev, plane_req->crtc_id);
577 if (!crtc) {
578 DRM_DEBUG_KMS("Unknown crtc ID %d\n",
579 plane_req->crtc_id);
580 return -ENOENT;
581 }
582 }
583
584 /*
585 * setplane_internal will take care of deref'ing either the old or new
586 * framebuffer depending on success.
587 */
588 return setplane_internal(plane, crtc, fb,
589 plane_req->crtc_x, plane_req->crtc_y,
590 plane_req->crtc_w, plane_req->crtc_h,
591 plane_req->src_x, plane_req->src_y,
592 plane_req->src_w, plane_req->src_h);
593 }
594
drm_mode_cursor_universal(struct drm_crtc * crtc,struct drm_mode_cursor2 * req,struct drm_file * file_priv)595 static int drm_mode_cursor_universal(struct drm_crtc *crtc,
596 struct drm_mode_cursor2 *req,
597 struct drm_file *file_priv)
598 {
599 struct drm_device *dev = crtc->dev;
600 struct drm_framebuffer *fb = NULL;
601 struct drm_mode_fb_cmd2 fbreq = {
602 .width = req->width,
603 .height = req->height,
604 .pixel_format = DRM_FORMAT_ARGB8888,
605 .pitches = { req->width * 4 },
606 .handles = { req->handle },
607 };
608 int32_t crtc_x, crtc_y;
609 uint32_t crtc_w = 0, crtc_h = 0;
610 uint32_t src_w = 0, src_h = 0;
611 int ret = 0;
612
613 BUG_ON(!crtc->cursor);
614 WARN_ON(crtc->cursor->crtc != crtc && crtc->cursor->crtc != NULL);
615
616 /*
617 * Obtain fb we'll be using (either new or existing) and take an extra
618 * reference to it if fb != null. setplane will take care of dropping
619 * the reference if the plane update fails.
620 */
621 if (req->flags & DRM_MODE_CURSOR_BO) {
622 if (req->handle) {
623 fb = drm_internal_framebuffer_create(dev, &fbreq, file_priv);
624 if (IS_ERR(fb)) {
625 DRM_DEBUG_KMS("failed to wrap cursor buffer in drm framebuffer\n");
626 return PTR_ERR(fb);
627 }
628 fb->hot_x = req->hot_x;
629 fb->hot_y = req->hot_y;
630 } else {
631 fb = NULL;
632 }
633 } else {
634 fb = crtc->cursor->fb;
635 if (fb)
636 drm_framebuffer_reference(fb);
637 }
638
639 if (req->flags & DRM_MODE_CURSOR_MOVE) {
640 crtc_x = req->x;
641 crtc_y = req->y;
642 } else {
643 crtc_x = crtc->cursor_x;
644 crtc_y = crtc->cursor_y;
645 }
646
647 if (fb) {
648 crtc_w = fb->width;
649 crtc_h = fb->height;
650 src_w = fb->width << 16;
651 src_h = fb->height << 16;
652 }
653
654 /*
655 * setplane_internal will take care of deref'ing either the old or new
656 * framebuffer depending on success.
657 */
658 ret = __setplane_internal(crtc->cursor, crtc, fb,
659 crtc_x, crtc_y, crtc_w, crtc_h,
660 0, 0, src_w, src_h);
661
662 /* Update successful; save new cursor position, if necessary */
663 if (ret == 0 && req->flags & DRM_MODE_CURSOR_MOVE) {
664 crtc->cursor_x = req->x;
665 crtc->cursor_y = req->y;
666 }
667
668 return ret;
669 }
670
drm_mode_cursor_common(struct drm_device * dev,struct drm_mode_cursor2 * req,struct drm_file * file_priv)671 static int drm_mode_cursor_common(struct drm_device *dev,
672 struct drm_mode_cursor2 *req,
673 struct drm_file *file_priv)
674 {
675 struct drm_crtc *crtc;
676 int ret = 0;
677
678 if (!drm_core_check_feature(dev, DRIVER_MODESET))
679 return -EINVAL;
680
681 if (!req->flags || (~DRM_MODE_CURSOR_FLAGS & req->flags))
682 return -EINVAL;
683
684 crtc = drm_crtc_find(dev, req->crtc_id);
685 if (!crtc) {
686 DRM_DEBUG_KMS("Unknown CRTC ID %d\n", req->crtc_id);
687 return -ENOENT;
688 }
689
690 /*
691 * If this crtc has a universal cursor plane, call that plane's update
692 * handler rather than using legacy cursor handlers.
693 */
694 drm_modeset_lock_crtc(crtc, crtc->cursor);
695 if (crtc->cursor) {
696 ret = drm_mode_cursor_universal(crtc, req, file_priv);
697 goto out;
698 }
699
700 if (req->flags & DRM_MODE_CURSOR_BO) {
701 if (!crtc->funcs->cursor_set && !crtc->funcs->cursor_set2) {
702 ret = -ENXIO;
703 goto out;
704 }
705 /* Turns off the cursor if handle is 0 */
706 if (crtc->funcs->cursor_set2)
707 ret = crtc->funcs->cursor_set2(crtc, file_priv, req->handle,
708 req->width, req->height, req->hot_x, req->hot_y);
709 else
710 ret = crtc->funcs->cursor_set(crtc, file_priv, req->handle,
711 req->width, req->height);
712 }
713
714 if (req->flags & DRM_MODE_CURSOR_MOVE) {
715 if (crtc->funcs->cursor_move) {
716 ret = crtc->funcs->cursor_move(crtc, req->x, req->y);
717 } else {
718 ret = -EFAULT;
719 goto out;
720 }
721 }
722 out:
723 drm_modeset_unlock_crtc(crtc);
724
725 return ret;
726
727 }
728
729
drm_mode_cursor_ioctl(struct drm_device * dev,void * data,struct drm_file * file_priv)730 int drm_mode_cursor_ioctl(struct drm_device *dev,
731 void *data, struct drm_file *file_priv)
732 {
733 struct drm_mode_cursor *req = data;
734 struct drm_mode_cursor2 new_req;
735
736 memcpy(&new_req, req, sizeof(struct drm_mode_cursor));
737 new_req.hot_x = new_req.hot_y = 0;
738
739 return drm_mode_cursor_common(dev, &new_req, file_priv);
740 }
741
742 /*
743 * Set the cursor configuration based on user request. This implements the 2nd
744 * version of the cursor ioctl, which allows userspace to additionally specify
745 * the hotspot of the pointer.
746 */
drm_mode_cursor2_ioctl(struct drm_device * dev,void * data,struct drm_file * file_priv)747 int drm_mode_cursor2_ioctl(struct drm_device *dev,
748 void *data, struct drm_file *file_priv)
749 {
750 struct drm_mode_cursor2 *req = data;
751
752 return drm_mode_cursor_common(dev, req, file_priv);
753 }
754
drm_mode_page_flip_ioctl(struct drm_device * dev,void * data,struct drm_file * file_priv)755 int drm_mode_page_flip_ioctl(struct drm_device *dev,
756 void *data, struct drm_file *file_priv)
757 {
758 struct drm_mode_crtc_page_flip_target *page_flip = data;
759 struct drm_crtc *crtc;
760 struct drm_framebuffer *fb = NULL;
761 struct drm_pending_vblank_event *e = NULL;
762 u32 target_vblank = page_flip->sequence;
763 int ret = -EINVAL;
764
765 if (!drm_core_check_feature(dev, DRIVER_MODESET))
766 return -EINVAL;
767
768 if (page_flip->flags & ~DRM_MODE_PAGE_FLIP_FLAGS)
769 return -EINVAL;
770
771 if (page_flip->sequence != 0 && !(page_flip->flags & DRM_MODE_PAGE_FLIP_TARGET))
772 return -EINVAL;
773
774 /* Only one of the DRM_MODE_PAGE_FLIP_TARGET_ABSOLUTE/RELATIVE flags
775 * can be specified
776 */
777 if ((page_flip->flags & DRM_MODE_PAGE_FLIP_TARGET) == DRM_MODE_PAGE_FLIP_TARGET)
778 return -EINVAL;
779
780 if ((page_flip->flags & DRM_MODE_PAGE_FLIP_ASYNC) && !dev->mode_config.async_page_flip)
781 return -EINVAL;
782
783 crtc = drm_crtc_find(dev, page_flip->crtc_id);
784 if (!crtc)
785 return -ENOENT;
786
787 if (crtc->funcs->page_flip_target) {
788 u32 current_vblank;
789 int r;
790
791 r = drm_crtc_vblank_get(crtc);
792 if (r)
793 return r;
794
795 current_vblank = drm_crtc_vblank_count(crtc);
796
797 switch (page_flip->flags & DRM_MODE_PAGE_FLIP_TARGET) {
798 case DRM_MODE_PAGE_FLIP_TARGET_ABSOLUTE:
799 if ((int)(target_vblank - current_vblank) > 1) {
800 DRM_DEBUG("Invalid absolute flip target %u, "
801 "must be <= %u\n", target_vblank,
802 current_vblank + 1);
803 drm_crtc_vblank_put(crtc);
804 return -EINVAL;
805 }
806 break;
807 case DRM_MODE_PAGE_FLIP_TARGET_RELATIVE:
808 if (target_vblank != 0 && target_vblank != 1) {
809 DRM_DEBUG("Invalid relative flip target %u, "
810 "must be 0 or 1\n", target_vblank);
811 drm_crtc_vblank_put(crtc);
812 return -EINVAL;
813 }
814 target_vblank += current_vblank;
815 break;
816 default:
817 target_vblank = current_vblank +
818 !(page_flip->flags & DRM_MODE_PAGE_FLIP_ASYNC);
819 break;
820 }
821 } else if (crtc->funcs->page_flip == NULL ||
822 (page_flip->flags & DRM_MODE_PAGE_FLIP_TARGET)) {
823 return -EINVAL;
824 }
825
826 drm_modeset_lock_crtc(crtc, crtc->primary);
827 if (crtc->primary->fb == NULL) {
828 /* The framebuffer is currently unbound, presumably
829 * due to a hotplug event, that userspace has not
830 * yet discovered.
831 */
832 ret = -EBUSY;
833 goto out;
834 }
835
836 fb = drm_framebuffer_lookup(dev, page_flip->fb_id);
837 if (!fb) {
838 ret = -ENOENT;
839 goto out;
840 }
841
842 if (crtc->state) {
843 const struct drm_plane_state *state = crtc->primary->state;
844
845 ret = drm_framebuffer_check_src_coords(state->src_x,
846 state->src_y,
847 state->src_w,
848 state->src_h,
849 fb);
850 } else {
851 ret = drm_crtc_check_viewport(crtc, crtc->x, crtc->y, &crtc->mode, fb);
852 }
853 if (ret)
854 goto out;
855
856 if (crtc->primary->fb->pixel_format != fb->pixel_format) {
857 DRM_DEBUG_KMS("Page flip is not allowed to change frame buffer format.\n");
858 ret = -EINVAL;
859 goto out;
860 }
861
862 if (page_flip->flags & DRM_MODE_PAGE_FLIP_EVENT) {
863 e = kzalloc(sizeof *e, GFP_KERNEL);
864 if (!e) {
865 ret = -ENOMEM;
866 goto out;
867 }
868 e->event.base.type = DRM_EVENT_FLIP_COMPLETE;
869 e->event.base.length = sizeof(e->event);
870 e->event.user_data = page_flip->user_data;
871 ret = drm_event_reserve_init(dev, file_priv, &e->base, &e->event.base);
872 if (ret) {
873 kfree(e);
874 goto out;
875 }
876 }
877
878 crtc->primary->old_fb = crtc->primary->fb;
879 if (crtc->funcs->page_flip_target)
880 ret = crtc->funcs->page_flip_target(crtc, fb, e,
881 page_flip->flags,
882 target_vblank);
883 else
884 ret = crtc->funcs->page_flip(crtc, fb, e, page_flip->flags);
885 if (ret) {
886 if (page_flip->flags & DRM_MODE_PAGE_FLIP_EVENT)
887 drm_event_cancel_free(dev, &e->base);
888 /* Keep the old fb, don't unref it. */
889 crtc->primary->old_fb = NULL;
890 } else {
891 crtc->primary->fb = fb;
892 /* Unref only the old framebuffer. */
893 fb = NULL;
894 }
895
896 out:
897 if (ret && crtc->funcs->page_flip_target)
898 drm_crtc_vblank_put(crtc);
899 if (fb)
900 drm_framebuffer_unreference(fb);
901 if (crtc->primary->old_fb)
902 drm_framebuffer_unreference(crtc->primary->old_fb);
903 crtc->primary->old_fb = NULL;
904 drm_modeset_unlock_crtc(crtc);
905
906 return ret;
907 }
908