kernel/generic/include/ddi/irq.h

   1 /*
   2  * Copyright (C) 2006 Jakub Jermar
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  *
   9  * - Redistributions of source code must retain the above copyright
  10  *   notice, this list of conditions and the following disclaimer.
  11  * - Redistributions in binary form must reproduce the above copyright
  12  *   notice, this list of conditions and the following disclaimer in the
  13  *   documentation and/or other materials provided with the distribution.
  14  * - The name of the author may not be used to endorse or promote products
  15  *   derived from this software without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  18  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  19  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  20  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  21  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  22  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  23  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  24  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27  */
  28
  29 /** @addtogroup genericddi
  30  * @{
  31  */
  32 /** @file
  33  */
  34
  35 #ifndef KERN_IRQ_H_
  36 #define KERN_IRQ_H_
  37
  38 #include <arch/types.h>
  39 #include <adt/list.h>
  40 #include <ipc/ipc.h>
  41 #include <ipc/irq.h>
  42 #include <atomic.h>
  43 #include <synch/spinlock.h>
  44
  45 typedef enum {
  46         IRQ_DECLINE,            /**< Decline to service. */
  47         IRQ_ACCEPT              /**< Accept to service. */
  48 } irq_ownership_t;
  49
  50 typedef enum {
  51         IRQ_TRIGGER_LEVEL = 1,
  52         IRQ_TRIGGER_EDGE
  53 } irq_trigger_t;
  54
  55 typedef struct irq irq_t;
  56
  57 typedef void (* irq_handler_t)(irq_t *irq, void *arg, ...);
  58
  59 /** Structure representing one device IRQ.
  60  *
  61  * If one device has multiple interrupts, there will
  62  * be multiple irq_t instantions with the same
  63  * devno.
  64  */
  65 struct irq {
  66         /** Hash table link. */
  67         link_t link;
  68
  69         /** Lock protecting everything in this structure
  70          *  except the link member. When both the IRQ
  71          *  hash table lock and this lock are to be acquired,
  72          *  this lock must not be taken first.
  73          */
  74         SPINLOCK_DECLARE(lock);
  75
  76         /** Unique device number. -1 if not yet assigned. */
  77         devno_t devno;
  78
  79         /** Actual IRQ number. -1 if not yet assigned. */
  80         inr_t inr;
  81         /** Trigger level of the IRQ.*/
  82         irq_trigger_t trigger;
  83         /** Claim ownership of the IRQ. */
  84         irq_ownership_t (* claim)(void);
  85         /** Handler for this IRQ and device. */
  86         irq_handler_t handler;
  87         /** Argument for the handler. */
  88         void *arg;
  89
  90         /** Answerbox of the task that wanted to be notified. */
  91         answerbox_t *notif_answerbox;
  92         /** Pseudo-code to be performed by the top-half
  93          *  before a notification is sent. */
  94         irq_code_t *code;
  95         /** Method of the notification. */
  96         unative_t method;
  97         /** Counter of IRQ notifications. */
  98         atomic_t counter;
  99 };
 100
 101 extern void irq_init(count_t inrs, count_t chains);
 102 extern void irq_initialize(irq_t *irq);
 103 extern void irq_register(irq_t *irq);
 104 extern irq_t *irq_dispatch_and_lock(inr_t inr);
 105 extern irq_t *irq_find_and_lock(inr_t inr, devno_t devno);
 106
 107 #endif
 108
 109 /** @}
 110  */