Skip to contentSkip to conversation

Documentation: mv DMA-* to separate DMA/ subdirectory

PATCH In review J. Bruce Fields 2 participants 2 messages Jun 2, 2008 – Jun 3, 2008

Subsystems (9)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 Documentation: mv DMA-* to separate DMA/ subdirectory

From: J. Bruce Fields <[email protected]>

Every now and then as I'm looking for something in Documentation/ I get annoyed at how cluttered that directory is, and go look for a few files that could be grouped into a subdirectory. This seemed like one candidate, though a lot of referenes to DMA-mapping.txt require fixing.

---

A Documentation/arch directory would take out another dozen entries or so, but I haven't had the energy.--b.

 Documentation/00-INDEX               |    4 -
 Documentation/DMA-API.txt            |  614 ---------------------------
 Documentation/DMA-ISA-LPC.txt        |  151 -------
 Documentation/DMA-attributes.txt     |   24 -
 Documentation/DMA-mapping.txt        |  766 ----------------------------------
 Documentation/DMA/00-INDEX           |   10 +
 Documentation/DMA/DMA-API.txt        |  614 +++++++++++++++++++++++++++
 Documentation/DMA/DMA-ISA-LPC.txt    |  151 +++++++
 Documentation/DMA/DMA-attributes.txt |   24 +
 Documentation/DMA/DMA-mapping.txt    |  766 ++++++++++++++++++++++++++++++++++
 Documentation/IO-mapping.txt         |    2 +-
 Documentation/PCI/pci.txt            |    6 +-
 Documentation/block/biodoc.txt       |    5 +-
 Documentation/memory-barriers.txt    |    2 +-
 Documentation/usb/dma.txt            |   13 +-
 arch/ia64/hp/common/sba_iommu.c      |   12 +-
 arch/ia64/sn/pci/pci_dma.c           |    4 +-
 arch/parisc/kernel/pci-dma.c         |    2 +-
 arch/x86/kernel/pci-gart_64.c        |    2 +-
 drivers/net/tehuti.c                 |    2 +-
 drivers/parisc/sba_iommu.c           |   18 +-
 include/asm-ia64/dma-mapping.h       |    2 +-
 include/asm-parisc/dma-mapping.h     |    2 +-
 include/asm-x86/dma-mapping.h        |    2 +-
 include/linux/dma-attrs.h            |    2 +-
 include/media/videobuf-dma-sg.h      |    2 +-
 26 files changed, 1605 insertions(+), 1597 deletions(-)
 delete mode 100644 Documentation/DMA-API.txt
 delete mode 100644 Documentation/DMA-ISA-LPC.txt
 delete mode 100644 Documentation/DMA-attributes.txt
 delete mode 100644 Documentation/DMA-mapping.txt
 create mode 100644 Documentation/DMA/00-INDEX
 create mode 100644 Documentation/DMA/DMA-API.txt
 create mode 100644 Documentation/DMA/DMA-ISA-LPC.txt
 create mode 100644 Documentation/DMA/DMA-attributes.txt
 create mode 100644 Documentation/DMA/DMA-mapping.txt
Documentation/00-INDEX +0 -4
index 1977fab..21b6171 100644
@@ -21,10 +21,6 @@ Changes
 	- list of changes that break older software packages.
 CodingStyle
 	- how the boss likes the C code in the kernel to look.
-DMA-API.txt
-	- DMA API, pci_ API & extensions for non-consistent memory machines.
-DMA-ISA-LPC.txt
-	- How to do DMA with ISA (and LPC) devices.
 DocBook/
 	- directory with DocBook templates etc. for kernel documentation.
 HOWTO
Documentation/DMA-API.txt deleted +0 -614

614 lines not on this page · raw message

Documentation/DMA-ISA-LPC.txt deleted +0 -151

151 lines not on this page · raw message

