From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from kanga.kvack.org (kanga.kvack.org [205.233.56.17]) by smtp.lore.kernel.org (Postfix) with ESMTP id 2220BC77B7F for ; Wed, 25 Jun 2025 02:41:44 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id B2D846B00B4; Tue, 24 Jun 2025 22:41:43 -0400 (EDT) Received: by kanga.kvack.org (Postfix, from userid 40) id B05156B00B5; Tue, 24 Jun 2025 22:41:43 -0400 (EDT) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id A421E6B00B6; Tue, 24 Jun 2025 22:41:43 -0400 (EDT) X-Delivered-To: linux-mm@kvack.org Received: from relay.hostedemail.com (smtprelay0017.hostedemail.com [216.40.44.17]) by kanga.kvack.org (Postfix) with ESMTP id 90A5C6B00B4 for ; Tue, 24 Jun 2025 22:41:43 -0400 (EDT) Received: from smtpin02.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay03.hostedemail.com (Postfix) with ESMTP id 121A9BF11A for ; Wed, 25 Jun 2025 02:41:43 +0000 (UTC) X-FDA: 83592372486.02.EFD9851 Received: from casper.infradead.org (casper.infradead.org [90.155.50.34]) by imf25.hostedemail.com (Postfix) with ESMTP id 406FBA0003 for ; Wed, 25 Jun 2025 02:41:40 +0000 (UTC) Authentication-Results: imf25.hostedemail.com; dkim=pass header.d=infradead.org header.s=casper.20170209 header.b=uJM6BLB6 ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=hostedemail.com; s=arc-20220608; t=1750819301; h=from:from:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:dkim-signature; bh=bqS8VBg7H0zTWw6zFLBSfLSl1NjJXNGmF0tzhS3Kfso=; b=MNd/uY5o5W/64ETPPqBCm4susVpgswJNpG9iE1g0E9PYYrB9sb/7S+jCO7Z6x5Gk3Wv6wp PNiPsYsx2GX4dI40chWZxNBXatWg2Ia+uqTm0224fGwJc8tMxgHysySjQUYqAr7LPWs4nM N41bFT/1Or/zajAjKToTZM/qSeXeblY= ARC-Authentication-Results: i=1; imf25.hostedemail.com; dkim=pass header.d=infradead.org header.s=casper.20170209 header.b=uJM6BLB6; spf=none (imf25.hostedemail.com: domain of rdunlap@infradead.org has no SPF policy when checking 90.155.50.34) smtp.mailfrom=rdunlap@infradead.org; dmarc=none ARC-Seal: i=1; s=arc-20220608; d=hostedemail.com; t=1750819301; a=rsa-sha256; cv=none; b=i6mR9+Nugj2P7PpVyGQtVzYE034lhNBM6WpOu6MLhhVErxseraywyFhYCf02Kcg87OiGk+ ewtkfor05vsl/O/hJcckhAPbqMItubd46zimCVmNLTJrZ5rR8XJxM6BFz8vZ0ErRsonC94 z2NFwHL6QUnDJ2P90lZTw2gBS3ZZjcc= DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=infradead.org; s=casper.20170209; h=Content-Transfer-Encoding:Content-Type: In-Reply-To:From:References:Cc:To:Subject:MIME-Version:Date:Message-ID:Sender :Reply-To:Content-ID:Content-Description; bh=bqS8VBg7H0zTWw6zFLBSfLSl1NjJXNGmF0tzhS3Kfso=; b=uJM6BLB6B2t3Hd1d3c/bLLVmUJ WsX1a480WFy1MFsocTmD3mRD4/ClPRzuXYr8zdrxd9FaNSZLNS1AwU+fNGZ3o5Ao/RmNmsKBqGshd KVJ48+c6bEoIm1danbGhcUZ+UOFmNbC/BB3ZRiVq1v45VjL/pqrdxGEeAvPPtAOvK0Ae/pV1PWPoF 7I+aGCrfnzrW20oA5LMe7a+PKmT9BayPtr8ml0/TggFcPVA/bM5tN1mV3K1VcWzFG92Z4qGPn3n7U 2q8E4xUHfXSjA4C3vK7bFhg1J4XiL7TDrgxcj3zRsUCtN6R/jL+mQQcdhZBu9bewvdlPa7XKfYGRo PzRUad4g==; Received: from [50.53.25.54] (helo=[192.168.254.17]) by casper.infradead.org with esmtpsa (Exim 4.98.2 #2 (Red Hat Linux)) id 1uUG4r-00000008GIU-2xCp; Wed, 25 Jun 2025 02:41:33 +0000 Message-ID: Date: Tue, 24 Jun 2025 19:41:30 -0700 MIME-Version: 1.0 User-Agent: Mozilla Thunderbird Subject: Re: [PATCH 1/8] docs: dma-api: use "DMA API" consistently throughout the document To: Petr Tesarik , Jonathan Corbet , Morton Cc: Marek Szyprowski , Leon Romanovsky , Keith Busch , Caleb Sander Mateos , Sagi Grimberg , Jens Axboe , John Garry , "open list:DOCUMENTATION" , open list , "open list:MEMORY MANAGEMENT" References: <20250624133923.1140421-1-ptesarik@suse.com> <20250624133923.1140421-2-ptesarik@suse.com> Content-Language: en-US From: Randy Dunlap In-Reply-To: <20250624133923.1140421-2-ptesarik@suse.com> Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 7bit X-Rspamd-Server: rspam03 X-Rspamd-Queue-Id: 406FBA0003 X-Stat-Signature: otofd1m38tdu47ipgeun7cup9nh39iis X-Rspam-User: X-HE-Tag: 1750819300-824703 X-HE-Meta: U2FsdGVkX1+bvqBHxb93pIophtNVdcVOiSvAbQRzxim9Wa4XI5zLB0pKvCzd/jRBqmHivNyw1rCXJUZaK6rfRimCgIQkTf3t1r9UvBdZt9+S3peE6pJFhkSrn2EjbQoqJJcZjAsgoHEify9UpKurw+DWp07Aosu/EByte7j6tgOZvlCwXD0XAaa6bYkm/cDZohlQXtMyhSp6Z7QMmVyRmNZT6GsGGmm4oDvYdvDgFkaqRz/oTcqCGQhIy7bDmb0hDB7KFwXfB0EmGhiXpkaLRj1s5UB1dIOUGCxTACpQO510jhWsuOTWac3U141B+rglIJtfJVuq3TytirLhkkcINykMoiDzE4no0klwNT2kYEli8DI/Q1CG59QU8YeMgJODWjpKXcaSzBfqO1R6jyfa9oduziWRrG6g82Y/7SsbIGGlwWPoYDbCzw8D1p6szLivD1zmdHsT1/L/aFrzotJZMp6to6dQi9CrdArBVGfF08y2IsgVj8Adx8ckWF6PLi8hPSPdVxb+61ClA49MIX9XsLtWdMZiiub8YwN5XVI5ZA6g6wZJ3ad4W9jmrW9HsOgcVR85Su2tKI4XeZT7yobZAtLC2HGfjwRGU/Jm/ELVeVTBD2J4vfMSq6tVQNhDpoa4INWMBW0d+6IrvW3ivZjoz4gSF7E7Txb8m9gKCfknMiY9o3rm8FJmcF28fumkckZIK8eYZGleLQw9aQcCswnnPXg06B8PZFtAi4ff8cyVa8p3Do6JpyjkVgWcHtPz/jBX807ZWu4AftglLKw+TOt+5AKTs0cd60x6Q65AlDBkgPTSPcHqSAcQlpQu1hvdVkignH648CtJRgNqIsvzqfAMAyVOf3xsjJEVlJR6W7fTnfwwCR9XiA9LqbvSLAki6mbfdYctuH2fHLV15zGGZaeB67aYCk+xC5uHIzTk/ySF9SpmnvmgZM/29Sf0ZWl8qC1OIo85tHzlaPqMucoQlWK YIQvXUD0 FyRDKFOKg7DWyWpAWTqvvH17SDt7R5cwda3WBpjRJ1XDtS6xCINUX3uKIO/vn+bOEHI/nXmztejAbQisS00PnsJLLbd2P/MYEZAkL5D8V+b0BjH0jd3b9t7DqnPFdhJOGqIGE+f6OK4WNW8gykoITX5opXY2MOa98kRH/AitQN1L7BfmhxFuyL/5rhcfH2/ZXrUK+EqybO8fjdwn1iQ2BwCJcqSAEhaR+4W1VSz5DYdlaxIEx2m1zIMivLkZgk7Kmk+8GN3taDnH0glBUdjFObPjeAzPuoozwXhCWIKJweTm3T09Iv5+SgS+lH4jqDgfdZ+P0WSxd0giIcdE= X-Bogosity: Ham, tests=bogofilter, spamicity=0.000000, version=1.2.4 Sender: owner-linux-mm@kvack.org Precedence: bulk X-Loop: owner-majordomo@kvack.org List-ID: List-Subscribe: List-Unsubscribe: Hi Petr, On 6/24/25 6:39 AM, Petr Tesarik wrote: > Make sure that all occurrences are spelled "DMA API" (all uppercase, no > hyphen, no underscore). > > Signed-off-by: Petr Tesarik LGTM. Thanks. Reviewed-by: Randy Dunlap > --- > Documentation/core-api/dma-api.rst | 22 +++++++++++----------- > 1 file changed, 11 insertions(+), 11 deletions(-) > > diff --git a/Documentation/core-api/dma-api.rst b/Documentation/core-api/dma-api.rst > index 2ad08517e626..97f42c15f5e4 100644 > --- a/Documentation/core-api/dma-api.rst > +++ b/Documentation/core-api/dma-api.rst > @@ -13,10 +13,10 @@ machines. Unless you know that your driver absolutely has to support > non-consistent platforms (this is usually only legacy platforms) you > should only use the API described in part I. > > -Part I - dma_API > +Part I - DMA API > ---------------- > > -To get the dma_API, you must #include . This > +To get the DMA API, you must #include . This > provides dma_addr_t and the interfaces described below. > > A dma_addr_t can hold any valid DMA address for the platform. It can be > @@ -76,7 +76,7 @@ may only be called with IRQs enabled. > Part Ib - Using small DMA-coherent buffers > ------------------------------------------ > > -To get this part of the dma_API, you must #include > +To get this part of the DMA API, you must #include > > Many drivers need lots of small DMA-coherent memory regions for DMA > descriptors or I/O buffers. Rather than allocating in units of a page > @@ -247,7 +247,7 @@ Maps a piece of processor virtual memory so it can be accessed by the > device and returns the DMA address of the memory. > > The direction for both APIs may be converted freely by casting. > -However the dma_API uses a strongly typed enumerator for its > +However the DMA API uses a strongly typed enumerator for its > direction: > > ======================= ============================================= > @@ -775,19 +775,19 @@ memory or doing partial flushes. > of two for easy alignment. > > > -Part III - Debug drivers use of the DMA-API > +Part III - Debug drivers use of the DMA API > ------------------------------------------- > > -The DMA-API as described above has some constraints. DMA addresses must be > +The DMA API as described above has some constraints. DMA addresses must be > released with the corresponding function with the same size for example. With > the advent of hardware IOMMUs it becomes more and more important that drivers > do not violate those constraints. In the worst case such a violation can > result in data corruption up to destroyed filesystems. > > -To debug drivers and find bugs in the usage of the DMA-API checking code can > +To debug drivers and find bugs in the usage of the DMA API checking code can > be compiled into the kernel which will tell the developer about those > violations. If your architecture supports it you can select the "Enable > -debugging of DMA-API usage" option in your kernel configuration. Enabling this > +debugging of DMA API usage" option in your kernel configuration. Enabling this > option has a performance impact. Do not enable it in production kernels. > > If you boot the resulting kernel will contain code which does some bookkeeping > @@ -826,7 +826,7 @@ example warning message may look like this:: > <4>---[ end trace f6435a98e2a38c0e ]--- > > The driver developer can find the driver and the device including a stacktrace > -of the DMA-API call which caused this warning. > +of the DMA API call which caused this warning. > > Per default only the first error will result in a warning message. All other > errors will only silently counted. This limitation exist to prevent the code > @@ -834,7 +834,7 @@ from flooding your kernel log. To support debugging a device driver this can > be disabled via debugfs. See the debugfs interface documentation below for > details. > > -The debugfs directory for the DMA-API debugging code is called dma-api/. In > +The debugfs directory for the DMA API debugging code is called dma-api/. In > this directory the following files can currently be found: > > =============================== =============================================== > @@ -882,7 +882,7 @@ dma-api/driver_filter You can write a name of a driver into this file > > If you have this code compiled into your kernel it will be enabled by default. > If you want to boot without the bookkeeping anyway you can provide > -'dma_debug=off' as a boot parameter. This will disable DMA-API debugging. > +'dma_debug=off' as a boot parameter. This will disable DMA API debugging. > Notice that you can not enable it again at runtime. You have to reboot to do > so. > -- ~Randy