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