Received-SPF: pass (google.com: domain of linux-kernel+bounces-142368-linux.lists.archive=gmail.com@vger.kernel.org designates 2604:1380:45d1:ec00::1 as permitted sender) client-ip=2604:1380:45d1:ec00::1;
Message-ID: <f3698562-5000-483e-bfd8-272bf6306b0e@amd.com>
Date: Fri, 12 Apr 2024 11:16:47 +0200
User-Agent: Mozilla Thunderbird
Subject: Re: [PATCH v5,05/23] dma-buf: heaps: Deduplicate docs and adopt
 common format
To: Yunfei Dong <yunfei.dong@mediatek.com>,
 Jeffrey Kardatzke <jkardatzke@google.com>,
 =?UTF-8?Q?N=C3=ADcolas_F_=2E_R_=2E_A_=2E_Prado?= <nfraprado@collabora.com>,
 Nathan Hebert <nhebert@chromium.org>,
 Nicolas Dufresne <nicolas.dufresne@collabora.com>,
 Hans Verkuil <hverkuil-cisco@xs4all.nl>,
 AngeloGioacchino Del Regno <angelogioacchino.delregno@collabora.com>,
 Benjamin Gaignard <benjamin.gaignard@collabora.com>,
 Sebastian Fricke <sebastian.fricke@collabora.com>,
 Tomasz Figa <tfiga@chromium.org>, Mauro Carvalho Chehab
 <mchehab@kernel.org>, Marek Szyprowski <m.szyprowski@samsung.com>
Cc: Chen-Yu Tsai <wenst@chromium.org>, Yong Wu <yong.wu@mediatek.com>,
 Hsin-Yi Wang <hsinyi@chromium.org>, Fritz Koenig <frkoenig@chromium.org>,
 Daniel Vetter <daniel@ffwll.ch>, Steve Cho <stevecho@chromium.org>,
 Sumit Semwal <sumit.semwal@linaro.org>, Brian Starkey
 <Brian.Starkey@arm.com>, John Stultz <jstultz@google.com>,
 "T . J . Mercier" <tjmercier@google.com>,
 Matthias Brugger <matthias.bgg@gmail.com>, linux-media@vger.kernel.org,
 dri-devel@lists.freedesktop.org, linux-kernel@vger.kernel.org,
 linux-arm-kernel@lists.infradead.org, linux-mediatek@lists.infradead.org,
 Project_Global_Chrome_Upstream_Group@mediatek.com
References: <20240412090851.24999-1-yunfei.dong@mediatek.com>
 <20240412090851.24999-6-yunfei.dong@mediatek.com>
