diff options
author | Ramesh Errabolu <Ramesh.Errabolu@amd.com> | 2023-11-22 10:05:56 -0600 |
---|---|---|
committer | Christian König <christian.koenig@amd.com> | 2023-11-30 14:24:54 +0100 |
commit | 3d1ff9dfdc168722f570144aba0ce29d28d7f483 (patch) | |
tree | eb139580acd7e62c3f19f8272faf22f94ba685b7 | |
parent | 55b0f4a7c37680428d640aeada96d62888366c56 (diff) | |
download | linux-3d1ff9dfdc168722f570144aba0ce29d28d7f483.tar.gz linux-3d1ff9dfdc168722f570144aba0ce29d28d7f483.tar.bz2 linux-3d1ff9dfdc168722f570144aba0ce29d28d7f483.zip |
dma-buf: Correct the documentation of name and exp_name symbols
Fix the documentation of struct dma_buf members name and exp_name
as to how these members are to be used and accessed.
Signed-off-by: Ramesh Errabolu <Ramesh.Errabolu@amd.com>
Reviewed-by: Christian König <christian.koenig@amd.com>
Link: https://patchwork.freedesktop.org/patch/msgid/20231122160556.24948-1-Ramesh.Errabolu@amd.com
Signed-off-by: Christian König <christian.koenig@amd.com>
-rw-r--r-- | include/linux/dma-buf.h | 11 |
1 files changed, 7 insertions, 4 deletions
diff --git a/include/linux/dma-buf.h b/include/linux/dma-buf.h index 3f31baa3293f..8ff4add71f88 100644 --- a/include/linux/dma-buf.h +++ b/include/linux/dma-buf.h @@ -343,16 +343,19 @@ struct dma_buf { /** * @exp_name: * - * Name of the exporter; useful for debugging. See the - * DMA_BUF_SET_NAME IOCTL. + * Name of the exporter; useful for debugging. Must not be NULL */ const char *exp_name; /** * @name: * - * Userspace-provided name; useful for accounting and debugging, - * protected by dma_resv_lock() on @resv and @name_lock for read access. + * Userspace-provided name. Default value is NULL. If not NULL, + * length cannot be longer than DMA_BUF_NAME_LEN, including NIL + * char. Useful for accounting and debugging. Read/Write accesses + * are protected by @name_lock + * + * See the IOCTLs DMA_BUF_SET_NAME or DMA_BUF_SET_NAME_A/B */ const char *name; |