Skip to content

Commit aaf46c6

Browse files
rddunlapjenswi-linaro
authored andcommitted
tee: <uapi/linux/tee.h: fix all kernel-doc issues
Fix kernel-doc warnings so that there no other kernel-doc issues in <uapi/linux/tee.h>: - add ending ':' to some struct members as needed for kernel-doc - change struct name in kernel-doc to match the actual struct name (2x) - add a @params: kernel-doc entry multiple times Warning: tee.h:265 struct member 'ret_origin' not described in 'tee_ioctl_open_session_arg' Warning: tee.h:265 struct member 'num_params' not described in 'tee_ioctl_open_session_arg' Warning: tee.h:265 struct member 'params' not described in 'tee_ioctl_open_session_arg' Warning: tee.h:351 struct member 'num_params' not described in 'tee_iocl_supp_recv_arg' Warning: tee.h:351 struct member 'params' not described in 'tee_iocl_supp_recv_arg' Warning: tee.h:372 struct member 'num_params' not described in 'tee_iocl_supp_send_arg' Warning: tee.h:372 struct member 'params' not described in 'tee_iocl_supp_send_arg' Warning: tee.h:298: expecting prototype for struct tee_ioctl_invoke_func_arg. Prototype was for struct tee_ioctl_invoke_arg instead Warning: tee.h:473: expecting prototype for struct tee_ioctl_invoke_func_arg. Prototype was for struct tee_ioctl_object_invoke_arg instead Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Reviewed-by: Sumit Garg <sumit.garg@oss.qualcomm.com> Signed-off-by: Jens Wiklander <jens.wiklander@linaro.org>
1 parent 3a86608 commit aaf46c6

1 file changed

Lines changed: 14 additions & 9 deletions

File tree

include/uapi/linux/tee.h

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -249,8 +249,9 @@ struct tee_ioctl_param {
249249
* @cancel_id: [in] Cancellation id, a unique value to identify this request
250250
* @session: [out] Session id
251251
* @ret: [out] return value
252-
* @ret_origin [out] origin of the return value
253-
* @num_params [in] number of parameters following this struct
252+
* @ret_origin: [out] origin of the return value
253+
* @num_params: [in] number of &struct tee_ioctl_param entries in @params
254+
* @params: array of ioctl parameters
254255
*/
255256
struct tee_ioctl_open_session_arg {
256257
__u8 uuid[TEE_IOCTL_UUID_LEN];
@@ -276,14 +277,14 @@ struct tee_ioctl_open_session_arg {
276277
struct tee_ioctl_buf_data)
277278

278279
/**
279-
* struct tee_ioctl_invoke_func_arg - Invokes a function in a Trusted
280-
* Application
280+
* struct tee_ioctl_invoke_arg - Invokes a function in a Trusted Application
281281
* @func: [in] Trusted Application function, specific to the TA
282282
* @session: [in] Session id
283283
* @cancel_id: [in] Cancellation id, a unique value to identify this request
284284
* @ret: [out] return value
285-
* @ret_origin [out] origin of the return value
286-
* @num_params [in] number of parameters following this struct
285+
* @ret_origin: [out] origin of the return value
286+
* @num_params: [in] number of parameters following this struct
287+
* @params: array of ioctl parameters
287288
*/
288289
struct tee_ioctl_invoke_arg {
289290
__u32 func;
@@ -338,7 +339,8 @@ struct tee_ioctl_close_session_arg {
338339
/**
339340
* struct tee_iocl_supp_recv_arg - Receive a request for a supplicant function
340341
* @func: [in] supplicant function
341-
* @num_params [in/out] number of parameters following this struct
342+
* @num_params: [in/out] number of &struct tee_ioctl_param entries in @params
343+
* @params: array of ioctl parameters
342344
*
343345
* @num_params is the number of params that tee-supplicant has room to
344346
* receive when input, @num_params is the number of actual params
@@ -363,7 +365,8 @@ struct tee_iocl_supp_recv_arg {
363365
/**
364366
* struct tee_iocl_supp_send_arg - Send a response to a received request
365367
* @ret: [out] return value
366-
* @num_params [in] number of parameters following this struct
368+
* @num_params: [in] number of &struct tee_ioctl_param entries in @params
369+
* @params: array of ioctl parameters
367370
*/
368371
struct tee_iocl_supp_send_arg {
369372
__u32 ret;
@@ -454,11 +457,13 @@ struct tee_ioctl_shm_register_fd_data {
454457
*/
455458

456459
/**
457-
* struct tee_ioctl_invoke_func_arg - Invokes an object in a Trusted Application
460+
* struct tee_ioctl_object_invoke_arg - Invokes an object in a
461+
* Trusted Application
458462
* @id: [in] Object id
459463
* @op: [in] Object operation, specific to the object
460464
* @ret: [out] return value
461465
* @num_params: [in] number of parameters following this struct
466+
* @params: array of ioctl parameters
462467
*/
463468
struct tee_ioctl_object_invoke_arg {
464469
__u64 id;

0 commit comments

Comments
 (0)