genirq/irqdomain: Make struct irqdomain readable
authorThomas Gleixner <tglx@linutronix.de>
Thu, 24 Nov 2022 23:24:10 +0000 (00:24 +0100)
committerThomas Gleixner <tglx@linutronix.de>
Mon, 5 Dec 2022 18:20:58 +0000 (19:20 +0100)
Tabular alignment of both kernel-doc and the actual struct declaration make
visual parsing way more conveniant.

No functional change.

Signed-off-by: Thomas Gleixner <tglx@linutronix.de>
Reviewed-by: Kevin Tian <kevin.tian@intel.com>
Acked-by: Marc Zyngier <maz@kernel.org>
Link: https://lore.kernel.org/r/20221124230313.514944367@linutronix.de
include/linux/irqdomain.h

index c42c369..b1fdd8d 100644 (file)
@@ -117,53 +117,53 @@ struct irq_domain_chip_generic;
 
 /**
  * struct irq_domain - Hardware interrupt number translation object
- * @link: Element in global irq_domain list.
- * @name: Name of interrupt domain
- * @ops: pointer to irq_domain methods
- * @host_data: private data pointer for use by owner.  Not touched by irq_domain
- *             core code.
- * @flags: host per irq_domain flags
- * @mapcount: The number of mapped interrupts
+ * @link:      Element in global irq_domain list.
+ * @name:      Name of interrupt domain
+ * @ops:       Pointer to irq_domain methods
+ * @host_data: Private data pointer for use by owner.  Not touched by irq_domain
+ *             core code.
+ * @flags:     Per irq_domain flags
+ * @mapcount:  The number of mapped interrupts
  *
- * Optional elements
- * @fwnode: Pointer to firmware node associated with the irq_domain. Pretty easy
- *          to swap it for the of_node via the irq_domain_get_of_node accessor
- * @gc: Pointer to a list of generic chips. There is a helper function for
- *      setting up one or more generic chips for interrupt controllers
- *      drivers using the generic chip library which uses this pointer.
- * @dev: Pointer to a device that the domain represent, and that will be
- *       used for power management purposes.
- * @parent: Pointer to parent irq_domain to support hierarchy irq_domains
+ * Optional elements:
+ * @fwnode:    Pointer to firmware node associated with the irq_domain. Pretty easy
+ *             to swap it for the of_node via the irq_domain_get_of_node accessor
+ * @gc:                Pointer to a list of generic chips. There is a helper function for
+ *             setting up one or more generic chips for interrupt controllers
+ *             drivers using the generic chip library which uses this pointer.
+ * @dev:       Pointer to a device that can be utilized for power management
+ *             purposes related to the irq domain.
+ * @parent:    Pointer to parent irq_domain to support hierarchy irq_domains
  *
- * Revmap data, used internally by irq_domain
- * @revmap_size: Size of the linear map table @revmap[]
- * @revmap_tree: Radix map tree for hwirqs that don't fit in the linear map
- * @revmap_mutex: Lock for the revmap
- * @revmap: Linear table of irq_data pointers
+ * Revmap data, used internally by the irq domain code:
+ * @revmap_size:       Size of the linear map table @revmap[]
+ * @revmap_tree:       Radix map tree for hwirqs that don't fit in the linear map
+ * @revmap_mutex:      Lock for the revmap
+ * @revmap:            Linear table of irq_data pointers
  */
 struct irq_domain {
-       struct list_head link;
-       const char *name;
-       const struct irq_domain_ops *ops;
-       void *host_data;
-       unsigned int flags;
-       unsigned int mapcount;
+       struct list_head                link;
+       const char                      *name;
+       const struct irq_domain_ops     *ops;
+       void                            *host_data;
+       unsigned int                    flags;
+       unsigned int                    mapcount;
 
        /* Optional data */
-       struct fwnode_handle *fwnode;
-       enum irq_domain_bus_token bus_token;
-       struct irq_domain_chip_generic *gc;
-       struct device *dev;
+       struct fwnode_handle            *fwnode;
+       enum irq_domain_bus_token       bus_token;
+       struct irq_domain_chip_generic  *gc;
+       struct device                   *dev;
 #ifdef CONFIG_IRQ_DOMAIN_HIERARCHY
-       struct irq_domain *parent;
+       struct irq_domain               *parent;
 #endif
 
        /* reverse map data. The linear map gets appended to the irq_domain */
-       irq_hw_number_t hwirq_max;
-       unsigned int revmap_size;
-       struct radix_tree_root revmap_tree;
-       struct mutex revmap_mutex;
-       struct irq_data __rcu *revmap[];
+       irq_hw_number_t                 hwirq_max;
+       unsigned int                    revmap_size;
+       struct radix_tree_root          revmap_tree;
+       struct mutex                    revmap_mutex;
+       struct irq_data __rcu           *revmap[];
 };
 
 /* Irq domain flags */