Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
drm/i915/pxp: fix i915_pxp_tee_interface.h kernel-doc warnings
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>
Reviewed-by: Lucas De Marchi <lucas.demarchi@intel.com>
Signed-off-by: Jani Nikula <jani.nikula@intel.com>
Link: https://patchwork.freedesktop.org/patch/msgid/7c26256dc00f970f94d145b73e341c36f553dfe4.1709898638.git.jani.nikula@intel.com
+20
-7
+20
-7
include/drm/i915_pxp_tee_interface.h
+20
-7
include/drm/i915_pxp_tee_interface.h
···
12
12
13
13
/**
14
14
* struct i915_pxp_component_ops - ops for PXP services.
15
-
* @owner: Module providing the ops
16
-
* @send: sends data to PXP
17
-
* @receive: receives data from PXP
18
15
*/
19
16
struct i915_pxp_component_ops {
20
17
/**
21
-
* @owner: owner of the module provding the ops
18
+
* @owner: Module providing the ops.
22
19
*/
23
20
struct module *owner;
24
21
22
+
/**
23
+
* @send: Send a PXP message.
24
+
*/
25
25
int (*send)(struct device *dev, const void *message, size_t size,
26
26
unsigned long timeout_ms);
27
+
/**
28
+
* @recv: Receive a PXP message.
29
+
*/
27
30
int (*recv)(struct device *dev, void *buffer, size_t size,
28
31
unsigned long timeout_ms);
32
+
/**
33
+
* @gsc_command: Send a GSC command.
34
+
*/
29
35
ssize_t (*gsc_command)(struct device *dev, u8 client_id, u32 fence_id,
30
36
struct scatterlist *sg_in, size_t total_in_len,
31
37
struct scatterlist *sg_out);
···
41
35
/**
42
36
* struct i915_pxp_component - Used for communication between i915 and TEE
43
37
* drivers for the PXP services
44
-
* @tee_dev: device that provide the PXP service from TEE Bus.
45
-
* @pxp_ops: Ops implemented by TEE driver, used by i915 driver.
46
38
*/
47
39
struct i915_pxp_component {
40
+
/**
41
+
* @tee_dev: device that provide the PXP service from TEE Bus.
42
+
*/
48
43
struct device *tee_dev;
44
+
45
+
/**
46
+
* @ops: Ops implemented by TEE driver, used by i915 driver.
47
+
*/
49
48
const struct i915_pxp_component_ops *ops;
50
49
51
-
/* To protect the above members. */
50
+
/**
51
+
* @mutex: To protect the above members.
52
+
*/
52
53
struct mutex mutex;
53
54
};
54
55