mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: Lee Jones <lee.jones@linaro.org>
To: lee.jones@linaro.org
Cc: linux-kernel@vger.kernel.org,
	"Harry Wentland" <harry.wentland@amd.com>,
	"Leo Li" <sunpeng.li@amd.com>,
	"Alex Deucher" <alexander.deucher@amd.com>,
	"Christian König" <christian.koenig@amd.com>,
	"David Airlie" <airlied@linux.ie>,
	"Daniel Vetter" <daniel@ffwll.ch>,
	amd-gfx@lists.freedesktop.org, dri-devel@lists.freedesktop.org
Subject: [PATCH 22/40] drm/amd/display/dc/bios/bios_parser2: Fix some formatting issues and missing parameter docs
Date: Fri,  8 Jan 2021 20:14:39 +0000	[thread overview]
Message-ID: <20210108201457.3078600-23-lee.jones@linaro.org> (raw)
In-Reply-To: <20210108201457.3078600-1-lee.jones@linaro.org>

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

 drivers/gpu/drm/amd/amdgpu/../display/dc/bios/bios_parser2.c:501: warning: Function parameter or member 'dcb' not described in 'bios_parser_get_gpio_pin_info'
 drivers/gpu/drm/amd/amdgpu/../display/dc/bios/bios_parser2.c:501: warning: Function parameter or member 'gpio_id' not described in 'bios_parser_get_gpio_pin_info'
 drivers/gpu/drm/amd/amdgpu/../display/dc/bios/bios_parser2.c:501: warning: Function parameter or member 'info' not described in 'bios_parser_get_gpio_pin_info'
 drivers/gpu/drm/amd/amdgpu/../display/dc/bios/bios_parser2.c:815: warning: Function parameter or member 'dcb' not described in 'bios_parser_get_spread_spectrum_info'
 drivers/gpu/drm/amd/amdgpu/../display/dc/bios/bios_parser2.c:815: warning: Function parameter or member 'signal' not described in 'bios_parser_get_spread_spectrum_info'
 drivers/gpu/drm/amd/amdgpu/../display/dc/bios/bios_parser2.c:815: warning: Function parameter or member 'index' not described in 'bios_parser_get_spread_spectrum_info'
 drivers/gpu/drm/amd/amdgpu/../display/dc/bios/bios_parser2.c:815: warning: Function parameter or member 'ss_info' not described in 'bios_parser_get_spread_spectrum_info'
 drivers/gpu/drm/amd/amdgpu/../display/dc/bios/bios_parser2.c:1210: warning: Function parameter or member 'dcb' not described in 'bios_parser_set_scratch_critical_state'
 drivers/gpu/drm/amd/amdgpu/../display/dc/bios/bios_parser2.c:1210: warning: Function parameter or member 'state' not described in 'bios_parser_set_scratch_critical_state'

Cc: Harry Wentland <harry.wentland@amd.com>
Cc: Leo Li <sunpeng.li@amd.com>
Cc: Alex Deucher <alexander.deucher@amd.com>
Cc: "Christian König" <christian.koenig@amd.com>
Cc: David Airlie <airlied@linux.ie>
Cc: Daniel Vetter <daniel@ffwll.ch>
Cc: amd-gfx@lists.freedesktop.org
Cc: dri-devel@lists.freedesktop.org
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
 .../drm/amd/display/dc/bios/bios_parser2.c    | 29 +++++++++----------
 1 file changed, 14 insertions(+), 15 deletions(-)

