Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
tee: clean up tee_core.h kernel-doc
Use the correct struct member name and function parameter name in
kernel-doc comments.
Move a macro that was between a struct's documentation and its
declaration.
These eliminate the following kernel-doc warnings:
Warning: include/linux/tee_core.h:73 struct member 'c_no_users' not
described in 'tee_device'
Warning: include/linux/tee_core.h:132 #define TEE_DESC_PRIVILEGED
0x1; error: Cannot parse struct or union!
Warning: include/linux/tee_core.h:257 function parameter 'connection_data'
not described in 'tee_session_calc_client_uuid'
Warning: include/linux/tee_core.h:320 function parameter 'teedev'
not described in 'tee_get_drvdata'
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>
authored by
Randy Dunlap
and committed by
Jens Wiklander
e416e7fa
6de23f81
+16
-14
+16
-14
include/linux/tee_core.h
+16
-14
include/linux/tee_core.h
···
50
50
* @dev: embedded basic device structure
51
51
* @cdev: embedded cdev
52
52
* @num_users: number of active users of this device
53
-
* @c_no_user: completion used when unregistering the device
53
+
* @c_no_users: completion used when unregistering the device
54
54
* @mutex: mutex protecting @num_users and @idr
55
55
* @idr: register of user space shared memory objects allocated or
56
56
* registered on this device
···
132
132
/* Size for TEE revision string buffer used by get_tee_revision(). */
133
133
#define TEE_REVISION_STR_SIZE 128
134
134
135
+
#define TEE_DESC_PRIVILEGED 0x1
135
136
/**
136
137
* struct tee_desc - Describes the TEE driver to the subsystem
137
138
* @name: name of driver
···
140
139
* @owner: module providing the driver
141
140
* @flags: Extra properties of driver, defined by TEE_DESC_* below
142
141
*/
143
-
#define TEE_DESC_PRIVILEGED 0x1
144
142
struct tee_desc {
145
143
const char *name;
146
144
const struct tee_driver_ops *ops;
···
187
187
* Allocates a new struct tee_device instance. The device is
188
188
* removed by tee_device_unregister().
189
189
*
190
-
* @returns a pointer to a 'struct tee_device' or an ERR_PTR on failure
190
+
* @returns: a pointer to a 'struct tee_device' or an ERR_PTR on failure
191
191
*/
192
192
struct tee_device *tee_device_alloc(const struct tee_desc *teedesc,
193
193
struct device *dev,
···
201
201
* tee_device_unregister() need to be called to remove the @teedev if
202
202
* this function fails.
203
203
*
204
-
* @returns < 0 on failure
204
+
* @returns: < 0 on failure
205
205
*/
206
206
int tee_device_register(struct tee_device *teedev);
207
207
···
254
254
* tee_session_calc_client_uuid() - Calculates client UUID for session
255
255
* @uuid: Resulting UUID
256
256
* @connection_method: Connection method for session (TEE_IOCTL_LOGIN_*)
257
-
* @connectuon_data: Connection data for opening session
257
+
* @connection_data: Connection data for opening session
258
258
*
259
259
* Based on connection method calculates UUIDv5 based client UUID.
260
260
*
261
261
* For group based logins verifies that calling process has specified
262
262
* credentials.
263
263
*
264
-
* @return < 0 on failure
264
+
* @returns: < 0 on failure
265
265
*/
266
266
int tee_session_calc_client_uuid(uuid_t *uuid, u32 connection_method,
267
267
const u8 connection_data[TEE_IOCTL_UUID_LEN]);
···
295
295
* @paddr: Physical address of start of pool
296
296
* @size: Size in bytes of the pool
297
297
*
298
-
* @returns pointer to a 'struct tee_shm_pool' or an ERR_PTR on failure.
298
+
* @returns: pointer to a 'struct tee_shm_pool' or an ERR_PTR on failure.
299
299
*/
300
300
struct tee_shm_pool *tee_shm_pool_alloc_res_mem(unsigned long vaddr,
301
301
phys_addr_t paddr, size_t size,
···
318
318
* @paddr: Physical address of start of pool
319
319
* @size: Size in bytes of the pool
320
320
*
321
-
* @returns pointer to a 'struct tee_protmem_pool' or an ERR_PTR on failure.
321
+
* @returns: pointer to a 'struct tee_protmem_pool' or an ERR_PTR on failure.
322
322
*/
323
323
struct tee_protmem_pool *tee_protmem_static_pool_alloc(phys_addr_t paddr,
324
324
size_t size);
325
325
326
326
/**
327
327
* tee_get_drvdata() - Return driver_data pointer
328
-
* @returns the driver_data pointer supplied to tee_register().
328
+
* @teedev: Pointer to the tee_device
329
+
*
330
+
* @returns: the driver_data pointer supplied to tee_register().
329
331
*/
330
332
void *tee_get_drvdata(struct tee_device *teedev);
331
333
···
336
334
* TEE driver
337
335
* @ctx: The TEE context for shared memory allocation
338
336
* @size: Shared memory allocation size
339
-
* @returns a pointer to 'struct tee_shm' on success or an ERR_PTR on failure
337
+
* @returns: a pointer to 'struct tee_shm' on success or an ERR_PTR on failure
340
338
*/
341
339
struct tee_shm *tee_shm_alloc_priv_buf(struct tee_context *ctx, size_t size);
342
340
···
356
354
/**
357
355
* tee_shm_is_dynamic() - Check if shared memory object is of the dynamic kind
358
356
* @shm: Shared memory handle
359
-
* @returns true if object is dynamic shared memory
357
+
* @returns: true if object is dynamic shared memory
360
358
*/
361
359
static inline bool tee_shm_is_dynamic(struct tee_shm *shm)
362
360
{
···
372
370
/**
373
371
* tee_shm_get_id() - Get id of a shared memory object
374
372
* @shm: Shared memory handle
375
-
* @returns id
373
+
* @returns: id
376
374
*/
377
375
static inline int tee_shm_get_id(struct tee_shm *shm)
378
376
{
···
384
382
* count
385
383
* @ctx: Context owning the shared memory
386
384
* @id: Id of shared memory object
387
-
* @returns a pointer to 'struct tee_shm' on success or an ERR_PTR on failure
385
+
* @returns: a pointer to 'struct tee_shm' on success or an ERR_PTR on failure
388
386
*/
389
387
struct tee_shm *tee_shm_get_from_id(struct tee_context *ctx, int id);
390
388
···
404
402
* teedev_open() - Open a struct tee_device
405
403
* @teedev: Device to open
406
404
*
407
-
* @return a pointer to struct tee_context on success or an ERR_PTR on failure.
405
+
* @returns: pointer to struct tee_context on success or an ERR_PTR on failure.
408
406
*/
409
407
struct tee_context *teedev_open(struct tee_device *teedev);
410
408