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