PCI: Fix kernel-doc formatting
Subsystems (4)
PATCH 1/5 PCI: Fix kernel-doc formatting
Fix kernel-doc formatting of function pci_dev_set_io_state(), and resolve build time warnings related to kernel-doc:
drivers/pci/pci.h:337: warning: Function parameter or member 'dev' not described in 'pci_dev_set_io_state' drivers/pci/pci.h:337: warning: Function parameter or member 'new' not described in 'pci_dev_set_io_state'
No change to functionality intended.
--- drivers/pci/pci.h | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)
drivers/pci/pci.h +2 -2
@@ -324,8 +324,8 @@ struct pci_sriov {/** * pci_dev_set_io_state - Set the new error state if possible. * -* @dev - pci device to set new error_state -* @new - the state we want dev to be in +* @dev: pci device to set new error_state +* @new: the state we want dev to be in * * Must be called with device_lock held. *
Signature · 1 line
2.32.0
PATCH 2/5 PCI: iproc: Fix kernel-doc formatting
Fix kernel-doc formatting used to describe structs, enum types and functions in the pcie-iproc.c, pcie-iproc-msi.c and pcie-iproc.h files.
Also, add documentation for the "mem" member of the struct iproc_pcie, and the enum values "IPROC_PCIE_IB_MAP_MEM", "IPROC_PCIE_IB_MAP_IO" and "IPROC_PCIE_IB_MAP_INVALID" of the enum iproc_pcie_ib_map_type.
Thus, resolve the following build time warning related to kernel-doc:
drivers/pci/controller/pcie-iproc.c:92: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst drivers/pci/controller/pcie-iproc.c:139: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst drivers/pci/controller/pcie-iproc.c:153: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst drivers/pci/controller/pcie-iproc.c:441: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst drivers/pci/controller/pcie-iproc.c:623: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst drivers/pci/controller/pcie-iproc.c:901: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst drivers/pci/controller/pcie-iproc.c:151: warning: Enum value 'IPROC_PCIE_IB_MAP_MEM' not described in enum 'iproc_pcie_ib_map_type' drivers/pci/controller/pcie-iproc.c:151: warning: Enum value 'IPROC_PCIE_IB_MAP_IO' not described in enum 'iproc_pcie_ib_map_type' drivers/pci/controller/pcie-iproc.c:151: warning: Enum value 'IPROC_PCIE_IB_MAP_INVALID' not described in enum 'iproc_pcie_ib_map_type'
drivers/pci/controller/pcie-iproc-msi.c:52: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst drivers/pci/controller/pcie-iproc-msi.c:68: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
drivers/pci/controller/pcie-iproc.h:11: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst drivers/pci/controller/pcie-iproc.h:28: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst drivers/pci/controller/pcie-iproc.h:39: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst drivers/pci/controller/pcie-iproc.h:51: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst drivers/pci/controller/pcie-iproc.h:112: warning: Function parameter or member 'mem' not described in 'iproc_pcie'
No change to functionality intended.
--- drivers/pci/controller/pcie-iproc-msi.c | 4 ++-- drivers/pci/controller/pcie-iproc.c | 24 +++++++++++------------- drivers/pci/controller/pcie-iproc.h | 18 +++++++++++++----- 3 files changed, 26 insertions(+), 20 deletions(-)
drivers/pci/controller/pcie-iproc-msi.c +2 -2
@@ -49,7 +49,7 @@ enum iproc_msi_reg {struct iproc_msi ;/** -* iProc MSI group +* struct iproc_msi_grp - iProc MSI group * * One MSI group is allocated per GIC interrupt, serviced by one iProc MSI * event queue.
@@ -65,7 +65,7 @@ struct iproc_msi_grp { };/** -* iProc event queue based MSI +* struct iproc_msi - iProc event queue based MSI * * Only meant to be used on platforms without MSI support integrated into the * GIC.
drivers/pci/controller/pcie-iproc.c +11 -13
@@ -89,8 +89,8 @@#define IPROC_PCIE_REG_INVALID 0xffff/** -* iProc PCIe outbound mapping controller specific parameters -* +* struct iproc_pcie_ob_map - iProc PCIe outbound mapping controller specific +* parameters * @window_sizes: list of supported outbound mapping window sizes in MB * @nr_sizes: number of supported outbound mapping window sizes */
@@ -136,22 +136,20 @@ static const struct iproc_pcie_ob_map paxb_v2_ob_map[] = { };/** -* iProc PCIe inbound mapping type +* enum iproc_pcie_ib_map_type - iProc PCIe inbound mapping type +* @IPROC_PCIE_IB_MAP_MEM: DDR memory +* @IPROC_PCIE_IB_MAP_IO: device I/O memory +* @IPROC_PCIE_IB_MAP_INVALID: invalid or unused */ enum iproc_pcie_ib_map_type { -/* for DDR memory */ IPROC_PCIE_IB_MAP_MEM =0 , - -/* for device I/O memory */ IPROC_PCIE_IB_MAP_IO , - -/* invalid or unused */ IPROC_PCIE_IB_MAP_INVALID };/** -* iProc PCIe inbound mapping controller specific parameters -* +* struct iproc_pcie_ib_map - iProc PCIe inbound mapping controller specific +* parameters * @type: inbound mapping region type * @size_unit: inbound mapping region size unit, could be SZ_1K, SZ_1M, or * SZ_1G
@@ -437,7 +435,7 @@ static inline void iproc_pcie_write_reg(struct iproc_pcie *pcie,writel (val, pcie->base + offset); } -/** +/* * APB error forwarding can be disabled during access of configuration * registers of the endpoint device, to prevent unsupported requests * (typically seen during enumeration with multi-function devices) from
@@ -619,7 +617,7 @@ static int iproc_pcie_config_read(struct pci_bus *bus, unsigned int devfn,return PCIBIOS_SUCCESSFUL ; } -/** +/* * Note access to the configuration registers are protected at the higher layer * by 'pci_lock' in drivers/pci/access.c */
@@ -897,7 +895,7 @@ static inline int iproc_pcie_ob_write(struct iproc_pcie *pcie, int window_idx,return 0 ; } -/** +/* * Some iProc SoCs require the SW to configure the outbound address mapping * * Outbound address translation:
drivers/pci/controller/pcie-iproc.h +13 -5
@@ -7,7 +7,15 @@#define _PCIE_IPROC_H/** -* iProc PCIe interface type +* enum iproc_pcie_type - iProc PCIe interface type +* @IPROC_PCIE_PAXB_BCMA: new generation of iProc BCMA-based host controllers +* @IPROC_PCIE_PAXB: iProc PAXB-based host controllers for SoCs such as NS, NSP, +* Cygnus, NS2 and Pegasus +* @IPROC_PCIE_PAXB_V2: next generation of iProc PAXB-based host controllers +* using the Stingray SoCs +* @IPROC_PCIE_PAXC: iProx PAXC-based host controllers +* @IPROC_PCIE_PAXC_V2: Second generation of the iProc PAXC-based host +* controllers * * PAXB is the wrapper used in root complex that can be connected to an * external endpoint device.
@@ -24,7 +32,7 @@ enum iproc_pcie_type { };/** -* iProc PCIe outbound mapping +* struct iproc_pcie_ob - iProc PCIe outbound mapping * @axi_offset: offset from the AXI address to the internal address used by * the iProc PCIe core * @nr_windows: total number of supported outbound mapping windows
@@ -35,7 +43,7 @@ struct iproc_pcie_ob { };/** -* iProc PCIe inbound mapping +* struct iproc_pcie_ib - iProc PCIe inbound mapping * @nr_regions: total number of supported inbound mapping regions */ struct iproc_pcie_ib {
@@ -47,13 +55,13 @@ struct iproc_pcie_ib_map;struct iproc_msi ;/** -* iProc PCIe device -* +* struct iproc_pcie - iProc PCIe device * @dev: pointer to device data structure * @type: iProc PCIe interface type * @reg_offsets: register offsets * @base: PCIe host controller I/O register base * @base_addr: PCIe host controller register base physical address +* @mem: host bridge memory window resource * @phy: optional PHY device that controls the Serdes * @map_irq: function callback to map interrupts * @ep_is_internal: indicates an internal emulated endpoint device is connected
Signature · 1 line
2.32.0
PATCH 3/5 PCI: cadence: Add missing kernel-doc for struct cdns_pcie members
In reply to Krzysztof WilczyńskiAdd missing documentation for the members "dev", "phy_count", "phy" and "link" of the struct cdns_pcie, and also remove surplus member "bus".
Thus resolve build time warnings related to kernel-doc:
drivers/pci/controller/cadence/pcie-cadence.h:281: warning: Function parameter or member 'dev' not described in 'cdns_pcie' drivers/pci/controller/cadence/pcie-cadence.h:281: warning: Function parameter or member 'phy_count' not described in 'cdns_pcie' drivers/pci/controller/cadence/pcie-cadence.h:281: warning: Function parameter or member 'phy' not described in 'cdns_pcie' drivers/pci/controller/cadence/pcie-cadence.h:281: warning: Function parameter or member 'link' not described in 'cdns_pcie'
No change to functionality intended.
--- drivers/pci/controller/cadence/pcie-cadence.h | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-)
drivers/pci/controller/cadence/pcie-cadence.h +4 -1
@@ -263,8 +263,11 @@ struct cdns_pcie_ops {* struct cdns_pcie - private data for Cadence PCIe controller drivers * @reg_base: IO mapped register base * @mem_res: start/end offsets in the physical system memory to map PCI accesses +* @dev: the PCI device * @is_rc: tell whether the PCIe controller mode is Root Complex or Endpoint. -* @bus: In Root Complex mode, the bus number +* @phy_count: number of supported PHY devices +* @phy: list of pointers to specific PHY control blocks +* @link: list of pointers to corresponding device link representations * @ops: Platform specific ops to control various inputs from Cadence PCIe * wrapper */
Signature · 1 line
2.32.0
PATCH 4/5 PCI: hotplug: Fix kernel-doc formatting and add missing documentation
In reply to Krzysztof WilczyńskiFix kernel-doc formatting and add missing documentation for the parameters "bus" of the get_slot_mapping() function.
Add documentation for missing "t" and remove surplus "slot" parameter of the cpqhp_pushbutton_thread() function.
Also add missing documentation for "inband_presence_disabled" member of the struct controller, and the "slot_list" and "pci_slot" members of the struct hotplug_slot.
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'
include/linux/pci_hotplug.h:64: warning: Function parameter or member 'slot_list' not described in 'hotplug_slot' include/linux/pci_hotplug.h:64: warning: Function parameter or member 'pci_slot' not described in 'hotplug_slot'
No change to functionality intended.
--- drivers/pci/hotplug/cpqphp_core.c | 7 ++++--- drivers/pci/hotplug/cpqphp_ctrl.c | 2 +- drivers/pci/hotplug/pciehp.h | 3 +++ include/linux/pci_hotplug.h | 2 ++ 4 files changed, 10 insertions(+), 4 deletions(-)
drivers/pci/hotplug/cpqphp_core.c +4 -3
@@ -296,9 +296,10 @@ static int ctrl_slot_cleanup(struct controller *ctrl)* * Won't 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 +* @bus: pointer to the PCI bus structure +* @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 */
drivers/pci/hotplug/cpqphp_ctrl.c +1 -1
@@ -1877,7 +1877,7 @@ static void interrupt_event_handler(struct controller *ctrl)/** * cpqhp_pushbutton_thread - handle pushbutton events -* @slot: target slot (struct) +* @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 +3 -0
@@ -47,6 +47,9 @@ extern int pciehp_poll_time;* struct controller - PCIe hotplug controller * @pcie: pointer to the controller's PCIe port service device * @slot_cap: cached copy of the Slot Capabilities register +* @inband_presence_disabled: whether In-Band Presence Detect Disable is +* supported by the controller and disabled per spec recommendation +* (PCIe r5.0, appendix I implementation note) * @slot_ctrl: cached copy of the Slot Control register * @ctrl_lock: serializes writes to the Slot Control register * @cmd_started: jiffies when the Slot Control register was last written;
include/linux/pci_hotplug.h +2 -0
@@ -50,6 +50,8 @@ struct hotplug_slot_ops {/** * struct hotplug_slot - used to register a physical slot with the hotplug pci core * @ops: pointer to the &struct hotplug_slot_ops to be used for this slot +* @slot_list: internal list used to track hotplug PCI slots +* @pci_slot: represents a physical slot * @owner: The module owner of this structure * @mod_name: The module name (KBUILD_MODNAME) of this structure */
Signature · 1 line
2.32.0
PATCH 5/5 PCI: endpoint: Fix kernel-doc formatting and add missing documentation
In reply to Krzysztof WilczyńskiFix a non-compliant kernel-doc at the top of the files include/linux/pci-ep-cfs.h and include/linux/pci-epc.h.
Also add the following missing documentation:
- "barno" and "flags" members of the struct pci_epf_bar
- "msix_interrupts" member of the struct pci_epf
- "get_features" member of the struct pci_epc_ops
- "core_init_notifier" member of the struct pci_epc_features
Thus, resolve build time warnings related to kernel-doc:
include/linux/pci-epf.h:4: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst include/linux/pci-epf.h:113: warning: Function parameter or member 'barno' not described in 'pci_epf_bar' include/linux/pci-epf.h:113: warning: Function parameter or member 'flags' not described in 'pci_epf_bar' include/linux/pci-epf.h:157: warning: Function parameter or member 'msix_interrupts' not described in 'pci_epf'
include/linux/pci-ep-cfs.h:4: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
include/linux/pci-epc.h:4: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst include/linux/pci-epc.h:91: warning: Function parameter or member 'get_features' not described in 'pci_epc_ops' include/linux/pci-epc.h:170: warning: Function parameter or member 'core_init_notifier' not described in 'pci_epc_features'
No change to functionality intended.
--- include/linux/pci-ep-cfs.h | 2 +- include/linux/pci-epc.h | 5 ++++- include/linux/pci-epf.h | 5 ++++- 3 files changed, 9 insertions(+), 3 deletions(-)
include/linux/pci-ep-cfs.h +1 -1
@@ -1,5 +1,5 @@/* SPDX-License-Identifier: GPL-2.0+ */ -/** +/* * PCI Endpoint ConfigFS header file * * Copyright (C) 2017 Texas Instruments
include/linux/pci-epc.h +4 -1
@@ -1,5 +1,5 @@/* SPDX-License-Identifier: GPL-2.0 */ -/** +/* * PCI Endpoint *Controller* (EPC) header file * * Copyright (C) 2017 Texas Instruments
@@ -58,6 +58,7 @@ pci_epc_interface_string(enum pci_epc_interface_type type)* @map_msi_irq: ops to map physical address to MSI address and return MSI data * @start: ops to start the PCI link * @stop: ops to stop the PCI link +* @get_features: ops to get the features supported by the EPC * @owner: the module owner containing the ops */ struct pci_epc_ops {
@@ -150,6 +151,8 @@ struct pci_epc {/** * struct pci_epc_features - features supported by a EPC device per function * @linkup_notifier: indicate if the EPC device can notify EPF driver on link up +* @core_init_notifier: indicate cores that can notify about their availability +* for initialization * @msi_capable: indicate if the endpoint function has MSI capability * @msix_capable: indicate if the endpoint function has MSI-X capability * @reserved_bar: bitmap to indicate reserved BAR unavailable to function driver
include/linux/pci-epf.h +4 -1
@@ -1,5 +1,5 @@/* SPDX-License-Identifier: GPL-2.0 */ -/** +/* * PCI Endpoint *Function* (EPF) header file * * Copyright (C) 2017 Texas Instruments
@@ -102,6 +102,8 @@ struct pci_epf_driver {* @phys_addr: physical address that should be mapped to the BAR * @addr: virtual address corresponding to the @phys_addr * @size: the size of the address space present in BAR +* @barno: the BAR number +* @flags: flags that are set for the BAR */ struct pci_epf_bar {dma_addr_t phys_addr;
@@ -118,6 +120,7 @@ struct pci_epf_bar {* @header: represents standard configuration header * @bar: represents the BAR of EPF device * @msi_interrupts: number of MSI interrupts required by this function +* @msix_interrupts: number of MSI-X interrupts required by this function * @func_no: unique function number within this endpoint device * @epc: the EPC device to which this EPF device is bound * @driver: the EPF driver to which this EPF device is bound
Signature · 1 line
2.32.0
Quoted 9 lines · Krzysztof Wilczyński
Fix kernel-doc formatting of function
pci_dev_set_io_state(), and resolve build time warnings related to kernel-doc:
drivers/pci/pci.h:337: warning: Function parameter or member 'dev' not described in 'pci_dev_set_io_state'drivers/pci/pci.h:337: warning: Function parameter or member 'new' not described in 'pci_dev_set_io_state'No change to functionality intended.
Signed-off-by Krzysztof Wilczyński <[email protected]>
I squashed these together and applied to pci/kernel-doc for v5.14, thanks!
Quoted 22 lines
--- drivers/pci/pci.h | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)drivers/pci/pci.h +2
-2@@ -324,8 +324,8 @@ struct pci_sriov {/** * pci_dev_set_io_state - Set the new error state if possible. * -* @dev - pci device to set new error_state -* @new - the state we want dev to be in +* @dev: pci device to set new error_state +* @new: the state we want dev to be in * * Must be called with device_lock held. * Signature · 1 line
2.32.0