Re: [PATCH 17/22] drm/i915/pxp: fix i915_pxp_tee_interface.h kernel-doc warnings

[Jani Nikula <jani.nikula@intel.com>]

On Thu, 07 Mar 2024, Lucas De Marchi <lucas.demarchi@intel.com> wrote:
> On Wed, Mar 06, 2024 at 08:31:22PM +0200, Jani Nikula wrote:
>>Make documentation match code.
>>
>>Signed-off-by: Jani Nikula <jani.nikula@intel.com>
>>---
>> include/drm/i915_pxp_tee_interface.h | 19 ++++++++++++-------
>> 1 file changed, 12 insertions(+), 7 deletions(-)
>>
>>diff --git a/include/drm/i915_pxp_tee_interface.h b/include/drm/i915_pxp_tee_interface.h
>>index 7d96985f2d05..653e85d6e32b 100644
>>--- a/include/drm/i915_pxp_tee_interface.h
>>+++ b/include/drm/i915_pxp_tee_interface.h
>>@@ -14,12 +14,10 @@ struct scatterlist;
>>  * struct i915_pxp_component_ops - ops for PXP services.
>>  * @owner: Module providing the ops
>>  * @send: sends data to PXP
>>- * @receive: receives data from PXP
>>+ * @recv: receives data from PXP
>>+ * @gsc_command: send gsc command
>>  */
>> struct i915_pxp_component_ops {
>>-	/**
>>-	 * @owner: owner of the module provding the ops
>>-	 */
>
>
> isn't the other way around the more common one? i.e. document the
> struct members closer to their declaration.
>
>> 	struct module *owner;
>>
>> 	int (*send)(struct device *dev, const void *message, size_t size,
>>@@ -35,14 +33,21 @@ struct i915_pxp_component_ops {
>> /**
>>  * struct i915_pxp_component - Used for communication between i915 and TEE
>>  * drivers for the PXP services
>>- * @tee_dev: device that provide the PXP service from TEE Bus.
>>- * @pxp_ops: Ops implemented by TEE driver, used by i915 driver.
>>  */
>
> ... which you follow here.

Yeah, fixed locally, ditto for previous patch. Thanks for the reviews.

BR,
Jani.


-- 
Jani Nikula, Intel