Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 229b4e07 authored by Changbin Du's avatar Changbin Du Committed by Bjorn Helgaas
Browse files

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: default avatarChangbin 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: default avatarBjorn Helgaas <bhelgaas@google.com>
Reviewed-by: default avatarMauro Carvalho Chehab <mchehab+samsung@kernel.org>
parent c42eaffa

Documentation/PCI/index.rst

+2 −0
Original line number Diff line number Diff line
@@ -7,3 +7,5 @@ Linux PCI Bus Subsystem 
.. toctree::

   :maxdepth: 2

   :numbered:



   pci

Documentation/PCI/pci.txt→Documentation/PCI/pci.rst

+149 −207

File changed and moved.

Preview size limit exceeded, changes collapsed.

include/linux/mod_devicetable.h

+24 −5
Original line number Diff line number Diff line
@@ -16,6 +16,25 @@ typedef unsigned long kernel_ulong_t; 


#define PCI_ANY_ID (~0)



/**

 * struct pci_device_id - PCI device ID structure

 * @vendor:		Vendor ID to match (or PCI_ANY_ID)

 * @device:		Device ID to match (or PCI_ANY_ID)

 * @subvendor:		Subsystem vendor ID to match (or PCI_ANY_ID)

 * @subdevice:		Subsystem device ID to match (or PCI_ANY_ID)

 * @class:		Device class, subclass, and "interface" to match.

 *			See Appendix D of the PCI Local Bus Spec or

 *			include/linux/pci_ids.h for a full list of classes.

 *			Most drivers do not need to specify class/class_mask

 *			as vendor/device is normally sufficient.

 * @class_mask:		Limit which sub-fields of the class field are compared.

 *			See drivers/scsi/sym53c8xx_2/ for example of usage.

 * @driver_data:	Data private to the driver.

 *			Most drivers don't need to use driver_data field.

 *			Best practice is to use driver_data as an index

 *			into a static list of equivalent device types,

 *			instead of using it as a pointer.

 */

struct pci_device_id {

	__u32 vendor, device;		/* Vendor and device ID or PCI_ANY_ID*/

	__u32 subvendor, subdevice;	/* Subsystem ID's or PCI_ANY_ID */

include/linux/pci.h

+47 −1

File changed.

Preview size limit exceeded, changes collapsed.