Documentation/DMA-attributes.txt deleted +0 -24
deleted file mode 100644
index 6d772f8..0000000
@@ -1,24 +0,0 @@
-			DMA attributes
-			==============
-
-This document describes the semantics of the DMA attributes that are
-defined in linux/dma-attrs.h.
-
-DMA_ATTR_WRITE_BARRIER
-----------------------
-
-DMA_ATTR_WRITE_BARRIER is a (write) barrier attribute for DMA.  DMA
-to a memory region with the DMA_ATTR_WRITE_BARRIER attribute forces
-all pending DMA writes to complete, and thus provides a mechanism to
-strictly order DMA from a device across all intervening busses and
-bridges.  This barrier is not specific to a particular type of
-interconnect, it applies to the system as a whole, and so its
-implementation must account for the idiosyncracies of the system all
-the way from the DMA device to memory.
-
-As an example of a situation where DMA_ATTR_WRITE_BARRIER would be
-useful, suppose that a device does a DMA write to indicate that data is
-ready and available in memory.  The DMA of the "completion indication"
-could race with data DMA.  Mapping the memory used for completion
-indications with DMA_ATTR_WRITE_BARRIER would prevent the race.
-
Documentation/DMA-mapping.txt deleted +0 -766

766 lines not on this page · raw message

Documentation/DMA/00-INDEX new file +10 -0
new file mode 100644
index 0000000..67d99a6
@@ -0,0 +1,10 @@
+00-INDEX
+	- this file.
+DMA-API.txt
+	- DMA API, pci_ API & extensions for non-consistent memory machines.
+DMA-ISA-LPC.txt
+	- How to do DMA with ISA (and LPC) devices.
+DMA-attributes.txt
+	- Semantics of DMA attributes defined in linux/dma-attrs.h
+DMA-mapping.txt
+	- the DMA mapping system described in terms of the pci_ API
Documentation/DMA/DMA-API.txt new file +614 -0

614 lines not on this page · raw message

Documentation/DMA/DMA-ISA-LPC.txt new file +151 -0

151 lines not on this page · raw message

Documentation/DMA/DMA-attributes.txt new file +24 -0
new file mode 100644
index 0000000..6d772f8
@@ -0,0 +1,24 @@
+			DMA attributes
+			==============
+
+This document describes the semantics of the DMA attributes that are
+defined in linux/dma-attrs.h.
+
+DMA_ATTR_WRITE_BARRIER
+----------------------
+
+DMA_ATTR_WRITE_BARRIER is a (write) barrier attribute for DMA.  DMA
+to a memory region with the DMA_ATTR_WRITE_BARRIER attribute forces
+all pending DMA writes to complete, and thus provides a mechanism to
+strictly order DMA from a device across all intervening busses and
+bridges.  This barrier is not specific to a particular type of
+interconnect, it applies to the system as a whole, and so its
+implementation must account for the idiosyncracies of the system all
+the way from the DMA device to memory.
+
+As an example of a situation where DMA_ATTR_WRITE_BARRIER would be
+useful, suppose that a device does a DMA write to indicate that data is
+ready and available in memory.  The DMA of the "completion indication"
+could race with data DMA.  Mapping the memory used for completion
+indications with DMA_ATTR_WRITE_BARRIER would prevent the race.
+
Documentation/DMA/DMA-mapping.txt new file +766 -0

636 lines not on this page · raw message

Documentation/IO-mapping.txt +1 -1
index 86edb61..9d85597 100644

Lines of this file are not shown. View the raw message.

Documentation/PCI/pci.txt +3 -3
index 8d4dc62..709dce1 100644

Lines of this file are not shown. View the raw message.

Documentation/block/biodoc.txt +3 -2
index 4dbb8be..28786a6 100644

Lines of this file are not shown. View the raw message.

Documentation/memory-barriers.txt +1 -1
index f5b7127..caa0bb7 100644

Lines of this file are not shown. View the raw message.

Documentation/usb/dma.txt +7 -6
index e8b50b7..d382274 100644

Lines of this file are not shown. View the raw message.

arch/ia64/hp/common/sba_iommu.c +6 -6
index 34421ae..b32d390 100644

Lines of this file are not shown. View the raw message.

arch/ia64/sn/pci/pci_dma.c +2 -2
index 52175af..0cfd1ec 100644

Lines of this file are not shown. View the raw message.

arch/parisc/kernel/pci-dma.c +1 -1
index ccd61b9..2a377e6 100644

Lines of this file are not shown. View the raw message.