diff --git a/drivers/gpu/drm/amd/display/dc/bios/bios_parser2.c b/drivers/gpu/drm/amd/display/dc/bios/bios_parser2.c
index 670c265838178..9f9fda3118d1f 100644
--- a/drivers/gpu/drm/amd/display/dc/bios/bios_parser2.c
+++ b/drivers/gpu/drm/amd/display/dc/bios/bios_parser2.c
@@ -485,10 +485,11 @@ static struct atom_hpd_int_record *get_hpd_record(
  * bios_parser_get_gpio_pin_info
  * Get GpioPin information of input gpio id
  *
- * @param gpio_id, GPIO ID
- * @param info, GpioPin information structure
- * @return Bios parser result code
- * @note
+ * @dcb:     pointer to the DC BIOS
+ * @gpio_id: GPIO ID
+ * @info:    GpioPin information structure
+ * return: Bios parser result code
+ * note:
  *  to get the GPIO PIN INFO, we need:
  *  1. get the GPIO_ID from other object table, see GetHPDInfo()
  *  2. in DATA_TABLE.GPIO_Pin_LUT, search all records,
@@ -801,11 +802,11 @@ static enum bp_result get_ss_info_v4_2(
  * ver 3.1,
  * there is only one entry for each signal /ss id.  However, there is
  * no planning of supporting multiple spread Sprectum entry for EverGreen
- * @param [in] this
- * @param [in] signal, ASSignalType to be converted to info index
- * @param [in] index, number of entries that match the converted info index
- * @param [out] ss_info, sprectrum information structure,
- * @return Bios parser result code
+ * @dcb:     pointer to the DC BIOS
+ * @signal:  ASSignalType to be converted to info index
+ * @index:   number of entries that match the converted info index
+ * @ss_info: sprectrum information structure,
+ * return: Bios parser result code
  */
 static enum bp_result bios_parser_get_spread_spectrum_info(
 	struct dc_bios *dcb,
@@ -1196,13 +1197,11 @@ static bool bios_parser_is_accelerated_mode(
 }
 
 /**
- * bios_parser_set_scratch_critical_state
+ * bios_parser_set_scratch_critical_state - update critical state bit
+ *                                          in VBIOS scratch register
  *
- * @brief
- *  update critical state bit in VBIOS scratch register
- *
- * @param
- *  bool - to set or reset state
+ * @dcb:   pointer to the DC BIO
+ * @state: set or reset state
  */
 static void bios_parser_set_scratch_critical_state(
 	struct dc_bios *dcb,
-- 
2.25.1


  parent reply	other threads:[~2021-01-08 20:19 UTC|newest]

Thread overview: 77+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-01-08 20:14 [PATCH 00/40] [Set 11] Rid W=1 warnings from GPU Lee Jones
2021-01-08 20:14 ` [PATCH 01/40] drm/nouveau/nvkm/subdev/bios/init: Demote obvious abuse of kernel-doc Lee Jones
2021-01-08 20:14 ` [PATCH 02/40] drm/nouveau/dispnv50/disp: Remove unused variable 'ret' Lee Jones
2021-01-08 20:14 ` [PATCH 03/40] drm/msm/dp/dp_display: Remove unused variable 'hpd' Lee Jones
2021-01-08 20:14 ` [PATCH 04/40] drm/amd/amdgpu/amdgpu_ih: Update 'amdgpu_ih_decode_iv_helper()'s function header Lee Jones
2021-01-08 20:30   ` Alex Deucher
2021-01-08 20:14 ` [PATCH 05/40] drm/amd/amdgpu/vega20_ih: Add missing descriptions for 'ih' and fix spelling error Lee Jones
2021-01-08 20:31   ` Alex Deucher
2021-01-08 20:14 ` [PATCH 06/40] drm/amd/pm/powerplay/hwmgr/process_pptables_v1_0: Provide description of 'call_back_func' Lee Jones
2021-01-08 20:32   ` Alex Deucher
2021-01-08 20:14 ` [PATCH 07/40] drm/amd/pm/powerplay/hwmgr/ppatomctrl: Fix documentation for 'mpll_param' Lee Jones
2021-01-08 20:33   ` Alex Deucher
2021-01-08 20:14 ` [PATCH 08/40] drm/amd/pm/powerplay/hwmgr/vega12_hwmgr: Fix legacy function header formatting Lee Jones
2021-01-08 20:34   ` Alex Deucher
2021-01-08 20:14 ` [PATCH 09/40] drm/amd/pm/powerplay/hwmgr/vega20_hwmgr: " Lee Jones
2021-01-08 20:34   ` Alex Deucher
2021-01-08 20:14 ` [PATCH 10/40] drm/amd/pm/powerplay/hwmgr/smu7_hwmgr: Fix formatting and spelling issues Lee Jones
2021-01-08 20:35   ` Alex Deucher
2021-01-08 20:14 ` [PATCH 11/40] drm/amd/pm/powerplay/hwmgr/hwmgr: Move prototype into shared header Lee Jones
2021-01-08 20:36   ` Alex Deucher
2021-01-08 20:14 ` [PATCH 12/40] drm/amd/pm/powerplay/hwmgr/vega10_hwmgr: Fix a bunch of kernel-doc formatting issues Lee Jones
2021-01-08 20:37   ` Alex Deucher
2021-01-08 20:14 ` [PATCH 13/40] drm/amd/display/dc/basics/conversion: Demote obvious kernel-doc abuse Lee Jones
2021-01-08 20:38   ` Alex Deucher
2021-01-08 20:14 ` [PATCH 14/40] drm/amd/display/amdgpu_dm/amdgpu_dm_debugfs: Demote non-kernel-doc comment blocks Lee Jones
2021-01-08 20:39   ` Alex Deucher
2021-01-08 20:14 ` [PATCH 15/40] drm/amd/display/dc/bios/command_table_helper: Fix kernel-doc formatting Lee Jones
2021-01-08 20:39   ` Alex Deucher
2021-01-08 20:14 ` [PATCH 16/40] drm/amd/display/dc/bios/command_table_helper2: Fix legacy formatting problems Lee Jones
2021-01-08 20:40   ` Alex Deucher
2021-01-08 20:14 ` [PATCH 17/40] drm/amd/display/dc/bios/bios_parser: Make local functions static Lee Jones
2021-01-08 20:40   ` Alex Deucher
2021-01-08 20:14 ` [PATCH 18/40] drm/amd/display/dc/bios/bios_parser: Fix a whole bunch of legacy doc formatting Lee Jones
2021-01-08 20:41   ` Alex Deucher
2021-01-08 20:14 ` [PATCH 19/40] drm/amd/display/dc/bios/command_table: Remove unused variable Lee Jones
2021-01-08 21:00   ` Alex Deucher
2021-01-08 20:14 ` [PATCH 20/40] include: drm: drm_atomic: Make use of 'new_plane_state' Lee Jones
2021-01-08 20:14 ` [PATCH 21/40] drm/amd/display/dc/calcs/dce_calcs: Remove unused variables 'v_filter_init_mode' and 'sclk_lvl' Lee Jones
2021-01-08 21:07   ` Alex Deucher
2021-01-14 16:50   ` Alex Deucher
2021-01-08 20:14 ` Lee Jones [this message]
2021-01-08 21:08   ` [PATCH 22/40] drm/amd/display/dc/bios/bios_parser2: Fix some formatting issues and missing parameter docs Alex Deucher
2021-01-08 20:14 ` [PATCH 23/40] drm/amd/display/dc/dce/dce_audio: Make function invoked by reference static Lee Jones
2021-01-08 21:08   ` Alex Deucher
2021-01-08 20:14 ` [PATCH 24/40] drm/amd/display/dc/dce/dce_stream_encoder: Remove unused variable 'regval' Lee Jones
2021-01-08 21:12   ` Alex Deucher
2021-01-08 20:14 ` [PATCH 25/40] drm/amd/display/dc/dce/dce_link_encoder: Make functions invoked by reference static Lee Jones
2021-01-08 21:13   ` Alex Deucher
2021-01-08 20:14 ` [PATCH 26/40] drm/amd/display/dc/dce/dce_clock_source: Fix formatting/spelling of worthy function headers Lee Jones
2021-01-08 21:14   ` Alex Deucher
2021-01-08 20:14 ` [PATCH 27/40] drm/amd/pm/powerplay/hwmgr/vega10_hwmgr: Fix worthy function headers, demote barely documented one Lee Jones
2021-01-08 21:15   ` Alex Deucher
2021-01-08 20:14 ` [PATCH 28/40] drm/amd/display/dc/dce/dce_transform: Remove 3 unused/legacy variables Lee Jones
2021-01-08 21:17   ` Alex Deucher
2021-01-08 20:14 ` [PATCH 29/40] drm/amd/display/dc/dce/dce_dmcu: Staticify local function call 'dce_dmcu_load_iram' Lee Jones
2021-01-08 21:17   ` Alex Deucher
2021-01-08 20:14 ` [PATCH 30/40] drm/amd/display/dc/dce/dce_dmcu: Move 'abm_gain_stepsize' to only source file it's used in Lee Jones
2021-01-08 21:18   ` Alex Deucher
2021-01-08 20:14 ` [PATCH 31/40] drm/amd/display/dc/dce/dce_opp: Make local functions and ones invoked by reference static Lee Jones
2021-01-08 21:19   ` Alex Deucher
2021-01-08 20:14 ` [PATCH 32/40] drm/amd/display/dc/dce/dce_aux: Remove unused function 'get_engine_type' Lee Jones
2021-01-08 21:21   ` Alex Deucher
2021-01-08 20:14 ` [PATCH 33/40] drm/nouveau/nvkm/subdev/volt/gk20a: Demote non-conformant kernel-doc headers Lee Jones
2021-01-08 20:14 ` [PATCH 34/40] drm/amd/display/dc/bios/bios_parser: Fix misspelling of function parameter Lee Jones
2021-01-08 21:21   ` Alex Deucher
2021-01-08 20:14 ` [PATCH 35/40] drm/amd/display/dc/bios/command_table: Remove unused variable and associated comment Lee Jones
2021-01-08 21:22   ` Alex Deucher
2021-01-08 20:14 ` [PATCH 36/40] drm/amd/display/dc/dce/dce_i2c_hw: Make functions called by reference static Lee Jones
2021-01-08 21:23   ` Alex Deucher
2021-01-08 20:14 ` [PATCH 37/40] drm/amd/display/dc/dce/dce_i2c_sw: Make a bunch of local functions static Lee Jones
2021-01-08 21:24   ` Alex Deucher
2021-01-08 20:14 ` [PATCH 38/40] drm/amd/display/dc/dce/dce_panel_cntl: Remove unused variables 'bl_pwm_cntl' and 'pwm_period_cntl' Lee Jones
2021-01-08 21:25   ` Alex Deucher
2021-01-08 20:14 ` [PATCH 39/40] drm/amd/display/dc/dce/dmub_psr: Demote non-conformant kernel-doc headers Lee Jones
2021-01-08 21:26   ` Alex Deucher
2021-01-08 20:14 ` [PATCH 40/40] drm/amd/display/dc/gpio/hw_factory: Delete unused function 'dal_hw_factory_destroy' Lee Jones
2021-01-08 21:27   ` Alex Deucher

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=20210108201457.3078600-23-lee.jones@linaro.org \
    --to=lee.jones@linaro.org \
    --cc=airlied@linux.ie \
    --cc=alexander.deucher@amd.com \
    --cc=amd-gfx@lists.freedesktop.org \
    --cc=christian.koenig@amd.com \
    --cc=daniel@ffwll.ch \
    --cc=dri-devel@lists.freedesktop.org \
    --cc=harry.wentland@amd.com \
    --cc=linux-kernel@vger.kernel.org \
    --cc=sunpeng.li@amd.com \
    /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

all inboxes | Powered by JetHome®