Skip to content

Commit

Permalink
pci hotplug: kernel-doc fixes
Browse files Browse the repository at this point in the history 
acpiphp.h: not using kernel-doc, so change /** to /*
acpiphp_core.c: lots of kernel-doc cleanups
acpiphp_glue.c: lots of kernel-doc cleanups
acpiphp_ibm.c: lots of kernel-doc cleanups
cpqphp_core.c: lots of kernel-doc cleanups
cpqphp_ctrl.c: lots of kernel-doc cleanups
fakephp.c:  correct kernel-doc notation
pciehp_ctrl.c: correct kernel-doc notation
rpadlpar_core.c: correct function names & kernel-doc notation
rpaphp_core.c: correct kernel-doc notation
shpchp_ctrl.c: correct kernel-doc notation

Signed-off-by: Randy Dunlap <randy.dunlap@oracle.com>
Cc: Kristen Accardi <kristen.c.accardi@intel.com>
Signed-off-by: Greg Kroah-Hartman <gregkh@suse.de>
  • Loading branch information
Randy Dunlap authored and Greg Kroah-Hartman committed Nov 28, 2007
1 parent d885c6b commit 26e6c66
Show file tree
Hide file tree
Showing 12 changed files with 169 additions and 169 deletions.
8 changes: 4 additions & 4 deletions drivers/pci/hotplug/acpiphp.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ struct slot {
char name[SLOT_NAME_SIZE];
};

/**
/*
* struct acpiphp_bridge - PCI bridge information
*
* for each bridge device in ACPI namespace
Expand Down Expand Up @@ -97,7 +97,7 @@ struct acpiphp_bridge {
};


/**
/*
* struct acpiphp_slot - PCI slot information
*
* PCI slot information for each *physical* PCI slot
Expand All @@ -118,7 +118,7 @@ struct acpiphp_slot {
};


/**
/*
* struct acpiphp_func - PCI function information
*
* PCI function information for each object in ACPI namespace
Expand All @@ -137,7 +137,7 @@ struct acpiphp_func {
u32 flags; /* see below */
};

