Rev 2109 | Rev 2292 | Go to most recent revision | 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 { |
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 | |||
1919 | jermar | 68 | #include <arch/types.h> |
69 | #include <adt/list.h> |
||
1921 | jermar | 70 | #include <synch/spinlock.h> |
2089 | decky | 71 | #include <proc/task.h> |
1919 | jermar | 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 | |||
2089 | decky | 83 | struct irq; |
84 | typedef void (* irq_handler_t)(struct irq *irq, void *arg, ...); |
||
1919 | jermar | 85 | |
2089 | decky | 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 { |
||
2106 | jermar | 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; |
||
2089 | decky | 107 | } ipc_notif_cfg_t; |
108 | |||
1919 | jermar | 109 | /** Structure representing one device IRQ. |
110 | * |
||
2106 | jermar | 111 | * If one device has multiple interrupts, there will be multiple irq_t |
112 | * instantions with the same devno. |
||
1919 | jermar | 113 | */ |
2089 | decky | 114 | typedef struct irq { |
1919 | jermar | 115 | /** Hash table link. */ |
116 | link_t link; |
||
117 | |||
1921 | jermar | 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 | |||
1919 | jermar | 125 | /** Unique device number. -1 if not yet assigned. */ |
126 | devno_t devno; |
||
127 | |||
128 | /** Actual IRQ number. -1 if not yet assigned. */ |
||
129 | inr_t inr; |
||
130 | /** Trigger level of the IRQ.*/ |
||
131 | irq_trigger_t trigger; |
||
132 | /** Claim ownership of the IRQ. */ |
||
133 | irq_ownership_t (* claim)(void); |
||
134 | /** Handler for this IRQ and device. */ |
||
135 | irq_handler_t handler; |
||
136 | /** Argument for the handler. */ |
||
137 | void *arg; |
||
1921 | jermar | 138 | |
1923 | jermar | 139 | /** Notification configuration structure. */ |
140 | ipc_notif_cfg_t notif_cfg; |
||
2089 | decky | 141 | } irq_t; |
1919 | jermar | 142 | |
143 | extern void irq_init(count_t inrs, count_t chains); |
||
144 | extern void irq_initialize(irq_t *irq); |
||
145 | extern void irq_register(irq_t *irq); |
||
1922 | jermar | 146 | extern irq_t *irq_dispatch_and_lock(inr_t inr); |
147 | extern irq_t *irq_find_and_lock(inr_t inr, devno_t devno); |
||
1919 | jermar | 148 | |
149 | #endif |
||
150 | |||
2089 | decky | 151 | #endif |
152 | |||
1919 | jermar | 153 | /** @} |
154 | */ |