From nobody Wed Oct 8 15:10:56 2025 Received: from mail-wr1-f46.google.com (mail-wr1-f46.google.com [209.85.221.46]) (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 7A0E3298CA2 for ; Fri, 27 Jun 2025 10:10:22 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.221.46 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1751019024; cv=none; b=JXZU3CtncK6wwXyL6eXiXruYAHZBRDvoD2YOUxw51zfSlQieaXJClKRx9g5/bfCb8BZOAjP53WzfqpvchyGOHCWS5wA5ISc+oG5OIR8wP4svNpiWVubRPhn0GBb9nObUf2nZdiBSn/YipQfFdFg593aorNU253JA0tUS4FhpldQ= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1751019024; c=relaxed/simple; bh=BUrtkuU0GNtLGvxwO3DTlvmmCqCxudl5NEHe+to6l5g=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=O3AWxH31+Gd/36K/I9aGpKeO1yqPzKapmAhf9NQ0mFhWt+GucrkjqyDe/OU+JAuPAqZgP97Mw7xC9hKMYXUa85oxyAqsF9FuWs33dCATkUH1OAFI0ydBKJWRAIdPZEj8LSpAmgrr5lrKOMVLC+TdG+VVDbElESYslIAryyW852w= 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=bmbuBhIu; arc=none smtp.client-ip=209.85.221.46 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="bmbuBhIu" Received: by mail-wr1-f46.google.com with SMTP id ffacd0b85a97d-3a4e749d7b2so318509f8f.0 for ; Fri, 27 Jun 2025 03:10:22 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=suse.com; s=google; t=1751019021; x=1751623821; 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=w3xq9CnnryfUDxSUQF9GpV8PIE+GCE84sbP2gNrPwwc=; b=bmbuBhIu5GeV3m0+BYeroVFz+fQcxry1duItb2Wa5M+jWEwpi7eY5xCtQBE7kbIyjg SNvKJCcm4qFhPmfD1qTMPBZ4QjGat72dc9EKC5HcKLoPq5+JBvXKXlRl8FjqlEnrIirB UO6H3+jhyJp2Fh8twjXbQFOEmQ5tR9yIYYRvPhOffoWEwihLEU+YxfbFJ3XjncqqTdbU XVLwnkC3huHKwRQxSRUYzl/M7LIlxrF02nUL79tzn1HXw3tSI4xf2m9npsGGh/WkcvO4 OhKJvTdcMSQwmCpdhb94QrT3E9kosaMZ2stMkdqpZAcd7s4FQelvhybOiFoLqQBGWZa4 m36w== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1751019021; x=1751623821; 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=w3xq9CnnryfUDxSUQF9GpV8PIE+GCE84sbP2gNrPwwc=; b=WTe3O/EZYfpeUZxysm153rCUGXTxbu0Ko99TSnG+hSdyenv6r1pGxginoxmI6r8zvl CDTWoK1+2VGfyKkFfejT/m4zd56lCImDuvoKhY7TDo5RSRRjmpO9VVkChU0kquQVMyWU uvBVYDpAHr3luBkwQSbZAnm4jr5m4cmPABTaNVX/BV47zbtJud/K3UULI9dJk5fJdyox hp+j6hFVWgEUbs7H0/OoWhmwyjZdHQlaj4JpSX/N9undi6Qmgou0KIF2ErLGX9CxbRCP e4TnxvBrdXAjFfnTPSEy5jWPGF165OzoVI2hEdczIQePXjM3KCEH2IjSKPxMs5m0SKg1 7Zbw== X-Forwarded-Encrypted: i=1; AJvYcCVhysN1W4u9HyimYF0CE/eDir+rT5gTP72uK72edQqcVubV5GVPwjdAMPyyjYTL0doJTnN9zGYme2Abn3c=@vger.kernel.org X-Gm-Message-State: AOJu0YwRBAvnGHmaWdmEpcv+xkPToltcXQRvTMqoLt+d9eDmKcj0E6OR nEj/n42fGGoEfjy4/isikvP43x+NxKHhhsMNqDzpMQ7eox3i3uluP0dKmkBx3M88clU= X-Gm-Gg: ASbGncuPqTnl/71O7QGU5m2Wekb/OKA9XPNdi/aHrZP19wmuCX1YnBJR4bm7lWiaZvw kS0Y6w80TbnxABsDIaaqoZibJe5kIAflWTz3qzNkoSevx7XNm+pu6Qa/WPNfq+e9eBvLwRVihrz A6u/RVrsIw2spi3acoXbKzJAeSNmwudmSkqI8bjWISY4QiW2iCkMH8eO1Xad75R6TvB2avT8MVn T33b1yjefRRAGcCCEUuqWprSgqFWfAaCotmoWBOBiZuiHkXcYIpGNYZ/5Lgy6sQamT//DILrUBZ HEI4nu5BPJQzsAlEMzOBdg5ENnjqT3HpIieaTw7Dj2ayug7vxh32jIwItNP0+QooOOemFeIDPkC aPzc04KCrifs0GoL94Q94U3seIurIDNYdC1g00GKY7JXyLUOPA3/Y X-Google-Smtp-Source: AGHT+IFl9NeQHOTdy/+Ly2ukX55GHMuwNJpmvj1Ce+Om/UQDamucwxW4fiFQPB/A8qZbOum6aIcqTw== X-Received: by 2002:a5d:5f53:0:b0:3a3:584b:f5d7 with SMTP id ffacd0b85a97d-3a90c551c42mr942241f8f.5.1751019020637; Fri, 27 Jun 2025 03:10:20 -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-3a892e52ca4sm2286180f8f.58.2025.06.27.03.10.20 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 27 Jun 2025 03:10:20 -0700 (PDT) From: Petr Tesarik To: Jonathan Corbet , Randy Dunlap , Robin Murphy , Marek Szyprowski Cc: Andrew Morton , Keith Busch , Jens Axboe , Bagas Sanjaya , 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 v2 1/8] docs: dma-api: use "DMA API" consistently throughout the document Date: Fri, 27 Jun 2025 12:10:08 +0200 Message-ID: <20250627101015.1600042-2-ptesarik@suse.com> X-Mailer: git-send-email 2.49.0 In-Reply-To: <20250627101015.1600042-1-ptesarik@suse.com> References: <20250627101015.1600042-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 Tested-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 2ad08517e626e..97f42c15f5e43 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