Content-Language: en-US
From: =?UTF-8?Q?Christian_K=C3=B6nig?= <christian.koenig@amd.com>
In-Reply-To: <20240412090851.24999-6-yunfei.dong@mediatek.com>
Content-Type: text/plain; charset=UTF-8; format=flowed
Content-Transfer-Encoding: 7bit
Precedence: bulk
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0:
	=?utf-8?B?N1VmWUNGMjJFNHhJZXFta3I0MEEyMzF6WTlCa1cxTmdoTDVXc3RhV1MzZ25n?=
 =?utf-8?B?Wm1veXBvYjlRdDd0cENQa2xPdGVTci9Ob2orblFUWHVJRUd0OGEreTd6VW1Z?=
 =?utf-8?B?eVdnZjIxZG5zUzFJSkpJL0VyOThrN1V0NjRQeW5aMzUrNHhkQnAvbU1BTlJq?=
 =?utf-8?B?UFZtcmFzQVRYM2FiSE1XODZsVDRKQVhhVk9YT0hXZ2YweDA5VjB1ZW9hUlNP?=
 =?utf-8?B?NENCR0tPUnlIL1lpOGVKblBuRHE3RkJ2UXF0R3k0c09zS25WSUQ3QnBpaXlK?=
 =?utf-8?B?RVBING1lamF5Mk1lNHJtdzVxbDNUN1NZTngyQkY2ckRwUUlaYXhZcjdhQzdt?=
 =?utf-8?B?cm93cDlkSDhNTTdvK2hvbWJtNCtVbWd6UzFiSHR1VFJPd21EVE0wQ09odE56?=
 =?utf-8?B?UERSNG1LZXk1QlJxck1FNU1aTU9UalFVRU5kL0FubTFVeUN4WFBXWCtsNnJG?=
 =?utf-8?B?ZTA2eDlBUW1QcG0yakdsT3VDRnFBRE9ubjljeTBkSHhyNXhiL0I5emF4b3Bx?=
 =?utf-8?B?M0lSK2dkT3hCTGVHL05LWmZOR3FIS0xRdjJMcXhuOTJZaklYdVpsSWRhaWpn?=
 =?utf-8?B?dmgwcW44ODh0elQzQnJxT3ROc3l4Sll0dHY4cHJmSXQ4QmpGWDlVRFRsZHFo?=
 =?utf-8?B?c2hZUkw2TWNXaHJiellXUTcwcDExditUaWlNeUdVamx3cEFpWnJObisxMlBo?=
 =?utf-8?B?d3hWZm5RODJseEduSTE4M21BcUJxbU1FV3hLbEs5RGE1Vk9pYngyeisvbWlF?=
 =?utf-8?B?OUc4VUlMaDIzRTE3bWx0NytSRDI4QmpKRno1ZGlCQUlqL0JMcDNYUUl6VmJU?=
 =?utf-8?B?cGFQRkZNYWhyUlRiWHJPeUVMRGVYK3MvY2JLMWsrMU9iVVBSazIwQXJxZGJk?=
 =?utf-8?B?QWJDQXBjeE4wdFJkVDd1Zngzc0RtSllncHhRb2J1UWdZdUNGazQ5aVd4TGZq?=
 =?utf-8?B?ZVYzbCttWUVHYW45WGlqWVlCTk5vYkNnQmJCbGJXTlR4dCtveVNmb2xOem5D?=
 =?utf-8?B?WFZUWDZ5RVo3dHd6bnJtb1g1aDdNL2NkejdVRm1BeWVuM0QyaGdRQW5TakxT?=
 =?utf-8?B?alV2SGJOZnVEODByd3cvQUYxL2txdzVPMTVwbHZlQ2hoT1B0VmxmNUJyMU1H?=
 =?utf-8?B?eXErV0QvSXpwLzh1eGtFOXVobndBTWNJaC9KVFZBL2REZk1vNStNUXZha3Bx?=
 =?utf-8?B?dXZLMGZwSjJ4ai95Y1ZVNEc0S05iV3BpSXo5RU4wMUd5Y3RWNzNVOWpjeTRF?=
 =?utf-8?B?Z0wvMWQ5RHN1SnlyTEVJbk01eHljczlJcHYvbGZuZk5BK09KL0tvRU93OVpT?=
 =?utf-8?B?bElaTFJpT1FrNFJINlNVNDZkb2lnNnUzQU9oYUIxZkxrZHZ3cERQSGkzNTMv?=
 =?utf-8?B?QmtxdVQyZmVJaExYaDJOU0wvaDB2ZkdVQkRhbnRFeURJTURNRHFxTE9iNHVm?=
 =?utf-8?B?NmQwREJ2RzMzWFJKZU1qdkhQbE4zb1VvK3JMdndaUVZ3bko2RWJtWmNHZW1o?=
 =?utf-8?B?Z3FIVFRveTVRaU9rRmE3cWg1ekpyVHdzb3F6NjBnMGNDOWNubEhYV2xPbkRm?=
 =?utf-8?B?U0dENlNNM1ozeWRaR21OLzh6S3J4NTN6ejNsVVJRUXBCeG5uZm8vNWJZdDZC?=
 =?utf-8?B?bXE0ODZtd3krdVUxQnZzR1Q2QUhLODJCOFNOdmw2VGdnVWVqZk5nSDNtSjZq?=
 =?utf-8?B?OXRvOGwzajNzd1Q3STJzL0p3djR2ZUcvK3RYWkJjYzNydGY4Y01TemdtYzhO?=
 =?utf-8?B?QjY4S1ljM2d1UU1Zak9pdHFMbExHSzB6VllUNW9wRTZKcEVwaHB1QlY1bWs2?=
 =?utf-8?B?ZEl0WVN0cE9WdmR3Rk1QMlBQZ3luOGx3SFNSdkRFbTE4ZkR4bTBWN2xtWXVk?=
 =?utf-8?B?U044U3hMa0pyUDdpdjFaWjdCL3g3UHlwdVZhQzZ5SU5nOHp4bVJXTDdxZ2dQ?=
 =?utf-8?B?N2NTRkNGd25qdGNzVlFldnZ1azR0MVhLU0lxR3ZteitZODB2Qi94Q2hSZDBn?=
 =?utf-8?B?M092aktuNHlhOGE1Rnl4MmlCYnNoOTZSUWtZNmh1TEdsSkJiQnlOckNnRnNC?=
 =?utf-8?B?bUdxbDB3MDVKb1NjdzVRWlRSZnRsckV6Vjh5TDBqLzNZY1QvV0JZK0VTK2Zw?=
 =?utf-8?Q?ZOl20oko1fk/SJRiPLEXs2kdZ?=
X-OriginatorOrg: amd.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 33931949-a65a-425a-d9ad-08dc5ad14d90
X-MS-Exchange-CrossTenant-AuthSource: PH7PR12MB5685.namprd12.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 12 Apr 2024 09:16:57.6903
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 3dd8961f-e488-4e60-8e11-a82d994e183d
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: yolCHiEtICIj6ORmigBsCzCKISCXshZKkX5ByTXGRkK9ak7kL8dJlIA4Vahf4RPq
X-MS-Exchange-Transport-CrossTenantHeadersStamped: SA1PR12MB7317

Am 12.04.24 um 11:08 schrieb Yunfei Dong:
> From: "T.J. Mercier" <tjmercier@google.com>
>
> 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@google.com>
> Signed-off-by: Yong Wu <yong.wu@mediatek.com>
> [Yong: Just add a comment for "priv" to mute build warning]
> Signed-off-by: Yunfei Dong <yunfei.dong@mediatek.com>

If nobody objects I'm going to cherry pick this cleanup here into 
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 */