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