From 842e4b5b9fd0bf1cf392b22080b0233dec5bf28d Mon Sep 17 00:00:00 2001 From: Guennadi Liakhovetski Date: Tue, 26 Mar 2019 14:20:42 +0100 Subject: [PATCH] interrupt: add doxygen documentation for struct irq_desc Other global interrupt-related structs are already documented, add missing documentation to struct irq_desc Signed-off-by: Guennadi Liakhovetski --- src/include/sof/drivers/interrupt.h | 25 +++++++++++++------------ 1 file changed, 13 insertions(+), 12 deletions(-) diff --git a/src/include/sof/drivers/interrupt.h b/src/include/sof/drivers/interrupt.h index aa48dc00f..f85cf66b6 100644 --- a/src/include/sof/drivers/interrupt.h +++ b/src/include/sof/drivers/interrupt.h @@ -35,19 +35,20 @@ struct irq_child { */ }; +/** + * \brief interrupt client descriptor + */ struct irq_desc { - int irq; /* logical IRQ number */ - - void (*handler)(void *arg); - void *handler_arg; - - /* whether irq should be automatically unmasked */ - int unmask; - - uint32_t cpu_mask; - - /* to link to other irq_desc */ - struct list_item irq_list; + int irq; /**< virtual IRQ number */ + void (*handler)(void *arg); /**< interrupt handler function */ + void *handler_arg; /**< interrupt handler argument */ + int unmask; /**< whether irq should be + * automatically unmasked + */ + uint32_t cpu_mask; /**< a mask of CPUs on which this + * interrupt is enabled + */ + struct list_item irq_list; /**< to link to other irq_desc */ }; /**