From: "Christian König" <christian.koenig@amd.com>
To: Yong Wu <yong.wu@mediatek.com>, Rob Herring <robh+dt@kernel.org>,
Sumit Semwal <sumit.semwal@linaro.org>,
Matthias Brugger <matthias.bgg@gmail.com>
Cc: devicetree@vger.kernel.org, Conor Dooley <conor+dt@kernel.org>,
Benjamin Gaignard <benjamin.gaignard@collabora.com>,
kuohong.wang@mediatek.com, linux-kernel@vger.kernel.org,
dri-devel@lists.freedesktop.org, tjmercier@google.com,
linaro-mm-sig@lists.linaro.org, John Stultz <jstultz@google.com>,
jianjiao.zeng@mediatek.com,
Krzysztof Kozlowski <krzysztof.kozlowski+dt@linaro.org>,
linux-mediatek@lists.infradead.org, linux-media@vger.kernel.org,
linux-arm-kernel@lists.infradead.org,
AngeloGioacchino Del Regno
<angelogioacchino.delregno@collabora.com>
Subject: Re: [PATCH 1/9] dma-buf: heaps: Deduplicate docs and adopt common format
Date: Mon, 11 Sep 2023 11:36:27 +0200 [thread overview]
Message-ID: <46532644-a38b-98d5-13a1-8b51b9276a1d@amd.com> (raw)
In-Reply-To: <20230911023038.30649-2-yong.wu@mediatek.com>
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);
>
next prev parent reply other threads:[~2023-09-11 9:36 UTC|newest]
Thread overview: 72+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-09-11 2:30 [PATCH 0/9] dma-buf: heaps: Add MediaTek secure heap Yong Wu
2023-09-11 2:30 ` [PATCH 1/9] dma-buf: heaps: Deduplicate docs and adopt common format Yong Wu
2023-09-11 9:36 ` Christian König [this message]
2023-09-11 23:51 ` T.J. Mercier
2023-09-11 2:30 ` [PATCH 2/9] dma-heap: Add proper kref handling on dma-buf heaps Yong Wu
2023-09-11 9:48 ` Christian König
2023-09-22 18:19 ` T.J. Mercier
2023-09-11 2:30 ` [PATCH 3/9] dma-heap: Provide accessors so that in-kernel drivers can allocate dmabufs from specific heaps Yong Wu
2023-09-11 10:13 ` Christian König
2023-09-11 18:29 ` John Stultz
2023-09-12 7:06 ` Christian König
2023-09-12 8:52 ` Yong Wu (吴勇)
2023-09-12 14:46 ` Christian König
2023-09-12 14:58 ` Nicolas Dufresne
2023-09-13 8:30 ` Christian König
2023-09-12 14:50 ` Nicolas Dufresne
2023-09-11 16:12 ` Nicolas Dufresne
2023-09-12 8:47 ` Yong Wu (吴勇)
2023-09-12 15:05 ` Nicolas Dufresne
2023-09-18 10:46 ` Yong Wu (吴勇)
2023-09-11 2:30 ` [PATCH 4/9] dma-buf: heaps: Initialise MediaTek secure heap Yong Wu
2023-09-11 8:05 ` kernel test robot
2023-09-27 14:42 ` Joakim Bech
2023-09-28 8:03 ` Yong Wu (吴勇)
2023-10-19 4:45 ` Vijayanand Jitta
2023-10-20 9:59 ` Yong Wu (吴勇)
2023-10-26 4:48 ` Vijayanand Jitta
2023-10-27 7:47 ` Yong Wu (吴勇)
2023-10-30 8:06 ` Vijayanand Jitta
2023-09-11 2:30 ` [PATCH 5/9] dma-buf: heaps: mtk_sec_heap: Initialise tee session Yong Wu
2023-09-11 9:29 ` AngeloGioacchino Del Regno
2023-09-11 10:15 ` Christian König
2023-09-12 6:17 ` Yong Wu (吴勇)
2023-09-12 9:32 ` AngeloGioacchino Del Regno
2023-09-25 12:49 ` Yong Wu (吴勇)
2023-09-27 13:46 ` Joakim Bech
2023-09-27 15:17 ` Benjamin Gaignard
2023-09-27 18:56 ` Jeffrey Kardatzke
2023-09-28 8:30 ` Benjamin Gaignard
2023-09-28 17:48 ` Jeffrey Kardatzke
2023-09-29 6:54 ` Benjamin Gaignard
2023-10-13 19:09 ` Jeffrey Kardatzke
2023-10-13 19:10 ` Jeffrey Kardatzke
2023-09-27 18:54 ` Jeffrey Kardatzke
2023-09-13 13:35 ` kernel test robot
2023-09-11 2:30 ` [PATCH 6/9] dma-buf: heaps: mtk_sec_heap: Add tee service call for buffer allocating/freeing Yong Wu
2023-09-14 10:18 ` kernel test robot
2023-09-27 14:37 ` Joakim Bech
2023-09-28 5:24 ` Yong Wu (吴勇)
2023-10-19 4:45 ` Vijayanand Jitta
2023-10-20 10:01 ` Yong Wu (吴勇)
2023-09-11 2:30 ` [PATCH 7/9] dma-buf: heaps: mtk_sec_heap: Add dma_ops Yong Wu
2023-09-11 2:30 ` [PATCH 8/9] dt-bindings: reserved-memory: MediaTek: Add reserved memory for SVP Yong Wu
2023-09-11 15:44 ` Rob Herring
2023-09-12 6:16 ` Yong Wu (吴勇)
2023-09-12 8:28 ` Krzysztof Kozlowski
2023-09-12 10:13 ` Robin Murphy
2023-09-12 15:53 ` Rob Herring
2023-09-12 16:05 ` Robin Murphy
2023-09-18 10:47 ` Yong Wu (吴勇)
2023-09-19 22:15 ` Jeffrey Kardatzke
2023-10-12 6:54 ` Yong Wu (吴勇)
2023-10-12 7:07 ` Krzysztof Kozlowski
2023-10-12 11:15 ` Yong Wu (吴勇)
2023-10-19 4:46 ` Vijayanand Jitta
2023-10-20 9:50 ` Yong Wu (吴勇)
2023-11-01 5:50 ` Jaskaran Singh
2023-11-06 5:56 ` Yong Wu (吴勇)
2023-11-20 8:20 ` Jaskaran Singh
2023-09-11 2:30 ` [PATCH 9/9] dma_buf: heaps: mtk_sec_heap: Add a new CMA heap Yong Wu
2023-09-11 9:33 ` AngeloGioacchino Del Regno
2023-10-19 4:44 ` [PATCH 0/9] dma-buf: heaps: Add MediaTek secure heap Vijayanand Jitta
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=46532644-a38b-98d5-13a1-8b51b9276a1d@amd.com \
--to=christian.koenig@amd.com \
--cc=angelogioacchino.delregno@collabora.com \
--cc=benjamin.gaignard@collabora.com \
--cc=conor+dt@kernel.org \
--cc=devicetree@vger.kernel.org \
--cc=dri-devel@lists.freedesktop.org \
--cc=jianjiao.zeng@mediatek.com \
--cc=jstultz@google.com \
--cc=krzysztof.kozlowski+dt@linaro.org \
--cc=kuohong.wang@mediatek.com \
--cc=linaro-mm-sig@lists.linaro.org \
--cc=linux-arm-kernel@lists.infradead.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-media@vger.kernel.org \
--cc=linux-mediatek@lists.infradead.org \
--cc=matthias.bgg@gmail.com \
--cc=robh+dt@kernel.org \
--cc=sumit.semwal@linaro.org \
--cc=tjmercier@google.com \
--cc=yong.wu@mediatek.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).