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 #define IRQ_NESTED_THREAD       0x10000000      /* IRQ is nested into another, no own handler thread */
  74
  75 #define IRQF_MODIFY_MASK        \
  76         (IRQ_TYPE_SENSE_MASK | IRQ_NOPROBE | IRQ_NOREQUEST | \
  77          IRQ_NOAUTOEN | IRQ_MOVE_PCNTXT | IRQ_LEVEL)
  78
  79 #ifdef CONFIG_IRQ_PER_CPU
  80 # define CHECK_IRQ_PER_CPU(var) ((var) & IRQ_PER_CPU)
  81 # define IRQ_NO_BALANCING_MASK  (IRQ_PER_CPU | IRQ_NO_BALANCING)
  82 #else
  83 # define CHECK_IRQ_PER_CPU(var) 0
  84 # define IRQ_NO_BALANCING_MASK  IRQ_NO_BALANCING
  85 #endif
  86
  87 struct msi_desc;
  88 struct irq_2_iommu;
  89
  90 /**
  91  * struct irq_data - per irq and irq chip data passed down to chip functions
  92  * @irq:                interrupt number
  93  * @node:               node index useful for balancing
  94  * @chip:               low level interrupt hardware access
  95  * @handler_data:       per-IRQ data for the irq_chip methods
  96  * @chip_data:          platform-specific per-chip private data for the chip
  97  *                      methods, to allow shared chip implementations
  98  * @msi_desc:           MSI descriptor
  99  * @affinity:           IRQ affinity on SMP
 100  * @irq_2_iommu:        iommu with this irq
 101  *
 102  * The fields here need to overlay the ones in irq_desc until we
 103  * cleaned up the direct references and switched everything over to
 104  * irq_data.
 105  */
 106 struct irq_data {
 107         unsigned int            irq;
 108         unsigned int            node;
 109         struct irq_chip         *chip;
 110         void                    *handler_data;
 111         void                    *chip_data;
 112         struct msi_desc         *msi_desc;
 113 #ifdef CONFIG_SMP
 114         cpumask_var_t           affinity;
 115 #endif
 116 #ifdef CONFIG_INTR_REMAP
 117         struct irq_2_iommu      *irq_2_iommu;
 118 #endif
 119 };
 120
 121 /**
 122  * struct irq_chip - hardware interrupt chip descriptor
 123  *
 124  * @name:               name for /proc/interrupts
 125  * @startup:            deprecated, replaced by irq_startup
 126  * @shutdown:           deprecated, replaced by irq_shutdown
 127  * @enable:             deprecated, replaced by irq_enable
 128  * @disable:            deprecated, replaced by irq_disable
 129  * @ack:                deprecated, replaced by irq_ack
 130  * @mask:               deprecated, replaced by irq_mask
 131  * @mask_ack:           deprecated, replaced by irq_mask_ack
 132  * @unmask:             deprecated, replaced by irq_unmask
 133  * @eoi:                deprecated, replaced by irq_eoi
 134  * @end:                deprecated, will go away with __do_IRQ()
 135  * @set_affinity:       deprecated, replaced by irq_set_affinity
 136  * @retrigger:          deprecated, replaced by irq_retrigger
 137  * @set_type:           deprecated, replaced by irq_set_type
 138  * @set_wake:           deprecated, replaced by irq_wake
 139  * @bus_lock:           deprecated, replaced by irq_bus_lock
 140  * @bus_sync_unlock:    deprecated, replaced by irq_bus_sync_unlock
 141  *
 142  * @irq_startup:        start up the interrupt (defaults to ->enable if NULL)
 143  * @irq_shutdown:       shut down the interrupt (defaults to ->disable if NULL)
 144  * @irq_enable:         enable the interrupt (defaults to chip->unmask if NULL)
 145  * @irq_disable:        disable the interrupt
 146  * @irq_ack:            start of a new interrupt
 147  * @irq_mask:           mask an interrupt source
 148  * @irq_mask_ack:       ack and mask an interrupt source
 149  * @irq_unmask:         unmask an interrupt source
 150  * @irq_eoi:            end of interrupt
 151  * @irq_set_affinity:   set the CPU affinity on SMP machines
 152  * @irq_retrigger:      resend an IRQ to the CPU
 153  * @irq_set_type:       set the flow type (IRQ_TYPE_LEVEL/etc.) of an IRQ
 154  * @irq_set_wake:       enable/disable power-management wake-on of an IRQ
 155  * @irq_bus_lock:       function to lock access to slow bus (i2c) chips
 156  * @irq_bus_sync_unlock:function to sync and unlock slow bus (i2c) chips
 157  *
 158  * @release:            release function solely used by UML
 159  */
 160 struct irq_chip {
 161         const char      *name;
 162 #ifndef CONFIG_GENERIC_HARDIRQS_NO_DEPRECATED
 163         unsigned int    (*startup)(unsigned int irq);
 164         void            (*shutdown)(unsigned int irq);
 165         void            (*enable)(unsigned int irq);
 166         void            (*disable)(unsigned int irq);
 167
 168         void            (*ack)(unsigned int irq);
 169         void            (*mask)(unsigned int irq);
 170         void            (*mask_ack)(unsigned int irq);
 171         void            (*unmask)(unsigned int irq);
 172         void            (*eoi)(unsigned int irq);
 173
 174         void            (*end)(unsigned int irq);
 175         int             (*set_affinity)(unsigned int irq,
 176                                         const struct cpumask *dest);
 177         int             (*retrigger)(unsigned int irq);
 178         int             (*set_type)(unsigned int irq, unsigned int flow_type);
 179         int             (*set_wake)(unsigned int irq, unsigned int on);
 180
 181         void            (*bus_lock)(unsigned int irq);
 182         void            (*bus_sync_unlock)(unsigned int irq);
 183 #endif
 184         unsigned int    (*irq_startup)(struct irq_data *data);
 185         void            (*irq_shutdown)(struct irq_data *data);
 186         void            (*irq_enable)(struct irq_data *data);
 187         void            (*irq_disable)(struct irq_data *data);
 188
 189         void            (*irq_ack)(struct irq_data *data);
 190         void            (*irq_mask)(struct irq_data *data);
 191         void            (*irq_mask_ack)(struct irq_data *data);
 192         void            (*irq_unmask)(struct irq_data *data);
 193         void            (*irq_eoi)(struct irq_data *data);
 194
 195         int             (*irq_set_affinity)(struct irq_data *data, const struct cpumask *dest, bool force);
 196         int             (*irq_retrigger)(struct irq_data *data);
 197         int             (*irq_set_type)(struct irq_data *data, unsigned int flow_type);
 198         int             (*irq_set_wake)(struct irq_data *data, unsigned int on);
 199
 200         void            (*irq_bus_lock)(struct irq_data *data);
 201         void            (*irq_bus_sync_unlock)(struct irq_data *data);
 202
 203         /* Currently used only by UML, might disappear one day.*/
 204 #ifdef CONFIG_IRQ_RELEASE_METHOD
 205         void            (*release)(unsigned int irq, void *dev_id);
 206 #endif
 207 };
 208
 209 /* This include will go away once we isolated irq_desc usage to core code */
 210 #include <linux/irqdesc.h>
 211
 212 /*
 213  * Pick up the arch-dependent methods:
 214  */
 215 #include <asm/hw_irq.h>
 216
 217 #ifndef ARCH_IRQ_INIT_FLAGS
 218 # define ARCH_IRQ_INIT_FLAGS    0
 219 #endif
 220
 221 #define IRQ_DEFAULT_INIT_FLAGS  (IRQ_DISABLED | ARCH_IRQ_INIT_FLAGS)
 222
 223 struct irqaction;
 224 extern int setup_irq(unsigned int irq, struct irqaction *new);
 225 extern void remove_irq(unsigned int irq, struct irqaction *act);
 226
 227 #ifdef CONFIG_GENERIC_HARDIRQS
 228
 229 #if defined(CONFIG_SMP) && defined(CONFIG_GENERIC_PENDING_IRQ)
 230 void move_native_irq(int irq);
 231 void move_masked_irq(int irq);
 232 #else
 233 static inline void move_native_irq(int irq) { }
 234 static inline void move_masked_irq(int irq) { }
 235 #endif
 236
 237 extern int no_irq_affinity;
 238
 239 /* Handle irq action chains: */
 240 extern irqreturn_t handle_IRQ_event(unsigned int irq, struct irqaction *action);
 241
 242 /*
 243  * Built-in IRQ handlers for various IRQ types,
 244  * callable via desc->handle_irq()
 245  */
 246 extern void handle_level_irq(unsigned int irq, struct irq_desc *desc);
 247 extern void handle_fasteoi_irq(unsigned int irq, struct irq_desc *desc);
 248 extern void handle_edge_irq(unsigned int irq, struct irq_desc *desc);
 249 extern void handle_simple_irq(unsigned int irq, struct irq_desc *desc);
 250 extern void handle_percpu_irq(unsigned int irq, struct irq_desc *desc);
 251 extern void handle_bad_irq(unsigned int irq, struct irq_desc *desc);
 252 extern void handle_nested_irq(unsigned int irq);
 253
 254 /* Handling of unhandled and spurious interrupts: */
 255 extern void note_interrupt(unsigned int irq, struct irq_desc *desc,
 256                            irqreturn_t action_ret);
 257
 258
 259 /* Enable/disable irq debugging output: */
 260 extern int noirqdebug_setup(char *str);
 261
 262 /* Checks whether the interrupt can be requested by request_irq(): */
 263 extern int can_request_irq(unsigned int irq, unsigned long irqflags);
 264
 265 /* Dummy irq-chip implementations: */
 266 extern struct irq_chip no_irq_chip;
 267 extern struct irq_chip dummy_irq_chip;
 268
 269 extern void
 270 set_irq_chip_and_handler(unsigned int irq, struct irq_chip *chip,
 271                          irq_flow_handler_t handle);
 272 extern void
 273 set_irq_chip_and_handler_name(unsigned int irq, struct irq_chip *chip,
 274                               irq_flow_handler_t handle, const char *name);
 275
 276 extern void
 277 __set_irq_handler(unsigned int irq, irq_flow_handler_t handle, int is_chained,
 278                   const char *name);
 279
 280 /*
 281  * Set a highlevel flow handler for a given IRQ:
 282  */
 283 static inline void
 284 set_irq_handler(unsigned int irq, irq_flow_handler_t handle)
 285 {
 286         __set_irq_handler(irq, handle, 0, NULL);
 287 }
 288
 289 /*
 290  * Set a highlevel chained flow handler for a given IRQ.
 291  * (a chained handler is automatically enabled and set to
 292  *  IRQ_NOREQUEST and IRQ_NOPROBE)
 293  */
 294 static inline void
 295 set_irq_chained_handler(unsigned int irq,
 296                         irq_flow_handler_t handle)
 297 {
 298         __set_irq_handler(irq, handle, 1, NULL);
 299 }
 300
 301 extern void set_irq_nested_thread(unsigned int irq, int nest);
 302
 303 void irq_modify_status(unsigned int irq, unsigned long clr, unsigned long set);
 304
 305 static inline void irq_set_status_flags(unsigned int irq, unsigned long set)
 306 {
 307         irq_modify_status(irq, 0, set);
 308 }
 309
 310 static inline void irq_clear_status_flags(unsigned int irq, unsigned long clr)
 311 {
 312         irq_modify_status(irq, clr, 0);
 313 }
 314
 315 static inline void set_irq_noprobe(unsigned int irq)
 316 {
 317         irq_modify_status(irq, 0, IRQ_NOPROBE);
 318 }
 319
 320 static inline void set_irq_probe(unsigned int irq)
 321 {
 322         irq_modify_status(irq, IRQ_NOPROBE, 0);
 323 }
 324
 325 /* Handle dynamic irq creation and destruction */
 326 extern unsigned int create_irq_nr(unsigned int irq_want, int node);
 327 extern int create_irq(void);
 328 extern void destroy_irq(unsigned int irq);
 329
 330 /* Dynamic irq helper functions */
 331 extern void dynamic_irq_init(unsigned int irq);
 332 void dynamic_irq_init_keep_chip_data(unsigned int irq);
 333 extern void dynamic_irq_cleanup(unsigned int irq);
 334 void dynamic_irq_cleanup_keep_chip_data(unsigned int irq);
 335
 336 /* Set/get chip/data for an IRQ: */
 337 extern int set_irq_chip(unsigned int irq, struct irq_chip *chip);
 338 extern int set_irq_data(unsigned int irq, void *data);
 339 extern int set_irq_chip_data(unsigned int irq, void *data);
 340 extern int set_irq_type(unsigned int irq, unsigned int type);
 341 extern int set_irq_msi(unsigned int irq, struct msi_desc *entry);
 342 extern struct irq_data *irq_get_irq_data(unsigned int irq);
 343
 344 static inline struct irq_chip *get_irq_chip(unsigned int irq)
 345 {
 346         struct irq_data *d = irq_get_irq_data(irq);
 347         return d ? d->chip : NULL;
 348 }
 349
 350 static inline struct irq_chip *irq_data_get_irq_chip(struct irq_data *d)
 351 {
 352         return d->chip;
 353 }
 354
 355 static inline void *get_irq_chip_data(unsigned int irq)
 356 {
 357         struct irq_data *d = irq_get_irq_data(irq);
 358         return d ? d->chip_data : NULL;
 359 }
 360
 361 static inline void *irq_data_get_irq_chip_data(struct irq_data *d)
 362 {
 363         return d->chip_data;
 364 }
 365
 366 static inline void *get_irq_data(unsigned int irq)
 367 {
 368         struct irq_data *d = irq_get_irq_data(irq);
 369         return d ? d->handler_data : NULL;
 370 }
 371
 372 static inline void *irq_data_get_irq_data(struct irq_data *d)
 373 {
 374         return d->handler_data;
 375 }
 376
 377 static inline struct msi_desc *get_irq_msi(unsigned int irq)
 378 {
 379         struct irq_data *d = irq_get_irq_data(irq);
 380         return d ? d->msi_desc : NULL;
 381 }
 382
 383 static inline struct msi_desc *irq_data_get_msi(struct irq_data *d)
 384 {
 385         return d->msi_desc;
 386 }
 387
 388 #ifdef CONFIG_INTR_REMAP
 389 static inline struct irq_2_iommu *get_irq_iommu(unsigned int irq)
 390 {
 391         struct irq_data *d = irq_get_irq_data(irq);
 392         return d ? d->irq_2_iommu : NULL;
 393 }
 394
 395 static inline struct irq_2_iommu *irq_data_get_iommu(struct irq_data *d)
 396 {
 397         return d->irq_2_iommu;
 398 }
 399 #endif
 400
 401 int irq_alloc_descs(int irq, unsigned int from, unsigned int cnt, int node);
 402 void irq_free_descs(unsigned int irq, unsigned int cnt);
 403 int irq_reserve_irqs(unsigned int from, unsigned int cnt);
 404
 405 static inline int irq_alloc_desc(int node)
 406 {
 407         return irq_alloc_descs(-1, 0, 1, node);
 408 }
 409
 410 static inline int irq_alloc_desc_at(unsigned int at, int node)
 411 {
 412         return irq_alloc_descs(at, at, 1, node);
 413 }
 414
 415 static inline int irq_alloc_desc_from(unsigned int from, int node)
 416 {
 417         return irq_alloc_descs(-1, from, 1, node);
 418 }
 419
 420 static inline void irq_free_desc(unsigned int irq)
 421 {
 422         irq_free_descs(irq, 1);
 423 }
 424
 425 #endif /* CONFIG_GENERIC_HARDIRQS */
 426
 427 #endif /* !CONFIG_S390 */
 428
 429 #endif /* _LINUX_IRQ_H */