Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

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>

authored by

Ramesh Errabolu and committed by
Christian König
3d1ff9df 55b0f4a7

+7 -4
+7 -4
include/linux/dma-buf.h
··· 343 343 /** 344 344 * @exp_name: 345 345 * 346 - * Name of the exporter; useful for debugging. See the 347 - * DMA_BUF_SET_NAME IOCTL. 346 + * Name of the exporter; useful for debugging. Must not be NULL 348 347 */ 349 348 const char *exp_name; 350 349 351 350 /** 352 351 * @name: 353 352 * 354 - * Userspace-provided name; useful for accounting and debugging, 355 - * protected by dma_resv_lock() on @resv and @name_lock for read access. 353 + * Userspace-provided name. Default value is NULL. If not NULL, 354 + * length cannot be longer than DMA_BUF_NAME_LEN, including NIL 355 + * char. Useful for accounting and debugging. Read/Write accesses 356 + * are protected by @name_lock 357 + * 358 + * See the IOCTLs DMA_BUF_SET_NAME or DMA_BUF_SET_NAME_A/B 356 359 */ 357 360 const char *name; 358 361