Rev 4343 | Go to most recent revision | Only display areas with differences | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed
Rev 4343 | Rev 4344 | ||
---|---|---|---|
1 | /* |
1 | /* |
2 | * Copyright (c) 2006 Jakub Jermar |
2 | * Copyright (c) 2006 Jakub Jermar |
3 | * All rights reserved. |
3 | * All rights reserved. |
4 | * |
4 | * |
5 | * Redistribution and use in source and binary forms, with or without |
5 | * Redistribution and use in source and binary forms, with or without |
6 | * modification, are permitted provided that the following conditions |
6 | * modification, are permitted provided that the following conditions |
7 | * are met: |
7 | * are met: |
8 | * |
8 | * |
9 | * - Redistributions of source code must retain the above copyright |
9 | * - Redistributions of source code must retain the above copyright |
10 | * notice, this list of conditions and the following disclaimer. |
10 | * notice, this list of conditions and the following disclaimer. |
11 | * - Redistributions in binary form must reproduce the above copyright |
11 | * - Redistributions in binary form must reproduce the above copyright |
12 | * notice, this list of conditions and the following disclaimer in the |
12 | * notice, this list of conditions and the following disclaimer in the |
13 | * documentation and/or other materials provided with the distribution. |
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 |
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. |
15 | * derived from this software without specific prior written permission. |
16 | * |
16 | * |
17 | * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR |
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 |
18 | * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES |
19 | * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. |
19 | * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. |
20 | * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, |
20 | * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, |
21 | * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT |
21 | * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT |
22 | * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
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 |
23 | * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
24 | * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
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 |
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. |
26 | * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
27 | */ |
27 | */ |
28 | 28 | ||
29 | /** @addtogroup genericddi |
29 | /** @addtogroup genericddi |
30 | * @{ |
30 | * @{ |
31 | */ |
31 | */ |
32 | /** @file |
32 | /** @file |
33 | */ |
33 | */ |
34 | 34 | ||
35 | #ifndef KERN_IRQ_H_ |
35 | #ifndef KERN_IRQ_H_ |
36 | #define KERN_IRQ_H_ |
36 | #define KERN_IRQ_H_ |
37 | 37 | ||
38 | typedef enum { |
38 | typedef enum { |
39 | CMD_MEM_READ_1 = 0, |
39 | CMD_PIO_READ_8 = 1, |
40 | CMD_MEM_READ_2, |
40 | CMD_PIO_READ_16, |
41 | CMD_MEM_READ_4, |
41 | CMD_PIO_READ_32, |
42 | CMD_MEM_READ_8, |
42 | CMD_PIO_WRITE_8, |
43 | CMD_MEM_WRITE_1, |
43 | CMD_PIO_WRITE_16, |
44 | CMD_MEM_WRITE_2, |
44 | CMD_PIO_WRITE_32, |
45 | CMD_MEM_WRITE_4, |
45 | CMD_BTEST, |
46 | CMD_MEM_WRITE_8, |
46 | CMD_PREDICATE, |
47 | CMD_PORT_READ_1, |
47 | CMD_ACCEPT, |
48 | CMD_PORT_WRITE_1, |
48 | CMD_DECLINE, |
49 | CMD_LAST |
49 | CMD_LAST |
50 | } irq_cmd_type; |
50 | } irq_cmd_type; |
51 | 51 | ||
52 | typedef struct { |
52 | typedef struct { |
53 | irq_cmd_type cmd; |
53 | irq_cmd_type cmd; |
54 | void *addr; |
54 | void *addr; |
55 | unsigned long long value; |
55 | unsigned long long value; |
- | 56 | unsigned int srcarg; |
|
56 | int dstarg; |
57 | unsigned int dstarg; |
57 | } irq_cmd_t; |
58 | } irq_cmd_t; |
58 | 59 | ||
59 | typedef struct { |
60 | typedef struct { |
60 | unsigned int cmdcount; |
61 | unsigned int cmdcount; |
61 | irq_cmd_t *cmds; |
62 | irq_cmd_t *cmds; |
62 | } irq_code_t; |
63 | } irq_code_t; |
63 | 64 | ||
64 | #ifdef KERNEL |
65 | #ifdef KERNEL |
65 | 66 | ||
66 | #include <arch/types.h> |
67 | #include <arch/types.h> |
67 | #include <adt/list.h> |
68 | #include <adt/list.h> |
- | 69 | #include <adt/hash_table.h> |
|
68 | #include <synch/spinlock.h> |
70 | #include <synch/spinlock.h> |
69 | #include <proc/task.h> |
71 | #include <proc/task.h> |
- | 72 | #include <ipc/ipc.h> |
|
70 | 73 | ||
71 | typedef enum { |
74 | typedef enum { |
72 | IRQ_DECLINE, /**< Decline to service. */ |
75 | IRQ_DECLINE, /**< Decline to service. */ |
73 | IRQ_ACCEPT /**< Accept to service. */ |
76 | IRQ_ACCEPT /**< Accept to service. */ |
74 | } irq_ownership_t; |
77 | } irq_ownership_t; |
75 | 78 | ||
76 | typedef enum { |
79 | typedef enum { |
77 | IRQ_TRIGGER_LEVEL = 1, |
80 | IRQ_TRIGGER_LEVEL = 1, |
78 | IRQ_TRIGGER_EDGE |
81 | IRQ_TRIGGER_EDGE |
79 | } irq_trigger_t; |
82 | } irq_trigger_t; |
80 | 83 | ||
81 | struct irq; |
84 | struct irq; |
82 | typedef void (* irq_handler_t)(struct irq *); |
85 | typedef void (* irq_handler_t)(struct irq *); |
83 | 86 | ||
84 | /** Type for function used to clear the interrupt. */ |
87 | /** Type for function used to clear the interrupt. */ |
85 | typedef void (* cir_t)(void *, inr_t); |
88 | typedef void (* cir_t)(void *, inr_t); |
86 | 89 | ||
87 | /** IPC notification config structure. |
90 | /** IPC notification config structure. |
88 | * |
91 | * |
89 | * Primarily, this structure is encapsulated in the irq_t structure. |
92 | * Primarily, this structure is encapsulated in the irq_t structure. |
90 | * It is protected by irq_t::lock. |
93 | * It is protected by irq_t::lock. |
91 | */ |
94 | */ |
92 | typedef struct { |
95 | typedef struct { |
93 | /** When false, notifications are not sent. */ |
96 | /** When false, notifications are not sent. */ |
94 | bool notify; |
97 | bool notify; |
95 | /** Answerbox for notifications. */ |
98 | /** Answerbox for notifications. */ |
96 | answerbox_t *answerbox; |
99 | answerbox_t *answerbox; |
97 | /** Method to be used for the notification. */ |
100 | /** Method to be used for the notification. */ |
98 | unative_t method; |
101 | unative_t method; |
- | 102 | /** Arguments that will be sent if the IRQ is claimed. */ |
|
- | 103 | unative_t scratch[IPC_CALL_LEN]; |
|
99 | /** Top-half pseudocode. */ |
104 | /** Top-half pseudocode. */ |
100 | irq_code_t *code; |
105 | irq_code_t *code; |
101 | /** Counter. */ |
106 | /** Counter. */ |
102 | count_t counter; |
107 | count_t counter; |
103 | /** |
108 | /** |
104 | * Link between IRQs that are notifying the same answerbox. The list is |
109 | * Link between IRQs that are notifying the same answerbox. The list is |
105 | * protected by the answerbox irq_lock. |
110 | * protected by the answerbox irq_lock. |
106 | */ |
111 | */ |
107 | link_t link; |
112 | link_t link; |
108 | } ipc_notif_cfg_t; |
113 | } ipc_notif_cfg_t; |
109 | 114 | ||
110 | /** Structure representing one device IRQ. |
115 | /** Structure representing one device IRQ. |
111 | * |
116 | * |
112 | * If one device has multiple interrupts, there will be multiple irq_t |
117 | * If one device has multiple interrupts, there will be multiple irq_t |
113 | * instantions with the same devno. |
118 | * instantions with the same devno. |
114 | */ |
119 | */ |
115 | typedef struct irq { |
120 | typedef struct irq { |
116 | /** Hash table link. */ |
121 | /** Hash table link. */ |
117 | link_t link; |
122 | link_t link; |
118 | 123 | ||
119 | /** Lock protecting everything in this structure |
124 | /** Lock protecting everything in this structure |
120 | * except the link member. When both the IRQ |
125 | * except the link member. When both the IRQ |
121 | * hash table lock and this lock are to be acquired, |
126 | * hash table lock and this lock are to be acquired, |
122 | * this lock must not be taken first. |
127 | * this lock must not be taken first. |
123 | */ |
128 | */ |
124 | SPINLOCK_DECLARE(lock); |
129 | SPINLOCK_DECLARE(lock); |
125 | 130 | ||
126 | /** Send EOI before processing the interrupt. |
131 | /** Send EOI before processing the interrupt. |
127 | * This is essential for timer interrupt which |
132 | * This is essential for timer interrupt which |
128 | * has to be acknowledged before doing preemption |
133 | * has to be acknowledged before doing preemption |
129 | * to make sure another timer interrupt will |
134 | * to make sure another timer interrupt will |
130 | * be eventually generated. |
135 | * be eventually generated. |
131 | */ |
136 | */ |
132 | bool preack; |
137 | bool preack; |
133 | 138 | ||
134 | /** Unique device number. -1 if not yet assigned. */ |
139 | /** Unique device number. -1 if not yet assigned. */ |
135 | devno_t devno; |
140 | devno_t devno; |
136 | 141 | ||
137 | /** Actual IRQ number. -1 if not yet assigned. */ |
142 | /** Actual IRQ number. -1 if not yet assigned. */ |
138 | inr_t inr; |
143 | inr_t inr; |
139 | /** Trigger level of the IRQ. */ |
144 | /** Trigger level of the IRQ. */ |
140 | irq_trigger_t trigger; |
145 | irq_trigger_t trigger; |
141 | /** Claim ownership of the IRQ. */ |
146 | /** Claim ownership of the IRQ. */ |
142 | irq_ownership_t (* claim)(void *); |
147 | irq_ownership_t (* claim)(struct irq *); |
143 | /** Handler for this IRQ and device. */ |
148 | /** Handler for this IRQ and device. */ |
144 | irq_handler_t handler; |
149 | irq_handler_t handler; |
145 | /** Instance argument for the handler and the claim function. */ |
150 | /** Instance argument for the handler and the claim function. */ |
146 | void *instance; |
151 | void *instance; |
147 | 152 | ||
148 | /** Clear interrupt routine. */ |
153 | /** Clear interrupt routine. */ |
149 | cir_t cir; |
154 | cir_t cir; |
150 | /** First argument to the clear interrupt routine. */ |
155 | /** First argument to the clear interrupt routine. */ |
151 | void *cir_arg; |
156 | void *cir_arg; |
152 | 157 | ||
153 | /** Notification configuration structure. */ |
158 | /** Notification configuration structure. */ |
154 | ipc_notif_cfg_t notif_cfg; |
159 | ipc_notif_cfg_t notif_cfg; |
155 | } irq_t; |
160 | } irq_t; |
156 | 161 | ||
- | 162 | SPINLOCK_EXTERN(irq_uspace_hash_table_lock); |
|
- | 163 | extern hash_table_t irq_uspace_hash_table; |
|
- | 164 | ||
157 | extern void irq_init(count_t, count_t); |
165 | extern void irq_init(count_t, count_t); |
158 | extern void irq_initialize(irq_t *); |
166 | extern void irq_initialize(irq_t *); |
159 | extern void irq_register(irq_t *); |
167 | extern void irq_register(irq_t *); |
160 | extern irq_t *irq_dispatch_and_lock(inr_t); |
168 | extern irq_t *irq_dispatch_and_lock(inr_t); |
161 | extern irq_t *irq_find_and_lock(inr_t, devno_t); |
- | |
162 | 169 | ||
163 | #endif |
170 | #endif |
164 | 171 | ||
165 | #endif |
172 | #endif |
166 | 173 | ||
167 | /** @} |
174 | /** @} |
168 | */ |
175 | */ |
169 | 176 |