On Mon, Apr 06, 2020 at 09:47:45PM +0200, Sam Ravnborg wrote: > 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: Sam Ravnborg <[email protected]> > Reviewed-by: Daniel Vetter <[email protected]> > Reviewed-by: Laurent Pinchart <[email protected]> > Cc: Laurent Pinchart <[email protected]> > Cc: Liviu Dudau <[email protected]>
Reviewed-by: Liviu Dudau <[email protected]> Thanks! Liviu > Cc: Daniel Vetter <[email protected]> > Cc: Maarten Lankhorst <[email protected]> > Cc: Maxime Ripard <[email protected]> > Cc: Thomas Zimmermann <[email protected]> > Cc: David Airlie <[email protected]> > --- > include/drm/drm_modeset_helper_vtables.h | 27 ++++++++++++++++++++++++ > 1 file changed, 27 insertions(+) > > diff --git a/include/drm/drm_modeset_helper_vtables.h > b/include/drm/drm_modeset_helper_vtables.h > index 7c20b1c8b6a7..421a30f08463 100644 > --- a/include/drm/drm_modeset_helper_vtables.h > +++ b/include/drm/drm_modeset_helper_vtables.h > @@ -1075,8 +1075,35 @@ struct drm_connector_helper_funcs { > void (*atomic_commit)(struct drm_connector *connector, > struct drm_connector_state *state); > > + /** > + * @prepare_writeback_job: > + * > + * As writeback jobs contain a framebuffer, drivers may need to > + * prepare and clean them up the same way they can prepare and > + * clean up framebuffers for planes. This optional connector operation > + * is used to support the preparation of writeback jobs. The job > + * prepare operation is called from drm_atomic_helper_prepare_planes() > + * for struct &drm_writeback_connector connectors only. > + * > + * This operation is optional. > + * > + * This callback is used by the atomic modeset helpers. > + */ > int (*prepare_writeback_job)(struct drm_writeback_connector *connector, > struct drm_writeback_job *job); > + /** > + * @cleanup_writeback_job: > + * > + * This optional connector operation is used to support the > + * cleanup of writeback jobs. The job cleanup operation is called > + * from the existing drm_writeback_cleanup_job() function, invoked > + * both when destroying the job as part of an aborted commit, or when > + * the job completes. > + * > + * This operation is optional. > + * > + * This callback is used by the atomic modeset helpers. > + */ > void (*cleanup_writeback_job)(struct drm_writeback_connector *connector, > struct drm_writeback_job *job); > }; > -- > 2.20.1 > -- ==================== | I would like to | | fix the world, | | but they're not | | giving me the | \ source code! / --------------- ¯\_(ツ)_/¯ _______________________________________________ dri-devel mailing list [email protected] https://lists.freedesktop.org/mailman/listinfo/dri-devel
