Rev 3947 | Details | Compare with Previous | Last modification | View Log | RSS feed
| Rev | Author | Line No. | Line |
|---|---|---|---|
| 1919 | jermar | 1 | /* |
| 2071 | jermar | 2 | * Copyright (c) 2006 Jakub Jermar |
| 1919 | 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 | |||
| 1920 | jermar | 29 | /** @addtogroup genericddi |
| 1919 | jermar | 30 | * @{ |
| 31 | */ |
||
| 32 | /** @file |
||
| 33 | */ |
||
| 34 | |||
| 35 | #ifndef KERN_IRQ_H_ |
||
| 36 | #define KERN_IRQ_H_ |
||
| 37 | |||
| 2089 | decky | 38 | typedef enum { |
| 3947 | jermar | 39 | CMD_PIO_READ_8 = 1, |
| 40 | CMD_PIO_READ_16, |
||
| 41 | CMD_PIO_READ_32, |
||
| 42 | CMD_PIO_WRITE_8, |
||
| 43 | CMD_PIO_WRITE_16, |
||
| 44 | CMD_PIO_WRITE_32, |
||
| 45 | CMD_BTEST, |
||
| 46 | CMD_PREDICATE, |
||
| 47 | CMD_ACCEPT, |
||
| 48 | CMD_DECLINE, |
||
| 2089 | decky | 49 | CMD_LAST |
| 50 | } irq_cmd_type; |
||
| 51 | |||
| 52 | typedef struct { |
||
| 53 | irq_cmd_type cmd; |
||
| 54 | void *addr; |
||
| 3947 | jermar | 55 | unsigned long long value; |
| 56 | unsigned int srcarg; |
||
| 57 | unsigned int dstarg; |
||
| 2089 | decky | 58 | } irq_cmd_t; |
| 59 | |||
| 60 | typedef struct { |
||
| 61 | unsigned int cmdcount; |
||
| 62 | irq_cmd_t *cmds; |
||
| 63 | } irq_code_t; |
||
| 64 | |||
| 65 | #ifdef KERNEL |
||
| 66 | |||
| 1919 | jermar | 67 | #include <arch/types.h> |
| 68 | #include <adt/list.h> |
||
| 3947 | jermar | 69 | #include <adt/hash_table.h> |
| 1921 | jermar | 70 | #include <synch/spinlock.h> |
| 2089 | decky | 71 | #include <proc/task.h> |
| 3947 | jermar | 72 | #include <ipc/ipc.h> |
| 1919 | jermar | 73 | |
| 74 | typedef enum { |
||
| 75 | IRQ_DECLINE, /**< Decline to service. */ |
||
| 76 | IRQ_ACCEPT /**< Accept to service. */ |
||
| 77 | } irq_ownership_t; |
||
| 78 | |||
| 79 | typedef enum { |
||
| 80 | IRQ_TRIGGER_LEVEL = 1, |
||
| 81 | IRQ_TRIGGER_EDGE |
||
| 82 | } irq_trigger_t; |
||
| 83 | |||
| 2089 | decky | 84 | struct irq; |
| 3906 | jermar | 85 | typedef void (* irq_handler_t)(struct irq *); |
| 1919 | jermar | 86 | |
| 3655 | jermar | 87 | /** Type for function used to clear the interrupt. */ |
| 3906 | jermar | 88 | typedef void (* cir_t)(void *, inr_t); |
| 3655 | jermar | 89 | |
| 2089 | decky | 90 | /** IPC notification config structure. |
| 91 | * |
||
| 92 | * Primarily, this structure is encapsulated in the irq_t structure. |
||
| 93 | * It is protected by irq_t::lock. |
||
| 94 | */ |
||
| 95 | typedef struct { |
||
| 2106 | jermar | 96 | /** When false, notifications are not sent. */ |
| 97 | bool notify; |
||
| 98 | /** Answerbox for notifications. */ |
||
| 99 | answerbox_t *answerbox; |
||
| 100 | /** Method to be used for the notification. */ |
||
| 101 | unative_t method; |
||
| 3947 | jermar | 102 | /** Arguments that will be sent if the IRQ is claimed. */ |
| 103 | unative_t scratch[IPC_CALL_LEN]; |
||
| 2106 | jermar | 104 | /** Top-half pseudocode. */ |
| 105 | irq_code_t *code; |
||
| 106 | /** Counter. */ |
||
| 4490 | decky | 107 | size_t counter; |
| 2106 | jermar | 108 | /** |
| 109 | * Link between IRQs that are notifying the same answerbox. The list is |
||
| 110 | * protected by the answerbox irq_lock. |
||
| 111 | */ |
||
| 112 | link_t link; |
||
| 2089 | decky | 113 | } ipc_notif_cfg_t; |
| 114 | |||
| 1919 | jermar | 115 | /** Structure representing one device IRQ. |
| 116 | * |
||
| 2106 | jermar | 117 | * If one device has multiple interrupts, there will be multiple irq_t |
| 118 | * instantions with the same devno. |
||
| 1919 | jermar | 119 | */ |
| 2089 | decky | 120 | typedef struct irq { |
| 1919 | jermar | 121 | /** Hash table link. */ |
| 122 | link_t link; |
||
| 123 | |||
| 1921 | jermar | 124 | /** Lock protecting everything in this structure |
| 125 | * except the link member. When both the IRQ |
||
| 126 | * hash table lock and this lock are to be acquired, |
||
| 127 | * this lock must not be taken first. |
||
| 128 | */ |
||
| 129 | SPINLOCK_DECLARE(lock); |
||
| 2218 | decky | 130 | |
| 131 | /** Send EOI before processing the interrupt. |
||
| 132 | * This is essential for timer interrupt which |
||
| 133 | * has to be acknowledged before doing preemption |
||
| 134 | * to make sure another timer interrupt will |
||
| 135 | * be eventually generated. |
||
| 136 | */ |
||
| 137 | bool preack; |
||
| 1921 | jermar | 138 | |
| 1919 | jermar | 139 | /** Unique device number. -1 if not yet assigned. */ |
| 140 | devno_t devno; |
||
| 141 | |||
| 142 | /** Actual IRQ number. -1 if not yet assigned. */ |
||
| 143 | inr_t inr; |
||
| 2218 | decky | 144 | /** Trigger level of the IRQ. */ |
| 1919 | jermar | 145 | irq_trigger_t trigger; |
| 146 | /** Claim ownership of the IRQ. */ |
||
| 3941 | jermar | 147 | irq_ownership_t (* claim)(struct irq *); |
| 1919 | jermar | 148 | /** Handler for this IRQ and device. */ |
| 149 | irq_handler_t handler; |
||
| 3906 | jermar | 150 | /** Instance argument for the handler and the claim function. */ |
| 151 | void *instance; |
||
| 1921 | jermar | 152 | |
| 3655 | jermar | 153 | /** Clear interrupt routine. */ |
| 154 | cir_t cir; |
||
| 155 | /** First argument to the clear interrupt routine. */ |
||
| 156 | void *cir_arg; |
||
| 157 | |||
| 1923 | jermar | 158 | /** Notification configuration structure. */ |
| 159 | ipc_notif_cfg_t notif_cfg; |
||
| 2089 | decky | 160 | } irq_t; |
| 1919 | jermar | 161 | |
| 3947 | jermar | 162 | SPINLOCK_EXTERN(irq_uspace_hash_table_lock); |
| 163 | extern hash_table_t irq_uspace_hash_table; |
||
| 164 | |||
| 4490 | decky | 165 | extern void irq_init(size_t, size_t); |
| 3906 | jermar | 166 | extern void irq_initialize(irq_t *); |
| 167 | extern void irq_register(irq_t *); |
||
| 168 | extern irq_t *irq_dispatch_and_lock(inr_t); |
||
| 1919 | jermar | 169 | |
| 170 | #endif |
||
| 171 | |||
| 2089 | decky | 172 | #endif |
| 173 | |||
| 1919 | jermar | 174 | /** @} |
| 175 | */ |