SAFE public projects git trees. - safe/jmp/linux-2.6/blob - 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/gfp.h>
  21 #include <linux/irqreturn.h>
  22 #include <linux/irqnr.h>
  23 #include <linux/errno.h>
  24 #include <linux/topology.h>
  25 #include <linux/wait.h>
  26
  27 #include <asm/irq.h>
  28 #include <asm/ptrace.h>
  29 #include <asm/irq_regs.h>
  30
  31 struct irq_desc;
  32 typedef void (*irq_flow_handler_t)(unsigned int irq,
  33                                             struct irq_desc *desc);
  34
  35
  36 /*
  37  * IRQ line status.
  38  *
  39  * Bits 0-7 are reserved for the IRQF_* bits in linux/interrupt.h
  40  *
  41  * IRQ types
  42  */
  43 #define IRQ_TYPE_NONE           0x00000000      /* Default, unspecified type */
  44 #define IRQ_TYPE_EDGE_RISING    0x00000001      /* Edge rising type */
  45 #define IRQ_TYPE_EDGE_FALLING   0x00000002      /* Edge falling type */
  46 #define IRQ_TYPE_EDGE_BOTH (IRQ_TYPE_EDGE_FALLING | IRQ_TYPE_EDGE_RISING)
  47 #define IRQ_TYPE_LEVEL_HIGH     0x00000004      /* Level high type */
  48 #define IRQ_TYPE_LEVEL_LOW      0x00000008      /* Level low type */
  49 #define IRQ_TYPE_SENSE_MASK     0x0000000f      /* Mask of the above */
  50 #define IRQ_TYPE_PROBE          0x00000010      /* Probing in progress */
  51
  52 /* Internal flags */
  53 #define IRQ_INPROGRESS          0x00000100      /* IRQ handler active - do not enter! */
  54 #define IRQ_DISABLED            0x00000200      /* IRQ disabled - do not enter! */
  55 #define IRQ_PENDING             0x00000400      /* IRQ pending - replay on enable */
  56 #define IRQ_REPLAY              0x00000800      /* IRQ has been replayed but not acked yet */
  57 #define IRQ_AUTODETECT          0x00001000      /* IRQ is being autodetected */
  58 #define IRQ_WAITING             0x00002000      /* IRQ not yet seen - for autodetection */
  59 #define IRQ_LEVEL               0x00004000      /* IRQ level triggered */
  60 #define IRQ_MASKED              0x00008000      /* IRQ masked - shouldn't be seen again */
  61 #define IRQ_PER_CPU             0x00010000      /* IRQ is per CPU */
  62 #define IRQ_NOPROBE             0x00020000      /* IRQ is not valid for probing */
  63 #define IRQ_NOREQUEST           0x00040000      /* IRQ cannot be requested */
  64 #define IRQ_NOAUTOEN            0x00080000      /* IRQ will not be enabled on request irq */
  65 #define IRQ_WAKEUP              0x00100000      /* IRQ triggers system wakeup */
  66 #define IRQ_MOVE_PENDING        0x00200000      /* need to re-target IRQ destination */
  67 #define IRQ_NO_BALANCING        0x00400000      /* IRQ is excluded from balancing */
  68 #define IRQ_SPURIOUS_DISABLED   0x00800000      /* IRQ was disabled by the spurious trap */
  69 #define IRQ_MOVE_PCNTXT         0x01000000      /* IRQ migration from process context */
  70 #define IRQ_AFFINITY_SET        0x02000000      /* IRQ affinity was set from userspace*/
  71 #define IRQ_SUSPENDED           0x04000000      /* IRQ has gone through suspend sequence */
  72 #define IRQ_ONESHOT             0x08000000      /* IRQ is not unmasked after hardirq */
  73
  74 #ifdef CONFIG_IRQ_PER_CPU
  75 # define CHECK_IRQ_PER_CPU(var) ((var) & IRQ_PER_CPU)
  76 # define IRQ_NO_BALANCING_MASK  (IRQ_PER_CPU | IRQ_NO_BALANCING)
  77 #else
  78 # define CHECK_IRQ_PER_CPU(var) 0
  79 # define IRQ_NO_BALANCING_MASK  IRQ_NO_BALANCING
  80 #endif
  81
  82 struct proc_dir_entry;
  83 struct msi_desc;
  84
  85 /**
  86  * struct irq_chip - hardware interrupt chip descriptor
  87  *
  88  * @name:               name for /proc/interrupts
  89  * @startup:            start up the interrupt (defaults to ->enable if NULL)
  90  * @shutdown:           shut down the interrupt (defaults to ->disable if NULL)
  91  * @enable:             enable the interrupt (defaults to chip->unmask if NULL)
  92  * @disable:            disable the interrupt (defaults to chip->mask if NULL)
  93  * @ack:                start of a new interrupt
  94  * @mask:               mask an interrupt source
  95  * @mask_ack:           ack and mask an interrupt source
  96  * @unmask:             unmask an interrupt source
  97  * @eoi:                end of interrupt - chip level
  98  * @end:                end of interrupt - flow level
  99  * @set_affinity:       set the CPU affinity on SMP machines
 100  * @retrigger:          resend an IRQ to the CPU
 101  * @set_type:           set the flow type (IRQ_TYPE_LEVEL/etc.) of an IRQ
 102  * @set_wake:           enable/disable power-management wake-on of an IRQ
 103  *
 104  * @bus_lock:           function to lock access to slow bus (i2c) chips
 105  * @bus_sync_unlock:    function to sync and unlock slow bus (i2c) chips
 106  *
 107  * @release:            release function solely used by UML
 108  * @typename:           obsoleted by name, kept as migration helper
 109  */
 110 struct irq_chip {
 111         const char      *name;
 112         unsigned int    (*startup)(unsigned int irq);
 113         void            (*shutdown)(unsigned int irq);
 114         void            (*enable)(unsigned int irq);
 115         void            (*disable)(unsigned int irq);
 116
 117         void            (*ack)(unsigned int irq);
 118         void            (*mask)(unsigned int irq);
 119         void            (*mask_ack)(unsigned int irq);
 120         void            (*unmask)(unsigned int irq);
 121         void            (*eoi)(unsigned int irq);
 122
 123         void            (*end)(unsigned int irq);
 124         int             (*set_affinity)(unsigned int irq,
 125                                         const struct cpumask *dest);
 126         int             (*retrigger)(unsigned int irq);
 127         int             (*set_type)(unsigned int irq, unsigned int flow_type);
 128         int             (*set_wake)(unsigned int irq, unsigned int on);
 129
 130         void            (*bus_lock)(unsigned int irq);
 131         void            (*bus_sync_unlock)(unsigned int irq);
 132
 133         /* Currently used only by UML, might disappear one day.*/
 134 #ifdef CONFIG_IRQ_RELEASE_METHOD
 135         void            (*release)(unsigned int irq, void *dev_id);
 136 #endif
 137         /*
 138          * For compatibility, ->typename is copied into ->name.
 139          * Will disappear.
 140          */
 141         const char      *typename;
 142 };
 143
 144 struct timer_rand_state;
 145 struct irq_2_iommu;
 146 /**
 147  * struct irq_desc - interrupt descriptor
 148  * @irq:                interrupt number for this descriptor
 149  * @timer_rand_state:   pointer to timer rand state struct
 150  * @kstat_irqs:         irq stats per cpu
 151  * @irq_2_iommu:        iommu with this irq
 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  * @last_unhandled:     aging timer for unhandled count
 164  * @irqs_unhandled:     stats field for spurious unhandled interrupts
 165  * @lock:               locking for SMP
 166  * @affinity:           IRQ affinity on SMP
 167  * @node:               node index useful for balancing
 168  * @pending_mask:       pending rebalanced interrupts
 169  * @threads_active:     number of irqaction threads currently running
 170  * @wait_for_threads:   wait queue for sync_irq to wait for threaded handlers
 171  * @dir:                /proc/irq/ procfs entry
 172  * @name:               flow handler name for /proc/interrupts output
 173  */
 174 struct irq_desc {
 175         unsigned int            irq;
 176         struct timer_rand_state *timer_rand_state;
 177         unsigned int            *kstat_irqs;
 178 #ifdef CONFIG_INTR_REMAP
 179         struct irq_2_iommu      *irq_2_iommu;
 180 #endif
 181         irq_flow_handler_t      handle_irq;
 182         struct irq_chip         *chip;
 183         struct msi_desc         *msi_desc;
 184         void                    *handler_data;
 185         void                    *chip_data;
 186         struct irqaction        *action;        /* IRQ action list */
 187         unsigned int            status;         /* IRQ status */
 188
 189         unsigned int            depth;          /* nested irq disables */
 190         unsigned int            wake_depth;     /* nested wake enables */
 191         unsigned int            irq_count;      /* For detecting broken IRQs */
 192         unsigned long           last_unhandled; /* Aging timer for unhandled count */
 193         unsigned int            irqs_unhandled;
 194         spinlock_t              lock;
 195 #ifdef CONFIG_SMP
 196         cpumask_var_t           affinity;
 197         unsigned int            node;
 198 #ifdef CONFIG_GENERIC_PENDING_IRQ
 199         cpumask_var_t           pending_mask;
 200 #endif
 201 #endif
 202         atomic_t                threads_active;
 203         wait_queue_head_t       wait_for_threads;
 204 #ifdef CONFIG_PROC_FS
 205         struct proc_dir_entry   *dir;
 206 #endif
 207         const char              *name;
 208 } ____cacheline_internodealigned_in_smp;
 209
 210 extern void arch_init_copy_chip_data(struct irq_desc *old_desc,
 211                                         struct irq_desc *desc, int node);
 212 extern void arch_free_chip_data(struct irq_desc *old_desc, struct irq_desc *desc);
 213
 214 #ifndef CONFIG_SPARSE_IRQ
 215 extern struct irq_desc irq_desc[NR_IRQS];
 216 #endif
 217
 218 #ifdef CONFIG_NUMA_IRQ_DESC
 219 extern struct irq_desc *move_irq_desc(struct irq_desc *old_desc, int node);
 220 #else
 221 static inline struct irq_desc *move_irq_desc(struct irq_desc *desc, int node)
 222 {
 223         return desc;
 224 }
 225 #endif
 226
 227 extern struct irq_desc *irq_to_desc_alloc_node(unsigned int irq, int node);
 228
 229 /*
 230  * Migration helpers for obsolete names, they will go away:
 231  */
 232 #define hw_interrupt_type       irq_chip
 233 #define no_irq_type             no_irq_chip
 234 typedef struct irq_desc         irq_desc_t;
 235
 236 /*
 237  * Pick up the arch-dependent methods:
 238  */
 239 #include <asm/hw_irq.h>
 240
 241 extern int setup_irq(unsigned int irq, struct irqaction *new);
 242 extern void remove_irq(unsigned int irq, struct irqaction *act);
 243
 244 #ifdef CONFIG_GENERIC_HARDIRQS
 245
 246 #ifdef CONFIG_SMP
 247
 248 #ifdef CONFIG_GENERIC_PENDING_IRQ
 249
 250 void move_native_irq(int irq);
 251 void move_masked_irq(int irq);
 252
 253 #else /* CONFIG_GENERIC_PENDING_IRQ */
 254
 255 static inline void move_irq(int irq)
 256 {
 257 }
 258
 259 static inline void move_native_irq(int irq)
 260 {
 261 }
 262
 263 static inline void move_masked_irq(int irq)
 264 {
 265 }
 266
 267 #endif /* CONFIG_GENERIC_PENDING_IRQ */
 268
 269 #else /* CONFIG_SMP */
 270
 271 #define move_native_irq(x)
 272 #define move_masked_irq(x)
 273
 274 #endif /* CONFIG_SMP */
 275
 276 extern int no_irq_affinity;
 277
 278 static inline int irq_balancing_disabled(unsigned int irq)
 279 {
 280         struct irq_desc *desc;
 281
 282         desc = irq_to_desc(irq);
 283         return desc->status & IRQ_NO_BALANCING_MASK;
 284 }
 285
 286 /* Handle irq action chains: */
 287 extern irqreturn_t handle_IRQ_event(unsigned int irq, struct irqaction *action);
 288
 289 /*
 290  * Built-in IRQ handlers for various IRQ types,
 291  * callable via desc->chip->handle_irq()
 292  */
 293 extern void handle_level_irq(unsigned int irq, struct irq_desc *desc);
 294 extern void handle_fasteoi_irq(unsigned int irq, struct irq_desc *desc);
 295 extern void handle_edge_irq(unsigned int irq, struct irq_desc *desc);
 296 extern void handle_simple_irq(unsigned int irq, struct irq_desc *desc);
 297 extern void handle_percpu_irq(unsigned int irq, struct irq_desc *desc);
 298 extern void handle_bad_irq(unsigned int irq, struct irq_desc *desc);
 299
 300 /*
 301  * Monolithic do_IRQ implementation.
 302  */
 303 #ifndef CONFIG_GENERIC_HARDIRQS_NO__DO_IRQ
 304 extern unsigned int __do_IRQ(unsigned int irq);
 305 #endif
 306
 307 /*
 308  * Architectures call this to let the generic IRQ layer
 309  * handle an interrupt. If the descriptor is attached to an
 310  * irqchip-style controller then we call the ->handle_irq() handler,
 311  * and it calls __do_IRQ() if it's attached to an irqtype-style controller.
 312  */
 313 static inline void generic_handle_irq_desc(unsigned int irq, struct irq_desc *desc)
 314 {
 315 #ifdef CONFIG_GENERIC_HARDIRQS_NO__DO_IRQ
 316         desc->handle_irq(irq, desc);
 317 #else
 318         if (likely(desc->handle_irq))
 319                 desc->handle_irq(irq, desc);
 320         else
 321                 __do_IRQ(irq);
 322 #endif
 323 }
 324
 325 static inline void generic_handle_irq(unsigned int irq)
 326 {
 327         generic_handle_irq_desc(irq, irq_to_desc(irq));
 328 }
 329
 330 /* Handling of unhandled and spurious interrupts: */
 331 extern void note_interrupt(unsigned int irq, struct irq_desc *desc,
 332                            irqreturn_t action_ret);
 333
 334 /* Resending of interrupts :*/
 335 void check_irq_resend(struct irq_desc *desc, unsigned int irq);
 336
 337 /* Enable/disable irq debugging output: */
 338 extern int noirqdebug_setup(char *str);
 339
 340 /* Checks whether the interrupt can be requested by request_irq(): */
 341 extern int can_request_irq(unsigned int irq, unsigned long irqflags);
 342
 343 /* Dummy irq-chip implementations: */
 344 extern struct irq_chip no_irq_chip;
 345 extern struct irq_chip dummy_irq_chip;
 346
 347 extern void
 348 set_irq_chip_and_handler(unsigned int irq, struct irq_chip *chip,
 349                          irq_flow_handler_t handle);
 350 extern void
 351 set_irq_chip_and_handler_name(unsigned int irq, struct irq_chip *chip,
 352                               irq_flow_handler_t handle, const char *name);
 353
 354 extern void
 355 __set_irq_handler(unsigned int irq, irq_flow_handler_t handle, int is_chained,
 356                   const char *name);
 357
 358 /* caller has locked the irq_desc and both params are valid */
 359 static inline void __set_irq_handler_unlocked(int irq,
 360                                               irq_flow_handler_t handler)
 361 {
 362         struct irq_desc *desc;
 363
 364         desc = irq_to_desc(irq);
 365         desc->handle_irq = handler;
 366 }
 367
 368 /*
 369  * Set a highlevel flow handler for a given IRQ:
 370  */
 371 static inline void
 372 set_irq_handler(unsigned int irq, irq_flow_handler_t handle)
 373 {
 374         __set_irq_handler(irq, handle, 0, NULL);
 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                         irq_flow_handler_t handle)
 385 {
 386         __set_irq_handler(irq, handle, 1, NULL);
 387 }
 388
 389 extern void set_irq_noprobe(unsigned int irq);
 390 extern void set_irq_probe(unsigned int irq);
 391
 392 /* Handle dynamic irq creation and destruction */
 393 extern unsigned int create_irq_nr(unsigned int irq_want, int node);
 394 extern int create_irq(void);
 395 extern void destroy_irq(unsigned int irq);
 396
 397 /* Test to see if a driver has successfully requested an irq */
 398 static inline int irq_has_action(unsigned int irq)
 399 {
 400         struct irq_desc *desc = irq_to_desc(irq);
 401         return desc->action != NULL;
 402 }
 403
 404 /* Dynamic irq helper functions */
 405 extern void dynamic_irq_init(unsigned int irq);
 406 extern void dynamic_irq_cleanup(unsigned int irq);
 407
 408 /* Set/get chip/data for an IRQ: */
 409 extern int set_irq_chip(unsigned int irq, struct irq_chip *chip);
 410 extern int set_irq_data(unsigned int irq, void *data);
 411 extern int set_irq_chip_data(unsigned int irq, void *data);
 412 extern int set_irq_type(unsigned int irq, unsigned int type);
 413 extern int set_irq_msi(unsigned int irq, struct msi_desc *entry);
 414
 415 #define get_irq_chip(irq)       (irq_to_desc(irq)->chip)
 416 #define get_irq_chip_data(irq)  (irq_to_desc(irq)->chip_data)
 417 #define get_irq_data(irq)       (irq_to_desc(irq)->handler_data)
 418 #define get_irq_msi(irq)        (irq_to_desc(irq)->msi_desc)
 419
 420 #define get_irq_desc_chip(desc)         ((desc)->chip)
 421 #define get_irq_desc_chip_data(desc)    ((desc)->chip_data)
 422 #define get_irq_desc_data(desc)         ((desc)->handler_data)
 423 #define get_irq_desc_msi(desc)          ((desc)->msi_desc)
 424
 425 #endif /* CONFIG_GENERIC_HARDIRQS */
 426
 427 #endif /* !CONFIG_S390 */
 428
 429 #ifdef CONFIG_SMP
 430 /**
 431  * alloc_desc_masks - allocate cpumasks for irq_desc
 432  * @desc:       pointer to irq_desc struct
 433  * @node:       node which will be handling the cpumasks
 434  * @boot:       true if need bootmem
 435  *
 436  * Allocates affinity and pending_mask cpumask if required.
 437  * Returns true if successful (or not required).
 438  */
 439 static inline bool alloc_desc_masks(struct irq_desc *desc, int node,
 440                                                         bool boot)
 441 {
 442         gfp_t gfp = GFP_ATOMIC;
 443
 444         if (boot)
 445                 gfp = GFP_NOWAIT;
 446
 447 #ifdef CONFIG_CPUMASK_OFFSTACK
 448         if (!alloc_cpumask_var_node(&desc->affinity, gfp, node))
 449                 return false;
 450
 451 #ifdef CONFIG_GENERIC_PENDING_IRQ
 452         if (!alloc_cpumask_var_node(&desc->pending_mask, gfp, node)) {
 453                 free_cpumask_var(desc->affinity);
 454                 return false;
 455         }
 456 #endif
 457 #endif
 458         return true;
 459 }
 460
 461 static inline void init_desc_masks(struct irq_desc *desc)
 462 {
 463         cpumask_setall(desc->affinity);
 464 #ifdef CONFIG_GENERIC_PENDING_IRQ
 465         cpumask_clear(desc->pending_mask);
 466 #endif
 467 }
 468
 469 /**
 470  * init_copy_desc_masks - copy cpumasks for irq_desc
 471  * @old_desc:   pointer to old irq_desc struct
 472  * @new_desc:   pointer to new irq_desc struct
 473  *
 474  * Insures affinity and pending_masks are copied to new irq_desc.
 475  * If !CONFIG_CPUMASKS_OFFSTACK the cpumasks are embedded in the
 476  * irq_desc struct so the copy is redundant.
 477  */
 478
 479 static inline void init_copy_desc_masks(struct irq_desc *old_desc,
 480                                         struct irq_desc *new_desc)
 481 {
 482 #ifdef CONFIG_CPUMASK_OFFSTACK
 483         cpumask_copy(new_desc->affinity, old_desc->affinity);
 484
 485 #ifdef CONFIG_GENERIC_PENDING_IRQ
 486         cpumask_copy(new_desc->pending_mask, old_desc->pending_mask);
 487 #endif
 488 #endif
 489 }
 490
 491 static inline void free_desc_masks(struct irq_desc *old_desc,
 492                                    struct irq_desc *new_desc)
 493 {
 494         free_cpumask_var(old_desc->affinity);
 495
 496 #ifdef CONFIG_GENERIC_PENDING_IRQ
 497         free_cpumask_var(old_desc->pending_mask);
 498 #endif
 499 }
 500
 501 #else /* !CONFIG_SMP */
 502
 503 static inline bool alloc_desc_masks(struct irq_desc *desc, int node,
 504                                                                 bool boot)
 505 {
 506         return true;
 507 }
 508
 509 static inline void init_desc_masks(struct irq_desc *desc)
 510 {
 511 }
 512
 513 static inline void init_copy_desc_masks(struct irq_desc *old_desc,
 514                                         struct irq_desc *new_desc)
 515 {
 516 }
 517
 518 static inline void free_desc_masks(struct irq_desc *old_desc,
 519                                    struct irq_desc *new_desc)
 520 {
 521 }
 522 #endif  /* CONFIG_SMP */
 523
 524 #endif /* _LINUX_IRQ_H */