include/drm/drm_modeset_helper_vtables.h

3  * Copyright © 2007-2008 Dave Airlie
4  * Copyright © 2007-2008 Intel Corporation
6  * Copyright © 2011-2013 Intel Corporation
10  * Permission is hereby granted, free of charge, to any person obtaining a
60  * struct drm_crtc_helper_funcs - helper operations for CRTCs
136 	 * to look at anything else but the passed-in mode, and validate it
137 	 * against configuration-invariant hardward constraints. Any further
240 	 * optimized fast-path instead of a full mode set operation with all the
309 	 * Drivers should check plane-update related CRTC constraints in this
340 	 * driver is not allowed to change anything outside of the free-standing
341 	 * state object passed-in.
351 	 * 0 on success, -EINVAL if the state or the transition can't be
352 	 * supported, -ENOMEM on memory allocation failure and -EDEADLK if an
463 	 *     need to apply some workarounds for gpu-specific vblank irq
480 	 * of scanlines to go until end of vblank, e.g., -1 means "one scanline
495  * drm_crtc_helper_add - sets the helper vtable for a crtc
502 	crtc->helper_private = funcs;  in drm_crtc_helper_add()
506  * struct drm_encoder_helper_funcs - helper operations for encoders
552 	 * to look at anything else but the passed-in mode, and validate it
553 	 * against configuration-invariant hardward constraints. Any further
693 	 * It is not used by any helper and therefore has purely driver-specific
821 	 * driver is not allowed to change anything outside of the free-standing
822 	 * state objects passed-in or assembled in the overall &drm_atomic_state
833 	 * 0 on success, -EINVAL if the state or the transition can't be
834 	 * supported, -ENOMEM on memory allocation failure and -EDEADLK if an
844  * drm_encoder_helper_add - sets the helper vtable for an encoder
851 	encoder->helper_private = funcs;  in drm_encoder_helper_add()
855  * struct drm_connector_helper_funcs - helper operations for connectors
869 	 * probe callback somewhere in the driver-private connector structure.
897 	 * held. Because of this it's safe to inspect &drm_connector->state.
928 	 * or the error code returned by drm_modeset_lock(), -EDEADLK.
961 	 * held. Because of this it's safe to inspect &drm_connector->state.
992 	 * be influenced by the currently set display state - such constraints
1025 	 * anything outside of arguments passed-in. Atomic drivers which need to
1089 	 * driver is not allowed to change anything outside of the free-standing
1090 	 * state objects passed-in or assembled in the overall &drm_atomic_state
1095 	 * 0 on success, -EINVAL if the state or the transition can't be
1096 	 * supported, -ENOMEM on memory allocation failure and -EDEADLK if an
1153 	 * Enable hot-plug detection for the connector.
1164 	 * Disable hot-plug detection for the connector.
1174  * drm_connector_helper_add - sets the helper vtable for a connector
1181 	connector->helper_private = funcs;  in drm_connector_helper_add()
1185  * struct drm_plane_helper_funcs - helper operations for planes
1200 	 * way is to fill out the &drm_plane_state.fence of the passed-in
1216 	 * shadow-plane helpers belongs into @begin_fb_access, so that atomic
1223 	 * optional. See @begin_fb_access for preparing per-commit resources.
1253 	 * For example, with shadow-plane helpers, the GEM buffer's vmap
1306 	 * 0 on success, -EINVAL if the state or the transition can't be
1307 	 * supported, -ENOMEM on memory allocation failure and -EDEADLK if an
1318 	 * hook is called in-between the &drm_crtc_helper_funcs.atomic_begin and
1335 	 * This hook is called in-between the &drm_crtc_helper_funcs.atomic_begin
1360 	 * This hook is called in-between the
1427 	 *  - It only works for single plane updates
1428 	 *  - Async Pageflips are not supported yet
1429 	 *  - Some hw might still scan out the old buffer until the next
1439  * drm_plane_helper_add - sets the helper vtable for a plane
1446 	plane->helper_private = funcs;  in drm_plane_helper_add()
1450  * struct drm_mode_config_helper_funcs - global modeset helper operations
1470 	 * to wait for driver-internal request for implicit syncing, before