include/linux/irqdesc.h

   1 #ifndef _LINUX_IRQDESC_H
   2 #define _LINUX_IRQDESC_H
   3
   4 /*
   5  * Core internal functions to deal with irq descriptors
   6  *
   7  * This include will move to kernel/irq once we cleaned up the tree.
   8  * For now it's included from <linux/irq.h>
   9  */
  10
  11 struct irq_affinity_notify;
  12 struct proc_dir_entry;
  13 struct module;
  14 struct irq_desc;
  15 struct irq_domain;
  16 struct pt_regs;
  17
  18 /**
  19  * struct irq_desc - interrupt descriptor
  20  * @irq_data:           per irq and chip data passed down to chip functions
  21  * @kstat_irqs:         irq stats per cpu
  22  * @handle_irq:         highlevel irq-events handler
  23  * @preflow_handler:    handler called before the flow handler (currently used by sparc)
  24  * @action:             the irq action chain
  25  * @status:             status information
  26  * @core_internal_state__do_not_mess_with_it: core internal status information
  27  * @depth:              disable-depth, for nested irq_disable() calls
  28  * @wake_depth:         enable depth, for multiple irq_set_irq_wake() callers
  29  * @irq_count:          stats field to detect stalled irqs
  30  * @last_unhandled:     aging timer for unhandled count
  31  * @irqs_unhandled:     stats field for spurious unhandled interrupts
  32  * @threads_handled:    stats field for deferred spurious detection of threaded handlers
  33  * @threads_handled_last: comparator field for deferred spurious detection of theraded handlers
  34  * @lock:               locking for SMP
  35  * @affinity_hint:      hint to user space for preferred irq affinity
  36  * @affinity_notify:    context for notification of affinity changes
  37  * @pending_mask:       pending rebalanced interrupts
  38  * @threads_oneshot:    bitfield to handle shared oneshot threads
  39  * @threads_active:     number of irqaction threads currently running
  40  * @wait_for_threads:   wait queue for sync_irq to wait for threaded handlers
  41  * @dir:                /proc/irq/ procfs entry
  42  * @name:               flow handler name for /proc/interrupts output
  43  */
  44 struct irq_desc {
  45         struct irq_data         irq_data;
  46         unsigned int __percpu   *kstat_irqs;
  47         irq_flow_handler_t      handle_irq;
  48 #ifdef CONFIG_IRQ_PREFLOW_FASTEOI
  49         irq_preflow_handler_t   preflow_handler;
  50 #endif
  51         struct irqaction        *action;        /* IRQ action list */
  52         unsigned int            status_use_accessors;
  53         unsigned int            core_internal_state__do_not_mess_with_it;
  54         unsigned int            depth;          /* nested irq disables */
  55         unsigned int            wake_depth;     /* nested wake enables */
  56         unsigned int            irq_count;      /* For detecting broken IRQs */
  57         unsigned long           last_unhandled; /* Aging timer for unhandled count */
  58         unsigned int            irqs_unhandled;
  59         atomic_t                threads_handled;
  60         int                     threads_handled_last;
  61         raw_spinlock_t          lock;
  62         struct cpumask          *percpu_enabled;
  63 #ifdef CONFIG_SMP
  64         const struct cpumask    *affinity_hint;
  65         struct irq_affinity_notify *affinity_notify;
  66 #ifdef CONFIG_GENERIC_PENDING_IRQ
  67         cpumask_var_t           pending_mask;
  68 #endif
  69 #endif
  70         unsigned long           threads_oneshot;
  71         atomic_t                threads_active;
  72         wait_queue_head_t       wait_for_threads;
  73 #ifdef CONFIG_PROC_FS
  74         struct proc_dir_entry   *dir;
  75 #endif
  76         int                     parent_irq;
  77         struct module           *owner;
  78         const char              *name;
  79 } ____cacheline_internodealigned_in_smp;
  80
  81 #ifndef CONFIG_SPARSE_IRQ
  82 extern struct irq_desc irq_desc[NR_IRQS];
  83 #endif
  84
  85 static inline struct irq_data *irq_desc_get_irq_data(struct irq_desc *desc)
  86 {
  87         return &desc->irq_data;
  88 }
  89
  90 static inline struct irq_chip *irq_desc_get_chip(struct irq_desc *desc)
  91 {
  92         return desc->irq_data.chip;
  93 }
  94
  95 static inline void *irq_desc_get_chip_data(struct irq_desc *desc)
  96 {
  97         return desc->irq_data.chip_data;
  98 }
  99
 100 static inline void *irq_desc_get_handler_data(struct irq_desc *desc)
 101 {
 102         return desc->irq_data.handler_data;
 103 }
 104
 105 static inline struct msi_desc *irq_desc_get_msi_desc(struct irq_desc *desc)
 106 {
 107         return desc->irq_data.msi_desc;
 108 }
 109
 110 /*
 111  * Architectures call this to let the generic IRQ layer
 112  * handle an interrupt. If the descriptor is attached to an
 113  * irqchip-style controller then we call the ->handle_irq() handler,
 114  * and it calls __do_IRQ() if it's attached to an irqtype-style controller.
 115  */
 116 static inline void generic_handle_irq_desc(unsigned int irq, struct irq_desc *desc)
 117 {
 118         desc->handle_irq(irq, desc);
 119 }
 120
 121 int generic_handle_irq(unsigned int irq);
 122
 123 #ifdef CONFIG_HANDLE_DOMAIN_IRQ
 124 /*
 125  * Convert a HW interrupt number to a logical one using a IRQ domain,
 126  * and handle the result interrupt number. Return -EINVAL if
 127  * conversion failed. Providing a NULL domain indicates that the
 128  * conversion has already been done.
 129  */
 130 int __handle_domain_irq(struct irq_domain *domain, unsigned int hwirq,
 131                         bool lookup, struct pt_regs *regs);
 132
 133 static inline int handle_domain_irq(struct irq_domain *domain,
 134                                     unsigned int hwirq, struct pt_regs *regs)
 135 {
 136         return __handle_domain_irq(domain, hwirq, true, regs);
 137 }
 138 #endif
 139
 140 /* Test to see if a driver has successfully requested an irq */
 141 static inline int irq_has_action(unsigned int irq)
 142 {
 143         struct irq_desc *desc = irq_to_desc(irq);
 144         return desc->action != NULL;
 145 }
 146
 147 /* caller has locked the irq_desc and both params are valid */
 148 static inline void __irq_set_handler_locked(unsigned int irq,
 149                                             irq_flow_handler_t handler)
 150 {
 151         struct irq_desc *desc;
 152
 153         desc = irq_to_desc(irq);
 154         desc->handle_irq = handler;
 155 }
 156
 157 /* caller has locked the irq_desc and both params are valid */
 158 static inline void
 159 __irq_set_chip_handler_name_locked(unsigned int irq, struct irq_chip *chip,
 160                                    irq_flow_handler_t handler, const char *name)
 161 {
 162         struct irq_desc *desc;
 163
 164         desc = irq_to_desc(irq);
 165         irq_desc_get_irq_data(desc)->chip = chip;
 166         desc->handle_irq = handler;
 167         desc->name = name;
 168 }
 169
 170 static inline int irq_balancing_disabled(unsigned int irq)
 171 {
 172         struct irq_desc *desc;
 173
 174         desc = irq_to_desc(irq);
 175         return desc->status_use_accessors & IRQ_NO_BALANCING_MASK;
 176 }
 177
 178 static inline int irq_is_percpu(unsigned int irq)
 179 {
 180         struct irq_desc *desc;
 181
 182         desc = irq_to_desc(irq);
 183         return desc->status_use_accessors & IRQ_PER_CPU;
 184 }
 185
 186 static inline void
 187 irq_set_lockdep_class(unsigned int irq, struct lock_class_key *class)
 188 {
 189         struct irq_desc *desc = irq_to_desc(irq);
 190
 191         if (desc)
 192                 lockdep_set_class(&desc->lock, class);
 193 }
 194
 195 #ifdef CONFIG_IRQ_PREFLOW_FASTEOI
 196 static inline void
 197 __irq_set_preflow_handler(unsigned int irq, irq_preflow_handler_t handler)
 198 {
 199         struct irq_desc *desc;
 200
 201         desc = irq_to_desc(irq);
 202         desc->preflow_handler = handler;
 203 }
 204 #endif
 205
 206 #endif