admin/linux
1
0
Fork 0
mirror of https://github.com/torvalds/linux.git synced 2025-12-07 20:06:24 +00:00
Code Issues Packages Projects Releases Wiki Activity

PCI: Improve Resizable BAR functions kernel doc

Browse Source 
Fix the copy-pasted errors in the Resizable BAR handling functions kernel
doc and generally improve wording choices.

Fix the formatting errors of the Return: line.

Signed-off-by: Ilpo Järvinen <ilpo.jarvinen@linux.intel.com>
Signed-off-by: Bjorn Helgaas <bhelgaas@google.com>
Reviewed-by: Christian König <christian.koenig@amd.com>
Link: https://patch.msgid.link/20251113180053.27944-5-ilpo.jarvinen@linux.intel.com
This commit is contained in:
Ilpo Järvinen
2025-11-13 20:00:46 +02:00
committed by Bjorn Helgaas
parent a337869885
commit ce04b2f9b0
1 changed files with 21 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

35
drivers/pci/rebar.c
View File

@@ -53,13 +53,15 @@ void pci_rebar_init(struct pci_dev *pdev)
}
/**
* pci_rebar_find_pos - find position of resize ctrl reg for BAR
* pci_rebar_find_pos - find position of resize control reg for BAR
* @pdev: PCI device
* @bar: BAR to find
*
* Helper to find the position of the ctrl register for a BAR.
* Returns -ENOTSUPP if resizable BARs are not supported at all.
* Returns -ENOENT if no ctrl register for the BAR could be found.
* Helper to find the position of the control register for a BAR.
*
* Return:
* * %-ENOTSUPP if resizable BARs are not supported at all,
* * %-ENOENT if no control register for the BAR could be found.
*/
static int pci_rebar_find_pos(struct pci_dev *pdev, int bar)
{
@@ -92,12 +94,14 @@ static int pci_rebar_find_pos(struct pci_dev *pdev, int bar)
}
/**
* pci_rebar_get_possible_sizes - get possible sizes for BAR
* pci_rebar_get_possible_sizes - get possible sizes for Resizable BAR
* @pdev: PCI device
* @bar: BAR to query
*
* Get the possible sizes of a resizable BAR as bitmask defined in the spec
* (bit 0=1MB, bit 31=128TB). Returns 0 if BAR isn't resizable.
* Get the possible sizes of a resizable BAR as bitmask.
*
* Return: A bitmask of possible sizes (bit 0=1MB, bit 31=128TB), or %0 if
* BAR isn't resizable.
*/
u32 pci_rebar_get_possible_sizes(struct pci_dev *pdev, int bar)
{
@@ -121,12 +125,14 @@ u32 pci_rebar_get_possible_sizes(struct pci_dev *pdev, int bar)
EXPORT_SYMBOL(pci_rebar_get_possible_sizes);
/**
* pci_rebar_get_current_size - get the current size of a BAR
* pci_rebar_get_current_size - get the current size of a Resizable BAR
* @pdev: PCI device
* @bar: BAR to set size to
* @bar: BAR to get the size from
*
* Read the size of a BAR from the resizable BAR config.
* Returns size if found or negative error code.
* Read the current size of a BAR from the Resizable BAR config.
*
* Return: BAR Size if @bar is resizable (0=1MB, 31=128TB), or negative on
* error.
*/
int pci_rebar_get_current_size(struct pci_dev *pdev, int bar)
{
@@ -142,13 +148,14 @@ int pci_rebar_get_current_size(struct pci_dev *pdev, int bar)
}
/**
* pci_rebar_set_size - set a new size for a BAR
* pci_rebar_set_size - set a new size for a Resizable BAR
* @pdev: PCI device
* @bar: BAR to set size to
* @size: new size as defined in the spec (0=1MB, 31=128TB)
* @size: new size as defined in the PCIe spec (0=1MB, 31=128TB)
*
* Set the new size of a BAR as defined in the spec.
* Returns zero if resizing was successful, error code otherwise.
*
* Return: %0 if resizing was successful, or negative on error.
*/
int pci_rebar_set_size(struct pci_dev *pdev, int bar, int size)
{