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_common_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  * @nr_actions:         number of installed actions on this descriptor
  42  * @no_suspend_depth:   number of irqactions on a irq descriptor with
  43  *                      IRQF_NO_SUSPEND set
  44  * @force_resume_depth: number of irqactions on a irq descriptor with
  45  *                      IRQF_FORCE_RESUME set
  46  * @dir:                /proc/irq/ procfs entry
  47  * @name:               flow handler name for /proc/interrupts output
  48  */
  49 struct irq_desc {
  50         struct irq_common_data  irq_common_data;
  51         struct irq_data         irq_data;
  52         unsigned int __percpu   *kstat_irqs;
  53         irq_flow_handler_t      handle_irq;
  54 #ifdef CONFIG_IRQ_PREFLOW_FASTEOI
  55         irq_preflow_handler_t   preflow_handler;
  56 #endif
  57         struct irqaction        *action;        /* IRQ action list */
  58         unsigned int            status_use_accessors;
  59         unsigned int            core_internal_state__do_not_mess_with_it;
  60         unsigned int            depth;          /* nested irq disables */
  61         unsigned int            wake_depth;     /* nested wake enables */
  62         unsigned int            irq_count;      /* For detecting broken IRQs */
  63         unsigned long           last_unhandled; /* Aging timer for unhandled count */
  64         unsigned int            irqs_unhandled;
  65         atomic_t                threads_handled;
  66         int                     threads_handled_last;
  67         raw_spinlock_t          lock;
  68         struct cpumask          *percpu_enabled;
  69 #ifdef CONFIG_SMP
  70         const struct cpumask    *affinity_hint;
  71         struct irq_affinity_notify *affinity_notify;
  72 #ifdef CONFIG_GENERIC_PENDING_IRQ
  73         cpumask_var_t           pending_mask;
  74 #endif
  75 #endif
  76         unsigned long           threads_oneshot;
  77         atomic_t                threads_active;
  78         wait_queue_head_t       wait_for_threads;
  79 #ifdef CONFIG_PM_SLEEP
  80         unsigned int            nr_actions;
  81         unsigned int            no_suspend_depth;
  82         unsigned int            cond_suspend_depth;
  83         unsigned int            force_resume_depth;
  84 #endif
  85 #ifdef CONFIG_PROC_FS
  86         struct proc_dir_entry   *dir;
  87 #endif
  88         int                     parent_irq;
  89         struct module           *owner;
  90         const char              *name;
  91 } ____cacheline_internodealigned_in_smp;
  92
  93 #ifndef CONFIG_SPARSE_IRQ
  94 extern struct irq_desc irq_desc[NR_IRQS];
  95 #endif
  96
  97 static inline struct irq_desc *irq_data_to_desc(struct irq_data *data)
  98 {
  99 #ifdef CONFIG_IRQ_DOMAIN_HIERARCHY
 100         return irq_to_desc(data->irq);
 101 #else
 102         return container_of(data, struct irq_desc, irq_data);
 103 #endif
 104 }
 105
 106 static inline struct irq_data *irq_desc_get_irq_data(struct irq_desc *desc)
 107 {
 108         return &desc->irq_data;
 109 }
 110
 111 static inline struct irq_chip *irq_desc_get_chip(struct irq_desc *desc)
 112 {
 113         return desc->irq_data.chip;
 114 }
 115
 116 static inline void *irq_desc_get_chip_data(struct irq_desc *desc)
 117 {
 118         return desc->irq_data.chip_data;
 119 }
 120
 121 static inline void *irq_desc_get_handler_data(struct irq_desc *desc)
 122 {
 123         return desc->irq_data.handler_data;
 124 }
 125
 126 static inline struct msi_desc *irq_desc_get_msi_desc(struct irq_desc *desc)
 127 {
 128         return desc->irq_data.msi_desc;
 129 }
 130
 131 /*
 132  * Architectures call this to let the generic IRQ layer
 133  * handle an interrupt. If the descriptor is attached to an
 134  * irqchip-style controller then we call the ->handle_irq() handler,
 135  * and it calls __do_IRQ() if it's attached to an irqtype-style controller.
 136  */
 137 static inline void generic_handle_irq_desc(unsigned int irq, struct irq_desc *desc)
 138 {
 139         desc->handle_irq(irq, desc);
 140 }
 141
 142 int generic_handle_irq(unsigned int irq);
 143
 144 #ifdef CONFIG_HANDLE_DOMAIN_IRQ
 145 /*
 146  * Convert a HW interrupt number to a logical one using a IRQ domain,
 147  * and handle the result interrupt number. Return -EINVAL if
 148  * conversion failed. Providing a NULL domain indicates that the
 149  * conversion has already been done.
 150  */
 151 int __handle_domain_irq(struct irq_domain *domain, unsigned int hwirq,
 152                         bool lookup, struct pt_regs *regs);
 153
 154 static inline int handle_domain_irq(struct irq_domain *domain,
 155                                     unsigned int hwirq, struct pt_regs *regs)
 156 {
 157         return __handle_domain_irq(domain, hwirq, true, regs);
 158 }
 159 #endif
 160
 161 /* Test to see if a driver has successfully requested an irq */
 162 static inline int irq_has_action(unsigned int irq)
 163 {
 164         struct irq_desc *desc = irq_to_desc(irq);
 165         return desc->action != NULL;
 166 }
 167
 168 /* caller has locked the irq_desc and both params are valid */
 169 static inline void __irq_set_handler_locked(unsigned int irq,
 170                                             irq_flow_handler_t handler)
 171 {
 172         struct irq_desc *desc;
 173
 174         desc = irq_to_desc(irq);
 175         desc->handle_irq = handler;
 176 }
 177
 178 /* caller has locked the irq_desc and both params are valid */
 179 static inline void
 180 __irq_set_chip_handler_name_locked(unsigned int irq, struct irq_chip *chip,
 181                                    irq_flow_handler_t handler, const char *name)
 182 {
 183         struct irq_desc *desc;
 184
 185         desc = irq_to_desc(irq);
 186         irq_desc_get_irq_data(desc)->chip = chip;
 187         desc->handle_irq = handler;
 188         desc->name = name;
 189 }
 190
 191 static inline int irq_balancing_disabled(unsigned int irq)
 192 {
 193         struct irq_desc *desc;
 194
 195         desc = irq_to_desc(irq);
 196         return desc->status_use_accessors & IRQ_NO_BALANCING_MASK;
 197 }
 198
 199 static inline int irq_is_percpu(unsigned int irq)
 200 {
 201         struct irq_desc *desc;
 202
 203         desc = irq_to_desc(irq);
 204         return desc->status_use_accessors & IRQ_PER_CPU;
 205 }
 206
 207 static inline void
 208 irq_set_lockdep_class(unsigned int irq, struct lock_class_key *class)
 209 {
 210         struct irq_desc *desc = irq_to_desc(irq);
 211
 212         if (desc)
 213                 lockdep_set_class(&desc->lock, class);
 214 }
 215
 216 #ifdef CONFIG_IRQ_PREFLOW_FASTEOI
 217 static inline void
 218 __irq_set_preflow_handler(unsigned int irq, irq_preflow_handler_t handler)
 219 {
 220         struct irq_desc *desc;
 221
 222         desc = irq_to_desc(irq);
 223         desc->preflow_handler = handler;
 224 }
 225 #endif
 226
 227 #endif