include/linux/irqdesc.h

   1 #ifndef _LINUX_IRQDESC_H
   2 #define _LINUX_IRQDESC_H
   3
   4 #include <linux/rcupdate.h>
   5 #include <linux/kobject.h>
   6
   7 /*
   8  * Core internal functions to deal with irq descriptors
   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  * @rcu:                rcu head for delayed free
  47  * @kobj:               kobject used to represent this struct in sysfs
  48  * @dir:                /proc/irq/ procfs entry
  49  * @debugfs_file:       dentry for the debugfs file
  50  * @name:               flow handler name for /proc/interrupts output
  51  */
  52 struct irq_desc {
  53         struct irq_common_data  irq_common_data;
  54         struct irq_data         irq_data;
  55         unsigned int __percpu   *kstat_irqs;
  56         irq_flow_handler_t      handle_irq;
  57 #ifdef CONFIG_IRQ_PREFLOW_FASTEOI
  58         irq_preflow_handler_t   preflow_handler;
  59 #endif
  60         struct irqaction        *action;        /* IRQ action list */
  61         unsigned int            status_use_accessors;
  62         unsigned int            core_internal_state__do_not_mess_with_it;
  63         unsigned int            depth;          /* nested irq disables */
  64         unsigned int            wake_depth;     /* nested wake enables */
  65         unsigned int            irq_count;      /* For detecting broken IRQs */
  66         unsigned long           last_unhandled; /* Aging timer for unhandled count */
  67         unsigned int            irqs_unhandled;
  68         atomic_t                threads_handled;
  69         int                     threads_handled_last;
  70         raw_spinlock_t          lock;
  71         struct cpumask          *percpu_enabled;
  72         const struct cpumask    *percpu_affinity;
  73 #ifdef CONFIG_SMP
  74         const struct cpumask    *affinity_hint;
  75         struct irq_affinity_notify *affinity_notify;
  76 #ifdef CONFIG_GENERIC_PENDING_IRQ
  77         cpumask_var_t           pending_mask;
  78 #endif
  79 #endif
  80         unsigned long           threads_oneshot;
  81         atomic_t                threads_active;
  82         wait_queue_head_t       wait_for_threads;
  83 #ifdef CONFIG_PM_SLEEP
  84         unsigned int            nr_actions;
  85         unsigned int            no_suspend_depth;
  86         unsigned int            cond_suspend_depth;
  87         unsigned int            force_resume_depth;
  88 #endif
  89 #ifdef CONFIG_PROC_FS
  90         struct proc_dir_entry   *dir;
  91 #endif
  92 #ifdef CONFIG_GENERIC_IRQ_DEBUGFS
  93         struct dentry           *debugfs_file;
  94 #endif
  95 #ifdef CONFIG_SPARSE_IRQ
  96         struct rcu_head         rcu;
  97         struct kobject          kobj;
  98 #endif
  99         int                     parent_irq;
 100         struct module           *owner;
 101         const char              *name;
 102 } ____cacheline_internodealigned_in_smp;
 103
 104 #ifdef CONFIG_SPARSE_IRQ
 105 extern void irq_lock_sparse(void);
 106 extern void irq_unlock_sparse(void);
 107 #else
 108 static inline void irq_lock_sparse(void) { }
 109 static inline void irq_unlock_sparse(void) { }
 110 extern struct irq_desc irq_desc[NR_IRQS];
 111 #endif
 112
 113 static inline struct irq_desc *irq_data_to_desc(struct irq_data *data)
 114 {
 115         return container_of(data->common, struct irq_desc, irq_common_data);
 116 }
 117
 118 static inline unsigned int irq_desc_get_irq(struct irq_desc *desc)
 119 {
 120         return desc->irq_data.irq;
 121 }
 122
 123 static inline struct irq_data *irq_desc_get_irq_data(struct irq_desc *desc)
 124 {
 125         return &desc->irq_data;
 126 }
 127
 128 static inline struct irq_chip *irq_desc_get_chip(struct irq_desc *desc)
 129 {
 130         return desc->irq_data.chip;
 131 }
 132
 133 static inline void *irq_desc_get_chip_data(struct irq_desc *desc)
 134 {
 135         return desc->irq_data.chip_data;
 136 }
 137
 138 static inline void *irq_desc_get_handler_data(struct irq_desc *desc)
 139 {
 140         return desc->irq_common_data.handler_data;
 141 }
 142
 143 static inline struct msi_desc *irq_desc_get_msi_desc(struct irq_desc *desc)
 144 {
 145         return desc->irq_common_data.msi_desc;
 146 }
 147
 148 /*
 149  * Architectures call this to let the generic IRQ layer
 150  * handle an interrupt.
 151  */
 152 static inline void generic_handle_irq_desc(struct irq_desc *desc)
 153 {
 154         desc->handle_irq(desc);
 155 }
 156
 157 int generic_handle_irq(unsigned int irq);
 158
 159 #ifdef CONFIG_HANDLE_DOMAIN_IRQ
 160 /*
 161  * Convert a HW interrupt number to a logical one using a IRQ domain,
 162  * and handle the result interrupt number. Return -EINVAL if
 163  * conversion failed. Providing a NULL domain indicates that the
 164  * conversion has already been done.
 165  */
 166 int __handle_domain_irq(struct irq_domain *domain, unsigned int hwirq,
 167                         bool lookup, struct pt_regs *regs);
 168
 169 static inline int handle_domain_irq(struct irq_domain *domain,
 170                                     unsigned int hwirq, struct pt_regs *regs)
 171 {
 172         return __handle_domain_irq(domain, hwirq, true, regs);
 173 }
 174 #endif
 175
 176 /* Test to see if a driver has successfully requested an irq */
 177 static inline int irq_desc_has_action(struct irq_desc *desc)
 178 {
 179         return desc->action != NULL;
 180 }
 181
 182 static inline int irq_has_action(unsigned int irq)
 183 {
 184         return irq_desc_has_action(irq_to_desc(irq));
 185 }
 186
 187 /**
 188  * irq_set_handler_locked - Set irq handler from a locked region
 189  * @data:       Pointer to the irq_data structure which identifies the irq
 190  * @handler:    Flow control handler function for this interrupt
 191  *
 192  * Sets the handler in the irq descriptor associated to @data.
 193  *
 194  * Must be called with irq_desc locked and valid parameters. Typical
 195  * call site is the irq_set_type() callback.
 196  */
 197 static inline void irq_set_handler_locked(struct irq_data *data,
 198                                           irq_flow_handler_t handler)
 199 {
 200         struct irq_desc *desc = irq_data_to_desc(data);
 201
 202         desc->handle_irq = handler;
 203 }
 204
 205 /**
 206  * irq_set_chip_handler_name_locked - Set chip, handler and name from a locked region
 207  * @data:       Pointer to the irq_data structure for which the chip is set
 208  * @chip:       Pointer to the new irq chip
 209  * @handler:    Flow control handler function for this interrupt
 210  * @name:       Name of the interrupt
 211  *
 212  * Replace the irq chip at the proper hierarchy level in @data and
 213  * sets the handler and name in the associated irq descriptor.
 214  *
 215  * Must be called with irq_desc locked and valid parameters.
 216  */
 217 static inline void
 218 irq_set_chip_handler_name_locked(struct irq_data *data, struct irq_chip *chip,
 219                                  irq_flow_handler_t handler, const char *name)
 220 {
 221         struct irq_desc *desc = irq_data_to_desc(data);
 222
 223         desc->handle_irq = handler;
 224         desc->name = name;
 225         data->chip = chip;
 226 }
 227
 228 static inline int irq_balancing_disabled(unsigned int irq)
 229 {
 230         struct irq_desc *desc;
 231
 232         desc = irq_to_desc(irq);
 233         return desc->status_use_accessors & IRQ_NO_BALANCING_MASK;
 234 }
 235
 236 static inline int irq_is_percpu(unsigned int irq)
 237 {
 238         struct irq_desc *desc;
 239
 240         desc = irq_to_desc(irq);
 241         return desc->status_use_accessors & IRQ_PER_CPU;
 242 }
 243
 244 static inline void
 245 irq_set_lockdep_class(unsigned int irq, struct lock_class_key *class)
 246 {
 247         struct irq_desc *desc = irq_to_desc(irq);
 248
 249         if (desc)
 250                 lockdep_set_class(&desc->lock, class);
 251 }
 252
 253 #ifdef CONFIG_IRQ_PREFLOW_FASTEOI
 254 static inline void
 255 __irq_set_preflow_handler(unsigned int irq, irq_preflow_handler_t handler)
 256 {
 257         struct irq_desc *desc;
 258
 259         desc = irq_to_desc(irq);
 260         desc->preflow_handler = handler;
 261 }
 262 #endif
 263
 264 #endif