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