[PATCH] Document pci_disable_device()

[PATCH] Document pci_disable_device()

[Bjorn Helgaas]

Add documentation for pci_disable_device().  We don't actually
deallocate IRQ resources in pci_disable_device() yet, but I suspect
we'll need to do so soon.

Signed-off-by: Bjorn Helgaas <bjorn.helgaas@hp.com>

===== Documentation/pci.txt 1.12 vs edited =====
--- 1.12/Documentation/pci.txt	2004-06-11 15:09:58 -06:00
+++ edited/Documentation/pci.txt	2004-08-03 14:20:22 -06:00
@@ -25,6 +25,7 @@
 	Discover resources (addresses and IRQ numbers) provided by the device
 	Allocate these resources
 	Communicate with the device
+	Disable the device
 
 Most of these topics are covered by the following sections, for the rest
 look at <linux/pci.h>, it's hopefully well commented.
@@ -162,8 +163,8 @@
 count on these devices by calling pci_dev_put().
 
 
-3. Enabling devices
-~~~~~~~~~~~~~~~~~~~
+3. Enabling and disabling devices
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    Before you do anything with the device you've found, you need to enable
 it by calling pci_enable_device() which enables I/O and memory regions of
 the device, allocates an IRQ if necessary, assigns missing resources if
@@ -179,6 +180,12 @@
 and also ensures that the cache line size register is set correctly.
 Make sure to check the return value of pci_set_mwi(), not all architectures
 may support Memory-Write-Invalidate.
+
+   If your driver decides to stop using the device (e.g., there was an
+error while setting it up or the driver module is being unloaded), it
+should call pci_disable_device() to deallocate any IRQ resources, disable
+PCI bus-mastering, etc.  You should not do anything with the device after
+calling pci_disable_device().
 
 4. How to access PCI config space
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Re: [PATCH] Document pci_disable_device()

[Greg KH]

On Tue, Aug 03, 2004 at 02:26:29PM -0600, Bjorn Helgaas wrote:
> Add documentation for pci_disable_device().  We don't actually
> deallocate IRQ resources in pci_disable_device() yet, but I suspect
> we'll need to do so soon.

Applied, thanks,

greg k-h