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 #include <linux/linkage.h>
  14 #include <linux/cache.h>
  15 #include <linux/spinlock.h>
  16 #include <linux/cpumask.h>
  17 #include <linux/gfp.h>
  18 #include <linux/irqhandler.h>
  19 #include <linux/irqreturn.h>
  20 #include <linux/irqnr.h>
  21 #include <linux/errno.h>
  22 #include <linux/topology.h>
  23 #include <linux/wait.h>
  24 #include <linux/io.h>
  25
  26 #include <asm/irq.h>
  27 #include <asm/ptrace.h>
  28 #include <asm/irq_regs.h>
  29
  30 struct seq_file;
  31 struct module;
  32 struct msi_msg;
  33 enum irqchip_irq_state;
  34
  35 /*
  36  * IRQ line status.
  37  *
  38  * Bits 0-7 are the same as the IRQF_* bits in linux/interrupt.h
  39  *
  40  * IRQ_TYPE_NONE                - default, unspecified type
  41  * IRQ_TYPE_EDGE_RISING         - rising edge triggered
  42  * IRQ_TYPE_EDGE_FALLING        - falling edge triggered
  43  * IRQ_TYPE_EDGE_BOTH           - rising and falling edge triggered
  44  * IRQ_TYPE_LEVEL_HIGH          - high level triggered
  45  * IRQ_TYPE_LEVEL_LOW           - low level triggered
  46  * IRQ_TYPE_LEVEL_MASK          - Mask to filter out the level bits
  47  * IRQ_TYPE_SENSE_MASK          - Mask for all the above bits
  48  * IRQ_TYPE_DEFAULT             - For use by some PICs to ask irq_set_type
  49  *                                to setup the HW to a sane default (used
  50  *                                by irqdomain map() callbacks to synchronize
  51  *                                the HW state and SW flags for a newly
  52  *                                allocated descriptor).
  53  *
  54  * IRQ_TYPE_PROBE               - Special flag for probing in progress
  55  *
  56  * Bits which can be modified via irq_set/clear/modify_status_flags()
  57  * IRQ_LEVEL                    - Interrupt is level type. Will be also
  58  *                                updated in the code when the above trigger
  59  *                                bits are modified via irq_set_irq_type()
  60  * IRQ_PER_CPU                  - Mark an interrupt PER_CPU. Will protect
  61  *                                it from affinity setting
  62  * IRQ_NOPROBE                  - Interrupt cannot be probed by autoprobing
  63  * IRQ_NOREQUEST                - Interrupt cannot be requested via
  64  *                                request_irq()
  65  * IRQ_NOTHREAD                 - Interrupt cannot be threaded
  66  * IRQ_NOAUTOEN                 - Interrupt is not automatically enabled in
  67  *                                request/setup_irq()
  68  * IRQ_NO_BALANCING             - Interrupt cannot be balanced (affinity set)
  69  * IRQ_MOVE_PCNTXT              - Interrupt can be migrated from process context
  70  * IRQ_NESTED_THREAD            - Interrupt nests into another thread
  71  * IRQ_PER_CPU_DEVID            - Dev_id is a per-cpu variable
  72  * IRQ_IS_POLLED                - Always polled by another interrupt. Exclude
  73  *                                it from the spurious interrupt detection
  74  *                                mechanism and from core side polling.
  75  * IRQ_DISABLE_UNLAZY           - Disable lazy irq disable
  76  */
  77 enum {
  78         IRQ_TYPE_NONE           = 0x00000000,
  79         IRQ_TYPE_EDGE_RISING    = 0x00000001,
  80         IRQ_TYPE_EDGE_FALLING   = 0x00000002,
  81         IRQ_TYPE_EDGE_BOTH      = (IRQ_TYPE_EDGE_FALLING | IRQ_TYPE_EDGE_RISING),
  82         IRQ_TYPE_LEVEL_HIGH     = 0x00000004,
  83         IRQ_TYPE_LEVEL_LOW      = 0x00000008,
  84         IRQ_TYPE_LEVEL_MASK     = (IRQ_TYPE_LEVEL_LOW | IRQ_TYPE_LEVEL_HIGH),
  85         IRQ_TYPE_SENSE_MASK     = 0x0000000f,
  86         IRQ_TYPE_DEFAULT        = IRQ_TYPE_SENSE_MASK,
  87
  88         IRQ_TYPE_PROBE          = 0x00000010,
  89
  90         IRQ_LEVEL               = (1 <<  8),
  91         IRQ_PER_CPU             = (1 <<  9),
  92         IRQ_NOPROBE             = (1 << 10),
  93         IRQ_NOREQUEST           = (1 << 11),
  94         IRQ_NOAUTOEN            = (1 << 12),
  95         IRQ_NO_BALANCING        = (1 << 13),
  96         IRQ_MOVE_PCNTXT         = (1 << 14),
  97         IRQ_NESTED_THREAD       = (1 << 15),
  98         IRQ_NOTHREAD            = (1 << 16),
  99         IRQ_PER_CPU_DEVID       = (1 << 17),
 100         IRQ_IS_POLLED           = (1 << 18),
 101         IRQ_DISABLE_UNLAZY      = (1 << 19),
 102 };
 103
 104 #define IRQF_MODIFY_MASK        \
 105         (IRQ_TYPE_SENSE_MASK | IRQ_NOPROBE | IRQ_NOREQUEST | \
 106          IRQ_NOAUTOEN | IRQ_MOVE_PCNTXT | IRQ_LEVEL | IRQ_NO_BALANCING | \
 107          IRQ_PER_CPU | IRQ_NESTED_THREAD | IRQ_NOTHREAD | IRQ_PER_CPU_DEVID | \
 108          IRQ_IS_POLLED | IRQ_DISABLE_UNLAZY)
 109
 110 #define IRQ_NO_BALANCING_MASK   (IRQ_PER_CPU | IRQ_NO_BALANCING)
 111
 112 /*
 113  * Return value for chip->irq_set_affinity()
 114  *
 115  * IRQ_SET_MASK_OK      - OK, core updates irq_common_data.affinity
 116  * IRQ_SET_MASK_NOCPY   - OK, chip did update irq_common_data.affinity
 117  * IRQ_SET_MASK_OK_DONE - Same as IRQ_SET_MASK_OK for core. Special code to
 118  *                        support stacked irqchips, which indicates skipping
 119  *                        all descendent irqchips.
 120  */
 121 enum {
 122         IRQ_SET_MASK_OK = 0,
 123         IRQ_SET_MASK_OK_NOCOPY,
 124         IRQ_SET_MASK_OK_DONE,
 125 };
 126
 127 struct msi_desc;
 128 struct irq_domain;
 129
 130 /**
 131  * struct irq_common_data - per irq data shared by all irqchips
 132  * @state_use_accessors: status information for irq chip functions.
 133  *                      Use accessor functions to deal with it
 134  * @node:               node index useful for balancing
 135  * @handler_data:       per-IRQ data for the irq_chip methods
 136  * @affinity:           IRQ affinity on SMP. If this is an IPI
 137  *                      related irq, then this is the mask of the
 138  *                      CPUs to which an IPI can be sent.
 139  * @msi_desc:           MSI descriptor
 140  * @ipi_offset:         Offset of first IPI target cpu in @affinity. Optional.
 141  */
 142 struct irq_common_data {
 143         unsigned int            state_use_accessors;
 144 #ifdef CONFIG_NUMA
 145         unsigned int            node;
 146 #endif
 147         void                    *handler_data;
 148         struct msi_desc         *msi_desc;
 149         cpumask_var_t           affinity;
 150 #ifdef CONFIG_GENERIC_IRQ_IPI
 151         unsigned int            ipi_offset;
 152 #endif
 153 };
 154
 155 /**
 156  * struct irq_data - per irq chip data passed down to chip functions
 157  * @mask:               precomputed bitmask for accessing the chip registers
 158  * @irq:                interrupt number
 159  * @hwirq:              hardware interrupt number, local to the interrupt domain
 160  * @common:             point to data shared by all irqchips
 161  * @chip:               low level interrupt hardware access
 162  * @domain:             Interrupt translation domain; responsible for mapping
 163  *                      between hwirq number and linux irq number.
 164  * @parent_data:        pointer to parent struct irq_data to support hierarchy
 165  *                      irq_domain
 166  * @chip_data:          platform-specific per-chip private data for the chip
 167  *                      methods, to allow shared chip implementations
 168  */
 169 struct irq_data {
 170         u32                     mask;
 171         unsigned int            irq;
 172         unsigned long           hwirq;
 173         struct irq_common_data  *common;
 174         struct irq_chip         *chip;
 175         struct irq_domain       *domain;
 176 #ifdef  CONFIG_IRQ_DOMAIN_HIERARCHY
 177         struct irq_data         *parent_data;
 178 #endif
 179         void                    *chip_data;
 180 };
 181
 182 /*
 183  * Bit masks for irq_common_data.state_use_accessors
 184  *
 185  * IRQD_TRIGGER_MASK            - Mask for the trigger type bits
 186  * IRQD_SETAFFINITY_PENDING     - Affinity setting is pending
 187  * IRQD_NO_BALANCING            - Balancing disabled for this IRQ
 188  * IRQD_PER_CPU                 - Interrupt is per cpu
 189  * IRQD_AFFINITY_SET            - Interrupt affinity was set
 190  * IRQD_LEVEL                   - Interrupt is level triggered
 191  * IRQD_WAKEUP_STATE            - Interrupt is configured for wakeup
 192  *                                from suspend
 193  * IRDQ_MOVE_PCNTXT             - Interrupt can be moved in process
 194  *                                context
 195  * IRQD_IRQ_DISABLED            - Disabled state of the interrupt
 196  * IRQD_IRQ_MASKED              - Masked state of the interrupt
 197  * IRQD_IRQ_INPROGRESS          - In progress state of the interrupt
 198  * IRQD_WAKEUP_ARMED            - Wakeup mode armed
 199  * IRQD_FORWARDED_TO_VCPU       - The interrupt is forwarded to a VCPU
 200  */
 201 enum {
 202         IRQD_TRIGGER_MASK               = 0xf,
 203         IRQD_SETAFFINITY_PENDING        = (1 <<  8),
 204         IRQD_NO_BALANCING               = (1 << 10),
 205         IRQD_PER_CPU                    = (1 << 11),
 206         IRQD_AFFINITY_SET               = (1 << 12),
 207         IRQD_LEVEL                      = (1 << 13),
 208         IRQD_WAKEUP_STATE               = (1 << 14),
 209         IRQD_MOVE_PCNTXT                = (1 << 15),
 210         IRQD_IRQ_DISABLED               = (1 << 16),
 211         IRQD_IRQ_MASKED                 = (1 << 17),
 212         IRQD_IRQ_INPROGRESS             = (1 << 18),
 213         IRQD_WAKEUP_ARMED               = (1 << 19),
 214         IRQD_FORWARDED_TO_VCPU          = (1 << 20),
 215 };
 216
 217 #define __irqd_to_state(d)              ((d)->common->state_use_accessors)
 218
 219 static inline bool irqd_is_setaffinity_pending(struct irq_data *d)
 220 {
 221         return __irqd_to_state(d) & IRQD_SETAFFINITY_PENDING;
 222 }
 223
 224 static inline bool irqd_is_per_cpu(struct irq_data *d)
 225 {
 226         return __irqd_to_state(d) & IRQD_PER_CPU;
 227 }
 228
 229 static inline bool irqd_can_balance(struct irq_data *d)
 230 {
 231         return !(__irqd_to_state(d) & (IRQD_PER_CPU | IRQD_NO_BALANCING));
 232 }
 233
 234 static inline bool irqd_affinity_was_set(struct irq_data *d)
 235 {
 236         return __irqd_to_state(d) & IRQD_AFFINITY_SET;
 237 }
 238
 239 static inline void irqd_mark_affinity_was_set(struct irq_data *d)
 240 {
 241         __irqd_to_state(d) |= IRQD_AFFINITY_SET;
 242 }
 243
 244 static inline u32 irqd_get_trigger_type(struct irq_data *d)
 245 {
 246         return __irqd_to_state(d) & IRQD_TRIGGER_MASK;
 247 }
 248
 249 /*
 250  * Must only be called inside irq_chip.irq_set_type() functions.
 251  */
 252 static inline void irqd_set_trigger_type(struct irq_data *d, u32 type)
 253 {
 254         __irqd_to_state(d) &= ~IRQD_TRIGGER_MASK;
 255         __irqd_to_state(d) |= type & IRQD_TRIGGER_MASK;
 256 }
 257
 258 static inline bool irqd_is_level_type(struct irq_data *d)
 259 {
 260         return __irqd_to_state(d) & IRQD_LEVEL;
 261 }
 262
 263 static inline bool irqd_is_wakeup_set(struct irq_data *d)
 264 {
 265         return __irqd_to_state(d) & IRQD_WAKEUP_STATE;
 266 }
 267
 268 static inline bool irqd_can_move_in_process_context(struct irq_data *d)
 269 {
 270         return __irqd_to_state(d) & IRQD_MOVE_PCNTXT;
 271 }
 272
 273 static inline bool irqd_irq_disabled(struct irq_data *d)
 274 {
 275         return __irqd_to_state(d) & IRQD_IRQ_DISABLED;
 276 }
 277
 278 static inline bool irqd_irq_masked(struct irq_data *d)
 279 {
 280         return __irqd_to_state(d) & IRQD_IRQ_MASKED;
 281 }
 282
 283 static inline bool irqd_irq_inprogress(struct irq_data *d)
 284 {
 285         return __irqd_to_state(d) & IRQD_IRQ_INPROGRESS;
 286 }
 287
 288 static inline bool irqd_is_wakeup_armed(struct irq_data *d)
 289 {
 290         return __irqd_to_state(d) & IRQD_WAKEUP_ARMED;
 291 }
 292
 293 static inline bool irqd_is_forwarded_to_vcpu(struct irq_data *d)
 294 {
 295         return __irqd_to_state(d) & IRQD_FORWARDED_TO_VCPU;
 296 }
 297
 298 static inline void irqd_set_forwarded_to_vcpu(struct irq_data *d)
 299 {
 300         __irqd_to_state(d) |= IRQD_FORWARDED_TO_VCPU;
 301 }
 302
 303 static inline void irqd_clr_forwarded_to_vcpu(struct irq_data *d)
 304 {
 305         __irqd_to_state(d) &= ~IRQD_FORWARDED_TO_VCPU;
 306 }
 307
 308 static inline irq_hw_number_t irqd_to_hwirq(struct irq_data *d)
 309 {
 310         return d->hwirq;
 311 }
 312
 313 /**
 314  * struct irq_chip - hardware interrupt chip descriptor
 315  *
 316  * @name:               name for /proc/interrupts
 317  * @irq_startup:        start up the interrupt (defaults to ->enable if NULL)
 318  * @irq_shutdown:       shut down the interrupt (defaults to ->disable if NULL)
 319  * @irq_enable:         enable the interrupt (defaults to chip->unmask if NULL)
 320  * @irq_disable:        disable the interrupt
 321  * @irq_ack:            start of a new interrupt
 322  * @irq_mask:           mask an interrupt source
 323  * @irq_mask_ack:       ack and mask an interrupt source
 324  * @irq_unmask:         unmask an interrupt source
 325  * @irq_eoi:            end of interrupt
 326  * @irq_set_affinity:   set the CPU affinity on SMP machines
 327  * @irq_retrigger:      resend an IRQ to the CPU
 328  * @irq_set_type:       set the flow type (IRQ_TYPE_LEVEL/etc.) of an IRQ
 329  * @irq_set_wake:       enable/disable power-management wake-on of an IRQ
 330  * @irq_bus_lock:       function to lock access to slow bus (i2c) chips
 331  * @irq_bus_sync_unlock:function to sync and unlock slow bus (i2c) chips
 332  * @irq_cpu_online:     configure an interrupt source for a secondary CPU
 333  * @irq_cpu_offline:    un-configure an interrupt source for a secondary CPU
 334  * @irq_suspend:        function called from core code on suspend once per
 335  *                      chip, when one or more interrupts are installed
 336  * @irq_resume:         function called from core code on resume once per chip,
 337  *                      when one ore more interrupts are installed
 338  * @irq_pm_shutdown:    function called from core code on shutdown once per chip
 339  * @irq_calc_mask:      Optional function to set irq_data.mask for special cases
 340  * @irq_print_chip:     optional to print special chip info in show_interrupts
 341  * @irq_request_resources:      optional to request resources before calling
 342  *                              any other callback related to this irq
 343  * @irq_release_resources:      optional to release resources acquired with
 344  *                              irq_request_resources
 345  * @irq_compose_msi_msg:        optional to compose message content for MSI
 346  * @irq_write_msi_msg:  optional to write message content for MSI
 347  * @irq_get_irqchip_state:      return the internal state of an interrupt
 348  * @irq_set_irqchip_state:      set the internal state of a interrupt
 349  * @irq_set_vcpu_affinity:      optional to target a vCPU in a virtual machine
 350  * @flags:              chip specific flags
 351  */
 352 struct irq_chip {
 353         const char      *name;
 354         unsigned int    (*irq_startup)(struct irq_data *data);
 355         void            (*irq_shutdown)(struct irq_data *data);
 356         void            (*irq_enable)(struct irq_data *data);
 357         void            (*irq_disable)(struct irq_data *data);
 358
 359         void            (*irq_ack)(struct irq_data *data);
 360         void            (*irq_mask)(struct irq_data *data);
 361         void            (*irq_mask_ack)(struct irq_data *data);
 362         void            (*irq_unmask)(struct irq_data *data);
 363         void            (*irq_eoi)(struct irq_data *data);
 364
 365         int             (*irq_set_affinity)(struct irq_data *data, const struct cpumask *dest, bool force);
 366         int             (*irq_retrigger)(struct irq_data *data);
 367         int             (*irq_set_type)(struct irq_data *data, unsigned int flow_type);
 368         int             (*irq_set_wake)(struct irq_data *data, unsigned int on);
 369
 370         void            (*irq_bus_lock)(struct irq_data *data);
 371         void            (*irq_bus_sync_unlock)(struct irq_data *data);
 372
 373         void            (*irq_cpu_online)(struct irq_data *data);
 374         void            (*irq_cpu_offline)(struct irq_data *data);
 375
 376         void            (*irq_suspend)(struct irq_data *data);
 377         void            (*irq_resume)(struct irq_data *data);
 378         void            (*irq_pm_shutdown)(struct irq_data *data);
 379
 380         void            (*irq_calc_mask)(struct irq_data *data);
 381
 382         void            (*irq_print_chip)(struct irq_data *data, struct seq_file *p);
 383         int             (*irq_request_resources)(struct irq_data *data);
 384         void            (*irq_release_resources)(struct irq_data *data);
 385
 386         void            (*irq_compose_msi_msg)(struct irq_data *data, struct msi_msg *msg);
 387         void            (*irq_write_msi_msg)(struct irq_data *data, struct msi_msg *msg);
 388
 389         int             (*irq_get_irqchip_state)(struct irq_data *data, enum irqchip_irq_state which, bool *state);
 390         int             (*irq_set_irqchip_state)(struct irq_data *data, enum irqchip_irq_state which, bool state);
 391
 392         int             (*irq_set_vcpu_affinity)(struct irq_data *data, void *vcpu_info);
 393
 394         unsigned long   flags;
 395 };
 396
 397 /*
 398  * irq_chip specific flags
 399  *
 400  * IRQCHIP_SET_TYPE_MASKED:     Mask before calling chip.irq_set_type()
 401  * IRQCHIP_EOI_IF_HANDLED:      Only issue irq_eoi() when irq was handled
 402  * IRQCHIP_MASK_ON_SUSPEND:     Mask non wake irqs in the suspend path
 403  * IRQCHIP_ONOFFLINE_ENABLED:   Only call irq_on/off_line callbacks
 404  *                              when irq enabled
 405  * IRQCHIP_SKIP_SET_WAKE:       Skip chip.irq_set_wake(), for this irq chip
 406  * IRQCHIP_ONESHOT_SAFE:        One shot does not require mask/unmask
 407  * IRQCHIP_EOI_THREADED:        Chip requires eoi() on unmask in threaded mode
 408  */
 409 enum {
 410         IRQCHIP_SET_TYPE_MASKED         = (1 <<  0),
 411         IRQCHIP_EOI_IF_HANDLED          = (1 <<  1),
 412         IRQCHIP_MASK_ON_SUSPEND         = (1 <<  2),
 413         IRQCHIP_ONOFFLINE_ENABLED       = (1 <<  3),
 414         IRQCHIP_SKIP_SET_WAKE           = (1 <<  4),
 415         IRQCHIP_ONESHOT_SAFE            = (1 <<  5),
 416         IRQCHIP_EOI_THREADED            = (1 <<  6),
 417 };
 418
 419 #include <linux/irqdesc.h>
 420
 421 /*
 422  * Pick up the arch-dependent methods:
 423  */
 424 #include <asm/hw_irq.h>
 425
 426 #ifndef NR_IRQS_LEGACY
 427 # define NR_IRQS_LEGACY 0
 428 #endif
 429
 430 #ifndef ARCH_IRQ_INIT_FLAGS
 431 # define ARCH_IRQ_INIT_FLAGS    0
 432 #endif
 433
 434 #define IRQ_DEFAULT_INIT_FLAGS  ARCH_IRQ_INIT_FLAGS
 435
 436 struct irqaction;
 437 extern int setup_irq(unsigned int irq, struct irqaction *new);
 438 extern void remove_irq(unsigned int irq, struct irqaction *act);
 439 extern int setup_percpu_irq(unsigned int irq, struct irqaction *new);
 440 extern void remove_percpu_irq(unsigned int irq, struct irqaction *act);
 441
 442 extern void irq_cpu_online(void);
 443 extern void irq_cpu_offline(void);
 444 extern int irq_set_affinity_locked(struct irq_data *data,
 445                                    const struct cpumask *cpumask, bool force);
 446 extern int irq_set_vcpu_affinity(unsigned int irq, void *vcpu_info);
 447
 448 extern void irq_migrate_all_off_this_cpu(void);
 449
 450 #if defined(CONFIG_SMP) && defined(CONFIG_GENERIC_PENDING_IRQ)
 451 void irq_move_irq(struct irq_data *data);
 452 void irq_move_masked_irq(struct irq_data *data);
 453 #else
 454 static inline void irq_move_irq(struct irq_data *data) { }
 455 static inline void irq_move_masked_irq(struct irq_data *data) { }
 456 #endif
 457
 458 extern int no_irq_affinity;
 459
 460 #ifdef CONFIG_HARDIRQS_SW_RESEND
 461 int irq_set_parent(int irq, int parent_irq);
 462 #else
 463 static inline int irq_set_parent(int irq, int parent_irq)
 464 {
 465         return 0;
 466 }
 467 #endif
 468
 469 /*
 470  * Built-in IRQ handlers for various IRQ types,
 471  * callable via desc->handle_irq()
 472  */
 473 extern void handle_level_irq(struct irq_desc *desc);
 474 extern void handle_fasteoi_irq(struct irq_desc *desc);
 475 extern void handle_edge_irq(struct irq_desc *desc);
 476 extern void handle_edge_eoi_irq(struct irq_desc *desc);
 477 extern void handle_simple_irq(struct irq_desc *desc);
 478 extern void handle_percpu_irq(struct irq_desc *desc);
 479 extern void handle_percpu_devid_irq(struct irq_desc *desc);
 480 extern void handle_bad_irq(struct irq_desc *desc);
 481 extern void handle_nested_irq(unsigned int irq);
 482
 483 extern int irq_chip_compose_msi_msg(struct irq_data *data, struct msi_msg *msg);
 484 #ifdef  CONFIG_IRQ_DOMAIN_HIERARCHY
 485 extern void irq_chip_enable_parent(struct irq_data *data);
 486 extern void irq_chip_disable_parent(struct irq_data *data);
 487 extern void irq_chip_ack_parent(struct irq_data *data);
 488 extern int irq_chip_retrigger_hierarchy(struct irq_data *data);
 489 extern void irq_chip_mask_parent(struct irq_data *data);
 490 extern void irq_chip_unmask_parent(struct irq_data *data);
 491 extern void irq_chip_eoi_parent(struct irq_data *data);
 492 extern int irq_chip_set_affinity_parent(struct irq_data *data,
 493                                         const struct cpumask *dest,
 494                                         bool force);
 495 extern int irq_chip_set_wake_parent(struct irq_data *data, unsigned int on);
 496 extern int irq_chip_set_vcpu_affinity_parent(struct irq_data *data,
 497                                              void *vcpu_info);
 498 extern int irq_chip_set_type_parent(struct irq_data *data, unsigned int type);
 499 #endif
 500
 501 /* Handling of unhandled and spurious interrupts: */
 502 extern void note_interrupt(struct irq_desc *desc, irqreturn_t action_ret);
 503
 504
 505 /* Enable/disable irq debugging output: */
 506 extern int noirqdebug_setup(char *str);
 507
 508 /* Checks whether the interrupt can be requested by request_irq(): */
 509 extern int can_request_irq(unsigned int irq, unsigned long irqflags);
 510
 511 /* Dummy irq-chip implementations: */
 512 extern struct irq_chip no_irq_chip;
 513 extern struct irq_chip dummy_irq_chip;
 514
 515 extern void
 516 irq_set_chip_and_handler_name(unsigned int irq, struct irq_chip *chip,
 517                               irq_flow_handler_t handle, const char *name);
 518
 519 static inline void irq_set_chip_and_handler(unsigned int irq, struct irq_chip *chip,
 520                                             irq_flow_handler_t handle)
 521 {
 522         irq_set_chip_and_handler_name(irq, chip, handle, NULL);
 523 }
 524
 525 extern int irq_set_percpu_devid(unsigned int irq);
 526
 527 extern void
 528 __irq_set_handler(unsigned int irq, irq_flow_handler_t handle, int is_chained,
 529                   const char *name);
 530
 531 static inline void
 532 irq_set_handler(unsigned int irq, irq_flow_handler_t handle)
 533 {
 534         __irq_set_handler(irq, handle, 0, NULL);
 535 }
 536
 537 /*
 538  * Set a highlevel chained flow handler for a given IRQ.
 539  * (a chained handler is automatically enabled and set to
 540  *  IRQ_NOREQUEST, IRQ_NOPROBE, and IRQ_NOTHREAD)
 541  */
 542 static inline void
 543 irq_set_chained_handler(unsigned int irq, irq_flow_handler_t handle)
 544 {
 545         __irq_set_handler(irq, handle, 1, NULL);
 546 }
 547
 548 /*
 549  * Set a highlevel chained flow handler and its data for a given IRQ.
 550  * (a chained handler is automatically enabled and set to
 551  *  IRQ_NOREQUEST, IRQ_NOPROBE, and IRQ_NOTHREAD)
 552  */
 553 void
 554 irq_set_chained_handler_and_data(unsigned int irq, irq_flow_handler_t handle,
 555                                  void *data);
 556
 557 void irq_modify_status(unsigned int irq, unsigned long clr, unsigned long set);
 558
 559 static inline void irq_set_status_flags(unsigned int irq, unsigned long set)
 560 {
 561         irq_modify_status(irq, 0, set);
 562 }
 563
 564 static inline void irq_clear_status_flags(unsigned int irq, unsigned long clr)
 565 {
 566         irq_modify_status(irq, clr, 0);
 567 }
 568
 569 static inline void irq_set_noprobe(unsigned int irq)
 570 {
 571         irq_modify_status(irq, 0, IRQ_NOPROBE);
 572 }
 573
 574 static inline void irq_set_probe(unsigned int irq)
 575 {
 576         irq_modify_status(irq, IRQ_NOPROBE, 0);
 577 }
 578
 579 static inline void irq_set_nothread(unsigned int irq)
 580 {
 581         irq_modify_status(irq, 0, IRQ_NOTHREAD);
 582 }
 583
 584 static inline void irq_set_thread(unsigned int irq)
 585 {
 586         irq_modify_status(irq, IRQ_NOTHREAD, 0);
 587 }
 588
 589 static inline void irq_set_nested_thread(unsigned int irq, bool nest)
 590 {
 591         if (nest)
 592                 irq_set_status_flags(irq, IRQ_NESTED_THREAD);
 593         else
 594                 irq_clear_status_flags(irq, IRQ_NESTED_THREAD);
 595 }
 596
 597 static inline void irq_set_percpu_devid_flags(unsigned int irq)
 598 {
 599         irq_set_status_flags(irq,
 600                              IRQ_NOAUTOEN | IRQ_PER_CPU | IRQ_NOTHREAD |
 601                              IRQ_NOPROBE | IRQ_PER_CPU_DEVID);
 602 }
 603
 604 /* Set/get chip/data for an IRQ: */
 605 extern int irq_set_chip(unsigned int irq, struct irq_chip *chip);
 606 extern int irq_set_handler_data(unsigned int irq, void *data);
 607 extern int irq_set_chip_data(unsigned int irq, void *data);
 608 extern int irq_set_irq_type(unsigned int irq, unsigned int type);
 609 extern int irq_set_msi_desc(unsigned int irq, struct msi_desc *entry);
 610 extern int irq_set_msi_desc_off(unsigned int irq_base, unsigned int irq_offset,
 611                                 struct msi_desc *entry);
 612 extern struct irq_data *irq_get_irq_data(unsigned int irq);
 613
 614 static inline struct irq_chip *irq_get_chip(unsigned int irq)
 615 {
 616         struct irq_data *d = irq_get_irq_data(irq);
 617         return d ? d->chip : NULL;
 618 }
 619
 620 static inline struct irq_chip *irq_data_get_irq_chip(struct irq_data *d)
 621 {
 622         return d->chip;
 623 }
 624
 625 static inline void *irq_get_chip_data(unsigned int irq)
 626 {
 627         struct irq_data *d = irq_get_irq_data(irq);
 628         return d ? d->chip_data : NULL;
 629 }
 630
 631 static inline void *irq_data_get_irq_chip_data(struct irq_data *d)
 632 {
 633         return d->chip_data;
 634 }
 635
 636 static inline void *irq_get_handler_data(unsigned int irq)
 637 {
 638         struct irq_data *d = irq_get_irq_data(irq);
 639         return d ? d->common->handler_data : NULL;
 640 }
 641
 642 static inline void *irq_data_get_irq_handler_data(struct irq_data *d)
 643 {
 644         return d->common->handler_data;
 645 }
 646
 647 static inline struct msi_desc *irq_get_msi_desc(unsigned int irq)
 648 {
 649         struct irq_data *d = irq_get_irq_data(irq);
 650         return d ? d->common->msi_desc : NULL;
 651 }
 652
 653 static inline struct msi_desc *irq_data_get_msi_desc(struct irq_data *d)
 654 {
 655         return d->common->msi_desc;
 656 }
 657
 658 static inline u32 irq_get_trigger_type(unsigned int irq)
 659 {
 660         struct irq_data *d = irq_get_irq_data(irq);
 661         return d ? irqd_get_trigger_type(d) : 0;
 662 }
 663
 664 static inline int irq_common_data_get_node(struct irq_common_data *d)
 665 {
 666 #ifdef CONFIG_NUMA
 667         return d->node;
 668 #else
 669         return 0;
 670 #endif
 671 }
 672
 673 static inline int irq_data_get_node(struct irq_data *d)
 674 {
 675         return irq_common_data_get_node(d->common);
 676 }
 677
 678 static inline struct cpumask *irq_get_affinity_mask(int irq)
 679 {
 680         struct irq_data *d = irq_get_irq_data(irq);
 681
 682         return d ? d->common->affinity : NULL;
 683 }
 684
 685 static inline struct cpumask *irq_data_get_affinity_mask(struct irq_data *d)
 686 {
 687         return d->common->affinity;
 688 }
 689
 690 unsigned int arch_dynirq_lower_bound(unsigned int from);
 691
 692 int __irq_alloc_descs(int irq, unsigned int from, unsigned int cnt, int node,
 693                 struct module *owner);
 694
 695 /* use macros to avoid needing export.h for THIS_MODULE */
 696 #define irq_alloc_descs(irq, from, cnt, node)   \
 697         __irq_alloc_descs(irq, from, cnt, node, THIS_MODULE)
 698
 699 #define irq_alloc_desc(node)                    \
 700         irq_alloc_descs(-1, 0, 1, node)
 701
 702 #define irq_alloc_desc_at(at, node)             \
 703         irq_alloc_descs(at, at, 1, node)
 704
 705 #define irq_alloc_desc_from(from, node)         \
 706         irq_alloc_descs(-1, from, 1, node)
 707
 708 #define irq_alloc_descs_from(from, cnt, node)   \
 709         irq_alloc_descs(-1, from, cnt, node)
 710
 711 void irq_free_descs(unsigned int irq, unsigned int cnt);
 712 static inline void irq_free_desc(unsigned int irq)
 713 {
 714         irq_free_descs(irq, 1);
 715 }
 716
 717 #ifdef CONFIG_GENERIC_IRQ_LEGACY_ALLOC_HWIRQ
 718 unsigned int irq_alloc_hwirqs(int cnt, int node);
 719 static inline unsigned int irq_alloc_hwirq(int node)
 720 {
 721         return irq_alloc_hwirqs(1, node);
 722 }
 723 void irq_free_hwirqs(unsigned int from, int cnt);
 724 static inline void irq_free_hwirq(unsigned int irq)
 725 {
 726         return irq_free_hwirqs(irq, 1);
 727 }
 728 int arch_setup_hwirq(unsigned int irq, int node);
 729 void arch_teardown_hwirq(unsigned int irq);
 730 #endif
 731
 732 #ifdef CONFIG_GENERIC_IRQ_LEGACY
 733 void irq_init_desc(unsigned int irq);
 734 #endif
 735
 736 /**
 737  * struct irq_chip_regs - register offsets for struct irq_gci
 738  * @enable:     Enable register offset to reg_base
 739  * @disable:    Disable register offset to reg_base
 740  * @mask:       Mask register offset to reg_base
 741  * @ack:        Ack register offset to reg_base
 742  * @eoi:        Eoi register offset to reg_base
 743  * @type:       Type configuration register offset to reg_base
 744  * @polarity:   Polarity configuration register offset to reg_base
 745  */
 746 struct irq_chip_regs {
 747         unsigned long           enable;
 748         unsigned long           disable;
 749         unsigned long           mask;
 750         unsigned long           ack;
 751         unsigned long           eoi;
 752         unsigned long           type;
 753         unsigned long           polarity;
 754 };
 755
 756 /**
 757  * struct irq_chip_type - Generic interrupt chip instance for a flow type
 758  * @chip:               The real interrupt chip which provides the callbacks
 759  * @regs:               Register offsets for this chip
 760  * @handler:            Flow handler associated with this chip
 761  * @type:               Chip can handle these flow types
 762  * @mask_cache_priv:    Cached mask register private to the chip type
 763  * @mask_cache:         Pointer to cached mask register
 764  *
 765  * A irq_generic_chip can have several instances of irq_chip_type when
 766  * it requires different functions and register offsets for different
 767  * flow types.
 768  */
 769 struct irq_chip_type {
 770         struct irq_chip         chip;
 771         struct irq_chip_regs    regs;
 772         irq_flow_handler_t      handler;
 773         u32                     type;
 774         u32                     mask_cache_priv;
 775         u32                     *mask_cache;
 776 };
 777
 778 /**
 779  * struct irq_chip_generic - Generic irq chip data structure
 780  * @lock:               Lock to protect register and cache data access
 781  * @reg_base:           Register base address (virtual)
 782  * @reg_readl:          Alternate I/O accessor (defaults to readl if NULL)
 783  * @reg_writel:         Alternate I/O accessor (defaults to writel if NULL)
 784  * @suspend:            Function called from core code on suspend once per
 785  *                      chip; can be useful instead of irq_chip::suspend to
 786  *                      handle chip details even when no interrupts are in use
 787  * @resume:             Function called from core code on resume once per chip;
 788  *                      can be useful instead of irq_chip::suspend to handle
 789  *                      chip details even when no interrupts are in use
 790  * @irq_base:           Interrupt base nr for this chip
 791  * @irq_cnt:            Number of interrupts handled by this chip
 792  * @mask_cache:         Cached mask register shared between all chip types
 793  * @type_cache:         Cached type register
 794  * @polarity_cache:     Cached polarity register
 795  * @wake_enabled:       Interrupt can wakeup from suspend
 796  * @wake_active:        Interrupt is marked as an wakeup from suspend source
 797  * @num_ct:             Number of available irq_chip_type instances (usually 1)
 798  * @private:            Private data for non generic chip callbacks
 799  * @installed:          bitfield to denote installed interrupts
 800  * @unused:             bitfield to denote unused interrupts
 801  * @domain:             irq domain pointer
 802  * @list:               List head for keeping track of instances
 803  * @chip_types:         Array of interrupt irq_chip_types
 804  *
 805  * Note, that irq_chip_generic can have multiple irq_chip_type
 806  * implementations which can be associated to a particular irq line of
 807  * an irq_chip_generic instance. That allows to share and protect
 808  * state in an irq_chip_generic instance when we need to implement
 809  * different flow mechanisms (level/edge) for it.
 810  */
 811 struct irq_chip_generic {
 812         raw_spinlock_t          lock;
 813         void __iomem            *reg_base;
 814         u32                     (*reg_readl)(void __iomem *addr);
 815         void                    (*reg_writel)(u32 val, void __iomem *addr);
 816         void                    (*suspend)(struct irq_chip_generic *gc);
 817         void                    (*resume)(struct irq_chip_generic *gc);
 818         unsigned int            irq_base;
 819         unsigned int            irq_cnt;
 820         u32                     mask_cache;
 821         u32                     type_cache;
 822         u32                     polarity_cache;
 823         u32                     wake_enabled;
 824         u32                     wake_active;
 825         unsigned int            num_ct;
 826         void                    *private;
 827         unsigned long           installed;
 828         unsigned long           unused;
 829         struct irq_domain       *domain;
 830         struct list_head        list;
 831         struct irq_chip_type    chip_types[0];
 832 };
 833
 834 /**
 835  * enum irq_gc_flags - Initialization flags for generic irq chips
 836  * @IRQ_GC_INIT_MASK_CACHE:     Initialize the mask_cache by reading mask reg
 837  * @IRQ_GC_INIT_NESTED_LOCK:    Set the lock class of the irqs to nested for
 838  *                              irq chips which need to call irq_set_wake() on
 839  *                              the parent irq. Usually GPIO implementations
 840  * @IRQ_GC_MASK_CACHE_PER_TYPE: Mask cache is chip type private
 841  * @IRQ_GC_NO_MASK:             Do not calculate irq_data->mask
 842  * @IRQ_GC_BE_IO:               Use big-endian register accesses (default: LE)
 843  */
 844 enum irq_gc_flags {
 845         IRQ_GC_INIT_MASK_CACHE          = 1 << 0,
 846         IRQ_GC_INIT_NESTED_LOCK         = 1 << 1,
 847         IRQ_GC_MASK_CACHE_PER_TYPE      = 1 << 2,
 848         IRQ_GC_NO_MASK                  = 1 << 3,
 849         IRQ_GC_BE_IO                    = 1 << 4,
 850 };
 851
 852 /*
 853  * struct irq_domain_chip_generic - Generic irq chip data structure for irq domains
 854  * @irqs_per_chip:      Number of interrupts per chip
 855  * @num_chips:          Number of chips
 856  * @irq_flags_to_set:   IRQ* flags to set on irq setup
 857  * @irq_flags_to_clear: IRQ* flags to clear on irq setup
 858  * @gc_flags:           Generic chip specific setup flags
 859  * @gc:                 Array of pointers to generic interrupt chips
 860  */
 861 struct irq_domain_chip_generic {
 862         unsigned int            irqs_per_chip;
 863         unsigned int            num_chips;
 864         unsigned int            irq_flags_to_clear;
 865         unsigned int            irq_flags_to_set;
 866         enum irq_gc_flags       gc_flags;
 867         struct irq_chip_generic *gc[0];
 868 };
 869
 870 /* Generic chip callback functions */
 871 void irq_gc_noop(struct irq_data *d);
 872 void irq_gc_mask_disable_reg(struct irq_data *d);
 873 void irq_gc_mask_set_bit(struct irq_data *d);
 874 void irq_gc_mask_clr_bit(struct irq_data *d);
 875 void irq_gc_unmask_enable_reg(struct irq_data *d);
 876 void irq_gc_ack_set_bit(struct irq_data *d);
 877 void irq_gc_ack_clr_bit(struct irq_data *d);
 878 void irq_gc_mask_disable_reg_and_ack(struct irq_data *d);
 879 void irq_gc_eoi(struct irq_data *d);
 880 int irq_gc_set_wake(struct irq_data *d, unsigned int on);
 881
 882 /* Setup functions for irq_chip_generic */
 883 int irq_map_generic_chip(struct irq_domain *d, unsigned int virq,
 884                          irq_hw_number_t hw_irq);
 885 struct irq_chip_generic *
 886 irq_alloc_generic_chip(const char *name, int nr_ct, unsigned int irq_base,
 887                        void __iomem *reg_base, irq_flow_handler_t handler);
 888 void irq_setup_generic_chip(struct irq_chip_generic *gc, u32 msk,
 889                             enum irq_gc_flags flags, unsigned int clr,
 890                             unsigned int set);
 891 int irq_setup_alt_chip(struct irq_data *d, unsigned int type);
 892 void irq_remove_generic_chip(struct irq_chip_generic *gc, u32 msk,
 893                              unsigned int clr, unsigned int set);
 894
 895 struct irq_chip_generic *irq_get_domain_generic_chip(struct irq_domain *d, unsigned int hw_irq);
 896 int irq_alloc_domain_generic_chips(struct irq_domain *d, int irqs_per_chip,
 897                                    int num_ct, const char *name,
 898                                    irq_flow_handler_t handler,
 899                                    unsigned int clr, unsigned int set,
 900                                    enum irq_gc_flags flags);
 901
 902
 903 static inline struct irq_chip_type *irq_data_get_chip_type(struct irq_data *d)
 904 {
 905         return container_of(d->chip, struct irq_chip_type, chip);
 906 }
 907
 908 #define IRQ_MSK(n) (u32)((n) < 32 ? ((1 << (n)) - 1) : UINT_MAX)
 909
 910 #ifdef CONFIG_SMP
 911 static inline void irq_gc_lock(struct irq_chip_generic *gc)
 912 {
 913         raw_spin_lock(&gc->lock);
 914 }
 915
 916 static inline void irq_gc_unlock(struct irq_chip_generic *gc)
 917 {
 918         raw_spin_unlock(&gc->lock);
 919 }
 920 #else
 921 static inline void irq_gc_lock(struct irq_chip_generic *gc) { }
 922 static inline void irq_gc_unlock(struct irq_chip_generic *gc) { }
 923 #endif
 924
 925 static inline void irq_reg_writel(struct irq_chip_generic *gc,
 926                                   u32 val, int reg_offset)
 927 {
 928         if (gc->reg_writel)
 929                 gc->reg_writel(val, gc->reg_base + reg_offset);
 930         else
 931                 writel(val, gc->reg_base + reg_offset);
 932 }
 933
 934 static inline u32 irq_reg_readl(struct irq_chip_generic *gc,
 935                                 int reg_offset)
 936 {
 937         if (gc->reg_readl)
 938                 return gc->reg_readl(gc->reg_base + reg_offset);
 939         else
 940                 return readl(gc->reg_base + reg_offset);
 941 }
 942
 943 /* Contrary to Linux irqs, for hardware irqs the irq number 0 is valid */
 944 #define INVALID_HWIRQ   (~0UL)
 945 irq_hw_number_t ipi_get_hwirq(unsigned int irq, unsigned int cpu);
 946
 947 #endif /* _LINUX_IRQ_H */