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