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            __private 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) ACCESS_PRIVATE((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 #undef __irqd_to_state
 309
 310 static inline irq_hw_number_t irqd_to_hwirq(struct irq_data *d)
 311 {
 312         return d->hwirq;
 313 }
 314
 315 /**
 316  * struct irq_chip - hardware interrupt chip descriptor
 317  *
 318  * @parent_device:      pointer to parent device for irqchip
 319  * @name:               name for /proc/interrupts
 320  * @irq_startup:        start up the interrupt (defaults to ->enable if NULL)
 321  * @irq_shutdown:       shut down the interrupt (defaults to ->disable if NULL)
 322  * @irq_enable:         enable the interrupt (defaults to chip->unmask if NULL)
 323  * @irq_disable:        disable the interrupt
 324  * @irq_ack:            start of a new interrupt
 325  * @irq_mask:           mask an interrupt source
 326  * @irq_mask_ack:       ack and mask an interrupt source
 327  * @irq_unmask:         unmask an interrupt source
 328  * @irq_eoi:            end of interrupt
 329  * @irq_set_affinity:   set the CPU affinity on SMP machines
 330  * @irq_retrigger:      resend an IRQ to the CPU
 331  * @irq_set_type:       set the flow type (IRQ_TYPE_LEVEL/etc.) of an IRQ
 332  * @irq_set_wake:       enable/disable power-management wake-on of an IRQ
 333  * @irq_bus_lock:       function to lock access to slow bus (i2c) chips
 334  * @irq_bus_sync_unlock:function to sync and unlock slow bus (i2c) chips
 335  * @irq_cpu_online:     configure an interrupt source for a secondary CPU
 336  * @irq_cpu_offline:    un-configure an interrupt source for a secondary CPU
 337  * @irq_suspend:        function called from core code on suspend once per
 338  *                      chip, when one or more interrupts are installed
 339  * @irq_resume:         function called from core code on resume once per chip,
 340  *                      when one ore more interrupts are installed
 341  * @irq_pm_shutdown:    function called from core code on shutdown once per chip
 342  * @irq_calc_mask:      Optional function to set irq_data.mask for special cases
 343  * @irq_print_chip:     optional to print special chip info in show_interrupts
 344  * @irq_request_resources:      optional to request resources before calling
 345  *                              any other callback related to this irq
 346  * @irq_release_resources:      optional to release resources acquired with
 347  *                              irq_request_resources
 348  * @irq_compose_msi_msg:        optional to compose message content for MSI
 349  * @irq_write_msi_msg:  optional to write message content for MSI
 350  * @irq_get_irqchip_state:      return the internal state of an interrupt
 351  * @irq_set_irqchip_state:      set the internal state of a interrupt
 352  * @irq_set_vcpu_affinity:      optional to target a vCPU in a virtual machine
 353  * @ipi_send_single:    send a single IPI to destination cpus
 354  * @ipi_send_mask:      send an IPI to destination cpus in cpumask
 355  * @flags:              chip specific flags
 356  */
 357 struct irq_chip {
 358         struct device   *parent_device;
 359         const char      *name;
 360         unsigned int    (*irq_startup)(struct irq_data *data);
 361         void            (*irq_shutdown)(struct irq_data *data);
 362         void            (*irq_enable)(struct irq_data *data);
 363         void            (*irq_disable)(struct irq_data *data);
 364
 365         void            (*irq_ack)(struct irq_data *data);
 366         void            (*irq_mask)(struct irq_data *data);
 367         void            (*irq_mask_ack)(struct irq_data *data);
 368         void            (*irq_unmask)(struct irq_data *data);
 369         void            (*irq_eoi)(struct irq_data *data);
 370
 371         int             (*irq_set_affinity)(struct irq_data *data, const struct cpumask *dest, bool force);
 372         int             (*irq_retrigger)(struct irq_data *data);
 373         int             (*irq_set_type)(struct irq_data *data, unsigned int flow_type);
 374         int             (*irq_set_wake)(struct irq_data *data, unsigned int on);
 375
 376         void            (*irq_bus_lock)(struct irq_data *data);
 377         void            (*irq_bus_sync_unlock)(struct irq_data *data);
 378
 379         void            (*irq_cpu_online)(struct irq_data *data);
 380         void            (*irq_cpu_offline)(struct irq_data *data);
 381
 382         void            (*irq_suspend)(struct irq_data *data);
 383         void            (*irq_resume)(struct irq_data *data);
 384         void            (*irq_pm_shutdown)(struct irq_data *data);
 385
 386         void            (*irq_calc_mask)(struct irq_data *data);
 387
 388         void            (*irq_print_chip)(struct irq_data *data, struct seq_file *p);
 389         int             (*irq_request_resources)(struct irq_data *data);
 390         void            (*irq_release_resources)(struct irq_data *data);
 391
 392         void            (*irq_compose_msi_msg)(struct irq_data *data, struct msi_msg *msg);
 393         void            (*irq_write_msi_msg)(struct irq_data *data, struct msi_msg *msg);
 394
 395         int             (*irq_get_irqchip_state)(struct irq_data *data, enum irqchip_irq_state which, bool *state);
 396         int             (*irq_set_irqchip_state)(struct irq_data *data, enum irqchip_irq_state which, bool state);
 397
 398         int             (*irq_set_vcpu_affinity)(struct irq_data *data, void *vcpu_info);
 399
 400         void            (*ipi_send_single)(struct irq_data *data, unsigned int cpu);
 401         void            (*ipi_send_mask)(struct irq_data *data, const struct cpumask *dest);
 402
 403         unsigned long   flags;
 404 };
 405
 406 /*
 407  * irq_chip specific flags
 408  *
 409  * IRQCHIP_SET_TYPE_MASKED:     Mask before calling chip.irq_set_type()
 410  * IRQCHIP_EOI_IF_HANDLED:      Only issue irq_eoi() when irq was handled
 411  * IRQCHIP_MASK_ON_SUSPEND:     Mask non wake irqs in the suspend path
 412  * IRQCHIP_ONOFFLINE_ENABLED:   Only call irq_on/off_line callbacks
 413  *                              when irq enabled
 414  * IRQCHIP_SKIP_SET_WAKE:       Skip chip.irq_set_wake(), for this irq chip
 415  * IRQCHIP_ONESHOT_SAFE:        One shot does not require mask/unmask
 416  * IRQCHIP_EOI_THREADED:        Chip requires eoi() on unmask in threaded mode
 417  */
 418 enum {
 419         IRQCHIP_SET_TYPE_MASKED         = (1 <<  0),
 420         IRQCHIP_EOI_IF_HANDLED          = (1 <<  1),
 421         IRQCHIP_MASK_ON_SUSPEND         = (1 <<  2),
 422         IRQCHIP_ONOFFLINE_ENABLED       = (1 <<  3),
 423         IRQCHIP_SKIP_SET_WAKE           = (1 <<  4),
 424         IRQCHIP_ONESHOT_SAFE            = (1 <<  5),
 425         IRQCHIP_EOI_THREADED            = (1 <<  6),
 426 };
 427
 428 #include <linux/irqdesc.h>
 429
 430 /*
 431  * Pick up the arch-dependent methods:
 432  */
 433 #include <asm/hw_irq.h>
 434
 435 #ifndef NR_IRQS_LEGACY
 436 # define NR_IRQS_LEGACY 0
 437 #endif
 438
 439 #ifndef ARCH_IRQ_INIT_FLAGS
 440 # define ARCH_IRQ_INIT_FLAGS    0
 441 #endif
 442
 443 #define IRQ_DEFAULT_INIT_FLAGS  ARCH_IRQ_INIT_FLAGS
 444
 445 struct irqaction;
 446 extern int setup_irq(unsigned int irq, struct irqaction *new);
 447 extern void remove_irq(unsigned int irq, struct irqaction *act);
 448 extern int setup_percpu_irq(unsigned int irq, struct irqaction *new);
 449 extern void remove_percpu_irq(unsigned int irq, struct irqaction *act);
 450
 451 extern void irq_cpu_online(void);
 452 extern void irq_cpu_offline(void);
 453 extern int irq_set_affinity_locked(struct irq_data *data,
 454                                    const struct cpumask *cpumask, bool force);
 455 extern int irq_set_vcpu_affinity(unsigned int irq, void *vcpu_info);
 456
 457 extern void irq_migrate_all_off_this_cpu(void);
 458
 459 #if defined(CONFIG_SMP) && defined(CONFIG_GENERIC_PENDING_IRQ)
 460 void irq_move_irq(struct irq_data *data);
 461 void irq_move_masked_irq(struct irq_data *data);
 462 #else
 463 static inline void irq_move_irq(struct irq_data *data) { }
 464 static inline void irq_move_masked_irq(struct irq_data *data) { }
 465 #endif
 466
 467 extern int no_irq_affinity;
 468
 469 #ifdef CONFIG_HARDIRQS_SW_RESEND
 470 int irq_set_parent(int irq, int parent_irq);
 471 #else
 472 static inline int irq_set_parent(int irq, int parent_irq)
 473 {
 474         return 0;
 475 }
 476 #endif
 477
 478 /*
 479  * Built-in IRQ handlers for various IRQ types,
 480  * callable via desc->handle_irq()
 481  */
 482 extern void handle_level_irq(struct irq_desc *desc);
 483 extern void handle_fasteoi_irq(struct irq_desc *desc);
 484 extern void handle_edge_irq(struct irq_desc *desc);
 485 extern void handle_edge_eoi_irq(struct irq_desc *desc);
 486 extern void handle_simple_irq(struct irq_desc *desc);
 487 extern void handle_percpu_irq(struct irq_desc *desc);
 488 extern void handle_percpu_devid_irq(struct irq_desc *desc);
 489 extern void handle_bad_irq(struct irq_desc *desc);
 490 extern void handle_nested_irq(unsigned int irq);
 491
 492 extern int irq_chip_compose_msi_msg(struct irq_data *data, struct msi_msg *msg);
 493 extern int irq_chip_pm_get(struct irq_data *data);
 494 extern int irq_chip_pm_put(struct irq_data *data);
 495 #ifdef  CONFIG_IRQ_DOMAIN_HIERARCHY
 496 extern void irq_chip_enable_parent(struct irq_data *data);
 497 extern void irq_chip_disable_parent(struct irq_data *data);
 498 extern void irq_chip_ack_parent(struct irq_data *data);
 499 extern int irq_chip_retrigger_hierarchy(struct irq_data *data);
 500 extern void irq_chip_mask_parent(struct irq_data *data);
 501 extern void irq_chip_unmask_parent(struct irq_data *data);
 502 extern void irq_chip_eoi_parent(struct irq_data *data);
 503 extern int irq_chip_set_affinity_parent(struct irq_data *data,
 504                                         const struct cpumask *dest,
 505                                         bool force);
 506 extern int irq_chip_set_wake_parent(struct irq_data *data, unsigned int on);
 507 extern int irq_chip_set_vcpu_affinity_parent(struct irq_data *data,
 508                                              void *vcpu_info);
 509 extern int irq_chip_set_type_parent(struct irq_data *data, unsigned int type);
 510 #endif
 511
 512 /* Handling of unhandled and spurious interrupts: */
 513 extern void note_interrupt(struct irq_desc *desc, irqreturn_t action_ret);
 514
 515
 516 /* Enable/disable irq debugging output: */
 517 extern int noirqdebug_setup(char *str);
 518
 519 /* Checks whether the interrupt can be requested by request_irq(): */
 520 extern int can_request_irq(unsigned int irq, unsigned long irqflags);
 521
 522 /* Dummy irq-chip implementations: */
 523 extern struct irq_chip no_irq_chip;
 524 extern struct irq_chip dummy_irq_chip;
 525
 526 extern void
 527 irq_set_chip_and_handler_name(unsigned int irq, struct irq_chip *chip,
 528                               irq_flow_handler_t handle, const char *name);
 529
 530 static inline void irq_set_chip_and_handler(unsigned int irq, struct irq_chip *chip,
 531                                             irq_flow_handler_t handle)
 532 {
 533         irq_set_chip_and_handler_name(irq, chip, handle, NULL);
 534 }
 535
 536 extern int irq_set_percpu_devid(unsigned int irq);
 537 extern int irq_set_percpu_devid_partition(unsigned int irq,
 538                                           const struct cpumask *affinity);
 539 extern int irq_get_percpu_devid_partition(unsigned int irq,
 540                                           struct cpumask *affinity);
 541
 542 extern void
 543 __irq_set_handler(unsigned int irq, irq_flow_handler_t handle, int is_chained,
 544                   const char *name);
 545
 546 static inline void
 547 irq_set_handler(unsigned int irq, irq_flow_handler_t handle)
 548 {
 549         __irq_set_handler(irq, handle, 0, NULL);
 550 }
 551
 552 /*
 553  * Set a highlevel chained flow handler for a given IRQ.
 554  * (a chained handler is automatically enabled and set to
 555  *  IRQ_NOREQUEST, IRQ_NOPROBE, and IRQ_NOTHREAD)
 556  */
 557 static inline void
 558 irq_set_chained_handler(unsigned int irq, irq_flow_handler_t handle)
 559 {
 560         __irq_set_handler(irq, handle, 1, NULL);
 561 }
 562
 563 /*
 564  * Set a highlevel chained flow handler and its data for a given IRQ.
 565  * (a chained handler is automatically enabled and set to
 566  *  IRQ_NOREQUEST, IRQ_NOPROBE, and IRQ_NOTHREAD)
 567  */
 568 void
 569 irq_set_chained_handler_and_data(unsigned int irq, irq_flow_handler_t handle,
 570                                  void *data);
 571
 572 void irq_modify_status(unsigned int irq, unsigned long clr, unsigned long set);
 573
 574 static inline void irq_set_status_flags(unsigned int irq, unsigned long set)
 575 {
 576         irq_modify_status(irq, 0, set);
 577 }
 578
 579 static inline void irq_clear_status_flags(unsigned int irq, unsigned long clr)
 580 {
 581         irq_modify_status(irq, clr, 0);
 582 }
 583
 584 static inline void irq_set_noprobe(unsigned int irq)
 585 {
 586         irq_modify_status(irq, 0, IRQ_NOPROBE);
 587 }
 588
 589 static inline void irq_set_probe(unsigned int irq)
 590 {
 591         irq_modify_status(irq, IRQ_NOPROBE, 0);
 592 }
 593
 594 static inline void irq_set_nothread(unsigned int irq)
 595 {
 596         irq_modify_status(irq, 0, IRQ_NOTHREAD);
 597 }
 598
 599 static inline void irq_set_thread(unsigned int irq)
 600 {
 601         irq_modify_status(irq, IRQ_NOTHREAD, 0);
 602 }
 603
 604 static inline void irq_set_nested_thread(unsigned int irq, bool nest)
 605 {
 606         if (nest)
 607                 irq_set_status_flags(irq, IRQ_NESTED_THREAD);
 608         else
 609                 irq_clear_status_flags(irq, IRQ_NESTED_THREAD);
 610 }
 611
 612 static inline void irq_set_percpu_devid_flags(unsigned int irq)
 613 {
 614         irq_set_status_flags(irq,
 615                              IRQ_NOAUTOEN | IRQ_PER_CPU | IRQ_NOTHREAD |
 616                              IRQ_NOPROBE | IRQ_PER_CPU_DEVID);
 617 }
 618
 619 /* Set/get chip/data for an IRQ: */
 620 extern int irq_set_chip(unsigned int irq, struct irq_chip *chip);
 621 extern int irq_set_handler_data(unsigned int irq, void *data);
 622 extern int irq_set_chip_data(unsigned int irq, void *data);
 623 extern int irq_set_irq_type(unsigned int irq, unsigned int type);
 624 extern int irq_set_msi_desc(unsigned int irq, struct msi_desc *entry);
 625 extern int irq_set_msi_desc_off(unsigned int irq_base, unsigned int irq_offset,
 626                                 struct msi_desc *entry);
 627 extern struct irq_data *irq_get_irq_data(unsigned int irq);
 628
 629 static inline struct irq_chip *irq_get_chip(unsigned int irq)
 630 {
 631         struct irq_data *d = irq_get_irq_data(irq);
 632         return d ? d->chip : NULL;
 633 }
 634
 635 static inline struct irq_chip *irq_data_get_irq_chip(struct irq_data *d)
 636 {
 637         return d->chip;
 638 }
 639
 640 static inline void *irq_get_chip_data(unsigned int irq)
 641 {
 642         struct irq_data *d = irq_get_irq_data(irq);
 643         return d ? d->chip_data : NULL;
 644 }
 645
 646 static inline void *irq_data_get_irq_chip_data(struct irq_data *d)
 647 {
 648         return d->chip_data;
 649 }
 650
 651 static inline void *irq_get_handler_data(unsigned int irq)
 652 {
 653         struct irq_data *d = irq_get_irq_data(irq);
 654         return d ? d->common->handler_data : NULL;
 655 }
 656
 657 static inline void *irq_data_get_irq_handler_data(struct irq_data *d)
 658 {
 659         return d->common->handler_data;
 660 }
 661
 662 static inline struct msi_desc *irq_get_msi_desc(unsigned int irq)
 663 {
 664         struct irq_data *d = irq_get_irq_data(irq);
 665         return d ? d->common->msi_desc : NULL;
 666 }
 667
 668 static inline struct msi_desc *irq_data_get_msi_desc(struct irq_data *d)
 669 {
 670         return d->common->msi_desc;
 671 }
 672
 673 static inline u32 irq_get_trigger_type(unsigned int irq)
 674 {
 675         struct irq_data *d = irq_get_irq_data(irq);
 676         return d ? irqd_get_trigger_type(d) : 0;
 677 }
 678
 679 static inline int irq_common_data_get_node(struct irq_common_data *d)
 680 {
 681 #ifdef CONFIG_NUMA
 682         return d->node;
 683 #else
 684         return 0;
 685 #endif
 686 }
 687
 688 static inline int irq_data_get_node(struct irq_data *d)
 689 {
 690         return irq_common_data_get_node(d->common);
 691 }
 692
 693 static inline struct cpumask *irq_get_affinity_mask(int irq)
 694 {
 695         struct irq_data *d = irq_get_irq_data(irq);
 696
 697         return d ? d->common->affinity : NULL;
 698 }
 699
 700 static inline struct cpumask *irq_data_get_affinity_mask(struct irq_data *d)
 701 {
 702         return d->common->affinity;
 703 }
 704
 705 unsigned int arch_dynirq_lower_bound(unsigned int from);
 706
 707 int __irq_alloc_descs(int irq, unsigned int from, unsigned int cnt, int node,
 708                 struct module *owner);
 709
 710 /* use macros to avoid needing export.h for THIS_MODULE */
 711 #define irq_alloc_descs(irq, from, cnt, node)   \
 712         __irq_alloc_descs(irq, from, cnt, node, THIS_MODULE)
 713
 714 #define irq_alloc_desc(node)                    \
 715         irq_alloc_descs(-1, 0, 1, node)
 716
 717 #define irq_alloc_desc_at(at, node)             \
 718         irq_alloc_descs(at, at, 1, node)
 719
 720 #define irq_alloc_desc_from(from, node)         \
 721         irq_alloc_descs(-1, from, 1, node)
 722
 723 #define irq_alloc_descs_from(from, cnt, node)   \
 724         irq_alloc_descs(-1, from, cnt, node)
 725
 726 void irq_free_descs(unsigned int irq, unsigned int cnt);
 727 static inline void irq_free_desc(unsigned int irq)
 728 {
 729         irq_free_descs(irq, 1);
 730 }
 731
 732 #ifdef CONFIG_GENERIC_IRQ_LEGACY_ALLOC_HWIRQ
 733 unsigned int irq_alloc_hwirqs(int cnt, int node);
 734 static inline unsigned int irq_alloc_hwirq(int node)
 735 {
 736         return irq_alloc_hwirqs(1, node);
 737 }
 738 void irq_free_hwirqs(unsigned int from, int cnt);
 739 static inline void irq_free_hwirq(unsigned int irq)
 740 {
 741         return irq_free_hwirqs(irq, 1);
 742 }
 743 int arch_setup_hwirq(unsigned int irq, int node);
 744 void arch_teardown_hwirq(unsigned int irq);
 745 #endif
 746
 747 #ifdef CONFIG_GENERIC_IRQ_LEGACY
 748 void irq_init_desc(unsigned int irq);
 749 #endif
 750
 751 /**
 752  * struct irq_chip_regs - register offsets for struct irq_gci
 753  * @enable:     Enable register offset to reg_base
 754  * @disable:    Disable register offset to reg_base
 755  * @mask:       Mask register offset to reg_base
 756  * @ack:        Ack register offset to reg_base
 757  * @eoi:        Eoi register offset to reg_base
 758  * @type:       Type configuration register offset to reg_base
 759  * @polarity:   Polarity configuration register offset to reg_base
 760  */
 761 struct irq_chip_regs {
 762         unsigned long           enable;
 763         unsigned long           disable;
 764         unsigned long           mask;
 765         unsigned long           ack;
 766         unsigned long           eoi;
 767         unsigned long           type;
 768         unsigned long           polarity;
 769 };
 770
 771 /**
 772  * struct irq_chip_type - Generic interrupt chip instance for a flow type
 773  * @chip:               The real interrupt chip which provides the callbacks
 774  * @regs:               Register offsets for this chip
 775  * @handler:            Flow handler associated with this chip
 776  * @type:               Chip can handle these flow types
 777  * @mask_cache_priv:    Cached mask register private to the chip type
 778  * @mask_cache:         Pointer to cached mask register
 779  *
 780  * A irq_generic_chip can have several instances of irq_chip_type when
 781  * it requires different functions and register offsets for different
 782  * flow types.
 783  */
 784 struct irq_chip_type {
 785         struct irq_chip         chip;
 786         struct irq_chip_regs    regs;
 787         irq_flow_handler_t      handler;
 788         u32                     type;
 789         u32                     mask_cache_priv;
 790         u32                     *mask_cache;
 791 };
 792
 793 /**
 794  * struct irq_chip_generic - Generic irq chip data structure
 795  * @lock:               Lock to protect register and cache data access
 796  * @reg_base:           Register base address (virtual)
 797  * @reg_readl:          Alternate I/O accessor (defaults to readl if NULL)
 798  * @reg_writel:         Alternate I/O accessor (defaults to writel if NULL)
 799  * @suspend:            Function called from core code on suspend once per
 800  *                      chip; can be useful instead of irq_chip::suspend to
 801  *                      handle chip details even when no interrupts are in use
 802  * @resume:             Function called from core code on resume once per chip;
 803  *                      can be useful instead of irq_chip::suspend to handle
 804  *                      chip details even when no interrupts are in use
 805  * @irq_base:           Interrupt base nr for this chip
 806  * @irq_cnt:            Number of interrupts handled by this chip
 807  * @mask_cache:         Cached mask register shared between all chip types
 808  * @type_cache:         Cached type register
 809  * @polarity_cache:     Cached polarity register
 810  * @wake_enabled:       Interrupt can wakeup from suspend
 811  * @wake_active:        Interrupt is marked as an wakeup from suspend source
 812  * @num_ct:             Number of available irq_chip_type instances (usually 1)
 813  * @private:            Private data for non generic chip callbacks
 814  * @installed:          bitfield to denote installed interrupts
 815  * @unused:             bitfield to denote unused interrupts
 816  * @domain:             irq domain pointer
 817  * @list:               List head for keeping track of instances
 818  * @chip_types:         Array of interrupt irq_chip_types
 819  *
 820  * Note, that irq_chip_generic can have multiple irq_chip_type
 821  * implementations which can be associated to a particular irq line of
 822  * an irq_chip_generic instance. That allows to share and protect
 823  * state in an irq_chip_generic instance when we need to implement
 824  * different flow mechanisms (level/edge) for it.
 825  */
 826 struct irq_chip_generic {
 827         raw_spinlock_t          lock;
 828         void __iomem            *reg_base;
 829         u32                     (*reg_readl)(void __iomem *addr);
 830         void                    (*reg_writel)(u32 val, void __iomem *addr);
 831         void                    (*suspend)(struct irq_chip_generic *gc);
 832         void                    (*resume)(struct irq_chip_generic *gc);
 833         unsigned int            irq_base;
 834         unsigned int            irq_cnt;
 835         u32                     mask_cache;
 836         u32                     type_cache;
 837         u32                     polarity_cache;
 838         u32                     wake_enabled;
 839         u32                     wake_active;
 840         unsigned int            num_ct;
 841         void                    *private;
 842         unsigned long           installed;
 843         unsigned long           unused;
 844         struct irq_domain       *domain;
 845         struct list_head        list;
 846         struct irq_chip_type    chip_types[0];
 847 };
 848
 849 /**
 850  * enum irq_gc_flags - Initialization flags for generic irq chips
 851  * @IRQ_GC_INIT_MASK_CACHE:     Initialize the mask_cache by reading mask reg
 852  * @IRQ_GC_INIT_NESTED_LOCK:    Set the lock class of the irqs to nested for
 853  *                              irq chips which need to call irq_set_wake() on
 854  *                              the parent irq. Usually GPIO implementations
 855  * @IRQ_GC_MASK_CACHE_PER_TYPE: Mask cache is chip type private
 856  * @IRQ_GC_NO_MASK:             Do not calculate irq_data->mask
 857  * @IRQ_GC_BE_IO:               Use big-endian register accesses (default: LE)
 858  */
 859 enum irq_gc_flags {
 860         IRQ_GC_INIT_MASK_CACHE          = 1 << 0,
 861         IRQ_GC_INIT_NESTED_LOCK         = 1 << 1,
 862         IRQ_GC_MASK_CACHE_PER_TYPE      = 1 << 2,
 863         IRQ_GC_NO_MASK                  = 1 << 3,
 864         IRQ_GC_BE_IO                    = 1 << 4,
 865 };
 866
 867 /*
 868  * struct irq_domain_chip_generic - Generic irq chip data structure for irq domains
 869  * @irqs_per_chip:      Number of interrupts per chip
 870  * @num_chips:          Number of chips
 871  * @irq_flags_to_set:   IRQ* flags to set on irq setup
 872  * @irq_flags_to_clear: IRQ* flags to clear on irq setup
 873  * @gc_flags:           Generic chip specific setup flags
 874  * @gc:                 Array of pointers to generic interrupt chips
 875  */
 876 struct irq_domain_chip_generic {
 877         unsigned int            irqs_per_chip;
 878         unsigned int            num_chips;
 879         unsigned int            irq_flags_to_clear;
 880         unsigned int            irq_flags_to_set;
 881         enum irq_gc_flags       gc_flags;
 882         struct irq_chip_generic *gc[0];
 883 };
 884
 885 /* Generic chip callback functions */
 886 void irq_gc_noop(struct irq_data *d);
 887 void irq_gc_mask_disable_reg(struct irq_data *d);
 888 void irq_gc_mask_set_bit(struct irq_data *d);
 889 void irq_gc_mask_clr_bit(struct irq_data *d);
 890 void irq_gc_unmask_enable_reg(struct irq_data *d);
 891 void irq_gc_ack_set_bit(struct irq_data *d);
 892 void irq_gc_ack_clr_bit(struct irq_data *d);
 893 void irq_gc_mask_disable_reg_and_ack(struct irq_data *d);
 894 void irq_gc_eoi(struct irq_data *d);
 895 int irq_gc_set_wake(struct irq_data *d, unsigned int on);
 896
 897 /* Setup functions for irq_chip_generic */
 898 int irq_map_generic_chip(struct irq_domain *d, unsigned int virq,
 899                          irq_hw_number_t hw_irq);
 900 struct irq_chip_generic *
 901 irq_alloc_generic_chip(const char *name, int nr_ct, unsigned int irq_base,
 902                        void __iomem *reg_base, irq_flow_handler_t handler);
 903 void irq_setup_generic_chip(struct irq_chip_generic *gc, u32 msk,
 904                             enum irq_gc_flags flags, unsigned int clr,
 905                             unsigned int set);
 906 int irq_setup_alt_chip(struct irq_data *d, unsigned int type);
 907 void irq_remove_generic_chip(struct irq_chip_generic *gc, u32 msk,
 908                              unsigned int clr, unsigned int set);
 909
 910 struct irq_chip_generic *irq_get_domain_generic_chip(struct irq_domain *d, unsigned int hw_irq);
 911 int irq_alloc_domain_generic_chips(struct irq_domain *d, int irqs_per_chip,
 912                                    int num_ct, const char *name,
 913                                    irq_flow_handler_t handler,
 914                                    unsigned int clr, unsigned int set,
 915                                    enum irq_gc_flags flags);
 916
 917
 918 static inline struct irq_chip_type *irq_data_get_chip_type(struct irq_data *d)
 919 {
 920         return container_of(d->chip, struct irq_chip_type, chip);
 921 }
 922
 923 #define IRQ_MSK(n) (u32)((n) < 32 ? ((1 << (n)) - 1) : UINT_MAX)
 924
 925 #ifdef CONFIG_SMP
 926 static inline void irq_gc_lock(struct irq_chip_generic *gc)
 927 {
 928         raw_spin_lock(&gc->lock);
 929 }
 930
 931 static inline void irq_gc_unlock(struct irq_chip_generic *gc)
 932 {
 933         raw_spin_unlock(&gc->lock);
 934 }
 935 #else
 936 static inline void irq_gc_lock(struct irq_chip_generic *gc) { }
 937 static inline void irq_gc_unlock(struct irq_chip_generic *gc) { }
 938 #endif
 939
 940 static inline void irq_reg_writel(struct irq_chip_generic *gc,
 941                                   u32 val, int reg_offset)
 942 {
 943         if (gc->reg_writel)
 944                 gc->reg_writel(val, gc->reg_base + reg_offset);
 945         else
 946                 writel(val, gc->reg_base + reg_offset);
 947 }
 948
 949 static inline u32 irq_reg_readl(struct irq_chip_generic *gc,
 950                                 int reg_offset)
 951 {
 952         if (gc->reg_readl)
 953                 return gc->reg_readl(gc->reg_base + reg_offset);
 954         else
 955                 return readl(gc->reg_base + reg_offset);
 956 }
 957
 958 /* Contrary to Linux irqs, for hardware irqs the irq number 0 is valid */
 959 #define INVALID_HWIRQ   (~0UL)
 960 irq_hw_number_t ipi_get_hwirq(unsigned int irq, unsigned int cpu);
 961 int __ipi_send_single(struct irq_desc *desc, unsigned int cpu);
 962 int __ipi_send_mask(struct irq_desc *desc, const struct cpumask *dest);
 963 int ipi_send_single(unsigned int virq, unsigned int cpu);
 964 int ipi_send_mask(unsigned int virq, const struct cpumask *dest);
 965
 966 #endif /* _LINUX_IRQ_H */