Skip to content

Commit ff2f19d

Browse files
Mani-Sadhasivambjorn-helgaas
authored andcommitted
PCI: endpoint: Add missing documentation about the MSI/MSI-X range
Both pci_epc_raise_irq() and pci_epc_map_msi_irq() APIs expect the MSI/MSI-X vectors to start from 1 but it is not documented. Add the range info to the kdoc of the APIs to make it clear. Link: https://lore.kernel.org/r/20230602114756.36586-2-manivannan.sadhasivam@linaro.org Fixes: 5e8cb40 ("PCI: endpoint: Add EP core layer to enable EP controller and EP functions") Fixes: 87d5972 ("PCI: endpoint: Add pci_epc_ops to map MSI IRQ") Signed-off-by: Manivannan Sadhasivam <manivannan.sadhasivam@linaro.org> Signed-off-by: Lorenzo Pieralisi <lpieralisi@kernel.org> Signed-off-by: Bjorn Helgaas <bhelgaas@google.com> Reviewed-by: Damien Le Moal <dlemoal@kernel.org>
1 parent b6a6e03 commit ff2f19d

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

drivers/pci/endpoint/pci-epc-core.c

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -213,7 +213,7 @@ EXPORT_SYMBOL_GPL(pci_epc_start);
213213
* @func_no: the physical endpoint function number in the EPC device
214214
* @vfunc_no: the virtual endpoint function number in the physical function
215215
* @type: specify the type of interrupt; legacy, MSI or MSI-X
216-
* @interrupt_num: the MSI or MSI-X interrupt number
216+
* @interrupt_num: the MSI or MSI-X interrupt number with range (1-N)
217217
*
218218
* Invoke to raise an legacy, MSI or MSI-X interrupt
219219
*/
@@ -246,7 +246,7 @@ EXPORT_SYMBOL_GPL(pci_epc_raise_irq);
246246
* @func_no: the physical endpoint function number in the EPC device
247247
* @vfunc_no: the virtual endpoint function number in the physical function
248248
* @phys_addr: the physical address of the outbound region
249-
* @interrupt_num: the MSI interrupt number
249+
* @interrupt_num: the MSI interrupt number with range (1-N)
250250
* @entry_size: Size of Outbound address region for each interrupt
251251
* @msi_data: the data that should be written in order to raise MSI interrupt
252252
* with interrupt number as 'interrupt num'

0 commit comments

Comments
 (0)