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