PCI: Fix kerneldoc warnings
authorKrzysztof Kozlowski <krzk@kernel.org>
Wed, 29 Jul 2020 20:12:19 +0000 (22:12 +0200)
committerBjorn Helgaas <bhelgaas@google.com>
Wed, 5 Aug 2020 23:23:14 +0000 (18:23 -0500)
Fix kerneldoc warnings, e.g.,

  $ make W=1 drivers/pci/
  drivers/pci/ats.c:196: warning: Function parameter or member 'pdev' not described in 'pci_enable_pri'
  drivers/pci/ats.c:196: warning: Function parameter or member 'reqs' not described in 'pci_enable_pri'
  ...

Link: https://lore.kernel.org/r/20200729201224.26799-2-krzk@kernel.org
Link: https://lore.kernel.org/r/20200729201224.26799-3-krzk@kernel.org
Link: https://lore.kernel.org/r/20200729201224.26799-4-krzk@kernel.org
Link: https://lore.kernel.org/r/20200729201224.26799-5-krzk@kernel.org
Link: https://lore.kernel.org/r/20200729201224.26799-6-krzk@kernel.org
Link: https://lore.kernel.org/r/20200729201224.26799-7-krzk@kernel.org
Signed-off-by: Krzysztof Kozlowski <krzk@kernel.org>
Signed-off-by: Bjorn Helgaas <bhelgaas@google.com>
14 files changed:
drivers/pci/ats.c
drivers/pci/controller/dwc/pcie-designware-ep.c
drivers/pci/controller/pcie-rockchip-ep.c
drivers/pci/endpoint/functions/pci-epf-test.c
drivers/pci/endpoint/pci-ep-cfs.c
drivers/pci/endpoint/pci-epc-core.c
drivers/pci/endpoint/pci-epc-mem.c
drivers/pci/endpoint/pci-epf-core.c
drivers/pci/hotplug/acpi_pcihp.c
drivers/pci/hotplug/pciehp_core.c
drivers/pci/of.c
drivers/pci/pci-pf-stub.c
drivers/pci/setup-bus.c
drivers/pci/vc.c

index b761c1f72f6728c8f2978c23027363021435a23a..2e107305250936b7cb0b240b9f71db645c1fbfe5 100644 (file)
@@ -188,7 +188,8 @@ void pci_pri_init(struct pci_dev *pdev)
 
 /**
  * pci_enable_pri - Enable PRI capability
- * @ pdev: PCI device structure
+ * @pdev: PCI device structure
+ * @reqs: outstanding requests
  *
  * Returns 0 on success, negative value on error
  */
index 5e5b8821bed8cec22fbc7e77c7198850cc22fcc8..305bfec2424d87d122017593ea6ad60c9b721365 100644 (file)
@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: GPL-2.0
-/**
+/*
  * Synopsys DesignWare PCIe Endpoint controller driver
  *
  * Copyright (C) 2017 Texas Instruments
index 5eaf36629a7590c40967553e38cff89a23b9fbc4..7631dc3961c1281bf1ca5b9374e332fbd101d1e9 100644 (file)
@@ -22,6 +22,7 @@
 /**
  * struct rockchip_pcie_ep - private data for PCIe endpoint controller driver
  * @rockchip: Rockchip PCIe controller
+ * @epc: PCI EPC device
  * @max_regions: maximum number of regions supported by hardware
  * @ob_region_map: bitmask of mapped outbound regions
  * @ob_addr: base addresses in the AXI bus where the outbound regions start
index c89a9561439f9e1d2e923052caae9c253512978c..e4e51d884553f6c048aa208499f93a6dec333827 100644 (file)
@@ -181,7 +181,7 @@ static int pci_epf_test_init_dma_chan(struct pci_epf_test *epf_test)
 
 /**
  * pci_epf_test_clean_dma_chan() - Function to cleanup EPF test DMA channel
- * @epf: the EPF test device that performs data transfer operation
+ * @epf_test: the EPF test device that performs data transfer operation
  *
  * Helper to cleanup EPF test DMA channel.
  */
