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  * @name:               flow handler name for /proc/interrupts output
  50  */
  51 struct irq_desc {
  52         struct irq_common_data  irq_common_data;
  53         struct irq_data         irq_data;
  54         unsigned int __percpu   *kstat_irqs;
  55         irq_flow_handler_t      handle_irq;
  56 #ifdef CONFIG_IRQ_PREFLOW_FASTEOI
  57         irq_preflow_handler_t   preflow_handler;
  58 #endif
  59         struct irqaction        *action;        /* IRQ action list */
  60         unsigned int            status_use_accessors;
  61         unsigned int            core_internal_state__do_not_mess_with_it;
  62         unsigned int            depth;          /* nested irq disables */
  63         unsigned int            wake_depth;     /* nested wake enables */
  64         unsigned int            tot_count;
  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_SPARSE_IRQ
  93         struct rcu_head         rcu;
  94         struct kobject          kobj;
  95 #endif
  96         int                     parent_irq;
  97         struct module           *owner;
  98         const char              *name;
  99 } ____cacheline_internodealigned_in_smp;
 100
 101 #ifdef CONFIG_SPARSE_IRQ
 102 extern void irq_lock_sparse(void);
 103 extern void irq_unlock_sparse(void);
 104 #else
 105 static inline void irq_lock_sparse(void) { }
 106 static inline void irq_unlock_sparse(void) { }
 107 extern struct irq_desc irq_desc[NR_IRQS];
 108 #endif
 109
 110 static inline struct irq_desc *irq_data_to_desc(struct irq_data *data)
 111 {
 112         return container_of(data->common, struct irq_desc, irq_common_data);
 113 }
 114
 115 static inline unsigned int irq_desc_get_irq(struct irq_desc *desc)
 116 {
 117         return desc->irq_data.irq;
 118 }
 119
 120 static inline struct irq_data *irq_desc_get_irq_data(struct irq_desc *desc)
 121 {
 122         return &desc->irq_data;
 123 }
 124
 125 static inline struct irq_chip *irq_desc_get_chip(struct irq_desc *desc)
 126 {
 127         return desc->irq_data.chip;
 128 }
 129
 130 static inline void *irq_desc_get_chip_data(struct irq_desc *desc)
 131 {
 132         return desc->irq_data.chip_data;
 133 }
 134
 135 static inline void *irq_desc_get_handler_data(struct irq_desc *desc)
 136 {
 137         return desc->irq_common_data.handler_data;
 138 }
 139
 140 static inline struct msi_desc *irq_desc_get_msi_desc(struct irq_desc *desc)
 141 {
 142         return desc->irq_common_data.msi_desc;
 143 }
 144
 145 /*
 146  * Architectures call this to let the generic IRQ layer
 147  * handle an interrupt.
 148  */
 149 static inline void generic_handle_irq_desc(struct irq_desc *desc)
 150 {
 151         desc->handle_irq(desc);
 152 }
 153
 154 int generic_handle_irq(unsigned int irq);
 155
 156 #ifdef CONFIG_HANDLE_DOMAIN_IRQ
 157 /*
 158  * Convert a HW interrupt number to a logical one using a IRQ domain,
 159  * and handle the result interrupt number. Return -EINVAL if
 160  * conversion failed. Providing a NULL domain indicates that the
 161  * conversion has already been done.
 162  */
 163 int __handle_domain_irq(struct irq_domain *domain, unsigned int hwirq,
 164                         bool lookup, struct pt_regs *regs);
 165
 166 static inline int handle_domain_irq(struct irq_domain *domain,
 167                                     unsigned int hwirq, struct pt_regs *regs)
 168 {
 169         return __handle_domain_irq(domain, hwirq, true, regs);
 170 }
 171 #endif
 172
 173 /* Test to see if a driver has successfully requested an irq */
 174 static inline int irq_desc_has_action(struct irq_desc *desc)
 175 {
 176         return desc->action != NULL;
 177 }
 178
 179 static inline int irq_has_action(unsigned int irq)
 180 {
 181         return irq_desc_has_action(irq_to_desc(irq));
 182 }
 183
 184 /**
 185  * irq_set_handler_locked - Set irq handler from a locked region
 186  * @data:       Pointer to the irq_data structure which identifies the irq
 187  * @handler:    Flow control handler function for this interrupt
 188  *
 189  * Sets the handler in the irq descriptor associated to @data.
 190  *
 191  * Must be called with irq_desc locked and valid parameters. Typical
 192  * call site is the irq_set_type() callback.
 193  */
 194 static inline void irq_set_handler_locked(struct irq_data *data,
 195                                           irq_flow_handler_t handler)
 196 {
 197         struct irq_desc *desc = irq_data_to_desc(data);
 198
 199         desc->handle_irq = handler;
 200 }
 201
 202 /**
 203  * irq_set_chip_handler_name_locked - Set chip, handler and name from a locked region
 204  * @data:       Pointer to the irq_data structure for which the chip is set
 205  * @chip:       Pointer to the new irq chip
 206  * @handler:    Flow control handler function for this interrupt
 207  * @name:       Name of the interrupt
 208  *
 209  * Replace the irq chip at the proper hierarchy level in @data and
 210  * sets the handler and name in the associated irq descriptor.
 211  *
 212  * Must be called with irq_desc locked and valid parameters.
 213  */
 214 static inline void
 215 irq_set_chip_handler_name_locked(struct irq_data *data, struct irq_chip *chip,
 216                                  irq_flow_handler_t handler, const char *name)
 217 {
 218         struct irq_desc *desc = irq_data_to_desc(data);
 219
 220         desc->handle_irq = handler;
 221         desc->name = name;
 222         data->chip = chip;
 223 }
 224
 225 static inline int irq_balancing_disabled(unsigned int irq)
 226 {
 227         struct irq_desc *desc;
 228
 229         desc = irq_to_desc(irq);
 230         return desc->status_use_accessors & IRQ_NO_BALANCING_MASK;
 231 }
 232
 233 static inline int irq_is_percpu(unsigned int irq)
 234 {
 235         struct irq_desc *desc;
 236
 237         desc = irq_to_desc(irq);
 238         return desc->status_use_accessors & IRQ_PER_CPU;
 239 }
 240
 241 static inline void
 242 irq_set_lockdep_class(unsigned int irq, struct lock_class_key *class)
 243 {
 244         struct irq_desc *desc = irq_to_desc(irq);
 245
 246         if (desc)
 247                 lockdep_set_class(&desc->lock, class);
 248 }
 249
 250 #ifdef CONFIG_IRQ_PREFLOW_FASTEOI
 251 static inline void
 252 __irq_set_preflow_handler(unsigned int irq, irq_preflow_handler_t handler)
 253 {
 254         struct irq_desc *desc;
 255
 256         desc = irq_to_desc(irq);
 257         desc->preflow_handler = handler;
 258 }
 259 #endif
 260
 261 #endif