[PATCH] PCI/MSI: correct kernel-doc in <linux/msi.h>

[PATCH] PCI/MSI: correct kernel-doc in <linux/msi.h>

[Randy Dunlap]

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>
---
Cc: Thomas Gleixner <tglx@linutronix.de>
---
 include/linux/msi.h |   13 +++++++------
 1 file changed, 7 insertions(+), 6 deletions(-)

--- linux-next-20251201.orig/include/linux/msi.h
+++ linux-next-20251201/include/linux/msi.h
@@ -49,12 +49,12 @@ typedef struct arch_msi_msg_data {
 #endif
 
 /**
- * msi_msg - Representation of a MSI message
+ * struct msi_msg - Representation of a MSI message
  * @address_lo:		Low 32 bits of msi message address
- * @arch_addrlo:	Architecture specific shadow of @address_lo
+ * @arch_addr_lo:	Architecture specific shadow of @address_lo
  * @address_hi:		High 32 bits of msi message address
  *			(only used when device supports it)
- * @arch_addrhi:	Architecture specific shadow of @address_hi
+ * @arch_addr_hi:	Architecture specific shadow of @address_hi
  * @data:		MSI message data (usually 16 bits)
  * @arch_data:		Architecture specific shadow of @data
  */
@@ -91,7 +91,7 @@ typedef void (*irq_write_msi_msg_t)(stru
 				    struct msi_msg *msg);
 
 /**
- * pci_msi_desc - PCI/MSI specific MSI descriptor data
+ * struct pci_msi_desc - PCI/MSI specific MSI descriptor data
  *
  * @msi_mask:	[PCI MSI]   MSI cached mask bits
  * @msix_ctrl:	[PCI MSI-X] MSI-X cached per vector control bits
@@ -101,6 +101,7 @@ typedef void (*irq_write_msi_msg_t)(stru
  * @can_mask:	[PCI MSI/X] Masking supported?
  * @is_64:	[PCI MSI/X] Address size: 0=32bit 1=64bit
  * @default_irq:[PCI MSI/X] The default pre-assigned non-MSI irq
+ * @msi_attrib:	[PCI MSI/X] Compound struct of MSI/X attributes
  * @mask_pos:	[PCI MSI]   Mask register position
  * @mask_base:	[PCI MSI-X] Mask register base address
  */
@@ -169,7 +170,7 @@ struct msi_desc_data {
  *                  Only used if iommu_msi_shift != 0
  * @iommu_msi_shift: Indicates how many bits of the original address should be
  *                   preserved when using iommu_msi_iova.
- * @sysfs_attr:	Pointer to sysfs device attribute
+ * @sysfs_attrs:	Pointer to sysfs device attribute
  *
  * @write_msi_msg:	Callback that may be called when the MSI message
  *			address or data changes
@@ -220,7 +221,7 @@ enum msi_desc_filter {
 /**
  * struct msi_dev_domain - The internals of MSI domain info per device
  * @store:		Xarray for storing MSI descriptor pointers
- * @irqdomain:		Pointer to a per device interrupt domain
+ * @domain:		Pointer to a per device interrupt domain
  */
 struct msi_dev_domain {
 	struct xarray		store;

[tip: irq/msi] genirq/msi: Correct kernel-doc in <linux/msi.h>

[tip-bot2 for Randy Dunlap]

The following commit has been merged into the irq/msi branch of tip:

Commit-ID:     0317e0aba5d41ae5e974026bf96899d9ae4bcbdb
Gitweb:        https://git.kernel.org/tip/0317e0aba5d41ae5e974026bf96899d9ae4bcbdb
Author:        Randy Dunlap <rdunlap@infradead.org>
AuthorDate:    Sun, 14 Dec 2025 12:23:41 -08:00
Committer:     Thomas Gleixner <tglx@linutronix.de>
CommitterDate: Mon, 15 Dec 2025 20:18:27 +01:00

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
---
 include/linux/msi.h | 13 +++++++------
 1 file changed, 7 insertions(+), 6 deletions(-)

diff --git a/include/linux/msi.h b/include/linux/msi.h
index 8003e32..94cfc37 100644
--- a/include/linux/msi.h
+++ b/include/linux/msi.h
@@ -49,12 +49,12 @@ typedef struct arch_msi_msg_data {
 #endif
 
 /**
- * msi_msg - Representation of a MSI message
+ * struct msi_msg - Representation of a MSI message
  * @address_lo:		Low 32 bits of msi message address
- * @arch_addrlo:	Architecture specific shadow of @address_lo
+ * @arch_addr_lo:	Architecture specific shadow of @address_lo
  * @address_hi:		High 32 bits of msi message address
  *			(only used when device supports it)
- * @arch_addrhi:	Architecture specific shadow of @address_hi
+ * @arch_addr_hi:	Architecture specific shadow of @address_hi
  * @data:		MSI message data (usually 16 bits)
  * @arch_data:		Architecture specific shadow of @data
  */
@@ -91,7 +91,7 @@ typedef void (*irq_write_msi_msg_t)(struct msi_desc *desc,
 				    struct msi_msg *msg);
 
 /**
- * pci_msi_desc - PCI/MSI specific MSI descriptor data
+ * struct pci_msi_desc - PCI/MSI specific MSI descriptor data
  *
  * @msi_mask:	[PCI MSI]   MSI cached mask bits
  * @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,
  * @can_mask:	[PCI MSI/X] Masking supported?
  * @is_64:	[PCI MSI/X] Address size: 0=32bit 1=64bit
  * @default_irq:[PCI MSI/X] The default pre-assigned non-MSI irq
+ * @msi_attrib:	[PCI MSI/X] Compound struct of MSI/X attributes
  * @mask_pos:	[PCI MSI]   Mask register position
  * @mask_base:	[PCI MSI-X] Mask register base address
  */
@@ -169,7 +170,7 @@ struct msi_desc_data {
  *                  Only used if iommu_msi_shift != 0
  * @iommu_msi_shift: Indicates how many bits of the original address should be
  *                   preserved when using iommu_msi_iova.
- * @sysfs_attr:	Pointer to sysfs device attribute
+ * @sysfs_attrs:	Pointer to sysfs device attribute
  *
  * @write_msi_msg:	Callback that may be called when the MSI message
  *			address or data changes
@@ -220,7 +221,7 @@ enum msi_desc_filter {
 /**
  * struct msi_dev_domain - The internals of MSI domain info per device
  * @store:		Xarray for storing MSI descriptor pointers
- * @irqdomain:		Pointer to a per device interrupt domain
+ * @domain:		Pointer to a per device interrupt domain
  */
 struct msi_dev_domain {
 	struct xarray		store;