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