tjh.dev / kernel
Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux
1
fork

Configure Feed

Select the types of activity you want to include in your feed.

genirq/msi: Correct kernel-doc in <linux/msi.h>

Eliminate all kernel-doc warnings in <linux/msi.h>:

- add "struct" to struct kernel-doc headers
- add missing struct member descriptions or correct typos in them

Fixes these warnings:
Warning: include/linux/msi.h:60 cannot understand function prototype:
'struct msi_msg'
Warning: include/linux/msi.h:73 struct member 'arch_addr_lo' not described
in 'msi_msg'
Warning: include/linux/msi.h:73 struct member 'arch_addr_hi' not described
in 'msi_msg'
Warning: include/linux/msi.h:106 cannot understand function prototype:
'struct pci_msi_desc'
Warning: include/linux/msi.h:124 struct member 'msi_attrib' not described
in 'pci_msi_desc'
Warning: include/linux/msi.h:204 struct member 'sysfs_attrs' not described
in 'msi_desc'
Warning: include/linux/msi.h:227 struct member 'domain' not described in
'msi_dev_domain'

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: Thomas Gleixner <tglx@linutronix.de>
Link: https://patch.msgid.link/20251214202341.2205675-1-rdunlap@infradead.org

authored by

Randy Dunlap and committed by
Thomas Gleixner 0317e0ab 8f0b4cce

+7 -6
+7 -6
include/linux/msi.h
··· 49 49 #endif 50 50 51 51 /** 52 - * msi_msg - Representation of a MSI message 52 + * struct msi_msg - Representation of a MSI message 53 53 * @address_lo: Low 32 bits of msi message address 54 - * @arch_addrlo: Architecture specific shadow of @address_lo 54 + * @arch_addr_lo: Architecture specific shadow of @address_lo 55 55 * @address_hi: High 32 bits of msi message address 56 56 * (only used when device supports it) 57 - * @arch_addrhi: Architecture specific shadow of @address_hi 57 + * @arch_addr_hi: Architecture specific shadow of @address_hi 58 58 * @data: MSI message data (usually 16 bits) 59 59 * @arch_data: Architecture specific shadow of @data 60 60 */ ··· 91 91 struct msi_msg *msg); 92 92 93 93 /** 94 - * pci_msi_desc - PCI/MSI specific MSI descriptor data 94 + * struct pci_msi_desc - PCI/MSI specific MSI descriptor data 95 95 * 96 96 * @msi_mask: [PCI MSI] MSI cached mask bits 97 97 * @msix_ctrl: [PCI MSI-X] MSI-X cached per vector control bits ··· 101 101 * @can_mask: [PCI MSI/X] Masking supported? 102 102 * @is_64: [PCI MSI/X] Address size: 0=32bit 1=64bit 103 103 * @default_irq:[PCI MSI/X] The default pre-assigned non-MSI irq 104 + * @msi_attrib: [PCI MSI/X] Compound struct of MSI/X attributes 104 105 * @mask_pos: [PCI MSI] Mask register position 105 106 * @mask_base: [PCI MSI-X] Mask register base address 106 107 */ ··· 170 169 * Only used if iommu_msi_shift != 0 171 170 * @iommu_msi_shift: Indicates how many bits of the original address should be 172 171 * preserved when using iommu_msi_iova. 173 - * @sysfs_attr: Pointer to sysfs device attribute 172 + * @sysfs_attrs: Pointer to sysfs device attribute 174 173 * 175 174 * @write_msi_msg: Callback that may be called when the MSI message 176 175 * address or data changes ··· 221 220 /** 222 221 * struct msi_dev_domain - The internals of MSI domain info per device 223 222 * @store: Xarray for storing MSI descriptor pointers 224 - * @irqdomain: Pointer to a per device interrupt domain 223 + * @domain: Pointer to a per device interrupt domain 225 224 */ 226 225 struct msi_dev_domain { 227 226 struct xarray store;