[PATCH 00/14] Move the ReST files from Documentation/*.txt

[PATCH 00/14] Move the ReST files from Documentation/*.txt

[Mauro Carvalho Chehab]

The main goal of this series is to cleanup the Documentation/
directory.

Most of the files under Documentation/*.txt are already in ReST format.
They just need to be moved to some place. So, most of the work here is
to just move files for them to generate an output using the docs building
system.

After this change, the  Documentation/ dir will contain:

- the main ReST file:
	- index.rst

- TUX and its copyright:
	- logo.gif and COPYING-logo

- Files required to do ReST builds:
	- .gitignore, Makefile,  conf.py,  docutils.conf,  Kconfig

- A pre-git file used to generate patches:
	- dontdiff
  (I guess we should get rid of it, as I doubt this is useful those days).

-

Besides the above rightful files, the Documentation/ dir will also
contain some left-overs:

- two somewhat new ReST files that should be moved to somewhere:
	- asm-annotations.rst and watch_queue.rst

- Two files that helps people looking for some well known documents
  that are referenced at the web, pointing to their new location inside
  the process/ dir:
	- SubmittingPatches and CodingStyle

- Three .txt files that weren't converted to ReST:
	- atomic_bitops.txt, memory-barriers.txt, atomic_t.txt

It should be noticed that I'm in doubt about the location of some files,
and some stuff may well belong to a trash can. So, this series create
a temporary place for orphaned documents in the form of a
Documentation/staging directory.

This series is also on my development git tree, at:

	https://git.linuxtv.org/mchehab/experimental.git/log/?h=rename-main-docs

The built output documentation on html format is at:

	https://www.infradead.org/~mchehab/kernel_docs/

(it contains also other documents I converted to ReST)


Mauro Carvalho Chehab (14):
  docs: move DMA kAPI to Documentation/core-api
  docs: add bus-virt-phys-mapping.txt to core-api
  docs: fix references for DMA*.txt files
  docs: move IPMI.txt to the driver API book
  docs: fix references for ipmi.rst file
  docs: debugging-via-ohci1394.txt: add it to the core-api book
  docs: add IRQ documentation at the core-api book
  docs: move kobject and kref docs into the core-api book
  docs: move digsig docs to the security book
  docs: move locking-specific documenta to locking/ directory
  docs: move other kAPI documents to core-api
  docs: move remaining stuff under Documentation/*.txt to
    Documentation/staging
  docs: staging: don't use literalinclude
  docs: staging: use small font for literal includes

 Documentation/PCI/pci.rst                     |  6 +-
 Documentation/admin-guide/hw-vuln/l1tf.rst    |  2 +-
 .../admin-guide/kernel-parameters.txt         |  2 +-
 .../admin-guide/kernel-per-CPU-kthreads.rst   |  2 +-
 Documentation/admin-guide/sysctl/vm.rst       |  2 +-
 Documentation/block/biodoc.rst                |  2 +-
 .../bus-virt-phys-mapping.rst}                |  2 +-
 .../debugging-via-ohci1394.rst}               |  0
 .../dma-api-howto.rst}                        |  0
 .../{DMA-API.txt => core-api/dma-api.rst}     |  6 +-
 .../dma-attributes.rst}                       |  0
 .../dma-isa-lpc.rst}                          |  2 +-
 Documentation/core-api/index.rst              | 14 +++++
 .../{IRQ.txt => core-api/irq/concepts.rst}    |  0
 Documentation/core-api/irq/index.rst          | 11 ++++
 .../irq/irq-affinity.rst}                     |  0
 .../irq/irq-domain.rst}                       |  3 +-
 .../irq/irqflags-tracing.rst}                 |  0
 Documentation/core-api/kobject.rst            |  2 +-
 Documentation/{kref.txt => core-api/kref.rst} |  0
 .../{mailbox.txt => core-api/mailbox.rst}     |  0
 .../nommu-mmap.rst}                           |  0
 .../this_cpu_ops.rst}                         |  0
 .../unaligned-memory-access.rst}              |  0
 Documentation/driver-api/index.rst            |  1 +
 .../{IPMI.txt => driver-api/ipmi.rst}         |  0
 Documentation/driver-api/usb/dma.rst          |  6 +-
 Documentation/gpu/drm-mm.rst                  |  2 +-
 Documentation/ia64/irq-redir.rst              |  2 +-
 Documentation/index.rst                       | 13 ++++
 .../futex-requeue-pi.rst}                     |  0
 .../hwspinlock.rst}                           |  0
 Documentation/locking/index.rst               |  7 +++
 .../percpu-rw-semaphore.rst}                  |  0
 .../{pi-futex.txt => locking/pi-futex.rst}    |  0
 .../preempt-locking.rst}                      |  0
 .../robust-futex-ABI.rst}                     |  0
 .../robust-futexes.rst}                       |  0
 Documentation/locking/rt-mutex.rst            |  2 +-
 Documentation/memory-barriers.txt             |  6 +-
 Documentation/networking/scaling.rst          |  4 +-
 .../{digsig.txt => security/digsig.rst}       |  0
 Documentation/security/index.rst              |  1 +
 .../{crc32.txt => staging/crc32.rst}          |  0
 Documentation/staging/index.rst               | 59 +++++++++++++++++++
 .../{kprobes.txt => staging/kprobes.rst}      |  0
 Documentation/{lzo.txt => staging/lzo.rst}    |  0
 .../remoteproc.rst}                           |  2 +-
 .../{rpmsg.txt => staging/rpmsg.rst}          |  0
 .../speculation.rst}                          |  8 ++-
 .../static-keys.rst}                          |  0
 Documentation/{tee.txt => staging/tee.rst}    |  1 +
 Documentation/{xz.txt => staging/xz.rst}      |  0
 Documentation/trace/kprobetrace.rst           |  2 +-
 .../translations/ko_KR/memory-barriers.txt    |  6 +-
 Documentation/translations/zh_CN/IRQ.txt      |  4 +-
 MAINTAINERS                                   | 20 +++----
 arch/Kconfig                                  |  2 +-
 arch/ia64/hp/common/sba_iommu.c               | 12 ++--
 arch/parisc/kernel/pci-dma.c                  |  2 +-
 arch/x86/include/asm/dma-mapping.h            |  4 +-
 arch/x86/kernel/amd_gart_64.c                 |  2 +-
 drivers/char/ipmi/Kconfig                     |  2 +-
 drivers/char/ipmi/ipmi_si_hotmod.c            |  2 +-
 drivers/char/ipmi/ipmi_si_intf.c              |  2 +-
 drivers/parisc/sba_iommu.c                    | 14 ++---
 include/asm-generic/bitops/atomic.h           |  2 +-
 include/linux/dma-mapping.h                   |  2 +-
 include/linux/jump_label.h                    |  2 +-
 include/media/videobuf-dma-sg.h               |  2 +-
 init/Kconfig                                  |  2 +-
 kernel/dma/debug.c                            |  2 +-
 lib/Kconfig.debug                             |  2 +-
 lib/crc32.c                                   |  2 +-
 lib/lzo/lzo1x_decompress_safe.c               |  2 +-
 lib/xz/Kconfig                                |  2 +-
 mm/Kconfig                                    |  2 +-
 mm/nommu.c                                    |  2 +-
 samples/kprobes/kprobe_example.c              |  2 +-
 samples/kprobes/kretprobe_example.c           |  2 +-
 80 files changed, 191 insertions(+), 81 deletions(-)
 rename Documentation/{bus-virt-phys-mapping.txt => core-api/bus-virt-phys-mapping.rst} (99%)
 rename Documentation/{debugging-via-ohci1394.txt => core-api/debugging-via-ohci1394.rst} (100%)
 rename Documentation/{DMA-API-HOWTO.txt => core-api/dma-api-howto.rst} (100%)
 rename Documentation/{DMA-API.txt => core-api/dma-api.rst} (99%)
 rename Documentation/{DMA-attributes.txt => core-api/dma-attributes.rst} (100%)
 rename Documentation/{DMA-ISA-LPC.txt => core-api/dma-isa-lpc.rst} (98%)
 rename Documentation/{IRQ.txt => core-api/irq/concepts.rst} (100%)
 create mode 100644 Documentation/core-api/irq/index.rst
 rename Documentation/{IRQ-affinity.txt => core-api/irq/irq-affinity.rst} (100%)
 rename Documentation/{IRQ-domain.txt => core-api/irq/irq-domain.rst} (99%)
 rename Documentation/{irqflags-tracing.txt => core-api/irq/irqflags-tracing.rst} (100%)
 rename Documentation/{kref.txt => core-api/kref.rst} (100%)
 rename Documentation/{mailbox.txt => core-api/mailbox.rst} (100%)
 rename Documentation/{nommu-mmap.txt => core-api/nommu-mmap.rst} (100%)
 rename Documentation/{this_cpu_ops.txt => core-api/this_cpu_ops.rst} (100%)
 rename Documentation/{unaligned-memory-access.txt => core-api/unaligned-memory-access.rst} (100%)
 rename Documentation/{IPMI.txt => driver-api/ipmi.rst} (100%)
 rename Documentation/{futex-requeue-pi.txt => locking/futex-requeue-pi.rst} (100%)
 rename Documentation/{hwspinlock.txt => locking/hwspinlock.rst} (100%)
 rename Documentation/{percpu-rw-semaphore.txt => locking/percpu-rw-semaphore.rst} (100%)
 rename Documentation/{pi-futex.txt => locking/pi-futex.rst} (100%)
 rename Documentation/{preempt-locking.txt => locking/preempt-locking.rst} (100%)
 rename Documentation/{robust-futex-ABI.txt => locking/robust-futex-ABI.rst} (100%)
 rename Documentation/{robust-futexes.txt => locking/robust-futexes.rst} (100%)
 rename Documentation/{digsig.txt => security/digsig.rst} (100%)
 rename Documentation/{crc32.txt => staging/crc32.rst} (100%)
 create mode 100644 Documentation/staging/index.rst
 rename Documentation/{kprobes.txt => staging/kprobes.rst} (100%)
 rename Documentation/{lzo.txt => staging/lzo.rst} (100%)
 rename Documentation/{remoteproc.txt => staging/remoteproc.rst} (99%)
 rename Documentation/{rpmsg.txt => staging/rpmsg.rst} (100%)
 rename Documentation/{speculation.txt => staging/speculation.rst} (97%)
 rename Documentation/{static-keys.txt => staging/static-keys.rst} (100%)
 rename Documentation/{tee.txt => staging/tee.rst} (99%)
 rename Documentation/{xz.txt => staging/xz.rst} (100%)

-- 
2.25.4


_______________________________________________
iommu mailing list
iommu@lists.linux-foundation.org
https://lists.linuxfoundation.org/mailman/listinfo/iommu

[PATCH 03/14] docs: fix references for DMA*.txt files

[Mauro Carvalho Chehab]

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>
---
 Documentation/PCI/pci.rst                          |  6 +++---
 Documentation/block/biodoc.rst                     |  2 +-
 Documentation/core-api/bus-virt-phys-mapping.rst   |  2 +-
 Documentation/core-api/dma-api.rst                 |  6 +++---
 Documentation/core-api/dma-isa-lpc.rst             |  2 +-
 Documentation/driver-api/usb/dma.rst               |  6 +++---
 Documentation/memory-barriers.txt                  |  6 +++---
 .../translations/ko_KR/memory-barriers.txt         |  6 +++---
 arch/ia64/hp/common/sba_iommu.c                    | 12 ++++++------
 arch/parisc/kernel/pci-dma.c                       |  2 +-
 arch/x86/include/asm/dma-mapping.h                 |  4 ++--
 arch/x86/kernel/amd_gart_64.c                      |  2 +-
 drivers/parisc/sba_iommu.c                         | 14 +++++++-------
 include/linux/dma-mapping.h                        |  2 +-
 include/media/videobuf-dma-sg.h                    |  2 +-
 kernel/dma/debug.c                                 |  2 +-
 16 files changed, 38 insertions(+), 38 deletions(-)

diff --git a/Documentation/PCI/pci.rst b/Documentation/PCI/pci.rst
index 8c016d8c9862..d10d3fe604c5 100644
--- a/Documentation/PCI/pci.rst
+++ b/Documentation/PCI/pci.rst
@@ -265,7 +265,7 @@ Set the DMA mask size
 ---------------------
 .. note::
    If anything below doesn't make sense, please refer to
-   Documentation/DMA-API.txt. This section is just a reminder that
+   :doc:`/core-api/dma-api`. This section is just a reminder that
    drivers need to indicate DMA capabilities of the device and is not
    an authoritative source for DMA interfaces.
 
@@ -291,7 +291,7 @@ Many 64-bit "PCI" devices (before PCI-X) and some PCI-X devices are
 Setup shared control data
 -------------------------
 Once the DMA masks are set, the driver can allocate "consistent" (a.k.a. shared)
-memory.  See Documentation/DMA-API.txt for a full description of
+memory.  See :doc:`/core-api/dma-api` for a full description of
 the DMA APIs. This section is just a reminder that it needs to be done
 before enabling DMA on the device.
 
@@ -421,7 +421,7 @@ owners if there is one.
 
 Then clean up "consistent" buffers which contain the control data.
 
-See Documentation/DMA-API.txt for details on unmapping interfaces.
+See :doc:`/core-api/dma-api` for details on unmapping interfaces.
 
 
 Unregister from other subsystems
diff --git a/Documentation/block/biodoc.rst b/Documentation/block/biodoc.rst
index b964796ec9c7..ba7f45d0271c 100644
--- a/Documentation/block/biodoc.rst
+++ b/Documentation/block/biodoc.rst
@@ -196,7 +196,7 @@ a virtual address mapping (unlike the earlier scheme of virtual address
 do not have a corresponding kernel virtual address space mapping) and
 low-memory pages.
 
-Note: Please refer to Documentation/DMA-API-HOWTO.txt for a discussion
+Note: Please refer to :doc:`/core-api/dma-api-howto` for a discussion
 on PCI high mem DMA aspects and mapping of scatter gather lists, and support
 for 64 bit PCI.
 
diff --git a/Documentation/core-api/bus-virt-phys-mapping.rst b/Documentation/core-api/bus-virt-phys-mapping.rst
index 4bb07c2f3e7d..c7bc99cd2e21 100644
--- a/Documentation/core-api/bus-virt-phys-mapping.rst
+++ b/Documentation/core-api/bus-virt-phys-mapping.rst
@@ -8,7 +8,7 @@ How to access I/O mapped memory from within device drivers
 
 	The virt_to_bus() and bus_to_virt() functions have been
 	superseded by the functionality provided by the PCI DMA interface
-	(see Documentation/DMA-API-HOWTO.txt).  They continue
+	(see :doc:`/core-api/dma-api-howto`).  They continue
 	to be documented below for historical purposes, but new code
 	must not use them. --davidm 00/12/12
 
diff --git a/Documentation/core-api/dma-api.rst b/Documentation/core-api/dma-api.rst
index 2d8d2fed7317..63b4a2f20867 100644
--- a/Documentation/core-api/dma-api.rst
+++ b/Documentation/core-api/dma-api.rst
@@ -5,7 +5,7 @@ Dynamic DMA mapping using the generic device
 :Author: James E.J. Bottomley <James.Bottomley@HansenPartnership.com>
 
 This document describes the DMA API.  For a more gentle introduction
-of the API (and actual examples), see Documentation/DMA-API-HOWTO.txt.
+of the API (and actual examples), see :doc:`/core-api/dma-api-howto`.
 
 This API is split into two pieces.  Part I describes the basic API.
 Part II describes extensions for supporting non-consistent memory
@@ -471,7 +471,7 @@ without the _attrs suffixes, except that they pass an optional
 dma_attrs.
 
 The interpretation of DMA attributes is architecture-specific, and
-each attribute should be documented in Documentation/DMA-attributes.txt.
+each attribute should be documented in :doc:`/core-api/dma-attributes`.
 
 If dma_attrs are 0, the semantics of each of these functions
 is identical to those of the corresponding function
@@ -484,7 +484,7 @@ for DMA::
 
 	#include <linux/dma-mapping.h>
 	/* DMA_ATTR_FOO should be defined in linux/dma-mapping.h and
-	* documented in Documentation/DMA-attributes.txt */
+	* documented in Documentation/core-api/dma-attributes.rst */
 	...
 
 		unsigned long attr;
