From: Lee Jones <lee.jones@linaro.org>
To: lee.jones@linaro.org
Cc: linux-arm-kernel@lists.infradead.org,
linux-kernel@vger.kernel.org, Roy Pledge <Roy.Pledge@nxp.com>,
Li Yang <leoyang.li@nxp.com>,
linuxppc-dev@lists.ozlabs.org
Subject: [PATCH 04/25] soc: fsl: dpio: qbman-portal: Fix a bunch of kernel-doc misdemeanours
Date: Tue, 3 Nov 2020 15:28:17 +0000 [thread overview]
Message-ID: <20201103152838.1290217-5-lee.jones@linaro.org> (raw)
In-Reply-To: <20201103152838.1290217-1-lee.jones@linaro.org>
Fixes the following W=1 kernel build warning(s):
drivers/soc/fsl/dpio/qbman-portal.c:430: warning: Function parameter or member 'inhibit' not described in 'qbman_swp_interrupt_set_inhibit'
drivers/soc/fsl/dpio/qbman-portal.c:430: warning: Excess function parameter 'mask' description in 'qbman_swp_interrupt_set_inhibit'
drivers/soc/fsl/dpio/qbman-portal.c:518: warning: Function parameter or member 'd' not described in 'qbman_eq_desc_clear'
drivers/soc/fsl/dpio/qbman-portal.c:529: warning: Function parameter or member 'respond_success' not described in 'qbman_eq_desc_set_no_orp'
drivers/soc/fsl/dpio/qbman-portal.c:529: warning: Excess function parameter 'response_success' description in 'qbman_eq_desc_set_no_orp'
drivers/soc/fsl/dpio/qbman-portal.c:941: warning: Function parameter or member 's' not described in 'qbman_swp_push_get'
drivers/soc/fsl/dpio/qbman-portal.c:941: warning: Excess function parameter 'p' description in 'qbman_swp_push_get'
drivers/soc/fsl/dpio/qbman-portal.c:955: warning: Function parameter or member 's' not described in 'qbman_swp_push_set'
drivers/soc/fsl/dpio/qbman-portal.c:955: warning: Excess function parameter 'p' description in 'qbman_swp_push_set'
drivers/soc/fsl/dpio/qbman-portal.c:1052: warning: Function parameter or member 'd' not described in 'qbman_pull_desc_set_fq'
drivers/soc/fsl/dpio/qbman-portal.c:1065: warning: Function parameter or member 'd' not described in 'qbman_pull_desc_set_wq'
drivers/soc/fsl/dpio/qbman-portal.c:1079: warning: Function parameter or member 'd' not described in 'qbman_pull_desc_set_channel'
drivers/soc/fsl/dpio/qbman-portal.c:1403: warning: Function parameter or member 'd' not described in 'qbman_release_desc_clear'
drivers/soc/fsl/dpio/qbman-portal.c:1412: warning: Function parameter or member 'd' not described in 'qbman_release_desc_set_bpid'
drivers/soc/fsl/dpio/qbman-portal.c:1412: warning: Function parameter or member 'bpid' not described in 'qbman_release_desc_set_bpid'
drivers/soc/fsl/dpio/qbman-portal.c:1421: warning: Function parameter or member 'd' not described in 'qbman_release_desc_set_rcdi'
drivers/soc/fsl/dpio/qbman-portal.c:1421: warning: Function parameter or member 'enable' not described in 'qbman_release_desc_set_rcdi'
Cc: Roy Pledge <Roy.Pledge@nxp.com>
Cc: Li Yang <leoyang.li@nxp.com>
Cc: linuxppc-dev@lists.ozlabs.org
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
drivers/soc/fsl/dpio/qbman-portal.c | 18 +++++++++++++-----
1 file changed, 13 insertions(+), 5 deletions(-)
diff --git a/drivers/soc/fsl/dpio/qbman-portal.c b/drivers/soc/fsl/dpio/qbman-portal.c
index 659b4a570d5b5..f13da4d7d1c52 100644
--- a/drivers/soc/fsl/dpio/qbman-portal.c
+++ b/drivers/soc/fsl/dpio/qbman-portal.c
@@ -424,7 +424,7 @@ int qbman_swp_interrupt_get_inhibit(struct qbman_swp *p)
/**
* qbman_swp_interrupt_set_inhibit() - write interrupt mask register
* @p: the given software portal object
- * @mask: The mask to set in SWP_IIR register
+ * @inhibit: whether to inhibit the IRQs
*/
void qbman_swp_interrupt_set_inhibit(struct qbman_swp *p, int inhibit)
{
@@ -510,7 +510,7 @@ enum qb_enqueue_commands {
#define QB_ENQUEUE_CMD_TARGET_TYPE_SHIFT 4
#define QB_ENQUEUE_CMD_DCA_EN_SHIFT 7
-/**
+/*
* qbman_eq_desc_clear() - Clear the contents of a descriptor to
* default/starting state.
*/
@@ -522,7 +522,7 @@ void qbman_eq_desc_clear(struct qbman_eq_desc *d)
/**
* qbman_eq_desc_set_no_orp() - Set enqueue descriptor without orp
* @d: the enqueue descriptor.
- * @response_success: 1 = enqueue with response always; 0 = enqueue with
+ * @respond_success: 1 = enqueue with response always; 0 = enqueue with
* rejections returned on a FQ.
*/
void qbman_eq_desc_set_no_orp(struct qbman_eq_desc *d, int respond_success)
@@ -932,7 +932,7 @@ int qbman_swp_enqueue_multiple_desc_mem_back(struct qbman_swp *s,
/**
* qbman_swp_push_get() - Get the push dequeue setup
- * @p: the software portal object
+ * @s: the software portal object
* @channel_idx: the channel index to query
* @enabled: returned boolean to show whether the push dequeue is enabled
* for the given channel
@@ -947,7 +947,7 @@ void qbman_swp_push_get(struct qbman_swp *s, u8 channel_idx, int *enabled)
/**
* qbman_swp_push_set() - Enable or disable push dequeue
- * @p: the software portal object
+ * @s: the software portal object
* @channel_idx: the channel index (0 to 15)
* @enable: enable or disable push dequeue
*/
@@ -1046,6 +1046,7 @@ void qbman_pull_desc_set_numframes(struct qbman_pull_desc *d, u8 numframes)
/**
* qbman_pull_desc_set_fq() - Set fqid from which the dequeue command dequeues
+ * @d: the pull dequeue descriptor to be set
* @fqid: the frame queue index of the given FQ
*/
void qbman_pull_desc_set_fq(struct qbman_pull_desc *d, u32 fqid)
@@ -1057,6 +1058,7 @@ void qbman_pull_desc_set_fq(struct qbman_pull_desc *d, u32 fqid)
/**
* qbman_pull_desc_set_wq() - Set wqid from which the dequeue command dequeues
+ * @d: the pull dequeue descriptor to be set
* @wqid: composed of channel id and wqid within the channel
* @dct: the dequeue command type
*/
@@ -1071,6 +1073,7 @@ void qbman_pull_desc_set_wq(struct qbman_pull_desc *d, u32 wqid,
/**
* qbman_pull_desc_set_channel() - Set channelid from which the dequeue command
* dequeues
+ * @d: the pull dequeue descriptor to be set
* @chid: the channel id to be dequeued
* @dct: the dequeue command type
*/
@@ -1398,6 +1401,7 @@ int qbman_result_has_new_result(struct qbman_swp *s, const struct dpaa2_dq *dq)
/**
* qbman_release_desc_clear() - Clear the contents of a descriptor to
* default/starting state.
+ * @d: the pull dequeue descriptor to be cleared
*/
void qbman_release_desc_clear(struct qbman_release_desc *d)
{
@@ -1407,6 +1411,8 @@ void qbman_release_desc_clear(struct qbman_release_desc *d)
/**
* qbman_release_desc_set_bpid() - Set the ID of the buffer pool to release to
+ * @d: the pull dequeue descriptor to be set
+ * @bpid: the bpid value to be set
*/
void qbman_release_desc_set_bpid(struct qbman_release_desc *d, u16 bpid)
{
@@ -1416,6 +1422,8 @@ void qbman_release_desc_set_bpid(struct qbman_release_desc *d, u16 bpid)
/**
* qbman_release_desc_set_rcdi() - Determines whether or not the portal's RCDI
* interrupt source should be asserted after the release command is completed.
+ * @d: the pull dequeue descriptor to be set
+ * @enable: enable (1) or disable (0) value
*/
void qbman_release_desc_set_rcdi(struct qbman_release_desc *d, int enable)
{
--
2.25.1
next prev parent reply other threads:[~2020-11-03 15:29 UTC|newest]
Thread overview: 58+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-11-03 15:28 [PATCH 00/25] Rid W=1 warnings in SoC Lee Jones
2020-11-03 15:28 ` [PATCH 01/25] soc: bcm: brcmstb: pm: pm-arm: Provide prototype for brcmstb_pm_s3_finish() Lee Jones
2020-11-04 3:25 ` Florian Fainelli
2020-11-26 9:20 ` Lee Jones
2020-11-27 17:05 ` Florian Fainelli
2020-11-27 17:20 ` Lee Jones
2020-11-03 15:28 ` [PATCH 02/25] soc: qcom: qcom_aoss: Remove set but unused variable 'tlen' Lee Jones
2020-11-03 15:28 ` [PATCH 03/25] soc: qcom: qcom_aoss: Add missing description for 'cooling_devs' Lee Jones
2020-11-03 15:28 ` Lee Jones [this message]
2020-11-03 15:28 ` [PATCH 05/25] soc: rockchip: io-domain: Remove incorrect and incomplete comment header Lee Jones
2020-11-12 10:33 ` Lee Jones
2020-11-12 11:13 ` Heiko Stübner
2020-11-12 13:22 ` Lee Jones
2020-11-12 13:23 ` Heiko Stübner
2020-11-12 13:28 ` Lee Jones
2020-11-12 13:30 ` Heiko Stübner
2020-11-12 13:47 ` Lee Jones
2020-11-03 15:28 ` [PATCH 06/25] soc: ti: knav_qmss_queue: Remove set but unchecked variable 'ret' Lee Jones
2020-11-12 10:31 ` Lee Jones
2020-11-12 12:25 ` Tero Kristo
2020-11-12 13:21 ` Lee Jones
2020-11-12 13:33 ` Tero Kristo
2020-11-12 17:50 ` santosh.shilimkar
2020-11-12 19:02 ` Lee Jones
2020-11-12 19:47 ` santosh.shilimkar
2020-11-12 20:07 ` Lee Jones
2020-11-03 15:28 ` [PATCH 07/25] soc: ti: knav_qmss_queue: Fix a whole host of function documentation issues Lee Jones
2020-11-03 15:28 ` [PATCH 08/25] soc: ti: knav_dma: Fix a kernel function doc formatting issue Lee Jones
2020-11-03 15:28 ` [PATCH 09/25] soc: ti: pm33xx: Remove set but unused variable 'ret' Lee Jones
2020-11-03 15:28 ` [PATCH 10/25] soc: ti: wkup_m3_ipc: Document 'm3_ipc' parameter throughout Lee Jones
2020-11-03 15:28 ` [PATCH 11/25] soc: fsl: qe: qe_common: Fix misnamed function attribute 'addr' Lee Jones
2020-11-12 10:33 ` Lee Jones
2020-11-12 23:12 ` Leo Li
2020-11-13 7:15 ` Lee Jones
2020-11-03 15:28 ` [PATCH 12/25] soc: qcom: qcom-geni-se: Fix misnamed function parameter 'rx_rfr' Lee Jones
2020-11-03 15:28 ` [PATCH 13/25] soc: tegra: fuse: speedo-tegra124: Remove some set but unused variables Lee Jones
2020-11-10 19:39 ` Thierry Reding
2020-11-03 15:28 ` [PATCH 14/25] soc: samsung: s3c-pm-check: Fix incorrectly named variable 'val' Lee Jones
2020-11-03 20:38 ` Krzysztof Kozlowski
2020-11-03 15:28 ` [PATCH 15/25] soc: qcom: rpmh: Fix possible doc-rot in rpmh_write()'s header Lee Jones
2020-11-03 15:28 ` [PATCH 16/25] soc: qcom: smem: Fix formatting and missing documentation issues Lee Jones
2020-11-03 15:28 ` [PATCH 17/25] soc: qcom: smsm: Fix some kernel-doc formatting and naming problems Lee Jones
2020-11-03 15:28 ` [PATCH 18/25] soc: qcom: wcnss_ctrl: Demote non-conformant struct header and fix function headers Lee Jones
2020-11-03 15:28 ` [PATCH 19/25] soc: qcom: smp2p: Remove unused struct attribute provide another Lee Jones
2020-11-11 5:20 ` Bjorn Andersson
2020-11-11 7:11 ` Lee Jones
2020-11-03 15:28 ` [PATCH 20/25] soc: qcom: llcc-qcom: Fix expected kernel-doc formatting Lee Jones
2020-11-03 15:28 ` [PATCH 21/25] soc: qcom: rpmhpd: Provide some missing struct member descriptions Lee Jones
2020-11-03 15:28 ` [PATCH 22/25] soc: qcom: kryo-l2-accessors: Fix misnaming of 'val' Lee Jones
2020-11-03 15:28 ` [PATCH 23/25] soc: ti: k3-ringacc: Provide documentation for 'k3_ring's 'state' Lee Jones
2020-11-03 15:28 ` [PATCH 24/25] soc: tegra: fuse: speedo-tegra210: Remove a group of set but unused variables Lee Jones
2020-11-10 19:41 ` Thierry Reding
2020-11-10 21:02 ` Lee Jones
2020-11-03 15:28 ` [PATCH 25/25] soc: fsl: qbman: qman: Remove unused variable 'dequeue_wq' Lee Jones
2020-11-24 0:49 ` Li Yang
2020-11-11 5:25 ` [PATCH 00/25] Rid W=1 warnings in SoC Bjorn Andersson
2020-11-12 11:16 ` Heiko Stuebner
2020-11-24 0:44 ` Li Yang
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=20201103152838.1290217-5-lee.jones@linaro.org \
--to=lee.jones@linaro.org \
--cc=Roy.Pledge@nxp.com \
--cc=leoyang.li@nxp.com \
--cc=linux-arm-kernel@lists.infradead.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linuxppc-dev@lists.ozlabs.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).