arch/x86/kernel/pci-gart_64.c +1 -1
index c07455d..a8d69f9 100644

Lines of this file are not shown. View the raw message.

drivers/net/tehuti.c +1 -1
index 432e837..d8dd024 100644

Lines of this file are not shown. View the raw message.

drivers/parisc/sba_iommu.c +9 -9
index bc73b96..4d1b401 100644

Lines of this file are not shown. View the raw message.

include/asm-ia64/dma-mapping.h +1 -1
index 9f0df9b..c79ef02 100644

Lines of this file are not shown. View the raw message.

include/asm-parisc/dma-mapping.h +1 -1
index c6c0e9f..869d5a7 100644

Lines of this file are not shown. View the raw message.

include/asm-x86/dma-mapping.h +1 -1
index a1a4dc7..9802af2 100644

Lines of this file are not shown. View the raw message.

include/linux/dma-attrs.h +1 -1
index 1677e2b..f2d567e 100644

Lines of this file are not shown. View the raw message.

include/media/videobuf-dma-sg.h +1 -1
index be8da26..5ac6f76 100644

Lines of this file are not shown. View the raw message.

The rest of this diff is not shown. View the raw message.

Signature · 1 line
1.5.5.rc1

Part of the diff is not shown here. View the raw message.

#1 lore raw
Quoted 41 lines · J. Bruce Fields

From: J. Bruce Fields <[email protected]>

Every now and then as I'm looking for something in Documentation/ I get annoyed at how cluttered that directory is, and go look for a few files that could be grouped into a subdirectory. This seemed like one candidate, though a lot of referenes to DMA-mapping.txt require fixing.

---

A Documentation/arch directory would take out another dozen entries or so, but I haven't had the energy.--b.

 Documentation/00-INDEX               |    4 -
 Documentation/DMA-API.txt            |  614 ---------------------------
 Documentation/DMA-ISA-LPC.txt        |  151 -------
 Documentation/DMA-attributes.txt     |   24 -
 Documentation/DMA-mapping.txt        |  766 ----------------------------------
 Documentation/DMA/00-INDEX           |   10 +
 Documentation/DMA/DMA-API.txt        |  614 +++++++++++++++++++++++++++
 Documentation/DMA/DMA-ISA-LPC.txt    |  151 +++++++
 Documentation/DMA/DMA-attributes.txt |   24 +
 Documentation/DMA/DMA-mapping.txt    |  766 ++++++++++++++++++++++++++++++++++
 Documentation/IO-mapping.txt         |    2 +-
 Documentation/PCI/pci.txt            |    6 +-
 Documentation/block/biodoc.txt       |    5 +-
 Documentation/memory-barriers.txt    |    2 +-
 Documentation/usb/dma.txt            |   13 +-
 arch/ia64/hp/common/sba_iommu.c      |   12 +-
 arch/ia64/sn/pci/pci_dma.c           |    4 +-
 arch/parisc/kernel/pci-dma.c         |    2 +-
 arch/x86/kernel/pci-gart_64.c        |    2 +-
 drivers/net/tehuti.c                 |    2 +-
 drivers/parisc/sba_iommu.c           |   18 +-
 include/asm-ia64/dma-mapping.h       |    2 +-
 include/asm-parisc/dma-mapping.h     |    2 +-
 include/asm-x86/dma-mapping.h        |    2 +-
 include/linux/dma-attrs.h            |    2 +-
 include/media/videobuf-dma-sg.h      |    2 +-
 26 files changed, 1605 insertions(+), 1597 deletions(-)
 delete mode 100644 Documentation/DMA-API.txt
Quoted 8 lines
 delete mode 100644 Documentation/DMA-ISA-LPC.txt
 delete mode 100644 Documentation/DMA-attributes.txt
 delete mode 100644 Documentation/DMA-mapping.txt
 create mode 100644 Documentation/DMA/00-INDEX
 create mode 100644 Documentation/DMA/DMA-API.txt
 create mode 100644 Documentation/DMA/DMA-ISA-LPC.txt
 create mode 100644 Documentation/DMA/DMA-attributes.txt
 create mode 100644 Documentation/DMA/DMA-mapping.txt

Maybe drop DMA- prefix? It's useless now.

Marcin