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