Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit aa4cd910 authored by Daniel Vetter's avatar Daniel Vetter
Browse files

drm/doc: Document drm_helper_resume_force_mode 



Stumbled over while reviewing all occurences in the DRM doc talking
about suspend/resume.

Reviewed-by: default avatarAlex Deucher <alexander.deucher@amd.com>
Signed-off-by: default avatarDaniel Vetter <daniel.vetter@ffwll.ch>
parent e1f8ebdc

Documentation/DocBook/drm.tmpl

+5 −2
Original line number Diff line number Diff line
@@ -1151,8 +1151,11 @@ int max_width, max_height;</synopsis> 
            This operation is called with the mode config lock held.

          </para>

          <note><para>

            FIXME: How should set_config interact with DPMS? If the CRTC is

            suspended, should it be resumed?

	    Note that the drm core has no notion of restoring the mode setting

	    state after resume, since all resume handling is in the full

	    responsibility of the driver. The common mode setting helper library

	    though provides a helper which can be used for this:

	    <function>drm_helper_resume_force_mode</function>.

          </para></note>

        </sect4>

        <sect4>

drivers/gpu/drm/drm_crtc_helper.c

+9 −0
Original line number Diff line number Diff line
@@ -943,6 +943,15 @@ int drm_helper_mode_fill_fb_struct(struct drm_framebuffer *fb, 
}

EXPORT_SYMBOL(drm_helper_mode_fill_fb_struct);



/**

 * drm_helper_resume_force_mode - force-restore mode setting configuration

 * @dev: drm_device which should be restored

 *

 * Drivers which use the mode setting helpers can use this function to

 * force-restore the mode setting configuration e.g. on resume or when something

 * else might have trampled over the hw state (like some overzealous old BIOSen

 * tended to do).

 */

int drm_helper_resume_force_mode(struct drm_device *dev)

{

	struct drm_crtc *crtc;