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