kernel/generic/include/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 genericinterrupt
  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
  41 typedef int32_t inr_t;
  42 typedef int32_t devno_t;
  43
  44 typedef enum {
  45         IRQ_DECLINE,            /**< Decline to service. */
  46         IRQ_ACCEPT              /**< Accept to service. */
  47 } irq_ownership_t;
  48
  49 typedef enum {
  50         IRQ_TRIGGER_LEVEL = 1,
  51         IRQ_TRIGGER_EDGE
  52 } irq_trigger_t;
  53
  54 typedef struct irq irq_t;
  55
  56 typedef void (* irq_handler_t)(irq_t *irq, void *arg, ...);
  57
  58 /** Structure representing one device IRQ.
  59  *
  60  * If one device has multiple interrupts, there will
  61  * be multiple irq_t instantions with the same
  62  * devno.
  63  */
  64 struct irq {
  65         /** Hash table link. */
  66         link_t link;
  67
  68         /** Unique device number. -1 if not yet assigned. */
  69         devno_t devno;
  70
  71         /** Actual IRQ number. -1 if not yet assigned. */
  72         inr_t inr;
  73         /** Task ID of the task to be notified about the IRQ or 0. */
  74         task_id_t notif;
  75         /** Trigger level of the IRQ.*/
  76         irq_trigger_t trigger;
  77         /** Claim ownership of the IRQ. */
  78         irq_ownership_t (* claim)(void);
  79         /** Handler for this IRQ and device. */
  80         irq_handler_t handler;
  81         /** Argument for the handler. */
  82         void *arg;
  83 };
  84
  85 extern void irq_init(count_t inrs, count_t chains);
  86 extern void irq_initialize(irq_t *irq);
  87 extern void irq_register(irq_t *irq);
  88 extern irq_t *irq_dispatch(inr_t inr);
  89
  90 #endif
  91
  92 /** @}
  93  */