Commit 748160e7 authored Jun 24, 2020 by Lee Jones

mfd: si476x-cmd: Update si476x_cmd_am_rsq_status()'s kerneldoc

4 of the old arguments were grouped and moved into a struct which
is now passed as a pointer instead of the arguments themselves.
However, whoever carried out this work forgot to update the
function's kerneldoc header.

Fixes the following W=1 warnings:

drivers/mfd/si476x-cmd.c:746: warning: Function parameter or member 'rsqargs' not described in 'si476x_core_cmd_am_rsq_s
drivers/mfd/si476x-cmd.c:746: warning: Excess function parameter 'rsqack' description in 'si476x_core_cmd_am_rsq_status'
drivers/mfd/si476x-cmd.c:746: warning: Excess function parameter 'attune' description in 'si476x_core_cmd_am_rsq_status'
drivers/mfd/si476x-cmd.c:746: warning: Excess function parameter 'cancel' description in 'si476x_core_cmd_am_rsq_status'
drivers/mfd/si476x-cmd.c:746: warning: Excess function parameter 'stcack' description in 'si476x_core_cmd_am_rsq_status'

Cc: Andrey Smirnov <andrew.smirnov@gmail.com>
Signed-off-by: Lee Jones <lee.jones@linaro.org>

parent b1ded80a

drivers/mfd/si476x-cmd.c

+2 −6

Original line number	Diff line number	Diff line
		@@ -729,12 +729,8 @@ static int si476x_core_cmd_intb_pin_cfg_a20(struct si476x_core *core,
		* si476x_cmd_am_rsq_status - send 'AM_RSQ_STATUS' command to the
		* device
		* @core: - device to send the command to
		* @rsqack: - if set command clears RSQINT, SNRINT, SNRLINT, RSSIHINT,
		* RSSSILINT, BLENDINT, MULTHINT and MULTLINT
		* @attune: - when set the values in the status report are the values
		* that were calculated at tune
		* @cancel: - abort ongoing seek/tune opertation
		* @stcack: - clear the STCINT bin in status register
		* @rsqargs: - pointer to a structure containing a group of sub-args
		* relevant to sending the RSQ status command
		* @report: - all signal quality information retured by the command
		* (if NULL then the output of the command is ignored)
		*

Admin message