Skip to content

Commit d3cd4d9

Browse files
rddunlaptsbogend
authored andcommitted
MIPS: msi-octeon: eliminate kernel-doc warnings
Rearrange kernel-doc notation for 2 functions to eliminate kernel-doc warnings. Use Return: notation for the function return value description. Add function short descriptions for both functions. Correct 2 typos. Fixes these kernel-doc warnings: msi-octeon.c:49: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst * Called when a driver request MSI interrupts instead of the msi-octeon.c:49: warning: missing initial short description on line: * Called when a driver request MSI interrupts instead of the msi-octeon.c:62: warning: No description found for return value of 'arch_setup_msi_irq' msi-octeon.c:189: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst * Called when a device no longer needs its MSI interrupts. All msi-octeon.c:189: warning: missing initial short description on line: * Called when a device no longer needs its MSI interrupts. All Fixes: e8635b4 ("MIPS: Add Cavium OCTEON PCI support.") Reported-by: kernel test robot <[email protected]> Signed-off-by: Randy Dunlap <[email protected]> Cc: Aditya Srivastava <[email protected]> Cc: Thomas Bogendoerfer <[email protected]> Cc: [email protected] Signed-off-by: Thomas Bogendoerfer <[email protected]>
1 parent b8295e4 commit d3cd4d9

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

arch/mips/pci/msi-octeon.c

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -46,16 +46,17 @@ static DEFINE_SPINLOCK(msi_free_irq_bitmask_lock);
4646
static int msi_irq_size;
4747

4848
/**
49-
* Called when a driver request MSI interrupts instead of the
49+
* arch_setup_msi_irq() - setup MSI IRQs for a device
50+
* @dev: Device requesting MSI interrupts
51+
* @desc: MSI descriptor
52+
*
53+
* Called when a driver requests MSI interrupts instead of the
5054
* legacy INT A-D. This routine will allocate multiple interrupts
5155
* for MSI devices that support them. A device can override this by
5256
* programming the MSI control bits [6:4] before calling
5357
* pci_enable_msi().
5458
*
55-
* @dev: Device requesting MSI interrupts
56-
* @desc: MSI descriptor
57-
*
58-
* Returns 0 on success.
59+
* Return: %0 on success, non-%0 on error.
5960
*/
6061
int arch_setup_msi_irq(struct pci_dev *dev, struct msi_desc *desc)
6162
{
@@ -186,10 +187,11 @@ int arch_setup_msi_irq(struct pci_dev *dev, struct msi_desc *desc)
186187
}
187188

188189
/**
190+
* arch_teardown_msi_irq() - release MSI IRQs for a device
191+
* @irq: The devices first irq number. There may be multiple in sequence.
192+
*
189193
* Called when a device no longer needs its MSI interrupts. All
190194
* MSI interrupts for the device are freed.
191-
*
192-
* @irq: The devices first irq number. There may be multple in sequence.
193195
*/
194196
void arch_teardown_msi_irq(unsigned int irq)
195197
{

0 commit comments

Comments
 (0)