include/linux/irq.h

   1 #ifndef _LINUX_IRQ_H
   2 #define _LINUX_IRQ_H
   3
   4 /*
   5  * Please do not include this file in generic code.  There is currently
   6  * no requirement for any architecture to implement anything held
   7  * within this file.
   8  *
   9  * Thanks. --rmk
  10  */
  11
  12 #include <linux/smp.h>
  13
  14 #ifndef CONFIG_S390
  15
  16 #include <linux/linkage.h>
  17 #include <linux/cache.h>
  18 #include <linux/spinlock.h>
  19 #include <linux/cpumask.h>
  20 #include <linux/irqreturn.h>
  21
  22 #include <asm/irq.h>
  23 #include <asm/ptrace.h>
  24 #include <asm/irq_regs.h>
  25
  26 struct irq_desc;
  27 typedef void fastcall (*irq_flow_handler_t)(unsigned int irq,
  28                                             struct irq_desc *desc);
  29
  30
  31 /*
  32  * IRQ line status.
  33  *
  34  * Bits 0-16 are reserved for the IRQF_* bits in linux/interrupt.h
  35  *
  36  * IRQ types
  37  */
  38 #define IRQ_TYPE_NONE           0x00000000      /* Default, unspecified type */
  39 #define IRQ_TYPE_EDGE_RISING    0x00000001      /* Edge rising type */
  40 #define IRQ_TYPE_EDGE_FALLING   0x00000002      /* Edge falling type */
  41 #define IRQ_TYPE_EDGE_BOTH (IRQ_TYPE_EDGE_FALLING | IRQ_TYPE_EDGE_RISING)
  42 #define IRQ_TYPE_LEVEL_HIGH     0x00000004      /* Level high type */
  43 #define IRQ_TYPE_LEVEL_LOW      0x00000008      /* Level low type */
  44 #define IRQ_TYPE_SENSE_MASK     0x0000000f      /* Mask of the above */
  45 #define IRQ_TYPE_PROBE          0x00000010      /* Probing in progress */
  46
  47 /* Internal flags */
  48 #define IRQ_INPROGRESS          0x00010000      /* IRQ handler active - do not enter! */
  49 #define IRQ_DISABLED            0x00020000      /* IRQ disabled - do not enter! */
  50 #define IRQ_PENDING             0x00040000      /* IRQ pending - replay on enable */
  51 #define IRQ_REPLAY              0x00080000      /* IRQ has been replayed but not acked yet */
  52 #define IRQ_AUTODETECT          0x00100000      /* IRQ is being autodetected */
  53 #define IRQ_WAITING             0x00200000      /* IRQ not yet seen - for autodetection */
  54 #define IRQ_LEVEL               0x00400000      /* IRQ level triggered */
  55 #define IRQ_MASKED              0x00800000      /* IRQ masked - shouldn't be seen again */
  56 #define IRQ_PER_CPU             0x01000000      /* IRQ is per CPU */
  57 #ifdef CONFIG_IRQ_PER_CPU
  58 # define CHECK_IRQ_PER_CPU(var) ((var) & IRQ_PER_CPU)
  59 #else
  60 # define CHECK_IRQ_PER_CPU(var) 0
  61 #endif
  62
  63 #define IRQ_NOPROBE             0x02000000      /* IRQ is not valid for probing */
  64 #define IRQ_NOREQUEST           0x04000000      /* IRQ cannot be requested */
  65 #define IRQ_NOAUTOEN            0x08000000      /* IRQ will not be enabled on request irq */
  66 #define IRQ_DELAYED_DISABLE     0x10000000      /* IRQ disable (masking) happens delayed. */
  67 #define IRQ_WAKEUP              0x20000000      /* IRQ triggers system wakeup */
  68 #define IRQ_MOVE_PENDING        0x40000000      /* need to re-target IRQ destination */
  69
  70 struct proc_dir_entry;
  71
  72 /**
  73  * struct irq_chip - hardware interrupt chip descriptor
  74  *
  75  * @name:               name for /proc/interrupts
  76  * @startup:            start up the interrupt (defaults to ->enable if NULL)
  77  * @shutdown:           shut down the interrupt (defaults to ->disable if NULL)
  78  * @enable:             enable the interrupt (defaults to chip->unmask if NULL)
  79  * @disable:            disable the interrupt (defaults to chip->mask if NULL)
  80  * @ack:                start of a new interrupt
  81  * @mask:               mask an interrupt source
  82  * @mask_ack:           ack and mask an interrupt source
  83  * @unmask:             unmask an interrupt source
  84  * @eoi:                end of interrupt - chip level
  85  * @end:                end of interrupt - flow level
  86  * @set_affinity:       set the CPU affinity on SMP machines
  87  * @retrigger:          resend an IRQ to the CPU
  88  * @set_type:           set the flow type (IRQ_TYPE_LEVEL/etc.) of an IRQ
  89  * @set_wake:           enable/disable power-management wake-on of an IRQ
  90  *
  91  * @release:            release function solely used by UML
  92  * @typename:           obsoleted by name, kept as migration helper
  93  */
  94 struct irq_chip {
  95         const char      *name;
  96         unsigned int    (*startup)(unsigned int irq);
  97         void            (*shutdown)(unsigned int irq);
  98         void            (*enable)(unsigned int irq);
  99         void            (*disable)(unsigned int irq);
 100
 101         void            (*ack)(unsigned int irq);
 102         void            (*mask)(unsigned int irq);
 103         void            (*mask_ack)(unsigned int irq);
 104         void            (*unmask)(unsigned int irq);
 105         void            (*eoi)(unsigned int irq);
 106
 107         void            (*end)(unsigned int irq);
 108         void            (*set_affinity)(unsigned int irq, cpumask_t dest);
 109         int             (*retrigger)(unsigned int irq);
 110         int             (*set_type)(unsigned int irq, unsigned int flow_type);
 111         int             (*set_wake)(unsigned int irq, unsigned int on);
 112
 113         /* Currently used only by UML, might disappear one day.*/
 114 #ifdef CONFIG_IRQ_RELEASE_METHOD
 115         void            (*release)(unsigned int irq, void *dev_id);
 116 #endif
 117         /*
 118          * For compatibility, ->typename is copied into ->name.
 119          * Will disappear.
 120          */
 121         const char      *typename;
 122 };
 123
 124 /**
 125  * struct irq_desc - interrupt descriptor
 126  *
 127  * @handle_irq:         highlevel irq-events handler [if NULL, __do_IRQ()]
 128  * @chip:               low level interrupt hardware access
 129  * @handler_data:       per-IRQ data for the irq_chip methods
 130  * @chip_data:          platform-specific per-chip private data for the chip
 131  *                      methods, to allow shared chip implementations
 132  * @action:             the irq action chain
 133  * @status:             status information
 134  * @depth:              disable-depth, for nested irq_disable() calls
 135  * @wake_depth:         enable depth, for multiple set_irq_wake() callers
 136  * @irq_count:          stats field to detect stalled irqs
 137  * @irqs_unhandled:     stats field for spurious unhandled interrupts
 138  * @lock:               locking for SMP
 139  * @affinity:           IRQ affinity on SMP
 140  * @cpu:                cpu index useful for balancing
 141  * @pending_mask:       pending rebalanced interrupts
 142  * @dir:                /proc/irq/ procfs entry
 143  * @affinity_entry:     /proc/irq/smp_affinity procfs entry on SMP
 144  * @name:               flow handler name for /proc/interrupts output
 145  *
 146  * Pad this out to 32 bytes for cache and indexing reasons.
 147  */
 148 struct irq_desc {
 149         irq_flow_handler_t      handle_irq;
 150         struct irq_chip         *chip;
 151         void                    *handler_data;
 152         void                    *chip_data;
 153         struct irqaction        *action;        /* IRQ action list */
 154         unsigned int            status;         /* IRQ status */
 155
 156         unsigned int            depth;          /* nested irq disables */
 157         unsigned int            wake_depth;     /* nested wake enables */
 158         unsigned int            irq_count;      /* For detecting broken IRQs */
 159         unsigned int            irqs_unhandled;
 160         spinlock_t              lock;
 161 #ifdef CONFIG_SMP
 162         cpumask_t               affinity;
 163         unsigned int            cpu;
 164 #endif
 165 #if defined(CONFIG_GENERIC_PENDING_IRQ) || defined(CONFIG_IRQBALANCE)
 166         cpumask_t               pending_mask;
 167 #endif
 168 #ifdef CONFIG_PROC_FS
 169         struct proc_dir_entry   *dir;
 170 #endif
 171         const char              *name;
 172 } ____cacheline_aligned;
 173
 174 extern struct irq_desc irq_desc[NR_IRQS];
 175
 176 /*
 177  * Migration helpers for obsolete names, they will go away:
 178  */
 179 #define hw_interrupt_type       irq_chip
 180 typedef struct irq_chip         hw_irq_controller;
 181 #define no_irq_type             no_irq_chip
 182 typedef struct irq_desc         irq_desc_t;
 183
 184 /*
 185  * Pick up the arch-dependent methods:
 186  */
 187 #include <asm/hw_irq.h>
 188
 189 extern int setup_irq(unsigned int irq, struct irqaction *new);
 190
 191 #ifdef CONFIG_GENERIC_HARDIRQS
 192
 193 #ifndef handle_dynamic_tick
 194 # define handle_dynamic_tick(a)         do { } while (0)
 195 #endif
 196
 197 #ifdef CONFIG_SMP
 198 static inline void set_native_irq_info(int irq, cpumask_t mask)
 199 {
 200         irq_desc[irq].affinity = mask;
 201 }
 202 #else
 203 static inline void set_native_irq_info(int irq, cpumask_t mask)
 204 {
 205 }
 206 #endif
 207
 208 #ifdef CONFIG_SMP
 209
 210 #if defined(CONFIG_GENERIC_PENDING_IRQ) || defined(CONFIG_IRQBALANCE)
 211
 212 void set_pending_irq(unsigned int irq, cpumask_t mask);
 213 void move_native_irq(int irq);
 214 void move_masked_irq(int irq);
 215
 216 #else /* CONFIG_GENERIC_PENDING_IRQ || CONFIG_IRQBALANCE */
 217
 218 static inline void move_irq(int irq)
 219 {
 220 }
 221
 222 static inline void move_native_irq(int irq)
 223 {
 224 }
 225
 226 static inline void move_masked_irq(int irq)
 227 {
 228 }
 229
 230 static inline void set_pending_irq(unsigned int irq, cpumask_t mask)
 231 {
 232 }
 233
 234 #endif /* CONFIG_GENERIC_PENDING_IRQ */
 235
 236 #else /* CONFIG_SMP */
 237
 238 #define move_native_irq(x)
 239 #define move_masked_irq(x)
 240
 241 #endif /* CONFIG_SMP */
 242
 243 #ifdef CONFIG_IRQBALANCE
 244 extern void set_balance_irq_affinity(unsigned int irq, cpumask_t mask);
 245 #else
 246 static inline void set_balance_irq_affinity(unsigned int irq, cpumask_t mask)
 247 {
 248 }
 249 #endif
 250
 251 #ifdef CONFIG_AUTO_IRQ_AFFINITY
 252 extern int select_smp_affinity(unsigned int irq);
 253 #else
 254 static inline int select_smp_affinity(unsigned int irq)
 255 {
 256         return 1;
 257 }
 258 #endif
 259
 260 extern int no_irq_affinity;
 261
 262 /* Handle irq action chains: */
 263 extern int handle_IRQ_event(unsigned int irq, struct irqaction *action);
 264
 265 /*
 266  * Built-in IRQ handlers for various IRQ types,
 267  * callable via desc->chip->handle_irq()
 268  */
 269 extern void fastcall handle_level_irq(unsigned int irq, struct irq_desc *desc);
 270 extern void fastcall handle_fasteoi_irq(unsigned int irq, struct irq_desc *desc);
 271 extern void fastcall handle_edge_irq(unsigned int irq, struct irq_desc *desc);
 272 extern void fastcall handle_simple_irq(unsigned int irq, struct irq_desc *desc);
 273 extern void fastcall handle_percpu_irq(unsigned int irq, struct irq_desc *desc);
 274 extern void fastcall handle_bad_irq(unsigned int irq, struct irq_desc *desc);
 275
 276 /*
 277  * Monolithic do_IRQ implementation.
 278  * (is an explicit fastcall, because i386 4KSTACKS calls it from assembly)
 279  */
 280 #ifndef CONFIG_GENERIC_HARDIRQS_NO__DO_IRQ
 281 extern fastcall unsigned int __do_IRQ(unsigned int irq);
 282 #endif
 283
 284 /*
 285  * Architectures call this to let the generic IRQ layer
 286  * handle an interrupt. If the descriptor is attached to an
 287  * irqchip-style controller then we call the ->handle_irq() handler,
 288  * and it calls __do_IRQ() if it's attached to an irqtype-style controller.
 289  */
 290 static inline void generic_handle_irq(unsigned int irq)
 291 {
 292         struct irq_desc *desc = irq_desc + irq;
 293
 294 #ifdef CONFIG_GENERIC_HARDIRQS_NO__DO_IRQ
 295         desc->handle_irq(irq, desc);
 296 #else
 297         if (likely(desc->handle_irq))
 298                 desc->handle_irq(irq, desc);
 299         else
 300                 __do_IRQ(irq);
 301 #endif
 302 }
 303
 304 /* Handling of unhandled and spurious interrupts: */
 305 extern void note_interrupt(unsigned int irq, struct irq_desc *desc,
 306                            int action_ret);
 307
 308 /* Resending of interrupts :*/
 309 void check_irq_resend(struct irq_desc *desc, unsigned int irq);
 310
 311 /* Initialize /proc/irq/ */
 312 extern void init_irq_proc(void);
 313
 314 /* Enable/disable irq debugging output: */
 315 extern int noirqdebug_setup(char *str);
 316
 317 /* Checks whether the interrupt can be requested by request_irq(): */
 318 extern int can_request_irq(unsigned int irq, unsigned long irqflags);
 319
 320 /* Dummy irq-chip implementations: */
 321 extern struct irq_chip no_irq_chip;
 322 extern struct irq_chip dummy_irq_chip;
 323
 324 extern void
 325 set_irq_chip_and_handler(unsigned int irq, struct irq_chip *chip,
 326                          irq_flow_handler_t handle);
 327 extern void
 328 set_irq_chip_and_handler_name(unsigned int irq, struct irq_chip *chip,
 329                               irq_flow_handler_t handle, const char *name);
 330
 331 extern void
 332 __set_irq_handler(unsigned int irq, irq_flow_handler_t handle, int is_chained,
 333                   const char *name);
 334
 335 /*
 336  * Set a highlevel flow handler for a given IRQ:
 337  */
 338 static inline void
 339 set_irq_handler(unsigned int irq, irq_flow_handler_t handle)
 340 {
 341         __set_irq_handler(irq, handle, 0, NULL);
 342 }
 343
 344 /*
 345  * Set a highlevel chained flow handler for a given IRQ.
 346  * (a chained handler is automatically enabled and set to
 347  *  IRQ_NOREQUEST and IRQ_NOPROBE)
 348  */
 349 static inline void
 350 set_irq_chained_handler(unsigned int irq,
 351                         irq_flow_handler_t handle)
 352 {
 353         __set_irq_handler(irq, handle, 1, NULL);
 354 }
 355
 356 /* Handle dynamic irq creation and destruction */
 357 extern int create_irq(void);
 358 extern void destroy_irq(unsigned int irq);
 359
 360 /* Test to see if a driver has successfully requested an irq */
 361 static inline int irq_has_action(unsigned int irq)
 362 {
 363         struct irq_desc *desc = irq_desc + irq;
 364         return desc->action != NULL;
 365 }
 366
 367 /* Dynamic irq helper functions */
 368 extern void dynamic_irq_init(unsigned int irq);
 369 extern void dynamic_irq_cleanup(unsigned int irq);
 370
 371 /* Set/get chip/data for an IRQ: */
 372 extern int set_irq_chip(unsigned int irq, struct irq_chip *chip);
 373 extern int set_irq_data(unsigned int irq, void *data);
 374 extern int set_irq_chip_data(unsigned int irq, void *data);
 375 extern int set_irq_type(unsigned int irq, unsigned int type);
 376
 377 #define get_irq_chip(irq)       (irq_desc[irq].chip)
 378 #define get_irq_chip_data(irq)  (irq_desc[irq].chip_data)
 379 #define get_irq_data(irq)       (irq_desc[irq].handler_data)
 380
 381 #endif /* CONFIG_GENERIC_HARDIRQS */
 382
 383 #endif /* !CONFIG_S390 */
 384
 385 #endif /* _LINUX_IRQ_H */