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