Documentation: PCI: convert pci.txt to reST

Convert plain text documentation to reStructuredText format and add it to
Sphinx TOC tree.  No essential content change.

Move the description of struct pci_driver and struct pci_device_id into
in-source comments.

Signed-off-by: Changbin Du <changbin.du@gmail.com>
[bhelgaas: fix kernel-doc warnings related to moving descriptions to
linux/pci.h, fix "space tab" whitespace errors in mod_devicetable.h]
Signed-off-by: Bjorn Helgaas <bhelgaas@google.com>
Reviewed-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>

1 files changed, 47 insertions, 1 deletions

diff --git a/include/linux/pci.h b/include/linux/pci.h
index 4a5a84d7bdd4..b74b2a4e6df2 100644
--- a/include/linux/pci.h
+++ b/include/linux/pci.h
@@ -151,6 +151,8 @@ static inline const char *pci_power_name(pci_power_t state)
 #define PCI_PM_BUS_WAIT         50
 
 /**
+ * typedef pci_channel_state_t
+ *
  * The pci_channel state describes connectivity between the CPU and
  * the PCI device.  If some PCI bus between here and the PCI device
  * has crashed or locked up, this info is reflected here.
@@ -775,6 +777,50 @@ struct pci_error_handlers {
 
 
 struct module;
+
+/**
+ * struct pci_driver - PCI driver structure
+ * @node:       List of driver structures.
+ * @name:       Driver name.
+ * @id_table:   Pointer to table of device IDs the driver is
+ *              interested in.  Most drivers should export this
+ *              table using MODULE_DEVICE_TABLE(pci,...).
+ * @probe:      This probing function gets called (during execution
+ *              of pci_register_driver() for already existing
+ *              devices or later if a new device gets inserted) for
+ *              all PCI devices which match the ID table and are not
+ *              "owned" by the other drivers yet. This function gets
+ *              passed a "struct pci_dev \*" for each device whose
+ *              entry in the ID table matches the device. The probe
+ *              function returns zero when the driver chooses to
+ *              take "ownership" of the device or an error code
+ *              (negative number) otherwise.
+ *              The probe function always gets called from process
+ *              context, so it can sleep.
+ * @remove:     The remove() function gets called whenever a device
+ *              being handled by this driver is removed (either during
+ *              deregistration of the driver or when it's manually
+ *              pulled out of a hot-pluggable slot).
+ *              The remove function always gets called from process
+ *              context, so it can sleep.
+ * @suspend:    Put device into low power state.
+ * @suspend_late: Put device into low power state.
+ * @resume_early: Wake device from low power state.
+ * @resume:     Wake device from low power state.
+ *              (Please see Documentation/power/pci.txt for descriptions
+ *              of PCI Power Management and the related functions.)
+ * @shutdown:   Hook into reboot_notifier_list (kernel/sys.c).
+ *              Intended to stop any idling DMA operations.
+ *              Useful for enabling wake-on-lan (NIC) or changing
+ *              the power state of a device before reboot.
+ *              e.g. drivers/net/e100.c.
+ * @sriov_configure: Optional driver callback to allow configuration of
+ *              number of VFs to enable via sysfs "sriov_numvfs" file.
+ * @err_handler: See Documentation/PCI/pci-error-recovery.rst
+ * @groups:     Sysfs attribute groups.
+ * @driver:     Driver model structure.
+ * @dynids:     List of dynamically added device IDs.
+ */
 struct pci_driver {
         struct list_head        node;
         const char              *name;
@@ -2206,7 +2252,7 @@ static inline u8 pci_vpd_srdt_tag(const u8 *srdt)
 
 /**
  * pci_vpd_info_field_size - Extracts the information field length
- * @lrdt: Pointer to the beginning of an information field header
+ * @info_field: Pointer to the beginning of an information field header
  *
  * Returns the extracted information field length.
  */