linux-fbdev.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Lee Jones <lee.jones@linaro.org>
To: lee.jones@linaro.org
Cc: linux-kernel@vger.kernel.org, Jingoo Han <jingoohan1@gmail.com>,
	Ben Dooks <ben@simtec.co.uk>,
	linux-fbdev@vger.kernel.org, dri-devel@lists.freedesktop.org
Subject: [PATCH 24/31] video: fbdev: s3c-fb: Fix some kernel-doc misdemeanours
Date: Wed, 13 Jan 2021 14:50:02 +0000	[thread overview]
Message-ID: <20210113145009.1272040-25-lee.jones@linaro.org> (raw)
In-Reply-To: <20210113145009.1272040-1-lee.jones@linaro.org>

Fixes the following W=1 kernel build warning(s):

 drivers/video/fbdev/s3c-fb.c:104: warning: Function parameter or member 'osd_stride' not described in 's3c_fb_variant'
 drivers/video/fbdev/s3c-fb.c:174: warning: Function parameter or member 'variant' not described in 's3c_fb_win'
 drivers/video/fbdev/s3c-fb.c:345: warning: Function parameter or member 'pixclk' not described in 's3c_fb_calc_pixclk'
 drivers/video/fbdev/s3c-fb.c:345: warning: Excess function parameter 'pixclock' description in 's3c_fb_calc_pixclk'
 drivers/video/fbdev/s3c-fb.c:742: warning: Function parameter or member 'transp' not described in 's3c_fb_setcolreg'
 drivers/video/fbdev/s3c-fb.c:742: warning: Excess function parameter 'trans' description in 's3c_fb_setcolreg'
 drivers/video/fbdev/s3c-fb.c:1142: warning: Function parameter or member 'sfb' not described in 's3c_fb_release_win'
 drivers/video/fbdev/s3c-fb.c:1172: warning: Function parameter or member 'win_no' not described in 's3c_fb_probe_win'

Cc: Jingoo Han <jingoohan1@gmail.com>
Cc: Ben Dooks <ben@simtec.co.uk>
Cc: linux-fbdev@vger.kernel.org
Cc: dri-devel@lists.freedesktop.org
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
 drivers/video/fbdev/s3c-fb.c | 9 ++++++---
 1 file changed, 6 insertions(+), 3 deletions(-)

diff --git a/drivers/video/fbdev/s3c-fb.c b/drivers/video/fbdev/s3c-fb.c
index ba316bd56efd7..d33d7df77a6a5 100644
--- a/drivers/video/fbdev/s3c-fb.c
+++ b/drivers/video/fbdev/s3c-fb.c
@@ -75,6 +75,7 @@ struct s3c_fb;
  * @buf_size: Offset of buffer size registers.
  * @buf_end: Offset of buffer end registers.
  * @osd: The base for the OSD registers.
+ * @osd_stride: The OSD stride value.
  * @palette: Address of palette memory, or 0 if none.
  * @has_prtcon: Set if has PRTCON register.
  * @has_shadowcon: Set if has SHADOWCON register.
