kernel/irq/chip.c

   1 /*
   2  * linux/kernel/irq/chip.c
   3  *
   4  * Copyright (C) 1992, 1998-2006 Linus Torvalds, Ingo Molnar
   5  * Copyright (C) 2005-2006, Thomas Gleixner, Russell King
   6  *
   7  * This file contains the core interrupt handling code, for irq-chip
   8  * based architectures.
   9  *
  10  * Detailed information is available in Documentation/DocBook/genericirq
  11  */
  12
  13 #include <linux/irq.h>
  14 #include <linux/msi.h>
  15 #include <linux/module.h>
  16 #include <linux/interrupt.h>
  17 #include <linux/kernel_stat.h>
  18
  19 #include "internals.h"
  20
  21 /**
  22  *      dynamic_irq_init - initialize a dynamically allocated irq
  23  *      @irq:   irq number to initialize
  24  */
  25 void dynamic_irq_init(unsigned int irq)
  26 {
  27         struct irq_desc *desc;
  28         unsigned long flags;
  29
  30         desc = irq_to_desc(irq);
  31         if (!desc) {
  32                 WARN(1, KERN_ERR "Trying to initialize invalid IRQ%d\n", irq);
  33                 return;
  34         }
  35
  36         /* Ensure we don't have left over values from a previous use of this irq */
  37         spin_lock_irqsave(&desc->lock, flags);
  38         desc->status = IRQ_DISABLED;
  39         desc->chip = &no_irq_chip;
  40         desc->handle_irq = handle_bad_irq;
  41         desc->depth = 1;
  42         desc->msi_desc = NULL;
  43         desc->handler_data = NULL;
  44         desc->chip_data = NULL;
  45         desc->action = NULL;
  46         desc->irq_count = 0;
  47         desc->irqs_unhandled = 0;
  48 #ifdef CONFIG_SMP
  49         cpumask_setall(desc->affinity);
  50 #ifdef CONFIG_GENERIC_PENDING_IRQ
  51         cpumask_clear(desc->pending_mask);
  52 #endif
  53 #endif
  54         spin_unlock_irqrestore(&desc->lock, flags);
  55 }
  56
  57 /**
  58  *      dynamic_irq_cleanup - cleanup a dynamically allocated irq
  59  *      @irq:   irq number to initialize
  60  */
  61 void dynamic_irq_cleanup(unsigned int irq)
  62 {
  63         struct irq_desc *desc = irq_to_desc(irq);
  64         unsigned long flags;
  65
  66         if (!desc) {
  67                 WARN(1, KERN_ERR "Trying to cleanup invalid IRQ%d\n", irq);
  68                 return;
  69         }
  70
  71         spin_lock_irqsave(&desc->lock, flags);
  72         if (desc->action) {
  73                 spin_unlock_irqrestore(&desc->lock, flags);
  74                 WARN(1, KERN_ERR "Destroying IRQ%d without calling free_irq\n",
  75                         irq);
  76                 return;
  77         }
  78         desc->msi_desc = NULL;
  79         desc->handler_data = NULL;
  80         desc->chip_data = NULL;
  81         desc->handle_irq = handle_bad_irq;
  82         desc->chip = &no_irq_chip;
  83         desc->name = NULL;
  84         spin_unlock_irqrestore(&desc->lock, flags);
  85 }
  86
  87
  88 /**
  89  *      set_irq_chip - set the irq chip for an irq
  90  *      @irq:   irq number
  91  *      @chip:  pointer to irq chip description structure
  92  */
  93 int set_irq_chip(unsigned int irq, struct irq_chip *chip)
  94 {
  95         struct irq_desc *desc = irq_to_desc(irq);
  96         unsigned long flags;
  97
  98         if (!desc) {
  99                 WARN(1, KERN_ERR "Trying to install chip for IRQ%d\n", irq);
 100                 return -EINVAL;
 101         }
 102
 103         if (!chip)
 104                 chip = &no_irq_chip;
 105
 106         spin_lock_irqsave(&desc->lock, flags);
 107         irq_chip_set_defaults(chip);
 108         desc->chip = chip;
 109         spin_unlock_irqrestore(&desc->lock, flags);
 110
 111         return 0;
 112 }
 113 EXPORT_SYMBOL(set_irq_chip);
 114
 115 /**
 116  *      set_irq_type - set the irq trigger type for an irq
 117  *      @irq:   irq number
 118  *      @type:  IRQ_TYPE_{LEVEL,EDGE}_* value - see include/linux/irq.h
 119  */
 120 int set_irq_type(unsigned int irq, unsigned int type)
 121 {
 122         struct irq_desc *desc = irq_to_desc(irq);
 123         unsigned long flags;
 124         int ret = -ENXIO;
 125
 126         if (!desc) {
 127                 printk(KERN_ERR "Trying to set irq type for IRQ%d\n", irq);
 128                 return -ENODEV;
 129         }
 130
 131         type &= IRQ_TYPE_SENSE_MASK;
 132         if (type == IRQ_TYPE_NONE)
 133                 return 0;
 134
 135         spin_lock_irqsave(&desc->lock, flags);
 136         ret = __irq_set_trigger(desc, irq, type);
 137         spin_unlock_irqrestore(&desc->lock, flags);
 138         return ret;
 139 }
 140 EXPORT_SYMBOL(set_irq_type);
 141
 142 /**
 143  *      set_irq_data - set irq type data for an irq
 144  *      @irq:   Interrupt number
 145  *      @data:  Pointer to interrupt specific data
 146  *
 147  *      Set the hardware irq controller data for an irq
 148  */
 149 int set_irq_data(unsigned int irq, void *data)
 150 {
 151         struct irq_desc *desc = irq_to_desc(irq);
 152         unsigned long flags;
 153
 154         if (!desc) {
 155                 printk(KERN_ERR
 156                        "Trying to install controller data for IRQ%d\n", irq);
 157                 return -EINVAL;
 158         }
 159
 160         spin_lock_irqsave(&desc->lock, flags);
 161         desc->handler_data = data;
 162         spin_unlock_irqrestore(&desc->lock, flags);
 163         return 0;
 164 }
 165 EXPORT_SYMBOL(set_irq_data);
 166
 167 /**
 168  *      set_irq_data - set irq type data for an irq
 169  *      @irq:   Interrupt number
 170  *      @entry: Pointer to MSI descriptor data
 171  *
 172  *      Set the hardware irq controller data for an irq
 173  */
 174 int set_irq_msi(unsigned int irq, struct msi_desc *entry)
 175 {
 176         struct irq_desc *desc = irq_to_desc(irq);
 177         unsigned long flags;
 178
 179         if (!desc) {
 180                 printk(KERN_ERR
 181                        "Trying to install msi data for IRQ%d\n", irq);
 182                 return -EINVAL;
 183         }
 184
 185         spin_lock_irqsave(&desc->lock, flags);
 186         desc->msi_desc = entry;
 187         if (entry)
 188                 entry->irq = irq;
 189         spin_unlock_irqrestore(&desc->lock, flags);
 190         return 0;
 191 }
 192
 193 /**
 194  *      set_irq_chip_data - set irq chip data for an irq
 195  *      @irq:   Interrupt number
 196  *      @data:  Pointer to chip specific data
 197  *
 198  *      Set the hardware irq chip data for an irq
 199  */
 200 int set_irq_chip_data(unsigned int irq, void *data)
 201 {
 202         struct irq_desc *desc = irq_to_desc(irq);
 203         unsigned long flags;
 204
 205         if (!desc) {
 206                 printk(KERN_ERR
 207                        "Trying to install chip data for IRQ%d\n", irq);
 208                 return -EINVAL;
 209         }
 210
 211         if (!desc->chip) {
 212                 printk(KERN_ERR "BUG: bad set_irq_chip_data(IRQ#%d)\n", irq);
 213                 return -EINVAL;
 214         }
 215
 216         spin_lock_irqsave(&desc->lock, flags);
 217         desc->chip_data = data;
 218         spin_unlock_irqrestore(&desc->lock, flags);
 219
 220         return 0;
 221 }
 222 EXPORT_SYMBOL(set_irq_chip_data);
 223
 224 /*
 225  * default enable function
 226  */
 227 static void default_enable(unsigned int irq)
 228 {
 229         struct irq_desc *desc = irq_to_desc(irq);
 230
 231         desc->chip->unmask(irq);
 232         desc->status &= ~IRQ_MASKED;
 233 }
 234
 235 /*
 236  * default disable function
 237  */
 238 static void default_disable(unsigned int irq)
 239 {
 240 }
 241
 242 /*
 243  * default startup function
 244  */
 245 static unsigned int default_startup(unsigned int irq)
 246 {
 247         struct irq_desc *desc = irq_to_desc(irq);
 248
 249         desc->chip->enable(irq);
 250         return 0;
 251 }
 252
 253 /*
 254  * default shutdown function
 255  */
 256 static void default_shutdown(unsigned int irq)
 257 {
 258         struct irq_desc *desc = irq_to_desc(irq);
 259
 260         desc->chip->mask(irq);
 261         desc->status |= IRQ_MASKED;
 262 }
 263
 264 /*
 265  * Fixup enable/disable function pointers
 266  */
 267 void irq_chip_set_defaults(struct irq_chip *chip)
 268 {
 269         if (!chip->enable)
 270                 chip->enable = default_enable;
 271         if (!chip->disable)
 272                 chip->disable = default_disable;
 273         if (!chip->startup)
 274                 chip->startup = default_startup;
 275         /*
 276          * We use chip->disable, when the user provided its own. When
 277          * we have default_disable set for chip->disable, then we need
 278          * to use default_shutdown, otherwise the irq line is not
 279          * disabled on free_irq():
 280          */
 281         if (!chip->shutdown)
 282                 chip->shutdown = chip->disable != default_disable ?
 283                         chip->disable : default_shutdown;
 284         if (!chip->name)
 285                 chip->name = chip->typename;
 286         if (!chip->end)
 287                 chip->end = dummy_irq_chip.end;
 288 }
 289
 290 static inline void mask_ack_irq(struct irq_desc *desc, int irq)
 291 {
 292         if (desc->chip->mask_ack)
 293                 desc->chip->mask_ack(irq);
 294         else {
 295                 desc->chip->mask(irq);
 296                 desc->chip->ack(irq);
 297         }
 298 }
 299
 300 /**
 301  *      handle_simple_irq - Simple and software-decoded IRQs.
 302  *      @irq:   the interrupt number
 303  *      @desc:  the interrupt description structure for this irq
 304  *
 305  *      Simple interrupts are either sent from a demultiplexing interrupt
 306  *      handler or come from hardware, where no interrupt hardware control
 307  *      is necessary.
 308  *
 309  *      Note: The caller is expected to handle the ack, clear, mask and
 310  *      unmask issues if necessary.
 311  */
 312 void
 313 handle_simple_irq(unsigned int irq, struct irq_desc *desc)
 314 {
 315         struct irqaction *action;
 316         irqreturn_t action_ret;
 317
 318         spin_lock(&desc->lock);
 319
 320         if (unlikely(desc->status & IRQ_INPROGRESS))
 321                 goto out_unlock;
 322         desc->status &= ~(IRQ_REPLAY | IRQ_WAITING);
 323         kstat_incr_irqs_this_cpu(irq, desc);
 324
 325         action = desc->action;
 326         if (unlikely(!action || (desc->status & IRQ_DISABLED)))
 327                 goto out_unlock;
 328
 329         desc->status |= IRQ_INPROGRESS;
 330         spin_unlock(&desc->lock);
 331
 332         action_ret = handle_IRQ_event(irq, action);
 333         if (!noirqdebug)
 334                 note_interrupt(irq, desc, action_ret);
 335
 336         spin_lock(&desc->lock);
 337         desc->status &= ~IRQ_INPROGRESS;
 338 out_unlock:
 339         spin_unlock(&desc->lock);
 340 }
 341
 342 /**
 343  *      handle_level_irq - Level type irq handler
 344  *      @irq:   the interrupt number
 345  *      @desc:  the interrupt description structure for this irq
 346  *
 347  *      Level type interrupts are active as long as the hardware line has
 348  *      the active level. This may require to mask the interrupt and unmask
 349  *      it after the associated handler has acknowledged the device, so the
 350  *      interrupt line is back to inactive.
 351  */
 352 void
 353 handle_level_irq(unsigned int irq, struct irq_desc *desc)
 354 {
 355         struct irqaction *action;
 356         irqreturn_t action_ret;
 357
 358         spin_lock(&desc->lock);
 359         mask_ack_irq(desc, irq);
 360         desc = irq_remap_to_desc(irq, desc);
 361
 362         if (unlikely(desc->status & IRQ_INPROGRESS))
 363                 goto out_unlock;
 364         desc->status &= ~(IRQ_REPLAY | IRQ_WAITING);
 365         kstat_incr_irqs_this_cpu(irq, desc);
 366
 367         /*
 368          * If its disabled or no action available
 369          * keep it masked and get out of here
 370          */
 371         action = desc->action;
 372         if (unlikely(!action || (desc->status & IRQ_DISABLED)))
 373                 goto out_unlock;
 374
 375         desc->status |= IRQ_INPROGRESS;
 376         spin_unlock(&desc->lock);
 377
 378         action_ret = handle_IRQ_event(irq, action);
 379         if (!noirqdebug)
 380                 note_interrupt(irq, desc, action_ret);
 381
 382         spin_lock(&desc->lock);
 383         desc->status &= ~IRQ_INPROGRESS;
 384         if (!(desc->status & IRQ_DISABLED) && desc->chip->unmask)
 385                 desc->chip->unmask(irq);
 386 out_unlock:
 387         spin_unlock(&desc->lock);
 388 }
 389 EXPORT_SYMBOL_GPL(handle_level_irq);
 390
 391 /**
 392  *      handle_fasteoi_irq - irq handler for transparent controllers
 393  *      @irq:   the interrupt number
 394  *      @desc:  the interrupt description structure for this irq
 395  *
 396  *      Only a single callback will be issued to the chip: an ->eoi()
 397  *      call when the interrupt has been serviced. This enables support
 398  *      for modern forms of interrupt handlers, which handle the flow
 399  *      details in hardware, transparently.
 400  */
 401 void
 402 handle_fasteoi_irq(unsigned int irq, struct irq_desc *desc)
 403 {
 404         struct irqaction *action;
 405         irqreturn_t action_ret;
 406
 407         spin_lock(&desc->lock);
 408
 409         if (unlikely(desc->status & IRQ_INPROGRESS))
 410                 goto out;
 411
 412         desc->status &= ~(IRQ_REPLAY | IRQ_WAITING);
 413         kstat_incr_irqs_this_cpu(irq, desc);
 414
 415         /*
 416          * If its disabled or no action available
 417          * then mask it and get out of here:
 418          */
 419         action = desc->action;
 420         if (unlikely(!action || (desc->status & IRQ_DISABLED))) {
 421                 desc->status |= IRQ_PENDING;
 422                 if (desc->chip->mask)
 423                         desc->chip->mask(irq);
 424                 goto out;
 425         }
 426
 427         desc->status |= IRQ_INPROGRESS;
 428         desc->status &= ~IRQ_PENDING;
 429         spin_unlock(&desc->lock);
 430
 431         action_ret = handle_IRQ_event(irq, action);
 432         if (!noirqdebug)
 433                 note_interrupt(irq, desc, action_ret);
 434
 435         spin_lock(&desc->lock);
 436         desc->status &= ~IRQ_INPROGRESS;
 437 out:
 438         desc->chip->eoi(irq);
 439         desc = irq_remap_to_desc(irq, desc);
 440
 441         spin_unlock(&desc->lock);
 442 }
 443
 444 /**
 445  *      handle_edge_irq - edge type IRQ handler
 446  *      @irq:   the interrupt number
 447  *      @desc:  the interrupt description structure for this irq
 448  *
 449  *      Interrupt occures on the falling and/or rising edge of a hardware
 450  *      signal. The occurence is latched into the irq controller hardware
 451  *      and must be acked in order to be reenabled. After the ack another
 452  *      interrupt can happen on the same source even before the first one
 453  *      is handled by the assosiacted event handler. If this happens it
 454  *      might be necessary to disable (mask) the interrupt depending on the
 455  *      controller hardware. This requires to reenable the interrupt inside
 456  *      of the loop which handles the interrupts which have arrived while
 457  *      the handler was running. If all pending interrupts are handled, the
 458  *      loop is left.
 459  */
 460 void
 461 handle_edge_irq(unsigned int irq, struct irq_desc *desc)
 462 {
 463         spin_lock(&desc->lock);
 464
 465         desc->status &= ~(IRQ_REPLAY | IRQ_WAITING);
 466
 467         /*
 468          * If we're currently running this IRQ, or its disabled,
 469          * we shouldn't process the IRQ. Mark it pending, handle
 470          * the necessary masking and go out
 471          */
 472         if (unlikely((desc->status & (IRQ_INPROGRESS | IRQ_DISABLED)) ||
 473                     !desc->action)) {
 474                 desc->status |= (IRQ_PENDING | IRQ_MASKED);
 475                 mask_ack_irq(desc, irq);
 476                 desc = irq_remap_to_desc(irq, desc);
 477                 goto out_unlock;
 478         }
 479         kstat_incr_irqs_this_cpu(irq, desc);
 480
 481         /* Start handling the irq */
 482         desc->chip->ack(irq);
 483         desc = irq_remap_to_desc(irq, desc);
 484
 485         /* Mark the IRQ currently in progress.*/
 486         desc->status |= IRQ_INPROGRESS;
 487
 488         do {
 489                 struct irqaction *action = desc->action;
 490                 irqreturn_t action_ret;
 491
 492                 if (unlikely(!action)) {
 493                         desc->chip->mask(irq);
 494                         goto out_unlock;
 495                 }
 496
 497                 /*
 498                  * When another irq arrived while we were handling
 499                  * one, we could have masked the irq.
 500                  * Renable it, if it was not disabled in meantime.
 501                  */
 502                 if (unlikely((desc->status &
 503                                (IRQ_PENDING | IRQ_MASKED | IRQ_DISABLED)) ==
 504                               (IRQ_PENDING | IRQ_MASKED))) {
 505                         desc->chip->unmask(irq);
 506                         desc->status &= ~IRQ_MASKED;
 507                 }
 508
 509                 desc->status &= ~IRQ_PENDING;
 510                 spin_unlock(&desc->lock);
 511                 action_ret = handle_IRQ_event(irq, action);
 512                 if (!noirqdebug)
 513                         note_interrupt(irq, desc, action_ret);
 514                 spin_lock(&desc->lock);
 515
 516         } while ((desc->status & (IRQ_PENDING | IRQ_DISABLED)) == IRQ_PENDING);
 517
 518         desc->status &= ~IRQ_INPROGRESS;
 519 out_unlock:
 520         spin_unlock(&desc->lock);
 521 }
 522
 523 /**
 524  *      handle_percpu_IRQ - Per CPU local irq handler
 525  *      @irq:   the interrupt number
 526  *      @desc:  the interrupt description structure for this irq
 527  *
 528  *      Per CPU interrupts on SMP machines without locking requirements
 529  */
 530 void
 531 handle_percpu_irq(unsigned int irq, struct irq_desc *desc)
 532 {
 533         irqreturn_t action_ret;
 534
 535         kstat_incr_irqs_this_cpu(irq, desc);
 536
 537         if (desc->chip->ack)
 538                 desc->chip->ack(irq);
 539
 540         action_ret = handle_IRQ_event(irq, desc->action);
 541         if (!noirqdebug)
 542                 note_interrupt(irq, desc, action_ret);
 543
 544         if (desc->chip->eoi) {
 545                 desc->chip->eoi(irq);
 546                 desc = irq_remap_to_desc(irq, desc);
 547         }
 548 }
 549
 550 void
 551 __set_irq_handler(unsigned int irq, irq_flow_handler_t handle, int is_chained,
 552                   const char *name)
 553 {
 554         struct irq_desc *desc = irq_to_desc(irq);
 555         unsigned long flags;
 556
 557         if (!desc) {
 558                 printk(KERN_ERR
 559                        "Trying to install type control for IRQ%d\n", irq);
 560                 return;
 561         }
 562
 563         if (!handle)
 564                 handle = handle_bad_irq;
 565         else if (desc->chip == &no_irq_chip) {
 566                 printk(KERN_WARNING "Trying to install %sinterrupt handler "
 567                        "for IRQ%d\n", is_chained ? "chained " : "", irq);
 568                 /*
 569                  * Some ARM implementations install a handler for really dumb
 570                  * interrupt hardware without setting an irq_chip. This worked
 571                  * with the ARM no_irq_chip but the check in setup_irq would
 572                  * prevent us to setup the interrupt at all. Switch it to
 573                  * dummy_irq_chip for easy transition.
 574                  */
 575                 desc->chip = &dummy_irq_chip;
 576         }
 577
 578         spin_lock_irqsave(&desc->lock, flags);
 579
 580         /* Uninstall? */
 581         if (handle == handle_bad_irq) {
 582                 if (desc->chip != &no_irq_chip) {
 583                         mask_ack_irq(desc, irq);
 584                         desc = irq_remap_to_desc(irq, desc);
 585                 }
 586                 desc->status |= IRQ_DISABLED;
 587                 desc->depth = 1;
 588         }
 589         desc->handle_irq = handle;
 590         desc->name = name;
 591
 592         if (handle != handle_bad_irq && is_chained) {
 593                 desc->status &= ~IRQ_DISABLED;
 594                 desc->status |= IRQ_NOREQUEST | IRQ_NOPROBE;
 595                 desc->depth = 0;
 596                 desc->chip->startup(irq);
 597         }
 598         spin_unlock_irqrestore(&desc->lock, flags);
 599 }
 600 EXPORT_SYMBOL_GPL(__set_irq_handler);
 601
 602 void
 603 set_irq_chip_and_handler(unsigned int irq, struct irq_chip *chip,
 604                          irq_flow_handler_t handle)
 605 {
 606         set_irq_chip(irq, chip);
 607         __set_irq_handler(irq, handle, 0, NULL);
 608 }
 609
 610 void
 611 set_irq_chip_and_handler_name(unsigned int irq, struct irq_chip *chip,
 612                               irq_flow_handler_t handle, const char *name)
 613 {
 614         set_irq_chip(irq, chip);
 615         __set_irq_handler(irq, handle, 0, name);
 616 }
 617
 618 void __init set_irq_noprobe(unsigned int irq)
 619 {
 620         struct irq_desc *desc = irq_to_desc(irq);
 621         unsigned long flags;
 622
 623         if (!desc) {
 624                 printk(KERN_ERR "Trying to mark IRQ%d non-probeable\n", irq);
 625                 return;
 626         }
 627
 628         spin_lock_irqsave(&desc->lock, flags);
 629         desc->status |= IRQ_NOPROBE;
 630         spin_unlock_irqrestore(&desc->lock, flags);
 631 }
 632
 633 void __init set_irq_probe(unsigned int irq)
 634 {
 635         struct irq_desc *desc = irq_to_desc(irq);
 636         unsigned long flags;
 637
 638         if (!desc) {
 639                 printk(KERN_ERR "Trying to mark IRQ%d probeable\n", irq);
 640                 return;
 641         }
 642
 643         spin_lock_irqsave(&desc->lock, flags);
 644         desc->status &= ~IRQ_NOPROBE;
 645         spin_unlock_irqrestore(&desc->lock, flags);
 646 }