Subversion Repositories HelenOS

Rev

Rev 2307 | Blame | Compare with Previous | Last modification | View Log | Download | RSS feed

  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. typedef enum {
  39.     CMD_MEM_READ_1 = 0,
  40.     CMD_MEM_READ_2,
  41.     CMD_MEM_READ_4,
  42.     CMD_MEM_READ_8,
  43.     CMD_MEM_WRITE_1,
  44.     CMD_MEM_WRITE_2,
  45.     CMD_MEM_WRITE_4,
  46.     CMD_MEM_WRITE_8,
  47.     CMD_PORT_READ_1,
  48.     CMD_PORT_WRITE_1,
  49.     CMD_IA64_GETCHAR,
  50.     CMD_PPC32_GETCHAR,
  51.     CMD_LAST
  52. } irq_cmd_type;
  53.  
  54. typedef struct {
  55.     irq_cmd_type cmd;
  56.     void *addr;
  57.     unsigned long long value;
  58.     int dstarg;
  59. } irq_cmd_t;
  60.  
  61. typedef struct {
  62.     unsigned int cmdcount;
  63.     irq_cmd_t *cmds;
  64. } irq_code_t;
  65.  
  66. #ifdef KERNEL
  67.  
  68. #include <arch/types.h>
  69. #include <adt/list.h>
  70. #include <synch/spinlock.h>
  71. #include <proc/task.h>
  72.  
  73. typedef enum {
  74.     IRQ_DECLINE,        /**< Decline to service. */
  75.     IRQ_ACCEPT      /**< Accept to service. */
  76. } irq_ownership_t;
  77.  
  78. typedef enum {
  79.     IRQ_TRIGGER_LEVEL = 1,
  80.     IRQ_TRIGGER_EDGE
  81. } irq_trigger_t;
  82.  
  83. struct irq;
  84. typedef void (* irq_handler_t)(struct irq *irq, void *arg, ...);
  85.  
  86. /** IPC notification config structure.
  87.  *
  88.  * Primarily, this structure is encapsulated in the irq_t structure.
  89.  * It is protected by irq_t::lock.
  90.  */
  91. typedef struct {
  92.     /** When false, notifications are not sent. */
  93.     bool notify;
  94.     /** Answerbox for notifications. */
  95.     answerbox_t *answerbox;
  96.     /** Method to be used for the notification. */
  97.     unative_t method;
  98.     /** Top-half pseudocode. */
  99.     irq_code_t *code;
  100.     /** Counter. */
  101.     count_t counter;
  102.     /**
  103.      * Link between IRQs that are notifying the same answerbox. The list is
  104.      * protected by the answerbox irq_lock.
  105.      */
  106.     link_t link;
  107. } ipc_notif_cfg_t;
  108.  
  109. /** Structure representing one device IRQ.
  110.  *
  111.  * If one device has multiple interrupts, there will be multiple irq_t
  112.  * instantions with the same devno.
  113.  */
  114. typedef struct irq {
  115.     /** Hash table link. */
  116.     link_t link;
  117.  
  118.     /** Lock protecting everything in this structure
  119.      *  except the link member. When both the IRQ
  120.      *  hash table lock and this lock are to be acquired,
  121.      *  this lock must not be taken first.
  122.      */
  123.     SPINLOCK_DECLARE(lock);
  124.    
  125.     /** Send EOI before processing the interrupt.
  126.      *  This is essential for timer interrupt which
  127.      *  has to be acknowledged before doing preemption
  128.      *  to make sure another timer interrupt will
  129.      *  be eventually generated.
  130.      */
  131.     bool preack;
  132.  
  133.     /** Unique device number. -1 if not yet assigned. */
  134.     devno_t devno;
  135.  
  136.     /** Actual IRQ number. -1 if not yet assigned. */
  137.     inr_t inr;
  138.     /** Trigger level of the IRQ. */
  139.     irq_trigger_t trigger;
  140.     /** Claim ownership of the IRQ. */
  141.     irq_ownership_t (* claim)(void);
  142.     /** Handler for this IRQ and device. */
  143.     irq_handler_t handler;
  144.     /** Argument for the handler. */
  145.     void *arg;
  146.  
  147.     /** Notification configuration structure. */
  148.     ipc_notif_cfg_t* notif_cfg;
  149. } irq_t;
  150.  
  151. extern void irq_init(count_t inrs, count_t chains);
  152. extern void irq_initialize(irq_t *irq);
  153. extern void irq_register(irq_t *irq);
  154. extern irq_t *irq_dispatch_and_lock(inr_t inr);
  155. extern irq_t *irq_find_and_lock(inr_t inr, devno_t devno);
  156.  
  157. #endif
  158.  
  159. #endif
  160.  
  161. /** @}
  162.  */
  163.