Skip to content

Commit 0317e0a

Browse files
rddunlapKAGA-KOKO
authored andcommitted
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
1 parent 8f0b4cc commit 0317e0a

1 file changed

Lines changed: 7 additions & 6 deletions

File tree

include/linux/msi.h

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -49,12 +49,12 @@ typedef struct arch_msi_msg_data {
4949
#endif
5050

5151
/**
52-
* msi_msg - Representation of a MSI message
52+
* struct msi_msg - Representation of a MSI message
5353
* @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
5555
* @address_hi: High 32 bits of msi message address
5656
* (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
5858
* @data: MSI message data (usually 16 bits)
5959
* @arch_data: Architecture specific shadow of @data
6060
*/
@@ -91,7 +91,7 @@ typedef void (*irq_write_msi_msg_t)(struct msi_desc *desc,
9191
struct msi_msg *msg);
9292

9393
/**
94-
* pci_msi_desc - PCI/MSI specific MSI descriptor data
94+
* struct pci_msi_desc - PCI/MSI specific MSI descriptor data
9595
*
9696
* @msi_mask: [PCI MSI] MSI cached mask bits
9797
* @msix_ctrl: [PCI MSI-X] MSI-X cached per vector control bits
@@ -101,6 +101,7 @@ typedef void (*irq_write_msi_msg_t)(struct msi_desc *desc,
101101
* @can_mask: [PCI MSI/X] Masking supported?
102102
* @is_64: [PCI MSI/X] Address size: 0=32bit 1=64bit
103103
* @default_irq:[PCI MSI/X] The default pre-assigned non-MSI irq
104+
* @msi_attrib: [PCI MSI/X] Compound struct of MSI/X attributes
104105
* @mask_pos: [PCI MSI] Mask register position
105106
* @mask_base: [PCI MSI-X] Mask register base address
106107
*/
@@ -169,7 +170,7 @@ struct msi_desc_data {
169170
* Only used if iommu_msi_shift != 0
170171
* @iommu_msi_shift: Indicates how many bits of the original address should be
171172
* preserved when using iommu_msi_iova.
172-
* @sysfs_attr: Pointer to sysfs device attribute
173+
* @sysfs_attrs: Pointer to sysfs device attribute
173174
*
174175
* @write_msi_msg: Callback that may be called when the MSI message
175176
* address or data changes
@@ -220,7 +221,7 @@ enum msi_desc_filter {
220221
/**
221222
* struct msi_dev_domain - The internals of MSI domain info per device
222223
* @store: Xarray for storing MSI descriptor pointers
223-
* @irqdomain: Pointer to a per device interrupt domain
224+
* @domain: Pointer to a per device interrupt domain
224225
*/
225226
struct msi_dev_domain {
226227
struct xarray store;

0 commit comments

Comments
 (0)