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 /**
 131  * struct irq_desc - interrupt descriptor
 132  *
 133  * @handle_irq:         highlevel irq-events handler [if NULL, __do_IRQ()]
 134  * @chip:               low level interrupt hardware access
 135  * @msi_desc:           MSI descriptor
 136  * @handler_data:       per-IRQ data for the irq_chip methods
 137  * @chip_data:          platform-specific per-chip private data for the chip
 138  *                      methods, to allow shared chip implementations
 139  * @action:             the irq action chain
 140  * @status:             status information
 141  * @depth:              disable-depth, for nested irq_disable() calls
 142  * @wake_depth:         enable depth, for multiple set_irq_wake() callers
 143  * @irq_count:          stats field to detect stalled irqs
 144  * @irqs_unhandled:     stats field for spurious unhandled interrupts
 145  * @last_unhandled:     aging timer for unhandled count
 146  * @lock:               locking for SMP
 147  * @affinity:           IRQ affinity on SMP
 148  * @cpu:                cpu index useful for balancing
 149  * @pending_mask:       pending rebalanced interrupts
 150  * @dir:                /proc/irq/ procfs entry
 151  * @affinity_entry:     /proc/irq/smp_affinity procfs entry on SMP
 152  * @name:               flow handler name for /proc/interrupts output
 153  */
 154 struct irq_desc {
 155         unsigned int            irq;
 156 #ifdef CONFIG_HAVE_SPARSE_IRQ
 157         struct irq_desc         *next;
 158 #endif
 159         irq_flow_handler_t      handle_irq;
 160         struct irq_chip         *chip;
 161         struct msi_desc         *msi_desc;
 162         void                    *handler_data;
 163         void                    *chip_data;
 164         struct irqaction        *action;        /* IRQ action list */
 165         unsigned int            status;         /* IRQ status */
 166
 167         unsigned int            depth;          /* nested irq disables */
 168         unsigned int            wake_depth;     /* nested wake enables */
 169         unsigned int            irq_count;      /* For detecting broken IRQs */
 170         unsigned int            irqs_unhandled;
 171         unsigned long           last_unhandled; /* Aging timer for unhandled count */
 172         spinlock_t              lock;
 173 #ifdef CONFIG_SMP
 174         cpumask_t               affinity;
 175         unsigned int            cpu;
 176 #endif
 177 #if defined(CONFIG_GENERIC_PENDING_IRQ) || defined(CONFIG_IRQBALANCE)
 178         cpumask_t               pending_mask;
 179 #endif
 180 #ifdef CONFIG_PROC_FS
 181         struct proc_dir_entry   *dir;
 182 #endif
 183         const char              *name;
 184 } ____cacheline_internodealigned_in_smp;
 185
 186 extern struct irq_desc *irq_to_desc(unsigned int irq);
 187 #ifndef CONFIG_HAVE_DYN_ARRAY
 188 /* could be removed if we get rid of all irq_desc reference */
 189 extern struct irq_desc irq_desc[NR_IRQS];
 190 #endif
 191
 192 /*
 193  * Migration helpers for obsolete names, they will go away:
 194  */
 195 #define hw_interrupt_type       irq_chip
 196 typedef struct irq_chip         hw_irq_controller;
 197 #define no_irq_type             no_irq_chip
 198 typedef struct irq_desc         irq_desc_t;
 199
 200 /*
 201  * Pick up the arch-dependent methods:
 202  */
 203 #include <asm/hw_irq.h>
 204
 205 extern int setup_irq(unsigned int irq, struct irqaction *new);
 206
 207 #ifdef CONFIG_GENERIC_HARDIRQS
 208
 209 #ifdef CONFIG_SMP
 210
 211 #if defined(CONFIG_GENERIC_PENDING_IRQ) || defined(CONFIG_IRQBALANCE)
 212
 213 void set_pending_irq(unsigned int irq, cpumask_t mask);
 214 void move_native_irq(int irq);
 215 void move_masked_irq(int irq);
 216
 217 #else /* CONFIG_GENERIC_PENDING_IRQ || CONFIG_IRQBALANCE */
 218
 219 static inline void move_irq(int irq)
 220 {
 221 }
 222
 223 static inline void move_native_irq(int irq)
 224 {
 225 }
 226
 227 static inline void move_masked_irq(int irq)
 228 {
 229 }
 230
 231 static inline void set_pending_irq(unsigned int irq, cpumask_t mask)
 232 {
 233 }
 234
 235 #endif /* CONFIG_GENERIC_PENDING_IRQ */
 236
 237 #else /* CONFIG_SMP */
 238
 239 #define move_native_irq(x)
 240 #define move_masked_irq(x)
 241
 242 #endif /* CONFIG_SMP */
 243
 244 #ifdef CONFIG_IRQBALANCE
 245 extern void set_balance_irq_affinity(unsigned int irq, cpumask_t mask);
 246 #else
 247 static inline void set_balance_irq_affinity(unsigned int irq, cpumask_t mask)
 248 {
 249 }
 250 #endif
 251
 252 extern int no_irq_affinity;
 253
 254 static inline int irq_balancing_disabled(unsigned int irq)
 255 {
 256         struct irq_desc *desc;
 257
 258         desc = irq_to_desc(irq);
 259         return desc->status & IRQ_NO_BALANCING_MASK;
 260 }
 261
 262 /* Handle irq action chains: */
 263 extern int handle_IRQ_event(unsigned int irq, struct irqaction *action);
 264
 265 /*
 266  * Built-in IRQ handlers for various IRQ types,
 267  * callable via desc->chip->handle_irq()
 268  */
 269 extern void handle_level_irq(unsigned int irq, struct irq_desc *desc);
 270 extern void handle_fasteoi_irq(unsigned int irq, struct irq_desc *desc);
 271 extern void handle_edge_irq(unsigned int irq, struct irq_desc *desc);
 272 extern void handle_simple_irq(unsigned int irq, struct irq_desc *desc);
 273 extern void handle_percpu_irq(unsigned int irq, struct irq_desc *desc);
 274 extern void handle_bad_irq(unsigned int irq, struct irq_desc *desc);
 275
 276 /*
 277  * Monolithic do_IRQ implementation.
 278  */
 279 #ifndef CONFIG_GENERIC_HARDIRQS_NO__DO_IRQ
 280 extern unsigned int __do_IRQ(unsigned int irq);
 281 #endif
 282
 283 /*
 284  * Architectures call this to let the generic IRQ layer
 285  * handle an interrupt. If the descriptor is attached to an
 286  * irqchip-style controller then we call the ->handle_irq() handler,
 287  * and it calls __do_IRQ() if it's attached to an irqtype-style controller.
 288  */
 289 static inline void generic_handle_irq(unsigned int irq)
 290 {
 291         struct irq_desc *desc = irq_to_desc(irq);
 292
 293 #ifdef CONFIG_GENERIC_HARDIRQS_NO__DO_IRQ
 294         desc->handle_irq(irq, desc);
 295 #else
 296         if (likely(desc->handle_irq))
 297                 desc->handle_irq(irq, desc);
 298         else
 299                 __do_IRQ(irq);
 300 #endif
 301 }
 302
 303 /* Handling of unhandled and spurious interrupts: */
 304 extern void note_interrupt(unsigned int irq, struct irq_desc *desc,
 305                            int action_ret);
 306
 307 /* Resending of interrupts :*/
 308 void check_irq_resend(struct irq_desc *desc, unsigned int irq);
 309
 310 /* Enable/disable irq debugging output: */
 311 extern int noirqdebug_setup(char *str);
 312
 313 /* Checks whether the interrupt can be requested by request_irq(): */
 314 extern int can_request_irq(unsigned int irq, unsigned long irqflags);
 315
 316 /* Dummy irq-chip implementations: */
 317 extern struct irq_chip no_irq_chip;
 318 extern struct irq_chip dummy_irq_chip;
 319
 320 extern void
 321 set_irq_chip_and_handler(unsigned int irq, struct irq_chip *chip,
 322                          irq_flow_handler_t handle);
 323 extern void
 324 set_irq_chip_and_handler_name(unsigned int irq, struct irq_chip *chip,
 325                               irq_flow_handler_t handle, const char *name);
 326
 327 extern void
 328 __set_irq_handler(unsigned int irq, irq_flow_handler_t handle, int is_chained,
 329                   const char *name);
 330
 331 /* caller has locked the irq_desc and both params are valid */
 332 static inline void __set_irq_handler_unlocked(int irq,
 333                                               irq_flow_handler_t handler)
 334 {
 335         struct irq_desc *desc;
 336
 337         desc = irq_to_desc(irq);
 338         desc->handle_irq = handler;
 339 }
 340
 341 /*
 342  * Set a highlevel flow handler for a given IRQ:
 343  */
 344 static inline void
 345 set_irq_handler(unsigned int irq, irq_flow_handler_t handle)
 346 {
 347         __set_irq_handler(irq, handle, 0, NULL);
 348 }
 349
 350 /*
 351  * Set a highlevel chained flow handler for a given IRQ.
 352  * (a chained handler is automatically enabled and set to
 353  *  IRQ_NOREQUEST and IRQ_NOPROBE)
 354  */
 355 static inline void
 356 set_irq_chained_handler(unsigned int irq,
 357                         irq_flow_handler_t handle)
 358 {
 359         __set_irq_handler(irq, handle, 1, NULL);
 360 }
 361
 362 extern void set_irq_noprobe(unsigned int irq);
 363 extern void set_irq_probe(unsigned int irq);
 364
 365 /* Handle dynamic irq creation and destruction */
 366 extern int create_irq(void);
 367 extern void destroy_irq(unsigned int irq);
 368
 369 /* Test to see if a driver has successfully requested an irq */
 370 static inline int irq_has_action(unsigned int irq)
 371 {
 372         struct irq_desc *desc = irq_to_desc(irq);
 373         return desc->action != NULL;
 374 }
 375
 376 /* Dynamic irq helper functions */
 377 extern void dynamic_irq_init(unsigned int irq);
 378 extern void dynamic_irq_cleanup(unsigned int irq);
 379
 380 /* Set/get chip/data for an IRQ: */
 381 extern int set_irq_chip(unsigned int irq, struct irq_chip *chip);
 382 extern int set_irq_data(unsigned int irq, void *data);
 383 extern int set_irq_chip_data(unsigned int irq, void *data);
 384 extern int set_irq_type(unsigned int irq, unsigned int type);
 385 extern int set_irq_msi(unsigned int irq, struct msi_desc *entry);
 386
 387 #define get_irq_chip(irq)       (irq_to_desc(irq)->chip)
 388 #define get_irq_chip_data(irq)  (irq_to_desc(irq)->chip_data)
 389 #define get_irq_data(irq)       (irq_to_desc(irq)->handler_data)
 390 #define get_irq_msi(irq)        (irq_to_desc(irq)->msi_desc)
 391
 392 #endif /* CONFIG_GENERIC_HARDIRQS */
 393
 394 #endif /* !CONFIG_S390 */
 395
 396 #endif /* _LINUX_IRQ_H */