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
  14 #ifndef CONFIG_S390
  15
  16 #include <linux/linkage.h>
  17 #include <linux/cache.h>
  18 #include <linux/spinlock.h>
  19 #include <linux/cpumask.h>
  20 #include <linux/gfp.h>
  21 #include <linux/irqreturn.h>
  22 #include <linux/irqnr.h>
  23 #include <linux/errno.h>
  24 #include <linux/topology.h>
  25 #include <linux/wait.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 irq_desc;
  33 struct irq_data;
  34 typedef void (*irq_flow_handler_t)(unsigned int irq,
  35                                             struct irq_desc *desc);
  36 typedef void (*irq_preflow_handler_t)(struct irq_data *data);
  37
  38 /*
  39  * IRQ line status.
  40  *
  41  * Bits 0-7 are the same as the IRQF_* bits in linux/interrupt.h
  42  *
  43  * IRQ_TYPE_NONE                - default, unspecified type
  44  * IRQ_TYPE_EDGE_RISING         - rising edge triggered
  45  * IRQ_TYPE_EDGE_FALLING        - falling edge triggered
  46  * IRQ_TYPE_EDGE_BOTH           - rising and falling edge triggered
  47  * IRQ_TYPE_LEVEL_HIGH          - high level triggered
  48  * IRQ_TYPE_LEVEL_LOW           - low level triggered
  49  * IRQ_TYPE_LEVEL_MASK          - Mask to filter out the level bits
  50  * IRQ_TYPE_SENSE_MASK          - Mask for all the above bits
  51  * IRQ_TYPE_PROBE               - Special flag for probing in progress
  52  *
  53  * Bits which can be modified via irq_set/clear/modify_status_flags()
  54  * IRQ_LEVEL                    - Interrupt is level type. Will be also
  55  *                                updated in the code when the above trigger
  56  *                                bits are modified via irq_set_irq_type()
  57  * IRQ_PER_CPU                  - Mark an interrupt PER_CPU. Will protect
  58  *                                it from affinity setting
  59  * IRQ_NOPROBE                  - Interrupt cannot be probed by autoprobing
  60  * IRQ_NOREQUEST                - Interrupt cannot be requested via
  61  *                                request_irq()
  62  * IRQ_NOTHREAD                 - Interrupt cannot be threaded
  63  * IRQ_NOAUTOEN                 - Interrupt is not automatically enabled in
  64  *                                request/setup_irq()
  65  * IRQ_NO_BALANCING             - Interrupt cannot be balanced (affinity set)
  66  * IRQ_MOVE_PCNTXT              - Interrupt can be migrated from process context
  67  * IRQ_NESTED_TRHEAD            - Interrupt nests into another thread
  68  */
  69 enum {
  70         IRQ_TYPE_NONE           = 0x00000000,
  71         IRQ_TYPE_EDGE_RISING    = 0x00000001,
  72         IRQ_TYPE_EDGE_FALLING   = 0x00000002,
  73         IRQ_TYPE_EDGE_BOTH      = (IRQ_TYPE_EDGE_FALLING | IRQ_TYPE_EDGE_RISING),
  74         IRQ_TYPE_LEVEL_HIGH     = 0x00000004,
  75         IRQ_TYPE_LEVEL_LOW      = 0x00000008,
  76         IRQ_TYPE_LEVEL_MASK     = (IRQ_TYPE_LEVEL_LOW | IRQ_TYPE_LEVEL_HIGH),
  77         IRQ_TYPE_SENSE_MASK     = 0x0000000f,
  78
  79         IRQ_TYPE_PROBE          = 0x00000010,
  80
  81         IRQ_LEVEL               = (1 <<  8),
  82         IRQ_PER_CPU             = (1 <<  9),
  83         IRQ_NOPROBE             = (1 << 10),
  84         IRQ_NOREQUEST           = (1 << 11),
  85         IRQ_NOAUTOEN            = (1 << 12),
  86         IRQ_NO_BALANCING        = (1 << 13),
  87         IRQ_MOVE_PCNTXT         = (1 << 14),
  88         IRQ_NESTED_THREAD       = (1 << 15),
  89         IRQ_NOTHREAD            = (1 << 16),
  90 };
  91
  92 #define IRQF_MODIFY_MASK        \
  93         (IRQ_TYPE_SENSE_MASK | IRQ_NOPROBE | IRQ_NOREQUEST | \
  94          IRQ_NOAUTOEN | IRQ_MOVE_PCNTXT | IRQ_LEVEL | IRQ_NO_BALANCING | \
  95          IRQ_PER_CPU | IRQ_NESTED_THREAD)
  96
  97 #define IRQ_NO_BALANCING_MASK   (IRQ_PER_CPU | IRQ_NO_BALANCING)
  98
  99 /*
 100  * Return value for chip->irq_set_affinity()
 101  *
 102  * IRQ_SET_MASK_OK      - OK, core updates irq_data.affinity
 103  * IRQ_SET_MASK_NOCPY   - OK, chip did update irq_data.affinity
 104  */
 105 enum {
 106         IRQ_SET_MASK_OK = 0,
 107         IRQ_SET_MASK_OK_NOCOPY,
 108 };
 109
 110 struct msi_desc;
 111
 112 /**
 113  * struct irq_data - per irq and irq chip data passed down to chip functions
 114  * @irq:                interrupt number
 115  * @node:               node index useful for balancing
 116  * @state_use_accessors: status information for irq chip functions.
 117  *                      Use accessor functions to deal with it
 118  * @chip:               low level interrupt hardware access
 119  * @handler_data:       per-IRQ data for the irq_chip methods
 120  * @chip_data:          platform-specific per-chip private data for the chip
 121  *                      methods, to allow shared chip implementations
 122  * @msi_desc:           MSI descriptor
 123  * @affinity:           IRQ affinity on SMP
 124  *
 125  * The fields here need to overlay the ones in irq_desc until we
 126  * cleaned up the direct references and switched everything over to
 127  * irq_data.
 128  */
 129 struct irq_data {
 130         unsigned int            irq;
 131         unsigned int            node;
 132         unsigned int            state_use_accessors;
 133         struct irq_chip         *chip;
 134         void                    *handler_data;
 135         void                    *chip_data;
 136         struct msi_desc         *msi_desc;
 137 #ifdef CONFIG_SMP
 138         cpumask_var_t           affinity;
 139 #endif
 140 };
 141
 142 /*
 143  * Bit masks for irq_data.state
 144  *
 145  * IRQD_TRIGGER_MASK            - Mask for the trigger type bits
 146  * IRQD_SETAFFINITY_PENDING     - Affinity setting is pending
 147  * IRQD_NO_BALANCING            - Balancing disabled for this IRQ
 148  * IRQD_PER_CPU                 - Interrupt is per cpu
 149  * IRQD_AFFINITY_SET            - Interrupt affinity was set
 150  * IRQD_LEVEL                   - Interrupt is level triggered
 151  * IRQD_WAKEUP_STATE            - Interrupt is configured for wakeup
 152  *                                from suspend
 153  * IRDQ_MOVE_PCNTXT             - Interrupt can be moved in process
 154  *                                context
 155  * IRQD_IRQ_DISABLED            - Disabled state of the interrupt
 156  * IRQD_IRQ_MASKED              - Masked state of the interrupt
 157  * IRQD_IRQ_INPROGRESS          - In progress state of the interrupt
 158  */
 159 enum {
 160         IRQD_TRIGGER_MASK               = 0xf,
 161         IRQD_SETAFFINITY_PENDING        = (1 <<  8),
 162         IRQD_NO_BALANCING               = (1 << 10),
 163         IRQD_PER_CPU                    = (1 << 11),
 164         IRQD_AFFINITY_SET               = (1 << 12),
 165         IRQD_LEVEL                      = (1 << 13),
 166         IRQD_WAKEUP_STATE               = (1 << 14),
 167         IRQD_MOVE_PCNTXT                = (1 << 15),
 168         IRQD_IRQ_DISABLED               = (1 << 16),
 169         IRQD_IRQ_MASKED                 = (1 << 17),
 170         IRQD_IRQ_INPROGRESS             = (1 << 18),
 171 };
 172
 173 static inline bool irqd_is_setaffinity_pending(struct irq_data *d)
 174 {
 175         return d->state_use_accessors & IRQD_SETAFFINITY_PENDING;
 176 }
 177
 178 static inline bool irqd_is_per_cpu(struct irq_data *d)
 179 {
 180         return d->state_use_accessors & IRQD_PER_CPU;
 181 }
 182
 183 static inline bool irqd_can_balance(struct irq_data *d)
 184 {
 185         return !(d->state_use_accessors & (IRQD_PER_CPU | IRQD_NO_BALANCING));
 186 }
 187
 188 static inline bool irqd_affinity_was_set(struct irq_data *d)
 189 {
 190         return d->state_use_accessors & IRQD_AFFINITY_SET;
 191 }
 192
 193 static inline void irqd_mark_affinity_was_set(struct irq_data *d)
 194 {
 195         d->state_use_accessors |= IRQD_AFFINITY_SET;
 196 }
 197
 198 static inline u32 irqd_get_trigger_type(struct irq_data *d)
 199 {
 200         return d->state_use_accessors & IRQD_TRIGGER_MASK;
 201 }
 202
 203 /*
 204  * Must only be called inside irq_chip.irq_set_type() functions.
 205  */
 206 static inline void irqd_set_trigger_type(struct irq_data *d, u32 type)
 207 {
 208         d->state_use_accessors &= ~IRQD_TRIGGER_MASK;
 209         d->state_use_accessors |= type & IRQD_TRIGGER_MASK;
 210 }
 211
 212 static inline bool irqd_is_level_type(struct irq_data *d)
 213 {
 214         return d->state_use_accessors & IRQD_LEVEL;
 215 }
 216
 217 static inline bool irqd_is_wakeup_set(struct irq_data *d)
 218 {
 219         return d->state_use_accessors & IRQD_WAKEUP_STATE;
 220 }
 221
 222 static inline bool irqd_can_move_in_process_context(struct irq_data *d)
 223 {
 224         return d->state_use_accessors & IRQD_MOVE_PCNTXT;
 225 }
 226
 227 static inline bool irqd_irq_disabled(struct irq_data *d)
 228 {
 229         return d->state_use_accessors & IRQD_IRQ_DISABLED;
 230 }
 231
 232 static inline bool irqd_irq_masked(struct irq_data *d)
 233 {
 234         return d->state_use_accessors & IRQD_IRQ_MASKED;
 235 }
 236
 237 static inline bool irqd_irq_inprogress(struct irq_data *d)
 238 {
 239         return d->state_use_accessors & IRQD_IRQ_INPROGRESS;
 240 }
 241
 242 /*
 243  * Functions for chained handlers which can be enabled/disabled by the
 244  * standard disable_irq/enable_irq calls. Must be called with
 245  * irq_desc->lock held.
 246  */
 247 static inline void irqd_set_chained_irq_inprogress(struct irq_data *d)
 248 {
 249         d->state_use_accessors |= IRQD_IRQ_INPROGRESS;
 250 }
 251
 252 static inline void irqd_clr_chained_irq_inprogress(struct irq_data *d)
 253 {
 254         d->state_use_accessors &= ~IRQD_IRQ_INPROGRESS;
 255 }
 256
 257 /**
 258  * struct irq_chip - hardware interrupt chip descriptor
 259  *
 260  * @name:               name for /proc/interrupts
 261  * @irq_startup:        start up the interrupt (defaults to ->enable if NULL)
 262  * @irq_shutdown:       shut down the interrupt (defaults to ->disable if NULL)
 263  * @irq_enable:         enable the interrupt (defaults to chip->unmask if NULL)
 264  * @irq_disable:        disable the interrupt
 265  * @irq_ack:            start of a new interrupt
 266  * @irq_mask:           mask an interrupt source
 267  * @irq_mask_ack:       ack and mask an interrupt source
 268  * @irq_unmask:         unmask an interrupt source
 269  * @irq_eoi:            end of interrupt
 270  * @irq_set_affinity:   set the CPU affinity on SMP machines
 271  * @irq_retrigger:      resend an IRQ to the CPU
 272  * @irq_set_type:       set the flow type (IRQ_TYPE_LEVEL/etc.) of an IRQ
 273  * @irq_set_wake:       enable/disable power-management wake-on of an IRQ
 274  * @irq_bus_lock:       function to lock access to slow bus (i2c) chips
 275  * @irq_bus_sync_unlock:function to sync and unlock slow bus (i2c) chips
 276  * @irq_cpu_online:     configure an interrupt source for a secondary CPU
 277  * @irq_cpu_offline:    un-configure an interrupt source for a secondary CPU
 278  * @irq_suspend:        function called from core code on suspend once per chip
 279  * @irq_resume:         function called from core code on resume once per chip
 280  * @irq_pm_shutdown:    function called from core code on shutdown once per chip
 281  * @irq_print_chip:     optional to print special chip info in show_interrupts
 282  * @flags:              chip specific flags
 283  *
 284  * @release:            release function solely used by UML
 285  */
 286 struct irq_chip {
 287         const char      *name;
 288         unsigned int    (*irq_startup)(struct irq_data *data);
 289         void            (*irq_shutdown)(struct irq_data *data);
 290         void            (*irq_enable)(struct irq_data *data);
 291         void            (*irq_disable)(struct irq_data *data);
 292
 293         void            (*irq_ack)(struct irq_data *data);
 294         void            (*irq_mask)(struct irq_data *data);
 295         void            (*irq_mask_ack)(struct irq_data *data);
 296         void            (*irq_unmask)(struct irq_data *data);
 297         void            (*irq_eoi)(struct irq_data *data);
 298
 299         int             (*irq_set_affinity)(struct irq_data *data, const struct cpumask *dest, bool force);
 300         int             (*irq_retrigger)(struct irq_data *data);
 301         int             (*irq_set_type)(struct irq_data *data, unsigned int flow_type);
 302         int             (*irq_set_wake)(struct irq_data *data, unsigned int on);
 303
 304         void            (*irq_bus_lock)(struct irq_data *data);
 305         void            (*irq_bus_sync_unlock)(struct irq_data *data);
 306
 307         void            (*irq_cpu_online)(struct irq_data *data);
 308         void            (*irq_cpu_offline)(struct irq_data *data);
 309
 310         void            (*irq_suspend)(struct irq_data *data);
 311         void            (*irq_resume)(struct irq_data *data);
 312         void            (*irq_pm_shutdown)(struct irq_data *data);
 313
 314         void            (*irq_print_chip)(struct irq_data *data, struct seq_file *p);
 315
 316         unsigned long   flags;
 317
 318         /* Currently used only by UML, might disappear one day.*/
 319 #ifdef CONFIG_IRQ_RELEASE_METHOD
 320         void            (*release)(unsigned int irq, void *dev_id);
 321 #endif
 322 };
 323
 324 /*
 325  * irq_chip specific flags
 326  *
 327  * IRQCHIP_SET_TYPE_MASKED:     Mask before calling chip.irq_set_type()
 328  * IRQCHIP_EOI_IF_HANDLED:      Only issue irq_eoi() when irq was handled
 329  * IRQCHIP_MASK_ON_SUSPEND:     Mask non wake irqs in the suspend path
 330  * IRQCHIP_ONOFFLINE_ENABLED:   Only call irq_on/off_line callbacks
 331  *                              when irq enabled
 332  */
 333 enum {
 334         IRQCHIP_SET_TYPE_MASKED         = (1 <<  0),
 335         IRQCHIP_EOI_IF_HANDLED          = (1 <<  1),
 336         IRQCHIP_MASK_ON_SUSPEND         = (1 <<  2),
 337         IRQCHIP_ONOFFLINE_ENABLED       = (1 <<  3),
 338 };
 339
 340 /* This include will go away once we isolated irq_desc usage to core code */
 341 #include <linux/irqdesc.h>
 342
 343 /*
 344  * Pick up the arch-dependent methods:
 345  */
 346 #include <asm/hw_irq.h>
 347
 348 #ifndef NR_IRQS_LEGACY
 349 # define NR_IRQS_LEGACY 0
 350 #endif
 351
 352 #ifndef ARCH_IRQ_INIT_FLAGS
 353 # define ARCH_IRQ_INIT_FLAGS    0
 354 #endif
 355
 356 #define IRQ_DEFAULT_INIT_FLAGS  ARCH_IRQ_INIT_FLAGS
 357
 358 struct irqaction;
 359 extern int setup_irq(unsigned int irq, struct irqaction *new);
 360 extern void remove_irq(unsigned int irq, struct irqaction *act);
 361
 362 extern void irq_cpu_online(void);
 363 extern void irq_cpu_offline(void);
 364 extern int __irq_set_affinity_locked(struct irq_data *data,  const struct cpumask *cpumask);
 365
 366 #ifdef CONFIG_GENERIC_HARDIRQS
 367
 368 #if defined(CONFIG_SMP) && defined(CONFIG_GENERIC_PENDING_IRQ)
 369 void irq_move_irq(struct irq_data *data);
 370 void irq_move_masked_irq(struct irq_data *data);
 371 #else
 372 static inline void irq_move_irq(struct irq_data *data) { }
 373 static inline void irq_move_masked_irq(struct irq_data *data) { }
 374 #endif
 375
 376 extern int no_irq_affinity;
 377
 378 /*
 379  * Built-in IRQ handlers for various IRQ types,
 380  * callable via desc->handle_irq()
 381  */
 382 extern void handle_level_irq(unsigned int irq, struct irq_desc *desc);
 383 extern void handle_fasteoi_irq(unsigned int irq, struct irq_desc *desc);
 384 extern void handle_edge_irq(unsigned int irq, struct irq_desc *desc);
 385 extern void handle_edge_eoi_irq(unsigned int irq, struct irq_desc *desc);
 386 extern void handle_simple_irq(unsigned int irq, struct irq_desc *desc);
 387 extern void handle_percpu_irq(unsigned int irq, struct irq_desc *desc);
 388 extern void handle_bad_irq(unsigned int irq, struct irq_desc *desc);
 389 extern void handle_nested_irq(unsigned int irq);
 390
 391 /* Handling of unhandled and spurious interrupts: */
 392 extern void note_interrupt(unsigned int irq, struct irq_desc *desc,
 393                            irqreturn_t action_ret);
 394
 395
 396 /* Enable/disable irq debugging output: */
 397 extern int noirqdebug_setup(char *str);
 398
 399 /* Checks whether the interrupt can be requested by request_irq(): */
 400 extern int can_request_irq(unsigned int irq, unsigned long irqflags);
 401
 402 /* Dummy irq-chip implementations: */
 403 extern struct irq_chip no_irq_chip;
 404 extern struct irq_chip dummy_irq_chip;
 405
 406 extern void
 407 irq_set_chip_and_handler_name(unsigned int irq, struct irq_chip *chip,
 408                               irq_flow_handler_t handle, const char *name);
 409
 410 static inline void irq_set_chip_and_handler(unsigned int irq, struct irq_chip *chip,
 411                                             irq_flow_handler_t handle)
 412 {
 413         irq_set_chip_and_handler_name(irq, chip, handle, NULL);
 414 }
 415
 416 extern void
 417 __irq_set_handler(unsigned int irq, irq_flow_handler_t handle, int is_chained,
 418                   const char *name);
 419
 420 static inline void
 421 irq_set_handler(unsigned int irq, irq_flow_handler_t handle)
 422 {
 423         __irq_set_handler(irq, handle, 0, NULL);
 424 }
 425
 426 /*
 427  * Set a highlevel chained flow handler for a given IRQ.
 428  * (a chained handler is automatically enabled and set to
 429  *  IRQ_NOREQUEST, IRQ_NOPROBE, and IRQ_NOTHREAD)
 430  */
 431 static inline void
 432 irq_set_chained_handler(unsigned int irq, irq_flow_handler_t handle)
 433 {
 434         __irq_set_handler(irq, handle, 1, NULL);
 435 }
 436
 437 void irq_modify_status(unsigned int irq, unsigned long clr, unsigned long set);
 438
 439 static inline void irq_set_status_flags(unsigned int irq, unsigned long set)
 440 {
 441         irq_modify_status(irq, 0, set);
 442 }
 443
 444 static inline void irq_clear_status_flags(unsigned int irq, unsigned long clr)
 445 {
 446         irq_modify_status(irq, clr, 0);
 447 }
 448
 449 static inline void irq_set_noprobe(unsigned int irq)
 450 {
 451         irq_modify_status(irq, 0, IRQ_NOPROBE);
 452 }
 453
 454 static inline void irq_set_probe(unsigned int irq)
 455 {
 456         irq_modify_status(irq, IRQ_NOPROBE, 0);
 457 }
 458
 459 static inline void irq_set_nothread(unsigned int irq)
 460 {
 461         irq_modify_status(irq, 0, IRQ_NOTHREAD);
 462 }
 463
 464 static inline void irq_set_thread(unsigned int irq)
 465 {
 466         irq_modify_status(irq, IRQ_NOTHREAD, 0);
 467 }
 468
 469 static inline void irq_set_nested_thread(unsigned int irq, bool nest)
 470 {
 471         if (nest)
 472                 irq_set_status_flags(irq, IRQ_NESTED_THREAD);
 473         else
 474                 irq_clear_status_flags(irq, IRQ_NESTED_THREAD);
 475 }
 476
 477 /* Handle dynamic irq creation and destruction */
 478 extern unsigned int create_irq_nr(unsigned int irq_want, int node);
 479 extern int create_irq(void);
 480 extern void destroy_irq(unsigned int irq);
 481
 482 /*
 483  * Dynamic irq helper functions. Obsolete. Use irq_alloc_desc* and
 484  * irq_free_desc instead.
 485  */
 486 extern void dynamic_irq_cleanup(unsigned int irq);
 487 static inline void dynamic_irq_init(unsigned int irq)
 488 {
 489         dynamic_irq_cleanup(irq);
 490 }
 491
 492 /* Set/get chip/data for an IRQ: */
 493 extern int irq_set_chip(unsigned int irq, struct irq_chip *chip);
 494 extern int irq_set_handler_data(unsigned int irq, void *data);
 495 extern int irq_set_chip_data(unsigned int irq, void *data);
 496 extern int irq_set_irq_type(unsigned int irq, unsigned int type);
 497 extern int irq_set_msi_desc(unsigned int irq, struct msi_desc *entry);
 498 extern struct irq_data *irq_get_irq_data(unsigned int irq);
 499
 500 static inline struct irq_chip *irq_get_chip(unsigned int irq)
 501 {
 502         struct irq_data *d = irq_get_irq_data(irq);
 503         return d ? d->chip : NULL;
 504 }
 505
 506 static inline struct irq_chip *irq_data_get_irq_chip(struct irq_data *d)
 507 {
 508         return d->chip;
 509 }
 510
 511 static inline void *irq_get_chip_data(unsigned int irq)
 512 {
 513         struct irq_data *d = irq_get_irq_data(irq);
 514         return d ? d->chip_data : NULL;
 515 }
 516
 517 static inline void *irq_data_get_irq_chip_data(struct irq_data *d)
 518 {
 519         return d->chip_data;
 520 }
 521
 522 static inline void *irq_get_handler_data(unsigned int irq)
 523 {
 524         struct irq_data *d = irq_get_irq_data(irq);
 525         return d ? d->handler_data : NULL;
 526 }
 527
 528 static inline void *irq_data_get_irq_handler_data(struct irq_data *d)
 529 {
 530         return d->handler_data;
 531 }
 532
 533 static inline struct msi_desc *irq_get_msi_desc(unsigned int irq)
 534 {
 535         struct irq_data *d = irq_get_irq_data(irq);
 536         return d ? d->msi_desc : NULL;
 537 }
 538
 539 static inline struct msi_desc *irq_data_get_msi(struct irq_data *d)
 540 {
 541         return d->msi_desc;
 542 }
 543
 544 int irq_alloc_descs(int irq, unsigned int from, unsigned int cnt, int node);
 545 void irq_free_descs(unsigned int irq, unsigned int cnt);
 546 int irq_reserve_irqs(unsigned int from, unsigned int cnt);
 547
 548 static inline int irq_alloc_desc(int node)
 549 {
 550         return irq_alloc_descs(-1, 0, 1, node);
 551 }
 552
 553 static inline int irq_alloc_desc_at(unsigned int at, int node)
 554 {
 555         return irq_alloc_descs(at, at, 1, node);
 556 }
 557
 558 static inline int irq_alloc_desc_from(unsigned int from, int node)
 559 {
 560         return irq_alloc_descs(-1, from, 1, node);
 561 }
 562
 563 static inline void irq_free_desc(unsigned int irq)
 564 {
 565         irq_free_descs(irq, 1);
 566 }
 567
 568 static inline int irq_reserve_irq(unsigned int irq)
 569 {
 570         return irq_reserve_irqs(irq, 1);
 571 }
 572
 573 #ifndef irq_reg_writel
 574 # define irq_reg_writel(val, addr)      writel(val, addr)
 575 #endif
 576 #ifndef irq_reg_readl
 577 # define irq_reg_readl(addr)            readl(addr)
 578 #endif
 579
 580 /**
 581  * struct irq_chip_regs - register offsets for struct irq_gci
 582  * @enable:     Enable register offset to reg_base
 583  * @disable:    Disable register offset to reg_base
 584  * @mask:       Mask register offset to reg_base
 585  * @ack:        Ack register offset to reg_base
 586  * @eoi:        Eoi register offset to reg_base
 587  * @type:       Type configuration register offset to reg_base
 588  * @polarity:   Polarity configuration register offset to reg_base
 589  */
 590 struct irq_chip_regs {
 591         unsigned long           enable;
 592         unsigned long           disable;
 593         unsigned long           mask;
 594         unsigned long           ack;
 595         unsigned long           eoi;
 596         unsigned long           type;
 597         unsigned long           polarity;
 598 };
 599
 600 /**
 601  * struct irq_chip_type - Generic interrupt chip instance for a flow type
 602  * @chip:               The real interrupt chip which provides the callbacks
 603  * @regs:               Register offsets for this chip
 604  * @handler:            Flow handler associated with this chip
 605  * @type:               Chip can handle these flow types
 606  *
 607  * A irq_generic_chip can have several instances of irq_chip_type when
 608  * it requires different functions and register offsets for different
 609  * flow types.
 610  */
 611 struct irq_chip_type {
 612         struct irq_chip         chip;
 613         struct irq_chip_regs    regs;
 614         irq_flow_handler_t      handler;
 615         u32                     type;
 616 };
 617
 618 /**
 619  * struct irq_chip_generic - Generic irq chip data structure
 620  * @lock:               Lock to protect register and cache data access
 621  * @reg_base:           Register base address (virtual)
 622  * @irq_base:           Interrupt base nr for this chip
 623  * @irq_cnt:            Number of interrupts handled by this chip
 624  * @mask_cache:         Cached mask register
 625  * @type_cache:         Cached type register
 626  * @polarity_cache:     Cached polarity register
 627  * @wake_enabled:       Interrupt can wakeup from suspend
 628  * @wake_active:        Interrupt is marked as an wakeup from suspend source
 629  * @num_ct:             Number of available irq_chip_type instances (usually 1)
 630  * @private:            Private data for non generic chip callbacks
 631  * @list:               List head for keeping track of instances
 632  * @chip_types:         Array of interrupt irq_chip_types
 633  *
 634  * Note, that irq_chip_generic can have multiple irq_chip_type
 635  * implementations which can be associated to a particular irq line of
 636  * an irq_chip_generic instance. That allows to share and protect
 637  * state in an irq_chip_generic instance when we need to implement
 638  * different flow mechanisms (level/edge) for it.
 639  */
 640 struct irq_chip_generic {
 641         raw_spinlock_t          lock;
 642         void __iomem            *reg_base;
 643         unsigned int            irq_base;
 644         unsigned int            irq_cnt;
 645         u32                     mask_cache;
 646         u32                     type_cache;
 647         u32                     polarity_cache;
 648         u32                     wake_enabled;
 649         u32                     wake_active;
 650         unsigned int            num_ct;
 651         void                    *private;
 652         struct list_head        list;
 653         struct irq_chip_type    chip_types[0];
 654 };
 655
 656 /**
 657  * enum irq_gc_flags - Initialization flags for generic irq chips
 658  * @IRQ_GC_INIT_MASK_CACHE:     Initialize the mask_cache by reading mask reg
 659  * @IRQ_GC_INIT_NESTED_LOCK:    Set the lock class of the irqs to nested for
 660  *                              irq chips which need to call irq_set_wake() on
 661  *                              the parent irq. Usually GPIO implementations
 662  */
 663 enum irq_gc_flags {
 664         IRQ_GC_INIT_MASK_CACHE          = 1 << 0,
 665         IRQ_GC_INIT_NESTED_LOCK         = 1 << 1,
 666 };
 667
 668 /* Generic chip callback functions */
 669 void irq_gc_noop(struct irq_data *d);
 670 void irq_gc_mask_disable_reg(struct irq_data *d);
 671 void irq_gc_mask_set_bit(struct irq_data *d);
 672 void irq_gc_mask_clr_bit(struct irq_data *d);
 673 void irq_gc_unmask_enable_reg(struct irq_data *d);
 674 void irq_gc_ack_set_bit(struct irq_data *d);
 675 void irq_gc_ack_clr_bit(struct irq_data *d);
 676 void irq_gc_mask_disable_reg_and_ack(struct irq_data *d);
 677 void irq_gc_eoi(struct irq_data *d);
 678 int irq_gc_set_wake(struct irq_data *d, unsigned int on);
 679
 680 /* Setup functions for irq_chip_generic */
 681 struct irq_chip_generic *
 682 irq_alloc_generic_chip(const char *name, int nr_ct, unsigned int irq_base,
 683                        void __iomem *reg_base, irq_flow_handler_t handler);
 684 void irq_setup_generic_chip(struct irq_chip_generic *gc, u32 msk,
 685                             enum irq_gc_flags flags, unsigned int clr,
 686                             unsigned int set);
 687 int irq_setup_alt_chip(struct irq_data *d, unsigned int type);
 688 void irq_remove_generic_chip(struct irq_chip_generic *gc, u32 msk,
 689                              unsigned int clr, unsigned int set);
 690
 691 static inline struct irq_chip_type *irq_data_get_chip_type(struct irq_data *d)
 692 {
 693         return container_of(d->chip, struct irq_chip_type, chip);
 694 }
 695
 696 #define IRQ_MSK(n) (u32)((n) < 32 ? ((1 << (n)) - 1) : UINT_MAX)
 697
 698 #ifdef CONFIG_SMP
 699 static inline void irq_gc_lock(struct irq_chip_generic *gc)
 700 {
 701         raw_spin_lock(&gc->lock);
 702 }
 703
 704 static inline void irq_gc_unlock(struct irq_chip_generic *gc)
 705 {
 706         raw_spin_unlock(&gc->lock);
 707 }
 708 #else
 709 static inline void irq_gc_lock(struct irq_chip_generic *gc) { }
 710 static inline void irq_gc_unlock(struct irq_chip_generic *gc) { }
 711 #endif
 712
 713 #endif /* CONFIG_GENERIC_HARDIRQS */
 714
 715 #endif /* !CONFIG_S390 */
 716
 717 #endif /* _LINUX_IRQ_H */