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
  54 #ifndef CONFIG_GENERIC_HARDIRQS_NO_COMPAT
  55 #define IRQ_INPROGRESS          0x00000100      /* DEPRECATED */
  56 #define IRQ_REPLAY              0x00000200      /* DEPRECATED */
  57 #define IRQ_WAITING             0x00000400      /* DEPRECATED */
  58 #define IRQ_DISABLED            0x00000800      /* DEPRECATED */
  59 #define IRQ_PENDING             0x00001000      /* DEPRECATED */
  60 #define IRQ_MASKED              0x00002000      /* DEPRECATED */
  61 /* DEPRECATED use irq_setaffinity_pending() instead*/
  62 #define IRQ_MOVE_PENDING        0x00004000
  63 #define IRQ_AFFINITY_SET        0x02000000      /* DEPRECATED */
  64 #endif
  65
  66 #define IRQ_LEVEL               0x00008000      /* IRQ level triggered */
  67 #define IRQ_PER_CPU             0x00010000      /* IRQ is per CPU */
  68 #define IRQ_NOPROBE             0x00020000      /* IRQ is not valid for probing */
  69 #define IRQ_NOREQUEST           0x00040000      /* IRQ cannot be requested */
  70 #define IRQ_NOAUTOEN            0x00080000      /* IRQ will not be enabled on request irq */
  71 #define IRQ_WAKEUP              0x00100000      /* IRQ triggers system wakeup */
  72 #define IRQ_NO_BALANCING        0x00400000      /* IRQ is excluded from balancing */
  73 #define IRQ_MOVE_PCNTXT         0x01000000      /* IRQ migration from process context */
  74 #define IRQ_NESTED_THREAD       0x10000000      /* IRQ is nested into another, no own handler thread */
  75
  76 #define IRQF_MODIFY_MASK        \
  77         (IRQ_TYPE_SENSE_MASK | IRQ_NOPROBE | IRQ_NOREQUEST | \
  78          IRQ_NOAUTOEN | IRQ_MOVE_PCNTXT | IRQ_LEVEL | IRQ_NO_BALANCING | \
  79          IRQ_PER_CPU | IRQ_NESTED_THREAD)
  80
  81 #define IRQ_NO_BALANCING_MASK   (IRQ_PER_CPU | IRQ_NO_BALANCING)
  82
  83 static inline __deprecated bool CHECK_IRQ_PER_CPU(unsigned int status)
  84 {
  85         return status & IRQ_PER_CPU;
  86 }
  87
  88 /*
  89  * Return value for chip->irq_set_affinity()
  90  *
  91  * IRQ_SET_MASK_OK      - OK, core updates irq_data.affinity
  92  * IRQ_SET_MASK_NOCPY   - OK, chip did update irq_data.affinity
  93  */
  94 enum {
  95         IRQ_SET_MASK_OK = 0,
  96         IRQ_SET_MASK_OK_NOCOPY,
  97 };
  98
  99 struct msi_desc;
 100
 101 /**
 102  * struct irq_data - per irq and irq chip data passed down to chip functions
 103  * @irq:                interrupt number
 104  * @node:               node index useful for balancing
 105  * @state_use_accessor: status information for irq chip functions.
 106  *                      Use accessor functions to deal with it
 107  * @chip:               low level interrupt hardware access
 108  * @handler_data:       per-IRQ data for the irq_chip methods
 109  * @chip_data:          platform-specific per-chip private data for the chip
 110  *                      methods, to allow shared chip implementations
 111  * @msi_desc:           MSI descriptor
 112  * @affinity:           IRQ affinity on SMP
 113  *
 114  * The fields here need to overlay the ones in irq_desc until we
 115  * cleaned up the direct references and switched everything over to
 116  * irq_data.
 117  */
 118 struct irq_data {
 119         unsigned int            irq;
 120         unsigned int            node;
 121         unsigned int            state_use_accessors;
 122         struct irq_chip         *chip;
 123         void                    *handler_data;
 124         void                    *chip_data;
 125         struct msi_desc         *msi_desc;
 126 #ifdef CONFIG_SMP
 127         cpumask_var_t           affinity;
 128 #endif
 129 };
 130
 131 /*
 132  * Bit masks for irq_data.state
 133  *
 134  * IRQD_SETAFFINITY_PENDING     - Affinity setting is pending
 135  * IRQD_NO_BALANCING            - Balancing disabled for this IRQ
 136  * IRQD_PER_CPU                 - Interrupt is per cpu
 137  * IRQD_AFFINITY_SET            - Interrupt affinity was set
 138  */
 139 enum {
 140         /* Bit 0 - 7 reserved for TYPE will use later */
 141         IRQD_SETAFFINITY_PENDING        = (1 <<  8),
 142         IRQD_NO_BALANCING               = (1 << 10),
 143         IRQD_PER_CPU                    = (1 << 11),
 144         IRQD_AFFINITY_SET               = (1 << 12),
 145 };
 146
 147 static inline bool irqd_is_setaffinity_pending(struct irq_data *d)
 148 {
 149         return d->state_use_accessors & IRQD_SETAFFINITY_PENDING;
 150 }
 151
 152 static inline bool irqd_is_per_cpu(struct irq_data *d)
 153 {
 154         return d->state_use_accessors & IRQD_PER_CPU;
 155 }
 156
 157 static inline bool irqd_can_balance(struct irq_data *d)
 158 {
 159         return !(d->state_use_accessors & (IRQD_PER_CPU | IRQD_NO_BALANCING));
 160 }
 161
 162 static inline bool irqd_affinity_was_set(struct irq_data *d)
 163 {
 164         return d->state_use_accessors & IRQD_AFFINITY_SET;
 165 }
 166
 167 /**
 168  * struct irq_chip - hardware interrupt chip descriptor
 169  *
 170  * @name:               name for /proc/interrupts
 171  * @startup:            deprecated, replaced by irq_startup
 172  * @shutdown:           deprecated, replaced by irq_shutdown
 173  * @enable:             deprecated, replaced by irq_enable
 174  * @disable:            deprecated, replaced by irq_disable
 175  * @ack:                deprecated, replaced by irq_ack
 176  * @mask:               deprecated, replaced by irq_mask
 177  * @mask_ack:           deprecated, replaced by irq_mask_ack
 178  * @unmask:             deprecated, replaced by irq_unmask
 179  * @eoi:                deprecated, replaced by irq_eoi
 180  * @end:                deprecated, will go away with __do_IRQ()
 181  * @set_affinity:       deprecated, replaced by irq_set_affinity
 182  * @retrigger:          deprecated, replaced by irq_retrigger
 183  * @set_type:           deprecated, replaced by irq_set_type
 184  * @set_wake:           deprecated, replaced by irq_wake
 185  * @bus_lock:           deprecated, replaced by irq_bus_lock
 186  * @bus_sync_unlock:    deprecated, replaced by irq_bus_sync_unlock
 187  *
 188  * @irq_startup:        start up the interrupt (defaults to ->enable if NULL)
 189  * @irq_shutdown:       shut down the interrupt (defaults to ->disable if NULL)
 190  * @irq_enable:         enable the interrupt (defaults to chip->unmask if NULL)
 191  * @irq_disable:        disable the interrupt
 192  * @irq_ack:            start of a new interrupt
 193  * @irq_mask:           mask an interrupt source
 194  * @irq_mask_ack:       ack and mask an interrupt source
 195  * @irq_unmask:         unmask an interrupt source
 196  * @irq_eoi:            end of interrupt
 197  * @irq_set_affinity:   set the CPU affinity on SMP machines
 198  * @irq_retrigger:      resend an IRQ to the CPU
 199  * @irq_set_type:       set the flow type (IRQ_TYPE_LEVEL/etc.) of an IRQ
 200  * @irq_set_wake:       enable/disable power-management wake-on of an IRQ
 201  * @irq_bus_lock:       function to lock access to slow bus (i2c) chips
 202  * @irq_bus_sync_unlock:function to sync and unlock slow bus (i2c) chips
 203  *
 204  * @release:            release function solely used by UML
 205  */
 206 struct irq_chip {
 207         const char      *name;
 208 #ifndef CONFIG_GENERIC_HARDIRQS_NO_DEPRECATED
 209         unsigned int    (*startup)(unsigned int irq);
 210         void            (*shutdown)(unsigned int irq);
 211         void            (*enable)(unsigned int irq);
 212         void            (*disable)(unsigned int irq);
 213
 214         void            (*ack)(unsigned int irq);
 215         void            (*mask)(unsigned int irq);
 216         void            (*mask_ack)(unsigned int irq);
 217         void            (*unmask)(unsigned int irq);
 218         void            (*eoi)(unsigned int irq);
 219
 220         void            (*end)(unsigned int irq);
 221         int             (*set_affinity)(unsigned int irq,
 222                                         const struct cpumask *dest);
 223         int             (*retrigger)(unsigned int irq);
 224         int             (*set_type)(unsigned int irq, unsigned int flow_type);
 225         int             (*set_wake)(unsigned int irq, unsigned int on);
 226
 227         void            (*bus_lock)(unsigned int irq);
 228         void            (*bus_sync_unlock)(unsigned int irq);
 229 #endif
 230         unsigned int    (*irq_startup)(struct irq_data *data);
 231         void            (*irq_shutdown)(struct irq_data *data);
 232         void            (*irq_enable)(struct irq_data *data);
 233         void            (*irq_disable)(struct irq_data *data);
 234
 235         void            (*irq_ack)(struct irq_data *data);
 236         void            (*irq_mask)(struct irq_data *data);
 237         void            (*irq_mask_ack)(struct irq_data *data);
 238         void            (*irq_unmask)(struct irq_data *data);
 239         void            (*irq_eoi)(struct irq_data *data);
 240
 241         int             (*irq_set_affinity)(struct irq_data *data, const struct cpumask *dest, bool force);
 242         int             (*irq_retrigger)(struct irq_data *data);
 243         int             (*irq_set_type)(struct irq_data *data, unsigned int flow_type);
 244         int             (*irq_set_wake)(struct irq_data *data, unsigned int on);
 245
 246         void            (*irq_bus_lock)(struct irq_data *data);
 247         void            (*irq_bus_sync_unlock)(struct irq_data *data);
 248
 249         /* Currently used only by UML, might disappear one day.*/
 250 #ifdef CONFIG_IRQ_RELEASE_METHOD
 251         void            (*release)(unsigned int irq, void *dev_id);
 252 #endif
 253 };
 254
 255 /* This include will go away once we isolated irq_desc usage to core code */
 256 #include <linux/irqdesc.h>
 257
 258 /*
 259  * Pick up the arch-dependent methods:
 260  */
 261 #include <asm/hw_irq.h>
 262
 263 #ifndef NR_IRQS_LEGACY
 264 # define NR_IRQS_LEGACY 0
 265 #endif
 266
 267 #ifndef ARCH_IRQ_INIT_FLAGS
 268 # define ARCH_IRQ_INIT_FLAGS    0
 269 #endif
 270
 271 #define IRQ_DEFAULT_INIT_FLAGS  ARCH_IRQ_INIT_FLAGS
 272
 273 struct irqaction;
 274 extern int setup_irq(unsigned int irq, struct irqaction *new);
 275 extern void remove_irq(unsigned int irq, struct irqaction *act);
 276
 277 #ifdef CONFIG_GENERIC_HARDIRQS
 278
 279 #if defined(CONFIG_SMP) && defined(CONFIG_GENERIC_PENDING_IRQ)
 280 void move_native_irq(int irq);
 281 void move_masked_irq(int irq);
 282 #else
 283 static inline void move_native_irq(int irq) { }
 284 static inline void move_masked_irq(int irq) { }
 285 #endif
 286
 287 extern int no_irq_affinity;
 288
 289 /* Handle irq action chains: */
 290 extern irqreturn_t handle_IRQ_event(unsigned int irq, struct irqaction *action);
 291
 292 /*
 293  * Built-in IRQ handlers for various IRQ types,
 294  * callable via desc->handle_irq()
 295  */
 296 extern void handle_level_irq(unsigned int irq, struct irq_desc *desc);
 297 extern void handle_fasteoi_irq(unsigned int irq, struct irq_desc *desc);
 298 extern void handle_edge_irq(unsigned int irq, struct irq_desc *desc);
 299 extern void handle_simple_irq(unsigned int irq, struct irq_desc *desc);
 300 extern void handle_percpu_irq(unsigned int irq, struct irq_desc *desc);
 301 extern void handle_bad_irq(unsigned int irq, struct irq_desc *desc);
 302 extern void handle_nested_irq(unsigned int irq);
 303
 304 /* Handling of unhandled and spurious interrupts: */
 305 extern void note_interrupt(unsigned int irq, struct irq_desc *desc,
 306                            irqreturn_t action_ret);
 307
 308
 309 /* Enable/disable irq debugging output: */
 310 extern int noirqdebug_setup(char *str);
 311
 312 /* Checks whether the interrupt can be requested by request_irq(): */
 313 extern int can_request_irq(unsigned int irq, unsigned long irqflags);
 314
 315 /* Dummy irq-chip implementations: */
 316 extern struct irq_chip no_irq_chip;
 317 extern struct irq_chip dummy_irq_chip;
 318
 319 extern void
 320 set_irq_chip_and_handler(unsigned int irq, struct irq_chip *chip,
 321                          irq_flow_handler_t handle);
 322 extern void
 323 set_irq_chip_and_handler_name(unsigned int irq, struct irq_chip *chip,
 324                               irq_flow_handler_t handle, const char *name);
 325
 326 extern void
 327 __set_irq_handler(unsigned int irq, irq_flow_handler_t handle, int is_chained,
 328                   const char *name);
 329
 330 /*
 331  * Set a highlevel flow handler for a given IRQ:
 332  */
 333 static inline void
 334 set_irq_handler(unsigned int irq, irq_flow_handler_t handle)
 335 {
 336         __set_irq_handler(irq, handle, 0, NULL);
 337 }
 338
 339 /*
 340  * Set a highlevel chained flow handler for a given IRQ.
 341  * (a chained handler is automatically enabled and set to
 342  *  IRQ_NOREQUEST and IRQ_NOPROBE)
 343  */
 344 static inline void
 345 set_irq_chained_handler(unsigned int irq, irq_flow_handler_t handle)
 346 {
 347         __set_irq_handler(irq, handle, 1, NULL);
 348 }
 349
 350 void irq_modify_status(unsigned int irq, unsigned long clr, unsigned long set);
 351
 352 static inline void irq_set_status_flags(unsigned int irq, unsigned long set)
 353 {
 354         irq_modify_status(irq, 0, set);
 355 }
 356
 357 static inline void irq_clear_status_flags(unsigned int irq, unsigned long clr)
 358 {
 359         irq_modify_status(irq, clr, 0);
 360 }
 361
 362 static inline void irq_set_noprobe(unsigned int irq)
 363 {
 364         irq_modify_status(irq, 0, IRQ_NOPROBE);
 365 }
 366
 367 static inline void irq_set_probe(unsigned int irq)
 368 {
 369         irq_modify_status(irq, IRQ_NOPROBE, 0);
 370 }
 371
 372 static inline void irq_set_nested_thread(unsigned int irq, bool nest)
 373 {
 374         if (nest)
 375                 irq_set_status_flags(irq, IRQ_NESTED_THREAD);
 376         else
 377                 irq_clear_status_flags(irq, IRQ_NESTED_THREAD);
 378 }
 379
 380 /* Handle dynamic irq creation and destruction */
 381 extern unsigned int create_irq_nr(unsigned int irq_want, int node);
 382 extern int create_irq(void);
 383 extern void destroy_irq(unsigned int irq);
 384
 385 /*
 386  * Dynamic irq helper functions. Obsolete. Use irq_alloc_desc* and
 387  * irq_free_desc instead.
 388  */
 389 extern void dynamic_irq_cleanup(unsigned int irq);
 390 static inline void dynamic_irq_init(unsigned int irq)
 391 {
 392         dynamic_irq_cleanup(irq);
 393 }
 394
 395 /* Set/get chip/data for an IRQ: */
 396 extern int irq_set_chip(unsigned int irq, struct irq_chip *chip);
 397 extern int irq_set_handler_data(unsigned int irq, void *data);
 398 extern int irq_set_chip_data(unsigned int irq, void *data);
 399 extern int irq_set_irq_type(unsigned int irq, unsigned int type);
 400 extern int irq_set_msi_desc(unsigned int irq, struct msi_desc *entry);
 401 extern struct irq_data *irq_get_irq_data(unsigned int irq);
 402
 403 static inline struct irq_chip *irq_get_chip(unsigned int irq)
 404 {
 405         struct irq_data *d = irq_get_irq_data(irq);
 406         return d ? d->chip : NULL;
 407 }
 408
 409 static inline struct irq_chip *irq_data_get_irq_chip(struct irq_data *d)
 410 {
 411         return d->chip;
 412 }
 413
 414 static inline void *irq_get_chip_data(unsigned int irq)
 415 {
 416         struct irq_data *d = irq_get_irq_data(irq);
 417         return d ? d->chip_data : NULL;
 418 }
 419
 420 static inline void *irq_data_get_irq_chip_data(struct irq_data *d)
 421 {
 422         return d->chip_data;
 423 }
 424
 425 static inline void *irq_get_handler_data(unsigned int irq)
 426 {
 427         struct irq_data *d = irq_get_irq_data(irq);
 428         return d ? d->handler_data : NULL;
 429 }
 430
 431 static inline void *irq_data_get_irq_handler_data(struct irq_data *d)
 432 {
 433         return d->handler_data;
 434 }
 435
 436 static inline struct msi_desc *irq_get_msi_desc(unsigned int irq)
 437 {
 438         struct irq_data *d = irq_get_irq_data(irq);
 439         return d ? d->msi_desc : NULL;
 440 }
 441
 442 static inline struct msi_desc *irq_data_get_msi(struct irq_data *d)
 443 {
 444         return d->msi_desc;
 445 }
 446
 447 #ifndef CONFIG_GENERIC_HARDIRQS_NO_COMPAT
 448 /* Please do not use: Use the replacement functions instead */
 449 static inline int set_irq_chip(unsigned int irq, struct irq_chip *chip)
 450 {
 451         return irq_set_chip(irq, chip);
 452 }
 453 static inline int set_irq_data(unsigned int irq, void *data)
 454 {
 455         return irq_set_handler_data(irq, data);
 456 }
 457 static inline int set_irq_chip_data(unsigned int irq, void *data)
 458 {
 459         return irq_set_chip_data(irq, data);
 460 }
 461 static inline int set_irq_type(unsigned int irq, unsigned int type)
 462 {
 463         return irq_set_irq_type(irq, type);
 464 }
 465 static inline int set_irq_msi(unsigned int irq, struct msi_desc *entry)
 466 {
 467         return irq_set_msi_desc(irq, entry);
 468 }
 469 static inline struct irq_chip *get_irq_chip(unsigned int irq)
 470 {
 471         return irq_get_chip(irq);
 472 }
 473 static inline void *get_irq_chip_data(unsigned int irq)
 474 {
 475         return irq_get_chip_data(irq);
 476 }
 477 static inline void *get_irq_data(unsigned int irq)
 478 {
 479         return irq_get_handler_data(irq);
 480 }
 481 static inline void *irq_data_get_irq_data(struct irq_data *d)
 482 {
 483         return irq_data_get_irq_handler_data(d);
 484 }
 485 static inline struct msi_desc *get_irq_msi(unsigned int irq)
 486 {
 487         return irq_get_msi_desc(irq);
 488 }
 489 static inline void set_irq_noprobe(unsigned int irq)
 490 {
 491         irq_set_noprobe(irq);
 492 }
 493 static inline void set_irq_probe(unsigned int irq)
 494 {
 495         irq_set_probe(irq);
 496 }
 497 static inline void set_irq_nested_thread(unsigned int irq, int nest)
 498 {
 499         irq_set_nested_thread(irq, nest);
 500 }
 501 #endif
 502
 503 int irq_alloc_descs(int irq, unsigned int from, unsigned int cnt, int node);
 504 void irq_free_descs(unsigned int irq, unsigned int cnt);
 505 int irq_reserve_irqs(unsigned int from, unsigned int cnt);
 506
 507 static inline int irq_alloc_desc(int node)
 508 {
 509         return irq_alloc_descs(-1, 0, 1, node);
 510 }
 511
 512 static inline int irq_alloc_desc_at(unsigned int at, int node)
 513 {
 514         return irq_alloc_descs(at, at, 1, node);
 515 }
 516
 517 static inline int irq_alloc_desc_from(unsigned int from, int node)
 518 {
 519         return irq_alloc_descs(-1, from, 1, node);
 520 }
 521
 522 static inline void irq_free_desc(unsigned int irq)
 523 {
 524         irq_free_descs(irq, 1);
 525 }
 526
 527 static inline int irq_reserve_irq(unsigned int irq)
 528 {
 529         return irq_reserve_irqs(irq, 1);
 530 }
 531
 532 #endif /* CONFIG_GENERIC_HARDIRQS */
 533
 534 #endif /* !CONFIG_S390 */
 535
 536 #endif /* _LINUX_IRQ_H */