PCI: hotplug: Fix kernel-doc formatting and add missing documentation
PATCH v2 1/1 PCI: hotplug: Fix kernel-doc formatting and add missing documentation
Fix kernel-doc formatting and add missing documentation for the parameters "bus" of the get_slot_mapping() function, "t" of the cpqhp_pushbutton_thread() function and "controller" of the inband_presence_disabled() function.
Also remove surplus parameter "slot" from the description of the function cpqhp_pushbutton_thread().
Thus, resolve build time warnings related to kernel-doc:
drivers/pci/hotplug/cpqphp_core.c:308: warning: Function parameter or member 'bus' not described in 'get_slot_mapping' drivers/pci/hotplug/cpqphp_core.c:308: warning: Function parameter or member 'bus_num' not described in 'get_slot_mapping' drivers/pci/hotplug/cpqphp_core.c:308: warning: Function parameter or member 'dev_num' not described in 'get_slot_mapping' drivers/pci/hotplug/cpqphp_core.c:308: warning: Function parameter or member 'slot' not described in 'get_slot_mapping'
drivers/pci/hotplug/cpqphp_ctrl.c:1887: warning: Function parameter or member 't' not described in 'cpqhp_pushbutton_thread' drivers/pci/hotplug/cpqphp_ctrl.c:1887: warning: Excess function parameter 'slot' description in 'cpqhp_pushbutton_thread'
drivers/pci/hotplug/pciehp.h:110: warning: Function parameter or member 'inband_presence_disabled' not described in 'controller'
No change to functionality intended.
--- drivers/pci/hotplug/cpqphp_core.c | 16 ++++--- drivers/pci/hotplug/cpqphp_ctrl.c | 4 +- drivers/pci/hotplug/pciehp.h | 80 ++++++++++++++++++------------- 3 files changed, 59 insertions(+), 41 deletions(-)
drivers/pci/hotplug/cpqphp_core.c +9 -7
@@ -292,15 +292,17 @@ static int ctrl_slot_cleanup(struct controller *ctrl)/** -* get_slot_mapping - determine logical slot mapping for PCI device +* get_slot_mapping - Determine logical slot mapping for PCI device. +* @bus: Pointer to the PCI bus structure. +* @bus_num: Bus number of the PCI device. +* @dev_num: Device number of the PCI device. +* @slot: Pointer to where slot number will be returned. * -* Won't work for more than one PCI-PCI bridge in a slot. +* Will not work for more than one PCI-PCI bridge in a slot. * -* @bus_num - bus number of PCI device -* @dev_num - device number of PCI device -* @slot - Pointer to u8 where slot number will be returned -* -* Output: SUCCESS or FAILURE +* Return: +* * 0 - Logical slot mapping has been found for this PCI device. +* * < 0 - Unable to find entry in the routing table for this PCI device. */ static int get_slot_mapping (struct pci_bus *bus,u8 bus_num,u8 dev_num,u8 *slot)
drivers/pci/hotplug/cpqphp_ctrl.c +2 -2
@@ -1876,8 +1876,8 @@ static void interrupt_event_handler(struct controller *ctrl)/** -* cpqhp_pushbutton_thread - handle pushbutton events -* @slot: target slot (struct) +* cpqhp_pushbutton_thread - Handle pushbutton events. +* @t: Pointer to struct timer_list which holds all timer related callbacks. * * Scheduled procedure to handle blocking stuff for the pushbuttons. * Handles all pending events and exits.
drivers/pci/hotplug/pciehp.h +48 -32
86 lines not on this page · raw message
Signature · 1 line
2.32.0
Hi Bjorn,
This version has been superseded by v3 where I added more hotplug-related kernel-doc fixes.
Krzysztof