2 * Copyright (C) 2018 Intel Corp.
4 * Permission is hereby granted, free of charge, to any person obtaining a
5 * copy of this software and associated documentation files (the "Software"),
6 * to deal in the Software without restriction, including without limitation
7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8 * and/or sell copies of the Software, and to permit persons to whom the
9 * Software is furnished to do so, subject to the following conditions:
11 * The above copyright notice and this permission notice shall be included in
12 * all copies or substantial portions of the Software.
14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
17 * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
18 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
19 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
20 * OTHER DEALINGS IN THE SOFTWARE.
23 * Rob Clark <robdclark@gmail.com>
24 * Daniel Vetter <daniel.vetter@ffwll.ch>
27 #include <drm/drm_atomic.h>
28 #include <drm/drm_atomic_state_helper.h>
29 #include <drm/drm_connector.h>
30 #include <drm/drm_crtc.h>
31 #include <drm/drm_device.h>
32 #include <drm/drm_plane.h>
33 #include <drm/drm_print.h>
34 #include <drm/drm_writeback.h>
36 #include <linux/slab.h>
37 #include <linux/dma-fence.h>
40 * DOC: atomic state reset and initialization
42 * Both the drm core and the atomic helpers assume that there is always the full
43 * and correct atomic software state for all connectors, CRTCs and planes
44 * available. Which is a bit a problem on driver load and also after system
45 * suspend. One way to solve this is to have a hardware state read-out
46 * infrastructure which reconstructs the full software state (e.g. the i915
49 * The simpler solution is to just reset the software state to everything off,
50 * which is easiest to do by calling drm_mode_config_reset(). To facilitate this
51 * the atomic helpers provide default reset implementations for all hooks.
53 * On the upside the precise state tracking of atomic simplifies system suspend
54 * and resume a lot. For drivers using drm_mode_config_reset() a complete recipe
55 * is implemented in drm_atomic_helper_suspend() and drm_atomic_helper_resume().
56 * For other drivers the building blocks are split out, see the documentation
57 * for these functions.
61 * __drm_atomic_helper_crtc_reset - reset state on CRTC
63 * @crtc_state: CRTC state to assign
65 * Initializes the newly allocated @crtc_state and assigns it to
66 * the &drm_crtc->state pointer of @crtc, usually required when
67 * initializing the drivers or when called from the &drm_crtc_funcs.reset
70 * This is useful for drivers that subclass the CRTC state.
73 __drm_atomic_helper_crtc_reset(struct drm_crtc
*crtc
,
74 struct drm_crtc_state
*crtc_state
)
77 crtc_state
->crtc
= crtc
;
79 crtc
->state
= crtc_state
;
81 EXPORT_SYMBOL(__drm_atomic_helper_crtc_reset
);
84 * drm_atomic_helper_crtc_reset - default &drm_crtc_funcs.reset hook for CRTCs
87 * Resets the atomic state for @crtc by freeing the state pointer (which might
88 * be NULL, e.g. at driver load time) and allocating a new empty state object.
90 void drm_atomic_helper_crtc_reset(struct drm_crtc
*crtc
)
92 struct drm_crtc_state
*crtc_state
=
93 kzalloc(sizeof(*crtc
->state
), GFP_KERNEL
);
96 crtc
->funcs
->atomic_destroy_state(crtc
, crtc
->state
);
98 __drm_atomic_helper_crtc_reset(crtc
, crtc_state
);
100 EXPORT_SYMBOL(drm_atomic_helper_crtc_reset
);
103 * __drm_atomic_helper_crtc_duplicate_state - copy atomic CRTC state
105 * @state: atomic CRTC state
107 * Copies atomic state from a CRTC's current state and resets inferred values.
108 * This is useful for drivers that subclass the CRTC state.
110 void __drm_atomic_helper_crtc_duplicate_state(struct drm_crtc
*crtc
,
111 struct drm_crtc_state
*state
)
113 memcpy(state
, crtc
->state
, sizeof(*state
));
115 if (state
->mode_blob
)
116 drm_property_blob_get(state
->mode_blob
);
117 if (state
->degamma_lut
)
118 drm_property_blob_get(state
->degamma_lut
);
120 drm_property_blob_get(state
->ctm
);
121 if (state
->gamma_lut
)
122 drm_property_blob_get(state
->gamma_lut
);
123 state
->mode_changed
= false;
124 state
->active_changed
= false;
125 state
->planes_changed
= false;
126 state
->connectors_changed
= false;
127 state
->color_mgmt_changed
= false;
128 state
->zpos_changed
= false;
129 state
->commit
= NULL
;
131 state
->async_flip
= false;
133 /* Self refresh should be canceled when a new update is available */
134 state
->active
= drm_atomic_crtc_effectively_active(state
);
135 state
->self_refresh_active
= false;
137 EXPORT_SYMBOL(__drm_atomic_helper_crtc_duplicate_state
);
140 * drm_atomic_helper_crtc_duplicate_state - default state duplicate hook
143 * Default CRTC state duplicate hook for drivers which don't have their own
144 * subclassed CRTC state structure.
146 struct drm_crtc_state
*
147 drm_atomic_helper_crtc_duplicate_state(struct drm_crtc
*crtc
)
149 struct drm_crtc_state
*state
;
151 if (WARN_ON(!crtc
->state
))
154 state
= kmalloc(sizeof(*state
), GFP_KERNEL
);
156 __drm_atomic_helper_crtc_duplicate_state(crtc
, state
);
160 EXPORT_SYMBOL(drm_atomic_helper_crtc_duplicate_state
);
163 * __drm_atomic_helper_crtc_destroy_state - release CRTC state
164 * @state: CRTC state object to release
166 * Releases all resources stored in the CRTC state without actually freeing
167 * the memory of the CRTC state. This is useful for drivers that subclass the
170 void __drm_atomic_helper_crtc_destroy_state(struct drm_crtc_state
*state
)
174 * In the event that a non-blocking commit returns
175 * -ERESTARTSYS before the commit_tail work is queued, we will
176 * have an extra reference to the commit object. Release it, if
177 * the event has not been consumed by the worker.
179 * state->event may be freed, so we can't directly look at
180 * state->event->base.completion.
182 if (state
->event
&& state
->commit
->abort_completion
)
183 drm_crtc_commit_put(state
->commit
);
185 kfree(state
->commit
->event
);
186 state
->commit
->event
= NULL
;
188 drm_crtc_commit_put(state
->commit
);
191 drm_property_blob_put(state
->mode_blob
);
192 drm_property_blob_put(state
->degamma_lut
);
193 drm_property_blob_put(state
->ctm
);
194 drm_property_blob_put(state
->gamma_lut
);
196 EXPORT_SYMBOL(__drm_atomic_helper_crtc_destroy_state
);
199 * drm_atomic_helper_crtc_destroy_state - default state destroy hook
201 * @state: CRTC state object to release
203 * Default CRTC state destroy hook for drivers which don't have their own
204 * subclassed CRTC state structure.
206 void drm_atomic_helper_crtc_destroy_state(struct drm_crtc
*crtc
,
207 struct drm_crtc_state
*state
)
209 __drm_atomic_helper_crtc_destroy_state(state
);
212 EXPORT_SYMBOL(drm_atomic_helper_crtc_destroy_state
);
215 * __drm_atomic_helper_plane_reset - resets planes state to default values
216 * @plane: plane object, must not be NULL
217 * @state: atomic plane state, must not be NULL
219 * Initializes plane state to default. This is useful for drivers that subclass
222 void __drm_atomic_helper_plane_reset(struct drm_plane
*plane
,
223 struct drm_plane_state
*state
)
225 state
->plane
= plane
;
226 state
->rotation
= DRM_MODE_ROTATE_0
;
228 state
->alpha
= DRM_BLEND_ALPHA_OPAQUE
;
229 state
->pixel_blend_mode
= DRM_MODE_BLEND_PREMULTI
;
231 plane
->state
= state
;
233 EXPORT_SYMBOL(__drm_atomic_helper_plane_reset
);
236 * drm_atomic_helper_plane_reset - default &drm_plane_funcs.reset hook for planes
239 * Resets the atomic state for @plane by freeing the state pointer (which might
240 * be NULL, e.g. at driver load time) and allocating a new empty state object.
242 void drm_atomic_helper_plane_reset(struct drm_plane
*plane
)
245 __drm_atomic_helper_plane_destroy_state(plane
->state
);
248 plane
->state
= kzalloc(sizeof(*plane
->state
), GFP_KERNEL
);
250 __drm_atomic_helper_plane_reset(plane
, plane
->state
);
252 EXPORT_SYMBOL(drm_atomic_helper_plane_reset
);
255 * __drm_atomic_helper_plane_duplicate_state - copy atomic plane state
256 * @plane: plane object
257 * @state: atomic plane state
259 * Copies atomic state from a plane's current state. This is useful for
260 * drivers that subclass the plane state.
262 void __drm_atomic_helper_plane_duplicate_state(struct drm_plane
*plane
,
263 struct drm_plane_state
*state
)
265 memcpy(state
, plane
->state
, sizeof(*state
));
268 drm_framebuffer_get(state
->fb
);
271 state
->commit
= NULL
;
272 state
->fb_damage_clips
= NULL
;
274 EXPORT_SYMBOL(__drm_atomic_helper_plane_duplicate_state
);
277 * drm_atomic_helper_plane_duplicate_state - default state duplicate hook
280 * Default plane state duplicate hook for drivers which don't have their own
281 * subclassed plane state structure.
283 struct drm_plane_state
*
284 drm_atomic_helper_plane_duplicate_state(struct drm_plane
*plane
)
286 struct drm_plane_state
*state
;
288 if (WARN_ON(!plane
->state
))
291 state
= kmalloc(sizeof(*state
), GFP_KERNEL
);
293 __drm_atomic_helper_plane_duplicate_state(plane
, state
);
297 EXPORT_SYMBOL(drm_atomic_helper_plane_duplicate_state
);
300 * __drm_atomic_helper_plane_destroy_state - release plane state
301 * @state: plane state object to release
303 * Releases all resources stored in the plane state without actually freeing
304 * the memory of the plane state. This is useful for drivers that subclass the
307 void __drm_atomic_helper_plane_destroy_state(struct drm_plane_state
*state
)
310 drm_framebuffer_put(state
->fb
);
313 dma_fence_put(state
->fence
);
316 drm_crtc_commit_put(state
->commit
);
318 drm_property_blob_put(state
->fb_damage_clips
);
320 EXPORT_SYMBOL(__drm_atomic_helper_plane_destroy_state
);
323 * drm_atomic_helper_plane_destroy_state - default state destroy hook
325 * @state: plane state object to release
327 * Default plane state destroy hook for drivers which don't have their own
328 * subclassed plane state structure.
330 void drm_atomic_helper_plane_destroy_state(struct drm_plane
*plane
,
331 struct drm_plane_state
*state
)
333 __drm_atomic_helper_plane_destroy_state(state
);
336 EXPORT_SYMBOL(drm_atomic_helper_plane_destroy_state
);
339 * __drm_atomic_helper_connector_reset - reset state on connector
340 * @connector: drm connector
341 * @conn_state: connector state to assign
343 * Initializes the newly allocated @conn_state and assigns it to
344 * the &drm_connector->state pointer of @connector, usually required when
345 * initializing the drivers or when called from the &drm_connector_funcs.reset
348 * This is useful for drivers that subclass the connector state.
351 __drm_atomic_helper_connector_reset(struct drm_connector
*connector
,
352 struct drm_connector_state
*conn_state
)
355 conn_state
->connector
= connector
;
357 connector
->state
= conn_state
;
359 EXPORT_SYMBOL(__drm_atomic_helper_connector_reset
);
362 * drm_atomic_helper_connector_reset - default &drm_connector_funcs.reset hook for connectors
363 * @connector: drm connector
365 * Resets the atomic state for @connector by freeing the state pointer (which
366 * might be NULL, e.g. at driver load time) and allocating a new empty state
369 void drm_atomic_helper_connector_reset(struct drm_connector
*connector
)
371 struct drm_connector_state
*conn_state
=
372 kzalloc(sizeof(*conn_state
), GFP_KERNEL
);
374 if (connector
->state
)
375 __drm_atomic_helper_connector_destroy_state(connector
->state
);
377 kfree(connector
->state
);
378 __drm_atomic_helper_connector_reset(connector
, conn_state
);
380 EXPORT_SYMBOL(drm_atomic_helper_connector_reset
);
383 * drm_atomic_helper_connector_tv_reset - Resets TV connector properties
384 * @connector: DRM connector
386 * Resets the TV-related properties attached to a connector.
388 void drm_atomic_helper_connector_tv_reset(struct drm_connector
*connector
)
390 struct drm_cmdline_mode
*cmdline
= &connector
->cmdline_mode
;
391 struct drm_connector_state
*state
= connector
->state
;
393 state
->tv
.margins
.left
= cmdline
->tv_margins
.left
;
394 state
->tv
.margins
.right
= cmdline
->tv_margins
.right
;
395 state
->tv
.margins
.top
= cmdline
->tv_margins
.top
;
396 state
->tv
.margins
.bottom
= cmdline
->tv_margins
.bottom
;
398 EXPORT_SYMBOL(drm_atomic_helper_connector_tv_reset
);
401 * __drm_atomic_helper_connector_duplicate_state - copy atomic connector state
402 * @connector: connector object
403 * @state: atomic connector state
405 * Copies atomic state from a connector's current state. This is useful for
406 * drivers that subclass the connector state.
409 __drm_atomic_helper_connector_duplicate_state(struct drm_connector
*connector
,
410 struct drm_connector_state
*state
)
412 memcpy(state
, connector
->state
, sizeof(*state
));
414 drm_connector_get(connector
);
415 state
->commit
= NULL
;
417 if (state
->hdr_output_metadata
)
418 drm_property_blob_get(state
->hdr_output_metadata
);
420 /* Don't copy over a writeback job, they are used only once */
421 state
->writeback_job
= NULL
;
423 EXPORT_SYMBOL(__drm_atomic_helper_connector_duplicate_state
);
426 * drm_atomic_helper_connector_duplicate_state - default state duplicate hook
427 * @connector: drm connector
429 * Default connector state duplicate hook for drivers which don't have their own
430 * subclassed connector state structure.
432 struct drm_connector_state
*
433 drm_atomic_helper_connector_duplicate_state(struct drm_connector
*connector
)
435 struct drm_connector_state
*state
;
437 if (WARN_ON(!connector
->state
))
440 state
= kmalloc(sizeof(*state
), GFP_KERNEL
);
442 __drm_atomic_helper_connector_duplicate_state(connector
, state
);
446 EXPORT_SYMBOL(drm_atomic_helper_connector_duplicate_state
);
449 * __drm_atomic_helper_connector_destroy_state - release connector state
450 * @state: connector state object to release
452 * Releases all resources stored in the connector state without actually
453 * freeing the memory of the connector state. This is useful for drivers that
454 * subclass the connector state.
457 __drm_atomic_helper_connector_destroy_state(struct drm_connector_state
*state
)
460 drm_connector_put(state
->connector
);
463 drm_crtc_commit_put(state
->commit
);
465 if (state
->writeback_job
)
466 drm_writeback_cleanup_job(state
->writeback_job
);
468 drm_property_blob_put(state
->hdr_output_metadata
);
470 EXPORT_SYMBOL(__drm_atomic_helper_connector_destroy_state
);
473 * drm_atomic_helper_connector_destroy_state - default state destroy hook
474 * @connector: drm connector
475 * @state: connector state object to release
477 * Default connector state destroy hook for drivers which don't have their own
478 * subclassed connector state structure.
480 void drm_atomic_helper_connector_destroy_state(struct drm_connector
*connector
,
481 struct drm_connector_state
*state
)
483 __drm_atomic_helper_connector_destroy_state(state
);
486 EXPORT_SYMBOL(drm_atomic_helper_connector_destroy_state
);
489 * __drm_atomic_helper_private_duplicate_state - copy atomic private state
491 * @state: new private object state
493 * Copies atomic state from a private objects's current state and resets inferred values.
494 * This is useful for drivers that subclass the private state.
496 void __drm_atomic_helper_private_obj_duplicate_state(struct drm_private_obj
*obj
,
497 struct drm_private_state
*state
)
499 memcpy(state
, obj
->state
, sizeof(*state
));
501 EXPORT_SYMBOL(__drm_atomic_helper_private_obj_duplicate_state
);