Pileus Git - ~andy/linux/blob - 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 seq_file;
  32 struct irq_desc;
  33 struct irq_data;
  34 typedef void (*irq_flow_handler_t)(unsigned int irq,
  35                                             struct irq_desc *desc);
  36 typedef void (*irq_preflow_handler_t)(struct irq_data *data);
  37
  38 /*
  39  * IRQ line status.
  40  *
  41  * Bits 0-7 are the same as the IRQF_* bits in linux/interrupt.h
  42  *
  43  * IRQ_TYPE_NONE                - default, unspecified type
  44  * IRQ_TYPE_EDGE_RISING         - rising edge triggered
  45  * IRQ_TYPE_EDGE_FALLING        - falling edge triggered
  46  * IRQ_TYPE_EDGE_BOTH           - rising and falling edge triggered
  47  * IRQ_TYPE_LEVEL_HIGH          - high level triggered
  48  * IRQ_TYPE_LEVEL_LOW           - low level triggered
  49  * IRQ_TYPE_LEVEL_MASK          - Mask to filter out the level bits
  50  * IRQ_TYPE_SENSE_MASK          - Mask for all the above bits
  51  * IRQ_TYPE_PROBE               - Special flag for probing in progress
  52  *
  53  * Bits which can be modified via irq_set/clear/modify_status_flags()
  54  * IRQ_LEVEL                    - Interrupt is level type. Will be also
  55  *                                updated in the code when the above trigger
  56  *                                bits are modified via irq_set_irq_type()
  57  * IRQ_PER_CPU                  - Mark an interrupt PER_CPU. Will protect
  58  *                                it from affinity setting
  59  * IRQ_NOPROBE                  - Interrupt cannot be probed by autoprobing
  60  * IRQ_NOREQUEST                - Interrupt cannot be requested via
  61  *                                request_irq()
  62  * IRQ_NOAUTOEN                 - Interrupt is not automatically enabled in
  63  *                                request/setup_irq()
  64  * IRQ_NO_BALANCING             - Interrupt cannot be balanced (affinity set)
  65  * IRQ_MOVE_PCNTXT              - Interrupt can be migrated from process context
  66  * IRQ_NESTED_TRHEAD            - Interrupt nests into another thread
  67  */
  68 enum {
  69         IRQ_TYPE_NONE           = 0x00000000,
  70         IRQ_TYPE_EDGE_RISING    = 0x00000001,
  71         IRQ_TYPE_EDGE_FALLING   = 0x00000002,
  72         IRQ_TYPE_EDGE_BOTH      = (IRQ_TYPE_EDGE_FALLING | IRQ_TYPE_EDGE_RISING),
  73         IRQ_TYPE_LEVEL_HIGH     = 0x00000004,
  74         IRQ_TYPE_LEVEL_LOW      = 0x00000008,
  75         IRQ_TYPE_LEVEL_MASK     = (IRQ_TYPE_LEVEL_LOW | IRQ_TYPE_LEVEL_HIGH),
  76         IRQ_TYPE_SENSE_MASK     = 0x0000000f,
  77
  78         IRQ_TYPE_PROBE          = 0x00000010,
  79
  80         IRQ_LEVEL               = (1 <<  8),
  81         IRQ_PER_CPU             = (1 <<  9),
  82         IRQ_NOPROBE             = (1 << 10),
  83         IRQ_NOREQUEST           = (1 << 11),
  84         IRQ_NOAUTOEN            = (1 << 12),
  85         IRQ_NO_BALANCING        = (1 << 13),
  86         IRQ_MOVE_PCNTXT         = (1 << 14),
  87         IRQ_NESTED_THREAD       = (1 << 15),
  88 };
  89
  90 #define IRQF_MODIFY_MASK        \
  91         (IRQ_TYPE_SENSE_MASK | IRQ_NOPROBE | IRQ_NOREQUEST | \
  92          IRQ_NOAUTOEN | IRQ_MOVE_PCNTXT | IRQ_LEVEL | IRQ_NO_BALANCING | \
  93          IRQ_PER_CPU | IRQ_NESTED_THREAD)
  94
  95 #define IRQ_NO_BALANCING_MASK   (IRQ_PER_CPU | IRQ_NO_BALANCING)
  96
  97 static inline __deprecated bool CHECK_IRQ_PER_CPU(unsigned int status)
  98 {
  99         return status & IRQ_PER_CPU;
 100 }
 101
 102 /*
 103  * Return value for chip->irq_set_affinity()
 104  *
 105  * IRQ_SET_MASK_OK      - OK, core updates irq_data.affinity
 106  * IRQ_SET_MASK_NOCPY   - OK, chip did update irq_data.affinity
 107  */
 108 enum {
 109         IRQ_SET_MASK_OK = 0,
 110         IRQ_SET_MASK_OK_NOCOPY,
 111 };
 112
 113 struct msi_desc;
 114
 115 /**
 116  * struct irq_data - per irq and irq chip data passed down to chip functions
 117  * @irq:                interrupt number
 118  * @node:               node index useful for balancing
 119  * @state_use_accessors: status information for irq chip functions.
 120  *                      Use accessor functions to deal with it
 121  * @chip:               low level interrupt hardware access
 122  * @handler_data:       per-IRQ data for the irq_chip methods
 123  * @chip_data:          platform-specific per-chip private data for the chip
 124  *                      methods, to allow shared chip implementations
 125  * @msi_desc:           MSI descriptor
 126  * @affinity:           IRQ affinity on SMP
 127  *
 128  * The fields here need to overlay the ones in irq_desc until we
 129  * cleaned up the direct references and switched everything over to
 130  * irq_data.
 131  */
 132 struct irq_data {
 133         unsigned int            irq;
 134         unsigned int            node;
 135         unsigned int            state_use_accessors;
 136         struct irq_chip         *chip;
 137         void                    *handler_data;
 138         void                    *chip_data;
 139         struct msi_desc         *msi_desc;
 140 #ifdef CONFIG_SMP
 141         cpumask_var_t           affinity;
 142 #endif
 143 };
 144
 145 /*
 146  * Bit masks for irq_data.state
 147  *
 148  * IRQD_TRIGGER_MASK            - Mask for the trigger type bits
 149  * IRQD_SETAFFINITY_PENDING     - Affinity setting is pending
 150  * IRQD_NO_BALANCING            - Balancing disabled for this IRQ
 151  * IRQD_PER_CPU                 - Interrupt is per cpu
 152  * IRQD_AFFINITY_SET            - Interrupt affinity was set
 153  * IRQD_LEVEL                   - Interrupt is level triggered
 154  * IRQD_WAKEUP_STATE            - Interrupt is configured for wakeup
 155  *                                from suspend
 156  * IRDQ_MOVE_PCNTXT             - Interrupt can be moved in process
 157  *                                context
 158  * IRQD_IRQ_DISABLED            - Disabled state of the interrupt
 159  * IRQD_IRQ_MASKED              - Masked state of the interrupt
 160  * IRQD_IRQ_INPROGRESS          - In progress state of the interrupt
 161  */
 162 enum {
 163         IRQD_TRIGGER_MASK               = 0xf,
 164         IRQD_SETAFFINITY_PENDING        = (1 <<  8),
 165         IRQD_NO_BALANCING               = (1 << 10),
 166         IRQD_PER_CPU                    = (1 << 11),
 167         IRQD_AFFINITY_SET               = (1 << 12),
 168         IRQD_LEVEL                      = (1 << 13),
 169         IRQD_WAKEUP_STATE               = (1 << 14),
 170         IRQD_MOVE_PCNTXT                = (1 << 15),
 171         IRQD_IRQ_DISABLED               = (1 << 16),
 172         IRQD_IRQ_MASKED                 = (1 << 17),
 173         IRQD_IRQ_INPROGRESS             = (1 << 18),
 174 };
 175
 176 static inline bool irqd_is_setaffinity_pending(struct irq_data *d)
 177 {
 178         return d->state_use_accessors & IRQD_SETAFFINITY_PENDING;
 179 }
 180
 181 static inline bool irqd_is_per_cpu(struct irq_data *d)
 182 {
 183         return d->state_use_accessors & IRQD_PER_CPU;
 184 }
 185
 186 static inline bool irqd_can_balance(struct irq_data *d)
 187 {
 188         return !(d->state_use_accessors & (IRQD_PER_CPU | IRQD_NO_BALANCING));
 189 }
 190
 191 static inline bool irqd_affinity_was_set(struct irq_data *d)
 192 {
 193         return d->state_use_accessors & IRQD_AFFINITY_SET;
 194 }
 195
 196 static inline void irqd_mark_affinity_was_set(struct irq_data *d)
 197 {
 198         d->state_use_accessors |= IRQD_AFFINITY_SET;
 199 }
 200
 201 static inline u32 irqd_get_trigger_type(struct irq_data *d)
 202 {
 203         return d->state_use_accessors & IRQD_TRIGGER_MASK;
 204 }
 205
 206 /*
 207  * Must only be called inside irq_chip.irq_set_type() functions.
 208  */
 209 static inline void irqd_set_trigger_type(struct irq_data *d, u32 type)
 210 {
 211         d->state_use_accessors &= ~IRQD_TRIGGER_MASK;
 212         d->state_use_accessors |= type & IRQD_TRIGGER_MASK;
 213 }
 214
 215 static inline bool irqd_is_level_type(struct irq_data *d)
 216 {
 217         return d->state_use_accessors & IRQD_LEVEL;
 218 }
 219
 220 static inline bool irqd_is_wakeup_set(struct irq_data *d)
 221 {
 222         return d->state_use_accessors & IRQD_WAKEUP_STATE;
 223 }
 224
 225 static inline bool irqd_can_move_in_process_context(struct irq_data *d)
 226 {
 227         return d->state_use_accessors & IRQD_MOVE_PCNTXT;
 228 }
 229
 230 static inline bool irqd_irq_disabled(struct irq_data *d)
 231 {
 232         return d->state_use_accessors & IRQD_IRQ_DISABLED;
 233 }
 234
 235 static inline bool irqd_irq_masked(struct irq_data *d)
 236 {
 237         return d->state_use_accessors & IRQD_IRQ_MASKED;
 238 }
 239
 240 static inline bool irqd_irq_inprogress(struct irq_data *d)
 241 {
 242         return d->state_use_accessors & IRQD_IRQ_INPROGRESS;
 243 }
 244
 245 /*
 246  * Functions for chained handlers which can be enabled/disabled by the
 247  * standard disable_irq/enable_irq calls. Must be called with
 248  * irq_desc->lock held.
 249  */
 250 static inline void irqd_set_chained_irq_inprogress(struct irq_data *d)
 251 {
 252         d->state_use_accessors |= IRQD_IRQ_INPROGRESS;
 253 }
 254
 255 static inline void irqd_clr_chained_irq_inprogress(struct irq_data *d)
 256 {
 257         d->state_use_accessors &= ~IRQD_IRQ_INPROGRESS;
 258 }
 259
 260 /**
 261  * struct irq_chip - hardware interrupt chip descriptor
 262  *
 263  * @name:               name for /proc/interrupts
 264  * @irq_startup:        start up the interrupt (defaults to ->enable if NULL)
 265  * @irq_shutdown:       shut down the interrupt (defaults to ->disable if NULL)
 266  * @irq_enable:         enable the interrupt (defaults to chip->unmask if NULL)
 267  * @irq_disable:        disable the interrupt
 268  * @irq_ack:            start of a new interrupt
 269  * @irq_mask:           mask an interrupt source
 270  * @irq_mask_ack:       ack and mask an interrupt source
 271  * @irq_unmask:         unmask an interrupt source
 272  * @irq_eoi:            end of interrupt
 273  * @irq_set_affinity:   set the CPU affinity on SMP machines
 274  * @irq_retrigger:      resend an IRQ to the CPU
 275  * @irq_set_type:       set the flow type (IRQ_TYPE_LEVEL/etc.) of an IRQ
 276  * @irq_set_wake:       enable/disable power-management wake-on of an IRQ
 277  * @irq_bus_lock:       function to lock access to slow bus (i2c) chips
 278  * @irq_bus_sync_unlock:function to sync and unlock slow bus (i2c) chips
 279  * @irq_cpu_online:     configure an interrupt source for a secondary CPU
 280  * @irq_cpu_offline:    un-configure an interrupt source for a secondary CPU
 281  * @irq_print_chip:     optional to print special chip info in show_interrupts
 282  * @flags:              chip specific flags
 283  *
 284  * @release:            release function solely used by UML
 285  */
 286 struct irq_chip {
 287         const char      *name;
 288         unsigned int    (*irq_startup)(struct irq_data *data);
 289         void            (*irq_shutdown)(struct irq_data *data);
 290         void            (*irq_enable)(struct irq_data *data);
 291         void            (*irq_disable)(struct irq_data *data);
 292
 293         void            (*irq_ack)(struct irq_data *data);
 294         void            (*irq_mask)(struct irq_data *data);
 295         void            (*irq_mask_ack)(struct irq_data *data);
 296         void            (*irq_unmask)(struct irq_data *data);
 297         void            (*irq_eoi)(struct irq_data *data);
 298
 299         int             (*irq_set_affinity)(struct irq_data *data, const struct cpumask *dest, bool force);
 300         int             (*irq_retrigger)(struct irq_data *data);
 301         int             (*irq_set_type)(struct irq_data *data, unsigned int flow_type);
 302         int             (*irq_set_wake)(struct irq_data *data, unsigned int on);
 303
 304         void            (*irq_bus_lock)(struct irq_data *data);
 305         void            (*irq_bus_sync_unlock)(struct irq_data *data);
 306
 307         void            (*irq_cpu_online)(struct irq_data *data);
 308         void            (*irq_cpu_offline)(struct irq_data *data);
 309
 310         void            (*irq_print_chip)(struct irq_data *data, struct seq_file *p);
 311
 312         unsigned long   flags;
 313
 314         /* Currently used only by UML, might disappear one day.*/
 315 #ifdef CONFIG_IRQ_RELEASE_METHOD
 316         void            (*release)(unsigned int irq, void *dev_id);
 317 #endif
 318 };
 319
 320 /*
 321  * irq_chip specific flags
 322  *
 323  * IRQCHIP_SET_TYPE_MASKED:     Mask before calling chip.irq_set_type()
 324  * IRQCHIP_EOI_IF_HANDLED:      Only issue irq_eoi() when irq was handled
 325  * IRQCHIP_MASK_ON_SUSPEND:     Mask non wake irqs in the suspend path
 326  * IRQCHIP_ONOFFLINE_ENABLED:   Only call irq_on/off_line callbacks
 327  *                              when irq enabled
 328  */
 329 enum {
 330         IRQCHIP_SET_TYPE_MASKED         = (1 <<  0),
 331         IRQCHIP_EOI_IF_HANDLED          = (1 <<  1),
 332         IRQCHIP_MASK_ON_SUSPEND         = (1 <<  2),
 333         IRQCHIP_ONOFFLINE_ENABLED       = (1 <<  3),
 334 };
 335
 336 /* This include will go away once we isolated irq_desc usage to core code */
 337 #include <linux/irqdesc.h>
 338
 339 /*
 340  * Pick up the arch-dependent methods:
 341  */
 342 #include <asm/hw_irq.h>
 343
 344 #ifndef NR_IRQS_LEGACY
 345 # define NR_IRQS_LEGACY 0
 346 #endif
 347
 348 #ifndef ARCH_IRQ_INIT_FLAGS
 349 # define ARCH_IRQ_INIT_FLAGS    0
 350 #endif
 351
 352 #define IRQ_DEFAULT_INIT_FLAGS  ARCH_IRQ_INIT_FLAGS
 353
 354 struct irqaction;
 355 extern int setup_irq(unsigned int irq, struct irqaction *new);
 356 extern void remove_irq(unsigned int irq, struct irqaction *act);
 357
 358 extern void irq_cpu_online(void);
 359 extern void irq_cpu_offline(void);
 360 extern int __irq_set_affinity_locked(struct irq_data *data,  const struct cpumask *cpumask);
 361
 362 #ifdef CONFIG_GENERIC_HARDIRQS
 363
 364 #if defined(CONFIG_SMP) && defined(CONFIG_GENERIC_PENDING_IRQ)
 365 void irq_move_irq(struct irq_data *data);
 366 void irq_move_masked_irq(struct irq_data *data);
 367 #else
 368 static inline void irq_move_irq(struct irq_data *data) { }
 369 static inline void irq_move_masked_irq(struct irq_data *data) { }
 370 #endif
 371
 372 extern int no_irq_affinity;
 373
 374 /*
 375  * Built-in IRQ handlers for various IRQ types,
 376  * callable via desc->handle_irq()
 377  */
 378 extern void handle_level_irq(unsigned int irq, struct irq_desc *desc);
 379 extern void handle_fasteoi_irq(unsigned int irq, struct irq_desc *desc);
 380 extern void handle_edge_irq(unsigned int irq, struct irq_desc *desc);
 381 extern void handle_edge_eoi_irq(unsigned int irq, struct irq_desc *desc);
 382 extern void handle_simple_irq(unsigned int irq, struct irq_desc *desc);
 383 extern void handle_percpu_irq(unsigned int irq, struct irq_desc *desc);
 384 extern void handle_bad_irq(unsigned int irq, struct irq_desc *desc);
 385 extern void handle_nested_irq(unsigned int irq);
 386
 387 /* Handling of unhandled and spurious interrupts: */
 388 extern void note_interrupt(unsigned int irq, struct irq_desc *desc,
 389                            irqreturn_t action_ret);
 390
 391
 392 /* Enable/disable irq debugging output: */
 393 extern int noirqdebug_setup(char *str);
 394
 395 /* Checks whether the interrupt can be requested by request_irq(): */
 396 extern int can_request_irq(unsigned int irq, unsigned long irqflags);
 397
 398 /* Dummy irq-chip implementations: */
 399 extern struct irq_chip no_irq_chip;
 400 extern struct irq_chip dummy_irq_chip;
 401
 402 extern void
 403 irq_set_chip_and_handler_name(unsigned int irq, struct irq_chip *chip,
 404                               irq_flow_handler_t handle, const char *name);
 405
 406 static inline void irq_set_chip_and_handler(unsigned int irq, struct irq_chip *chip,
 407                                             irq_flow_handler_t handle)
 408 {
 409         irq_set_chip_and_handler_name(irq, chip, handle, NULL);
 410 }
 411
 412 extern void
 413 __irq_set_handler(unsigned int irq, irq_flow_handler_t handle, int is_chained,
 414                   const char *name);
 415
 416 static inline void
 417 irq_set_handler(unsigned int irq, irq_flow_handler_t handle)
 418 {
 419         __irq_set_handler(irq, handle, 0, NULL);
 420 }
 421
 422 /*
 423  * Set a highlevel chained flow handler for a given IRQ.
 424  * (a chained handler is automatically enabled and set to
 425  *  IRQ_NOREQUEST and IRQ_NOPROBE)
 426  */
 427 static inline void
 428 irq_set_chained_handler(unsigned int irq, irq_flow_handler_t handle)
 429 {
 430         __irq_set_handler(irq, handle, 1, NULL);
 431 }
 432
 433 void irq_modify_status(unsigned int irq, unsigned long clr, unsigned long set);
 434
 435 static inline void irq_set_status_flags(unsigned int irq, unsigned long set)
 436 {
 437         irq_modify_status(irq, 0, set);
 438 }
 439
 440 static inline void irq_clear_status_flags(unsigned int irq, unsigned long clr)
 441 {
 442         irq_modify_status(irq, clr, 0);
 443 }
 444
 445 static inline void irq_set_noprobe(unsigned int irq)
 446 {
 447         irq_modify_status(irq, 0, IRQ_NOPROBE);
 448 }
 449
 450 static inline void irq_set_probe(unsigned int irq)
 451 {
 452         irq_modify_status(irq, IRQ_NOPROBE, 0);
 453 }
 454
 455 static inline void irq_set_nested_thread(unsigned int irq, bool nest)
 456 {
 457         if (nest)
 458                 irq_set_status_flags(irq, IRQ_NESTED_THREAD);
 459         else
 460                 irq_clear_status_flags(irq, IRQ_NESTED_THREAD);
 461 }
 462
 463 /* Handle dynamic irq creation and destruction */
 464 extern unsigned int create_irq_nr(unsigned int irq_want, int node);
 465 extern int create_irq(void);
 466 extern void destroy_irq(unsigned int irq);
 467
 468 /*
 469  * Dynamic irq helper functions. Obsolete. Use irq_alloc_desc* and
 470  * irq_free_desc instead.
 471  */
 472 extern void dynamic_irq_cleanup(unsigned int irq);
 473 static inline void dynamic_irq_init(unsigned int irq)
 474 {
 475         dynamic_irq_cleanup(irq);
 476 }
 477
 478 /* Set/get chip/data for an IRQ: */
 479 extern int irq_set_chip(unsigned int irq, struct irq_chip *chip);
 480 extern int irq_set_handler_data(unsigned int irq, void *data);
 481 extern int irq_set_chip_data(unsigned int irq, void *data);
 482 extern int irq_set_irq_type(unsigned int irq, unsigned int type);
 483 extern int irq_set_msi_desc(unsigned int irq, struct msi_desc *entry);
 484 extern struct irq_data *irq_get_irq_data(unsigned int irq);
 485
 486 static inline struct irq_chip *irq_get_chip(unsigned int irq)
 487 {
 488         struct irq_data *d = irq_get_irq_data(irq);
 489         return d ? d->chip : NULL;
 490 }
 491
 492 static inline struct irq_chip *irq_data_get_irq_chip(struct irq_data *d)
 493 {
 494         return d->chip;
 495 }
 496
 497 static inline void *irq_get_chip_data(unsigned int irq)
 498 {
 499         struct irq_data *d = irq_get_irq_data(irq);
 500         return d ? d->chip_data : NULL;
 501 }
 502
 503 static inline void *irq_data_get_irq_chip_data(struct irq_data *d)
 504 {
 505         return d->chip_data;
 506 }
 507
 508 static inline void *irq_get_handler_data(unsigned int irq)
 509 {
 510         struct irq_data *d = irq_get_irq_data(irq);
 511         return d ? d->handler_data : NULL;
 512 }
 513
 514 static inline void *irq_data_get_irq_handler_data(struct irq_data *d)
 515 {
 516         return d->handler_data;
 517 }
 518
 519 static inline struct msi_desc *irq_get_msi_desc(unsigned int irq)
 520 {
 521         struct irq_data *d = irq_get_irq_data(irq);
 522         return d ? d->msi_desc : NULL;
 523 }
 524
 525 static inline struct msi_desc *irq_data_get_msi(struct irq_data *d)
 526 {
 527         return d->msi_desc;
 528 }
 529
 530 int irq_alloc_descs(int irq, unsigned int from, unsigned int cnt, int node);
 531 void irq_free_descs(unsigned int irq, unsigned int cnt);
 532 int irq_reserve_irqs(unsigned int from, unsigned int cnt);
 533
 534 static inline int irq_alloc_desc(int node)
 535 {
 536         return irq_alloc_descs(-1, 0, 1, node);
 537 }
 538
 539 static inline int irq_alloc_desc_at(unsigned int at, int node)
 540 {
 541         return irq_alloc_descs(at, at, 1, node);
 542 }
 543
 544 static inline int irq_alloc_desc_from(unsigned int from, int node)
 545 {
 546         return irq_alloc_descs(-1, from, 1, node);
 547 }
 548
 549 static inline void irq_free_desc(unsigned int irq)
 550 {
 551         irq_free_descs(irq, 1);
 552 }
 553
 554 static inline int irq_reserve_irq(unsigned int irq)
 555 {
 556         return irq_reserve_irqs(irq, 1);
 557 }
 558
 559 #endif /* CONFIG_GENERIC_HARDIRQS */
 560
 561 #endif /* !CONFIG_S390 */
 562
 563 #endif /* _LINUX_IRQ_H */