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