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