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 <[email protected]> --- drivers/pci/setup-res.c | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/drivers/pci/setup-res.c b/drivers/pci/setup-res.c index e4486d7030c0..558e452fc799 100644 --- a/drivers/pci/setup-res.c +++ b/drivers/pci/setup-res.c @@ -455,6 +455,25 @@ 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 + * + * Reconfigures @resno to @size and re-runs resource assignment algorithm + * with the new size. + * + * Prior to resize, @dev resources that share the bridge window with @resno + * are released (unpins the bridge window resource to allow changing it). + * The caller may prevent releasing a particular BAR by providing + * @exclude_bars mask but it 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) { -- 2.39.5