diff --git a/Documentation/core-api/dma-isa-lpc.rst b/Documentation/core-api/dma-isa-lpc.rst
index b1ec7b16c21f..e59a3d35a93d 100644
--- a/Documentation/core-api/dma-isa-lpc.rst
+++ b/Documentation/core-api/dma-isa-lpc.rst
@@ -17,7 +17,7 @@ To do ISA style DMA you need to include two headers::
 	#include <asm/dma.h>
 
 The first is the generic DMA API used to convert virtual addresses to
-bus addresses (see Documentation/DMA-API.txt for details).
+bus addresses (see :doc:`/core-api/dma-api` for details).
 
 The second contains the routines specific to ISA DMA transfers. Since
 this is not present on all platforms make sure you construct your
diff --git a/Documentation/driver-api/usb/dma.rst b/Documentation/driver-api/usb/dma.rst
index 59d5aee89e37..2b3dbd3265b4 100644
--- a/Documentation/driver-api/usb/dma.rst
+++ b/Documentation/driver-api/usb/dma.rst
@@ -10,7 +10,7 @@ API overview
 
 The big picture is that USB drivers can continue to ignore most DMA issues,
 though they still must provide DMA-ready buffers (see
-``Documentation/DMA-API-HOWTO.txt``).  That's how they've worked through
+:doc:`/core-api/dma-api-howto`).  That's how they've worked through
 the 2.4 (and earlier) kernels, or they can now be DMA-aware.
 
 DMA-aware usb drivers:
