drm/komeda: Fixed warning: Function parameter or member not described
Subsystems (4)
PATCH 1/1 drm/komeda: Fixed warning: Function parameter or member not described
Fixed the warnings: Function parameter or member 'xxx' not described when make htmldocs
This patch depends on:
- https://patchwork.freedesktop.org/series/54448/
- https://patchwork.freedesktop.org/series/54449/
- https://patchwork.freedesktop.org/series/54450/
--- .../gpu/drm/arm/display/komeda/komeda_crtc.c | 14 ++++-- .../gpu/drm/arm/display/komeda/komeda_dev.h | 16 +++++-- .../arm/display/komeda/komeda_framebuffer.h | 9 +++- .../gpu/drm/arm/display/komeda/komeda_kms.h | 18 ++++++-- .../drm/arm/display/komeda/komeda_pipeline.h | 43 ++++++++++++++----- .../gpu/drm/arm/display/komeda/komeda_plane.c | 8 ++++ 6 files changed, 85 insertions(+), 23 deletions(-)
drivers/gpu/drm/arm/display/komeda/komeda_crtc.c +11 -3
@@ -18,9 +18,17 @@#include "komeda_dev.h" #include "komeda_kms.h" -/* crtc_atomic_check is the final check stage, so beside build a display data -* pipeline according the crtc_state, but still needs to release/disable the -* unclaimed pipeline resources. +/** +* komeda_crtc_atomic_check - build display output data flow +* @crtc: DRM crtc +* @state: the crtc state object +* +* crtc_atomic_check is the final check stage, so beside build a display data +* pipeline according to the crtc_state, but still needs to release or disable +* the unclaimed pipeline resources. +* +* RETURNS: +* Zero for success or -errno */ static int komeda_crtc_atomic_check(struct drm_crtc *crtc,
drivers/gpu/drm/arm/display/komeda/komeda_dev.h +12 -4
@@ -120,7 +120,7 @@ struct komeda_dev_funcs { int master_pipe, u32 active_pipes); }; -/** +/* * DISPLAY_MODE describes how many display been enabled, and which will be * passed to CHIP by &komeda_dev_funcs->change_opmode(), then CHIP can do the * pipeline resources assignment according to this usage hint.
@@ -145,24 +145,31 @@ enum {* control-abilites of device. */ struct komeda_dev { +/** @dev: the base device structure */ struct device *dev; +/** @reg_base: the base address of komeda io space */ u32 __iomem *reg_base; +/** @chip: the basic chip information */ struct komeda_chip_info chip;/** @fmt_tbl: initialized by &komeda_dev_funcs->init_format_table */ struct komeda_format_caps_table fmt_tbl;/** @pclk: APB clock for register access */ struct clk *pclk; -/** @mck: HW main engine clk */ +/** @mclk: HW main engine clk */ struct clk *mclk;/** @irq: irq number */ int irq; -struct mutex lock;/* used to protect dpmode */ -u32 dpmode;/* current display mode */ +/** @lock: used to protect dpmode */ +struct mutex lock; +/** @dpmode: current display mode */ +u32 dpmode; +/** @n_pipelines: the number of pipe in @pipelines */ int n_pipelines; +/** @pipelines: the komeda pipelines */ struct komeda_pipeline *pipelines[KOMEDA_MAX_PIPELINES ];/** @funcs: chip funcs to access to HW */
@@ -175,6 +182,7 @@ struct komeda_dev {*/ void *chip_data; +/** @debugfs_root: root directory of komeda debugfs */ struct dentry *debugfs_root; };
drivers/gpu/drm/arm/display/komeda/komeda_framebuffer.h +7 -2
@@ -10,11 +10,16 @@#include <drm/drm_framebuffer.h> #include "komeda_format_caps.h" -/** struct komeda_fb - entend drm_framebuffer with komeda attribute */ +/** +* struct komeda_fb - Entending drm_framebuffer with komeda attribute +*/ struct komeda_fb {/** @base: &drm_framebuffer */ struct drm_framebuffer base; -/* @format_caps: &komeda_format_caps */ +/** +* @format_caps: +* extends drm_format_info for komeda specific information +*/ const struct komeda_format_caps *format_caps;/** @aligned_w: aligned frame buffer width */ u32 aligned_w;
drivers/gpu/drm/arm/display/komeda/komeda_kms.h +15 -3
@@ -16,7 +16,9 @@#include <video/videomode.h> #include <video/display_timing.h> -/** struct komeda_plane - komeda instance of drm_plane */ +/** +* struct komeda_plane - komeda instance of drm_plane +*/ struct komeda_plane {/** @base: &drm_plane */ struct drm_plane base;
@@ -72,11 +74,13 @@ struct komeda_crtc {*/ struct komeda_pipeline *slave; -/* this flip_done is for tracing the disable */ +/** @disable_done: this flip_done is for tracing the disable */ struct completion *disable_done; }; -/** struct komeda_crtc_state */ +/** +* struct komeda_crtc_state +*/ struct komeda_crtc_state {/** @base: &drm_crtc_state */ struct drm_crtc_state base;
@@ -84,7 +88,15 @@ struct komeda_crtc_state {/* private properties */ /* computed state which are used by validate/check */ +/** +* @affected_pipes: +* the affected pipelines in once display instance +*/ u32 affected_pipes; +/** +* @active_pipes: +* the active pipelines in once display instance +*/ u32 active_pipes; };
drivers/gpu/drm/arm/display/komeda/komeda_pipeline.h +32 -11
129 lines not on this page · raw message
drivers/gpu/drm/arm/display/komeda/komeda_plane.c +8 -0
@@ -38,6 +38,14 @@ komeda_plane_init_data_flow(struct drm_plane_state *st,return 0 ; } +/** +* komeda_plane_atomic_check - build input data flow +* @plane: DRM plane +* @state: the plane state object +* +* RETURNS: +* Zero for success or -errno +*/ int komeda_plane_atomic_check (struct drm_plane *plane,struct drm_plane_state *state) {
Signature · 6 lines
2.17.1 _______________________________________________ dri-devel mailing list [email protected] https://lists.freedesktop.org/mailman/listinfo/dri-devel