| Message ID | 20230911023038.30649-2-yong.wu@mediatek.com (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | dma-buf: heaps: Add MediaTek secure heap | expand |
m 11.09.23 um 04:30 schrieb Yong Wu: > From: "T.J. Mercier" <tjmercier@google.com> > > The docs for dma_heap_get_name were incorrect, and since they were > duplicated in the implementation file 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. > > Signed-off-by: T.J. Mercier <tjmercier@google.com> > Signed-off-by: Yong Wu <yong.wu@mediatek.com> > [Yong: Just add a comment for "priv" to mute build warning] > --- > drivers/dma-buf/dma-heap.c | 29 +++++++---------------------- > include/linux/dma-heap.h | 11 +++++------ > 2 files changed, 12 insertions(+), 28 deletions(-) > > diff --git a/drivers/dma-buf/dma-heap.c b/drivers/dma-buf/dma-heap.c > index 84ae708fafe7..51030f6c9d6e 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. > */ > @@ -192,25 +191,11 @@ static const struct file_operations dma_heap_fops = { > #endif > }; > > -/** > - * dma_heap_get_drvdata() - get per-subdriver data for the heap > - * @heap: DMA-Heap to retrieve private data for > - * > - * Returns: > - * The per-subdriver data for the heap. > - */ Kernel documentation is usually kept on the implementation and not the definition. So I strongly suggest to remove the documentation from the header instead and if there is any additional information in there add it here. Regards, Christian. > void *dma_heap_get_drvdata(struct dma_heap *heap) > { > return heap->priv; > } > > -/** > - * 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) > { > return heap->name; > diff --git a/include/linux/dma-heap.h b/include/linux/dma-heap.h > index 0c05561cad6e..c7c29b724ad6 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. > */ > @@ -42,7 +41,7 @@ struct dma_heap_export_info { > }; > > /** > - * dma_heap_get_drvdata() - get per-heap driver data > + * dma_heap_get_drvdata - get per-heap driver data > * @heap: DMA-Heap to retrieve private data for > * > * Returns: > @@ -51,8 +50,8 @@ struct dma_heap_export_info { > 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. > @@ -61,7 +60,7 @@ 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 > + * @exp_info: information needed to register this heap > */ > struct dma_heap *dma_heap_add(const struct dma_heap_export_info *exp_info); >
On Mon, Sep 11, 2023 at 2:36 AM Christian König <christian.koenig@amd.com> wrote: > > m 11.09.23 um 04:30 schrieb Yong Wu: > > From: "T.J. Mercier" <tjmercier@google.com> > > > > The docs for dma_heap_get_name were incorrect, and since they were > > duplicated in the implementation file 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. > > > > Signed-off-by: T.J. Mercier <tjmercier@google.com> > > Signed-off-by: Yong Wu <yong.wu@mediatek.com> > > [Yong: Just add a comment for "priv" to mute build warning] > > --- > > drivers/dma-buf/dma-heap.c | 29 +++++++---------------------- > > include/linux/dma-heap.h | 11 +++++------ > > 2 files changed, 12 insertions(+), 28 deletions(-) > > > > diff --git a/drivers/dma-buf/dma-heap.c b/drivers/dma-buf/dma-heap.c > > index 84ae708fafe7..51030f6c9d6e 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. > > */ > > @@ -192,25 +191,11 @@ static const struct file_operations dma_heap_fops = { > > #endif > > }; > > > > -/** > > - * dma_heap_get_drvdata() - get per-subdriver data for the heap > > - * @heap: DMA-Heap to retrieve private data for > > - * > > - * Returns: > > - * The per-subdriver data for the heap. > > - */ > > Kernel documentation is usually kept on the implementation and not the > definition. > > So I strongly suggest to remove the documentation from the header > instead and if there is any additional information in there add it here. > > Regards, > Christian. > Ok thanks for looking. I'll move all the function docs over to the implementation.
diff --git a/drivers/dma-buf/dma-heap.c b/drivers/dma-buf/dma-heap.c index 84ae708fafe7..51030f6c9d6e 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. */ @@ -192,25 +191,11 @@ static const struct file_operations dma_heap_fops = { #endif }; -/** - * dma_heap_get_drvdata() - get per-subdriver data for the heap - * @heap: DMA-Heap to retrieve private data for - * - * Returns: - * The per-subdriver data for the heap. - */ void *dma_heap_get_drvdata(struct dma_heap *heap) { return heap->priv; } -/** - * 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) { return heap->name; diff --git a/include/linux/dma-heap.h b/include/linux/dma-heap.h index 0c05561cad6e..c7c29b724ad6 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. */ @@ -42,7 +41,7 @@ struct dma_heap_export_info { }; /** - * dma_heap_get_drvdata() - get per-heap driver data + * dma_heap_get_drvdata - get per-heap driver data * @heap: DMA-Heap to retrieve private data for * * Returns: @@ -51,8 +50,8 @@ struct dma_heap_export_info { 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. @@ -61,7 +60,7 @@ 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 + * @exp_info: information needed to register this heap */ struct dma_heap *dma_heap_add(const struct dma_heap_export_info *exp_info);