index 55edce50be96dd9d4a3edd5a3e43ac693d1d2e2d..3710adf51912de68207fa021ee5325eb8af9782a 100644 (file)
@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: GPL-2.0
-/**
+/*
  * configfs to configure the PCI endpoint
  *
  * Copyright (C) 2017 Texas Instruments
index 82ba0dc7f2f5f6d81d5259d4014fd1a894655d26..cadd3db0cbb08647025c08cdb2434dd7cd72c270 100644 (file)
@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: GPL-2.0
-/**
+/*
  * PCI Endpoint *Controller* (EPC) library
  *
  * Copyright (C) 2017 Texas Instruments
index 80c46f3a459090794e10e89d9a7441197a3842f0..a97b56a6d2db2cd813f7ea8b07bf5abcc62418f8 100644 (file)
@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: GPL-2.0
-/**
+/*
  * PCI Endpoint *Controller* Address Space Management
  *
  * Copyright (C) 2017 Texas Instruments
index 244e00f48c5cf007508d2dbef5a6a63c39327955..c977cf9dce56142740e1176a6b0fada4f242d742 100644 (file)
@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: GPL-2.0
-/**
+/*
  * PCI Endpoint *Function* (EPF) library
  *
  * Copyright (C) 2017 Texas Instruments
@@ -71,6 +71,7 @@ EXPORT_SYMBOL_GPL(pci_epf_bind);
 
 /**
  * pci_epf_free_space() - free the allocated PCI EPF register space
+ * @epf: the EPF device from whom to free the memory
  * @addr: the virtual address of the PCI EPF register space
  * @bar: the BAR number corresponding to the register space
  *
@@ -96,6 +97,7 @@ EXPORT_SYMBOL_GPL(pci_epf_free_space);
 
 /**
  * pci_epf_alloc_space() - allocate memory for the PCI EPF register space
+ * @epf: the EPF device to whom allocate the memory
  * @size: the size of the memory that has to be allocated
  * @bar: the BAR number corresponding to the allocated register space
  * @align: alignment size for the allocation region
index 6b7c1ed58e7e0a2d881a97436c87ee4bc6ab7d20..2750a64cecd3a416c4ed4ff39178376f80da6eaf 100644 (file)
@@ -61,7 +61,7 @@ static acpi_status acpi_run_oshp(acpi_handle handle)
 
 /**
  * acpi_get_hp_hw_control_from_firmware
- * @dev: the pci_dev of the bridge that has a hotplug controller
+ * @pdev: the pci_dev of the bridge that has a hotplug controller
  *
  * Attempt to take hotplug control from firmware.
  */
@@ -191,7 +191,7 @@ check_hotplug(acpi_handle handle, u32 lvl, void *context, void **rv)
 
 /**
  * acpi_pci_detect_ejectable - check if the PCI bus has ejectable slots
- * @handle - handle of the PCI bus to scan
+ * @handle: handle of the PCI bus to scan
  *
  * Returns 1 if the PCI bus has ACPI based ejectable slots, 0 otherwise.
  */
index bf779f291f1526a739422139c8bdb4d04e72a512..ad3393930ecb4d91dc21ef7a5abf575662c76e7c 100644 (file)
@@ -153,6 +153,7 @@ static int get_adapter_status(struct hotplug_slot *hotplug_slot, u8 *value)
 
 /**
  * pciehp_check_presence() - synthesize event if presence has changed
+ * @ctrl: controller to check
  *
  * On probe and resume, an explicit presence check is necessary to bring up an
  * occupied slot or bring down an unoccupied slot.  This can't be triggered by
index 27839cd2459f69274851e104708e801c45c414e9..4c3bd8696aaf2a425b9f90f4ad92cb0c75ca1049 100644 (file)
@@ -243,6 +243,8 @@ EXPORT_SYMBOL_GPL(of_pci_check_probe_only);
  * @busno: bus number associated with the bridge root bus
  * @bus_max: maximum number of buses for this bridge
  * @resources: list where the range of resources will be added after DT parsing
+ * @ib_resources: list where the range of inbound resources (with addresses
+ *                from 'dma-ranges') will be added after DT parsing
  * @io_base: pointer to a variable that will contain on return the physical
  * address for the start of the I/O range. Can be NULL if the caller doesn't
  * expect I/O ranges to be present in the device tree.
index ef293e735c557014276572a9a2bdb02c3c2dd22b..a0b2bd6c918a07165c7f0298dd5281c40b94e0c9 100644 (file)
@@ -9,7 +9,7 @@
 #include <linux/module.h>
 #include <linux/pci.h>
 
-/**
+/*
  * pci_pf_stub_whitelist - White list of devices to bind pci-pf-stub onto
  *
  * This table provides the list of IDs this driver is supposed to bind
index 9b94b1f16d80ea7837f13bb979defbb37520b27b..fb74d8eb80884d3f9343f6650ae2736351fdc7ff 100644 (file)
@@ -55,6 +55,7 @@ static void free_list(struct list_head *head)
  * @dev:       Device to which the resource belongs
  * @res:       Resource to be tracked
  * @add_size:  Additional size to be optionally added to the resource
+ * @min_align: Minimum memory window alignment
  */
 static int add_to_list(struct list_head *head, struct pci_dev *dev,
                       struct resource *res, resource_size_t add_size,
index 5486f8768c8644495e4de039061e8f17cfcae953..5fc59ac31145fbec630239f6b36214fda1a409b9 100644 (file)
@@ -172,7 +172,6 @@ enable:
  * @dev: device
  * @pos: starting position of VC capability (VC/VC9/MFVC)
  * @save_state: buffer for save/restore
- * @name: for error message
  * @save: if provided a buffer, this indicates what to do with it
  *
  * Walking Virtual Channel config space to size, save, or restore it