Skip to content

Commit

Permalink
ACPI / hotplug / PCI: Proper kerneldoc comments for enumeration/removal
Browse files Browse the repository at this point in the history
Add proper kerneldoc comments describing acpiphp_enumerate_slots()
and acpiphp_remove_slots().

Signed-off-by: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
Tested-by: Mika Westerberg <mika.westerberg@linux.intel.com>
  • Loading branch information
rafaeljw committed Feb 5, 2014
1 parent 1c0c544 commit 454481a
Showing 1 changed file with 10 additions and 4 deletions.
14 changes: 10 additions & 4 deletions drivers/pci/hotplug/acpiphp_glue.c
Original file line number Diff line number Diff line change
Expand Up @@ -1001,9 +1001,12 @@ static void handle_hotplug_event(acpi_handle handle, u32 type, void *data)
acpi_evaluate_hotplug_ost(handle, type, ost_code, NULL);
}

/*
* Create hotplug slots for the PCI bus.
* It should always return 0 to avoid skipping following notifiers.
/**
* acpiphp_enumerate_slots - Enumerate PCI slots for a given bus.
* @bus: PCI bus to enumerate the slots for.
*
* A "slot" is an object associated with a PCI device number. All functions
* (PCI devices) with the same bus and device number belong to the same slot.
*/
void acpiphp_enumerate_slots(struct pci_bus *bus)
{
Expand Down Expand Up @@ -1076,7 +1079,10 @@ void acpiphp_enumerate_slots(struct pci_bus *bus)
}
}

/* Destroy hotplug slots associated with the PCI bus */
/**
* acpiphp_remove_slots - Remove slot objects associated with a given bus.
* @bus: PCI bus to remove the slot objects for.
*/
void acpiphp_remove_slots(struct pci_bus *bus)
{
struct acpiphp_bridge *bridge;
Expand Down

0 comments on commit 454481a

Please sign in to comment.