Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

docs: dma-api: use "DMA API" consistently throughout the document

Make sure that all occurrences are spelled "DMA API" (all uppercase, no
hyphen, no underscore).

Signed-off-by: Petr Tesarik <ptesarik@suse.com>
Reviewed-by: Randy Dunlap <rdunlap@infradead.org>
Tested-by: Randy Dunlap <rdunlap@infradead.org>
Acked-by: Marek Szyprowski <m.szyprowski@samsung.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/20250627101015.1600042-2-ptesarik@suse.com

authored by

Petr Tesarik and committed by
Jonathan Corbet
7362b6ba 739ca710

+11 -11
+11 -11
Documentation/core-api/dma-api.rst
··· 13 13 non-consistent platforms (this is usually only legacy platforms) you 14 14 should only use the API described in part I. 15 15 16 - Part I - dma_API 16 + Part I - DMA API 17 17 ---------------- 18 18 19 - To get the dma_API, you must #include <linux/dma-mapping.h>. This 19 + To get the DMA API, you must #include <linux/dma-mapping.h>. This 20 20 provides dma_addr_t and the interfaces described below. 21 21 22 22 A dma_addr_t can hold any valid DMA address for the platform. It can be ··· 76 76 Part Ib - Using small DMA-coherent buffers 77 77 ------------------------------------------ 78 78 79 - To get this part of the dma_API, you must #include <linux/dmapool.h> 79 + To get this part of the DMA API, you must #include <linux/dmapool.h> 80 80 81 81 Many drivers need lots of small DMA-coherent memory regions for DMA 82 82 descriptors or I/O buffers. Rather than allocating in units of a page ··· 247 247 device and returns the DMA address of the memory. 248 248 249 249 The direction for both APIs may be converted freely by casting. 250 - However the dma_API uses a strongly typed enumerator for its 250 + However the DMA API uses a strongly typed enumerator for its 251 251 direction: 252 252 253 253 ======================= ============================================= ··· 775 775 of two for easy alignment. 776 776 777 777 778 - Part III - Debug drivers use of the DMA-API 778 + Part III - Debug drivers use of the DMA API 779 779 ------------------------------------------- 780 780 781 - The DMA-API as described above has some constraints. DMA addresses must be 781 + The DMA API as described above has some constraints. DMA addresses must be 782 782 released with the corresponding function with the same size for example. With 783 783 the advent of hardware IOMMUs it becomes more and more important that drivers 784 784 do not violate those constraints. In the worst case such a violation can 785 785 result in data corruption up to destroyed filesystems. 786 786 787 - To debug drivers and find bugs in the usage of the DMA-API checking code can 787 + To debug drivers and find bugs in the usage of the DMA API checking code can 788 788 be compiled into the kernel which will tell the developer about those 789 789 violations. If your architecture supports it you can select the "Enable 790 - debugging of DMA-API usage" option in your kernel configuration. Enabling this 790 + debugging of DMA API usage" option in your kernel configuration. Enabling this 791 791 option has a performance impact. Do not enable it in production kernels. 792 792 793 793 If you boot the resulting kernel will contain code which does some bookkeeping ··· 826 826 <EOI> <4>---[ end trace f6435a98e2a38c0e ]--- 827 827 828 828 The driver developer can find the driver and the device including a stacktrace 829 - of the DMA-API call which caused this warning. 829 + of the DMA API call which caused this warning. 830 830 831 831 Per default only the first error will result in a warning message. All other 832 832 errors will only silently counted. This limitation exist to prevent the code ··· 834 834 be disabled via debugfs. See the debugfs interface documentation below for 835 835 details. 836 836 837 - The debugfs directory for the DMA-API debugging code is called dma-api/. In 837 + The debugfs directory for the DMA API debugging code is called dma-api/. In 838 838 this directory the following files can currently be found: 839 839 840 840 =============================== =============================================== ··· 882 882 883 883 If you have this code compiled into your kernel it will be enabled by default. 884 884 If you want to boot without the bookkeeping anyway you can provide 885 - 'dma_debug=off' as a boot parameter. This will disable DMA-API debugging. 885 + 'dma_debug=off' as a boot parameter. This will disable DMA API debugging. 886 886 Notice that you can not enable it again at runtime. You have to reboot to do 887 887 so. 888 888