OpenE2K
/
linux
6
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

[PATCH] DMI: cleanup kernel-doc, add to DocBook 

Add DMI interface functions to a new Firmware Interfaces chapter in the
kernel-api DocBook.  Clean up kernel-doc in drivers/firmware/dmi_scan.c.

Signed-off-by: Randy Dunlap <rdunlap@xenotime.net>
Signed-off-by: Andrew Morton <akpm@osdl.org>
Signed-off-by: Linus Torvalds <torvalds@osdl.org>
This commit is contained in:
Randy Dunlap 2006-06-25 05:49:18 -07:00 committed by Linus Torvalds
parent e905914f96
commit b0ef371e3f
2 changed files with 18 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
Documentation/DocBook/kernel-api.tmpl
View File

@ -304,12 +304,13 @@ X!Ekernel/module.c
<sect1><title>MTRR Handling</title> <sect1><title>MTRR Handling</title>
!Earch/i386/kernel/cpu/mtrr/main.c !Earch/i386/kernel/cpu/mtrr/main.c
</sect1> </sect1>
<sect1><title>PCI Support Library</title> <sect1><title>PCI Support Library</title>
!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/pci-acpi.c
<!-- kerneldoc does not understand to __devinit <!-- kerneldoc does not understand __devinit
X!Edrivers/pci/search.c X!Edrivers/pci/search.c
--> -->
!Edrivers/pci/msi.c !Edrivers/pci/msi.c
@ -338,6 +339,13 @@ X!Earch/i386/kernel/mca.c
</sect1> </sect1>
</chapter> </chapter>
<chapter id="firmware">
<title>Firmware Interfaces</title>
<sect1><title>DMI Interfaces</title>
!Edrivers/firmware/dmi_scan.c
</sect1>
</chapter>
<chapter id="devfs"> <chapter id="devfs">
<title>The Device File System</title> <title>The Device File System</title>
!Efs/devfs/base.c !Efs/devfs/base.c

13
drivers/firmware/dmi_scan.c
View File

@ -255,10 +255,15 @@ void __init dmi_scan_machine(void)
/** /**
* dmi_check_system - check system DMI data * dmi_check_system - check system DMI data
* @list: array of dmi_system_id structures to match against * @list: array of dmi_system_id structures to match against
* All non-null elements of the list must match
* their slot's (field index's) data (i.e., each
* list string must be a substring of the specified
* DMI slot's string data) to be considered a
* successful match.
* *
* Walk the blacklist table running matching functions until someone * Walk the blacklist table running matching functions until someone
* returns non zero or we hit the end. Callback function is called for * returns non zero or we hit the end. Callback function is called for
* each successfull match. Returns the number of matches. * each successful match. Returns the number of matches.
*/ */
int dmi_check_system(struct dmi_system_id *list) int dmi_check_system(struct dmi_system_id *list)
{ {
@ -287,7 +292,7 @@ EXPORT_SYMBOL(dmi_check_system);
/** /**
* dmi_get_system_info - return DMI data value * dmi_get_system_info - return DMI data value
* @field: data index (see enum dmi_filed) * @field: data index (see enum dmi_field)
* *
* Returns one DMI data value, can be used to perform * Returns one DMI data value, can be used to perform
* complex DMI data checks. * complex DMI data checks.
@ -301,13 +306,13 @@ EXPORT_SYMBOL(dmi_get_system_info);
/** /**
* dmi_find_device - find onboard device by type/name * dmi_find_device - find onboard device by type/name
* @type: device type or %DMI_DEV_TYPE_ANY to match all device types * @type: device type or %DMI_DEV_TYPE_ANY to match all device types
* @desc: device name string or %NULL to match all * @name: device name string or %NULL to match all
* @from: previous device found in search, or %NULL for new search. * @from: previous device found in search, or %NULL for new search.
* *
* Iterates through the list of known onboard devices. If a device is * Iterates through the list of known onboard devices. If a device is
* found with a matching @vendor and @device, a pointer to its device * found with a matching @vendor and @device, a pointer to its device
* structure is returned. Otherwise, %NULL is returned. * structure is returned. Otherwise, %NULL is returned.
* A new search is initiated by passing %NULL to the @from argument. * A new search is initiated by passing %NULL as the @from argument.
* If @from is not %NULL, searches continue from next device. * If @from is not %NULL, searches continue from next device.
*/ */
struct dmi_device * dmi_find_device(int type, const char *name, struct dmi_device * dmi_find_device(int type, const char *name,