From nobody Wed Oct 8 22:32:49 2025 Received: from mail-wr1-f41.google.com (mail-wr1-f41.google.com [209.85.221.41]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 785B92C08DA for ; Tue, 24 Jun 2025 13:39:31 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.221.41 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1750772373; cv=none; b=sOSJDg7j/fUmOvTKKntp0Px+AuNgG2WdgMH6gMng89Nwq2Z3Qf0Suo4+VrTLm6K5H9HjDlAVB/HupCezasjhXVz4y9E5G9T9qi11jLHlJbs7QFA7WeqXNOnmncReD/ztOAZCXL09aTTTVUbq6kFI4hNmQyGhDrKA5zFfJx3pqOc= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1750772373; c=relaxed/simple; bh=A6LKHXBUG4iUTzGnKK5661G16ikKPC/56/HUtV07NJs=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=g7YVzcTxvPyoMc5gPh8ijX1S3NL/H6JiX7s6bMeXKmlLSwzEF/lcw61L3O3jPUpBPNUzOQ4H+sTK0rtrhs9lo9m7z7q+ChY9F4M2lr4hKPdo6ool+A9X77YGI7SYh7oujKexg3n7bHwK98mIPTnF/lYGi50eslELwnnH5IVjaGw= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=quarantine dis=none) header.from=suse.com; spf=pass smtp.mailfrom=suse.com; dkim=pass (2048-bit key) header.d=suse.com header.i=@suse.com header.b=FRHzr7Du; arc=none smtp.client-ip=209.85.221.41 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=quarantine dis=none) header.from=suse.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=suse.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=suse.com header.i=@suse.com header.b="FRHzr7Du" Received: by mail-wr1-f41.google.com with SMTP id ffacd0b85a97d-3a528e301b0so283405f8f.1 for ; Tue, 24 Jun 2025 06:39:31 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=suse.com; s=google; t=1750772370; x=1751377170; darn=vger.kernel.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=G8OYkNwJziYcgoiRcCAHS+W9j9ESRdVu8lYPwRcMBHY=; b=FRHzr7DuAjoRUeQd9yt5fimv/BBC54RLBV9boEgV+68y7uaZjiiXy2ioPwOmXcHfHu iTX0LzwpY+157yynfG7qTV3rPUup0gXBjNot9+6lc57/tJ02hFZoYDKMst2ByG0pYHrk vB9eUX62ouS1sNms8PJ6S3JMZXq18a+aE7IlJ5HbOeI/rTSTpXVL2Yny9XuEMKyQvXU2 jobFpZcer2CMqemG3eNXseGV8NBgnRaDdzeDx9DW54GXC30kLNb1Z6BfNCgUizFIZB8a +MEHG/D4PUoU4cSzy40/aiz6qDq9RCyVmAOtDVf1GWSKsdFGfTHAJnQ2Cv9+nwiL1taI evDw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1750772370; x=1751377170; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=G8OYkNwJziYcgoiRcCAHS+W9j9ESRdVu8lYPwRcMBHY=; b=eQzGGY3qVENyqYkmI1ZxyhLK2Mh0rEnlCUk5LoRfTNFNTIlXCY5Jc4ZQ5A0Nxgy7/a 0h92YcjmqFygHlDwYPy9JtCOHFHcO513g4qbDZz1vp+Q8VWUzctgabOtRb7hker1zWUt +mfbeNMb53cR1CpUWFWOu0gBO1/5PS3BIYlS/dH3swgWOOmvXMtadGMSOUgYelOAfWPy Q15TzcgI5CRptii4+n8I/wA0VFZd+yswDkDSk4gpuwsJluGxKpErJneAFg47Y8ZneQWS cPdxwOAMDQBE4WmBLFK8gafK6bYcXhqh0QoWhxdKGsCgj4sqjNMdHkaLsjwHzpIZDPBk UcLg== X-Forwarded-Encrypted: i=1; AJvYcCX2/8tS5fhv9ooQC1DjrsQKghfRcuttfXfOCxAwaMhdrhxuF3bXIUnqd4rFnxd4aa6tF7PJOotqQcPvTOw=@vger.kernel.org X-Gm-Message-State: AOJu0YzssCwLmmcpNeUGBNLUsiJ0fdJMF96iNzGxisdfVXMJgGqoFwWh w6rz0ZYZ4lnZUHhYQ2+OqeRzKDlDmGJvgQF9dS9cVAS2CO7HOgQRbzeheiZIuXwWnGo= X-Gm-Gg: ASbGncsRBCl/BNcmx8DuOi4MhXQTEDJwGZanITQwOT4T0HE2AJa7U9uJkGM3301I5Tv WBTHZew0pN759y6WaaG90qaNBpmkftLcodKIdC9r//VH4tU/nUNc/8bZNEdbKjD0U+8zptDGemu v6CqvSCHCwMmzeHXE1Jx9Bjm0Ve8yQ70fKHkG3dN4Ud/edBUZFwPezweYevbGSHmgpcOw/suBqZ kzjUK61OSFzM2IITxW8j8v2S0d4iLDuynE3D9dvY0AtX30R9kFvhhKUk5aC6yoBSTOfWw9wrctb OKuCi6U66q/rk31j8KBeTcDspCoNzn5Tz2PWppNUTw5ziqtE7ND7OV0+jtPuv/+woqPTLt0rkUC 2/ellhFvHNNnZUW9ahstf2N2YRpwzNELkjR4XPN2DoepUI8wkQWdO X-Google-Smtp-Source: AGHT+IEIwFSHwaoj31PtLeuWDl43hdEdyv9aVZ6WqShd2YpoPc0pFXp6GwtI5lbLwyI31derXkrYlg== X-Received: by 2002:a5d:5f4b:0:b0:3a4:da29:d13f with SMTP id ffacd0b85a97d-3a6d12e1dc6mr5124726f8f.3.1750772369659; Tue, 24 Jun 2025 06:39:29 -0700 (PDT) Received: from localhost (dynamic-2a00-1028-83b8-1e7a-3010-3bd6-8521-caf1.ipv6.o2.cz. [2a00:1028:83b8:1e7a:3010:3bd6:8521:caf1]) by smtp.gmail.com with UTF8SMTPSA id ffacd0b85a97d-3a6e805d5f4sm1928629f8f.27.2025.06.24.06.39.29 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 24 Jun 2025 06:39:29 -0700 (PDT) From: Petr Tesarik To: Jonathan Corbet , Morton Cc: Marek Szyprowski , Leon Romanovsky , Keith Busch , Caleb Sander Mateos , Sagi Grimberg , Jens Axboe , John Garry , linux-doc@vger.kernel.org (open list:DOCUMENTATION), linux-kernel@vger.kernel.org (open list), linux-mm@kvack.org (open list:MEMORY MANAGEMENT), Petr Tesarik Subject: [PATCH 1/8] docs: dma-api: use "DMA API" consistently throughout the document Date: Tue, 24 Jun 2025 15:39:16 +0200 Message-ID: <20250624133923.1140421-2-ptesarik@suse.com> X-Mailer: git-send-email 2.49.0 In-Reply-To: <20250624133923.1140421-1-ptesarik@suse.com> References: <20250624133923.1140421-1-ptesarik@suse.com> Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="utf-8" Make sure that all occurrences are spelled "DMA API" (all uppercase, no hyphen, no underscore). Signed-off-by: Petr Tesarik 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/dm= a-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. =20 -Part I - dma_API +Part I - DMA API ---------------- =20 -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. =20 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 ------------------------------------------ =20 -To get this part of the dma_API, you must #include +To get this part of the DMA API, you must #include =20 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 a= ccessed by the device and returns the DMA address of the memory. =20 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: =20 =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D =3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D @@ -775,19 +775,19 @@ memory or doing partial flushes. of two for easy alignment. =20 =20 -Part III - Debug drivers use of the DMA-API +Part III - Debug drivers use of the DMA API ------------------------------------------- =20 -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. W= ith the advent of hardware IOMMUs it becomes more and more important that driv= ers do not violate those constraints. In the worst case such a violation can result in data corruption up to destroyed filesystems. =20 -To debug drivers and find bugs in the usage of the DMA-API checking code c= an +To debug drivers and find bugs in the usage of the DMA API checking code c= an 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. =20 If you boot the resulting kernel will contain code which does some bookkee= ping @@ -826,7 +826,7 @@ example warning message may look like this:: <4>---[ end trace f6435a98e2a38c0e ]--- =20 The driver developer can find the driver and the device including a stackt= race -of the DMA-API call which caused this warning. +of the DMA API call which caused this warning. =20 Per default only the first error will result in a warning message. All oth= er errors will only silently counted. This limitation exist to prevent the co= de @@ -834,7 +834,7 @@ from flooding your kernel log. To support debugging a d= evice driver this can be disabled via debugfs. See the debugfs interface documentation below for details. =20 -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: =20 =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D @@ -882,7 +882,7 @@ dma-api/driver_filter You can write a name of a driver= into this file =20 If you have this code compiled into your kernel it will be enabled by defa= ult. If you want to boot without the bookkeeping anyway you can provide -'dma_debug=3Doff' as a boot parameter. This will disable DMA-API debugging. +'dma_debug=3Doff' 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. =20 --=20 2.49.0