| Message ID | 1464729075-22243-3-git-send-email-daniel.vetter@ffwll.ch (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
On Tue, May 31, 2016 at 11:11:12PM +0200, Daniel Vetter wrote: > kernel-doc was unhappy, appease it. > > Cc: Noralf Trønnes <noralf@tronnes.org> > Cc: laurent.pinchart@ideasonboard.com > Signed-off-by: Daniel Vetter <daniel.vetter@intel.com> On this one: s/metadat/metadata/g I know we are just appeasing the gods of kernel-doc here, but how about this: @mode_cmd: metadata to be used by the framebuffer creator function ? Best regards, Liviu > --- > drivers/gpu/drm/drm_fb_cma_helper.c | 18 ++++++++++++------ > 1 file changed, 12 insertions(+), 6 deletions(-) > > diff --git a/drivers/gpu/drm/drm_fb_cma_helper.c b/drivers/gpu/drm/drm_fb_cma_helper.c > index 172cafe11c71..9cd23283c3a0 100644 > --- a/drivers/gpu/drm/drm_fb_cma_helper.c > +++ b/drivers/gpu/drm/drm_fb_cma_helper.c > @@ -162,6 +162,10 @@ static struct drm_fb_cma *drm_fb_cma_alloc(struct drm_device *dev, > * drm_fb_cma_create_with_funcs() - helper function for the > * &drm_mode_config_funcs ->fb_create > * callback function > + * @dev: DRM device > + * @file_priv: drm file for the ioctl call > + * @mode_cmd: metadat for the framebuffer that should be created > + * @funcs: vtable to be used for the new framebuffer object > * > * This can be used to set &drm_framebuffer_funcs for drivers that need the > * dirty() callback. Use drm_fb_cma_create() if you don't need to change > @@ -223,6 +227,10 @@ EXPORT_SYMBOL_GPL(drm_fb_cma_create_with_funcs); > > /** > * drm_fb_cma_create() - &drm_mode_config_funcs ->fb_create callback function > + * @dev: DRM device > + * @file_priv: drm file for the ioctl call > + * @mode_cmd: metadat for the framebuffer that should be created > + * > * > * If your hardware has special alignment or pitch requirements these should be > * checked before calling this function. Use drm_fb_cma_create_with_funcs() if > @@ -246,7 +254,7 @@ EXPORT_SYMBOL_GPL(drm_fb_cma_create); > * This function will usually be called from the CRTC callback functions. > */ > struct drm_gem_cma_object *drm_fb_cma_get_gem_obj(struct drm_framebuffer *fb, > - unsigned int plane) > + unsigned int plane) > { > struct drm_fb_cma *fb_cma = to_fb_cma(fb); > > @@ -258,10 +266,6 @@ struct drm_gem_cma_object *drm_fb_cma_get_gem_obj(struct drm_framebuffer *fb, > EXPORT_SYMBOL_GPL(drm_fb_cma_get_gem_obj); > > #ifdef CONFIG_DEBUG_FS > -/* > - * drm_fb_cma_describe() - Helper to dump information about a single > - * CMA framebuffer object > - */ > static void drm_fb_cma_describe(struct drm_framebuffer *fb, struct seq_file *m) > { > struct drm_fb_cma *fb_cma = to_fb_cma(fb); > @@ -279,7 +283,9 @@ static void drm_fb_cma_describe(struct drm_framebuffer *fb, struct seq_file *m) > > /** > * drm_fb_cma_debugfs_show() - Helper to list CMA framebuffer objects > - * in debugfs. > + * in debugfs. > + * @m: output file > + * @arg: private data for the callback > */ > int drm_fb_cma_debugfs_show(struct seq_file *m, void *arg) > { > -- > 2.8.1 > > _______________________________________________ > dri-devel mailing list > dri-devel@lists.freedesktop.org > https://lists.freedesktop.org/mailman/listinfo/dri-devel
Hi Daniel, Thank you for the patch. On Tuesday 31 May 2016 23:11:12 Daniel Vetter wrote: > kernel-doc was unhappy, appease it. > > Cc: Noralf Trønnes <noralf@tronnes.org> > Cc: laurent.pinchart@ideasonboard.com > Signed-off-by: Daniel Vetter <daniel.vetter@intel.com> > --- > drivers/gpu/drm/drm_fb_cma_helper.c | 18 ++++++++++++------ > 1 file changed, 12 insertions(+), 6 deletions(-) > > diff --git a/drivers/gpu/drm/drm_fb_cma_helper.c > b/drivers/gpu/drm/drm_fb_cma_helper.c index 172cafe11c71..9cd23283c3a0 > 100644 > --- a/drivers/gpu/drm/drm_fb_cma_helper.c > +++ b/drivers/gpu/drm/drm_fb_cma_helper.c > @@ -162,6 +162,10 @@ static struct drm_fb_cma *drm_fb_cma_alloc(struct > drm_device *dev, > * drm_fb_cma_create_with_funcs() - helper function for the > * &drm_mode_config_funcs ->fb_create > * callback function > + * @dev: DRM device > + * @file_priv: drm file for the ioctl call > + * @mode_cmd: metadat for the framebuffer that should be created Beside the 'metadat' typo here and below, Acked-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com> I'm not fond of the description of the mode_cmd parameter, but given that this function is used as a callback helper, nobody will need to understand what the parameters are. > + * @funcs: vtable to be used for the new framebuffer object > * > * This can be used to set &drm_framebuffer_funcs for drivers that need the > * dirty() callback. Use drm_fb_cma_create() if you don't need to change @@ > -223,6 +227,10 @@ EXPORT_SYMBOL_GPL(drm_fb_cma_create_with_funcs); > > /** > * drm_fb_cma_create() - &drm_mode_config_funcs ->fb_create callback > function > + * @dev: DRM device > + * @file_priv: drm file for the ioctl call > + * @mode_cmd: metadat for the framebuffer that should be created > + * > * > * If your hardware has special alignment or pitch requirements these > should be > * checked before calling this function. Use drm_fb_cma_create_with_funcs() > if > @@ -246,7 +254,7 @@ > EXPORT_SYMBOL_GPL(drm_fb_cma_create); > * This function will usually be called from the CRTC callback functions. > */ > struct drm_gem_cma_object *drm_fb_cma_get_gem_obj(struct drm_framebuffer > *fb, > - unsigned int plane) > + unsigned int plane) > { > struct drm_fb_cma *fb_cma = to_fb_cma(fb); > > @@ -258,10 +266,6 @@ struct drm_gem_cma_object > *drm_fb_cma_get_gem_obj(struct drm_framebuffer *fb, > EXPORT_SYMBOL_GPL(drm_fb_cma_get_gem_obj); > > #ifdef CONFIG_DEBUG_FS > -/* > - * drm_fb_cma_describe() - Helper to dump information about a single > - * CMA framebuffer object > - */ > static void drm_fb_cma_describe(struct drm_framebuffer *fb, struct seq_file > *m) { > struct drm_fb_cma *fb_cma = to_fb_cma(fb); > @@ -279,7 +283,9 @@ static void drm_fb_cma_describe(struct drm_framebuffer > *fb, struct seq_file *m) > > /** > * drm_fb_cma_debugfs_show() - Helper to list CMA framebuffer objects > - * in debugfs. > + * in debugfs. > + * @m: output file > + * @arg: private data for the callback > */ > int drm_fb_cma_debugfs_show(struct seq_file *m, void *arg) > {
diff --git a/drivers/gpu/drm/drm_fb_cma_helper.c b/drivers/gpu/drm/drm_fb_cma_helper.c index 172cafe11c71..9cd23283c3a0 100644 --- a/drivers/gpu/drm/drm_fb_cma_helper.c +++ b/drivers/gpu/drm/drm_fb_cma_helper.c @@ -162,6 +162,10 @@ static struct drm_fb_cma *drm_fb_cma_alloc(struct drm_device *dev, * drm_fb_cma_create_with_funcs() - helper function for the * &drm_mode_config_funcs ->fb_create * callback function + * @dev: DRM device + * @file_priv: drm file for the ioctl call + * @mode_cmd: metadat for the framebuffer that should be created + * @funcs: vtable to be used for the new framebuffer object * * This can be used to set &drm_framebuffer_funcs for drivers that need the * dirty() callback. Use drm_fb_cma_create() if you don't need to change @@ -223,6 +227,10 @@ EXPORT_SYMBOL_GPL(drm_fb_cma_create_with_funcs); /** * drm_fb_cma_create() - &drm_mode_config_funcs ->fb_create callback function + * @dev: DRM device + * @file_priv: drm file for the ioctl call + * @mode_cmd: metadat for the framebuffer that should be created + * * * If your hardware has special alignment or pitch requirements these should be * checked before calling this function. Use drm_fb_cma_create_with_funcs() if @@ -246,7 +254,7 @@ EXPORT_SYMBOL_GPL(drm_fb_cma_create); * This function will usually be called from the CRTC callback functions. */ struct drm_gem_cma_object *drm_fb_cma_get_gem_obj(struct drm_framebuffer *fb, - unsigned int plane) + unsigned int plane) { struct drm_fb_cma *fb_cma = to_fb_cma(fb); @@ -258,10 +266,6 @@ struct drm_gem_cma_object *drm_fb_cma_get_gem_obj(struct drm_framebuffer *fb, EXPORT_SYMBOL_GPL(drm_fb_cma_get_gem_obj); #ifdef CONFIG_DEBUG_FS -/* - * drm_fb_cma_describe() - Helper to dump information about a single - * CMA framebuffer object - */ static void drm_fb_cma_describe(struct drm_framebuffer *fb, struct seq_file *m) { struct drm_fb_cma *fb_cma = to_fb_cma(fb); @@ -279,7 +283,9 @@ static void drm_fb_cma_describe(struct drm_framebuffer *fb, struct seq_file *m) /** * drm_fb_cma_debugfs_show() - Helper to list CMA framebuffer objects - * in debugfs. + * in debugfs. + * @m: output file + * @arg: private data for the callback */ int drm_fb_cma_debugfs_show(struct seq_file *m, void *arg) {
kernel-doc was unhappy, appease it. Cc: Noralf Trønnes <noralf@tronnes.org> Cc: laurent.pinchart@ideasonboard.com Signed-off-by: Daniel Vetter <daniel.vetter@intel.com> --- drivers/gpu/drm/drm_fb_cma_helper.c | 18 ++++++++++++------ 1 file changed, 12 insertions(+), 6 deletions(-)