| Message ID | 7c26256dc00f970f94d145b73e341c36f553dfe4.1709898638.git.jani.nikula@intel.com (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | drm: fix headers, add header test facility | expand |
On Fri, Mar 08, 2024 at 01:55:45PM +0200, Jani Nikula wrote: >Make documentation match code. Slightly fix up the documentation >comments while at it. > >v2: >- Move comments next to members instead of struct comment (Lucas) >- Small fixups while at it > >Cc: Lucas De Marchi <lucas.demarchi@intel.com> >Acked-by: Thomas Zimmermann <tzimmermann@suse.de> >Signed-off-by: Jani Nikula <jani.nikula@intel.com> Reviewed-by: Lucas De Marchi <lucas.demarchi@intel.com> Lucas De Marchi >--- > include/drm/i915_pxp_tee_interface.h | 27 ++++++++++++++++++++------- > 1 file changed, 20 insertions(+), 7 deletions(-) > >diff --git a/include/drm/i915_pxp_tee_interface.h b/include/drm/i915_pxp_tee_interface.h >index 7d96985f2d05..a532d32f58f3 100644 >--- a/include/drm/i915_pxp_tee_interface.h >+++ b/include/drm/i915_pxp_tee_interface.h >@@ -12,20 +12,26 @@ 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 > */ > struct i915_pxp_component_ops { > /** >- * @owner: owner of the module provding the ops >+ * @owner: Module providing the ops. > */ > struct module *owner; > >+ /** >+ * @send: Send a PXP message. >+ */ > int (*send)(struct device *dev, const void *message, size_t size, > unsigned long timeout_ms); >+ /** >+ * @recv: Receive a PXP message. >+ */ > int (*recv)(struct device *dev, void *buffer, size_t size, > unsigned long timeout_ms); >+ /** >+ * @gsc_command: Send a GSC command. >+ */ > ssize_t (*gsc_command)(struct device *dev, u8 client_id, u32 fence_id, > struct scatterlist *sg_in, size_t total_in_len, > struct scatterlist *sg_out); >@@ -35,14 +41,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. > */ > struct i915_pxp_component { >+ /** >+ * @tee_dev: device that provide the PXP service from TEE Bus. >+ */ > struct device *tee_dev; >+ >+ /** >+ * @ops: Ops implemented by TEE driver, used by i915 driver. >+ */ > const struct i915_pxp_component_ops *ops; > >- /* To protect the above members. */ >+ /** >+ * @mutex: To protect the above members. >+ */ > struct mutex mutex; > }; > >-- >2.39.2 >
diff --git a/include/drm/i915_pxp_tee_interface.h b/include/drm/i915_pxp_tee_interface.h index 7d96985f2d05..a532d32f58f3 100644 --- a/include/drm/i915_pxp_tee_interface.h +++ b/include/drm/i915_pxp_tee_interface.h @@ -12,20 +12,26 @@ 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 */ struct i915_pxp_component_ops { /** - * @owner: owner of the module provding the ops + * @owner: Module providing the ops. */ struct module *owner; + /** + * @send: Send a PXP message. + */ int (*send)(struct device *dev, const void *message, size_t size, unsigned long timeout_ms); + /** + * @recv: Receive a PXP message. + */ int (*recv)(struct device *dev, void *buffer, size_t size, unsigned long timeout_ms); + /** + * @gsc_command: Send a GSC command. + */ ssize_t (*gsc_command)(struct device *dev, u8 client_id, u32 fence_id, struct scatterlist *sg_in, size_t total_in_len, struct scatterlist *sg_out); @@ -35,14 +41,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. */ struct i915_pxp_component { + /** + * @tee_dev: device that provide the PXP service from TEE Bus. + */ struct device *tee_dev; + + /** + * @ops: Ops implemented by TEE driver, used by i915 driver. + */ const struct i915_pxp_component_ops *ops; - /* To protect the above members. */ + /** + * @mutex: To protect the above members. + */ struct mutex mutex; };