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