@@ -60,7 +60,7 @@ and effects like cache-trashing can impose subtle penalties.
   force a consistent memory access ordering by using memory barriers.  It's
   not using a streaming DMA mapping, so it's good for small transfers on
   systems where the I/O would otherwise thrash an IOMMU mapping.  (See
-  ``Documentation/DMA-API-HOWTO.txt`` for definitions of "coherent" and
+  :doc:`/core-api/dma-api-howto` for definitions of "coherent" and
   "streaming" DMA mappings.)
 
   Asking for 1/Nth of a page (as well as asking for N pages) is reasonably
@@ -91,7 +91,7 @@ Working with existing buffers
 Existing buffers aren't usable for DMA without first being mapped into the
 DMA address space of the device.  However, most buffers passed to your
 driver can safely be used with such DMA mapping.  (See the first section
-of Documentation/DMA-API-HOWTO.txt, titled "What memory is DMA-able?")
+of :doc:`/core-api/dma-api-howto`, titled "What memory is DMA-able?")
 
 - When you're using scatterlists, you can map everything at once.  On some
   systems, this kicks in an IOMMU and turns the scatterlists into single
diff --git a/Documentation/memory-barriers.txt b/Documentation/memory-barriers.txt
index eaabc3134294..0e4947a8282d 100644
--- a/Documentation/memory-barriers.txt
+++ b/Documentation/memory-barriers.txt
@@ -546,8 +546,8 @@ There are certain things that the Linux kernel memory barriers do not guarantee:
 	[*] For information on bus mastering DMA and coherency please read:
 
 	    Documentation/driver-api/pci/pci.rst
-	    Documentation/DMA-API-HOWTO.txt
-	    Documentation/DMA-API.txt
+	    Documentation/core-api/dma-api-howto.rst
+	    Documentation/core-api/dma-api.rst
 
 
 DATA DEPENDENCY BARRIERS (HISTORICAL)
@@ -1932,7 +1932,7 @@ There are some more advanced barrier functions:
      here.
 
      See the subsection "Kernel I/O barrier effects" for more information on
-     relaxed I/O accessors and the Documentation/DMA-API.txt file for more
+     relaxed I/O accessors and the Documentation/core-api/dma-api.rst file for more
      information on consistent memory.
 
 
diff --git a/Documentation/translations/ko_KR/memory-barriers.txt b/Documentation/translations/ko_KR/memory-barriers.txt
index e50fe6541335..037e82ade93c 100644
--- a/Documentation/translations/ko_KR/memory-barriers.txt
+++ b/Documentation/translations/ko_KR/memory-barriers.txt
@@ -570,8 +570,8 @@ ACQUIRE 는 해당 오퍼레이션의 로드 부분에만 적용되고 RELEASE 
 	[*] 버스 마스터링 DMA 와 일관성에 대해서는 다음을 참고하시기 바랍니다:
 
 	    Documentation/driver-api/pci/pci.rst
-	    Documentation/DMA-API-HOWTO.txt
-	    Documentation/DMA-API.txt
+	    Documentation/core-api/dma-api-howto.rst
+	    Documentation/core-api/dma-api.rst
 
 
 데이터 의존성 배리어 (역사적)
@@ -1904,7 +1904,7 @@ Mandatory 배리어들은 SMP 시스템에서도 UP 시스템에서도 SMP 효
 
      writel_relaxed() 와 같은 완화된 I/O 접근자들에 대한 자세한 내용을 위해서는
      "커널 I/O 배리어의 효과" 섹션을, consistent memory 에 대한 자세한 내용을
