include/drm/drm_modeset_helper_vtables.h

62  * These hooks are used by the legacy CRTC helpers and the new atomic
77 	 * This callback is used by the legacy CRTC helpers.  Atomic helpers
79 	 * facilitate transitions to atomic, but it is deprecated. Instead
92 	 * This callback is used by the legacy CRTC helpers.  Atomic helpers
94 	 * transitions to atomic, but it is deprecated. Instead @atomic_disable
107 	 * This callback is used by the legacy CRTC helpers.  Atomic helpers
109 	 * transitions to atomic, but it is deprecated. Instead @atomic_enable
127 	 * atomic helpers to validate modes supplied by userspace in
134 	 * Since this function is both called from the check phase of an atomic
159 	 * This function is used by both legacy CRTC helpers and atomic helpers.
160 	 * With atomic helpers it is optional.
164 	 * This function is called in the check phase of atomic modesets, which
166 	 * just check whether a configuration would be possible). Atomic drivers
173 	 * Atomic drivers which need to inspect and adjust more state should
201 	 * since it can't update other planes it's incompatible with atomic
219 	 * requirement of atomic and hence is used by the atomic helpers.
222 	 * called. Atomic drivers which need hardware to be running before they
244 	 * incompatible with atomic modeset support.
259 	 * and scanout without sleeping, i.e. from an atomic calling context. It
276 	 * This callback should be used to disable the CRTC. With the atomic
284 	 * This hook is used both by legacy CRTC helpers and atomic helpers.
285 	 * Atomic drivers don't need to implement it if there's no need to
288 	 * @disable must be the inverse of @atomic_enable for atomic drivers.
289 	 * Atomic drivers should consider to use @atomic_disable instead of
302 	 * rules under atomic.
328 	 * can add more state objects to the atomic commit if needed. Care must
334 	 * This callback is used by the atomic modeset helpers, but it is
339 	 * This function is called in the check phase of an atomic update. The
362 	 * Drivers should prepare for an atomic update of multiple planes on
374 	 * This callback is used by the atomic modeset helpers, but it is
382 	 * Drivers should finalize an atomic update of multiple planes on
398 	 * This callback is used by the atomic modeset helpers, but it is
407 	 * This callback should be used to enable the CRTC. With the atomic
414 	 * This hook is used only by atomic helpers, for symmetry with
415 	 * @atomic_disable. Atomic drivers don't need to implement it if there's
418 	 * @atomic_enable must be the inverse of @atomic_disable for atomic
429 	 * This callback should be used to disable the CRTC. With the atomic
437 	 * This hook is used only by atomic helpers. Atomic drivers don't
508  * These hooks are used by the legacy CRTC helpers and the new atomic
523 	 * This callback is used by the legacy CRTC helpers.  Atomic helpers
525 	 * facilitate transitions to atomic, but it is deprecated. Instead
543 	 * atomic helpers to validate modes supplied by userspace in
550 	 * Since this function is both called from the check phase of an atomic
574 	 * This function is used by both legacy CRTC helpers and atomic helpers.
579 	 * This function is called in the check phase of atomic modesets, which
581 	 * just check whether a configuration would be possible). Atomic drivers
588 	 * Atomic drivers which need to inspect and adjust more state should
616 	 * This callback is used by the legacy CRTC helpers.  Atomic helpers
618 	 * transitions to atomic, but it is deprecated. Instead @disable should
631 	 * This callback is used by the legacy CRTC helpers.  Atomic helpers
633 	 * transitions to atomic, but it is deprecated. Instead @enable should
651 	 * This callback is used both by the legacy CRTC helpers and the atomic
652 	 * modeset helpers. It is optional in the atomic helpers.
656 	 * If the driver uses the atomic modeset helpers and needs to inspect
677 	 * This callback is used by the atomic modeset helpers in place of the
708 	 * This callback should be used to disable the encoder. With the atomic
715 	 * This callback is a variant of @disable that provides the atomic state
719 	 * This hook is only used by atomic helpers. Atomic drivers don't need
738 	 * This callback is a variant of @enable that provides the atomic state
742 	 * This hook is only used by atomic helpers, it is the opposite of
743 	 * @atomic_disable. Atomic drivers don't need to implement it if there's
754 	 * This callback should be used to disable the encoder. With the atomic
761 	 * This hook is used both by legacy CRTC helpers and atomic helpers.
762 	 * Atomic drivers don't need to implement it if there's no need to
765 	 * @disable must be the inverse of @enable for atomic drivers.
767 	 * For atomic drivers also consider @atomic_disable and save yourself
780 	 * rules under atomic.
787 	 * This callback should be used to enable the encoder. With the atomic
794 	 * This hook is only used by atomic helpers, it is the opposite of
795 	 * @disable. Atomic drivers don't need to implement it if there's no
798 	 * works @enable must be the inverse of @disable for atomic drivers.
805 	 * This callback is used to validate encoder state for atomic drivers.
816 	 * This function is used by the atomic helpers, but it is optional.
820 	 * This function is called in the check phase of an atomic update. The
857  * These functions are used by the atomic and legacy modeset helpers and by the
916 	 * This is the atomic version of &drm_connector_funcs.detect.
950 	 * which are also called by the atomic helpers from
980 	 * This function is optional, and is the atomic version of
983 	 * To allow for accessing the atomic state of modesetting objects, the
992 	 * should be handled in the driver's atomic check. For example, if a
1016 	 * This function is used by both the atomic helpers (in the
1022 	 * In atomic drivers this function is called in the check phase of an
1023 	 * atomic update. The driver is not allowed to change or inspect
1024 	 * anything outside of arguments passed-in. Atomic drivers which need to
1044 	 * This is the atomic version of @best_encoder for atomic drivers which
1054 	 * This function is called in the check phase of an atomic update. The
1079 	 * can add more state objects to the atomic commit if needed. Care must
1087 	 * This function is called in the check phase of an atomic update. The
1112 	 * This callback is used by the atomic modeset helpers.
1129 	 * This callback is used by the atomic modeset helpers.
1144 	 * This callback is used by the atomic modeset helpers.
1196  * These functions are used by the atomic helpers.
1207 	 * called in the context of the atomic IOCTL even for async commits to
1221 	 * the atomic commit. Resources that can be release at the commit's end
1225 	 * shadow-plane helpers belongs into @begin_fb_access, so that atomic
1231 	 * This callback is used by the atomic modeset helpers, but it is
1238 	 * this callback is the only one which can fail an atomic commit,
1249 	 * This callback is used by the atomic modeset helpers, but it is
1258 	 * This hook prepares the plane for access during an atomic commit.
1260 	 * are released at the end of the atomic commit in @end_fb_access.
1268 	 * The callback is used by the atomic modeset helpers, but it is optional.
1298 	 * can add more state objects to the atomic commit if needed. Care must
1304 	 * This callback is used by the atomic modeset helpers, but it is
1309 	 * This function is called in the check phase of an atomic update. The
1335 	 * This callback is used by the atomic modeset helpers, but it is optional.
1357 	 * This callback is used by the atomic modeset helpers, but it is
1384 	 * This callback is used by the atomic modeset helpers, but it is
1394 	 * atomic state can be updated in a async fashion. Here async means
1461  * These helper functions are used by the atomic helpers.
1471 	 * by the atomic helpers
1473 	 * This function is called when the new atomic state has already been
1477 	 * already waited for preceding atomic commits and fences, but drivers
1482 	 * After the atomic update is committed to the hardware this hook needs
1507 	 * is not used by the atomic helpers.