Merge branch 'pci/doc'

- Fix several kerneldoc warnings (Krzysztof Kozlowski)

* pci/doc:
  PCI: Fix kerneldoc warnings
This commit is contained in:
Bjorn Helgaas 2020-08-05 18:24:22 -05:00
commit 65c2bc6ce9
14 changed files with 18 additions and 11 deletions

View File

@ -188,7 +188,8 @@ void pci_pri_init(struct pci_dev *pdev)
/** /**
* pci_enable_pri - Enable PRI capability * 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 * Returns 0 on success, negative value on error
*/ */

View File

@ -1,5 +1,5 @@
// SPDX-License-Identifier: GPL-2.0 // SPDX-License-Identifier: GPL-2.0
/** /*
* Synopsys DesignWare PCIe Endpoint controller driver * Synopsys DesignWare PCIe Endpoint controller driver
* *
* Copyright (C) 2017 Texas Instruments * Copyright (C) 2017 Texas Instruments

View File

@ -22,6 +22,7 @@
/** /**
* struct rockchip_pcie_ep - private data for PCIe endpoint controller driver * struct rockchip_pcie_ep - private data for PCIe endpoint controller driver
* @rockchip: Rockchip PCIe controller * @rockchip: Rockchip PCIe controller
* @epc: PCI EPC device
* @max_regions: maximum number of regions supported by hardware * @max_regions: maximum number of regions supported by hardware
* @ob_region_map: bitmask of mapped outbound regions * @ob_region_map: bitmask of mapped outbound regions
* @ob_addr: base addresses in the AXI bus where the outbound regions start * @ob_addr: base addresses in the AXI bus where the outbound regions start

View 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 * 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. * Helper to cleanup EPF test DMA channel.
*/ */

View File

@ -1,5 +1,5 @@
// SPDX-License-Identifier: GPL-2.0 // SPDX-License-Identifier: GPL-2.0
/** /*
* configfs to configure the PCI endpoint * configfs to configure the PCI endpoint
* *
* Copyright (C) 2017 Texas Instruments * Copyright (C) 2017 Texas Instruments

View File

@ -1,5 +1,5 @@
// SPDX-License-Identifier: GPL-2.0 // SPDX-License-Identifier: GPL-2.0
/** /*
* PCI Endpoint *Controller* (EPC) library * PCI Endpoint *Controller* (EPC) library
* *
* Copyright (C) 2017 Texas Instruments * Copyright (C) 2017 Texas Instruments

View File

@ -1,5 +1,5 @@
// SPDX-License-Identifier: GPL-2.0 // SPDX-License-Identifier: GPL-2.0
/** /*
* PCI Endpoint *Controller* Address Space Management * PCI Endpoint *Controller* Address Space Management
* *
* Copyright (C) 2017 Texas Instruments * Copyright (C) 2017 Texas Instruments

View File

@ -1,5 +1,5 @@
// SPDX-License-Identifier: GPL-2.0 // SPDX-License-Identifier: GPL-2.0
/** /*
* PCI Endpoint *Function* (EPF) library * PCI Endpoint *Function* (EPF) library
* *
* Copyright (C) 2017 Texas Instruments * 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 * 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 * @addr: the virtual address of the PCI EPF register space
* @bar: the BAR number corresponding to the 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 * 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 * @size: the size of the memory that has to be allocated
* @bar: the BAR number corresponding to the allocated register space * @bar: the BAR number corresponding to the allocated register space
* @align: alignment size for the allocation region * @align: alignment size for the allocation region

View File

@ -61,7 +61,7 @@ static acpi_status acpi_run_oshp(acpi_handle handle)
/** /**
* acpi_get_hp_hw_control_from_firmware * 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. * 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 * 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. * Returns 1 if the PCI bus has ACPI based ejectable slots, 0 otherwise.
*/ */

View 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 * 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 * 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 * occupied slot or bring down an unoccupied slot. This can't be triggered by

View File

@ -243,6 +243,8 @@ EXPORT_SYMBOL_GPL(of_pci_check_probe_only);
* @busno: bus number associated with the bridge root bus * @busno: bus number associated with the bridge root bus
* @bus_max: maximum number of buses for this bridge * @bus_max: maximum number of buses for this bridge
* @resources: list where the range of resources will be added after DT parsing * @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 * @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 * 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. * expect I/O ranges to be present in the device tree.

View File

@ -9,7 +9,7 @@
#include <linux/module.h> #include <linux/module.h>
#include <linux/pci.h> #include <linux/pci.h>
/** /*
* pci_pf_stub_whitelist - White list of devices to bind pci-pf-stub onto * 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 * This table provides the list of IDs this driver is supposed to bind

View File

@ -55,6 +55,7 @@ static void free_list(struct list_head *head)
* @dev: Device to which the resource belongs * @dev: Device to which the resource belongs
* @res: Resource to be tracked * @res: Resource to be tracked
* @add_size: Additional size to be optionally added to the resource * @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, static int add_to_list(struct list_head *head, struct pci_dev *dev,
struct resource *res, resource_size_t add_size, struct resource *res, resource_size_t add_size,

View File

@ -172,7 +172,6 @@ static void pci_vc_enable(struct pci_dev *dev, int pos, int res)
* @dev: device * @dev: device
* @pos: starting position of VC capability (VC/VC9/MFVC) * @pos: starting position of VC capability (VC/VC9/MFVC)
* @save_state: buffer for save/restore * @save_state: buffer for save/restore
* @name: for error message
* @save: if provided a buffer, this indicates what to do with it * @save: if provided a buffer, this indicates what to do with it
* *
* Walking Virtual Channel config space to size, save, or restore it * Walking Virtual Channel config space to size, save, or restore it