@@ -155,7 +156,7 @@ struct s3c_fb_palette {
  * @windata: The platform data supplied for the window configuration.
  * @parent: The hardware that this window is part of.
  * @fbinfo: Pointer pack to the framebuffer info for this window.
- * @varint: The variant information for this window.
+ * @variant: The variant information for this window.
  * @palette_buffer: Buffer/cache to hold palette entries.
  * @pseudo_palette: For use in TRUECOLOUR modes for entries 0..15/
  * @index: The window number of this window.
@@ -336,7 +337,7 @@ static int s3c_fb_check_var(struct fb_var_screeninfo *var,
 /**
  * s3c_fb_calc_pixclk() - calculate the divider to create the pixel clock.
  * @sfb: The hardware state.
- * @pixclock: The pixel clock wanted, in picoseconds.
+ * @pixclk: The pixel clock wanted, in picoseconds.
  *
  * Given the specified pixel clock, work out the necessary divider to get
  * close to the output frequency.
@@ -733,7 +734,7 @@ static inline unsigned int chan_to_field(unsigned int chan,
  * @red: The red field for the palette data.
  * @green: The green field for the palette data.
  * @blue: The blue field for the palette data.
- * @trans: The transparency (alpha) field for the palette data.
+ * @transp: The transparency (alpha) field for the palette data.
  * @info: The framebuffer being changed.
  */
 static int s3c_fb_setcolreg(unsigned regno,
@@ -1133,6 +1134,7 @@ static void s3c_fb_free_memory(struct s3c_fb *sfb, struct s3c_fb_win *win)
 
 /**
  * s3c_fb_release_win() - release resources for a framebuffer window.
+ * @sfb: The base resources for the hardware.
  * @win: The window to cleanup the resources for.
  *
  * Release the resources that where claimed for the hardware window,
@@ -1160,6 +1162,7 @@ static void s3c_fb_release_win(struct s3c_fb *sfb, struct s3c_fb_win *win)
 /**
  * s3c_fb_probe_win() - register an hardware window
  * @sfb: The base resources for the hardware
+ * @win_no: The ID of the window to be registered
  * @variant: The variant information for this window.
  * @res: Pointer to where to place the resultant window.
  *
-- 
2.25.1


  parent reply	other threads:[~2021-01-13 14:52 UTC|newest]

Thread overview: 41+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-01-13 14:49 [PATCH 00/31] Rid W=1 warnings from Video Lee Jones
2021-01-13 14:49 ` [PATCH 01/31] video: fbdev: core: fbmon: Add missing description for 'specs' Lee Jones
2021-01-13 14:49 ` [PATCH 02/31] video: of_display_timing: Provide missing description for 'dt' Lee Jones
2021-01-13 14:49 ` [PATCH 03/31] video: fbdev: aty: atyfb_base: Remove superfluous code surrounding 'dac_type' Lee Jones
2021-01-13 14:49 ` [PATCH 04/31] video: fbdev: aty: atyfb_base: Mark 'dac_type' as __maybe_unused Lee Jones
2021-01-13 14:49 ` [PATCH 05/31] video: of_videomode: Fix formatting in kernel-doc header Lee Jones
2021-01-13 14:49 ` [PATCH 06/31] video: fbdev: core: fb_notify: Demote non-conformant " Lee Jones
2021-01-13 14:49 ` [PATCH 07/31] video: fbdev: riva: fbdev: Fix some kernel-doc misdemeanours Lee Jones
2021-01-13 14:49 ` [PATCH 08/31] video: fbdev: sis: sis_main: Remove unused variable 'reg' Lee Jones
2021-01-13 14:49 ` [PATCH 09/31] video: fbdev: sis: Remove superfluous include of 'init.h' Lee Jones
2021-01-13 14:49 ` [PATCH 10/31] video: fbdev: riva: riva_hw: Remove a bunch of unused variables Lee Jones
2021-01-13 14:49 ` [PATCH 11/31] video: fbdev: sis: init: Remove four " Lee Jones
2021-01-13 14:49 ` [PATCH 12/31] video: fbdev: sis: oem310: Remove some unused static const tables Lee Jones
2021-01-13 14:49 ` [PATCH 13/31] video: fbdev: nvidia: nv_setup: Remove a couple of unused 'tmp' variables Lee Jones
2021-01-13 14:49 ` [PATCH 14/31] video: fbdev: aty: mach64_ct: Remove some set but unused variables Lee Jones
2021-01-13 15:24   ` Daniël Mantione
2021-01-13 15:45     ` Lee Jones
2021-01-13 14:49 ` [PATCH 15/31] video: fbdev: via: lcd: Remove unused variable 'mode_crt_table' Lee Jones
2021-01-13 14:49 ` [PATCH 16/31] video: fbdev: pm2fb: Fix some kernel-doc formatting issues Lee Jones
2021-01-13 14:49 ` [PATCH 17/31] video: fbdev: aty: radeon_monitor: Remove unused variable 'mon_types' Lee Jones
2021-01-13 14:49 ` [PATCH 18/31] video: fbdev: neofb: Remove unused variable 'CursorMem' Lee Jones
2021-01-13 14:49 ` [PATCH 19/31] video: fbdev: tdfxfb: Remove unused variable 'tmp' Lee Jones
2021-01-13 14:49 ` [PATCH 20/31] video: fbdev: core: fbcon: Mark 'pending' as __maybe_unused Lee Jones
2021-01-13 14:49 ` [PATCH 21/31] video: fbdev: sstfb: Mark 3 debug variables " Lee Jones
2021-01-13 14:50 ` [PATCH 22/31] video: fbdev: cirrusfb: Remove unused variable 'dummy' from 'WHDR()' Lee Jones
2021-01-13 14:50 ` [PATCH 23/31] video: fbdev: s1d13xxxfb: Mark debug variables as __maybe_unused Lee Jones
2021-01-13 14:50 ` Lee Jones [this message]
2021-01-13 20:07   ` [PATCH 24/31] video: fbdev: s3c-fb: Fix some kernel-doc misdemeanours Jingoo Han
2021-01-13 14:50 ` [PATCH 25/31] video: fbdev: mx3fb: Remove unused variable 'enabled' Lee Jones
2021-01-13 14:50 ` [PATCH 26/31] video: fbdev: riva: riva_hw: Remove set but unused variables 'vus_p' and 'vus_n' Lee Jones
2021-01-13 14:50 ` [PATCH 27/31] video: fbdev: sis: init: Remove unused variables 'cr_data2', 'VT' and 'HT' Lee Jones
2021-01-13 14:50 ` [PATCH 28/31] video: fbdev: cirrusfb: Add description for 'info' and correct spelling of 'regbase' Lee Jones
2021-01-13 14:50 ` [PATCH 29/31] video: fbdev: s1d13xxxfb: Function name must be on the 2nd line in kernel-doc Lee Jones
2021-01-13 14:50 ` [PATCH 30/31] video: fbdev: s3c-fb: Remove unused variable 'var' from 's3c_fb_probe_win()' Lee Jones
2021-01-13 20:09   ` Jingoo Han
2021-01-13 14:50 ` [PATCH 31/31] video: fbdev: mx3fb: Fix some kernel-doc issues Lee Jones
2021-01-13 19:01 ` [PATCH 00/31] Rid W=1 warnings from Video Sam Ravnborg
2021-01-13 20:25   ` Lee Jones
2021-01-14  9:04     ` Jani Nikula
2021-01-14  9:11       ` Daniel Vetter
2021-01-14  9:54         ` Daniel Vetter

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20210113145009.1272040-25-lee.jones@linaro.org \
    --to=lee.jones@linaro.org \
    --cc=ben@simtec.co.uk \
    --cc=dri-devel@lists.freedesktop.org \
    --cc=jingoohan1@gmail.com \
    --cc=linux-fbdev@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).