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