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

docs: fix references for DMA*.txt files

As we moved those files to core-api, fix references to point
to their newer locations.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/37b2fd159fbc7655dbf33b3eb1215396a25f6344.1592895969.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>

authored by

Mauro Carvalho Chehab and committed by
Jonathan Corbet
985098a0 bbea2aa3

+35 -35
+3 -3
Documentation/PCI/pci.rst
··· 265 265 --------------------- 266 266 .. note:: 267 267 If anything below doesn't make sense, please refer to 268 - Documentation/DMA-API.txt. This section is just a reminder that 268 + :doc:`/core-api/dma-api`. This section is just a reminder that 269 269 drivers need to indicate DMA capabilities of the device and is not 270 270 an authoritative source for DMA interfaces. 271 271 ··· 291 291 Setup shared control data 292 292 ------------------------- 293 293 Once the DMA masks are set, the driver can allocate "consistent" (a.k.a. shared) 294 - memory. See Documentation/DMA-API.txt for a full description of 294 + memory. See :doc:`/core-api/dma-api` for a full description of 295 295 the DMA APIs. This section is just a reminder that it needs to be done 296 296 before enabling DMA on the device. 297 297 ··· 421 421 422 422 Then clean up "consistent" buffers which contain the control data. 423 423 424 - See Documentation/DMA-API.txt for details on unmapping interfaces. 424 + See :doc:`/core-api/dma-api` for details on unmapping interfaces. 425 425 426 426 427 427 Unregister from other subsystems
+1 -1
Documentation/block/biodoc.rst
··· 196 196 do not have a corresponding kernel virtual address space mapping) and 197 197 low-memory pages. 198 198 199 - Note: Please refer to Documentation/DMA-API-HOWTO.txt for a discussion 199 + Note: Please refer to :doc:`/core-api/dma-api-howto` for a discussion 200 200 on PCI high mem DMA aspects and mapping of scatter gather lists, and support 201 201 for 64 bit PCI. 202 202
+1 -1
Documentation/bus-virt-phys-mapping.txt
··· 8 8 9 9 The virt_to_bus() and bus_to_virt() functions have been 10 10 superseded by the functionality provided by the PCI DMA interface 11 - (see Documentation/DMA-API-HOWTO.txt). They continue 11 + (see :doc:`/core-api/dma-api-howto`). They continue 12 12 to be documented below for historical purposes, but new code 13 13 must not use them. --davidm 00/12/12 14 14
+3 -3
Documentation/core-api/dma-api.rst
··· 5 5 :Author: James E.J. Bottomley <James.Bottomley@HansenPartnership.com> 6 6 7 7 This document describes the DMA API. For a more gentle introduction 8 - of the API (and actual examples), see Documentation/DMA-API-HOWTO.txt. 8 + of the API (and actual examples), see :doc:`/core-api/dma-api-howto`. 9 9 10 10 This API is split into two pieces. Part I describes the basic API. 11 11 Part II describes extensions for supporting non-consistent memory ··· 471 471 dma_attrs. 472 472 473 473 The interpretation of DMA attributes is architecture-specific, and 474 - each attribute should be documented in Documentation/DMA-attributes.txt. 474 + each attribute should be documented in :doc:`/core-api/dma-attributes`. 475 475 476 476 If dma_attrs are 0, the semantics of each of these functions 477 477 is identical to those of the corresponding function ··· 484 484 485 485 #include <linux/dma-mapping.h> 486 486 /* DMA_ATTR_FOO should be defined in linux/dma-mapping.h and 487 - * documented in Documentation/DMA-attributes.txt */ 487 + * documented in Documentation/core-api/dma-attributes.rst */ 488 488 ... 489 489 490 490 unsigned long attr;
+1 -1
Documentation/core-api/dma-isa-lpc.rst
··· 17 17 #include <asm/dma.h> 18 18 19 19 The first is the generic DMA API used to convert virtual addresses to 20 - bus addresses (see Documentation/DMA-API.txt for details). 20 + bus addresses (see :doc:`/core-api/dma-api` for details). 21 21 22 22 The second contains the routines specific to ISA DMA transfers. Since 23 23 this is not present on all platforms make sure you construct your
+3 -3
Documentation/driver-api/usb/dma.rst
··· 10 10 11 11 The big picture is that USB drivers can continue to ignore most DMA issues, 12 12 though they still must provide DMA-ready buffers (see 13 - ``Documentation/DMA-API-HOWTO.txt``). That's how they've worked through 13 + :doc:`/core-api/dma-api-howto`). That's how they've worked through 14 14 the 2.4 (and earlier) kernels, or they can now be DMA-aware. 15 15 16 16 DMA-aware usb drivers: ··· 60 60 force a consistent memory access ordering by using memory barriers. It's 61 61 not using a streaming DMA mapping, so it's good for small transfers on 62 62 systems where the I/O would otherwise thrash an IOMMU mapping. (See 63 - ``Documentation/DMA-API-HOWTO.txt`` for definitions of "coherent" and 63 + :doc:`/core-api/dma-api-howto` for definitions of "coherent" and 64 64 "streaming" DMA mappings.) 65 65 66 66 Asking for 1/Nth of a page (as well as asking for N pages) is reasonably ··· 91 91 Existing buffers aren't usable for DMA without first being mapped into the 92 92 DMA address space of the device. However, most buffers passed to your 93 93 driver can safely be used with such DMA mapping. (See the first section 94 - of Documentation/DMA-API-HOWTO.txt, titled "What memory is DMA-able?") 94 + of :doc:`/core-api/dma-api-howto`, titled "What memory is DMA-able?") 95 95 96 96 - When you're using scatterlists, you can map everything at once. On some 97 97 systems, this kicks in an IOMMU and turns the scatterlists into single
+3 -3
Documentation/translations/ko_KR/memory-barriers.txt
··· 570 570 [*] 버스 마스터링 DMA 와 일관성에 대해서는 다음을 참고하시기 바랍니다: 571 571 572 572 Documentation/driver-api/pci/pci.rst 573 - Documentation/DMA-API-HOWTO.txt 574 - Documentation/DMA-API.txt 573 + Documentation/core-api/dma-api-howto.rst 574 + Documentation/core-api/dma-api.rst 575 575 576 576 577 577 데이터 의존성 배리어 (역사적) ··· 1907 1907 1908 1908 writel_relaxed() 와 같은 완화된 I/O 접근자들에 대한 자세한 내용을 위해서는 1909 1909 "커널 I/O 배리어의 효과" 섹션을, consistent memory 에 대한 자세한 내용을 1910 - 위해선 Documentation/DMA-API.txt 문서를 참고하세요. 1910 + 위해선 Documentation/core-api/dma-api.rst 문서를 참고하세요. 1911 1911 1912 1912 1913 1913 =========================
+6 -6
arch/ia64/hp/common/sba_iommu.c
··· 907 907 * @dir: dma direction 908 908 * @attrs: optional dma attributes 909 909 * 910 - * See Documentation/DMA-API-HOWTO.txt 910 + * See Documentation/core-api/dma-api-howto.rst 911 911 */ 912 912 static dma_addr_t sba_map_page(struct device *dev, struct page *page, 913 913 unsigned long poff, size_t size, ··· 1028 1028 * @dir: R/W or both. 1029 1029 * @attrs: optional dma attributes 1030 1030 * 1031 - * See Documentation/DMA-API-HOWTO.txt 1031 + * See Documentation/core-api/dma-api-howto.rst 1032 1032 */ 1033 1033 static void sba_unmap_page(struct device *dev, dma_addr_t iova, size_t size, 1034 1034 enum dma_data_direction dir, unsigned long attrs) ··· 1105 1105 * @size: number of bytes mapped in driver buffer. 1106 1106 * @dma_handle: IOVA of new buffer. 1107 1107 * 1108 - * See Documentation/DMA-API-HOWTO.txt 1108 + * See Documentation/core-api/dma-api-howto.rst 1109 1109 */ 1110 1110 static void * 1111 1111 sba_alloc_coherent(struct device *dev, size_t size, dma_addr_t *dma_handle, ··· 1162 1162 * @vaddr: virtual address IOVA of "consistent" buffer. 1163 1163 * @dma_handler: IO virtual address of "consistent" buffer. 1164 1164 * 1165 - * See Documentation/DMA-API-HOWTO.txt 1165 + * See Documentation/core-api/dma-api-howto.rst 1166 1166 */ 1167 1167 static void sba_free_coherent(struct device *dev, size_t size, void *vaddr, 1168 1168 dma_addr_t dma_handle, unsigned long attrs) ··· 1425 1425 * @dir: R/W or both. 1426 1426 * @attrs: optional dma attributes 1427 1427 * 1428 - * See Documentation/DMA-API-HOWTO.txt 1428 + * See Documentation/core-api/dma-api-howto.rst 1429 1429 */ 1430 1430 static int sba_map_sg_attrs(struct device *dev, struct scatterlist *sglist, 1431 1431 int nents, enum dma_data_direction dir, ··· 1524 1524 * @dir: R/W or both. 1525 1525 * @attrs: optional dma attributes 1526 1526 * 1527 - * See Documentation/DMA-API-HOWTO.txt 1527 + * See Documentation/core-api/dma-api-howto.rst 1528 1528 */ 1529 1529 static void sba_unmap_sg_attrs(struct device *dev, struct scatterlist *sglist, 1530 1530 int nents, enum dma_data_direction dir,
+1 -1
arch/parisc/kernel/pci-dma.c
··· 3 3 ** PARISC 1.1 Dynamic DMA mapping support. 4 4 ** This implementation is for PA-RISC platforms that do not support 5 5 ** I/O TLBs (aka DMA address translation hardware). 6 - ** See Documentation/DMA-API-HOWTO.txt for interface definitions. 6 + ** See Documentation/core-api/dma-api-howto.rst for interface definitions. 7 7 ** 8 8 ** (c) Copyright 1999,2000 Hewlett-Packard Company 9 9 ** (c) Copyright 2000 Grant Grundler
+2 -2
arch/x86/include/asm/dma-mapping.h
··· 3 3 #define _ASM_X86_DMA_MAPPING_H 4 4 5 5 /* 6 - * IOMMU interface. See Documentation/DMA-API-HOWTO.txt and 7 - * Documentation/DMA-API.txt for documentation. 6 + * IOMMU interface. See Documentation/core-api/dma-api-howto.rst and 7 + * Documentation/core-api/dma-api.rst for documentation. 8 8 */ 9 9 10 10 #include <linux/scatterlist.h>
+1 -1
arch/x86/kernel/amd_gart_64.c
··· 6 6 * This allows to use PCI devices that only support 32bit addresses on systems 7 7 * with more than 4GB. 8 8 * 9 - * See Documentation/DMA-API-HOWTO.txt for the interface specification. 9 + * See Documentation/core-api/dma-api-howto.rst for the interface specification. 10 10 * 11 11 * Copyright 2002 Andi Kleen, SuSE Labs. 12 12 */
+7 -7
drivers/parisc/sba_iommu.c
··· 666 666 * @dev: instance of PCI owned by the driver that's asking 667 667 * @mask: number of address bits this PCI device can handle 668 668 * 669 - * See Documentation/DMA-API-HOWTO.txt 669 + * See Documentation/core-api/dma-api-howto.rst 670 670 */ 671 671 static int sba_dma_supported( struct device *dev, u64 mask) 672 672 { ··· 698 698 * @size: number of bytes to map in driver buffer. 699 699 * @direction: R/W or both. 700 700 * 701 - * See Documentation/DMA-API-HOWTO.txt 701 + * See Documentation/core-api/dma-api-howto.rst 702 702 */ 703 703 static dma_addr_t 704 704 sba_map_single(struct device *dev, void *addr, size_t size, ··· 788 788 * @size: number of bytes mapped in driver buffer. 789 789 * @direction: R/W or both. 790 790 * 791 - * See Documentation/DMA-API-HOWTO.txt 791 + * See Documentation/core-api/dma-api-howto.rst 792 792 */ 793 793 static void 794 794 sba_unmap_page(struct device *dev, dma_addr_t iova, size_t size, ··· 867 867 * @size: number of bytes mapped in driver buffer. 868 868 * @dma_handle: IOVA of new buffer. 869 869 * 870 - * See Documentation/DMA-API-HOWTO.txt 870 + * See Documentation/core-api/dma-api-howto.rst 871 871 */ 872 872 static void *sba_alloc(struct device *hwdev, size_t size, dma_addr_t *dma_handle, 873 873 gfp_t gfp, unsigned long attrs) ··· 898 898 * @vaddr: virtual address IOVA of "consistent" buffer. 899 899 * @dma_handler: IO virtual address of "consistent" buffer. 900 900 * 901 - * See Documentation/DMA-API-HOWTO.txt 901 + * See Documentation/core-api/dma-api-howto.rst 902 902 */ 903 903 static void 904 904 sba_free(struct device *hwdev, size_t size, void *vaddr, ··· 933 933 * @nents: number of entries in list 934 934 * @direction: R/W or both. 935 935 * 936 - * See Documentation/DMA-API-HOWTO.txt 936 + * See Documentation/core-api/dma-api-howto.rst 937 937 */ 938 938 static int 939 939 sba_map_sg(struct device *dev, struct scatterlist *sglist, int nents, ··· 1017 1017 * @nents: number of entries in list 1018 1018 * @direction: R/W or both. 1019 1019 * 1020 - * See Documentation/DMA-API-HOWTO.txt 1020 + * See Documentation/core-api/dma-api-howto.rst 1021 1021 */ 1022 1022 static void 1023 1023 sba_unmap_sg(struct device *dev, struct scatterlist *sglist, int nents,
+1 -1
include/linux/dma-mapping.h
··· 14 14 15 15 /** 16 16 * List of possible attributes associated with a DMA mapping. The semantics 17 - * of each attribute should be defined in Documentation/DMA-attributes.txt. 17 + * of each attribute should be defined in Documentation/core-api/dma-attributes.rst. 18 18 */ 19 19 20 20 /*
+1 -1
include/media/videobuf-dma-sg.h
··· 31 31 * does memory allocation too using vmalloc_32(). 32 32 * 33 33 * videobuf_dma_*() 34 - * see Documentation/DMA-API-HOWTO.txt, these functions to 34 + * see Documentation/core-api/dma-api-howto.rst, these functions to 35 35 * basically the same. The map function does also build a 36 36 * scatterlist for the buffer (and unmap frees it ...) 37 37 *
+1 -1
kernel/dma/debug.c
··· 1071 1071 /* 1072 1072 * Drivers should use dma_mapping_error() to check the returned 1073 1073 * addresses of dma_map_single() and dma_map_page(). 1074 - * If not, print this warning message. See Documentation/DMA-API.txt. 1074 + * If not, print this warning message. See Documentation/core-api/dma-api.rst. 1075 1075 */ 1076 1076 if (entry->map_err_type == MAP_ERR_NOT_CHECKED) { 1077 1077 err_printk(ref->dev, entry,