mirror of
https://github.com/adulau/aha.git
synced 2024-12-28 11:46:19 +00:00
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>
This commit is contained in:
parent
681bf59721
commit
cffb2fafb7
5 changed files with 18 additions and 9 deletions
|
@ -190,16 +190,20 @@ X!Ekernel/module.c
|
||||||
!Edrivers/pci/pci.c
|
!Edrivers/pci/pci.c
|
||||||
!Edrivers/pci/pci-driver.c
|
!Edrivers/pci/pci-driver.c
|
||||||
!Edrivers/pci/remove.c
|
!Edrivers/pci/remove.c
|
||||||
!Edrivers/pci/pci-acpi.c
|
|
||||||
!Edrivers/pci/search.c
|
!Edrivers/pci/search.c
|
||||||
!Edrivers/pci/msi.c
|
!Edrivers/pci/msi.c
|
||||||
!Edrivers/pci/bus.c
|
!Edrivers/pci/bus.c
|
||||||
|
!Edrivers/pci/access.c
|
||||||
|
!Edrivers/pci/irq.c
|
||||||
|
!Edrivers/pci/htirq.c
|
||||||
<!-- FIXME: Removed for now since no structured comments in source
|
<!-- FIXME: Removed for now since no structured comments in source
|
||||||
X!Edrivers/pci/hotplug.c
|
X!Edrivers/pci/hotplug.c
|
||||||
-->
|
-->
|
||||||
!Edrivers/pci/probe.c
|
!Edrivers/pci/probe.c
|
||||||
|
!Edrivers/pci/slot.c
|
||||||
!Edrivers/pci/rom.c
|
!Edrivers/pci/rom.c
|
||||||
!Edrivers/pci/iov.c
|
!Edrivers/pci/iov.c
|
||||||
|
!Idrivers/pci/pci-sysfs.c
|
||||||
</sect1>
|
</sect1>
|
||||||
<sect1><title>PCI Hotplug Support Library</title>
|
<sect1><title>PCI Hotplug Support Library</title>
|
||||||
!Edrivers/pci/hotplug/pci_hotplug_core.c
|
!Edrivers/pci/hotplug/pci_hotplug_core.c
|
||||||
|
|
|
@ -87,8 +87,8 @@ EXPORT_SYMBOL(pci_read_vpd);
|
||||||
* pci_write_vpd - Write entry to Vital Product Data
|
* pci_write_vpd - Write entry to Vital Product Data
|
||||||
* @dev: pci device struct
|
* @dev: pci device struct
|
||||||
* @pos: offset in vpd space
|
* @pos: offset in vpd space
|
||||||
* @count: number of bytes to read
|
* @count: number of bytes to write
|
||||||
* @val: value to write
|
* @buf: buffer containing write data
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
ssize_t pci_write_vpd(struct pci_dev *dev, loff_t pos, size_t count, const void *buf)
|
ssize_t pci_write_vpd(struct pci_dev *dev, loff_t pos, size_t count, const void *buf)
|
||||||
|
|
|
@ -158,6 +158,7 @@ int ht_create_irq(struct pci_dev *dev, int idx)
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* ht_destroy_irq - destroy an irq created with ht_create_irq
|
* ht_destroy_irq - destroy an irq created with ht_create_irq
|
||||||
|
* @irq: irq to be destroyed
|
||||||
*
|
*
|
||||||
* This reverses ht_create_irq removing the specified irq from
|
* This reverses ht_create_irq removing the specified irq from
|
||||||
* existence. The irq should be free before this happens.
|
* existence. The irq should be free before this happens.
|
||||||
|
|
|
@ -492,6 +492,7 @@ write_vpd_attr(struct kobject *kobj, struct bin_attribute *bin_attr,
|
||||||
/**
|
/**
|
||||||
* pci_read_legacy_io - read byte(s) from legacy I/O port space
|
* pci_read_legacy_io - read byte(s) from legacy I/O port space
|
||||||
* @kobj: kobject corresponding to file to read from
|
* @kobj: kobject corresponding to file to read from
|
||||||
|
* @bin_attr: struct bin_attribute for this file
|
||||||
* @buf: buffer to store results
|
* @buf: buffer to store results
|
||||||
* @off: offset into legacy I/O port space
|
* @off: offset into legacy I/O port space
|
||||||
* @count: number of bytes to read
|
* @count: number of bytes to read
|
||||||
|
@ -517,6 +518,7 @@ pci_read_legacy_io(struct kobject *kobj, struct bin_attribute *bin_attr,
|
||||||
/**
|
/**
|
||||||
* pci_write_legacy_io - write byte(s) to legacy I/O port space
|
* pci_write_legacy_io - write byte(s) to legacy I/O port space
|
||||||
* @kobj: kobject corresponding to file to read from
|
* @kobj: kobject corresponding to file to read from
|
||||||
|
* @bin_attr: struct bin_attribute for this file
|
||||||
* @buf: buffer containing value to be written
|
* @buf: buffer containing value to be written
|
||||||
* @off: offset into legacy I/O port space
|
* @off: offset into legacy I/O port space
|
||||||
* @count: number of bytes to write
|
* @count: number of bytes to write
|
||||||
|
@ -733,9 +735,9 @@ pci_mmap_resource_wc(struct kobject *kobj, struct bin_attribute *attr,
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* pci_remove_resource_files - cleanup resource files
|
* pci_remove_resource_files - cleanup resource files
|
||||||
* @dev: dev to cleanup
|
* @pdev: dev to cleanup
|
||||||
*
|
*
|
||||||
* If we created resource files for @dev, remove them from sysfs and
|
* If we created resource files for @pdev, remove them from sysfs and
|
||||||
* free their resources.
|
* free their resources.
|
||||||
*/
|
*/
|
||||||
static void
|
static void
|
||||||
|
@ -793,9 +795,9 @@ static int pci_create_attr(struct pci_dev *pdev, int num, int write_combine)
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* pci_create_resource_files - create resource files in sysfs for @dev
|
* pci_create_resource_files - create resource files in sysfs for @dev
|
||||||
* @dev: dev in question
|
* @pdev: dev in question
|
||||||
*
|
*
|
||||||
* Walk the resources in @dev creating files for each resource available.
|
* Walk the resources in @pdev creating files for each resource available.
|
||||||
*/
|
*/
|
||||||
static int pci_create_resource_files(struct pci_dev *pdev)
|
static int pci_create_resource_files(struct pci_dev *pdev)
|
||||||
{
|
{
|
||||||
|
@ -829,6 +831,7 @@ void __weak pci_remove_resource_files(struct pci_dev *dev) { return; }
|
||||||
/**
|
/**
|
||||||
* pci_write_rom - used to enable access to the PCI ROM display
|
* pci_write_rom - used to enable access to the PCI ROM display
|
||||||
* @kobj: kernel object handle
|
* @kobj: kernel object handle
|
||||||
|
* @bin_attr: struct bin_attribute for this file
|
||||||
* @buf: user input
|
* @buf: user input
|
||||||
* @off: file offset
|
* @off: file offset
|
||||||
* @count: number of byte in input
|
* @count: number of byte in input
|
||||||
|
@ -852,6 +855,7 @@ pci_write_rom(struct kobject *kobj, struct bin_attribute *bin_attr,
|
||||||
/**
|
/**
|
||||||
* pci_read_rom - read a PCI ROM
|
* pci_read_rom - read a PCI ROM
|
||||||
* @kobj: kernel object handle
|
* @kobj: kernel object handle
|
||||||
|
* @bin_attr: struct bin_attribute for this file
|
||||||
* @buf: where to put the data we read from the ROM
|
* @buf: where to put the data we read from the ROM
|
||||||
* @off: file offset
|
* @off: file offset
|
||||||
* @count: number of bytes to read
|
* @count: number of bytes to read
|
||||||
|
|
|
@ -264,8 +264,8 @@ EXPORT_SYMBOL_GPL(pci_create_slot);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* pci_renumber_slot - update %struct pci_slot -> number
|
* pci_renumber_slot - update %struct pci_slot -> number
|
||||||
* @slot - %struct pci_slot to update
|
* @slot: &struct pci_slot to update
|
||||||
* @slot_nr - new number for slot
|
* @slot_nr: new number for slot
|
||||||
*
|
*
|
||||||
* The primary purpose of this interface is to allow callers who earlier
|
* The primary purpose of this interface is to allow callers who earlier
|
||||||
* created a placeholder slot in pci_create_slot() by passing a -1 as
|
* created a placeholder slot in pci_create_slot() by passing a -1 as
|
||||||
|
|
Loading…
Reference in a new issue