• Sam Ravnborg's avatar
    drm: writeback: document callbacks · 21de71f6
    Sam Ravnborg authored
    Document the callbacks:
        drm_connector_helper_funcs.prepare_writeback_job
        drm_connector_helper_funcs.cleanup_writeback_job
    
    The documentation was pulled from the changelong introducing the
    callbacks, originally written by Laurent.
    
    Adding the missing documentation fixes the following warnings:
    drm_modeset_helper_vtables.h:1052: warning: Function parameter or member 'prepare_writeback_job' not described in 'drm_connector_helper_funcs'
    drm_modeset_helper_vtables.h:1052: warning: Function parameter or member 'cleanup_writeback_job' not described in 'drm_connector_helper_funcs'
    
    v2:
      - Fix formatting (Daniel)
      - Drop changelog text and add reference (Daniel)
      - Improve grammar. and use "operation" (Laurent)
    Signed-off-by: default avatarSam Ravnborg <sam@ravnborg.org>
    Reviewed-by: default avatarDaniel Vetter <daniel.vetter@ffwll.ch>
    Reviewed-by: default avatarLaurent Pinchart <laurent.pinchart@ideasonboard.com>
    Reviewed-by: default avatarLiviu Dudau <liviu.dudau@arm.com>
    Cc: Laurent Pinchart <laurent.pinchart+renesas@ideasonboard.com>
    Cc: Liviu Dudau <liviu.dudau@arm.com>
    Cc: Daniel Vetter <daniel.vetter@ffwll.ch>
    Cc: Maarten Lankhorst <maarten.lankhorst@linux.intel.com>
    Cc: Maxime Ripard <mripard@kernel.org>
    Cc: Thomas Zimmermann <tzimmermann@suse.de>
    Cc: David Airlie <airlied@linux.ie>
    Link: https://patchwork.freedesktop.org/patch/msgid/20200406194746.26433-3-sam@ravnborg.org
    21de71f6
drm_modeset_helper_vtables.h 53.7 KB