| Message ID | 20220501103428.111286-1-krzysztof.kozlowski@linaro.org (mailing list archive) |
|---|---|
| State | Not Applicable |
| Headers | show |
| Series | [1/2] mailbox: correct kerneldoc | expand |
On 01/05/2022 12:34, Krzysztof Kozlowski wrote: > Correct kerneldoc warnings like: > > drivers/mailbox/arm_mhu_db.c:47: > warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst > drivers/mailbox/qcom-ipcc.c:58: > warning: Function parameter or member 'num_chans' not described in 'qcom_ipcc' > > Signed-off-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org> Any comments on these patches? These fix warnings and they wait for almost three weeks to be applied... Can we get the warnings fixed? Best regards, Krzysztof
On 01-05-22, 12:34, Krzysztof Kozlowski wrote: > Correct kerneldoc warnings like: > > drivers/mailbox/arm_mhu_db.c:47: > warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst > drivers/mailbox/qcom-ipcc.c:58: > warning: Function parameter or member 'num_chans' not described in 'qcom_ipcc' > > Signed-off-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org> > --- > drivers/mailbox/arm_mhu_db.c | 2 +- > drivers/mailbox/arm_mhuv2.c | 3 ++- Acked-by: Viresh Kumar <viresh.kumar@linaro.org>
On Sun, May 01, 2022 at 12:34:27PM +0200, Krzysztof Kozlowski wrote: > Correct kerneldoc warnings like: > > drivers/mailbox/arm_mhu_db.c:47: > warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst > drivers/mailbox/qcom-ipcc.c:58: > warning: Function parameter or member 'num_chans' not described in 'qcom_ipcc' > > Signed-off-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org> > --- > drivers/mailbox/arm_mhu_db.c | 2 +- I thought I had copied it from arm_mhuc.c but apparently not. Anyways, Acked-by: Sudeep Holla <sudeep.holla@arm.com>
On 19/05/2022 17:13, Sudeep Holla wrote: > On Sun, May 01, 2022 at 12:34:27PM +0200, Krzysztof Kozlowski wrote: >> Correct kerneldoc warnings like: >> >> drivers/mailbox/arm_mhu_db.c:47: >> warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst >> drivers/mailbox/qcom-ipcc.c:58: >> warning: Function parameter or member 'num_chans' not described in 'qcom_ipcc' >> >> Signed-off-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org> >> --- >> drivers/mailbox/arm_mhu_db.c | 2 +- > > I thought I had copied it from arm_mhuc.c but apparently not. Anyways, > > Acked-by: Sudeep Holla <sudeep.holla@arm.com> > Thanks! Could someone pick these two patches? Best regards, Krzysztof
On Thu, May 19, 2022 at 05:14:33PM +0200, Krzysztof Kozlowski wrote: > On 19/05/2022 17:13, Sudeep Holla wrote: > > On Sun, May 01, 2022 at 12:34:27PM +0200, Krzysztof Kozlowski wrote: > >> Correct kerneldoc warnings like: > >> > >> drivers/mailbox/arm_mhu_db.c:47: > >> warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst > >> drivers/mailbox/qcom-ipcc.c:58: > >> warning: Function parameter or member 'num_chans' not described in 'qcom_ipcc' > >> > >> Signed-off-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org> > >> --- > >> drivers/mailbox/arm_mhu_db.c | 2 +- > > > > I thought I had copied it from arm_mhuc.c but apparently not. Anyways, > > > > Acked-by: Sudeep Holla <sudeep.holla@arm.com> > > > > > Thanks! Could someone pick these two patches? > They generally go via Jassi's tree. Hi Jassi, There is another PCC driver fix that I had acked few weeks back. Please pick this as well as that when you start finalising patches for your PR for v5.19.
diff --git a/drivers/mailbox/arm_mhu_db.c b/drivers/mailbox/arm_mhu_db.c index 8674153cc893..aa0a4d83880f 100644 --- a/drivers/mailbox/arm_mhu_db.c +++ b/drivers/mailbox/arm_mhu_db.c @@ -44,7 +44,7 @@ struct arm_mhu { }; /** - * ARM MHU Mailbox allocated channel information + * struct mhu_db_channel - ARM MHU Mailbox allocated channel information * * @mhu: Pointer to parent mailbox device * @pchan: Physical channel within which this doorbell resides in diff --git a/drivers/mailbox/arm_mhuv2.c b/drivers/mailbox/arm_mhuv2.c index d997f8ebfa98..a47aef8df52f 100644 --- a/drivers/mailbox/arm_mhuv2.c +++ b/drivers/mailbox/arm_mhuv2.c @@ -160,7 +160,8 @@ enum mhuv2_frame { * struct mhuv2 - MHUv2 mailbox controller data * * @mbox: Mailbox controller belonging to the MHU frame. - * @send/recv: Base address of the register mapping region. + * @send: Base address of the register mapping region. + * @recv: Base address of the register mapping region. * @frame: Frame type: RECEIVER_FRAME or SENDER_FRAME. * @irq: Interrupt. * @windows: Channel windows implemented by the platform. diff --git a/drivers/mailbox/qcom-ipcc.c b/drivers/mailbox/qcom-ipcc.c index c5d963222014..881706da59c0 100644 --- a/drivers/mailbox/qcom-ipcc.c +++ b/drivers/mailbox/qcom-ipcc.c @@ -41,9 +41,10 @@ struct qcom_ipcc_chan_info { * @dev: Device associated with this instance * @base: Base address of the IPCC frame associated to APSS * @irq_domain: The irq_domain associated with this instance - * @chan: The mailbox channels array + * @chans: The mailbox channels array * @mchan: The per-mailbox channel info array * @mbox: The mailbox controller + * @num_chans: Number of @chans elements * @irq: Summary irq */ struct qcom_ipcc {
Correct kerneldoc warnings like: drivers/mailbox/arm_mhu_db.c:47: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst drivers/mailbox/qcom-ipcc.c:58: warning: Function parameter or member 'num_chans' not described in 'qcom_ipcc' Signed-off-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org> --- drivers/mailbox/arm_mhu_db.c | 2 +- drivers/mailbox/arm_mhuv2.c | 3 ++- drivers/mailbox/qcom-ipcc.c | 3 ++- 3 files changed, 5 insertions(+), 3 deletions(-)