diff mbox series

[2/8] firmware: qcom_scm-legacy: correct kerneldoc

Message ID 20220501103520.111561-2-krzysztof.kozlowski@linaro.org (mailing list archive)
State Not Applicable
Headers show
Series [1/8] clk: qcom: alpha-pll: correct kerneldoc | expand

Commit Message

Krzysztof Kozlowski May 1, 2022, 10:35 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>
---
 drivers/firmware/qcom_scm-legacy.c | 4 ++++
 1 file changed, 4 insertions(+)

Comments

Stephen Boyd May 19, 2022, 12:03 a.m. UTC | #1 
Quoting Krzysztof Kozlowski (2022-05-01 03:35:14)
> diff --git a/drivers/firmware/qcom_scm-legacy.c b/drivers/firmware/qcom_scm-legacy.c
> index 1829ba220576..7854af4abc62 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/HVC call

I think only SMC call is possible so drop HVC to not be confusing.

>   *
>   * A note on cache maintenance:
>   * Note that any buffers that are expected to be accessed by the secure world
Krzysztof Kozlowski May 19, 2022, 7:20 a.m. UTC | #2 
On 19/05/2022 02:03, Stephen Boyd wrote:
> Quoting Krzysztof Kozlowski (2022-05-01 03:35:14)
>> diff --git a/drivers/firmware/qcom_scm-legacy.c b/drivers/firmware/qcom_scm-legacy.c
>> index 1829ba220576..7854af4abc62 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/HVC call
> 
> I think only SMC call is possible so drop HVC to not be confusing.

Sure.


Best regards,
Krzysztof
diff mbox series

Patch

diff --git a/drivers/firmware/qcom_scm-legacy.c b/drivers/firmware/qcom_scm-legacy.c
index 1829ba220576..7854af4abc62 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/HVC 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
  *