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