diff mbox series

[v2] firmware: qcom_scm-legacy: correct kerneldoc

Message ID 20220519073410.7358-1-krzysztof.kozlowski@linaro.org
State Accepted
Commit ebf21bbc2ff56ad42994f04ada64280bc819bb0b
Headers show
Series [v2] firmware: qcom_scm-legacy: correct kerneldoc | expand

Commit Message

Krzysztof Kozlowski May 19, 2022, 7:34 a.m. UTC
Correct kerneldoc warnings like:

  drivers/firmware/qcom_scm-legacy.c:133:
    warning: Function parameter or member 'dev' not described in 'scm_legacy_call'

Signed-off-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>

---

Changes since v1:
1. Split series per subsystem.
2. Correct argument description (Stephen).
---
 drivers/firmware/qcom_scm-legacy.c | 4 ++++
 1 file changed, 4 insertions(+)

Comments

Stephen Boyd May 19, 2022, 10:12 p.m. UTC | #1
Quoting Krzysztof Kozlowski (2022-05-19 00:34:10)
> Correct kerneldoc warnings like:
> 
>   drivers/firmware/qcom_scm-legacy.c:133:
>     warning: Function parameter or member 'dev' not described in 'scm_legacy_call'
> 
> Signed-off-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
> 
> ---

Reviewed-by: Stephen Boyd <sboyd@kernel.org>
Krzysztof Kozlowski June 20, 2022, 6:34 p.m. UTC | #2
On 20/05/2022 00:12, Stephen Boyd wrote:
> Quoting Krzysztof Kozlowski (2022-05-19 00:34:10)
>> Correct kerneldoc warnings like:
>>
>>   drivers/firmware/qcom_scm-legacy.c:133:
>>     warning: Function parameter or member 'dev' not described in 'scm_legacy_call'
>>
>> Signed-off-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
>>
>> ---
> 
> Reviewed-by: Stephen Boyd <sboyd@kernel.org>

Thanks!

This was month ago... Is there anyone willing to pick it up?

Best regards,
Krzysztof
Bjorn Andersson June 27, 2022, 8:02 p.m. UTC | #3
On Thu, 19 May 2022 09:34:10 +0200, Krzysztof Kozlowski wrote:
> Correct kerneldoc warnings like:
> 
>   drivers/firmware/qcom_scm-legacy.c:133:
>     warning: Function parameter or member 'dev' not described in 'scm_legacy_call'
> 
> 

Applied, thanks!

[1/1] firmware: qcom_scm-legacy: correct kerneldoc
      commit: ebf21bbc2ff56ad42994f04ada64280bc819bb0b

Best regards,
diff mbox series

Patch

diff --git a/drivers/firmware/qcom_scm-legacy.c b/drivers/firmware/qcom_scm-legacy.c
index 1829ba220576..9f918b9e6f8f 100644
--- a/drivers/firmware/qcom_scm-legacy.c
+++ b/drivers/firmware/qcom_scm-legacy.c
@@ -120,6 +120,9 @@  static void __scm_legacy_do(const struct arm_smccc_args *smc,
 /**
  * scm_legacy_call() - Sends a command to the SCM and waits for the command to
  * finish processing.
+ * @dev:	device
+ * @desc:	descriptor structure containing arguments and return values
+ * @res:        results from SMC call
  *
  * A note on cache maintenance:
  * Note that any buffers that are expected to be accessed by the secure world
@@ -211,6 +214,7 @@  int scm_legacy_call(struct device *dev, const struct qcom_scm_desc *desc,
 /**
  * scm_legacy_call_atomic() - Send an atomic SCM command with up to 5 arguments
  * and 3 return values
+ * @unused: device, legacy argument, not used, can be NULL
  * @desc: SCM call descriptor containing arguments
  * @res:  SCM call return values
  *