include/linux/irqdesc.h

   1 #ifndef _LINUX_IRQDESC_H
   2 #define _LINUX_IRQDESC_H
   3
   4 #include <linux/rcupdate.h>
   5
   6 /*
   7  * Core internal functions to deal with irq descriptors
   8  */
   9
  10 struct irq_affinity_notify;
  11 struct proc_dir_entry;
  12 struct module;
  13 struct irq_desc;
  14 struct irq_domain;
  15 struct pt_regs;
  16
  17 /**
  18  * struct irq_desc - interrupt descriptor
  19  * @irq_common_data:    per irq and chip data passed down to chip functions
  20  * @kstat_irqs:         irq stats per cpu
  21  * @handle_irq:         highlevel irq-events handler
  22  * @preflow_handler:    handler called before the flow handler (currently used by sparc)
  23  * @action:             the irq action chain
  24  * @status:             status information
  25  * @core_internal_state__do_not_mess_with_it: core internal status information
  26  * @depth:              disable-depth, for nested irq_disable() calls
  27  * @wake_depth:         enable depth, for multiple irq_set_irq_wake() callers
  28  * @irq_count:          stats field to detect stalled irqs
  29  * @last_unhandled:     aging timer for unhandled count
  30  * @irqs_unhandled:     stats field for spurious unhandled interrupts
  31  * @threads_handled:    stats field for deferred spurious detection of threaded handlers
  32  * @threads_handled_last: comparator field for deferred spurious detection of theraded handlers
  33  * @lock:               locking for SMP
  34  * @affinity_hint:      hint to user space for preferred irq affinity
  35  * @affinity_notify:    context for notification of affinity changes
  36  * @pending_mask:       pending rebalanced interrupts
  37  * @threads_oneshot:    bitfield to handle shared oneshot threads
  38  * @threads_active:     number of irqaction threads currently running
  39  * @wait_for_threads:   wait queue for sync_irq to wait for threaded handlers
  40  * @nr_actions:         number of installed actions on this descriptor
  41  * @no_suspend_depth:   number of irqactions on a irq descriptor with
  42  *                      IRQF_NO_SUSPEND set
  43  * @force_resume_depth: number of irqactions on a irq descriptor with
  44  *                      IRQF_FORCE_RESUME set
  45  * @rcu:                rcu head for delayed free
  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         const struct cpumask    *percpu_affinity;
  70 #ifdef CONFIG_SMP
  71         const struct cpumask    *affinity_hint;
  72         struct irq_affinity_notify *affinity_notify;
  73 #ifdef CONFIG_GENERIC_PENDING_IRQ
  74         cpumask_var_t           pending_mask;
  75 #endif
  76 #endif
  77         unsigned long           threads_oneshot;
  78         atomic_t                threads_active;
  79         wait_queue_head_t       wait_for_threads;
  80 #ifdef CONFIG_PM_SLEEP
  81         unsigned int            nr_actions;
  82         unsigned int            no_suspend_depth;
  83         unsigned int            cond_suspend_depth;
  84         unsigned int            force_resume_depth;
  85 #endif
  86 #ifdef CONFIG_PROC_FS
  87         struct proc_dir_entry   *dir;
  88 #endif
  89 #ifdef CONFIG_SPARSE_IRQ
  90         struct rcu_head         rcu;
  91 #endif
  92         int                     parent_irq;
  93         struct module           *owner;
  94         const char              *name;
  95 } ____cacheline_internodealigned_in_smp;
  96
  97 #ifdef CONFIG_SPARSE_IRQ
  98 extern void irq_lock_sparse(void);
  99 extern void irq_unlock_sparse(void);
 100 #else
 101 static inline void irq_lock_sparse(void) { }
 102 static inline void irq_unlock_sparse(void) { }
 103 extern struct irq_desc irq_desc[NR_IRQS];
 104 #endif
 105
 106 static inline struct irq_desc *irq_data_to_desc(struct irq_data *data)
 107 {
 108         return container_of(data->common, struct irq_desc, irq_common_data);
 109 }
 110
 111 static inline unsigned int irq_desc_get_irq(struct irq_desc *desc)
 112 {
 113         return desc->irq_data.irq;
 114 }
 115
 116 static inline struct irq_data *irq_desc_get_irq_data(struct irq_desc *desc)
 117 {
 118         return &desc->irq_data;
 119 }
 120
 121 static inline struct irq_chip *irq_desc_get_chip(struct irq_desc *desc)
 122 {
 123         return desc->irq_data.chip;
 124 }
 125
 126 static inline void *irq_desc_get_chip_data(struct irq_desc *desc)
 127 {
 128         return desc->irq_data.chip_data;
 129 }
 130
 131 static inline void *irq_desc_get_handler_data(struct irq_desc *desc)
 132 {
 133         return desc->irq_common_data.handler_data;
 134 }
 135
 136 static inline struct msi_desc *irq_desc_get_msi_desc(struct irq_desc *desc)
 137 {
 138         return desc->irq_common_data.msi_desc;
 139 }
 140
 141 /*
 142  * Architectures call this to let the generic IRQ layer
 143  * handle an interrupt.
 144  */
 145 static inline void generic_handle_irq_desc(struct irq_desc *desc)
 146 {
 147         desc->handle_irq(desc);
 148 }
 149
 150 int generic_handle_irq(unsigned int irq);
 151
 152 #ifdef CONFIG_HANDLE_DOMAIN_IRQ
 153 /*
 154  * Convert a HW interrupt number to a logical one using a IRQ domain,
 155  * and handle the result interrupt number. Return -EINVAL if
 156  * conversion failed. Providing a NULL domain indicates that the
 157  * conversion has already been done.
 158  */
 159 int __handle_domain_irq(struct irq_domain *domain, unsigned int hwirq,
 160                         bool lookup, struct pt_regs *regs);
 161
 162 static inline int handle_domain_irq(struct irq_domain *domain,
 163                                     unsigned int hwirq, struct pt_regs *regs)
 164 {
 165         return __handle_domain_irq(domain, hwirq, true, regs);
 166 }
 167 #endif
 168
 169 /* Test to see if a driver has successfully requested an irq */
 170 static inline int irq_desc_has_action(struct irq_desc *desc)
 171 {
 172         return desc->action != NULL;
 173 }
 174
 175 static inline int irq_has_action(unsigned int irq)
 176 {
 177         return irq_desc_has_action(irq_to_desc(irq));
 178 }
 179
 180 /**
 181  * irq_set_handler_locked - Set irq handler from a locked region
 182  * @data:       Pointer to the irq_data structure which identifies the irq
 183  * @handler:    Flow control handler function for this interrupt
 184  *
 185  * Sets the handler in the irq descriptor associated to @data.
 186  *
 187  * Must be called with irq_desc locked and valid parameters. Typical
 188  * call site is the irq_set_type() callback.
 189  */
 190 static inline void irq_set_handler_locked(struct irq_data *data,
 191                                           irq_flow_handler_t handler)
 192 {
 193         struct irq_desc *desc = irq_data_to_desc(data);
 194
 195         desc->handle_irq = handler;
 196 }
 197
 198 /**
 199  * irq_set_chip_handler_name_locked - Set chip, handler and name from a locked region
 200  * @data:       Pointer to the irq_data structure for which the chip is set
 201  * @chip:       Pointer to the new irq chip
 202  * @handler:    Flow control handler function for this interrupt
 203  * @name:       Name of the interrupt
 204  *
 205  * Replace the irq chip at the proper hierarchy level in @data and
 206  * sets the handler and name in the associated irq descriptor.
 207  *
 208  * Must be called with irq_desc locked and valid parameters.
 209  */
 210 static inline void
 211 irq_set_chip_handler_name_locked(struct irq_data *data, struct irq_chip *chip,
 212                                  irq_flow_handler_t handler, const char *name)
 213 {
 214         struct irq_desc *desc = irq_data_to_desc(data);
 215
 216         desc->handle_irq = handler;
 217         desc->name = name;
 218         data->chip = chip;
 219 }
 220
 221 static inline int irq_balancing_disabled(unsigned int irq)
 222 {
 223         struct irq_desc *desc;
 224
 225         desc = irq_to_desc(irq);
 226         return desc->status_use_accessors & IRQ_NO_BALANCING_MASK;
 227 }
 228
 229 static inline int irq_is_percpu(unsigned int irq)
 230 {
 231         struct irq_desc *desc;
 232
 233         desc = irq_to_desc(irq);
 234         return desc->status_use_accessors & IRQ_PER_CPU;
 235 }
 236
 237 static inline void
 238 irq_set_lockdep_class(unsigned int irq, struct lock_class_key *class)
 239 {
 240         struct irq_desc *desc = irq_to_desc(irq);
 241
 242         if (desc)
 243                 lockdep_set_class(&desc->lock, class);
 244 }
 245
 246 #ifdef CONFIG_IRQ_PREFLOW_FASTEOI
 247 static inline void
 248 __irq_set_preflow_handler(unsigned int irq, irq_preflow_handler_t handler)
 249 {
 250         struct irq_desc *desc;
 251
 252         desc = irq_to_desc(irq);
 253         desc->preflow_handler = handler;
 254 }
 255 #endif
 256
 257 #endif