Browse Source

PCI: doc/pci: create Documentation/PCI/ and move files into it

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>
Randy Dunlap 17 years ago
parent
commit
4b5ff46923

+ 0 - 10
Documentation/00-INDEX

@@ -25,8 +25,6 @@ DMA-API.txt
 	- DMA API, pci_ API & extensions for non-consistent memory machines.
 	- DMA API, pci_ API & extensions for non-consistent memory machines.
 DMA-ISA-LPC.txt
 DMA-ISA-LPC.txt
 	- How to do DMA with ISA (and LPC) devices.
 	- How to do DMA with ISA (and LPC) devices.
-DMA-mapping.txt
-	- info for PCI drivers using DMA portably across all platforms.
 DocBook/
 DocBook/
 	- directory with DocBook templates etc. for kernel documentation.
 	- directory with DocBook templates etc. for kernel documentation.
 HOWTO
 HOWTO
@@ -43,8 +41,6 @@ ManagementStyle
 	- how to (attempt to) manage kernel hackers.
 	- how to (attempt to) manage kernel hackers.
 MSI-HOWTO.txt
 MSI-HOWTO.txt
 	- the Message Signaled Interrupts (MSI) Driver Guide HOWTO and FAQ.
 	- the Message Signaled Interrupts (MSI) Driver Guide HOWTO and FAQ.
-PCIEBUS-HOWTO.txt
-	- a guide describing the PCI Express Port Bus driver.
 RCU/
 RCU/
 	- directory with info on RCU (read-copy update).
 	- directory with info on RCU (read-copy update).
 README.DAC960
 README.DAC960
@@ -285,12 +281,6 @@ parport.txt
 	- how to use the parallel-port driver.
 	- how to use the parallel-port driver.
 parport-lowlevel.txt
 parport-lowlevel.txt
 	- description and usage of the low level parallel port functions.
 	- 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/
 pcmcia/
 	- info on the Linux PCMCIA driver.
 	- info on the Linux PCMCIA driver.
 pi-futex.txt
 pi-futex.txt

+ 12 - 0
Documentation/PCI/00-INDEX

@@ -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

+ 6 - 6
Documentation/PCIEBUS-HOWTO.txt → Documentation/PCI/PCIEBUS-HOWTO.txt

@@ -56,9 +56,9 @@ advantages of using the PCI Express Port Bus driver are listed below:
 
 
 	- Allow service drivers implemented in an independent
 	- Allow service drivers implemented in an independent
 	  staged approach.
 	  staged approach.
-	
+
 	- Allow one service driver to run on multiple PCI-PCI Bridge
 	- 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
 	- Manage and distribute resources of a PCI-PCI Bridge Port
 	  device to requested service drivers.
 	  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.
 imposes no impact on the functionality of existing service drivers.
 
 
 A service driver is required to use the two APIs shown below to
 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
 section 5.2.1 & 5.2.2). It is important that a service driver
 initializes the pcie_port_service_driver data structure, included in
 initializes the pcie_port_service_driver data structure, included in
 header file /include/linux/pcieport_if.h, before calling these APIs.
 header file /include/linux/pcieport_if.h, before calling these APIs.
@@ -137,7 +137,7 @@ driver.
 static int __init aerdrv_service_init(void)
 static int __init aerdrv_service_init(void)
 {
 {
 	int retval = 0;
 	int retval = 0;
-	
+
 	retval = pcie_port_service_register(&root_aerdrv);
 	retval = pcie_port_service_register(&root_aerdrv);
 	if (!retval) {
 	if (!retval) {
 		/*
 		/*
@@ -147,7 +147,7 @@ static int __init aerdrv_service_init(void)
 	return retval;
 	return retval;
 }
 }
 
 
-static void __exit aerdrv_service_exit(void) 
+static void __exit aerdrv_service_exit(void)
 {
 {
 	pcie_port_service_unregister(&root_aerdrv);
 	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
 request MSI based interrupts. A service driver may not know whether
 any other service drivers have run on this Root Port. If either one
 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
 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
 To avoid this situation all service drivers are not permitted to
 switch interrupt mode on its device. The PCI Express Port Bus driver
 switch interrupt mode on its device. The PCI Express Port Bus driver

+ 0 - 0
Documentation/pci-error-recovery.txt → Documentation/PCI/pci-error-recovery.txt


+ 1 - 1
Documentation/pci.txt → Documentation/PCI/pci.txt

@@ -119,7 +119,7 @@ initialization with a pointer to a structure describing the driver
 			the power state of a device before reboot.
 			the power state of a device before reboot.
 			e.g. drivers/net/e100.c.
 			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
 The ID table is an array of struct pci_device_id entries ending with an

+ 1 - 1
Documentation/pcieaer-howto.txt → Documentation/PCI/pcieaer-howto.txt

@@ -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
 well as how to enable the drivers of endpoint devices to conform with
 PCI Express AER driver.
 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?
 1.3 What is the PCI Express AER Driver?
 
 

+ 2 - 2
Documentation/memory-barriers.txt

@@ -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:
 	[*] 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
 	    Documentation/DMA-API.txt