69adcf3944cc96a075ec02686fa675fa7061c0ab
[cascardo/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
34 #include "drm_crtc_internal.h"
35
36 /**
37  * drm_atomic_state_default_release -
38  * release memory initialized by drm_atomic_state_init
39  * @state: atomic state
40  *
41  * Free all the memory allocated by drm_atomic_state_init.
42  * This is useful for drivers that subclass the atomic state.
43  */
44 void drm_atomic_state_default_release(struct drm_atomic_state *state)
45 {
46         kfree(state->connectors);
47         kfree(state->connector_states);
48         kfree(state->crtcs);
49         kfree(state->crtc_states);
50         kfree(state->planes);
51         kfree(state->plane_states);
52 }
53 EXPORT_SYMBOL(drm_atomic_state_default_release);
54
55 /**
56  * drm_atomic_state_init - init new atomic state
57  * @dev: DRM device
58  * @state: atomic state
59  *
60  * Default implementation for filling in a new atomic state.
61  * This is useful for drivers that subclass the atomic state.
62  */
63 int
64 drm_atomic_state_init(struct drm_device *dev, struct drm_atomic_state *state)
65 {
66         /* TODO legacy paths should maybe do a better job about
67          * setting this appropriately?
68          */
69         state->allow_modeset = true;
70
71         state->crtcs = kcalloc(dev->mode_config.num_crtc,
72                                sizeof(*state->crtcs), GFP_KERNEL);
73         if (!state->crtcs)
74                 goto fail;
75         state->crtc_states = kcalloc(dev->mode_config.num_crtc,
76                                      sizeof(*state->crtc_states), GFP_KERNEL);
77         if (!state->crtc_states)
78                 goto fail;
79         state->planes = kcalloc(dev->mode_config.num_total_plane,
80                                 sizeof(*state->planes), GFP_KERNEL);
81         if (!state->planes)
82                 goto fail;
83         state->plane_states = kcalloc(dev->mode_config.num_total_plane,
84                                       sizeof(*state->plane_states), GFP_KERNEL);
85         if (!state->plane_states)
86                 goto fail;
87
88         state->dev = dev;
89
90         DRM_DEBUG_ATOMIC("Allocated atomic state %p\n", state);
91
92         return 0;
93 fail:
94         drm_atomic_state_default_release(state);
95         return -ENOMEM;
96 }
97 EXPORT_SYMBOL(drm_atomic_state_init);
98
99 /**
100  * drm_atomic_state_alloc - allocate atomic state
101  * @dev: DRM device
102  *
103  * This allocates an empty atomic state to track updates.
104  */
105 struct drm_atomic_state *
106 drm_atomic_state_alloc(struct drm_device *dev)
107 {
108         struct drm_mode_config *config = &dev->mode_config;
109         struct drm_atomic_state *state;
110
111         if (!config->funcs->atomic_state_alloc) {
112                 state = kzalloc(sizeof(*state), GFP_KERNEL);
113                 if (!state)
114                         return NULL;
115                 if (drm_atomic_state_init(dev, state) < 0) {
116                         kfree(state);
117                         return NULL;
118                 }
119                 return state;
120         }
121
122         return config->funcs->atomic_state_alloc(dev);
123 }
124 EXPORT_SYMBOL(drm_atomic_state_alloc);
125
126 /**
127  * drm_atomic_state_default_clear - clear base atomic state
128  * @state: atomic state
129  *
130  * Default implementation for clearing atomic state.
131  * This is useful for drivers that subclass the atomic state.
132  */
133 void drm_atomic_state_default_clear(struct drm_atomic_state *state)
134 {
135         struct drm_device *dev = state->dev;
136         struct drm_mode_config *config = &dev->mode_config;
137         int i;
138
139         DRM_DEBUG_ATOMIC("Clearing atomic state %p\n", state);
140
141         for (i = 0; i < state->num_connector; i++) {
142                 struct drm_connector *connector = state->connectors[i];
143
144                 if (!connector)
145                         continue;
146
147                 /*
148                  * FIXME: Nonblocking commits can race with connector unplugging and
149                  * there's currently nothing that prevents cleanup up state for
150                  * deleted connectors. As long as the callback doesn't look at
151                  * the connector we'll be fine though, so make sure that's the
152                  * case by setting all connector pointers to NULL.
153                  */
154                 state->connector_states[i]->connector = NULL;
155                 connector->funcs->atomic_destroy_state(NULL,
156                                                        state->connector_states[i]);
157                 state->connectors[i] = NULL;
158                 state->connector_states[i] = NULL;
159         }
160
161         for (i = 0; i < config->num_crtc; i++) {
162                 struct drm_crtc *crtc = state->crtcs[i];
163
164                 if (!crtc)
165                         continue;
166
167                 crtc->funcs->atomic_destroy_state(crtc,
168                                                   state->crtc_states[i]);
169                 state->crtcs[i] = NULL;
170                 state->crtc_states[i] = NULL;
171         }
172
173         for (i = 0; i < config->num_total_plane; i++) {
174                 struct drm_plane *plane = state->planes[i];
175
176                 if (!plane)
177                         continue;
178
179                 plane->funcs->atomic_destroy_state(plane,
180                                                    state->plane_states[i]);
181                 state->planes[i] = NULL;
182                 state->plane_states[i] = NULL;
183         }
184 }
185 EXPORT_SYMBOL(drm_atomic_state_default_clear);
186
187 /**
188  * drm_atomic_state_clear - clear state object
189  * @state: atomic state
190  *
191  * When the w/w mutex algorithm detects a deadlock we need to back off and drop
192  * all locks. So someone else could sneak in and change the current modeset
193  * configuration. Which means that all the state assembled in @state is no
194  * longer an atomic update to the current state, but to some arbitrary earlier
195  * state. Which could break assumptions the driver's ->atomic_check likely
196  * relies on.
197  *
198  * Hence we must clear all cached state and completely start over, using this
199  * function.
200  */
201 void drm_atomic_state_clear(struct drm_atomic_state *state)
202 {
203         struct drm_device *dev = state->dev;
204         struct drm_mode_config *config = &dev->mode_config;
205
206         if (config->funcs->atomic_state_clear)
207                 config->funcs->atomic_state_clear(state);
208         else
209                 drm_atomic_state_default_clear(state);
210 }
211 EXPORT_SYMBOL(drm_atomic_state_clear);
212
213 /**
214  * drm_atomic_state_free - free all memory for an atomic state
215  * @state: atomic state to deallocate
216  *
217  * This frees all memory associated with an atomic state, including all the
218  * per-object state for planes, crtcs and connectors.
219  */
220 void drm_atomic_state_free(struct drm_atomic_state *state)
221 {
222         struct drm_device *dev;
223         struct drm_mode_config *config;
224
225         if (!state)
226                 return;
227
228         dev = state->dev;
229         config = &dev->mode_config;
230
231         drm_atomic_state_clear(state);
232
233         DRM_DEBUG_ATOMIC("Freeing atomic state %p\n", state);
234
235         if (config->funcs->atomic_state_free) {
236                 config->funcs->atomic_state_free(state);
237         } else {
238                 drm_atomic_state_default_release(state);
239                 kfree(state);
240         }
241 }
242 EXPORT_SYMBOL(drm_atomic_state_free);
243
244 /**
245  * drm_atomic_get_crtc_state - get crtc state
246  * @state: global atomic state object
247  * @crtc: crtc to get state object for
248  *
249  * This function returns the crtc state for the given crtc, allocating it if
250  * needed. It will also grab the relevant crtc lock to make sure that the state
251  * is consistent.
252  *
253  * Returns:
254  *
255  * Either the allocated state or the error code encoded into the pointer. When
256  * the error is EDEADLK then the w/w mutex code has detected a deadlock and the
257  * entire atomic sequence must be restarted. All other errors are fatal.
258  */
259 struct drm_crtc_state *
260 drm_atomic_get_crtc_state(struct drm_atomic_state *state,
261                           struct drm_crtc *crtc)
262 {
263         int ret, index = drm_crtc_index(crtc);
264         struct drm_crtc_state *crtc_state;
265
266         WARN_ON(!state->acquire_ctx);
267
268         crtc_state = drm_atomic_get_existing_crtc_state(state, crtc);
269         if (crtc_state)
270                 return crtc_state;
271
272         ret = drm_modeset_lock(&crtc->mutex, state->acquire_ctx);
273         if (ret)
274                 return ERR_PTR(ret);
275
276         crtc_state = crtc->funcs->atomic_duplicate_state(crtc);
277         if (!crtc_state)
278                 return ERR_PTR(-ENOMEM);
279
280         state->crtc_states[index] = crtc_state;
281         state->crtcs[index] = crtc;
282         crtc_state->state = state;
283
284         DRM_DEBUG_ATOMIC("Added [CRTC:%d:%s] %p state to %p\n",
285                          crtc->base.id, crtc->name, crtc_state, state);
286
287         return crtc_state;
288 }
289 EXPORT_SYMBOL(drm_atomic_get_crtc_state);
290
291 /**
292  * drm_atomic_set_mode_for_crtc - set mode for CRTC
293  * @state: the CRTC whose incoming state to update
294  * @mode: kernel-internal mode to use for the CRTC, or NULL to disable
295  *
296  * Set a mode (originating from the kernel) on the desired CRTC state. Does
297  * not change any other state properties, including enable, active, or
298  * mode_changed.
299  *
300  * RETURNS:
301  * Zero on success, error code on failure. Cannot return -EDEADLK.
302  */
303 int drm_atomic_set_mode_for_crtc(struct drm_crtc_state *state,
304                                  struct drm_display_mode *mode)
305 {
306         struct drm_mode_modeinfo umode;
307
308         /* Early return for no change. */
309         if (mode && memcmp(&state->mode, mode, sizeof(*mode)) == 0)
310                 return 0;
311
312         drm_property_unreference_blob(state->mode_blob);
313         state->mode_blob = NULL;
314
315         if (mode) {
316                 drm_mode_convert_to_umode(&umode, mode);
317                 state->mode_blob =
318                         drm_property_create_blob(state->crtc->dev,
319                                                  sizeof(umode),
320                                                  &umode);
321                 if (IS_ERR(state->mode_blob))
322                         return PTR_ERR(state->mode_blob);
323
324                 drm_mode_copy(&state->mode, mode);
325                 state->enable = true;
326                 DRM_DEBUG_ATOMIC("Set [MODE:%s] for CRTC state %p\n",
327                                  mode->name, state);
328         } else {
329                 memset(&state->mode, 0, sizeof(state->mode));
330                 state->enable = false;
331                 DRM_DEBUG_ATOMIC("Set [NOMODE] for CRTC state %p\n",
332                                  state);
333         }
334
335         return 0;
336 }
337 EXPORT_SYMBOL(drm_atomic_set_mode_for_crtc);
338
339 /**
340  * drm_atomic_set_mode_prop_for_crtc - set mode for CRTC
341  * @state: the CRTC whose incoming state to update
342  * @blob: pointer to blob property to use for mode
343  *
344  * Set a mode (originating from a blob property) on the desired CRTC state.
345  * This function will take a reference on the blob property for the CRTC state,
346  * and release the reference held on the state's existing mode property, if any
347  * was set.
348  *
349  * RETURNS:
350  * Zero on success, error code on failure. Cannot return -EDEADLK.
351  */
352 int drm_atomic_set_mode_prop_for_crtc(struct drm_crtc_state *state,
353                                       struct drm_property_blob *blob)
354 {
355         if (blob == state->mode_blob)
356                 return 0;
357
358         drm_property_unreference_blob(state->mode_blob);
359         state->mode_blob = NULL;
360
361         if (blob) {
362                 if (blob->length != sizeof(struct drm_mode_modeinfo) ||
363                     drm_mode_convert_umode(&state->mode,
364                                            (const struct drm_mode_modeinfo *)
365                                             blob->data))
366                         return -EINVAL;
367
368                 state->mode_blob = drm_property_reference_blob(blob);
369                 state->enable = true;
370                 DRM_DEBUG_ATOMIC("Set [MODE:%s] for CRTC state %p\n",
371                                  state->mode.name, state);
372         } else {
373                 memset(&state->mode, 0, sizeof(state->mode));
374                 state->enable = false;
375                 DRM_DEBUG_ATOMIC("Set [NOMODE] for CRTC state %p\n",
376                                  state);
377         }
378
379         return 0;
380 }
381 EXPORT_SYMBOL(drm_atomic_set_mode_prop_for_crtc);
382
383 /**
384  * drm_atomic_replace_property_blob - replace a blob property
385  * @blob: a pointer to the member blob to be replaced
386  * @new_blob: the new blob to replace with
387  * @replaced: whether the blob has been replaced
388  *
389  * RETURNS:
390  * Zero on success, error code on failure
391  */
392 static void
393 drm_atomic_replace_property_blob(struct drm_property_blob **blob,
394                                  struct drm_property_blob *new_blob,
395                                  bool *replaced)
396 {
397         struct drm_property_blob *old_blob = *blob;
398
399         if (old_blob == new_blob)
400                 return;
401
402         if (old_blob)
403                 drm_property_unreference_blob(old_blob);
404         if (new_blob)
405                 drm_property_reference_blob(new_blob);
406         *blob = new_blob;
407         *replaced = true;
408
409         return;
410 }
411
412 static int
413 drm_atomic_replace_property_blob_from_id(struct drm_crtc *crtc,
414                                          struct drm_property_blob **blob,
415                                          uint64_t blob_id,
416                                          ssize_t expected_size,
417                                          bool *replaced)
418 {
419         struct drm_device *dev = crtc->dev;
420         struct drm_property_blob *new_blob = NULL;
421
422         if (blob_id != 0) {
423                 new_blob = drm_property_lookup_blob(dev, blob_id);
424                 if (new_blob == NULL)
425                         return -EINVAL;
426                 if (expected_size > 0 && expected_size != new_blob->length)
427                         return -EINVAL;
428         }
429
430         drm_atomic_replace_property_blob(blob, new_blob, replaced);
431
432         return 0;
433 }
434
435 /**
436  * drm_atomic_crtc_set_property - set property on CRTC
437  * @crtc: the drm CRTC to set a property on
438  * @state: the state object to update with the new property value
439  * @property: the property to set
440  * @val: the new property value
441  *
442  * Use this instead of calling crtc->atomic_set_property directly.
443  * This function handles generic/core properties and calls out to
444  * driver's ->atomic_set_property() for driver properties.  To ensure
445  * consistent behavior you must call this function rather than the
446  * driver hook directly.
447  *
448  * RETURNS:
449  * Zero on success, error code on failure
450  */
451 int drm_atomic_crtc_set_property(struct drm_crtc *crtc,
452                 struct drm_crtc_state *state, struct drm_property *property,
453                 uint64_t val)
454 {
455         struct drm_device *dev = crtc->dev;
456         struct drm_mode_config *config = &dev->mode_config;
457         bool replaced = false;
458         int ret;
459
460         if (property == config->prop_active)
461                 state->active = val;
462         else if (property == config->prop_mode_id) {
463                 struct drm_property_blob *mode =
464                         drm_property_lookup_blob(dev, val);
465                 ret = drm_atomic_set_mode_prop_for_crtc(state, mode);
466                 drm_property_unreference_blob(mode);
467                 return ret;
468         } else if (property == config->degamma_lut_property) {
469                 ret = drm_atomic_replace_property_blob_from_id(crtc,
470                                         &state->degamma_lut,
471                                         val,
472                                         -1,
473                                         &replaced);
474                 state->color_mgmt_changed = replaced;
475                 return ret;
476         } else if (property == config->ctm_property) {
477                 ret = drm_atomic_replace_property_blob_from_id(crtc,
478                                         &state->ctm,
479                                         val,
480                                         sizeof(struct drm_color_ctm),
481                                         &replaced);
482                 state->color_mgmt_changed = replaced;
483                 return ret;
484         } else if (property == config->gamma_lut_property) {
485                 ret = drm_atomic_replace_property_blob_from_id(crtc,
486                                         &state->gamma_lut,
487                                         val,
488                                         -1,
489                                         &replaced);
490                 state->color_mgmt_changed = replaced;
491                 return ret;
492         } else if (crtc->funcs->atomic_set_property)
493                 return crtc->funcs->atomic_set_property(crtc, state, property, val);
494         else
495                 return -EINVAL;
496
497         return 0;
498 }
499 EXPORT_SYMBOL(drm_atomic_crtc_set_property);
500
501 /**
502  * drm_atomic_crtc_get_property - get property value from CRTC state
503  * @crtc: the drm CRTC to set a property on
504  * @state: the state object to get the property value from
505  * @property: the property to set
506  * @val: return location for the property value
507  *
508  * This function handles generic/core properties and calls out to
509  * driver's ->atomic_get_property() for driver properties.  To ensure
510  * consistent behavior you must call this function rather than the
511  * driver hook directly.
512  *
513  * RETURNS:
514  * Zero on success, error code on failure
515  */
516 static int
517 drm_atomic_crtc_get_property(struct drm_crtc *crtc,
518                 const struct drm_crtc_state *state,
519                 struct drm_property *property, uint64_t *val)
520 {
521         struct drm_device *dev = crtc->dev;
522         struct drm_mode_config *config = &dev->mode_config;
523
524         if (property == config->prop_active)
525                 *val = state->active;
526         else if (property == config->prop_mode_id)
527                 *val = (state->mode_blob) ? state->mode_blob->base.id : 0;
528         else if (property == config->degamma_lut_property)
529                 *val = (state->degamma_lut) ? state->degamma_lut->base.id : 0;
530         else if (property == config->ctm_property)
531                 *val = (state->ctm) ? state->ctm->base.id : 0;
532         else if (property == config->gamma_lut_property)
533                 *val = (state->gamma_lut) ? state->gamma_lut->base.id : 0;
534         else if (crtc->funcs->atomic_get_property)
535                 return crtc->funcs->atomic_get_property(crtc, state, property, val);
536         else
537                 return -EINVAL;
538
539         return 0;
540 }
541
542 /**
543  * drm_atomic_crtc_check - check crtc state
544  * @crtc: crtc to check
545  * @state: crtc state to check
546  *
547  * Provides core sanity checks for crtc state.
548  *
549  * RETURNS:
550  * Zero on success, error code on failure
551  */
552 static int drm_atomic_crtc_check(struct drm_crtc *crtc,
553                 struct drm_crtc_state *state)
554 {
555         /* NOTE: we explicitly don't enforce constraints such as primary
556          * layer covering entire screen, since that is something we want
557          * to allow (on hw that supports it).  For hw that does not, it
558          * should be checked in driver's crtc->atomic_check() vfunc.
559          *
560          * TODO: Add generic modeset state checks once we support those.
561          */
562
563         if (state->active && !state->enable) {
564                 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] active without enabled\n",
565                                  crtc->base.id, crtc->name);
566                 return -EINVAL;
567         }
568
569         /* The state->enable vs. state->mode_blob checks can be WARN_ON,
570          * as this is a kernel-internal detail that userspace should never
571          * be able to trigger. */
572         if (drm_core_check_feature(crtc->dev, DRIVER_ATOMIC) &&
573             WARN_ON(state->enable && !state->mode_blob)) {
574                 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] enabled without mode blob\n",
575                                  crtc->base.id, crtc->name);
576                 return -EINVAL;
577         }
578
579         if (drm_core_check_feature(crtc->dev, DRIVER_ATOMIC) &&
580             WARN_ON(!state->enable && state->mode_blob)) {
581                 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] disabled with mode blob\n",
582                                  crtc->base.id, crtc->name);
583                 return -EINVAL;
584         }
585
586         /*
587          * Reject event generation for when a CRTC is off and stays off.
588          * It wouldn't be hard to implement this, but userspace has a track
589          * record of happily burning through 100% cpu (or worse, crash) when the
590          * display pipe is suspended. To avoid all that fun just reject updates
591          * that ask for events since likely that indicates a bug in the
592          * compositor's drawing loop. This is consistent with the vblank IOCTL
593          * and legacy page_flip IOCTL which also reject service on a disabled
594          * pipe.
595          */
596         if (state->event && !state->active && !crtc->state->active) {
597                 DRM_DEBUG_ATOMIC("[CRTC:%d] requesting event but off\n",
598                                  crtc->base.id);
599                 return -EINVAL;
600         }
601
602         return 0;
603 }
604
605 /**
606  * drm_atomic_get_plane_state - get plane state
607  * @state: global atomic state object
608  * @plane: plane to get state object for
609  *
610  * This function returns the plane state for the given plane, allocating it if
611  * needed. It will also grab the relevant plane lock to make sure that the state
612  * is consistent.
613  *
614  * Returns:
615  *
616  * Either the allocated state or the error code encoded into the pointer. When
617  * the error is EDEADLK then the w/w mutex code has detected a deadlock and the
618  * entire atomic sequence must be restarted. All other errors are fatal.
619  */
620 struct drm_plane_state *
621 drm_atomic_get_plane_state(struct drm_atomic_state *state,
622                           struct drm_plane *plane)
623 {
624         int ret, index = drm_plane_index(plane);
625         struct drm_plane_state *plane_state;
626
627         WARN_ON(!state->acquire_ctx);
628
629         plane_state = drm_atomic_get_existing_plane_state(state, plane);
630         if (plane_state)
631                 return plane_state;
632
633         ret = drm_modeset_lock(&plane->mutex, state->acquire_ctx);
634         if (ret)
635                 return ERR_PTR(ret);
636
637         plane_state = plane->funcs->atomic_duplicate_state(plane);
638         if (!plane_state)
639                 return ERR_PTR(-ENOMEM);
640
641         state->plane_states[index] = plane_state;
642         state->planes[index] = plane;
643         plane_state->state = state;
644
645         DRM_DEBUG_ATOMIC("Added [PLANE:%d:%s] %p state to %p\n",
646                          plane->base.id, plane->name, plane_state, state);
647
648         if (plane_state->crtc) {
649                 struct drm_crtc_state *crtc_state;
650
651                 crtc_state = drm_atomic_get_crtc_state(state,
652                                                        plane_state->crtc);
653                 if (IS_ERR(crtc_state))
654                         return ERR_CAST(crtc_state);
655         }
656
657         return plane_state;
658 }
659 EXPORT_SYMBOL(drm_atomic_get_plane_state);
660
661 /**
662  * drm_atomic_plane_set_property - set property on plane
663  * @plane: the drm plane to set a property on
664  * @state: the state object to update with the new property value
665  * @property: the property to set
666  * @val: the new property value
667  *
668  * Use this instead of calling plane->atomic_set_property directly.
669  * This function handles generic/core properties and calls out to
670  * driver's ->atomic_set_property() for driver properties.  To ensure
671  * consistent behavior you must call this function rather than the
672  * driver hook directly.
673  *
674  * RETURNS:
675  * Zero on success, error code on failure
676  */
677 int drm_atomic_plane_set_property(struct drm_plane *plane,
678                 struct drm_plane_state *state, struct drm_property *property,
679                 uint64_t val)
680 {
681         struct drm_device *dev = plane->dev;
682         struct drm_mode_config *config = &dev->mode_config;
683
684         if (property == config->prop_fb_id) {
685                 struct drm_framebuffer *fb = drm_framebuffer_lookup(dev, val);
686                 drm_atomic_set_fb_for_plane(state, fb);
687                 if (fb)
688                         drm_framebuffer_unreference(fb);
689         } else if (property == config->prop_crtc_id) {
690                 struct drm_crtc *crtc = drm_crtc_find(dev, val);
691                 return drm_atomic_set_crtc_for_plane(state, crtc);
692         } else if (property == config->prop_crtc_x) {
693                 state->crtc_x = U642I64(val);
694         } else if (property == config->prop_crtc_y) {
695                 state->crtc_y = U642I64(val);
696         } else if (property == config->prop_crtc_w) {
697                 state->crtc_w = val;
698         } else if (property == config->prop_crtc_h) {
699                 state->crtc_h = val;
700         } else if (property == config->prop_src_x) {
701                 state->src_x = val;
702         } else if (property == config->prop_src_y) {
703                 state->src_y = val;
704         } else if (property == config->prop_src_w) {
705                 state->src_w = val;
706         } else if (property == config->prop_src_h) {
707                 state->src_h = val;
708         } else if (property == config->rotation_property) {
709                 state->rotation = val;
710         } else if (plane->funcs->atomic_set_property) {
711                 return plane->funcs->atomic_set_property(plane, state,
712                                 property, val);
713         } else {
714                 return -EINVAL;
715         }
716
717         return 0;
718 }
719 EXPORT_SYMBOL(drm_atomic_plane_set_property);
720
721 /**
722  * drm_atomic_plane_get_property - get property value from plane state
723  * @plane: the drm plane to set a property on
724  * @state: the state object to get the property value from
725  * @property: the property to set
726  * @val: return location for the property value
727  *
728  * This function handles generic/core properties and calls out to
729  * driver's ->atomic_get_property() for driver properties.  To ensure
730  * consistent behavior you must call this function rather than the
731  * driver hook directly.
732  *
733  * RETURNS:
734  * Zero on success, error code on failure
735  */
736 static int
737 drm_atomic_plane_get_property(struct drm_plane *plane,
738                 const struct drm_plane_state *state,
739                 struct drm_property *property, uint64_t *val)
740 {
741         struct drm_device *dev = plane->dev;
742         struct drm_mode_config *config = &dev->mode_config;
743
744         if (property == config->prop_fb_id) {
745                 *val = (state->fb) ? state->fb->base.id : 0;
746         } else if (property == config->prop_crtc_id) {
747                 *val = (state->crtc) ? state->crtc->base.id : 0;
748         } else if (property == config->prop_crtc_x) {
749                 *val = I642U64(state->crtc_x);
750         } else if (property == config->prop_crtc_y) {
751                 *val = I642U64(state->crtc_y);
752         } else if (property == config->prop_crtc_w) {
753                 *val = state->crtc_w;
754         } else if (property == config->prop_crtc_h) {
755                 *val = state->crtc_h;
756         } else if (property == config->prop_src_x) {
757                 *val = state->src_x;
758         } else if (property == config->prop_src_y) {
759                 *val = state->src_y;
760         } else if (property == config->prop_src_w) {
761                 *val = state->src_w;
762         } else if (property == config->prop_src_h) {
763                 *val = state->src_h;
764         } else if (property == config->rotation_property) {
765                 *val = state->rotation;
766         } else if (plane->funcs->atomic_get_property) {
767                 return plane->funcs->atomic_get_property(plane, state, property, val);
768         } else {
769                 return -EINVAL;
770         }
771
772         return 0;
773 }
774
775 static bool
776 plane_switching_crtc(struct drm_atomic_state *state,
777                      struct drm_plane *plane,
778                      struct drm_plane_state *plane_state)
779 {
780         if (!plane->state->crtc || !plane_state->crtc)
781                 return false;
782
783         if (plane->state->crtc == plane_state->crtc)
784                 return false;
785
786         /* This could be refined, but currently there's no helper or driver code
787          * to implement direct switching of active planes nor userspace to take
788          * advantage of more direct plane switching without the intermediate
789          * full OFF state.
790          */
791         return true;
792 }
793
794 /**
795  * drm_atomic_plane_check - check plane state
796  * @plane: plane to check
797  * @state: plane state to check
798  *
799  * Provides core sanity checks for plane state.
800  *
801  * RETURNS:
802  * Zero on success, error code on failure
803  */
804 static int drm_atomic_plane_check(struct drm_plane *plane,
805                 struct drm_plane_state *state)
806 {
807         unsigned int fb_width, fb_height;
808         int ret;
809
810         /* either *both* CRTC and FB must be set, or neither */
811         if (WARN_ON(state->crtc && !state->fb)) {
812                 DRM_DEBUG_ATOMIC("CRTC set but no FB\n");
813                 return -EINVAL;
814         } else if (WARN_ON(state->fb && !state->crtc)) {
815                 DRM_DEBUG_ATOMIC("FB set but no CRTC\n");
816                 return -EINVAL;
817         }
818
819         /* if disabled, we don't care about the rest of the state: */
820         if (!state->crtc)
821                 return 0;
822
823         /* Check whether this plane is usable on this CRTC */
824         if (!(plane->possible_crtcs & drm_crtc_mask(state->crtc))) {
825                 DRM_DEBUG_ATOMIC("Invalid crtc for plane\n");
826                 return -EINVAL;
827         }
828
829         /* Check whether this plane supports the fb pixel format. */
830         ret = drm_plane_check_pixel_format(plane, state->fb->pixel_format);
831         if (ret) {
832                 DRM_DEBUG_ATOMIC("Invalid pixel format %s\n",
833                                  drm_get_format_name(state->fb->pixel_format));
834                 return ret;
835         }
836
837         /* Give drivers some help against integer overflows */
838         if (state->crtc_w > INT_MAX ||
839             state->crtc_x > INT_MAX - (int32_t) state->crtc_w ||
840             state->crtc_h > INT_MAX ||
841             state->crtc_y > INT_MAX - (int32_t) state->crtc_h) {
842                 DRM_DEBUG_ATOMIC("Invalid CRTC coordinates %ux%u+%d+%d\n",
843                                  state->crtc_w, state->crtc_h,
844                                  state->crtc_x, state->crtc_y);
845                 return -ERANGE;
846         }
847
848         fb_width = state->fb->width << 16;
849         fb_height = state->fb->height << 16;
850
851         /* Make sure source coordinates are inside the fb. */
852         if (state->src_w > fb_width ||
853             state->src_x > fb_width - state->src_w ||
854             state->src_h > fb_height ||
855             state->src_y > fb_height - state->src_h) {
856                 DRM_DEBUG_ATOMIC("Invalid source coordinates "
857                                  "%u.%06ux%u.%06u+%u.%06u+%u.%06u\n",
858                                  state->src_w >> 16, ((state->src_w & 0xffff) * 15625) >> 10,
859                                  state->src_h >> 16, ((state->src_h & 0xffff) * 15625) >> 10,
860                                  state->src_x >> 16, ((state->src_x & 0xffff) * 15625) >> 10,
861                                  state->src_y >> 16, ((state->src_y & 0xffff) * 15625) >> 10);
862                 return -ENOSPC;
863         }
864
865         if (plane_switching_crtc(state->state, plane, state)) {
866                 DRM_DEBUG_ATOMIC("[PLANE:%d:%s] switching CRTC directly\n",
867                                  plane->base.id, plane->name);
868                 return -EINVAL;
869         }
870
871         return 0;
872 }
873
874 /**
875  * drm_atomic_get_connector_state - get connector state
876  * @state: global atomic state object
877  * @connector: connector to get state object for
878  *
879  * This function returns the connector state for the given connector,
880  * allocating it if needed. It will also grab the relevant connector lock to
881  * make sure that the state is consistent.
882  *
883  * Returns:
884  *
885  * Either the allocated state or the error code encoded into the pointer. When
886  * the error is EDEADLK then the w/w mutex code has detected a deadlock and the
887  * entire atomic sequence must be restarted. All other errors are fatal.
888  */
889 struct drm_connector_state *
890 drm_atomic_get_connector_state(struct drm_atomic_state *state,
891                           struct drm_connector *connector)
892 {
893         int ret, index;
894         struct drm_mode_config *config = &connector->dev->mode_config;
895         struct drm_connector_state *connector_state;
896
897         WARN_ON(!state->acquire_ctx);
898
899         ret = drm_modeset_lock(&config->connection_mutex, state->acquire_ctx);
900         if (ret)
901                 return ERR_PTR(ret);
902
903         index = drm_connector_index(connector);
904
905         if (index >= state->num_connector) {
906                 struct drm_connector **c;
907                 struct drm_connector_state **cs;
908                 int alloc = max(index + 1, config->num_connector);
909
910                 c = krealloc(state->connectors, alloc * sizeof(*state->connectors), GFP_KERNEL);
911                 if (!c)
912                         return ERR_PTR(-ENOMEM);
913
914                 state->connectors = c;
915                 memset(&state->connectors[state->num_connector], 0,
916                        sizeof(*state->connectors) * (alloc - state->num_connector));
917
918                 cs = krealloc(state->connector_states, alloc * sizeof(*state->connector_states), GFP_KERNEL);
919                 if (!cs)
920                         return ERR_PTR(-ENOMEM);
921
922                 state->connector_states = cs;
923                 memset(&state->connector_states[state->num_connector], 0,
924                        sizeof(*state->connector_states) * (alloc - state->num_connector));
925                 state->num_connector = alloc;
926         }
927
928         if (state->connector_states[index])
929                 return state->connector_states[index];
930
931         connector_state = connector->funcs->atomic_duplicate_state(connector);
932         if (!connector_state)
933                 return ERR_PTR(-ENOMEM);
934
935         state->connector_states[index] = connector_state;
936         state->connectors[index] = connector;
937         connector_state->state = state;
938
939         DRM_DEBUG_ATOMIC("Added [CONNECTOR:%d] %p state to %p\n",
940                          connector->base.id, connector_state, state);
941
942         if (connector_state->crtc) {
943                 struct drm_crtc_state *crtc_state;
944
945                 crtc_state = drm_atomic_get_crtc_state(state,
946                                                        connector_state->crtc);
947                 if (IS_ERR(crtc_state))
948                         return ERR_CAST(crtc_state);
949         }
950
951         return connector_state;
952 }
953 EXPORT_SYMBOL(drm_atomic_get_connector_state);
954
955 /**
956  * drm_atomic_connector_set_property - set property on connector.
957  * @connector: the drm connector to set a property on
958  * @state: the state object to update with the new property value
959  * @property: the property to set
960  * @val: the new property value
961  *
962  * Use this instead of calling connector->atomic_set_property directly.
963  * This function handles generic/core properties and calls out to
964  * driver's ->atomic_set_property() for driver properties.  To ensure
965  * consistent behavior you must call this function rather than the
966  * driver hook directly.
967  *
968  * RETURNS:
969  * Zero on success, error code on failure
970  */
971 int drm_atomic_connector_set_property(struct drm_connector *connector,
972                 struct drm_connector_state *state, struct drm_property *property,
973                 uint64_t val)
974 {
975         struct drm_device *dev = connector->dev;
976         struct drm_mode_config *config = &dev->mode_config;
977
978         if (property == config->prop_crtc_id) {
979                 struct drm_crtc *crtc = drm_crtc_find(dev, val);
980                 return drm_atomic_set_crtc_for_connector(state, crtc);
981         } else if (property == config->dpms_property) {
982                 /* setting DPMS property requires special handling, which
983                  * is done in legacy setprop path for us.  Disallow (for
984                  * now?) atomic writes to DPMS property:
985                  */
986                 return -EINVAL;
987         } else if (connector->funcs->atomic_set_property) {
988                 return connector->funcs->atomic_set_property(connector,
989                                 state, property, val);
990         } else {
991                 return -EINVAL;
992         }
993 }
994 EXPORT_SYMBOL(drm_atomic_connector_set_property);
995
996 /**
997  * drm_atomic_connector_get_property - get property value from connector state
998  * @connector: the drm connector to set a property on
999  * @state: the state object to get the property value from
1000  * @property: the property to set
1001  * @val: return location for the property value
1002  *
1003  * This function handles generic/core properties and calls out to
1004  * driver's ->atomic_get_property() for driver properties.  To ensure
1005  * consistent behavior you must call this function rather than the
1006  * driver hook directly.
1007  *
1008  * RETURNS:
1009  * Zero on success, error code on failure
1010  */
1011 static int
1012 drm_atomic_connector_get_property(struct drm_connector *connector,
1013                 const struct drm_connector_state *state,
1014                 struct drm_property *property, uint64_t *val)
1015 {
1016         struct drm_device *dev = connector->dev;
1017         struct drm_mode_config *config = &dev->mode_config;
1018
1019         if (property == config->prop_crtc_id) {
1020                 *val = (state->crtc) ? state->crtc->base.id : 0;
1021         } else if (property == config->dpms_property) {
1022                 *val = connector->dpms;
1023         } else if (connector->funcs->atomic_get_property) {
1024                 return connector->funcs->atomic_get_property(connector,
1025                                 state, property, val);
1026         } else {
1027                 return -EINVAL;
1028         }
1029
1030         return 0;
1031 }
1032
1033 int drm_atomic_get_property(struct drm_mode_object *obj,
1034                 struct drm_property *property, uint64_t *val)
1035 {
1036         struct drm_device *dev = property->dev;
1037         int ret;
1038
1039         switch (obj->type) {
1040         case DRM_MODE_OBJECT_CONNECTOR: {
1041                 struct drm_connector *connector = obj_to_connector(obj);
1042                 WARN_ON(!drm_modeset_is_locked(&dev->mode_config.connection_mutex));
1043                 ret = drm_atomic_connector_get_property(connector,
1044                                 connector->state, property, val);
1045                 break;
1046         }
1047         case DRM_MODE_OBJECT_CRTC: {
1048                 struct drm_crtc *crtc = obj_to_crtc(obj);
1049                 WARN_ON(!drm_modeset_is_locked(&crtc->mutex));
1050                 ret = drm_atomic_crtc_get_property(crtc,
1051                                 crtc->state, property, val);
1052                 break;
1053         }
1054         case DRM_MODE_OBJECT_PLANE: {
1055                 struct drm_plane *plane = obj_to_plane(obj);
1056                 WARN_ON(!drm_modeset_is_locked(&plane->mutex));
1057                 ret = drm_atomic_plane_get_property(plane,
1058                                 plane->state, property, val);
1059                 break;
1060         }
1061         default:
1062                 ret = -EINVAL;
1063                 break;
1064         }
1065
1066         return ret;
1067 }
1068
1069 /**
1070  * drm_atomic_set_crtc_for_plane - set crtc for plane
1071  * @plane_state: the plane whose incoming state to update
1072  * @crtc: crtc to use for the plane
1073  *
1074  * Changing the assigned crtc for a plane requires us to grab the lock and state
1075  * for the new crtc, as needed. This function takes care of all these details
1076  * besides updating the pointer in the state object itself.
1077  *
1078  * Returns:
1079  * 0 on success or can fail with -EDEADLK or -ENOMEM. When the error is EDEADLK
1080  * then the w/w mutex code has detected a deadlock and the entire atomic
1081  * sequence must be restarted. All other errors are fatal.
1082  */
1083 int
1084 drm_atomic_set_crtc_for_plane(struct drm_plane_state *plane_state,
1085                               struct drm_crtc *crtc)
1086 {
1087         struct drm_plane *plane = plane_state->plane;
1088         struct drm_crtc_state *crtc_state;
1089
1090         if (plane_state->crtc) {
1091                 crtc_state = drm_atomic_get_crtc_state(plane_state->state,
1092                                                        plane_state->crtc);
1093                 if (WARN_ON(IS_ERR(crtc_state)))
1094                         return PTR_ERR(crtc_state);
1095
1096                 crtc_state->plane_mask &= ~(1 << drm_plane_index(plane));
1097         }
1098
1099         plane_state->crtc = crtc;
1100
1101         if (crtc) {
1102                 crtc_state = drm_atomic_get_crtc_state(plane_state->state,
1103                                                        crtc);
1104                 if (IS_ERR(crtc_state))
1105                         return PTR_ERR(crtc_state);
1106                 crtc_state->plane_mask |= (1 << drm_plane_index(plane));
1107         }
1108
1109         if (crtc)
1110                 DRM_DEBUG_ATOMIC("Link plane state %p to [CRTC:%d:%s]\n",
1111                                  plane_state, crtc->base.id, crtc->name);
1112         else
1113                 DRM_DEBUG_ATOMIC("Link plane state %p to [NOCRTC]\n",
1114                                  plane_state);
1115
1116         return 0;
1117 }
1118 EXPORT_SYMBOL(drm_atomic_set_crtc_for_plane);
1119
1120 /**
1121  * drm_atomic_set_fb_for_plane - set framebuffer for plane
1122  * @plane_state: atomic state object for the plane
1123  * @fb: fb to use for the plane
1124  *
1125  * Changing the assigned framebuffer for a plane requires us to grab a reference
1126  * to the new fb and drop the reference to the old fb, if there is one. This
1127  * function takes care of all these details besides updating the pointer in the
1128  * state object itself.
1129  */
1130 void
1131 drm_atomic_set_fb_for_plane(struct drm_plane_state *plane_state,
1132                             struct drm_framebuffer *fb)
1133 {
1134         if (plane_state->fb)
1135                 drm_framebuffer_unreference(plane_state->fb);
1136         if (fb)
1137                 drm_framebuffer_reference(fb);
1138         plane_state->fb = fb;
1139
1140         if (fb)
1141                 DRM_DEBUG_ATOMIC("Set [FB:%d] for plane state %p\n",
1142                                  fb->base.id, plane_state);
1143         else
1144                 DRM_DEBUG_ATOMIC("Set [NOFB] for plane state %p\n",
1145                                  plane_state);
1146 }
1147 EXPORT_SYMBOL(drm_atomic_set_fb_for_plane);
1148
1149 /**
1150  * drm_atomic_set_crtc_for_connector - set crtc for connector
1151  * @conn_state: atomic state object for the connector
1152  * @crtc: crtc to use for the connector
1153  *
1154  * Changing the assigned crtc for a connector requires us to grab the lock and
1155  * state for the new crtc, as needed. This function takes care of all these
1156  * details besides updating the pointer in the state object itself.
1157  *
1158  * Returns:
1159  * 0 on success or can fail with -EDEADLK or -ENOMEM. When the error is EDEADLK
1160  * then the w/w mutex code has detected a deadlock and the entire atomic
1161  * sequence must be restarted. All other errors are fatal.
1162  */
1163 int
1164 drm_atomic_set_crtc_for_connector(struct drm_connector_state *conn_state,
1165                                   struct drm_crtc *crtc)
1166 {
1167         struct drm_crtc_state *crtc_state;
1168
1169         if (conn_state->crtc && conn_state->crtc != crtc) {
1170                 crtc_state = drm_atomic_get_existing_crtc_state(conn_state->state,
1171                                                                 conn_state->crtc);
1172
1173                 crtc_state->connector_mask &=
1174                         ~(1 << drm_connector_index(conn_state->connector));
1175         }
1176
1177         if (crtc) {
1178                 crtc_state = drm_atomic_get_crtc_state(conn_state->state, crtc);
1179                 if (IS_ERR(crtc_state))
1180                         return PTR_ERR(crtc_state);
1181
1182                 crtc_state->connector_mask |=
1183                         1 << drm_connector_index(conn_state->connector);
1184         }
1185
1186         conn_state->crtc = crtc;
1187
1188         if (crtc)
1189                 DRM_DEBUG_ATOMIC("Link connector state %p to [CRTC:%d:%s]\n",
1190                                  conn_state, crtc->base.id, crtc->name);
1191         else
1192                 DRM_DEBUG_ATOMIC("Link connector state %p to [NOCRTC]\n",
1193                                  conn_state);
1194
1195         return 0;
1196 }
1197 EXPORT_SYMBOL(drm_atomic_set_crtc_for_connector);
1198
1199 /**
1200  * drm_atomic_add_affected_connectors - add connectors for crtc
1201  * @state: atomic state
1202  * @crtc: DRM crtc
1203  *
1204  * This function walks the current configuration and adds all connectors
1205  * currently using @crtc to the atomic configuration @state. Note that this
1206  * function must acquire the connection mutex. This can potentially cause
1207  * unneeded seralization if the update is just for the planes on one crtc. Hence
1208  * drivers and helpers should only call this when really needed (e.g. when a
1209  * full modeset needs to happen due to some change).
1210  *
1211  * Returns:
1212  * 0 on success or can fail with -EDEADLK or -ENOMEM. When the error is EDEADLK
1213  * then the w/w mutex code has detected a deadlock and the entire atomic
1214  * sequence must be restarted. All other errors are fatal.
1215  */
1216 int
1217 drm_atomic_add_affected_connectors(struct drm_atomic_state *state,
1218                                    struct drm_crtc *crtc)
1219 {
1220         struct drm_mode_config *config = &state->dev->mode_config;
1221         struct drm_connector *connector;
1222         struct drm_connector_state *conn_state;
1223         int ret;
1224
1225         ret = drm_modeset_lock(&config->connection_mutex, state->acquire_ctx);
1226         if (ret)
1227                 return ret;
1228
1229         DRM_DEBUG_ATOMIC("Adding all current connectors for [CRTC:%d:%s] to %p\n",
1230                          crtc->base.id, crtc->name, state);
1231
1232         /*
1233          * Changed connectors are already in @state, so only need to look at the
1234          * current configuration.
1235          */
1236         drm_for_each_connector(connector, state->dev) {
1237                 if (connector->state->crtc != crtc)
1238                         continue;
1239
1240                 conn_state = drm_atomic_get_connector_state(state, connector);
1241                 if (IS_ERR(conn_state))
1242                         return PTR_ERR(conn_state);
1243         }
1244
1245         return 0;
1246 }
1247 EXPORT_SYMBOL(drm_atomic_add_affected_connectors);
1248
1249 /**
1250  * drm_atomic_add_affected_planes - add planes for crtc
1251  * @state: atomic state
1252  * @crtc: DRM crtc
1253  *
1254  * This function walks the current configuration and adds all planes
1255  * currently used by @crtc to the atomic configuration @state. This is useful
1256  * when an atomic commit also needs to check all currently enabled plane on
1257  * @crtc, e.g. when changing the mode. It's also useful when re-enabling a CRTC
1258  * to avoid special code to force-enable all planes.
1259  *
1260  * Since acquiring a plane state will always also acquire the w/w mutex of the
1261  * current CRTC for that plane (if there is any) adding all the plane states for
1262  * a CRTC will not reduce parallism of atomic updates.
1263  *
1264  * Returns:
1265  * 0 on success or can fail with -EDEADLK or -ENOMEM. When the error is EDEADLK
1266  * then the w/w mutex code has detected a deadlock and the entire atomic
1267  * sequence must be restarted. All other errors are fatal.
1268  */
1269 int
1270 drm_atomic_add_affected_planes(struct drm_atomic_state *state,
1271                                struct drm_crtc *crtc)
1272 {
1273         struct drm_plane *plane;
1274
1275         WARN_ON(!drm_atomic_get_existing_crtc_state(state, crtc));
1276
1277         drm_for_each_plane_mask(plane, state->dev, crtc->state->plane_mask) {
1278                 struct drm_plane_state *plane_state =
1279                         drm_atomic_get_plane_state(state, plane);
1280
1281                 if (IS_ERR(plane_state))
1282                         return PTR_ERR(plane_state);
1283         }
1284         return 0;
1285 }
1286 EXPORT_SYMBOL(drm_atomic_add_affected_planes);
1287
1288 /**
1289  * drm_atomic_legacy_backoff - locking backoff for legacy ioctls
1290  * @state: atomic state
1291  *
1292  * This function should be used by legacy entry points which don't understand
1293  * -EDEADLK semantics. For simplicity this one will grab all modeset locks after
1294  * the slowpath completed.
1295  */
1296 void drm_atomic_legacy_backoff(struct drm_atomic_state *state)
1297 {
1298         int ret;
1299
1300 retry:
1301         drm_modeset_backoff(state->acquire_ctx);
1302
1303         ret = drm_modeset_lock_all_ctx(state->dev, state->acquire_ctx);
1304         if (ret)
1305                 goto retry;
1306 }
1307 EXPORT_SYMBOL(drm_atomic_legacy_backoff);
1308
1309 /**
1310  * drm_atomic_check_only - check whether a given config would work
1311  * @state: atomic configuration to check
1312  *
1313  * Note that this function can return -EDEADLK if the driver needed to acquire
1314  * more locks but encountered a deadlock. The caller must then do the usual w/w
1315  * backoff dance and restart. All other errors are fatal.
1316  *
1317  * Returns:
1318  * 0 on success, negative error code on failure.
1319  */
1320 int drm_atomic_check_only(struct drm_atomic_state *state)
1321 {
1322         struct drm_device *dev = state->dev;
1323         struct drm_mode_config *config = &dev->mode_config;
1324         struct drm_plane *plane;
1325         struct drm_plane_state *plane_state;
1326         struct drm_crtc *crtc;
1327         struct drm_crtc_state *crtc_state;
1328         int i, ret = 0;
1329
1330         DRM_DEBUG_ATOMIC("checking %p\n", state);
1331
1332         for_each_plane_in_state(state, plane, plane_state, i) {
1333                 ret = drm_atomic_plane_check(plane, plane_state);
1334                 if (ret) {
1335                         DRM_DEBUG_ATOMIC("[PLANE:%d:%s] atomic core check failed\n",
1336                                          plane->base.id, plane->name);
1337                         return ret;
1338                 }
1339         }
1340
1341         for_each_crtc_in_state(state, crtc, crtc_state, i) {
1342                 ret = drm_atomic_crtc_check(crtc, crtc_state);
1343                 if (ret) {
1344                         DRM_DEBUG_ATOMIC("[CRTC:%d:%s] atomic core check failed\n",
1345                                          crtc->base.id, crtc->name);
1346                         return ret;
1347                 }
1348         }
1349
1350         if (config->funcs->atomic_check)
1351                 ret = config->funcs->atomic_check(state->dev, state);
1352
1353         if (!state->allow_modeset) {
1354                 for_each_crtc_in_state(state, crtc, crtc_state, i) {
1355                         if (drm_atomic_crtc_needs_modeset(crtc_state)) {
1356                                 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] requires full modeset\n",
1357                                                  crtc->base.id, crtc->name);
1358                                 return -EINVAL;
1359                         }
1360                 }
1361         }
1362
1363         return ret;
1364 }
1365 EXPORT_SYMBOL(drm_atomic_check_only);
1366
1367 /**
1368  * drm_atomic_commit - commit configuration atomically
1369  * @state: atomic configuration to check
1370  *
1371  * Note that this function can return -EDEADLK if the driver needed to acquire
1372  * more locks but encountered a deadlock. The caller must then do the usual w/w
1373  * backoff dance and restart. All other errors are fatal.
1374  *
1375  * Also note that on successful execution ownership of @state is transferred
1376  * from the caller of this function to the function itself. The caller must not
1377  * free or in any other way access @state. If the function fails then the caller
1378  * must clean up @state itself.
1379  *
1380  * Returns:
1381  * 0 on success, negative error code on failure.
1382  */
1383 int drm_atomic_commit(struct drm_atomic_state *state)
1384 {
1385         struct drm_mode_config *config = &state->dev->mode_config;
1386         int ret;
1387
1388         ret = drm_atomic_check_only(state);
1389         if (ret)
1390                 return ret;
1391
1392         DRM_DEBUG_ATOMIC("commiting %p\n", state);
1393
1394         return config->funcs->atomic_commit(state->dev, state, false);
1395 }
1396 EXPORT_SYMBOL(drm_atomic_commit);
1397
1398 /**
1399  * drm_atomic_nonblocking_commit - atomic&nonblocking configuration commit
1400  * @state: atomic configuration to check
1401  *
1402  * Note that this function can return -EDEADLK if the driver needed to acquire
1403  * more locks but encountered a deadlock. The caller must then do the usual w/w
1404  * backoff dance and restart. All other errors are fatal.
1405  *
1406  * Also note that on successful execution ownership of @state is transferred
1407  * from the caller of this function to the function itself. The caller must not
1408  * free or in any other way access @state. If the function fails then the caller
1409  * must clean up @state itself.
1410  *
1411  * Returns:
1412  * 0 on success, negative error code on failure.
1413  */
1414 int drm_atomic_nonblocking_commit(struct drm_atomic_state *state)
1415 {
1416         struct drm_mode_config *config = &state->dev->mode_config;
1417         int ret;
1418
1419         ret = drm_atomic_check_only(state);
1420         if (ret)
1421                 return ret;
1422
1423         DRM_DEBUG_ATOMIC("commiting %p nonblocking\n", state);
1424
1425         return config->funcs->atomic_commit(state->dev, state, true);
1426 }
1427 EXPORT_SYMBOL(drm_atomic_nonblocking_commit);
1428
1429 /*
1430  * The big monstor ioctl
1431  */
1432
1433 static struct drm_pending_vblank_event *create_vblank_event(
1434                 struct drm_device *dev, struct drm_file *file_priv, uint64_t user_data)
1435 {
1436         struct drm_pending_vblank_event *e = NULL;
1437         int ret;
1438
1439         e = kzalloc(sizeof *e, GFP_KERNEL);
1440         if (!e)
1441                 return NULL;
1442
1443         e->event.base.type = DRM_EVENT_FLIP_COMPLETE;
1444         e->event.base.length = sizeof(e->event);
1445         e->event.user_data = user_data;
1446
1447         ret = drm_event_reserve_init(dev, file_priv, &e->base, &e->event.base);
1448         if (ret) {
1449                 kfree(e);
1450                 return NULL;
1451         }
1452
1453         return e;
1454 }
1455
1456 static int atomic_set_prop(struct drm_atomic_state *state,
1457                 struct drm_mode_object *obj, struct drm_property *prop,
1458                 uint64_t prop_value)
1459 {
1460         struct drm_mode_object *ref;
1461         int ret;
1462
1463         if (!drm_property_change_valid_get(prop, prop_value, &ref))
1464                 return -EINVAL;
1465
1466         switch (obj->type) {
1467         case DRM_MODE_OBJECT_CONNECTOR: {
1468                 struct drm_connector *connector = obj_to_connector(obj);
1469                 struct drm_connector_state *connector_state;
1470
1471                 connector_state = drm_atomic_get_connector_state(state, connector);
1472                 if (IS_ERR(connector_state)) {
1473                         ret = PTR_ERR(connector_state);
1474                         break;
1475                 }
1476
1477                 ret = drm_atomic_connector_set_property(connector,
1478                                 connector_state, prop, prop_value);
1479                 break;
1480         }
1481         case DRM_MODE_OBJECT_CRTC: {
1482                 struct drm_crtc *crtc = obj_to_crtc(obj);
1483                 struct drm_crtc_state *crtc_state;
1484
1485                 crtc_state = drm_atomic_get_crtc_state(state, crtc);
1486                 if (IS_ERR(crtc_state)) {
1487                         ret = PTR_ERR(crtc_state);
1488                         break;
1489                 }
1490
1491                 ret = drm_atomic_crtc_set_property(crtc,
1492                                 crtc_state, prop, prop_value);
1493                 break;
1494         }
1495         case DRM_MODE_OBJECT_PLANE: {
1496                 struct drm_plane *plane = obj_to_plane(obj);
1497                 struct drm_plane_state *plane_state;
1498
1499                 plane_state = drm_atomic_get_plane_state(state, plane);
1500                 if (IS_ERR(plane_state)) {
1501                         ret = PTR_ERR(plane_state);
1502                         break;
1503                 }
1504
1505                 ret = drm_atomic_plane_set_property(plane,
1506                                 plane_state, prop, prop_value);
1507                 break;
1508         }
1509         default:
1510                 ret = -EINVAL;
1511                 break;
1512         }
1513
1514         drm_property_change_valid_put(prop, ref);
1515         return ret;
1516 }
1517
1518 /**
1519  * drm_atomic_clean_old_fb -- Unset old_fb pointers and set plane->fb pointers.
1520  *
1521  * @dev: drm device to check.
1522  * @plane_mask: plane mask for planes that were updated.
1523  * @ret: return value, can be -EDEADLK for a retry.
1524  *
1525  * Before doing an update plane->old_fb is set to plane->fb,
1526  * but before dropping the locks old_fb needs to be set to NULL
1527  * and plane->fb updated. This is a common operation for each
1528  * atomic update, so this call is split off as a helper.
1529  */
1530 void drm_atomic_clean_old_fb(struct drm_device *dev,
1531                              unsigned plane_mask,
1532                              int ret)
1533 {
1534         struct drm_plane *plane;
1535
1536         /* if succeeded, fixup legacy plane crtc/fb ptrs before dropping
1537          * locks (ie. while it is still safe to deref plane->state).  We
1538          * need to do this here because the driver entry points cannot
1539          * distinguish between legacy and atomic ioctls.
1540          */
1541         drm_for_each_plane_mask(plane, dev, plane_mask) {
1542                 if (ret == 0) {
1543                         struct drm_framebuffer *new_fb = plane->state->fb;
1544                         if (new_fb)
1545                                 drm_framebuffer_reference(new_fb);
1546                         plane->fb = new_fb;
1547                         plane->crtc = plane->state->crtc;
1548
1549                         if (plane->old_fb)
1550                                 drm_framebuffer_unreference(plane->old_fb);
1551                 }
1552                 plane->old_fb = NULL;
1553         }
1554 }
1555 EXPORT_SYMBOL(drm_atomic_clean_old_fb);
1556
1557 int drm_mode_atomic_ioctl(struct drm_device *dev,
1558                           void *data, struct drm_file *file_priv)
1559 {
1560         struct drm_mode_atomic *arg = data;
1561         uint32_t __user *objs_ptr = (uint32_t __user *)(unsigned long)(arg->objs_ptr);
1562         uint32_t __user *count_props_ptr = (uint32_t __user *)(unsigned long)(arg->count_props_ptr);
1563         uint32_t __user *props_ptr = (uint32_t __user *)(unsigned long)(arg->props_ptr);
1564         uint64_t __user *prop_values_ptr = (uint64_t __user *)(unsigned long)(arg->prop_values_ptr);
1565         unsigned int copied_objs, copied_props;
1566         struct drm_atomic_state *state;
1567         struct drm_modeset_acquire_ctx ctx;
1568         struct drm_plane *plane;
1569         struct drm_crtc *crtc;
1570         struct drm_crtc_state *crtc_state;
1571         unsigned plane_mask;
1572         int ret = 0;
1573         unsigned int i, j;
1574
1575         /* disallow for drivers not supporting atomic: */
1576         if (!drm_core_check_feature(dev, DRIVER_ATOMIC))
1577                 return -EINVAL;
1578
1579         /* disallow for userspace that has not enabled atomic cap (even
1580          * though this may be a bit overkill, since legacy userspace
1581          * wouldn't know how to call this ioctl)
1582          */
1583         if (!file_priv->atomic)
1584                 return -EINVAL;
1585
1586         if (arg->flags & ~DRM_MODE_ATOMIC_FLAGS)
1587                 return -EINVAL;
1588
1589         if (arg->reserved)
1590                 return -EINVAL;
1591
1592         if ((arg->flags & DRM_MODE_PAGE_FLIP_ASYNC) &&
1593                         !dev->mode_config.async_page_flip)
1594                 return -EINVAL;
1595
1596         /* can't test and expect an event at the same time. */
1597         if ((arg->flags & DRM_MODE_ATOMIC_TEST_ONLY) &&
1598                         (arg->flags & DRM_MODE_PAGE_FLIP_EVENT))
1599                 return -EINVAL;
1600
1601         drm_modeset_acquire_init(&ctx, 0);
1602
1603         state = drm_atomic_state_alloc(dev);
1604         if (!state)
1605                 return -ENOMEM;
1606
1607         state->acquire_ctx = &ctx;
1608         state->allow_modeset = !!(arg->flags & DRM_MODE_ATOMIC_ALLOW_MODESET);
1609
1610 retry:
1611         plane_mask = 0;
1612         copied_objs = 0;
1613         copied_props = 0;
1614
1615         for (i = 0; i < arg->count_objs; i++) {
1616                 uint32_t obj_id, count_props;
1617                 struct drm_mode_object *obj;
1618
1619                 if (get_user(obj_id, objs_ptr + copied_objs)) {
1620                         ret = -EFAULT;
1621                         goto out;
1622                 }
1623
1624                 obj = drm_mode_object_find(dev, obj_id, DRM_MODE_OBJECT_ANY);
1625                 if (!obj || !obj->properties) {
1626                         ret = -ENOENT;
1627                         goto out;
1628                 }
1629
1630                 if (get_user(count_props, count_props_ptr + copied_objs)) {
1631                         ret = -EFAULT;
1632                         goto out;
1633                 }
1634
1635                 copied_objs++;
1636
1637                 for (j = 0; j < count_props; j++) {
1638                         uint32_t prop_id;
1639                         uint64_t prop_value;
1640                         struct drm_property *prop;
1641
1642                         if (get_user(prop_id, props_ptr + copied_props)) {
1643                                 ret = -EFAULT;
1644                                 goto out;
1645                         }
1646
1647                         prop = drm_property_find(dev, prop_id);
1648                         if (!prop) {
1649                                 ret = -ENOENT;
1650                                 goto out;
1651                         }
1652
1653                         if (copy_from_user(&prop_value,
1654                                            prop_values_ptr + copied_props,
1655                                            sizeof(prop_value))) {
1656                                 ret = -EFAULT;
1657                                 goto out;
1658                         }
1659
1660                         ret = atomic_set_prop(state, obj, prop, prop_value);
1661                         if (ret)
1662                                 goto out;
1663
1664                         copied_props++;
1665                 }
1666
1667                 if (obj->type == DRM_MODE_OBJECT_PLANE && count_props &&
1668                     !(arg->flags & DRM_MODE_ATOMIC_TEST_ONLY)) {
1669                         plane = obj_to_plane(obj);
1670                         plane_mask |= (1 << drm_plane_index(plane));
1671                         plane->old_fb = plane->fb;
1672                 }
1673         }
1674
1675         if (arg->flags & DRM_MODE_PAGE_FLIP_EVENT) {
1676                 for_each_crtc_in_state(state, crtc, crtc_state, i) {
1677                         struct drm_pending_vblank_event *e;
1678
1679                         e = create_vblank_event(dev, file_priv, arg->user_data);
1680                         if (!e) {
1681                                 ret = -ENOMEM;
1682                                 goto out;
1683                         }
1684
1685                         crtc_state->event = e;
1686                 }
1687         }
1688
1689         if (arg->flags & DRM_MODE_ATOMIC_TEST_ONLY) {
1690                 /*
1691                  * Unlike commit, check_only does not clean up state.
1692                  * Below we call drm_atomic_state_free for it.
1693                  */
1694                 ret = drm_atomic_check_only(state);
1695         } else if (arg->flags & DRM_MODE_ATOMIC_NONBLOCK) {
1696                 ret = drm_atomic_nonblocking_commit(state);
1697         } else {
1698                 ret = drm_atomic_commit(state);
1699         }
1700
1701 out:
1702         drm_atomic_clean_old_fb(dev, plane_mask, ret);
1703
1704         if (ret && arg->flags & DRM_MODE_PAGE_FLIP_EVENT) {
1705                 /*
1706                  * TEST_ONLY and PAGE_FLIP_EVENT are mutually exclusive,
1707                  * if they weren't, this code should be called on success
1708                  * for TEST_ONLY too.
1709                  */
1710
1711                 for_each_crtc_in_state(state, crtc, crtc_state, i) {
1712                         if (!crtc_state->event)
1713                                 continue;
1714
1715                         drm_event_cancel_free(dev, &crtc_state->event->base);
1716                 }
1717         }
1718
1719         if (ret == -EDEADLK) {
1720                 drm_atomic_state_clear(state);
1721                 drm_modeset_backoff(&ctx);
1722                 goto retry;
1723         }
1724
1725         if (ret || arg->flags & DRM_MODE_ATOMIC_TEST_ONLY)
1726                 drm_atomic_state_free(state);
1727
1728         drm_modeset_drop_locks(&ctx);
1729         drm_modeset_acquire_fini(&ctx);
1730
1731         return ret;
1732 }