/**
/*
* struct acpiphp_attention_info - device specific attention registration
*
* ACPI has no generic method of setting/getting attention status
Expand Down
29 changes: 12 additions & 17 deletions drivers/pci/hotplug/acpiphp_core.c
View file
Original file line number Diff line number Diff line change
Expand Up @@ -91,10 +91,10 @@ static struct hotplug_slot_ops acpi_hotplug_slot_ops = {
* acpiphp_register_attention - set attention LED callback
* @info: must be completely filled with LED callbacks
*
* Description: this is used to register a hardware specific ACPI
* Description: This is used to register a hardware specific ACPI
* driver that manipulates the attention LED. All the fields in
* info must be set.
**/
*/
int acpiphp_register_attention(struct acpiphp_attention_info *info)
{
int retval = -EINVAL;
Expand All @@ -112,10 +112,10 @@ int acpiphp_register_attention(struct acpiphp_attention_info *info)
* acpiphp_unregister_attention - unset attention LED callback
* @info: must match the pointer used to register
*
* Description: this is used to un-register a hardware specific acpi
* Description: This is used to un-register a hardware specific acpi
* driver that manipulates the attention LED. The pointer to the
* info struct must be the same as the one used to set it.
**/
*/
int acpiphp_unregister_attention(struct acpiphp_attention_info *info)
{
int retval = -EINVAL;
Expand All @@ -133,7 +133,6 @@ int acpiphp_unregister_attention(struct acpiphp_attention_info *info)
* @hotplug_slot: slot to enable
*
* Actual tasks are done in acpiphp_enable_slot()
*
*/
static int enable_slot(struct hotplug_slot *hotplug_slot)
{
Expand All @@ -151,7 +150,6 @@ static int enable_slot(struct hotplug_slot *hotplug_slot)
* @hotplug_slot: slot to disable
*
* Actual tasks are done in acpiphp_disable_slot()
*
*/
static int disable_slot(struct hotplug_slot *hotplug_slot)
{
Expand All @@ -168,15 +166,15 @@ static int disable_slot(struct hotplug_slot *hotplug_slot)
}


/**
* set_attention_status - set attention LED
/**
* set_attention_status - set attention LED
* @hotplug_slot: slot to set attention LED on
* @status: value to set attention LED to (0 or 1)
*
* attention status LED, so we use a callback that
* was registered with us. This allows hardware specific
* ACPI implementations to blink the light for us.
**/
*/
static int set_attention_status(struct hotplug_slot *hotplug_slot, u8 status)
{
int retval = -ENODEV;
Expand All @@ -199,7 +197,6 @@ static int disable_slot(struct hotplug_slot *hotplug_slot)
*
* Some platforms may not implement _STA method properly.
* In that case, the value returned may not be reliable.
*
*/
static int get_power_status(struct hotplug_slot *hotplug_slot, u8 *value)
{
Expand All @@ -213,16 +210,16 @@ static int get_power_status(struct hotplug_slot *hotplug_slot, u8 *value)
}


/**
/**
* get_attention_status - get attention LED status
* @hotplug_slot: slot to get status from
* @value: returns with value of attention LED
*
* ACPI doesn't have known method to determine the state
* of the attention status LED, so we use a callback that
* was registered with us. This allows hardware specific
* ACPI implementations to determine its state
**/
* ACPI implementations to determine its state.
*/
static int get_attention_status(struct hotplug_slot *hotplug_slot, u8 *value)
{
int retval = -EINVAL;
Expand All @@ -244,8 +241,7 @@ static int get_attention_status(struct hotplug_slot *hotplug_slot, u8 *value)
* @value: pointer to store status
*
* ACPI doesn't provide any formal means to access latch status.
* Instead, we fake latch status from _STA
*
* Instead, we fake latch status from _STA.
*/
static int get_latch_status(struct hotplug_slot *hotplug_slot, u8 *value)
{
Expand All @@ -265,8 +261,7 @@ static int get_latch_status(struct hotplug_slot *hotplug_slot, u8 *value)
* @value: pointer to store status
*
* ACPI doesn't provide any formal means to access adapter status.
* Instead, we fake adapter status from _STA
*
* Instead, we fake adapter status from _STA.
*/
static int get_adapter_status(struct hotplug_slot *hotplug_slot, u8 *value)
{
Expand Down
36 changes: 15 additions & 21 deletions drivers/pci/hotplug/acpiphp_glue.c
View file
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,6 @@ static void handle_hotplug_event_func(acpi_handle handle, u32 type, void *contex
* 2. has _PS0 method
* 3. has _PS3 method
* 4. ..
*
*/
static int is_ejectable(acpi_handle handle)
{
Expand Down Expand Up @@ -986,10 +985,8 @@ static int power_off_slot(struct acpiphp_slot *slot)


/**
* acpiphp_max_busnr - return the highest reserved bus number under
* the given bus.
* acpiphp_max_busnr - return the highest reserved bus number under the given bus.
* @bus: bus to start search with
*
*/
static unsigned char acpiphp_max_busnr(struct pci_bus *bus)
{
Expand Down Expand Up @@ -1018,7 +1015,6 @@ static unsigned char acpiphp_max_busnr(struct pci_bus *bus)
/**
* acpiphp_bus_add - add a new bus to acpi subsystem
* @func: acpiphp_func of the bridge
*
*/
static int acpiphp_bus_add(struct acpiphp_func *func)
{
Expand Down Expand Up @@ -1063,7 +1059,6 @@ static int acpiphp_bus_add(struct acpiphp_func *func)
/**
* acpiphp_bus_trim - trim a bus from acpi subsystem
* @handle: handle to acpi namespace
*
*/
static int acpiphp_bus_trim(acpi_handle handle)
{
Expand All @@ -1089,7 +1084,6 @@ static int acpiphp_bus_trim(acpi_handle handle)
*
* This function should be called per *physical slot*,
* not per each slot object in ACPI namespace.
*
*/
static int enable_device(struct acpiphp_slot *slot)
{
Expand Down Expand Up @@ -1185,6 +1179,7 @@ static void disable_bridges(struct pci_bus *bus)

/**
* disable_device - disable a slot
* @slot: ACPI PHP slot
*/
static int disable_device(struct acpiphp_slot *slot)
{
Expand Down Expand Up @@ -1240,14 +1235,15 @@ static int disable_device(struct acpiphp_slot *slot)

/**
* get_slot_status - get ACPI slot status
* @slot: ACPI PHP slot
*
* if a slot has _STA for each function and if any one of them
* returned non-zero status, return it
* If a slot has _STA for each function and if any one of them
* returned non-zero status, return it.
*
* if a slot doesn't have _STA and if any one of its functions'
* configuration space is configured, return 0x0f as a _STA
* If a slot doesn't have _STA and if any one of its functions'
* configuration space is configured, return 0x0f as a _STA.
*
* otherwise return 0
* Otherwise return 0.
*/
static unsigned int get_slot_status(struct acpiphp_slot *slot)
{
Expand Down Expand Up @@ -1281,6 +1277,7 @@ static unsigned int get_slot_status(struct acpiphp_slot *slot)

/**
* acpiphp_eject_slot - physically eject the slot
* @slot: ACPI PHP slot
*/
int acpiphp_eject_slot(struct acpiphp_slot *slot)
{
Expand Down Expand Up @@ -1314,6 +1311,7 @@ int acpiphp_eject_slot(struct acpiphp_slot *slot)

/**
* acpiphp_check_bridge - re-enumerate devices
* @bridge: where to begin re-enumeration
*
* Iterate over all slots under this bridge and make sure that if a
* card is present they are enabled, and if not they are disabled.
Expand Down Expand Up @@ -1538,13 +1536,11 @@ check_sub_bridges(acpi_handle handle, u32 lvl, void *context, void **rv)

/**
* handle_hotplug_event_bridge - handle ACPI event on bridges
*
* @handle: Notify()'ed acpi_handle
* @type: Notify code
* @context: pointer to acpiphp_bridge structure
*
* handles ACPI event notification on {host,p2p} bridges
*
* Handles ACPI event notification on {host,p2p} bridges.
*/
static void handle_hotplug_event_bridge(acpi_handle handle, u32 type, void *context)
{
Expand Down Expand Up @@ -1634,13 +1630,11 @@ static void handle_hotplug_event_bridge(acpi_handle handle, u32 type, void *cont

/**
* handle_hotplug_event_func - handle ACPI event on functions (i.e. slots)
*
* @handle: Notify()'ed acpi_handle
* @type: Notify code
* @context: pointer to acpiphp_func structure
*
* handles ACPI event notification on slots
*
* Handles ACPI event notification on slots.
*/
static void handle_hotplug_event_func(acpi_handle handle, u32 type, void *context)
{
Expand Down Expand Up @@ -1705,7 +1699,6 @@ static struct acpi_pci_driver acpi_pci_hp_driver = {

/**
* acpiphp_glue_init - initializes all PCI hotplug - ACPI glue data structures
*
*/
int __init acpiphp_glue_init(void)
{
Expand All @@ -1726,7 +1719,7 @@ int __init acpiphp_glue_init(void)
/**
* acpiphp_glue_exit - terminates all PCI hotplug - ACPI glue data structures
*
* This function frees all data allocated in acpiphp_glue_init()
* This function frees all data allocated in acpiphp_glue_init().
*/
void acpiphp_glue_exit(void)
{
Expand Down Expand Up @@ -1760,7 +1753,6 @@ int __init acpiphp_get_num_slots(void)
* acpiphp_for_each_slot - call function for each slot
* @fn: callback function
* @data: context to be passed to callback function
*
*/
static int acpiphp_for_each_slot(acpiphp_callback fn, void *data)
{
Expand All @@ -1786,6 +1778,7 @@ static int acpiphp_for_each_slot(acpiphp_callback fn, void *data)

/**
* acpiphp_enable_slot - power on slot
* @slot: ACPI PHP slot
*/
int acpiphp_enable_slot(struct acpiphp_slot *slot)
{
Expand Down Expand Up @@ -1815,6 +1808,7 @@ int acpiphp_enable_slot(struct acpiphp_slot *slot)

/**
* acpiphp_disable_slot - power off slot
* @slot: ACPI PHP slot
*/
int acpiphp_disable_slot(struct acpiphp_slot *slot)
{
Expand Down
Loading

0 comments on commit 26e6c66

Please sign in to comment.