Skip to contentSkip to conversation

soc: mediatek: mtk-infracfg: Fix kerneldoc

PATCH Applied Krzysztof Kozlowski 3 participants 6 messages Jul 29, 2020 – Aug 19, 2020

Subsystems (3)
lore
Share & tools
lore
#0 lore raw

PATCH 1/2 soc: mediatek: mtk-infracfg: Fix kerneldoc

Fix W=1 compile warnings (invalid kerneldoc):

drivers/soc/mediatek/mtk-infracfg.c:34: warning: Function parameter or member 'infracfg' not described in 'mtk_infracfg_set_bus_protection' drivers/soc/mediatek/mtk-infracfg.c:34: warning: Excess function parameter 'regmap' description in 'mtk_infracfg_set_bus_protection'

---
 drivers/soc/mediatek/mtk-infracfg.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
drivers/soc/mediatek/mtk-infracfg.c +2 -2
index 341c7ac250e3..4a123796aad3 100644
@@ -19,7 +19,7 @@
 
 /**
  * mtk_infracfg_set_bus_protection - enable bus protection
- * @regmap: The infracfg regmap
+ * @infracfg: The infracfg regmap
  * @mask: The mask containing the protection bits to be enabled.
  * @reg_update: The boolean flag determines to set the protection bits
  *              by regmap_update_bits with enable register(PROTECTEN) or
@@ -50,7 +50,7 @@ int mtk_infracfg_set_bus_protection(struct regmap *infracfg, u32 mask,
 
 /**
  * mtk_infracfg_clear_bus_protection - disable bus protection
- * @regmap: The infracfg regmap
+ * @infracfg: The infracfg regmap
  * @mask: The mask containing the protection bits to be disabled.
  * @reg_update: The boolean flag determines to clear the protection bits
  *              by regmap_update_bits with enable register(PROTECTEN) or
Signature · 1 line
2.17.1
#1 lore raw

PATCH 2/2 soc: qcom: smd-rpm: Fix kerneldoc

Fix W=1 compile warnings (invalid kerneldoc):

drivers/soc/qcom/smd-rpm.c:35: warning: Function parameter or member 'dev' not described in 'qcom_smd_rpm' drivers/soc/qcom/smd-rpm.c:99: warning: Function parameter or member 'state' not described in 'qcom_rpm_smd_write'

---
 drivers/soc/qcom/smd-rpm.c | 2 ++
 1 file changed, 2 insertions(+)
drivers/soc/qcom/smd-rpm.c +2 -0
index 877b13850730..1d4eb46b417a 100644
@@ -20,6 +20,7 @@
  * struct qcom_smd_rpm - state of the rpm device driver
  * @rpm_channel:	reference to the smd channel
  * @icc:		interconnect proxy device
+ * @dev:		rpm device
  * @ack:		completion for acks
  * @lock:		mutual exclusion around the send/complete pair
  * @ack_status:		result of the rpm request
@@ -86,6 +87,7 @@ struct qcom_rpm_message {
 /**
  * qcom_rpm_smd_write - write @buf to @type:@id
  * @rpm:	rpm handle
+ * @state:	active/sleep state flags
  * @type:	resource type
  * @id:		resource identifier
  * @buf:	the data to be written
Signature · 1 line
2.17.1
maintainer Applied
#3 lore raw
In reply to Krzysztof Kozlowski
Quoted 6 lines · Krzysztof Kozlowski

Fix W=1 compile warnings (invalid kerneldoc):

drivers/soc/mediatek/mtk-infracfg.c:34: warning: Function parameter or member 'infracfg' not described in 'mtk_infracfg_set_bus_protection' drivers/soc/mediatek/mtk-infracfg.c:34: warning: Excess function parameter 'regmap' description in 'mtk_infracfg_set_bus_protection'

Queued for v5.9-next/soc

Thanks
Matthias

Quoted 27 lines
---
  drivers/soc/mediatek/mtk-infracfg.c | 4 ++--
  1 file changed, 2 insertions(+), 2 deletions(-)
drivers/soc/mediatek/mtk-infracfg.c +2 -2
index 341c7ac250e3..4a123796aad3 100644
@@ -19,7 +19,7 @@
 
  /**
   * mtk_infracfg_set_bus_protection - enable bus protection
- * @regmap: The infracfg regmap
+ * @infracfg: The infracfg regmap
   * @mask: The mask containing the protection bits to be enabled.
   * @reg_update: The boolean flag determines to set the protection bits
   *              by regmap_update_bits with enable register(PROTECTEN) or
@@ -50,7 +50,7 @@ int mtk_infracfg_set_bus_protection(struct regmap *infracfg, u32 mask,
 
  /**
   * mtk_infracfg_clear_bus_protection - disable bus protection
- * @regmap: The infracfg regmap
+ * @infracfg: The infracfg regmap
   * @mask: The mask containing the protection bits to be disabled.
   * @reg_update: The boolean flag determines to clear the protection bits
   *              by regmap_update_bits with enable register(PROTECTEN) or
#2 lore raw

Re: [PATCH 2/2] soc: qcom: smd-rpm: Fix kerneldoc

In reply to Krzysztof Kozlowski
Quoted 6 lines · Krzysztof Kozlowski

Fix W=1 compile warnings (invalid kerneldoc):

drivers/soc/qcom/smd-rpm.c:35: warning: Function parameter or member 'dev' not described in 'qcom_smd_rpm' drivers/soc/qcom/smd-rpm.c:99: warning: Function parameter or member 'state' not described in 'qcom_rpm_smd_write'

Thanks for spotting these, applied.

PS. This doesn't have any relationship with the Mediatek patch, the two goes through different maintainer trees and my manual mailbox filter almost discarded the series. So please send patches like this individually in the future.

Thanks,
Bjorn

Quoted 27 lines
---
 drivers/soc/qcom/smd-rpm.c | 2 ++
 1 file changed, 2 insertions(+)
drivers/soc/qcom/smd-rpm.c +2 -0
index 877b13850730..1d4eb46b417a 100644
@@ -20,6 +20,7 @@
  * struct qcom_smd_rpm - state of the rpm device driver
  * @rpm_channel:	reference to the smd channel
  * @icc:		interconnect proxy device
+ * @dev:		rpm device
  * @ack:		completion for acks
  * @lock:		mutual exclusion around the send/complete pair
  * @ack_status:		result of the rpm request
@@ -86,6 +87,7 @@ struct qcom_rpm_message {
 /**
  * qcom_rpm_smd_write - write @buf to @type:@id
  * @rpm:	rpm handle
+ * @state:	active/sleep state flags
  * @type:	resource type
  * @id:		resource identifier
  * @buf:	the data to be written
Signature · 1 line
2.17.1
#4 lore raw
In reply to Matthias Brugger
Quoted 11 lines · Matthias Brugger
Quoted 6 lines · Krzysztof Kozlowski

Fix W=1 compile warnings (invalid kerneldoc):

drivers/soc/mediatek/mtk-infracfg.c:34: warning: Function parameter or member 'infracfg' not described in 'mtk_infracfg_set_bus_protection' drivers/soc/mediatek/mtk-infracfg.c:34: warning: Excess function parameter 'regmap' description in 'mtk_infracfg_set_bus_protection'

Queued for v5.9-next/soc

Hi,

It looks like this missed the merge window. Do you plan to keep it for v5.10?

Best regards,
Krzysztof

maintainer
#5 lore raw
Quoted 9 lines · Krzysztof Kozlowski
Quoted 8 lines · Matthias Brugger
Quoted 5 lines · Krzysztof Kozlowski

Fix W=1 compile warnings (invalid kerneldoc):

drivers/soc/mediatek/mtk-infracfg.c:34: warning: Function parameter or member 'infracfg' not described in 'mtk_infracfg_set_bus_protection' drivers/soc/mediatek/mtk-infracfg.c:34: warning: Excess function parameter 'regmap' description in 'mtk_infracfg_set_bus_protection'

Quoted 9 lines
Quoted 3 lines
Quoted 1 line

Queued for v5.9-next/soc

Hi,

It looks like this missed the merge window. Do you plan to keep it for v5.10?

Yes. I'm using the confusing way of v5.9-next branch, which means v5.10, as long as Linus does not decide to switch to v6.x

Anyway it's queued for v5.10

Regards,
Matthias