PCI: Add kerneldoc for pci_resize_resource()

As pci_resize_resource() is meant to be used also outside of PCI core,
document the interface with kerneldoc.

Signed-off-by: Ilpo Järvinen <ilpo.jarvinen@linux.intel.com>
Signed-off-by: Bjorn Helgaas <bhelgaas@google.com>
Tested-by: Alex Bennée <alex.bennee@linaro.org> # AVA, AMD GPU
Link: https://patch.msgid.link/20251113162628.5946-8-ilpo.jarvinen@linux.intel.com
This commit is contained in:
Ilpo Järvinen
2025-11-13 18:26:24 +02:00
committed by Bjorn Helgaas
parent 337b1b566d
commit d787018e2d

View File

@@ -455,6 +455,26 @@ void pci_resize_resource_set_size(struct pci_dev *dev, int resno, int size)
resource_set_size(res, res_size);
}
/**
* pci_resize_resource - reconfigure a Resizable BAR and resources
* @dev: the PCI device
* @resno: index of the BAR to be resized
* @size: new size as defined in the spec (0=1MB, 31=128TB)
* @exclude_bars: a mask of BARs that should not be released
*
* Reconfigure @resno to @size and re-run resource assignment algorithm
* with the new size.
*
* Prior to resize, release @dev resources that share a bridge window with
* @resno. This unpins the bridge window resource to allow changing it.
*
* The caller may prevent releasing a particular BAR by providing
* @exclude_bars mask, but this may result in the resize operation failing
* due to insufficient space.
*
* Return: 0 on success, or negative on error. In case of an error, the
* resources are restored to their original places.
*/
int pci_resize_resource(struct pci_dev *dev, int resno, int size,
int exclude_bars)
{