diff options
| author | Randy Dunlap <randy.dunlap@oracle.com> | 2009-04-10 18:17:50 -0400 |
|---|---|---|
| committer | Jesse Barnes <jbarnes@virtuousgeek.org> | 2009-04-22 17:49:33 -0400 |
| commit | cffb2fafb726c898fec1c5ae33717741f94fda83 (patch) | |
| tree | eba298bb6cdd5b4dce0d5ebc0598f3b2b3f378ed | |
| parent | 681bf597215c62bd6f5ae1180a58a38997122b5b (diff) | |
docbooks: add/fix PCI kernel-doc
Add drivers/pci/*.c source files to DocBook/kernel-api.tmpl
and update those pci/*.c source files that need kernel-doc fixes.
Signed-off-by: Randy Dunlap <randy.dunlap@oracle.com>
Signed-off-by: Jesse Barnes <jbarnes@virtuousgeek.org>
| -rw-r--r-- | Documentation/DocBook/kernel-api.tmpl | 6 | ||||
| -rw-r--r-- | drivers/pci/access.c | 4 | ||||
| -rw-r--r-- | drivers/pci/htirq.c | 1 | ||||
| -rw-r--r-- | drivers/pci/pci-sysfs.c | 12 | ||||
| -rw-r--r-- | drivers/pci/slot.c | 4 |
5 files changed, 18 insertions, 9 deletions
diff --git a/Documentation/DocBook/kernel-api.tmpl b/Documentation/DocBook/kernel-api.tmpl index d6ac5d61820e..44b3def961a2 100644 --- a/Documentation/DocBook/kernel-api.tmpl +++ b/Documentation/DocBook/kernel-api.tmpl | |||
| @@ -190,16 +190,20 @@ X!Ekernel/module.c | |||
| 190 | !Edrivers/pci/pci.c | 190 | !Edrivers/pci/pci.c |
| 191 | !Edrivers/pci/pci-driver.c | 191 | !Edrivers/pci/pci-driver.c |
| 192 | !Edrivers/pci/remove.c | 192 | !Edrivers/pci/remove.c |
| 193 | !Edrivers/pci/pci-acpi.c | ||
| 194 | !Edrivers/pci/search.c | 193 | !Edrivers/pci/search.c |
| 195 | !Edrivers/pci/msi.c | 194 | !Edrivers/pci/msi.c |
| 196 | !Edrivers/pci/bus.c | 195 | !Edrivers/pci/bus.c |
| 196 | !Edrivers/pci/access.c | ||
| 197 | !Edrivers/pci/irq.c | ||
| 198 | !Edrivers/pci/htirq.c | ||
| 197 | <!-- FIXME: Removed for now since no structured comments in source | 199 | <!-- FIXME: Removed for now since no structured comments in source |
| 198 | X!Edrivers/pci/hotplug.c | 200 | X!Edrivers/pci/hotplug.c |
| 199 | --> | 201 | --> |
| 200 | !Edrivers/pci/probe.c | 202 | !Edrivers/pci/probe.c |
| 203 | !Edrivers/pci/slot.c | ||
| 201 | !Edrivers/pci/rom.c | 204 | !Edrivers/pci/rom.c |
| 202 | !Edrivers/pci/iov.c | 205 | !Edrivers/pci/iov.c |
| 206 | !Idrivers/pci/pci-sysfs.c | ||
| 203 | </sect1> | 207 | </sect1> |
| 204 | <sect1><title>PCI Hotplug Support Library</title> | 208 | <sect1><title>PCI Hotplug Support Library</title> |
| 205 | !Edrivers/pci/hotplug/pci_hotplug_core.c | 209 | !Edrivers/pci/hotplug/pci_hotplug_core.c |
diff --git a/drivers/pci/access.c b/drivers/pci/access.c index 64dd7df90e62..0f3706512686 100644 --- a/drivers/pci/access.c +++ b/drivers/pci/access.c | |||
| @@ -87,8 +87,8 @@ EXPORT_SYMBOL(pci_read_vpd); | |||
| 87 | * pci_write_vpd - Write entry to Vital Product Data | 87 | * pci_write_vpd - Write entry to Vital Product Data |
| 88 | * @dev: pci device struct | 88 | * @dev: pci device struct |
| 89 | * @pos: offset in vpd space | 89 | * @pos: offset in vpd space |
| 90 | * @count: number of bytes to read | 90 | * @count: number of bytes to write |
| 91 | * @val: value to write | 91 | * @buf: buffer containing write data |
| 92 | * | 92 | * |
| 93 | */ | 93 | */ |
| 94 | ssize_t pci_write_vpd(struct pci_dev *dev, loff_t pos, size_t count, const void *buf) | 94 | ssize_t pci_write_vpd(struct pci_dev *dev, loff_t pos, size_t count, const void *buf) |
diff --git a/drivers/pci/htirq.c b/drivers/pci/htirq.c index bf7d6ce9bbb3..6808d8333ecc 100644 --- a/drivers/pci/htirq.c +++ b/drivers/pci/htirq.c | |||
| @@ -158,6 +158,7 @@ int ht_create_irq(struct pci_dev *dev, int idx) | |||
| 158 | 158 | ||
| 159 | /** | 159 | /** |
| 160 | * ht_destroy_irq - destroy an irq created with ht_create_irq | 160 | * ht_destroy_irq - destroy an irq created with ht_create_irq |
| 161 | * @irq: irq to be destroyed | ||
| 161 | * | 162 | * |
| 162 | * This reverses ht_create_irq removing the specified irq from | 163 | * This reverses ht_create_irq removing the specified irq from |
| 163 | * existence. The irq should be free before this happens. | 164 | * existence. The irq should be free before this happens. |
diff --git a/drivers/pci/pci-sysfs.c b/drivers/pci/pci-sysfs.c index a7eb1b46a5a8..85ebd02a64a7 100644 --- a/drivers/pci/pci-sysfs.c +++ b/drivers/pci/pci-sysfs.c | |||
| @@ -492,6 +492,7 @@ write_vpd_attr(struct kobject *kobj, struct bin_attribute *bin_attr, | |||
| 492 | /** | 492 | /** |
| 493 | * pci_read_legacy_io - read byte(s) from legacy I/O port space | 493 | * pci_read_legacy_io - read byte(s) from legacy I/O port space |
| 494 | * @kobj: kobject corresponding to file to read from | 494 | * @kobj: kobject corresponding to file to read from |
| 495 | * @bin_attr: struct bin_attribute for this file | ||
| 495 | * @buf: buffer to store results | 496 | * @buf: buffer to store results |
| 496 | * @off: offset into legacy I/O port space | 497 | * @off: offset into legacy I/O port space |
| 497 | * @count: number of bytes to read | 498 | * @count: number of bytes to read |
| @@ -517,6 +518,7 @@ pci_read_legacy_io(struct kobject *kobj, struct bin_attribute *bin_attr, | |||
| 517 | /** | 518 | /** |
| 518 | * pci_write_legacy_io - write byte(s) to legacy I/O port space | 519 | * pci_write_legacy_io - write byte(s) to legacy I/O port space |
| 519 | * @kobj: kobject corresponding to file to read from | 520 | * @kobj: kobject corresponding to file to read from |
| 521 | * @bin_attr: struct bin_attribute for this file | ||
| 520 | * @buf: buffer containing value to be written | 522 | * @buf: buffer containing value to be written |
| 521 | * @off: offset into legacy I/O port space | 523 | * @off: offset into legacy I/O port space |
| 522 | * @count: number of bytes to write | 524 | * @count: number of bytes to write |
| @@ -733,9 +735,9 @@ pci_mmap_resource_wc(struct kobject *kobj, struct bin_attribute *attr, | |||
| 733 | 735 | ||
| 734 | /** | 736 | /** |
| 735 | * pci_remove_resource_files - cleanup resource files | 737 | * pci_remove_resource_files - cleanup resource files |
| 736 | * @dev: dev to cleanup | 738 | * @pdev: dev to cleanup |
| 737 | * | 739 | * |
| 738 | * If we created resource files for @dev, remove them from sysfs and | 740 | * If we created resource files for @pdev, remove them from sysfs and |
| 739 | * free their resources. | 741 | * free their resources. |
| 740 | */ | 742 | */ |
| 741 | static void | 743 | static void |
| @@ -793,9 +795,9 @@ static int pci_create_attr(struct pci_dev *pdev, int num, int write_combine) | |||
| 793 | 795 | ||
| 794 | /** | 796 | /** |
| 795 | * pci_create_resource_files - create resource files in sysfs for @dev | 797 | * pci_create_resource_files - create resource files in sysfs for @dev |
| 796 | * @dev: dev in question | 798 | * @pdev: dev in question |
| 797 | * | 799 | * |
| 798 | * Walk the resources in @dev creating files for each resource available. | 800 | * Walk the resources in @pdev creating files for each resource available. |
| 799 | */ | 801 | */ |
| 800 | static int pci_create_resource_files(struct pci_dev *pdev) | 802 | static int pci_create_resource_files(struct pci_dev *pdev) |
| 801 | { | 803 | { |
| @@ -829,6 +831,7 @@ void __weak pci_remove_resource_files(struct pci_dev *dev) { return; } | |||
| 829 | /** | 831 | /** |
| 830 | * pci_write_rom - used to enable access to the PCI ROM display | 832 | * pci_write_rom - used to enable access to the PCI ROM display |
| 831 | * @kobj: kernel object handle | 833 | * @kobj: kernel object handle |
| 834 | * @bin_attr: struct bin_attribute for this file | ||
| 832 | * @buf: user input | 835 | * @buf: user input |
| 833 | * @off: file offset | 836 | * @off: file offset |
| 834 | * @count: number of byte in input | 837 | * @count: number of byte in input |
| @@ -852,6 +855,7 @@ pci_write_rom(struct kobject *kobj, struct bin_attribute *bin_attr, | |||
| 852 | /** | 855 | /** |
| 853 | * pci_read_rom - read a PCI ROM | 856 | * pci_read_rom - read a PCI ROM |
| 854 | * @kobj: kernel object handle | 857 | * @kobj: kernel object handle |
| 858 | * @bin_attr: struct bin_attribute for this file | ||
| 855 | * @buf: where to put the data we read from the ROM | 859 | * @buf: where to put the data we read from the ROM |
| 856 | * @off: file offset | 860 | * @off: file offset |
| 857 | * @count: number of bytes to read | 861 | * @count: number of bytes to read |
diff --git a/drivers/pci/slot.c b/drivers/pci/slot.c index 21189447e545..fe95ce20bcbd 100644 --- a/drivers/pci/slot.c +++ b/drivers/pci/slot.c | |||
| @@ -264,8 +264,8 @@ EXPORT_SYMBOL_GPL(pci_create_slot); | |||
| 264 | 264 | ||
| 265 | /** | 265 | /** |
| 266 | * pci_renumber_slot - update %struct pci_slot -> number | 266 | * pci_renumber_slot - update %struct pci_slot -> number |
| 267 | * @slot - %struct pci_slot to update | 267 | * @slot: &struct pci_slot to update |
| 268 | * @slot_nr - new number for slot | 268 | * @slot_nr: new number for slot |
| 269 | * | 269 | * |
| 270 | * The primary purpose of this interface is to allow callers who earlier | 270 | * The primary purpose of this interface is to allow callers who earlier |
| 271 | * created a placeholder slot in pci_create_slot() by passing a -1 as | 271 | * created a placeholder slot in pci_create_slot() by passing a -1 as |
