On Tue, Jun 22, 2021 at 9:01 PM Sam Ravnborg sam@ravnborg.org wrote:
Hi Daniel.
On Tue, Jun 22, 2021 at 06:54:58PM +0200, Daniel Vetter wrote:
Also review & update everything while we're at it.
This is prep work to smash a ton of stuff into the kerneldoc for @resv.
Signed-off-by: Daniel Vetter daniel.vetter@intel.com Cc: Sumit Semwal sumit.semwal@linaro.org Cc: "Christian König" christian.koenig@amd.com Cc: Alex Deucher alexander.deucher@amd.com Cc: Daniel Vetter daniel.vetter@ffwll.ch Cc: Dave Airlie airlied@redhat.com Cc: Nirmoy Das nirmoy.das@amd.com Cc: Deepak R Varma mh12gx2825@gmail.com Cc: Chen Li chenli@uniontech.com Cc: Kevin Wang kevin1.wang@amd.com Cc: linux-media@vger.kernel.org Cc: linaro-mm-sig@lists.linaro.org
include/linux/dma-buf.h | 107 +++++++++++++++++++++++++++++++--------- 1 file changed, 83 insertions(+), 24 deletions(-)
diff --git a/include/linux/dma-buf.h b/include/linux/dma-buf.h index 92eec38a03aa..6d18b9e448b9 100644 --- a/include/linux/dma-buf.h +++ b/include/linux/dma-buf.h @@ -289,28 +289,6 @@ struct dma_buf_ops {
/**
- struct dma_buf - shared buffer object
- @size: size of the buffer; invariant over the lifetime of the buffer.
- @file: file pointer used for sharing buffers across, and for refcounting.
- @attachments: list of dma_buf_attachment that denotes all devices attached,
protected by dma_resv lock.
- @ops: dma_buf_ops associated with this buffer object.
- @lock: used internally to serialize list manipulation, attach/detach and
vmap/unmap
- @vmapping_counter: used internally to refcnt the vmaps
- @vmap_ptr: the current vmap ptr if vmapping_counter > 0
- @exp_name: name of the exporter; useful for debugging.
- @name: userspace-provided name; useful for accounting and debugging,
protected by @resv.
- @name_lock: spinlock to protect name access
- @owner: pointer to exporter module; used for refcounting when exporter is a
kernel module.
- @list_node: node for dma_buf accounting and debugging.
- @priv: exporter specific private data for this buffer object.
- @resv: reservation object linked to this dma-buf
- @poll: for userspace poll support
- @cb_excl: for userspace poll support
- @cb_shared: for userspace poll support
- @sysfs_entry: for exposing information about this buffer in sysfs.
This sentence
- The attachment_uid member of @sysfs_entry is protected by dma_resv lock
- and is incremented on each attach.
belongs to the paragraph describing sysfs_entry and should be moved too. Or maybe reworded and then document all fields in dma_buf_sysfs_entry?
Unfortunately kerneldoc lost the ability to document embedded structs/unions. At least last time I checked, it's a bit a bikeshed. So I'd need to pull the entire struct out. I'll just move it since it's indeed misplaced.
With this fixed: Acked-by: Sam Ravnborg sam@ravnborg.org
Thanks for taking a look. -Daniel