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 26394C7EE30 for ; Tue, 24 Jun 2025 13:39:35 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id D11186B00AF; Tue, 24 Jun 2025 09:39:33 -0400 (EDT) Received: by kanga.kvack.org (Postfix, from userid 40) id C9AAC6B00B2; Tue, 24 Jun 2025 09:39:33 -0400 (EDT) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id B3B4B6B00B3; Tue, 24 Jun 2025 09:39:33 -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 99AE46B00AF for ; Tue, 24 Jun 2025 09:39:33 -0400 (EDT) Received: from smtpin13.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay09.hostedemail.com (Postfix) with ESMTP id 4CFB5808C1 for ; Tue, 24 Jun 2025 13:39:33 +0000 (UTC) X-FDA: 83590401426.13.A34FA6C Received: from mail-wr1-f50.google.com (mail-wr1-f50.google.com [209.85.221.50]) by imf12.hostedemail.com (Postfix) with ESMTP id 6353A40006 for ; Tue, 24 Jun 2025 13:39:31 +0000 (UTC) Authentication-Results: imf12.hostedemail.com; dkim=pass header.d=suse.com header.s=google header.b=OxkIZKMS; spf=pass (imf12.hostedemail.com: domain of ptesarik@suse.com designates 209.85.221.50 as permitted sender) smtp.mailfrom=ptesarik@suse.com; dmarc=pass (policy=quarantine) header.from=suse.com ARC-Seal: i=1; s=arc-20220608; d=hostedemail.com; t=1750772371; a=rsa-sha256; cv=none; b=YC48W3Br6BIX0ajU2IkCpINN5F6a3cPkIoT3TLp3yUu+8oF3XHqXjGFoIxCuN6iIt/86E3 7IvgJvhpqIWqQjYflB1dRdhx9PV3KCdCc9aQZsn2v/XEH436/dhcKrZvX7KBic47gHna3z xYBF4MIXfNF5/aTl6afvGCZPzy141aI= ARC-Authentication-Results: i=1; imf12.hostedemail.com; dkim=pass header.d=suse.com header.s=google header.b=OxkIZKMS; spf=pass (imf12.hostedemail.com: domain of ptesarik@suse.com designates 209.85.221.50 as permitted sender) smtp.mailfrom=ptesarik@suse.com; dmarc=pass (policy=quarantine) header.from=suse.com ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=hostedemail.com; s=arc-20220608; t=1750772371; 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-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:dkim-signature; bh=G8OYkNwJziYcgoiRcCAHS+W9j9ESRdVu8lYPwRcMBHY=; b=DUydgOLFzmBTqQr3eztvN8TyNJ/OrYwz77C9ckoe6GHbJI7x+kh5Ydj5K6ToAWKKZbb1Hu +tmHfb5FbQtXNf2YkcJSMfZs2Axo66ZnsgLQiHJ/K7WnAo6PWHitgRrY3/XK+hp05nivi8 rAXwFxemsTVk2YhKcBi8FUVuYwL6zQA= Received: by mail-wr1-f50.google.com with SMTP id ffacd0b85a97d-3a4e575db1aso266660f8f.2 for ; Tue, 24 Jun 2025 06:39:30 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=suse.com; s=google; t=1750772370; x=1751377170; darn=kvack.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=OxkIZKMS9pNjX84OIKhJOmmpoIu6n0riSHkbVpKAsdJht691NJW+RZZ05VA0eNqDLA rASP5jmSx9U9hlfFCYnuy83VAOi/AvU2SeyrNc6PlVKW3rZNcW85oUh56D3alr9Uyu0E LyFv440cT1Gs6+A3sf+89c0d635qJPifTT8B3YH9GEpZb8WjSSMuxr3weZCRLm5XGmkP nftE/7gsw4SBeeicihfLmr5LnDf/AZ0KBTjq6q1XH08IAlqanXPOr87QfZAhBhh8HuIM EIOjjRTH3seaf4uk/pwt/egAdaeJl7ablX4vqKyLM5Smt+OpPmwoyt7F/lCyV4E91UWU XsKg== 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=QVgSZmt2xN1YuD/T9+T6CY6tkNON7rmhv8U3psK7pm/JDtZqMUUUvq0wbdQlxbfBAY 02pJI8pUTXKNU7vmSU0MxbflnXYGJXTxk5rbhvg1xKtI7wz5EPNT0kJjf7dkjKQXUJVg pNSs/IHLzySBS5Rhzx9YoAkDy7eiJF+Re9zmIo156Ykpn5puiLwYuCqlQjj7DNl5MGyO xLOrRCkWmL1d9Kz+z3lBjk/rHVjxzT86wiW6YtQZyDjE8NH/lQYvOPwNZFe1hyb2fMcT xn27d/vICNBj/Mva8Xa0jBNEhRA37iZjvx+E/nh0F4QXhYPEc7ZO5Mh5l5cCYSKJPkNK KOyA== X-Forwarded-Encrypted: i=1; AJvYcCUC0MuaF1radGoiV79FzcD/5gE6gVhetkBmeP9/yZkiersR9li1J+Y/4z6RRkGQduis/UikTJTaZw==@kvack.org X-Gm-Message-State: AOJu0Yzm1C+9bh+M6WW1Y84RFewQhANGUMdOYXthKx9zUQpE8gfAjv1h dGF1chkU/MQ+xGtdKC9Xc8prADeNuezQoJmSJYZtdPwWFxrI7UyaYMCY7gpoCDSuKlA= X-Gm-Gg: ASbGnct6noPRpxVxgmMW1WoFilrOzyAj42wYYTec9YkK319GC0amNm3m0CH7LBXk7+s Cpks88tupMhPHL0ZA5OzMi2AzDo+EgsksMWt8xqXmDKzwuF4mx6RfDAWegGSPZvLcXITJ1RmV7O 4QSGEKg9DJPD7A7rOHfzo5Egn9UJO7y5wPisMfe5/k5Ol4WZS2U8JOCMkMpcft4uFw/ImxGcAeI zdyKMAo+Y3S4Ln/CmmHlehYOJfK2Buywfj7VKmEHOKEzHNEXbsNxe07TqVSHsSqgIS4IjapBHKI 0RbEFZ7qQlgG7QPt1KTlFAR5ct9+z0W1Wxw020aPNAtTp2bCqfbgf6sogndEgBAnV1DJHFiFm0V j9H9OE7x3HSaBUIARvYYSyMgph4x9QR5PItcZ1wDoR3ggqdMBXUPN 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> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Stat-Signature: 4dz5f7r3dn63e31qi4e85uhm6xs93tjd X-Rspamd-Server: rspam05 X-Rspamd-Queue-Id: 6353A40006 X-Rspam-User: X-HE-Tag: 1750772371-635289 X-HE-Meta: U2FsdGVkX19KkwuOC9lNVZ9nPY3vYLJ0+1S2PyKRePTX5TJHKS1rJkBrnm8QUGh9rZonHyXEWOHtxi7VPZqmoSgRPcN7Swso42bR1EpyS74IptJ8Q1Rny52ELQJDMUYXuQOe3t8pgMfZ9wWvyYi3QhJUerSusH8ptlKSHWe/dfp45PVJ+AJa5mm73zn8W+Y1A49/xOvzN7G34SKAtZnSC2zywJenxorAuYaPVgXZ+9wOv2ISm2UDWlRYXIWwciFozXu8vvhvySux7PRS1TuNlUoizj7K1TVfKS3mcdyxHZRWi3nSuksbWixGqLsyC8p3stoEgdLNPj73JSFJ6y2yPSmDRPBqIS6BeQOGHnvgnT6D1WwdBwAC1eB4u/RSchJrDBFopgNPnwCADCnKjZ2ndH+0tIr19GM/BpRMbcfwFig95dxce6b4xOP+U2O2xRw6mUgOCLBT5clhOPHIMfsku3DNoaPBuVvdXLhsIeTNSLAPlKvkmGjK6siBnUe0h22CHnvPrOew7NtfTf4BGjh47P8XMI64rTJLkhCGEwQCByJtYJzK7fHue9ERABV1PLPEOigPjUOaplB5HCSRgP4YQ1/nskDrKuFU/9ra4xCckAMvcomTuygDP+do/77Es/1MYO6QmWfVzQ/EHKWUUptOgkvegl5XnMq6z06hLMxviYy3FSytF1jYCvRJ5x0KhIdEusnGKqJHnSKzPMnoyJMIUDdVpRu3ksYFWg54l4Lg5ni4QWTJzQU9dggh6DyR4zN0q3qdUnKVrfVf2B96J7esGkAYN5xs0GHgJ+unFxJIWyRd1kpPfJm7LPrl336xp4ONaBeFkb6r5MbTVMx38OQswduJd5A2/BiwDTkCpg9iy7PqDCscy2Sgx+tA5ZObaaHcHuXqP5X4/Z5RUUYyOgJHnozZe6/xhG6kXsYp5EwV1B8bKHppiKXXOvqebmoXGpOtrvFZL5rOpWavVdNJSFc oAxw4BOi AvWKb+jinzXaa6YIlqF+San2TliLJJRuDbY310xmwKd8EPq24WB+Cnx8uJWc+VhF0vLhy9xeqlHahImFToDUbkp8YoV3ZfXPD0uLuc+/Bl7r35oGBWw38qCy2dc+hJjThXbxPLt5wsgTJGwXc9ugEqJIAvqllDA/dulAVkqhwcuUrXH/3I6bNGaTlDiWOKMCnqygsGht7PfFVIgtfCN/UdO8GXFhHotI3jsM+9EzXlE0wLGqCk1BbDE+gST9CD626yliikvSHAv9LTPgrONi/YIjAJ7HWAUFtjDuYceibjR/fRyyLOSd0XnvGcxEc377JDCPGdSsu4Wy11TFWw9C8nDKns+DFb0T6o/Jx 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: Make sure that all occurrences are spelled "DMA API" (all uppercase, no hyphen, no underscore). Signed-off-by: Petr Tesarik --- 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. -- 2.49.0