]> git.karo-electronics.de Git - karo-tx-linux.git/blob - drivers/gpu/drm/drm_atomic.c
Merge airlied/drm-next into drm-misc-next
[karo-tx-linux.git] / drivers / gpu / drm / drm_atomic.c
1 /*
2  * Copyright (C) 2014 Red Hat
3  * Copyright (C) 2014 Intel Corp.
4  *
5  * Permission is hereby granted, free of charge, to any person obtaining a
6  * copy of this software and associated documentation files (the "Software"),
7  * to deal in the Software without restriction, including without limitation
8  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
9  * and/or sell copies of the Software, and to permit persons to whom the
10  * Software is furnished to do so, subject to the following conditions:
11  *
12  * The above copyright notice and this permission notice shall be included in
13  * all copies or substantial portions of the Software.
14  *
15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
18  * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
19  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
20  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
21  * OTHER DEALINGS IN THE SOFTWARE.
22  *
23  * Authors:
24  * Rob Clark <robdclark@gmail.com>
25  * Daniel Vetter <daniel.vetter@ffwll.ch>
26  */
27
28
29 #include <drm/drmP.h>
30 #include <drm/drm_atomic.h>
31 #include <drm/drm_mode.h>
32 #include <drm/drm_plane_helper.h>
33 #include <drm/drm_print.h>
34 #include <linux/sync_file.h>
35
36 #include "drm_crtc_internal.h"
37
38 void __drm_crtc_commit_free(struct kref *kref)
39 {
40         struct drm_crtc_commit *commit =
41                 container_of(kref, struct drm_crtc_commit, ref);
42
43         kfree(commit);
44 }
45 EXPORT_SYMBOL(__drm_crtc_commit_free);
46
47 /**
48  * drm_atomic_state_default_release -
49  * release memory initialized by drm_atomic_state_init
50  * @state: atomic state
51  *
52  * Free all the memory allocated by drm_atomic_state_init.
53  * This is useful for drivers that subclass the atomic state.
54  */
55 void drm_atomic_state_default_release(struct drm_atomic_state *state)
56 {
57         kfree(state->connectors);
58         kfree(state->crtcs);
59         kfree(state->planes);
60 }
61 EXPORT_SYMBOL(drm_atomic_state_default_release);
62
63 /**
64  * drm_atomic_state_init - init new atomic state
65  * @dev: DRM device
66  * @state: atomic state
67  *
68  * Default implementation for filling in a new atomic state.
69  * This is useful for drivers that subclass the atomic state.
70  */
71 int
72 drm_atomic_state_init(struct drm_device *dev, struct drm_atomic_state *state)
73 {
74         kref_init(&state->ref);
75
76         /* TODO legacy paths should maybe do a better job about
77          * setting this appropriately?
78          */
79         state->allow_modeset = true;
80
81         state->crtcs = kcalloc(dev->mode_config.num_crtc,
82                                sizeof(*state->crtcs), GFP_KERNEL);
83         if (!state->crtcs)
84                 goto fail;
85         state->planes = kcalloc(dev->mode_config.num_total_plane,
86                                 sizeof(*state->planes), GFP_KERNEL);
87         if (!state->planes)
88                 goto fail;
89
90         state->dev = dev;
91
92         DRM_DEBUG_ATOMIC("Allocated atomic state %p\n", state);
93
94         return 0;
95 fail:
96         drm_atomic_state_default_release(state);
97         return -ENOMEM;
98 }
99 EXPORT_SYMBOL(drm_atomic_state_init);
100
101 /**
102  * drm_atomic_state_alloc - allocate atomic state
103  * @dev: DRM device
104  *
105  * This allocates an empty atomic state to track updates.
106  */
107 struct drm_atomic_state *
108 drm_atomic_state_alloc(struct drm_device *dev)
109 {
110         struct drm_mode_config *config = &dev->mode_config;
111         struct drm_atomic_state *state;
112
113         if (!config->funcs->atomic_state_alloc) {
114                 state = kzalloc(sizeof(*state), GFP_KERNEL);
115                 if (!state)
116                         return NULL;
117                 if (drm_atomic_state_init(dev, state) < 0) {
118                         kfree(state);
119                         return NULL;
120                 }
121                 return state;
122         }
123
124         return config->funcs->atomic_state_alloc(dev);
125 }
126 EXPORT_SYMBOL(drm_atomic_state_alloc);
127
128 /**
129  * drm_atomic_state_default_clear - clear base atomic state
130  * @state: atomic state
131  *
132  * Default implementation for clearing atomic state.
133  * This is useful for drivers that subclass the atomic state.
134  */
135 void drm_atomic_state_default_clear(struct drm_atomic_state *state)
136 {
137         struct drm_device *dev = state->dev;
138         struct drm_mode_config *config = &dev->mode_config;
139         int i;
140
141         DRM_DEBUG_ATOMIC("Clearing atomic state %p\n", state);
142
143         for (i = 0; i < state->num_connector; i++) {
144                 struct drm_connector *connector = state->connectors[i].ptr;
145
146                 if (!connector)
147                         continue;
148
149                 connector->funcs->atomic_destroy_state(connector,
150                                                        state->connectors[i].state);
151                 state->connectors[i].ptr = NULL;
152                 state->connectors[i].state = NULL;
153                 drm_connector_unreference(connector);
154         }
155
156         for (i = 0; i < config->num_crtc; i++) {
157                 struct drm_crtc *crtc = state->crtcs[i].ptr;
158
159                 if (!crtc)
160                         continue;
161
162                 crtc->funcs->atomic_destroy_state(crtc,
163                                                   state->crtcs[i].state);
164
165                 if (state->crtcs[i].commit) {
166                         kfree(state->crtcs[i].commit->event);
167                         state->crtcs[i].commit->event = NULL;
168                         drm_crtc_commit_put(state->crtcs[i].commit);
169                 }
170
171                 state->crtcs[i].commit = NULL;
172                 state->crtcs[i].ptr = NULL;
173                 state->crtcs[i].state = NULL;
174         }
175
176         for (i = 0; i < config->num_total_plane; i++) {
177                 struct drm_plane *plane = state->planes[i].ptr;
178
179                 if (!plane)
180                         continue;
181
182                 plane->funcs->atomic_destroy_state(plane,
183                                                    state->planes[i].state);
184                 state->planes[i].ptr = NULL;
185                 state->planes[i].state = NULL;
186         }
187 }
188 EXPORT_SYMBOL(drm_atomic_state_default_clear);
189
190 /**
191  * drm_atomic_state_clear - clear state object
192  * @state: atomic state
193  *
194  * When the w/w mutex algorithm detects a deadlock we need to back off and drop
195  * all locks. So someone else could sneak in and change the current modeset
196  * configuration. Which means that all the state assembled in @state is no
197  * longer an atomic update to the current state, but to some arbitrary earlier
198  * state. Which could break assumptions the driver's
199  * &drm_mode_config_funcs.atomic_check likely relies on.
200  *
201  * Hence we must clear all cached state and completely start over, using this
202  * function.
203  */
204 void drm_atomic_state_clear(struct drm_atomic_state *state)
205 {
206         struct drm_device *dev = state->dev;
207         struct drm_mode_config *config = &dev->mode_config;
208
209         if (config->funcs->atomic_state_clear)
210                 config->funcs->atomic_state_clear(state);
211         else
212                 drm_atomic_state_default_clear(state);
213 }
214 EXPORT_SYMBOL(drm_atomic_state_clear);
215
216 /**
217  * __drm_atomic_state_free - free all memory for an atomic state
218  * @ref: This atomic state to deallocate
219  *
220  * This frees all memory associated with an atomic state, including all the
221  * per-object state for planes, crtcs and connectors.
222  */
223 void __drm_atomic_state_free(struct kref *ref)
224 {
225         struct drm_atomic_state *state = container_of(ref, typeof(*state), ref);
226         struct drm_mode_config *config = &state->dev->mode_config;
227
228         drm_atomic_state_clear(state);
229
230         DRM_DEBUG_ATOMIC("Freeing atomic state %p\n", state);
231
232         if (config->funcs->atomic_state_free) {
233                 config->funcs->atomic_state_free(state);
234         } else {
235                 drm_atomic_state_default_release(state);
236                 kfree(state);
237         }
238 }
239 EXPORT_SYMBOL(__drm_atomic_state_free);
240
241 /**
242  * drm_atomic_get_crtc_state - get crtc state
243  * @state: global atomic state object
244  * @crtc: crtc to get state object for
245  *
246  * This function returns the crtc state for the given crtc, allocating it if
247  * needed. It will also grab the relevant crtc lock to make sure that the state
248  * is consistent.
249  *
250  * Returns:
251  *
252  * Either the allocated state or the error code encoded into the pointer. When
253  * the error is EDEADLK then the w/w mutex code has detected a deadlock and the
254  * entire atomic sequence must be restarted. All other errors are fatal.
255  */
256 struct drm_crtc_state *
257 drm_atomic_get_crtc_state(struct drm_atomic_state *state,
258                           struct drm_crtc *crtc)
259 {
260         int ret, index = drm_crtc_index(crtc);
261         struct drm_crtc_state *crtc_state;
262
263         WARN_ON(!state->acquire_ctx);
264
265         crtc_state = drm_atomic_get_existing_crtc_state(state, crtc);
266         if (crtc_state)
267                 return crtc_state;
268
269         ret = drm_modeset_lock(&crtc->mutex, state->acquire_ctx);
270         if (ret)
271                 return ERR_PTR(ret);
272
273         crtc_state = crtc->funcs->atomic_duplicate_state(crtc);
274         if (!crtc_state)
275                 return ERR_PTR(-ENOMEM);
276
277         state->crtcs[index].state = crtc_state;
278         state->crtcs[index].old_state = crtc->state;
279         state->crtcs[index].new_state = crtc_state;
280         state->crtcs[index].ptr = crtc;
281         crtc_state->state = state;
282
283         DRM_DEBUG_ATOMIC("Added [CRTC:%d:%s] %p state to %p\n",
284                          crtc->base.id, crtc->name, crtc_state, state);
285
286         return crtc_state;
287 }
288 EXPORT_SYMBOL(drm_atomic_get_crtc_state);
289
290 static void set_out_fence_for_crtc(struct drm_atomic_state *state,
291                                    struct drm_crtc *crtc, s32 __user *fence_ptr)
292 {
293         state->crtcs[drm_crtc_index(crtc)].out_fence_ptr = fence_ptr;
294 }
295
296 static s32 __user *get_out_fence_for_crtc(struct drm_atomic_state *state,
297                                           struct drm_crtc *crtc)
298 {
299         s32 __user *fence_ptr;
300
301         fence_ptr = state->crtcs[drm_crtc_index(crtc)].out_fence_ptr;
302         state->crtcs[drm_crtc_index(crtc)].out_fence_ptr = NULL;
303
304         return fence_ptr;
305 }
306
307 /**
308  * drm_atomic_set_mode_for_crtc - set mode for CRTC
309  * @state: the CRTC whose incoming state to update
310  * @mode: kernel-internal mode to use for the CRTC, or NULL to disable
311  *
312  * Set a mode (originating from the kernel) on the desired CRTC state and update
313  * the enable property.
314  *
315  * RETURNS:
316  * Zero on success, error code on failure. Cannot return -EDEADLK.
317  */
318 int drm_atomic_set_mode_for_crtc(struct drm_crtc_state *state,
319                                  struct drm_display_mode *mode)
320 {
321         struct drm_mode_modeinfo umode;
322
323         /* Early return for no change. */
324         if (mode && memcmp(&state->mode, mode, sizeof(*mode)) == 0)
325                 return 0;
326
327         drm_property_unreference_blob(state->mode_blob);
328         state->mode_blob = NULL;
329
330         if (mode) {
331                 drm_mode_convert_to_umode(&umode, mode);
332                 state->mode_blob =
333                         drm_property_create_blob(state->crtc->dev,
334                                                  sizeof(umode),
335                                                  &umode);
336                 if (IS_ERR(state->mode_blob))
337                         return PTR_ERR(state->mode_blob);
338
339                 drm_mode_copy(&state->mode, mode);
340                 state->enable = true;
341                 DRM_DEBUG_ATOMIC("Set [MODE:%s] for CRTC state %p\n",
342                                  mode->name, state);
343         } else {
344                 memset(&state->mode, 0, sizeof(state->mode));
345                 state->enable = false;
346                 DRM_DEBUG_ATOMIC("Set [NOMODE] for CRTC state %p\n",
347                                  state);
348         }
349
350         return 0;
351 }
352 EXPORT_SYMBOL(drm_atomic_set_mode_for_crtc);
353
354 /**
355  * drm_atomic_set_mode_prop_for_crtc - set mode for CRTC
356  * @state: the CRTC whose incoming state to update
357  * @blob: pointer to blob property to use for mode
358  *
359  * Set a mode (originating from a blob property) on the desired CRTC state.
360  * This function will take a reference on the blob property for the CRTC state,
361  * and release the reference held on the state's existing mode property, if any
362  * was set.
363  *
364  * RETURNS:
365  * Zero on success, error code on failure. Cannot return -EDEADLK.
366  */
367 int drm_atomic_set_mode_prop_for_crtc(struct drm_crtc_state *state,
368                                       struct drm_property_blob *blob)
369 {
370         if (blob == state->mode_blob)
371                 return 0;
372
373         drm_property_unreference_blob(state->mode_blob);
374         state->mode_blob = NULL;
375
376         memset(&state->mode, 0, sizeof(state->mode));
377
378         if (blob) {
379                 if (blob->length != sizeof(struct drm_mode_modeinfo) ||
380                     drm_mode_convert_umode(&state->mode,
381                                            (const struct drm_mode_modeinfo *)
382                                             blob->data))
383                         return -EINVAL;
384
385                 state->mode_blob = drm_property_reference_blob(blob);
386                 state->enable = true;
387                 DRM_DEBUG_ATOMIC("Set [MODE:%s] for CRTC state %p\n",
388                                  state->mode.name, state);
389         } else {
390                 state->enable = false;
391                 DRM_DEBUG_ATOMIC("Set [NOMODE] for CRTC state %p\n",
392                                  state);
393         }
394
395         return 0;
396 }
397 EXPORT_SYMBOL(drm_atomic_set_mode_prop_for_crtc);
398
399 /**
400  * drm_atomic_replace_property_blob - replace a blob property
401  * @blob: a pointer to the member blob to be replaced
402  * @new_blob: the new blob to replace with
403  * @replaced: whether the blob has been replaced
404  *
405  * RETURNS:
406  * Zero on success, error code on failure
407  */
408 static void
409 drm_atomic_replace_property_blob(struct drm_property_blob **blob,
410                                  struct drm_property_blob *new_blob,
411                                  bool *replaced)
412 {
413         struct drm_property_blob *old_blob = *blob;
414
415         if (old_blob == new_blob)
416                 return;
417
418         drm_property_unreference_blob(old_blob);
419         if (new_blob)
420                 drm_property_reference_blob(new_blob);
421         *blob = new_blob;
422         *replaced = true;
423
424         return;
425 }
426
427 static int
428 drm_atomic_replace_property_blob_from_id(struct drm_crtc *crtc,
429                                          struct drm_property_blob **blob,
430                                          uint64_t blob_id,
431                                          ssize_t expected_size,
432                                          bool *replaced)
433 {
434         struct drm_property_blob *new_blob = NULL;
435
436         if (blob_id != 0) {
437                 new_blob = drm_property_lookup_blob(crtc->dev, blob_id);
438                 if (new_blob == NULL)
439                         return -EINVAL;
440
441                 if (expected_size > 0 && expected_size != new_blob->length) {
442                         drm_property_unreference_blob(new_blob);
443                         return -EINVAL;
444                 }
445         }
446
447         drm_atomic_replace_property_blob(blob, new_blob, replaced);
448         drm_property_unreference_blob(new_blob);
449
450         return 0;
451 }
452
453 /**
454  * drm_atomic_crtc_set_property - set property on CRTC
455  * @crtc: the drm CRTC to set a property on
456  * @state: the state object to update with the new property value
457  * @property: the property to set
458  * @val: the new property value
459  *
460  * This function handles generic/core properties and calls out to driver's
461  * &drm_crtc_funcs.atomic_set_property for driver properties. To ensure
462  * consistent behavior you must call this function rather than the driver hook
463  * directly.
464  *
465  * RETURNS:
466  * Zero on success, error code on failure
467  */
468 int drm_atomic_crtc_set_property(struct drm_crtc *crtc,
469                 struct drm_crtc_state *state, struct drm_property *property,
470                 uint64_t val)
471 {
472         struct drm_device *dev = crtc->dev;
473         struct drm_mode_config *config = &dev->mode_config;
474         bool replaced = false;
475         int ret;
476
477         if (property == config->prop_active)
478                 state->active = val;
479         else if (property == config->prop_mode_id) {
480                 struct drm_property_blob *mode =
481                         drm_property_lookup_blob(dev, val);
482                 ret = drm_atomic_set_mode_prop_for_crtc(state, mode);
483                 drm_property_unreference_blob(mode);
484                 return ret;
485         } else if (property == config->degamma_lut_property) {
486                 ret = drm_atomic_replace_property_blob_from_id(crtc,
487                                         &state->degamma_lut,
488                                         val,
489                                         -1,
490                                         &replaced);
491                 state->color_mgmt_changed |= replaced;
492                 return ret;
493         } else if (property == config->ctm_property) {
494                 ret = drm_atomic_replace_property_blob_from_id(crtc,
495                                         &state->ctm,
496                                         val,
497                                         sizeof(struct drm_color_ctm),
498                                         &replaced);
499                 state->color_mgmt_changed |= replaced;
500                 return ret;
501         } else if (property == config->gamma_lut_property) {
502                 ret = drm_atomic_replace_property_blob_from_id(crtc,
503                                         &state->gamma_lut,
504                                         val,
505                                         -1,
506                                         &replaced);
507                 state->color_mgmt_changed |= replaced;
508                 return ret;
509         } else if (property == config->prop_out_fence_ptr) {
510                 s32 __user *fence_ptr = u64_to_user_ptr(val);
511
512                 if (!fence_ptr)
513                         return 0;
514
515                 if (put_user(-1, fence_ptr))
516                         return -EFAULT;
517
518                 set_out_fence_for_crtc(state->state, crtc, fence_ptr);
519         } else if (crtc->funcs->atomic_set_property)
520                 return crtc->funcs->atomic_set_property(crtc, state, property, val);
521         else
522                 return -EINVAL;
523
524         return 0;
525 }
526 EXPORT_SYMBOL(drm_atomic_crtc_set_property);
527
528 /**
529  * drm_atomic_crtc_get_property - get property value from CRTC state
530  * @crtc: the drm CRTC to set a property on
531  * @state: the state object to get the property value from
532  * @property: the property to set
533  * @val: return location for the property value
534  *
535  * This function handles generic/core properties and calls out to driver's
536  * &drm_crtc_funcs.atomic_get_property for driver properties. To ensure
537  * consistent behavior you must call this function rather than the driver hook
538  * directly.
539  *
540  * RETURNS:
541  * Zero on success, error code on failure
542  */
543 static int
544 drm_atomic_crtc_get_property(struct drm_crtc *crtc,
545                 const struct drm_crtc_state *state,
546                 struct drm_property *property, uint64_t *val)
547 {
548         struct drm_device *dev = crtc->dev;
549         struct drm_mode_config *config = &dev->mode_config;
550
551         if (property == config->prop_active)
552                 *val = state->active;
553         else if (property == config->prop_mode_id)
554                 *val = (state->mode_blob) ? state->mode_blob->base.id : 0;
555         else if (property == config->degamma_lut_property)
556                 *val = (state->degamma_lut) ? state->degamma_lut->base.id : 0;
557         else if (property == config->ctm_property)
558                 *val = (state->ctm) ? state->ctm->base.id : 0;
559         else if (property == config->gamma_lut_property)
560                 *val = (state->gamma_lut) ? state->gamma_lut->base.id : 0;
561         else if (property == config->prop_out_fence_ptr)
562                 *val = 0;
563         else if (crtc->funcs->atomic_get_property)
564                 return crtc->funcs->atomic_get_property(crtc, state, property, val);
565         else
566                 return -EINVAL;
567
568         return 0;
569 }
570
571 /**
572  * drm_atomic_crtc_check - check crtc state
573  * @crtc: crtc to check
574  * @state: crtc state to check
575  *
576  * Provides core sanity checks for crtc state.
577  *
578  * RETURNS:
579  * Zero on success, error code on failure
580  */
581 static int drm_atomic_crtc_check(struct drm_crtc *crtc,
582                 struct drm_crtc_state *state)
583 {
584         /* NOTE: we explicitly don't enforce constraints such as primary
585          * layer covering entire screen, since that is something we want
586          * to allow (on hw that supports it).  For hw that does not, it
587          * should be checked in driver's crtc->atomic_check() vfunc.
588          *
589          * TODO: Add generic modeset state checks once we support those.
590          */
591
592         if (state->active && !state->enable) {
593                 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] active without enabled\n",
594                                  crtc->base.id, crtc->name);
595                 return -EINVAL;
596         }
597
598         /* The state->enable vs. state->mode_blob checks can be WARN_ON,
599          * as this is a kernel-internal detail that userspace should never
600          * be able to trigger. */
601         if (drm_core_check_feature(crtc->dev, DRIVER_ATOMIC) &&
602             WARN_ON(state->enable && !state->mode_blob)) {
603                 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] enabled without mode blob\n",
604                                  crtc->base.id, crtc->name);
605                 return -EINVAL;
606         }
607
608         if (drm_core_check_feature(crtc->dev, DRIVER_ATOMIC) &&
609             WARN_ON(!state->enable && state->mode_blob)) {
610                 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] disabled with mode blob\n",
611                                  crtc->base.id, crtc->name);
612                 return -EINVAL;
613         }
614
615         /*
616          * Reject event generation for when a CRTC is off and stays off.
617          * It wouldn't be hard to implement this, but userspace has a track
618          * record of happily burning through 100% cpu (or worse, crash) when the
619          * display pipe is suspended. To avoid all that fun just reject updates
620          * that ask for events since likely that indicates a bug in the
621          * compositor's drawing loop. This is consistent with the vblank IOCTL
622          * and legacy page_flip IOCTL which also reject service on a disabled
623          * pipe.
624          */
625         if (state->event && !state->active && !crtc->state->active) {
626                 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] requesting event but off\n",
627                                  crtc->base.id, crtc->name);
628                 return -EINVAL;
629         }
630
631         return 0;
632 }
633
634 static void drm_atomic_crtc_print_state(struct drm_printer *p,
635                 const struct drm_crtc_state *state)
636 {
637         struct drm_crtc *crtc = state->crtc;
638
639         drm_printf(p, "crtc[%u]: %s\n", crtc->base.id, crtc->name);
640         drm_printf(p, "\tenable=%d\n", state->enable);
641         drm_printf(p, "\tactive=%d\n", state->active);
642         drm_printf(p, "\tplanes_changed=%d\n", state->planes_changed);
643         drm_printf(p, "\tmode_changed=%d\n", state->mode_changed);
644         drm_printf(p, "\tactive_changed=%d\n", state->active_changed);
645         drm_printf(p, "\tconnectors_changed=%d\n", state->connectors_changed);
646         drm_printf(p, "\tcolor_mgmt_changed=%d\n", state->color_mgmt_changed);
647         drm_printf(p, "\tplane_mask=%x\n", state->plane_mask);
648         drm_printf(p, "\tconnector_mask=%x\n", state->connector_mask);
649         drm_printf(p, "\tencoder_mask=%x\n", state->encoder_mask);
650         drm_printf(p, "\tmode: " DRM_MODE_FMT "\n", DRM_MODE_ARG(&state->mode));
651
652         if (crtc->funcs->atomic_print_state)
653                 crtc->funcs->atomic_print_state(p, state);
654 }
655
656 /**
657  * drm_atomic_get_plane_state - get plane state
658  * @state: global atomic state object
659  * @plane: plane to get state object for
660  *
661  * This function returns the plane state for the given plane, allocating it if
662  * needed. It will also grab the relevant plane lock to make sure that the state
663  * is consistent.
664  *
665  * Returns:
666  *
667  * Either the allocated state or the error code encoded into the pointer. When
668  * the error is EDEADLK then the w/w mutex code has detected a deadlock and the
669  * entire atomic sequence must be restarted. All other errors are fatal.
670  */
671 struct drm_plane_state *
672 drm_atomic_get_plane_state(struct drm_atomic_state *state,
673                           struct drm_plane *plane)
674 {
675         int ret, index = drm_plane_index(plane);
676         struct drm_plane_state *plane_state;
677
678         WARN_ON(!state->acquire_ctx);
679
680         plane_state = drm_atomic_get_existing_plane_state(state, plane);
681         if (plane_state)
682                 return plane_state;
683
684         ret = drm_modeset_lock(&plane->mutex, state->acquire_ctx);
685         if (ret)
686                 return ERR_PTR(ret);
687
688         plane_state = plane->funcs->atomic_duplicate_state(plane);
689         if (!plane_state)
690                 return ERR_PTR(-ENOMEM);
691
692         state->planes[index].state = plane_state;
693         state->planes[index].ptr = plane;
694         state->planes[index].old_state = plane->state;
695         state->planes[index].new_state = plane_state;
696         plane_state->state = state;
697
698         DRM_DEBUG_ATOMIC("Added [PLANE:%d:%s] %p state to %p\n",
699                          plane->base.id, plane->name, plane_state, state);
700
701         if (plane_state->crtc) {
702                 struct drm_crtc_state *crtc_state;
703
704                 crtc_state = drm_atomic_get_crtc_state(state,
705                                                        plane_state->crtc);
706                 if (IS_ERR(crtc_state))
707                         return ERR_CAST(crtc_state);
708         }
709
710         return plane_state;
711 }
712 EXPORT_SYMBOL(drm_atomic_get_plane_state);
713
714 /**
715  * drm_atomic_plane_set_property - set property on plane
716  * @plane: the drm plane to set a property on
717  * @state: the state object to update with the new property value
718  * @property: the property to set
719  * @val: the new property value
720  *
721  * This function handles generic/core properties and calls out to driver's
722  * &drm_plane_funcs.atomic_set_property for driver properties.  To ensure
723  * consistent behavior you must call this function rather than the driver hook
724  * directly.
725  *
726  * RETURNS:
727  * Zero on success, error code on failure
728  */
729 int drm_atomic_plane_set_property(struct drm_plane *plane,
730                 struct drm_plane_state *state, struct drm_property *property,
731                 uint64_t val)
732 {
733         struct drm_device *dev = plane->dev;
734         struct drm_mode_config *config = &dev->mode_config;
735
736         if (property == config->prop_fb_id) {
737                 struct drm_framebuffer *fb = drm_framebuffer_lookup(dev, val);
738                 drm_atomic_set_fb_for_plane(state, fb);
739                 if (fb)
740                         drm_framebuffer_unreference(fb);
741         } else if (property == config->prop_in_fence_fd) {
742                 if (state->fence)
743                         return -EINVAL;
744
745                 if (U642I64(val) == -1)
746                         return 0;
747
748                 state->fence = sync_file_get_fence(val);
749                 if (!state->fence)
750                         return -EINVAL;
751
752         } else if (property == config->prop_crtc_id) {
753                 struct drm_crtc *crtc = drm_crtc_find(dev, val);
754                 return drm_atomic_set_crtc_for_plane(state, crtc);
755         } else if (property == config->prop_crtc_x) {
756                 state->crtc_x = U642I64(val);
757         } else if (property == config->prop_crtc_y) {
758                 state->crtc_y = U642I64(val);
759         } else if (property == config->prop_crtc_w) {
760                 state->crtc_w = val;
761         } else if (property == config->prop_crtc_h) {
762                 state->crtc_h = val;
763         } else if (property == config->prop_src_x) {
764                 state->src_x = val;
765         } else if (property == config->prop_src_y) {
766                 state->src_y = val;
767         } else if (property == config->prop_src_w) {
768                 state->src_w = val;
769         } else if (property == config->prop_src_h) {
770                 state->src_h = val;
771         } else if (property == plane->rotation_property) {
772                 if (!is_power_of_2(val & DRM_ROTATE_MASK))
773                         return -EINVAL;
774                 state->rotation = val;
775         } else if (property == plane->zpos_property) {
776                 state->zpos = val;
777         } else if (plane->funcs->atomic_set_property) {
778                 return plane->funcs->atomic_set_property(plane, state,
779                                 property, val);
780         } else {
781                 return -EINVAL;
782         }
783
784         return 0;
785 }
786 EXPORT_SYMBOL(drm_atomic_plane_set_property);
787
788 /**
789  * drm_atomic_plane_get_property - get property value from plane state
790  * @plane: the drm plane to set a property on
791  * @state: the state object to get the property value from
792  * @property: the property to set
793  * @val: return location for the property value
794  *
795  * This function handles generic/core properties and calls out to driver's
796  * &drm_plane_funcs.atomic_get_property for driver properties.  To ensure
797  * consistent behavior you must call this function rather than the driver hook
798  * directly.
799  *
800  * RETURNS:
801  * Zero on success, error code on failure
802  */
803 static int
804 drm_atomic_plane_get_property(struct drm_plane *plane,
805                 const struct drm_plane_state *state,
806                 struct drm_property *property, uint64_t *val)
807 {
808         struct drm_device *dev = plane->dev;
809         struct drm_mode_config *config = &dev->mode_config;
810
811         if (property == config->prop_fb_id) {
812                 *val = (state->fb) ? state->fb->base.id : 0;
813         } else if (property == config->prop_in_fence_fd) {
814                 *val = -1;
815         } else if (property == config->prop_crtc_id) {
816                 *val = (state->crtc) ? state->crtc->base.id : 0;
817         } else if (property == config->prop_crtc_x) {
818                 *val = I642U64(state->crtc_x);
819         } else if (property == config->prop_crtc_y) {
820                 *val = I642U64(state->crtc_y);
821         } else if (property == config->prop_crtc_w) {
822                 *val = state->crtc_w;
823         } else if (property == config->prop_crtc_h) {
824                 *val = state->crtc_h;
825         } else if (property == config->prop_src_x) {
826                 *val = state->src_x;
827         } else if (property == config->prop_src_y) {
828                 *val = state->src_y;
829         } else if (property == config->prop_src_w) {
830                 *val = state->src_w;
831         } else if (property == config->prop_src_h) {
832                 *val = state->src_h;
833         } else if (property == plane->rotation_property) {
834                 *val = state->rotation;
835         } else if (property == plane->zpos_property) {
836                 *val = state->zpos;
837         } else if (plane->funcs->atomic_get_property) {
838                 return plane->funcs->atomic_get_property(plane, state, property, val);
839         } else {
840                 return -EINVAL;
841         }
842
843         return 0;
844 }
845
846 static bool
847 plane_switching_crtc(struct drm_atomic_state *state,
848                      struct drm_plane *plane,
849                      struct drm_plane_state *plane_state)
850 {
851         if (!plane->state->crtc || !plane_state->crtc)
852                 return false;
853
854         if (plane->state->crtc == plane_state->crtc)
855                 return false;
856
857         /* This could be refined, but currently there's no helper or driver code
858          * to implement direct switching of active planes nor userspace to take
859          * advantage of more direct plane switching without the intermediate
860          * full OFF state.
861          */
862         return true;
863 }
864
865 /**
866  * drm_atomic_plane_check - check plane state
867  * @plane: plane to check
868  * @state: plane state to check
869  *
870  * Provides core sanity checks for plane state.
871  *
872  * RETURNS:
873  * Zero on success, error code on failure
874  */
875 static int drm_atomic_plane_check(struct drm_plane *plane,
876                 struct drm_plane_state *state)
877 {
878         unsigned int fb_width, fb_height;
879         int ret;
880
881         /* either *both* CRTC and FB must be set, or neither */
882         if (WARN_ON(state->crtc && !state->fb)) {
883                 DRM_DEBUG_ATOMIC("CRTC set but no FB\n");
884                 return -EINVAL;
885         } else if (WARN_ON(state->fb && !state->crtc)) {
886                 DRM_DEBUG_ATOMIC("FB set but no CRTC\n");
887                 return -EINVAL;
888         }
889
890         /* if disabled, we don't care about the rest of the state: */
891         if (!state->crtc)
892                 return 0;
893
894         /* Check whether this plane is usable on this CRTC */
895         if (!(plane->possible_crtcs & drm_crtc_mask(state->crtc))) {
896                 DRM_DEBUG_ATOMIC("Invalid crtc for plane\n");
897                 return -EINVAL;
898         }
899
900         /* Check whether this plane supports the fb pixel format. */
901         ret = drm_plane_check_pixel_format(plane, state->fb->format->format);
902         if (ret) {
903                 struct drm_format_name_buf format_name;
904                 DRM_DEBUG_ATOMIC("Invalid pixel format %s\n",
905                                  drm_get_format_name(state->fb->format->format,
906                                                      &format_name));
907                 return ret;
908         }
909
910         /* Give drivers some help against integer overflows */
911         if (state->crtc_w > INT_MAX ||
912             state->crtc_x > INT_MAX - (int32_t) state->crtc_w ||
913             state->crtc_h > INT_MAX ||
914             state->crtc_y > INT_MAX - (int32_t) state->crtc_h) {
915                 DRM_DEBUG_ATOMIC("Invalid CRTC coordinates %ux%u+%d+%d\n",
916                                  state->crtc_w, state->crtc_h,
917                                  state->crtc_x, state->crtc_y);
918                 return -ERANGE;
919         }
920
921         fb_width = state->fb->width << 16;
922         fb_height = state->fb->height << 16;
923
924         /* Make sure source coordinates are inside the fb. */
925         if (state->src_w > fb_width ||
926             state->src_x > fb_width - state->src_w ||
927             state->src_h > fb_height ||
928             state->src_y > fb_height - state->src_h) {
929                 DRM_DEBUG_ATOMIC("Invalid source coordinates "
930                                  "%u.%06ux%u.%06u+%u.%06u+%u.%06u\n",
931                                  state->src_w >> 16, ((state->src_w & 0xffff) * 15625) >> 10,
932                                  state->src_h >> 16, ((state->src_h & 0xffff) * 15625) >> 10,
933                                  state->src_x >> 16, ((state->src_x & 0xffff) * 15625) >> 10,
934                                  state->src_y >> 16, ((state->src_y & 0xffff) * 15625) >> 10);
935                 return -ENOSPC;
936         }
937
938         if (plane_switching_crtc(state->state, plane, state)) {
939                 DRM_DEBUG_ATOMIC("[PLANE:%d:%s] switching CRTC directly\n",
940                                  plane->base.id, plane->name);
941                 return -EINVAL;
942         }
943
944         return 0;
945 }
946
947 static void drm_atomic_plane_print_state(struct drm_printer *p,
948                 const struct drm_plane_state *state)
949 {
950         struct drm_plane *plane = state->plane;
951         struct drm_rect src  = drm_plane_state_src(state);
952         struct drm_rect dest = drm_plane_state_dest(state);
953
954         drm_printf(p, "plane[%u]: %s\n", plane->base.id, plane->name);
955         drm_printf(p, "\tcrtc=%s\n", state->crtc ? state->crtc->name : "(null)");
956         drm_printf(p, "\tfb=%u\n", state->fb ? state->fb->base.id : 0);
957         if (state->fb) {
958                 struct drm_framebuffer *fb = state->fb;
959                 int i, n = fb->format->num_planes;
960                 struct drm_format_name_buf format_name;
961
962                 drm_printf(p, "\t\tformat=%s\n",
963                               drm_get_format_name(fb->format->format, &format_name));
964                 drm_printf(p, "\t\t\tmodifier=0x%llx\n", fb->modifier);
965                 drm_printf(p, "\t\tsize=%dx%d\n", fb->width, fb->height);
966                 drm_printf(p, "\t\tlayers:\n");
967                 for (i = 0; i < n; i++) {
968                         drm_printf(p, "\t\t\tpitch[%d]=%u\n", i, fb->pitches[i]);
969                         drm_printf(p, "\t\t\toffset[%d]=%u\n", i, fb->offsets[i]);
970                 }
971         }
972         drm_printf(p, "\tcrtc-pos=" DRM_RECT_FMT "\n", DRM_RECT_ARG(&dest));
973         drm_printf(p, "\tsrc-pos=" DRM_RECT_FP_FMT "\n", DRM_RECT_FP_ARG(&src));
974         drm_printf(p, "\trotation=%x\n", state->rotation);
975
976         if (plane->funcs->atomic_print_state)
977                 plane->funcs->atomic_print_state(p, state);
978 }
979
980 /**
981  * drm_atomic_get_connector_state - get connector state
982  * @state: global atomic state object
983  * @connector: connector to get state object for
984  *
985  * This function returns the connector state for the given connector,
986  * allocating it if needed. It will also grab the relevant connector lock to
987  * make sure that the state is consistent.
988  *
989  * Returns:
990  *
991  * Either the allocated state or the error code encoded into the pointer. When
992  * the error is EDEADLK then the w/w mutex code has detected a deadlock and the
993  * entire atomic sequence must be restarted. All other errors are fatal.
994  */
995 struct drm_connector_state *
996 drm_atomic_get_connector_state(struct drm_atomic_state *state,
997                           struct drm_connector *connector)
998 {
999         int ret, index;
1000         struct drm_mode_config *config = &connector->dev->mode_config;
1001         struct drm_connector_state *connector_state;
1002
1003         WARN_ON(!state->acquire_ctx);
1004
1005         ret = drm_modeset_lock(&config->connection_mutex, state->acquire_ctx);
1006         if (ret)
1007                 return ERR_PTR(ret);
1008
1009         index = drm_connector_index(connector);
1010
1011         if (index >= state->num_connector) {
1012                 struct __drm_connnectors_state *c;
1013                 int alloc = max(index + 1, config->num_connector);
1014
1015                 c = krealloc(state->connectors, alloc * sizeof(*state->connectors), GFP_KERNEL);
1016                 if (!c)
1017                         return ERR_PTR(-ENOMEM);
1018
1019                 state->connectors = c;
1020                 memset(&state->connectors[state->num_connector], 0,
1021                        sizeof(*state->connectors) * (alloc - state->num_connector));
1022
1023                 state->num_connector = alloc;
1024         }
1025
1026         if (state->connectors[index].state)
1027                 return state->connectors[index].state;
1028
1029         connector_state = connector->funcs->atomic_duplicate_state(connector);
1030         if (!connector_state)
1031                 return ERR_PTR(-ENOMEM);
1032
1033         drm_connector_reference(connector);
1034         state->connectors[index].state = connector_state;
1035         state->connectors[index].old_state = connector->state;
1036         state->connectors[index].new_state = connector_state;
1037         state->connectors[index].ptr = connector;
1038         connector_state->state = state;
1039
1040         DRM_DEBUG_ATOMIC("Added [CONNECTOR:%d:%s] %p state to %p\n",
1041                          connector->base.id, connector->name,
1042                          connector_state, state);
1043
1044         if (connector_state->crtc) {
1045                 struct drm_crtc_state *crtc_state;
1046
1047                 crtc_state = drm_atomic_get_crtc_state(state,
1048                                                        connector_state->crtc);
1049                 if (IS_ERR(crtc_state))
1050                         return ERR_CAST(crtc_state);
1051         }
1052
1053         return connector_state;
1054 }
1055 EXPORT_SYMBOL(drm_atomic_get_connector_state);
1056
1057 /**
1058  * drm_atomic_connector_set_property - set property on connector.
1059  * @connector: the drm connector to set a property on
1060  * @state: the state object to update with the new property value
1061  * @property: the property to set
1062  * @val: the new property value
1063  *
1064  * This function handles generic/core properties and calls out to driver's
1065  * &drm_connector_funcs.atomic_set_property for driver properties.  To ensure
1066  * consistent behavior you must call this function rather than the driver hook
1067  * directly.
1068  *
1069  * RETURNS:
1070  * Zero on success, error code on failure
1071  */
1072 int drm_atomic_connector_set_property(struct drm_connector *connector,
1073                 struct drm_connector_state *state, struct drm_property *property,
1074                 uint64_t val)
1075 {
1076         struct drm_device *dev = connector->dev;
1077         struct drm_mode_config *config = &dev->mode_config;
1078
1079         if (property == config->prop_crtc_id) {
1080                 struct drm_crtc *crtc = drm_crtc_find(dev, val);
1081                 return drm_atomic_set_crtc_for_connector(state, crtc);
1082         } else if (property == config->dpms_property) {
1083                 /* setting DPMS property requires special handling, which
1084                  * is done in legacy setprop path for us.  Disallow (for
1085                  * now?) atomic writes to DPMS property:
1086                  */
1087                 return -EINVAL;
1088         } else if (property == config->tv_select_subconnector_property) {
1089                 state->tv.subconnector = val;
1090         } else if (property == config->tv_left_margin_property) {
1091                 state->tv.margins.left = val;
1092         } else if (property == config->tv_right_margin_property) {
1093                 state->tv.margins.right = val;
1094         } else if (property == config->tv_top_margin_property) {
1095                 state->tv.margins.top = val;
1096         } else if (property == config->tv_bottom_margin_property) {
1097                 state->tv.margins.bottom = val;
1098         } else if (property == config->tv_mode_property) {
1099                 state->tv.mode = val;
1100         } else if (property == config->tv_brightness_property) {
1101                 state->tv.brightness = val;
1102         } else if (property == config->tv_contrast_property) {
1103                 state->tv.contrast = val;
1104         } else if (property == config->tv_flicker_reduction_property) {
1105                 state->tv.flicker_reduction = val;
1106         } else if (property == config->tv_overscan_property) {
1107                 state->tv.overscan = val;
1108         } else if (property == config->tv_saturation_property) {
1109                 state->tv.saturation = val;
1110         } else if (property == config->tv_hue_property) {
1111                 state->tv.hue = val;
1112         } else if (connector->funcs->atomic_set_property) {
1113                 return connector->funcs->atomic_set_property(connector,
1114                                 state, property, val);
1115         } else {
1116                 return -EINVAL;
1117         }
1118
1119         return 0;
1120 }
1121 EXPORT_SYMBOL(drm_atomic_connector_set_property);
1122
1123 static void drm_atomic_connector_print_state(struct drm_printer *p,
1124                 const struct drm_connector_state *state)
1125 {
1126         struct drm_connector *connector = state->connector;
1127
1128         drm_printf(p, "connector[%u]: %s\n", connector->base.id, connector->name);
1129         drm_printf(p, "\tcrtc=%s\n", state->crtc ? state->crtc->name : "(null)");
1130
1131         if (connector->funcs->atomic_print_state)
1132                 connector->funcs->atomic_print_state(p, state);
1133 }
1134
1135 /**
1136  * drm_atomic_connector_get_property - get property value from connector state
1137  * @connector: the drm connector to set a property on
1138  * @state: the state object to get the property value from
1139  * @property: the property to set
1140  * @val: return location for the property value
1141  *
1142  * This function handles generic/core properties and calls out to driver's
1143  * &drm_connector_funcs.atomic_get_property for driver properties.  To ensure
1144  * consistent behavior you must call this function rather than the driver hook
1145  * directly.
1146  *
1147  * RETURNS:
1148  * Zero on success, error code on failure
1149  */
1150 static int
1151 drm_atomic_connector_get_property(struct drm_connector *connector,
1152                 const struct drm_connector_state *state,
1153                 struct drm_property *property, uint64_t *val)
1154 {
1155         struct drm_device *dev = connector->dev;
1156         struct drm_mode_config *config = &dev->mode_config;
1157
1158         if (property == config->prop_crtc_id) {
1159                 *val = (state->crtc) ? state->crtc->base.id : 0;
1160         } else if (property == config->dpms_property) {
1161                 *val = connector->dpms;
1162         } else if (property == config->tv_select_subconnector_property) {
1163                 *val = state->tv.subconnector;
1164         } else if (property == config->tv_left_margin_property) {
1165                 *val = state->tv.margins.left;
1166         } else if (property == config->tv_right_margin_property) {
1167                 *val = state->tv.margins.right;
1168         } else if (property == config->tv_top_margin_property) {
1169                 *val = state->tv.margins.top;
1170         } else if (property == config->tv_bottom_margin_property) {
1171                 *val = state->tv.margins.bottom;
1172         } else if (property == config->tv_mode_property) {
1173                 *val = state->tv.mode;
1174         } else if (property == config->tv_brightness_property) {
1175                 *val = state->tv.brightness;
1176         } else if (property == config->tv_contrast_property) {
1177                 *val = state->tv.contrast;
1178         } else if (property == config->tv_flicker_reduction_property) {
1179                 *val = state->tv.flicker_reduction;
1180         } else if (property == config->tv_overscan_property) {
1181                 *val = state->tv.overscan;
1182         } else if (property == config->tv_saturation_property) {
1183                 *val = state->tv.saturation;
1184         } else if (property == config->tv_hue_property) {
1185                 *val = state->tv.hue;
1186         } else if (connector->funcs->atomic_get_property) {
1187                 return connector->funcs->atomic_get_property(connector,
1188                                 state, property, val);
1189         } else {
1190                 return -EINVAL;
1191         }
1192
1193         return 0;
1194 }
1195
1196 int drm_atomic_get_property(struct drm_mode_object *obj,
1197                 struct drm_property *property, uint64_t *val)
1198 {
1199         struct drm_device *dev = property->dev;
1200         int ret;
1201
1202         switch (obj->type) {
1203         case DRM_MODE_OBJECT_CONNECTOR: {
1204                 struct drm_connector *connector = obj_to_connector(obj);
1205                 WARN_ON(!drm_modeset_is_locked(&dev->mode_config.connection_mutex));
1206                 ret = drm_atomic_connector_get_property(connector,
1207                                 connector->state, property, val);
1208                 break;
1209         }
1210         case DRM_MODE_OBJECT_CRTC: {
1211                 struct drm_crtc *crtc = obj_to_crtc(obj);
1212                 WARN_ON(!drm_modeset_is_locked(&crtc->mutex));
1213                 ret = drm_atomic_crtc_get_property(crtc,
1214                                 crtc->state, property, val);
1215                 break;
1216         }
1217         case DRM_MODE_OBJECT_PLANE: {
1218                 struct drm_plane *plane = obj_to_plane(obj);
1219                 WARN_ON(!drm_modeset_is_locked(&plane->mutex));
1220                 ret = drm_atomic_plane_get_property(plane,
1221                                 plane->state, property, val);
1222                 break;
1223         }
1224         default:
1225                 ret = -EINVAL;
1226                 break;
1227         }
1228
1229         return ret;
1230 }
1231
1232 /**
1233  * drm_atomic_set_crtc_for_plane - set crtc for plane
1234  * @plane_state: the plane whose incoming state to update
1235  * @crtc: crtc to use for the plane
1236  *
1237  * Changing the assigned crtc for a plane requires us to grab the lock and state
1238  * for the new crtc, as needed. This function takes care of all these details
1239  * besides updating the pointer in the state object itself.
1240  *
1241  * Returns:
1242  * 0 on success or can fail with -EDEADLK or -ENOMEM. When the error is EDEADLK
1243  * then the w/w mutex code has detected a deadlock and the entire atomic
1244  * sequence must be restarted. All other errors are fatal.
1245  */
1246 int
1247 drm_atomic_set_crtc_for_plane(struct drm_plane_state *plane_state,
1248                               struct drm_crtc *crtc)
1249 {
1250         struct drm_plane *plane = plane_state->plane;
1251         struct drm_crtc_state *crtc_state;
1252
1253         if (plane_state->crtc) {
1254                 crtc_state = drm_atomic_get_crtc_state(plane_state->state,
1255                                                        plane_state->crtc);
1256                 if (WARN_ON(IS_ERR(crtc_state)))
1257                         return PTR_ERR(crtc_state);
1258
1259                 crtc_state->plane_mask &= ~(1 << drm_plane_index(plane));
1260         }
1261
1262         plane_state->crtc = crtc;
1263
1264         if (crtc) {
1265                 crtc_state = drm_atomic_get_crtc_state(plane_state->state,
1266                                                        crtc);
1267                 if (IS_ERR(crtc_state))
1268                         return PTR_ERR(crtc_state);
1269                 crtc_state->plane_mask |= (1 << drm_plane_index(plane));
1270         }
1271
1272         if (crtc)
1273                 DRM_DEBUG_ATOMIC("Link plane state %p to [CRTC:%d:%s]\n",
1274                                  plane_state, crtc->base.id, crtc->name);
1275         else
1276                 DRM_DEBUG_ATOMIC("Link plane state %p to [NOCRTC]\n",
1277                                  plane_state);
1278
1279         return 0;
1280 }
1281 EXPORT_SYMBOL(drm_atomic_set_crtc_for_plane);
1282
1283 /**
1284  * drm_atomic_set_fb_for_plane - set framebuffer for plane
1285  * @plane_state: atomic state object for the plane
1286  * @fb: fb to use for the plane
1287  *
1288  * Changing the assigned framebuffer for a plane requires us to grab a reference
1289  * to the new fb and drop the reference to the old fb, if there is one. This
1290  * function takes care of all these details besides updating the pointer in the
1291  * state object itself.
1292  */
1293 void
1294 drm_atomic_set_fb_for_plane(struct drm_plane_state *plane_state,
1295                             struct drm_framebuffer *fb)
1296 {
1297         if (fb)
1298                 DRM_DEBUG_ATOMIC("Set [FB:%d] for plane state %p\n",
1299                                  fb->base.id, plane_state);
1300         else
1301                 DRM_DEBUG_ATOMIC("Set [NOFB] for plane state %p\n",
1302                                  plane_state);
1303
1304         drm_framebuffer_assign(&plane_state->fb, fb);
1305 }
1306 EXPORT_SYMBOL(drm_atomic_set_fb_for_plane);
1307
1308 /**
1309  * drm_atomic_set_fence_for_plane - set fence for plane
1310  * @plane_state: atomic state object for the plane
1311  * @fence: dma_fence to use for the plane
1312  *
1313  * Helper to setup the plane_state fence in case it is not set yet.
1314  * By using this drivers doesn't need to worry if the user choose
1315  * implicit or explicit fencing.
1316  *
1317  * This function will not set the fence to the state if it was set
1318  * via explicit fencing interfaces on the atomic ioctl. In that case it will
1319  * drop the reference to the fence as we are not storing it anywhere.
1320  * Otherwise, if &drm_plane_state.fence is not set this function we just set it
1321  * with the received implicit fence. In both cases this function consumes a
1322  * reference for @fence.
1323  */
1324 void
1325 drm_atomic_set_fence_for_plane(struct drm_plane_state *plane_state,
1326                                struct dma_fence *fence)
1327 {
1328         if (plane_state->fence) {
1329                 dma_fence_put(fence);
1330                 return;
1331         }
1332
1333         plane_state->fence = fence;
1334 }
1335 EXPORT_SYMBOL(drm_atomic_set_fence_for_plane);
1336
1337 /**
1338  * drm_atomic_set_crtc_for_connector - set crtc for connector
1339  * @conn_state: atomic state object for the connector
1340  * @crtc: crtc to use for the connector
1341  *
1342  * Changing the assigned crtc for a connector requires us to grab the lock and
1343  * state for the new crtc, as needed. This function takes care of all these
1344  * details besides updating the pointer in the state object itself.
1345  *
1346  * Returns:
1347  * 0 on success or can fail with -EDEADLK or -ENOMEM. When the error is EDEADLK
1348  * then the w/w mutex code has detected a deadlock and the entire atomic
1349  * sequence must be restarted. All other errors are fatal.
1350  */
1351 int
1352 drm_atomic_set_crtc_for_connector(struct drm_connector_state *conn_state,
1353                                   struct drm_crtc *crtc)
1354 {
1355         struct drm_crtc_state *crtc_state;
1356
1357         if (conn_state->crtc == crtc)
1358                 return 0;
1359
1360         if (conn_state->crtc) {
1361                 crtc_state = drm_atomic_get_existing_crtc_state(conn_state->state,
1362                                                                 conn_state->crtc);
1363
1364                 crtc_state->connector_mask &=
1365                         ~(1 << drm_connector_index(conn_state->connector));
1366
1367                 drm_connector_unreference(conn_state->connector);
1368                 conn_state->crtc = NULL;
1369         }
1370
1371         if (crtc) {
1372                 crtc_state = drm_atomic_get_crtc_state(conn_state->state, crtc);
1373                 if (IS_ERR(crtc_state))
1374                         return PTR_ERR(crtc_state);
1375
1376                 crtc_state->connector_mask |=
1377                         1 << drm_connector_index(conn_state->connector);
1378
1379                 drm_connector_reference(conn_state->connector);
1380                 conn_state->crtc = crtc;
1381
1382                 DRM_DEBUG_ATOMIC("Link connector state %p to [CRTC:%d:%s]\n",
1383                                  conn_state, crtc->base.id, crtc->name);
1384         } else {
1385                 DRM_DEBUG_ATOMIC("Link connector state %p to [NOCRTC]\n",
1386                                  conn_state);
1387         }
1388
1389         return 0;
1390 }
1391 EXPORT_SYMBOL(drm_atomic_set_crtc_for_connector);
1392
1393 /**
1394  * drm_atomic_add_affected_connectors - add connectors for crtc
1395  * @state: atomic state
1396  * @crtc: DRM crtc
1397  *
1398  * This function walks the current configuration and adds all connectors
1399  * currently using @crtc to the atomic configuration @state. Note that this
1400  * function must acquire the connection mutex. This can potentially cause
1401  * unneeded seralization if the update is just for the planes on one crtc. Hence
1402  * drivers and helpers should only call this when really needed (e.g. when a
1403  * full modeset needs to happen due to some change).
1404  *
1405  * Returns:
1406  * 0 on success or can fail with -EDEADLK or -ENOMEM. When the error is EDEADLK
1407  * then the w/w mutex code has detected a deadlock and the entire atomic
1408  * sequence must be restarted. All other errors are fatal.
1409  */
1410 int
1411 drm_atomic_add_affected_connectors(struct drm_atomic_state *state,
1412                                    struct drm_crtc *crtc)
1413 {
1414         struct drm_mode_config *config = &state->dev->mode_config;
1415         struct drm_connector *connector;
1416         struct drm_connector_state *conn_state;
1417         struct drm_connector_list_iter conn_iter;
1418         struct drm_crtc_state *crtc_state;
1419         int ret;
1420
1421         crtc_state = drm_atomic_get_crtc_state(state, crtc);
1422         if (IS_ERR(crtc_state))
1423                 return PTR_ERR(crtc_state);
1424
1425         ret = drm_modeset_lock(&config->connection_mutex, state->acquire_ctx);
1426         if (ret)
1427                 return ret;
1428
1429         DRM_DEBUG_ATOMIC("Adding all current connectors for [CRTC:%d:%s] to %p\n",
1430                          crtc->base.id, crtc->name, state);
1431
1432         /*
1433          * Changed connectors are already in @state, so only need to look
1434          * at the connector_mask in crtc_state.
1435          */
1436         drm_connector_list_iter_get(state->dev, &conn_iter);
1437         drm_for_each_connector_iter(connector, &conn_iter) {
1438                 if (!(crtc_state->connector_mask & (1 << drm_connector_index(connector))))
1439                         continue;
1440
1441                 conn_state = drm_atomic_get_connector_state(state, connector);
1442                 if (IS_ERR(conn_state)) {
1443                         drm_connector_list_iter_put(&conn_iter);
1444                         return PTR_ERR(conn_state);
1445                 }
1446         }
1447         drm_connector_list_iter_put(&conn_iter);
1448
1449         return 0;
1450 }
1451 EXPORT_SYMBOL(drm_atomic_add_affected_connectors);
1452
1453 /**
1454  * drm_atomic_add_affected_planes - add planes for crtc
1455  * @state: atomic state
1456  * @crtc: DRM crtc
1457  *
1458  * This function walks the current configuration and adds all planes
1459  * currently used by @crtc to the atomic configuration @state. This is useful
1460  * when an atomic commit also needs to check all currently enabled plane on
1461  * @crtc, e.g. when changing the mode. It's also useful when re-enabling a CRTC
1462  * to avoid special code to force-enable all planes.
1463  *
1464  * Since acquiring a plane state will always also acquire the w/w mutex of the
1465  * current CRTC for that plane (if there is any) adding all the plane states for
1466  * a CRTC will not reduce parallism of atomic updates.
1467  *
1468  * Returns:
1469  * 0 on success or can fail with -EDEADLK or -ENOMEM. When the error is EDEADLK
1470  * then the w/w mutex code has detected a deadlock and the entire atomic
1471  * sequence must be restarted. All other errors are fatal.
1472  */
1473 int
1474 drm_atomic_add_affected_planes(struct drm_atomic_state *state,
1475                                struct drm_crtc *crtc)
1476 {
1477         struct drm_plane *plane;
1478
1479         WARN_ON(!drm_atomic_get_existing_crtc_state(state, crtc));
1480
1481         drm_for_each_plane_mask(plane, state->dev, crtc->state->plane_mask) {
1482                 struct drm_plane_state *plane_state =
1483                         drm_atomic_get_plane_state(state, plane);
1484
1485                 if (IS_ERR(plane_state))
1486                         return PTR_ERR(plane_state);
1487         }
1488         return 0;
1489 }
1490 EXPORT_SYMBOL(drm_atomic_add_affected_planes);
1491
1492 /**
1493  * drm_atomic_legacy_backoff - locking backoff for legacy ioctls
1494  * @state: atomic state
1495  *
1496  * This function should be used by legacy entry points which don't understand
1497  * -EDEADLK semantics. For simplicity this one will grab all modeset locks after
1498  * the slowpath completed.
1499  */
1500 void drm_atomic_legacy_backoff(struct drm_atomic_state *state)
1501 {
1502         struct drm_device *dev = state->dev;
1503         unsigned crtc_mask = 0;
1504         struct drm_crtc *crtc;
1505         int ret;
1506         bool global = false;
1507
1508         drm_for_each_crtc(crtc, dev) {
1509                 if (crtc->acquire_ctx != state->acquire_ctx)
1510                         continue;
1511
1512                 crtc_mask |= drm_crtc_mask(crtc);
1513                 crtc->acquire_ctx = NULL;
1514         }
1515
1516         if (WARN_ON(dev->mode_config.acquire_ctx == state->acquire_ctx)) {
1517                 global = true;
1518
1519                 dev->mode_config.acquire_ctx = NULL;
1520         }
1521
1522 retry:
1523         drm_modeset_backoff(state->acquire_ctx);
1524
1525         ret = drm_modeset_lock_all_ctx(dev, state->acquire_ctx);
1526         if (ret)
1527                 goto retry;
1528
1529         drm_for_each_crtc(crtc, dev)
1530                 if (drm_crtc_mask(crtc) & crtc_mask)
1531                         crtc->acquire_ctx = state->acquire_ctx;
1532
1533         if (global)
1534                 dev->mode_config.acquire_ctx = state->acquire_ctx;
1535 }
1536 EXPORT_SYMBOL(drm_atomic_legacy_backoff);
1537
1538 /**
1539  * drm_atomic_check_only - check whether a given config would work
1540  * @state: atomic configuration to check
1541  *
1542  * Note that this function can return -EDEADLK if the driver needed to acquire
1543  * more locks but encountered a deadlock. The caller must then do the usual w/w
1544  * backoff dance and restart. All other errors are fatal.
1545  *
1546  * Returns:
1547  * 0 on success, negative error code on failure.
1548  */
1549 int drm_atomic_check_only(struct drm_atomic_state *state)
1550 {
1551         struct drm_device *dev = state->dev;
1552         struct drm_mode_config *config = &dev->mode_config;
1553         struct drm_plane *plane;
1554         struct drm_plane_state *plane_state;
1555         struct drm_crtc *crtc;
1556         struct drm_crtc_state *crtc_state;
1557         int i, ret = 0;
1558
1559         DRM_DEBUG_ATOMIC("checking %p\n", state);
1560
1561         for_each_new_plane_in_state(state, plane, plane_state, i) {
1562                 ret = drm_atomic_plane_check(plane, plane_state);
1563                 if (ret) {
1564                         DRM_DEBUG_ATOMIC("[PLANE:%d:%s] atomic core check failed\n",
1565                                          plane->base.id, plane->name);
1566                         return ret;
1567                 }
1568         }
1569
1570         for_each_new_crtc_in_state(state, crtc, crtc_state, i) {
1571                 ret = drm_atomic_crtc_check(crtc, crtc_state);
1572                 if (ret) {
1573                         DRM_DEBUG_ATOMIC("[CRTC:%d:%s] atomic core check failed\n",
1574                                          crtc->base.id, crtc->name);
1575                         return ret;
1576                 }
1577         }
1578
1579         if (config->funcs->atomic_check)
1580                 ret = config->funcs->atomic_check(state->dev, state);
1581
1582         if (!state->allow_modeset) {
1583                 for_each_new_crtc_in_state(state, crtc, crtc_state, i) {
1584                         if (drm_atomic_crtc_needs_modeset(crtc_state)) {
1585                                 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] requires full modeset\n",
1586                                                  crtc->base.id, crtc->name);
1587                                 return -EINVAL;
1588                         }
1589                 }
1590         }
1591
1592         return ret;
1593 }
1594 EXPORT_SYMBOL(drm_atomic_check_only);
1595
1596 /**
1597  * drm_atomic_commit - commit configuration atomically
1598  * @state: atomic configuration to check
1599  *
1600  * Note that this function can return -EDEADLK if the driver needed to acquire
1601  * more locks but encountered a deadlock. The caller must then do the usual w/w
1602  * backoff dance and restart. All other errors are fatal.
1603  *
1604  * This function will take its own reference on @state.
1605  * Callers should always release their reference with drm_atomic_state_put().
1606  *
1607  * Returns:
1608  * 0 on success, negative error code on failure.
1609  */
1610 int drm_atomic_commit(struct drm_atomic_state *state)
1611 {
1612         struct drm_mode_config *config = &state->dev->mode_config;
1613         int ret;
1614
1615         ret = drm_atomic_check_only(state);
1616         if (ret)
1617                 return ret;
1618
1619         DRM_DEBUG_ATOMIC("commiting %p\n", state);
1620
1621         return config->funcs->atomic_commit(state->dev, state, false);
1622 }
1623 EXPORT_SYMBOL(drm_atomic_commit);
1624
1625 /**
1626  * drm_atomic_nonblocking_commit - atomic nonblocking commit
1627  * @state: atomic configuration to check
1628  *
1629  * Note that this function can return -EDEADLK if the driver needed to acquire
1630  * more locks but encountered a deadlock. The caller must then do the usual w/w
1631  * backoff dance and restart. All other errors are fatal.
1632  *
1633  * This function will take its own reference on @state.
1634  * Callers should always release their reference with drm_atomic_state_put().
1635  *
1636  * Returns:
1637  * 0 on success, negative error code on failure.
1638  */
1639 int drm_atomic_nonblocking_commit(struct drm_atomic_state *state)
1640 {
1641         struct drm_mode_config *config = &state->dev->mode_config;
1642         int ret;
1643
1644         ret = drm_atomic_check_only(state);
1645         if (ret)
1646                 return ret;
1647
1648         DRM_DEBUG_ATOMIC("commiting %p nonblocking\n", state);
1649
1650         return config->funcs->atomic_commit(state->dev, state, true);
1651 }
1652 EXPORT_SYMBOL(drm_atomic_nonblocking_commit);
1653
1654 static void drm_atomic_print_state(const struct drm_atomic_state *state)
1655 {
1656         struct drm_printer p = drm_info_printer(state->dev->dev);
1657         struct drm_plane *plane;
1658         struct drm_plane_state *plane_state;
1659         struct drm_crtc *crtc;
1660         struct drm_crtc_state *crtc_state;
1661         struct drm_connector *connector;
1662         struct drm_connector_state *connector_state;
1663         int i;
1664
1665         DRM_DEBUG_ATOMIC("checking %p\n", state);
1666
1667         for_each_new_plane_in_state(state, plane, plane_state, i)
1668                 drm_atomic_plane_print_state(&p, plane_state);
1669
1670         for_each_new_crtc_in_state(state, crtc, crtc_state, i)
1671                 drm_atomic_crtc_print_state(&p, crtc_state);
1672
1673         for_each_new_connector_in_state(state, connector, connector_state, i)
1674                 drm_atomic_connector_print_state(&p, connector_state);
1675 }
1676
1677 /**
1678  * drm_state_dump - dump entire device atomic state
1679  * @dev: the drm device
1680  * @p: where to print the state to
1681  *
1682  * Just for debugging.  Drivers might want an option to dump state
1683  * to dmesg in case of error irq's.  (Hint, you probably want to
1684  * ratelimit this!)
1685  *
1686  * The caller must drm_modeset_lock_all(), or if this is called
1687  * from error irq handler, it should not be enabled by default.
1688  * (Ie. if you are debugging errors you might not care that this
1689  * is racey.  But calling this without all modeset locks held is
1690  * not inherently safe.)
1691  */
1692 void drm_state_dump(struct drm_device *dev, struct drm_printer *p)
1693 {
1694         struct drm_mode_config *config = &dev->mode_config;
1695         struct drm_plane *plane;
1696         struct drm_crtc *crtc;
1697         struct drm_connector *connector;
1698         struct drm_connector_list_iter conn_iter;
1699
1700         if (!drm_core_check_feature(dev, DRIVER_ATOMIC))
1701                 return;
1702
1703         list_for_each_entry(plane, &config->plane_list, head)
1704                 drm_atomic_plane_print_state(p, plane->state);
1705
1706         list_for_each_entry(crtc, &config->crtc_list, head)
1707                 drm_atomic_crtc_print_state(p, crtc->state);
1708
1709         drm_connector_list_iter_get(dev, &conn_iter);
1710         drm_for_each_connector_iter(connector, &conn_iter)
1711                 drm_atomic_connector_print_state(p, connector->state);
1712         drm_connector_list_iter_put(&conn_iter);
1713 }
1714 EXPORT_SYMBOL(drm_state_dump);
1715
1716 #ifdef CONFIG_DEBUG_FS
1717 static int drm_state_info(struct seq_file *m, void *data)
1718 {
1719         struct drm_info_node *node = (struct drm_info_node *) m->private;
1720         struct drm_device *dev = node->minor->dev;
1721         struct drm_printer p = drm_seq_file_printer(m);
1722
1723         drm_modeset_lock_all(dev);
1724         drm_state_dump(dev, &p);
1725         drm_modeset_unlock_all(dev);
1726
1727         return 0;
1728 }
1729
1730 /* any use in debugfs files to dump individual planes/crtc/etc? */
1731 static const struct drm_info_list drm_atomic_debugfs_list[] = {
1732         {"state", drm_state_info, 0},
1733 };
1734
1735 int drm_atomic_debugfs_init(struct drm_minor *minor)
1736 {
1737         return drm_debugfs_create_files(drm_atomic_debugfs_list,
1738                         ARRAY_SIZE(drm_atomic_debugfs_list),
1739                         minor->debugfs_root, minor);
1740 }
1741 #endif
1742
1743 /*
1744  * The big monstor ioctl
1745  */
1746
1747 static struct drm_pending_vblank_event *create_vblank_event(
1748                 struct drm_device *dev, uint64_t user_data)
1749 {
1750         struct drm_pending_vblank_event *e = NULL;
1751
1752         e = kzalloc(sizeof *e, GFP_KERNEL);
1753         if (!e)
1754                 return NULL;
1755
1756         e->event.base.type = DRM_EVENT_FLIP_COMPLETE;
1757         e->event.base.length = sizeof(e->event);
1758         e->event.user_data = user_data;
1759
1760         return e;
1761 }
1762
1763 static int atomic_set_prop(struct drm_atomic_state *state,
1764                 struct drm_mode_object *obj, struct drm_property *prop,
1765                 uint64_t prop_value)
1766 {
1767         struct drm_mode_object *ref;
1768         int ret;
1769
1770         if (!drm_property_change_valid_get(prop, prop_value, &ref))
1771                 return -EINVAL;
1772
1773         switch (obj->type) {
1774         case DRM_MODE_OBJECT_CONNECTOR: {
1775                 struct drm_connector *connector = obj_to_connector(obj);
1776                 struct drm_connector_state *connector_state;
1777
1778                 connector_state = drm_atomic_get_connector_state(state, connector);
1779                 if (IS_ERR(connector_state)) {
1780                         ret = PTR_ERR(connector_state);
1781                         break;
1782                 }
1783
1784                 ret = drm_atomic_connector_set_property(connector,
1785                                 connector_state, prop, prop_value);
1786                 break;
1787         }
1788         case DRM_MODE_OBJECT_CRTC: {
1789                 struct drm_crtc *crtc = obj_to_crtc(obj);
1790                 struct drm_crtc_state *crtc_state;
1791
1792                 crtc_state = drm_atomic_get_crtc_state(state, crtc);
1793                 if (IS_ERR(crtc_state)) {
1794                         ret = PTR_ERR(crtc_state);
1795                         break;
1796                 }
1797
1798                 ret = drm_atomic_crtc_set_property(crtc,
1799                                 crtc_state, prop, prop_value);
1800                 break;
1801         }
1802         case DRM_MODE_OBJECT_PLANE: {
1803                 struct drm_plane *plane = obj_to_plane(obj);
1804                 struct drm_plane_state *plane_state;
1805
1806                 plane_state = drm_atomic_get_plane_state(state, plane);
1807                 if (IS_ERR(plane_state)) {
1808                         ret = PTR_ERR(plane_state);
1809                         break;
1810                 }
1811
1812                 ret = drm_atomic_plane_set_property(plane,
1813                                 plane_state, prop, prop_value);
1814                 break;
1815         }
1816         default:
1817                 ret = -EINVAL;
1818                 break;
1819         }
1820
1821         drm_property_change_valid_put(prop, ref);
1822         return ret;
1823 }
1824
1825 /**
1826  * drm_atomic_clean_old_fb -- Unset old_fb pointers and set plane->fb pointers.
1827  *
1828  * @dev: drm device to check.
1829  * @plane_mask: plane mask for planes that were updated.
1830  * @ret: return value, can be -EDEADLK for a retry.
1831  *
1832  * Before doing an update &drm_plane.old_fb is set to &drm_plane.fb, but before
1833  * dropping the locks old_fb needs to be set to NULL and plane->fb updated. This
1834  * is a common operation for each atomic update, so this call is split off as a
1835  * helper.
1836  */
1837 void drm_atomic_clean_old_fb(struct drm_device *dev,
1838                              unsigned plane_mask,
1839                              int ret)
1840 {
1841         struct drm_plane *plane;
1842
1843         /* if succeeded, fixup legacy plane crtc/fb ptrs before dropping
1844          * locks (ie. while it is still safe to deref plane->state).  We
1845          * need to do this here because the driver entry points cannot
1846          * distinguish between legacy and atomic ioctls.
1847          */
1848         drm_for_each_plane_mask(plane, dev, plane_mask) {
1849                 if (ret == 0) {
1850                         struct drm_framebuffer *new_fb = plane->state->fb;
1851                         if (new_fb)
1852                                 drm_framebuffer_reference(new_fb);
1853                         plane->fb = new_fb;
1854                         plane->crtc = plane->state->crtc;
1855
1856                         if (plane->old_fb)
1857                                 drm_framebuffer_unreference(plane->old_fb);
1858                 }
1859                 plane->old_fb = NULL;
1860         }
1861 }
1862 EXPORT_SYMBOL(drm_atomic_clean_old_fb);
1863
1864 /**
1865  * DOC: explicit fencing properties
1866  *
1867  * Explicit fencing allows userspace to control the buffer synchronization
1868  * between devices. A Fence or a group of fences are transfered to/from
1869  * userspace using Sync File fds and there are two DRM properties for that.
1870  * IN_FENCE_FD on each DRM Plane to send fences to the kernel and
1871  * OUT_FENCE_PTR on each DRM CRTC to receive fences from the kernel.
1872  *
1873  * As a contrast, with implicit fencing the kernel keeps track of any
1874  * ongoing rendering, and automatically ensures that the atomic update waits
1875  * for any pending rendering to complete. For shared buffers represented with
1876  * a &struct dma_buf this is tracked in &struct reservation_object.
1877  * Implicit syncing is how Linux traditionally worked (e.g. DRI2/3 on X.org),
1878  * whereas explicit fencing is what Android wants.
1879  *
1880  * "IN_FENCE_FD”:
1881  *      Use this property to pass a fence that DRM should wait on before
1882  *      proceeding with the Atomic Commit request and show the framebuffer for
1883  *      the plane on the screen. The fence can be either a normal fence or a
1884  *      merged one, the sync_file framework will handle both cases and use a
1885  *      fence_array if a merged fence is received. Passing -1 here means no
1886  *      fences to wait on.
1887  *
1888  *      If the Atomic Commit request has the DRM_MODE_ATOMIC_TEST_ONLY flag
1889  *      it will only check if the Sync File is a valid one.
1890  *
1891  *      On the driver side the fence is stored on the @fence parameter of
1892  *      &struct drm_plane_state. Drivers which also support implicit fencing
1893  *      should set the implicit fence using drm_atomic_set_fence_for_plane(),
1894  *      to make sure there's consistent behaviour between drivers in precedence
1895  *      of implicit vs. explicit fencing.
1896  *
1897  * "OUT_FENCE_PTR”:
1898  *      Use this property to pass a file descriptor pointer to DRM. Once the
1899  *      Atomic Commit request call returns OUT_FENCE_PTR will be filled with
1900  *      the file descriptor number of a Sync File. This Sync File contains the
1901  *      CRTC fence that will be signaled when all framebuffers present on the
1902  *      Atomic Commit * request for that given CRTC are scanned out on the
1903  *      screen.
1904  *
1905  *      The Atomic Commit request fails if a invalid pointer is passed. If the
1906  *      Atomic Commit request fails for any other reason the out fence fd
1907  *      returned will be -1. On a Atomic Commit with the
1908  *      DRM_MODE_ATOMIC_TEST_ONLY flag the out fence will also be set to -1.
1909  *
1910  *      Note that out-fences don't have a special interface to drivers and are
1911  *      internally represented by a &struct drm_pending_vblank_event in struct
1912  *      &drm_crtc_state, which is also used by the nonblocking atomic commit
1913  *      helpers and for the DRM event handling for existing userspace.
1914  */
1915
1916 struct drm_out_fence_state {
1917         s32 __user *out_fence_ptr;
1918         struct sync_file *sync_file;
1919         int fd;
1920 };
1921
1922 static int setup_out_fence(struct drm_out_fence_state *fence_state,
1923                            struct dma_fence *fence)
1924 {
1925         fence_state->fd = get_unused_fd_flags(O_CLOEXEC);
1926         if (fence_state->fd < 0)
1927                 return fence_state->fd;
1928
1929         if (put_user(fence_state->fd, fence_state->out_fence_ptr))
1930                 return -EFAULT;
1931
1932         fence_state->sync_file = sync_file_create(fence);
1933         if (!fence_state->sync_file)
1934                 return -ENOMEM;
1935
1936         return 0;
1937 }
1938
1939 static int prepare_crtc_signaling(struct drm_device *dev,
1940                                   struct drm_atomic_state *state,
1941                                   struct drm_mode_atomic *arg,
1942                                   struct drm_file *file_priv,
1943                                   struct drm_out_fence_state **fence_state,
1944                                   unsigned int *num_fences)
1945 {
1946         struct drm_crtc *crtc;
1947         struct drm_crtc_state *crtc_state;
1948         int i, ret;
1949
1950         if (arg->flags & DRM_MODE_ATOMIC_TEST_ONLY)
1951                 return 0;
1952
1953         for_each_new_crtc_in_state(state, crtc, crtc_state, i) {
1954                 s32 __user *fence_ptr;
1955
1956                 fence_ptr = get_out_fence_for_crtc(crtc_state->state, crtc);
1957
1958                 if (arg->flags & DRM_MODE_PAGE_FLIP_EVENT || fence_ptr) {
1959                         struct drm_pending_vblank_event *e;
1960
1961                         e = create_vblank_event(dev, arg->user_data);
1962                         if (!e)
1963                                 return -ENOMEM;
1964
1965                         crtc_state->event = e;
1966                 }
1967
1968                 if (arg->flags & DRM_MODE_PAGE_FLIP_EVENT) {
1969                         struct drm_pending_vblank_event *e = crtc_state->event;
1970
1971                         if (!file_priv)
1972                                 continue;
1973
1974                         ret = drm_event_reserve_init(dev, file_priv, &e->base,
1975                                                      &e->event.base);
1976                         if (ret) {
1977                                 kfree(e);
1978                                 crtc_state->event = NULL;
1979                                 return ret;
1980                         }
1981                 }
1982
1983                 if (fence_ptr) {
1984                         struct dma_fence *fence;
1985                         struct drm_out_fence_state *f;
1986
1987                         f = krealloc(*fence_state, sizeof(**fence_state) *
1988                                      (*num_fences + 1), GFP_KERNEL);
1989                         if (!f)
1990                                 return -ENOMEM;
1991
1992                         memset(&f[*num_fences], 0, sizeof(*f));
1993
1994                         f[*num_fences].out_fence_ptr = fence_ptr;
1995                         *fence_state = f;
1996
1997                         fence = drm_crtc_create_fence(crtc);
1998                         if (!fence)
1999                                 return -ENOMEM;
2000
2001                         ret = setup_out_fence(&f[(*num_fences)++], fence);
2002                         if (ret) {
2003                                 dma_fence_put(fence);
2004                                 return ret;
2005                         }
2006
2007                         crtc_state->event->base.fence = fence;
2008                 }
2009         }
2010
2011         return 0;
2012 }
2013
2014 static void complete_crtc_signaling(struct drm_device *dev,
2015                                     struct drm_atomic_state *state,
2016                                     struct drm_out_fence_state *fence_state,
2017                                     unsigned int num_fences,
2018                                     bool install_fds)
2019 {
2020         struct drm_crtc *crtc;
2021         struct drm_crtc_state *crtc_state;
2022         int i;
2023
2024         if (install_fds) {
2025                 for (i = 0; i < num_fences; i++)
2026                         fd_install(fence_state[i].fd,
2027                                    fence_state[i].sync_file->file);
2028
2029                 kfree(fence_state);
2030                 return;
2031         }
2032
2033         for_each_new_crtc_in_state(state, crtc, crtc_state, i) {
2034                 struct drm_pending_vblank_event *event = crtc_state->event;
2035                 /*
2036                  * Free the allocated event. drm_atomic_helper_setup_commit
2037                  * can allocate an event too, so only free it if it's ours
2038                  * to prevent a double free in drm_atomic_state_clear.
2039                  */
2040                 if (event && (event->base.fence || event->base.file_priv)) {
2041                         drm_event_cancel_free(dev, &event->base);
2042                         crtc_state->event = NULL;
2043                 }
2044         }
2045
2046         if (!fence_state)
2047                 return;
2048
2049         for (i = 0; i < num_fences; i++) {
2050                 if (fence_state[i].sync_file)
2051                         fput(fence_state[i].sync_file->file);
2052                 if (fence_state[i].fd >= 0)
2053                         put_unused_fd(fence_state[i].fd);
2054
2055                 /* If this fails log error to the user */
2056                 if (fence_state[i].out_fence_ptr &&
2057                     put_user(-1, fence_state[i].out_fence_ptr))
2058                         DRM_DEBUG_ATOMIC("Couldn't clear out_fence_ptr\n");
2059         }
2060
2061         kfree(fence_state);
2062 }
2063
2064 int drm_mode_atomic_ioctl(struct drm_device *dev,
2065                           void *data, struct drm_file *file_priv)
2066 {
2067         struct drm_mode_atomic *arg = data;
2068         uint32_t __user *objs_ptr = (uint32_t __user *)(unsigned long)(arg->objs_ptr);
2069         uint32_t __user *count_props_ptr = (uint32_t __user *)(unsigned long)(arg->count_props_ptr);
2070         uint32_t __user *props_ptr = (uint32_t __user *)(unsigned long)(arg->props_ptr);
2071         uint64_t __user *prop_values_ptr = (uint64_t __user *)(unsigned long)(arg->prop_values_ptr);
2072         unsigned int copied_objs, copied_props;
2073         struct drm_atomic_state *state;
2074         struct drm_modeset_acquire_ctx ctx;
2075         struct drm_plane *plane;
2076         struct drm_out_fence_state *fence_state = NULL;
2077         unsigned plane_mask;
2078         int ret = 0;
2079         unsigned int i, j, num_fences = 0;
2080
2081         /* disallow for drivers not supporting atomic: */
2082         if (!drm_core_check_feature(dev, DRIVER_ATOMIC))
2083                 return -EINVAL;
2084
2085         /* disallow for userspace that has not enabled atomic cap (even
2086          * though this may be a bit overkill, since legacy userspace
2087          * wouldn't know how to call this ioctl)
2088          */
2089         if (!file_priv->atomic)
2090                 return -EINVAL;
2091
2092         if (arg->flags & ~DRM_MODE_ATOMIC_FLAGS)
2093                 return -EINVAL;
2094
2095         if (arg->reserved)
2096                 return -EINVAL;
2097
2098         if ((arg->flags & DRM_MODE_PAGE_FLIP_ASYNC) &&
2099                         !dev->mode_config.async_page_flip)
2100                 return -EINVAL;
2101
2102         /* can't test and expect an event at the same time. */
2103         if ((arg->flags & DRM_MODE_ATOMIC_TEST_ONLY) &&
2104                         (arg->flags & DRM_MODE_PAGE_FLIP_EVENT))
2105                 return -EINVAL;
2106
2107         drm_modeset_acquire_init(&ctx, 0);
2108
2109         state = drm_atomic_state_alloc(dev);
2110         if (!state)
2111                 return -ENOMEM;
2112
2113         state->acquire_ctx = &ctx;
2114         state->allow_modeset = !!(arg->flags & DRM_MODE_ATOMIC_ALLOW_MODESET);
2115
2116 retry:
2117         plane_mask = 0;
2118         copied_objs = 0;
2119         copied_props = 0;
2120
2121         for (i = 0; i < arg->count_objs; i++) {
2122                 uint32_t obj_id, count_props;
2123                 struct drm_mode_object *obj;
2124
2125                 if (get_user(obj_id, objs_ptr + copied_objs)) {
2126                         ret = -EFAULT;
2127                         goto out;
2128                 }
2129
2130                 obj = drm_mode_object_find(dev, obj_id, DRM_MODE_OBJECT_ANY);
2131                 if (!obj) {
2132                         ret = -ENOENT;
2133                         goto out;
2134                 }
2135
2136                 if (!obj->properties) {
2137                         drm_mode_object_unreference(obj);
2138                         ret = -ENOENT;
2139                         goto out;
2140                 }
2141
2142                 if (get_user(count_props, count_props_ptr + copied_objs)) {
2143                         drm_mode_object_unreference(obj);
2144                         ret = -EFAULT;
2145                         goto out;
2146                 }
2147
2148                 copied_objs++;
2149
2150                 for (j = 0; j < count_props; j++) {
2151                         uint32_t prop_id;
2152                         uint64_t prop_value;
2153                         struct drm_property *prop;
2154
2155                         if (get_user(prop_id, props_ptr + copied_props)) {
2156                                 drm_mode_object_unreference(obj);
2157                                 ret = -EFAULT;
2158                                 goto out;
2159                         }
2160
2161                         prop = drm_mode_obj_find_prop_id(obj, prop_id);
2162                         if (!prop) {
2163                                 drm_mode_object_unreference(obj);
2164                                 ret = -ENOENT;
2165                                 goto out;
2166                         }
2167
2168                         if (copy_from_user(&prop_value,
2169                                            prop_values_ptr + copied_props,
2170                                            sizeof(prop_value))) {
2171                                 drm_mode_object_unreference(obj);
2172                                 ret = -EFAULT;
2173                                 goto out;
2174                         }
2175
2176                         ret = atomic_set_prop(state, obj, prop, prop_value);
2177                         if (ret) {
2178                                 drm_mode_object_unreference(obj);
2179                                 goto out;
2180                         }
2181
2182                         copied_props++;
2183                 }
2184
2185                 if (obj->type == DRM_MODE_OBJECT_PLANE && count_props &&
2186                     !(arg->flags & DRM_MODE_ATOMIC_TEST_ONLY)) {
2187                         plane = obj_to_plane(obj);
2188                         plane_mask |= (1 << drm_plane_index(plane));
2189                         plane->old_fb = plane->fb;
2190                 }
2191                 drm_mode_object_unreference(obj);
2192         }
2193
2194         ret = prepare_crtc_signaling(dev, state, arg, file_priv, &fence_state,
2195                                      &num_fences);
2196         if (ret)
2197                 goto out;
2198
2199         if (arg->flags & DRM_MODE_ATOMIC_TEST_ONLY) {
2200                 ret = drm_atomic_check_only(state);
2201         } else if (arg->flags & DRM_MODE_ATOMIC_NONBLOCK) {
2202                 ret = drm_atomic_nonblocking_commit(state);
2203         } else {
2204                 if (unlikely(drm_debug & DRM_UT_STATE))
2205                         drm_atomic_print_state(state);
2206
2207                 ret = drm_atomic_commit(state);
2208         }
2209
2210 out:
2211         drm_atomic_clean_old_fb(dev, plane_mask, ret);
2212
2213         complete_crtc_signaling(dev, state, fence_state, num_fences, !ret);
2214
2215         if (ret == -EDEADLK) {
2216                 drm_atomic_state_clear(state);
2217                 drm_modeset_backoff(&ctx);
2218                 goto retry;
2219         }
2220
2221         drm_atomic_state_put(state);
2222
2223         drm_modeset_drop_locks(&ctx);
2224         drm_modeset_acquire_fini(&ctx);
2225
2226         return ret;
2227 }