PCI: doc/pci: create Documentation/PCI/ and move files into it
Randy Dunlap [Tue, 11 Mar 2008 00:16:32 +0000 (17:16 -0700)]
Create Documentation/PCI/ and move PCI-related files to it.
Fix a few instances of trailing whitespace.
Update references to the new file locations.

Signed-off-by: Randy Dunlap <randy.dunlap@oracle.com>
Cc: Jesse Barnes <jbarnes@virtuousgeek.org>
Signed-off-by: Greg Kroah-Hartman <gregkh@suse.de>

Documentation/00-INDEX
Documentation/PCI/00-INDEX [new file with mode: 0644]
Documentation/PCI/PCIEBUS-HOWTO.txt [moved from Documentation/PCIEBUS-HOWTO.txt with 98% similarity]
Documentation/PCI/pci-error-recovery.txt [moved from Documentation/pci-error-recovery.txt with 100% similarity]
Documentation/PCI/pci.txt [moved from Documentation/pci.txt with 99% similarity]
Documentation/PCI/pcieaer-howto.txt [moved from Documentation/pcieaer-howto.txt with 99% similarity]
Documentation/memory-barriers.txt

index f7923a4..a82a113 100644 (file)
@@ -25,8 +25,6 @@ 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-mapping.txt
-       - info for PCI drivers using DMA portably across all platforms.
 DocBook/
        - directory with DocBook templates etc. for kernel documentation.
 HOWTO
@@ -43,8 +41,6 @@ ManagementStyle
        - how to (attempt to) manage kernel hackers.
 MSI-HOWTO.txt
        - the Message Signaled Interrupts (MSI) Driver Guide HOWTO and FAQ.
-PCIEBUS-HOWTO.txt
-       - a guide describing the PCI Express Port Bus driver.
 RCU/
        - directory with info on RCU (read-copy update).
 README.DAC960
@@ -285,12 +281,6 @@ parport.txt
        - how to use the parallel-port driver.
 parport-lowlevel.txt
        - description and usage of the low level parallel port functions.
-pci-error-recovery.txt
-       - info on PCI error recovery.
-pci.txt
-       - info on the PCI subsystem for device driver authors.
-pcieaer-howto.txt
-       - the PCI Express Advanced Error Reporting Driver Guide HOWTO.
 pcmcia/
        - info on the Linux PCMCIA driver.
 pi-futex.txt
diff --git a/Documentation/PCI/00-INDEX b/Documentation/PCI/00-INDEX
new file mode 100644 (file)
index 0000000..49f4394
--- /dev/null
@@ -0,0 +1,12 @@
+00-INDEX
+       - this file
+PCI-DMA-mapping.txt
+       - info for PCI drivers using DMA portably across all platforms
+PCIEBUS-HOWTO.txt
+       - a guide describing the PCI Express Port Bus driver
+pci-error-recovery.txt
+       - info on PCI error recovery
+pci.txt
+       - info on the PCI subsystem for device driver authors
+pcieaer-howto.txt
+       - the PCI Express Advanced Error Reporting Driver Guide HOWTO
similarity index 98%
rename from Documentation/PCIEBUS-HOWTO.txt
rename to Documentation/PCI/PCIEBUS-HOWTO.txt
index c93f42a..9a07e38 100644 (file)
@@ -56,9 +56,9 @@ advantages of using the PCI Express Port Bus driver are listed below:
 
        - Allow service drivers implemented in an independent
          staged approach.
-       
+
        - Allow one service driver to run on multiple PCI-PCI Bridge
-         Port devices. 
+         Port devices.
 
        - Manage and distribute resources of a PCI-PCI Bridge Port
          device to requested service drivers.
@@ -82,7 +82,7 @@ Model requires some minimal changes on existing service drivers that
 imposes no impact on the functionality of existing service drivers.
 
 A service driver is required to use the two APIs shown below to
-register its service with the PCI Express Port Bus driver (see 
+register its service with the PCI Express Port Bus driver (see
 section 5.2.1 & 5.2.2). It is important that a service driver
 initializes the pcie_port_service_driver data structure, included in
 header file /include/linux/pcieport_if.h, before calling these APIs.
@@ -137,7 +137,7 @@ driver.
 static int __init aerdrv_service_init(void)
 {
        int retval = 0;
-       
+
        retval = pcie_port_service_register(&root_aerdrv);
        if (!retval) {
                /*
@@ -147,7 +147,7 @@ static int __init aerdrv_service_init(void)
        return retval;
 }
 
-static void __exit aerdrv_service_exit(void) 
+static void __exit aerdrv_service_exit(void)
 {
        pcie_port_service_unregister(&root_aerdrv);
 }
@@ -175,7 +175,7 @@ same physical Root Port. Both service drivers call pci_enable_msi to
 request MSI based interrupts. A service driver may not know whether
 any other service drivers have run on this Root Port. If either one
 of them calls pci_disable_msi, it puts the other service driver
-in a wrong interrupt mode. 
+in a wrong interrupt mode.
 
 To avoid this situation all service drivers are not permitted to
 switch interrupt mode on its device. The PCI Express Port Bus driver
similarity index 99%
rename from Documentation/pci.txt
rename to Documentation/PCI/pci.txt
index d2c2e6e..8d4dc62 100644 (file)
@@ -119,7 +119,7 @@ initialization with a pointer to a structure describing the driver
                        the power state of a device before reboot.
                        e.g. drivers/net/e100.c.
 
-       err_handler     See Documentation/pci-error-recovery.txt
+       err_handler     See Documentation/PCI/pci-error-recovery.txt
 
 
 The ID table is an array of struct pci_device_id entries ending with an
similarity index 99%
rename from Documentation/pcieaer-howto.txt
rename to Documentation/PCI/pcieaer-howto.txt
index d5da861..16c2512 100644 (file)
@@ -13,7 +13,7 @@ Reporting (AER) driver and provides information on how to use it, as
 well as how to enable the drivers of endpoint devices to conform with
 PCI Express AER driver.
 
-1.2 Copyright © Intel Corporation 2006.
+1.2 Copyright © Intel Corporation 2006.
 
 1.3 What is the PCI Express AER Driver?
 
index 1f506f7..e5a819a 100644 (file)
@@ -430,8 +430,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/pci.txt
-           Documentation/DMA-mapping.txt
+           Documentation/PCI/pci.txt
+           Documentation/PCI/PCI-DMA-mapping.txt
            Documentation/DMA-API.txt