]> www.infradead.org Git - users/jedix/linux-maple.git/commitdiff
dma-buf: Correct the documentation of name and exp_name symbols
authorRamesh Errabolu <Ramesh.Errabolu@amd.com>
Wed, 22 Nov 2023 16:05:56 +0000 (10:05 -0600)
committerChristian König <christian.koenig@amd.com>
Thu, 30 Nov 2023 13:24:54 +0000 (14:24 +0100)
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>
include/linux/dma-buf.h

index 3f31baa3293f9819e271911db351456ad2a14519..8ff4add71f8833dc318fd71aad84cf7d20b4570b 100644 (file)
@@ -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;