-     위해선 Documentation/DMA-API.txt 문서를 참고하세요.
+     위해선 Documentation/core-api/dma-api.rst 문서를 참고하세요.
 
 
 =========================
diff --git a/arch/ia64/hp/common/sba_iommu.c b/arch/ia64/hp/common/sba_iommu.c
index a806227c1fad..656a4888c300 100644
--- a/arch/ia64/hp/common/sba_iommu.c
+++ b/arch/ia64/hp/common/sba_iommu.c
@@ -907,7 +907,7 @@ sba_mark_invalid(struct ioc *ioc, dma_addr_t iova, size_t byte_cnt)
  * @dir: dma direction
  * @attrs: optional dma attributes
  *
- * See Documentation/DMA-API-HOWTO.txt
+ * See Documentation/core-api/dma-api-howto.rst
  */
 static dma_addr_t sba_map_page(struct device *dev, struct page *page,
 			       unsigned long poff, size_t size,
@@ -1028,7 +1028,7 @@ sba_mark_clean(struct ioc *ioc, dma_addr_t iova, size_t size)
  * @dir:  R/W or both.
  * @attrs: optional dma attributes
  *
- * See Documentation/DMA-API-HOWTO.txt
+ * See Documentation/core-api/dma-api-howto.rst
  */
 static void sba_unmap_page(struct device *dev, dma_addr_t iova, size_t size,
 			   enum dma_data_direction dir, unsigned long attrs)
@@ -1105,7 +1105,7 @@ static void sba_unmap_page(struct device *dev, dma_addr_t iova, size_t size,
  * @size:  number of bytes mapped in driver buffer.
  * @dma_handle:  IOVA of new buffer.
  *
- * See Documentation/DMA-API-HOWTO.txt
+ * See Documentation/core-api/dma-api-howto.rst
  */
 static void *
 sba_alloc_coherent(struct device *dev, size_t size, dma_addr_t *dma_handle,
@@ -1162,7 +1162,7 @@ sba_alloc_coherent(struct device *dev, size_t size, dma_addr_t *dma_handle,
  * @vaddr:  virtual address IOVA of "consistent" buffer.
  * @dma_handler:  IO virtual address of "consistent" buffer.
  *
- * See Documentation/DMA-API-HOWTO.txt
+ * See Documentation/core-api/dma-api-howto.rst
  */
 static void sba_free_coherent(struct device *dev, size_t size, void *vaddr,
 			      dma_addr_t dma_handle, unsigned long attrs)
@@ -1425,7 +1425,7 @@ static void sba_unmap_sg_attrs(struct device *dev, struct scatterlist *sglist,
  * @dir:  R/W or both.
  * @attrs: optional dma attributes
  *
- * See Documentation/DMA-API-HOWTO.txt
+ * See Documentation/core-api/dma-api-howto.rst
  */
 static int sba_map_sg_attrs(struct device *dev, struct scatterlist *sglist,
 			    int nents, enum dma_data_direction dir,
@@ -1524,7 +1524,7 @@ static int sba_map_sg_attrs(struct device *dev, struct scatterlist *sglist,
  * @dir:  R/W or both.
  * @attrs: optional dma attributes
  *
- * See Documentation/DMA-API-HOWTO.txt
+ * See Documentation/core-api/dma-api-howto.rst
  */
 static void sba_unmap_sg_attrs(struct device *dev, struct scatterlist *sglist,
 			       int nents, enum dma_data_direction dir,
diff --git a/arch/parisc/kernel/pci-dma.c b/arch/parisc/kernel/pci-dma.c
index 0f1b460ee715..a86c9456b3c1 100644
--- a/arch/parisc/kernel/pci-dma.c
+++ b/arch/parisc/kernel/pci-dma.c
@@ -3,7 +3,7 @@
 ** PARISC 1.1 Dynamic DMA mapping support.
 ** This implementation is for PA-RISC platforms that do not support
 ** I/O TLBs (aka DMA address translation hardware).
-** See Documentation/DMA-API-HOWTO.txt for interface definitions.
+** See Documentation/core-api/dma-api-howto.rst for interface definitions.
 **
 **      (c) Copyright 1999,2000 Hewlett-Packard Company
 **      (c) Copyright 2000 Grant Grundler
diff --git a/arch/x86/include/asm/dma-mapping.h b/arch/x86/include/asm/dma-mapping.h
index 6b15a24930e0..fed67eafcacc 100644
--- a/arch/x86/include/asm/dma-mapping.h
+++ b/arch/x86/include/asm/dma-mapping.h
@@ -3,8 +3,8 @@
 #define _ASM_X86_DMA_MAPPING_H
 
 /*
- * IOMMU interface. See Documentation/DMA-API-HOWTO.txt and
- * Documentation/DMA-API.txt for documentation.
+ * IOMMU interface. See Documentation/core-api/dma-api-howto.rst and
+ * Documentation/core-api/dma-api.rst for documentation.
  */
 
 #include <linux/scatterlist.h>
diff --git a/arch/x86/kernel/amd_gart_64.c b/arch/x86/kernel/amd_gart_64.c
index 5f816861f5d2..13386e13d711 100644
--- a/arch/x86/kernel/amd_gart_64.c
+++ b/arch/x86/kernel/amd_gart_64.c
@@ -6,7 +6,7 @@
  * This allows to use PCI devices that only support 32bit addresses on systems
  * with more than 4GB.
  *
- * See Documentation/DMA-API-HOWTO.txt for the interface specification.
+ * See Documentation/core-api/dma-api-howto.rst for the interface specification.
  *
  * Copyright 2002 Andi Kleen, SuSE Labs.
  */
diff --git a/drivers/parisc/sba_iommu.c b/drivers/parisc/sba_iommu.c
index 7e112829d250..5368452eb5a6 100644
--- a/drivers/parisc/sba_iommu.c
+++ b/drivers/parisc/sba_iommu.c
@@ -666,7 +666,7 @@ sba_mark_invalid(struct ioc *ioc, dma_addr_t iova, size_t byte_cnt)
  * @dev: instance of PCI owned by the driver that's asking
  * @mask:  number of address bits this PCI device can handle
  *
- * See Documentation/DMA-API-HOWTO.txt
+ * See Documentation/core-api/dma-api-howto.rst
  */
 static int sba_dma_supported( struct device *dev, u64 mask)
 {
@@ -698,7 +698,7 @@ static int sba_dma_supported( struct device *dev, u64 mask)
  * @size:  number of bytes to map in driver buffer.
  * @direction:  R/W or both.
  *
- * See Documentation/DMA-API-HOWTO.txt
+ * See Documentation/core-api/dma-api-howto.rst
  */
 static dma_addr_t
 sba_map_single(struct device *dev, void *addr, size_t size,
@@ -788,7 +788,7 @@ sba_map_page(struct device *dev, struct page *page, unsigned long offset,
  * @size:  number of bytes mapped in driver buffer.
  * @direction:  R/W or both.
  *
- * See Documentation/DMA-API-HOWTO.txt
+ * See Documentation/core-api/dma-api-howto.rst
  */
 static void
 sba_unmap_page(struct device *dev, dma_addr_t iova, size_t size,
@@ -867,7 +867,7 @@ sba_unmap_page(struct device *dev, dma_addr_t iova, size_t size,
  * @size:  number of bytes mapped in driver buffer.
  * @dma_handle:  IOVA of new buffer.
  *
- * See Documentation/DMA-API-HOWTO.txt
+ * See Documentation/core-api/dma-api-howto.rst
  */
 static void *sba_alloc(struct device *hwdev, size_t size, dma_addr_t *dma_handle,
 		gfp_t gfp, unsigned long attrs)
@@ -898,7 +898,7 @@ static void *sba_alloc(struct device *hwdev, size_t size, dma_addr_t *dma_handle
  * @vaddr:  virtual address IOVA of "consistent" buffer.
  * @dma_handler:  IO virtual address of "consistent" buffer.
  *
- * See Documentation/DMA-API-HOWTO.txt
+ * See Documentation/core-api/dma-api-howto.rst
  */
 static void
 sba_free(struct device *hwdev, size_t size, void *vaddr,
@@ -933,7 +933,7 @@ int dump_run_sg = 0;
  * @nents:  number of entries in list
  * @direction:  R/W or both.
  *
- * See Documentation/DMA-API-HOWTO.txt
+ * See Documentation/core-api/dma-api-howto.rst
  */
 static int
 sba_map_sg(struct device *dev, struct scatterlist *sglist, int nents,
@@ -1017,7 +1017,7 @@ sba_map_sg(struct device *dev, struct scatterlist *sglist, int nents,
  * @nents:  number of entries in list
  * @direction:  R/W or both.
  *
- * See Documentation/DMA-API-HOWTO.txt
+ * See Documentation/core-api/dma-api-howto.rst
  */
 static void 
 sba_unmap_sg(struct device *dev, struct scatterlist *sglist, int nents,
diff --git a/include/linux/dma-mapping.h b/include/linux/dma-mapping.h
index b43116a6405d..f893a6bb3125 100644
--- a/include/linux/dma-mapping.h
+++ b/include/linux/dma-mapping.h
@@ -14,7 +14,7 @@
 
 /**
  * List of possible attributes associated with a DMA mapping. The semantics
- * of each attribute should be defined in Documentation/DMA-attributes.txt.
+ * of each attribute should be defined in Documentation/core-api/dma-attributes.rst.
  */
 
 /*
diff --git a/include/media/videobuf-dma-sg.h b/include/media/videobuf-dma-sg.h
index b89d5e31f172..34450f7ad510 100644
--- a/include/media/videobuf-dma-sg.h
+++ b/include/media/videobuf-dma-sg.h
@@ -31,7 +31,7 @@
  *	does memory allocation too using vmalloc_32().
  *
  * videobuf_dma_*()
- *	see Documentation/DMA-API-HOWTO.txt, these functions to
+ *	see Documentation/core-api/dma-api-howto.rst, these functions to
  *	basically the same.  The map function does also build a
  *	scatterlist for the buffer (and unmap frees it ...)
  *
diff --git a/kernel/dma/debug.c b/kernel/dma/debug.c
index 36c962a86bf2..f97f088ace7e 100644
--- a/kernel/dma/debug.c
+++ b/kernel/dma/debug.c
@@ -1071,7 +1071,7 @@ static void check_unmap(struct dma_debug_entry *ref)
 	/*
 	 * Drivers should use dma_mapping_error() to check the returned
 	 * addresses of dma_map_single() and dma_map_page().
-	 * If not, print this warning message. See Documentation/DMA-API.txt.
+	 * If not, print this warning message. See Documentation/core-api/dma-api.rst.
 	 */
 	if (entry->map_err_type == MAP_ERR_NOT_CHECKED) {
 		err_printk(ref->dev, entry,
-- 
2.25.4

_______________________________________________
iommu mailing list
iommu@lists.linux-foundation.org
https://lists.linuxfoundation.org/mailman/listinfo/iommu

Re: [PATCH 03/14] docs: fix references for DMA*.txt files

[Paul E. McKenney]

On Fri, May 01, 2020 at 05:37:47PM +0200, Mauro Carvalho Chehab wrote:
> 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>
> ---
>  Documentation/PCI/pci.rst                          |  6 +++---
>  Documentation/block/biodoc.rst                     |  2 +-
>  Documentation/core-api/bus-virt-phys-mapping.rst   |  2 +-
>  Documentation/core-api/dma-api.rst                 |  6 +++---
>  Documentation/core-api/dma-isa-lpc.rst             |  2 +-
>  Documentation/driver-api/usb/dma.rst               |  6 +++---
>  Documentation/memory-barriers.txt                  |  6 +++---

For memory-barriers.txt:

Acked-by: Paul E. McKenney <paulmck@kernel.org>

>  .../translations/ko_KR/memory-barriers.txt         |  6 +++---
>  arch/ia64/hp/common/sba_iommu.c                    | 12 ++++++------
>  arch/parisc/kernel/pci-dma.c                       |  2 +-
>  arch/x86/include/asm/dma-mapping.h                 |  4 ++--
>  arch/x86/kernel/amd_gart_64.c                      |  2 +-
>  drivers/parisc/sba_iommu.c                         | 14 +++++++-------
>  include/linux/dma-mapping.h                        |  2 +-
>  include/media/videobuf-dma-sg.h                    |  2 +-
>  kernel/dma/debug.c                                 |  2 +-
>  16 files changed, 38 insertions(+), 38 deletions(-)
> 
> diff --git a/Documentation/PCI/pci.rst b/Documentation/PCI/pci.rst
> index 8c016d8c9862..d10d3fe604c5 100644
> --- a/Documentation/PCI/pci.rst
> +++ b/Documentation/PCI/pci.rst
> @@ -265,7 +265,7 @@ Set the DMA mask size
>  ---------------------
>  .. note::
>     If anything below doesn't make sense, please refer to
> -   Documentation/DMA-API.txt. This section is just a reminder that
> +   :doc:`/core-api/dma-api`. This section is just a reminder that
>     drivers need to indicate DMA capabilities of the device and is not
>     an authoritative source for DMA interfaces.
>  
> @@ -291,7 +291,7 @@ Many 64-bit "PCI" devices (before PCI-X) and some PCI-X devices are
>  Setup shared control data
>  -------------------------
>  Once the DMA masks are set, the driver can allocate "consistent" (a.k.a. shared)
> -memory.  See Documentation/DMA-API.txt for a full description of
> +memory.  See :doc:`/core-api/dma-api` for a full description of
>  the DMA APIs. This section is just a reminder that it needs to be done
>  before enabling DMA on the device.
>  
> @@ -421,7 +421,7 @@ owners if there is one.
>  
>  Then clean up "consistent" buffers which contain the control data.
>  
> -See Documentation/DMA-API.txt for details on unmapping interfaces.
> +See :doc:`/core-api/dma-api` for details on unmapping interfaces.
>  
>  
>  Unregister from other subsystems
> diff --git a/Documentation/block/biodoc.rst b/Documentation/block/biodoc.rst
> index b964796ec9c7..ba7f45d0271c 100644
> --- a/Documentation/block/biodoc.rst
> +++ b/Documentation/block/biodoc.rst
> @@ -196,7 +196,7 @@ a virtual address mapping (unlike the earlier scheme of virtual address
>  do not have a corresponding kernel virtual address space mapping) and
>  low-memory pages.
>  
> -Note: Please refer to Documentation/DMA-API-HOWTO.txt for a discussion
> +Note: Please refer to :doc:`/core-api/dma-api-howto` for a discussion
>  on PCI high mem DMA aspects and mapping of scatter gather lists, and support
>  for 64 bit PCI.
>  
> diff --git a/Documentation/core-api/bus-virt-phys-mapping.rst b/Documentation/core-api/bus-virt-phys-mapping.rst
> index 4bb07c2f3e7d..c7bc99cd2e21 100644
> --- a/Documentation/core-api/bus-virt-phys-mapping.rst
> +++ b/Documentation/core-api/bus-virt-phys-mapping.rst
> @@ -8,7 +8,7 @@ How to access I/O mapped memory from within device drivers
>  
>  	The virt_to_bus() and bus_to_virt() functions have been
>  	superseded by the functionality provided by the PCI DMA interface
> -	(see Documentation/DMA-API-HOWTO.txt).  They continue
> +	(see :doc:`/core-api/dma-api-howto`).  They continue
>  	to be documented below for historical purposes, but new code
>  	must not use them. --davidm 00/12/12
>  
> diff --git a/Documentation/core-api/dma-api.rst b/Documentation/core-api/dma-api.rst
> index 2d8d2fed7317..63b4a2f20867 100644
> --- a/Documentation/core-api/dma-api.rst
> +++ b/Documentation/core-api/dma-api.rst
> @@ -5,7 +5,7 @@ Dynamic DMA mapping using the generic device
>  :Author: James E.J. Bottomley <James.Bottomley@HansenPartnership.com>
>  
>  This document describes the DMA API.  For a more gentle introduction
> -of the API (and actual examples), see Documentation/DMA-API-HOWTO.txt.
> +of the API (and actual examples), see :doc:`/core-api/dma-api-howto`.
>  
>  This API is split into two pieces.  Part I describes the basic API.
>  Part II describes extensions for supporting non-consistent memory
> @@ -471,7 +471,7 @@ without the _attrs suffixes, except that they pass an optional
>  dma_attrs.
>  
>  The interpretation of DMA attributes is architecture-specific, and
> -each attribute should be documented in Documentation/DMA-attributes.txt.
> +each attribute should be documented in :doc:`/core-api/dma-attributes`.
>  
>  If dma_attrs are 0, the semantics of each of these functions
>  is identical to those of the corresponding function
> @@ -484,7 +484,7 @@ for DMA::
>  
>  	#include <linux/dma-mapping.h>
>  	/* DMA_ATTR_FOO should be defined in linux/dma-mapping.h and
> -	* documented in Documentation/DMA-attributes.txt */
> +	* documented in Documentation/core-api/dma-attributes.rst */
>  	...
>  
>  		unsigned long attr;
> diff --git a/Documentation/core-api/dma-isa-lpc.rst b/Documentation/core-api/dma-isa-lpc.rst
> index b1ec7b16c21f..e59a3d35a93d 100644
> --- a/Documentation/core-api/dma-isa-lpc.rst
> +++ b/Documentation/core-api/dma-isa-lpc.rst
> @@ -17,7 +17,7 @@ To do ISA style DMA you need to include two headers::
>  	#include <asm/dma.h>
>  
>  The first is the generic DMA API used to convert virtual addresses to
> -bus addresses (see Documentation/DMA-API.txt for details).
> +bus addresses (see :doc:`/core-api/dma-api` for details).
>  
>  The second contains the routines specific to ISA DMA transfers. Since
>  this is not present on all platforms make sure you construct your
> diff --git a/Documentation/driver-api/usb/dma.rst b/Documentation/driver-api/usb/dma.rst
> index 59d5aee89e37..2b3dbd3265b4 100644
> --- a/Documentation/driver-api/usb/dma.rst
> +++ b/Documentation/driver-api/usb/dma.rst
> @@ -10,7 +10,7 @@ API overview
>  
>  The big picture is that USB drivers can continue to ignore most DMA issues,
>  though they still must provide DMA-ready buffers (see
> -``Documentation/DMA-API-HOWTO.txt``).  That's how they've worked through
> +:doc:`/core-api/dma-api-howto`).  That's how they've worked through
>  the 2.4 (and earlier) kernels, or they can now be DMA-aware.
>  
>  DMA-aware usb drivers:
> @@ -60,7 +60,7 @@ and effects like cache-trashing can impose subtle penalties.
>    force a consistent memory access ordering by using memory barriers.  It's
>    not using a streaming DMA mapping, so it's good for small transfers on
>    systems where the I/O would otherwise thrash an IOMMU mapping.  (See
> -  ``Documentation/DMA-API-HOWTO.txt`` for definitions of "coherent" and
> +  :doc:`/core-api/dma-api-howto` for definitions of "coherent" and
>    "streaming" DMA mappings.)
>  
>    Asking for 1/Nth of a page (as well as asking for N pages) is reasonably
> @@ -91,7 +91,7 @@ Working with existing buffers
>  Existing buffers aren't usable for DMA without first being mapped into the
>  DMA address space of the device.  However, most buffers passed to your
>  driver can safely be used with such DMA mapping.  (See the first section
> -of Documentation/DMA-API-HOWTO.txt, titled "What memory is DMA-able?")
> +of :doc:`/core-api/dma-api-howto`, titled "What memory is DMA-able?")
>  
>  - When you're using scatterlists, you can map everything at once.  On some
>    systems, this kicks in an IOMMU and turns the scatterlists into single
> diff --git a/Documentation/memory-barriers.txt b/Documentation/memory-barriers.txt
> index eaabc3134294..0e4947a8282d 100644
> --- a/Documentation/memory-barriers.txt
> +++ b/Documentation/memory-barriers.txt
> @@ -546,8 +546,8 @@ There are certain things that the Linux kernel memory barriers do not guarantee:
>  	[*] For information on bus mastering DMA and coherency please read:
>  
>  	    Documentation/driver-api/pci/pci.rst
> -	    Documentation/DMA-API-HOWTO.txt
> -	    Documentation/DMA-API.txt
> +	    Documentation/core-api/dma-api-howto.rst
> +	    Documentation/core-api/dma-api.rst
>  
>  
>  DATA DEPENDENCY BARRIERS (HISTORICAL)
> @@ -1932,7 +1932,7 @@ There are some more advanced barrier functions:
>       here.
>  
>       See the subsection "Kernel I/O barrier effects" for more information on
> -     relaxed I/O accessors and the Documentation/DMA-API.txt file for more
> +     relaxed I/O accessors and the Documentation/core-api/dma-api.rst file for more
>       information on consistent memory.
>  
>  
> diff --git a/Documentation/translations/ko_KR/memory-barriers.txt b/Documentation/translations/ko_KR/memory-barriers.txt
> index e50fe6541335..037e82ade93c 100644
> --- a/Documentation/translations/ko_KR/memory-barriers.txt
> +++ b/Documentation/translations/ko_KR/memory-barriers.txt
> @@ -570,8 +570,8 @@ ACQUIRE 는 해당 오퍼레이션의 로드 부분에만 적용되고 RELEASE 
>  	[*] 버스 마스터링 DMA 와 일관성에 대해서는 다음을 참고하시기 바랍니다:
>  
>  	    Documentation/driver-api/pci/pci.rst
> -	    Documentation/DMA-API-HOWTO.txt
> -	    Documentation/DMA-API.txt
> +	    Documentation/core-api/dma-api-howto.rst
> +	    Documentation/core-api/dma-api.rst
>  
>  
>  데이터 의존성 배리어 (역사적)
> @@ -1904,7 +1904,7 @@ Mandatory 배리어들은 SMP 시스템에서도 UP 시스템에서도 SMP 효
>  
>       writel_relaxed() 와 같은 완화된 I/O 접근자들에 대한 자세한 내용을 위해서는
>       "커널 I/O 배리어의 효과" 섹션을, consistent memory 에 대한 자세한 내용을
> -     위해선 Documentation/DMA-API.txt 문서를 참고하세요.
> +     위해선 Documentation/core-api/dma-api.rst 문서를 참고하세요.
>  
>  
>  =========================
> diff --git a/arch/ia64/hp/common/sba_iommu.c b/arch/ia64/hp/common/sba_iommu.c
> index a806227c1fad..656a4888c300 100644
> --- a/arch/ia64/hp/common/sba_iommu.c
> +++ b/arch/ia64/hp/common/sba_iommu.c
> @@ -907,7 +907,7 @@ sba_mark_invalid(struct ioc *ioc, dma_addr_t iova, size_t byte_cnt)
>   * @dir: dma direction
>   * @attrs: optional dma attributes
>   *
> - * See Documentation/DMA-API-HOWTO.txt
> + * See Documentation/core-api/dma-api-howto.rst
>   */
>  static dma_addr_t sba_map_page(struct device *dev, struct page *page,
>  			       unsigned long poff, size_t size,
> @@ -1028,7 +1028,7 @@ sba_mark_clean(struct ioc *ioc, dma_addr_t iova, size_t size)
>   * @dir:  R/W or both.
>   * @attrs: optional dma attributes
>   *
> - * See Documentation/DMA-API-HOWTO.txt
> + * See Documentation/core-api/dma-api-howto.rst
>   */
>  static void sba_unmap_page(struct device *dev, dma_addr_t iova, size_t size,
>  			   enum dma_data_direction dir, unsigned long attrs)
> @@ -1105,7 +1105,7 @@ static void sba_unmap_page(struct device *dev, dma_addr_t iova, size_t size,
>   * @size:  number of bytes mapped in driver buffer.
>   * @dma_handle:  IOVA of new buffer.
>   *
> - * See Documentation/DMA-API-HOWTO.txt
> + * See Documentation/core-api/dma-api-howto.rst
>   */
>  static void *
>  sba_alloc_coherent(struct device *dev, size_t size, dma_addr_t *dma_handle,
> @@ -1162,7 +1162,7 @@ sba_alloc_coherent(struct device *dev, size_t size, dma_addr_t *dma_handle,
>   * @vaddr:  virtual address IOVA of "consistent" buffer.
>   * @dma_handler:  IO virtual address of "consistent" buffer.
>   *
> - * See Documentation/DMA-API-HOWTO.txt
> + * See Documentation/core-api/dma-api-howto.rst
>   */
>  static void sba_free_coherent(struct device *dev, size_t size, void *vaddr,
>  			      dma_addr_t dma_handle, unsigned long attrs)
> @@ -1425,7 +1425,7 @@ static void sba_unmap_sg_attrs(struct device *dev, struct scatterlist *sglist,
>   * @dir:  R/W or both.
>   * @attrs: optional dma attributes
>   *
> - * See Documentation/DMA-API-HOWTO.txt
> + * See Documentation/core-api/dma-api-howto.rst
>   */
>  static int sba_map_sg_attrs(struct device *dev, struct scatterlist *sglist,
>  			    int nents, enum dma_data_direction dir,
> @@ -1524,7 +1524,7 @@ static int sba_map_sg_attrs(struct device *dev, struct scatterlist *sglist,
>   * @dir:  R/W or both.
>   * @attrs: optional dma attributes
>   *
> - * See Documentation/DMA-API-HOWTO.txt
> + * See Documentation/core-api/dma-api-howto.rst
>   */
>  static void sba_unmap_sg_attrs(struct device *dev, struct scatterlist *sglist,
>  			       int nents, enum dma_data_direction dir,
> diff --git a/arch/parisc/kernel/pci-dma.c b/arch/parisc/kernel/pci-dma.c
> index 0f1b460ee715..a86c9456b3c1 100644
> --- a/arch/parisc/kernel/pci-dma.c
> +++ b/arch/parisc/kernel/pci-dma.c
> @@ -3,7 +3,7 @@
>  ** PARISC 1.1 Dynamic DMA mapping support.
>  ** This implementation is for PA-RISC platforms that do not support
>  ** I/O TLBs (aka DMA address translation hardware).
> -** See Documentation/DMA-API-HOWTO.txt for interface definitions.
> +** See Documentation/core-api/dma-api-howto.rst for interface definitions.
>  **
>  **      (c) Copyright 1999,2000 Hewlett-Packard Company
>  **      (c) Copyright 2000 Grant Grundler
> diff --git a/arch/x86/include/asm/dma-mapping.h b/arch/x86/include/asm/dma-mapping.h
> index 6b15a24930e0..fed67eafcacc 100644
> --- a/arch/x86/include/asm/dma-mapping.h
> +++ b/arch/x86/include/asm/dma-mapping.h
> @@ -3,8 +3,8 @@
>  #define _ASM_X86_DMA_MAPPING_H
>  
>  /*
> - * IOMMU interface. See Documentation/DMA-API-HOWTO.txt and
> - * Documentation/DMA-API.txt for documentation.
> + * IOMMU interface. See Documentation/core-api/dma-api-howto.rst and
> + * Documentation/core-api/dma-api.rst for documentation.
>   */
>  
>  #include <linux/scatterlist.h>
> diff --git a/arch/x86/kernel/amd_gart_64.c b/arch/x86/kernel/amd_gart_64.c
> index 5f816861f5d2..13386e13d711 100644
> --- a/arch/x86/kernel/amd_gart_64.c
> +++ b/arch/x86/kernel/amd_gart_64.c
> @@ -6,7 +6,7 @@
>   * This allows to use PCI devices that only support 32bit addresses on systems
>   * with more than 4GB.
>   *
> - * See Documentation/DMA-API-HOWTO.txt for the interface specification.
> + * See Documentation/core-api/dma-api-howto.rst for the interface specification.
>   *
>   * Copyright 2002 Andi Kleen, SuSE Labs.
>   */
> diff --git a/drivers/parisc/sba_iommu.c b/drivers/parisc/sba_iommu.c
> index 7e112829d250..5368452eb5a6 100644
> --- a/drivers/parisc/sba_iommu.c
> +++ b/drivers/parisc/sba_iommu.c
> @@ -666,7 +666,7 @@ sba_mark_invalid(struct ioc *ioc, dma_addr_t iova, size_t byte_cnt)
>   * @dev: instance of PCI owned by the driver that's asking
>   * @mask:  number of address bits this PCI device can handle
>   *
> - * See Documentation/DMA-API-HOWTO.txt
> + * See Documentation/core-api/dma-api-howto.rst
>   */
>  static int sba_dma_supported( struct device *dev, u64 mask)
>  {
> @@ -698,7 +698,7 @@ static int sba_dma_supported( struct device *dev, u64 mask)
>   * @size:  number of bytes to map in driver buffer.
>   * @direction:  R/W or both.
>   *
> - * See Documentation/DMA-API-HOWTO.txt
> + * See Documentation/core-api/dma-api-howto.rst
>   */
>  static dma_addr_t
>  sba_map_single(struct device *dev, void *addr, size_t size,
> @@ -788,7 +788,7 @@ sba_map_page(struct device *dev, struct page *page, unsigned long offset,
>   * @size:  number of bytes mapped in driver buffer.
>   * @direction:  R/W or both.
>   *
> - * See Documentation/DMA-API-HOWTO.txt
> + * See Documentation/core-api/dma-api-howto.rst
>   */
>  static void
>  sba_unmap_page(struct device *dev, dma_addr_t iova, size_t size,
> @@ -867,7 +867,7 @@ sba_unmap_page(struct device *dev, dma_addr_t iova, size_t size,
>   * @size:  number of bytes mapped in driver buffer.
>   * @dma_handle:  IOVA of new buffer.
>   *
> - * See Documentation/DMA-API-HOWTO.txt
> + * See Documentation/core-api/dma-api-howto.rst
>   */
>  static void *sba_alloc(struct device *hwdev, size_t size, dma_addr_t *dma_handle,
>  		gfp_t gfp, unsigned long attrs)
> @@ -898,7 +898,7 @@ static void *sba_alloc(struct device *hwdev, size_t size, dma_addr_t *dma_handle
>   * @vaddr:  virtual address IOVA of "consistent" buffer.
>   * @dma_handler:  IO virtual address of "consistent" buffer.
>   *
> - * See Documentation/DMA-API-HOWTO.txt
> + * See Documentation/core-api/dma-api-howto.rst
>   */
>  static void
>  sba_free(struct device *hwdev, size_t size, void *vaddr,
> @@ -933,7 +933,7 @@ int dump_run_sg = 0;
>   * @nents:  number of entries in list
>   * @direction:  R/W or both.
>   *
> - * See Documentation/DMA-API-HOWTO.txt
> + * See Documentation/core-api/dma-api-howto.rst
>   */
>  static int
>  sba_map_sg(struct device *dev, struct scatterlist *sglist, int nents,
> @@ -1017,7 +1017,7 @@ sba_map_sg(struct device *dev, struct scatterlist *sglist, int nents,
>   * @nents:  number of entries in list
>   * @direction:  R/W or both.
>   *
> - * See Documentation/DMA-API-HOWTO.txt
> + * See Documentation/core-api/dma-api-howto.rst
>   */
>  static void 
>  sba_unmap_sg(struct device *dev, struct scatterlist *sglist, int nents,
> diff --git a/include/linux/dma-mapping.h b/include/linux/dma-mapping.h
> index b43116a6405d..f893a6bb3125 100644
> --- a/include/linux/dma-mapping.h
> +++ b/include/linux/dma-mapping.h
> @@ -14,7 +14,7 @@
>  
>  /**
>   * List of possible attributes associated with a DMA mapping. The semantics
> - * of each attribute should be defined in Documentation/DMA-attributes.txt.
> + * of each attribute should be defined in Documentation/core-api/dma-attributes.rst.
>   */
>  
>  /*
> diff --git a/include/media/videobuf-dma-sg.h b/include/media/videobuf-dma-sg.h
> index b89d5e31f172..34450f7ad510 100644
> --- a/include/media/videobuf-dma-sg.h
> +++ b/include/media/videobuf-dma-sg.h
> @@ -31,7 +31,7 @@
>   *	does memory allocation too using vmalloc_32().
>   *
>   * videobuf_dma_*()
> - *	see Documentation/DMA-API-HOWTO.txt, these functions to
> + *	see Documentation/core-api/dma-api-howto.rst, these functions to
>   *	basically the same.  The map function does also build a
>   *	scatterlist for the buffer (and unmap frees it ...)
>   *
> diff --git a/kernel/dma/debug.c b/kernel/dma/debug.c
> index 36c962a86bf2..f97f088ace7e 100644
> --- a/kernel/dma/debug.c
> +++ b/kernel/dma/debug.c
> @@ -1071,7 +1071,7 @@ static void check_unmap(struct dma_debug_entry *ref)
>  	/*
>  	 * Drivers should use dma_mapping_error() to check the returned
>  	 * addresses of dma_map_single() and dma_map_page().
> -	 * If not, print this warning message. See Documentation/DMA-API.txt.
> +	 * If not, print this warning message. See Documentation/core-api/dma-api.rst.
>  	 */
>  	if (entry->map_err_type == MAP_ERR_NOT_CHECKED) {
>  		err_printk(ref->dev, entry,
> -- 
> 2.25.4
> 
_______________________________________________
iommu mailing list
iommu@lists.linux-foundation.org
https://lists.linuxfoundation.org/mailman/listinfo/iommu

Re: [PATCH 03/14] docs: fix references for DMA*.txt files

[Jonathan Corbet]

On Fri,  1 May 2020 17:37:47 +0200
Mauro Carvalho Chehab <mchehab+huawei@kernel.org> wrote:

> 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>
> ---
>  Documentation/PCI/pci.rst                          |  6 +++---
>  Documentation/block/biodoc.rst                     |  2 +-
>  Documentation/core-api/bus-virt-phys-mapping.rst   |  2 +-
>  Documentation/core-api/dma-api.rst                 |  6 +++---
>  Documentation/core-api/dma-isa-lpc.rst             |  2 +-
>  Documentation/driver-api/usb/dma.rst               |  6 +++---
>  Documentation/memory-barriers.txt                  |  6 +++---
>  .../translations/ko_KR/memory-barriers.txt         |  6 +++---
>  arch/ia64/hp/common/sba_iommu.c                    | 12 ++++++------
>  arch/parisc/kernel/pci-dma.c                       |  2 +-
>  arch/x86/include/asm/dma-mapping.h                 |  4 ++--
>  arch/x86/kernel/amd_gart_64.c                      |  2 +-
>  drivers/parisc/sba_iommu.c                         | 14 +++++++-------
>  include/linux/dma-mapping.h                        |  2 +-
>  include/media/videobuf-dma-sg.h                    |  2 +-
>  kernel/dma/debug.c                                 |  2 +-
>  16 files changed, 38 insertions(+), 38 deletions(-)

...of course, not applying patch 2 causes this one to not apply, so
holding off for now...

jon
_______________________________________________
iommu mailing list
iommu@lists.linux-foundation.org
https://lists.linuxfoundation.org/mailman/listinfo/iommu