Re: [PATCH v7 04/28] dma-buf: heaps: Deduplicate docs and adopt common format

Christian König <christian.koenig@xxxxxxx> · Thu, 25 Jul 2024 13:52:17 +0200

Am 20.07.24 um 09:15 schrieb Yunfei Dong:
From: "T.J. Mercier" <tjmercier@xxxxxxxxxx>

The docs for dma_heap_get_name were incorrect, and since they were
duplicated in the header they were wrong there too.

The docs formatting was inconsistent so I tried to make it more
consistent across functions since I'm already in here doing cleanup.

Remove multiple unused includes and alphabetize.

Signed-off-by: T.J. Mercier <tjmercier@xxxxxxxxxx>
Signed-off-by: Yong Wu <yong.wu@xxxxxxxxxxxx>
[Yong: Just add a comment for "priv" to mute build warning]
Signed-off-by: Yunfei Dong <yunfei.dong@xxxxxxxxxxxx>

Since this is essentially a complete independent documentation fix I've 
gone ahead and pushed it to drm-misc-next.

Regards,
Christian.

---
  drivers/dma-buf/dma-heap.c | 27 +++++++++++++++------------
  include/linux/dma-heap.h   | 21 +--------------------
  2 files changed, 16 insertions(+), 32 deletions(-)

diff --git a/drivers/dma-buf/dma-heap.c b/drivers/dma-buf/dma-heap.c
index 84ae708fafe7..22f6c193db0d 100644
--- a/drivers/dma-buf/dma-heap.c
+++ b/drivers/dma-buf/dma-heap.c
@@ -7,17 +7,15 @@
   */
  
  #include <linux/cdev.h>
-#include <linux/debugfs.h>
  #include <linux/device.h>
  #include <linux/dma-buf.h>
+#include <linux/dma-heap.h>
  #include <linux/err.h>
-#include <linux/xarray.h>
  #include <linux/list.h>
-#include <linux/slab.h>
  #include <linux/nospec.h>
-#include <linux/uaccess.h>
  #include <linux/syscalls.h>
-#include <linux/dma-heap.h>
+#include <linux/uaccess.h>
+#include <linux/xarray.h>
  #include <uapi/linux/dma-heap.h>
  
  #define DEVNAME "dma_heap"
@@ -28,9 +26,10 @@
   * struct dma_heap - represents a dmabuf heap in the system
   * @name:		used for debugging/device-node name
   * @ops:		ops struct for this heap
- * @heap_devt		heap device node
- * @list		list head connecting to list of heaps
- * @heap_cdev		heap char device
+ * @priv:		private data for this heap
+ * @heap_devt:		heap device node
+ * @list:		list head connecting to list of heaps
+ * @heap_cdev:		heap char device
   *
   * Represents a heap of memory from which buffers can be made.
   */
@@ -193,11 +192,11 @@ static const struct file_operations dma_heap_fops = {
  };
  
  /**
- * dma_heap_get_drvdata() - get per-subdriver data for the heap
+ * dma_heap_get_drvdata - get per-heap driver data
   * @heap: DMA-Heap to retrieve private data for
   *
   * Returns:
- * The per-subdriver data for the heap.
+ * The per-heap data for the heap.
   */
  void *dma_heap_get_drvdata(struct dma_heap *heap)
  {
@@ -205,8 +204,8 @@ void *dma_heap_get_drvdata(struct dma_heap *heap)
  }
  
  /**
- * dma_heap_get_name() - get heap name
- * @heap: DMA-Heap to retrieve private data for
+ * dma_heap_get_name - get heap name
+ * @heap: DMA-Heap to retrieve the name of
   *
   * Returns:
   * The char* for the heap name.
@@ -216,6 +215,10 @@ const char *dma_heap_get_name(struct dma_heap *heap)
  	return heap->name;
  }
  
+/**
+ * dma_heap_add - adds a heap to dmabuf heaps
+ * @exp_info: information needed to register this heap
+ */
  struct dma_heap *dma_heap_add(const struct dma_heap_export_info *exp_info)
  {
  	struct dma_heap *heap, *h, *err_ret;
diff --git a/include/linux/dma-heap.h b/include/linux/dma-heap.h
index 0c05561cad6e..fbe86ec889a8 100644
--- a/include/linux/dma-heap.h
+++ b/include/linux/dma-heap.h
@@ -9,14 +9,13 @@
  #ifndef _DMA_HEAPS_H
  #define _DMA_HEAPS_H
  
-#include <linux/cdev.h>
  #include <linux/types.h>
  
  struct dma_heap;
  
  /**
   * struct dma_heap_ops - ops to operate on a given heap
- * @allocate:		allocate dmabuf and return struct dma_buf ptr
+ * @allocate:	allocate dmabuf and return struct dma_buf ptr
   *
   * allocate returns dmabuf on success, ERR_PTR(-errno) on error.
   */
@@ -41,28 +40,10 @@ struct dma_heap_export_info {
  	void *priv;
  };
  
-/**
- * dma_heap_get_drvdata() - get per-heap driver data
- * @heap: DMA-Heap to retrieve private data for
- *
- * Returns:
- * The per-heap data for the heap.
- */
  void *dma_heap_get_drvdata(struct dma_heap *heap);
  
-/**
- * dma_heap_get_name() - get heap name
- * @heap: DMA-Heap to retrieve private data for
- *
- * Returns:
- * The char* for the heap name.
- */
  const char *dma_heap_get_name(struct dma_heap *heap);
  
-/**
- * dma_heap_add - adds a heap to dmabuf heaps
- * @exp_info:		information needed to register this heap
- */
  struct dma_heap *dma_heap_add(const struct dma_heap_export_info *exp_info);
  
  #endif /* _DMA_HEAPS_H */







