Rev 2808 | Rev 2812 | Go to most recent revision | Only display areas with differences | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed
Rev 2808 | Rev 2809 | ||
---|---|---|---|
1 | /* |
1 | /* |
2 | * Copyright (c) 2006 Ondrej Palkovsky |
2 | * Copyright (c) 2006 Ondrej Palkovsky |
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 genericipc |
29 | /** @addtogroup genericipc |
30 | * @{ |
30 | * @{ |
31 | */ |
31 | */ |
32 | /** @file |
32 | /** @file |
33 | */ |
33 | */ |
34 | 34 | ||
35 | #ifndef KERN_IPC_H_ |
35 | #ifndef KERN_IPC_H_ |
36 | #define KERN_IPC_H_ |
36 | #define KERN_IPC_H_ |
37 | 37 | ||
38 | /* Length of data being transfered with IPC call */ |
38 | /* Length of data being transfered with IPC call */ |
39 | /* - the uspace may not be able to utilize full length */ |
39 | /* - the uspace may not be able to utilize full length */ |
40 | #define IPC_CALL_LEN 6 |
40 | #define IPC_CALL_LEN 6 |
41 | 41 | ||
42 | /** Maximum active async calls per thread */ |
42 | /** Maximum active async calls per thread */ |
43 | #ifdef CONFIG_DEBUG |
43 | #ifdef CONFIG_DEBUG |
44 | #define IPC_MAX_ASYNC_CALLS 4 |
44 | #define IPC_MAX_ASYNC_CALLS 4 |
45 | #else |
45 | #else |
46 | #define IPC_MAX_ASYNC_CALLS 4000 |
46 | #define IPC_MAX_ASYNC_CALLS 4000 |
47 | #endif |
47 | #endif |
48 | 48 | ||
49 | /* Flags for calls */ |
49 | /* Flags for calls */ |
50 | 50 | ||
51 | /** This is answer to a call */ |
51 | /** This is answer to a call */ |
52 | #define IPC_CALL_ANSWERED (1 << 0) |
52 | #define IPC_CALL_ANSWERED (1 << 0) |
53 | /** This call will not be freed on error */ |
53 | /** This call will not be freed on error */ |
54 | #define IPC_CALL_STATIC_ALLOC (1 << 1) |
54 | #define IPC_CALL_STATIC_ALLOC (1 << 1) |
55 | /** Answer will not be passed to userspace, will be discarded */ |
55 | /** Answer will not be passed to userspace, will be discarded */ |
56 | #define IPC_CALL_DISCARD_ANSWER (1 << 2) |
56 | #define IPC_CALL_DISCARD_ANSWER (1 << 2) |
57 | /** Call was forwarded */ |
57 | /** Call was forwarded */ |
58 | #define IPC_CALL_FORWARDED (1 << 3) |
58 | #define IPC_CALL_FORWARDED (1 << 3) |
59 | /** Identify connect_me_to answer */ |
59 | /** Identify connect_me_to answer */ |
60 | #define IPC_CALL_CONN_ME_TO (1 << 4) |
60 | #define IPC_CALL_CONN_ME_TO (1 << 4) |
61 | /** Interrupt notification */ |
61 | /** Interrupt notification */ |
62 | #define IPC_CALL_NOTIF (1 << 5) |
62 | #define IPC_CALL_NOTIF (1 << 5) |
63 | 63 | ||
64 | /* |
64 | /* |
65 | * Bits used in call hashes. |
65 | * Bits used in call hashes. |
66 | * The addresses are aligned at least to 4 that is why we can use the 2 least |
66 | * The addresses are aligned at least to 4 that is why we can use the 2 least |
67 | * significant bits of the call address. |
67 | * significant bits of the call address. |
68 | */ |
68 | */ |
69 | /** Type of this call is 'answer' */ |
69 | /** Type of this call is 'answer' */ |
70 | #define IPC_CALLID_ANSWERED 1 |
70 | #define IPC_CALLID_ANSWERED 1 |
71 | /** Type of this call is 'notification' */ |
71 | /** Type of this call is 'notification' */ |
72 | #define IPC_CALLID_NOTIFICATION 2 |
72 | #define IPC_CALLID_NOTIFICATION 2 |
73 | 73 | ||
74 | /* Return values from sys_ipc_call_async(). */ |
74 | /* Return values from sys_ipc_call_async(). */ |
75 | #define IPC_CALLRET_FATAL -1 |
75 | #define IPC_CALLRET_FATAL -1 |
76 | #define IPC_CALLRET_TEMPORARY -2 |
76 | #define IPC_CALLRET_TEMPORARY -2 |
77 | 77 | ||
78 | 78 | ||
79 | /* Macros for manipulating calling data */ |
79 | /* Macros for manipulating calling data */ |
80 | #define IPC_SET_RETVAL(data, retval) ((data).args[0] = (retval)) |
80 | #define IPC_SET_RETVAL(data, retval) ((data).args[0] = (retval)) |
81 | #define IPC_SET_METHOD(data, val) ((data).args[0] = (val)) |
81 | #define IPC_SET_METHOD(data, val) ((data).args[0] = (val)) |
82 | #define IPC_SET_ARG1(data, val) ((data).args[1] = (val)) |
82 | #define IPC_SET_ARG1(data, val) ((data).args[1] = (val)) |
83 | #define IPC_SET_ARG2(data, val) ((data).args[2] = (val)) |
83 | #define IPC_SET_ARG2(data, val) ((data).args[2] = (val)) |
84 | #define IPC_SET_ARG3(data, val) ((data).args[3] = (val)) |
84 | #define IPC_SET_ARG3(data, val) ((data).args[3] = (val)) |
85 | #define IPC_SET_ARG4(data, val) ((data).args[4] = (val)) |
85 | #define IPC_SET_ARG4(data, val) ((data).args[4] = (val)) |
86 | #define IPC_SET_ARG5(data, val) ((data).args[5] = (val)) |
86 | #define IPC_SET_ARG5(data, val) ((data).args[5] = (val)) |
87 | 87 | ||
88 | #define IPC_GET_METHOD(data) ((data).args[0]) |
88 | #define IPC_GET_METHOD(data) ((data).args[0]) |
89 | #define IPC_GET_RETVAL(data) ((data).args[0]) |
89 | #define IPC_GET_RETVAL(data) ((data).args[0]) |
90 | 90 | ||
91 | #define IPC_GET_ARG1(data) ((data).args[1]) |
91 | #define IPC_GET_ARG1(data) ((data).args[1]) |
92 | #define IPC_GET_ARG2(data) ((data).args[2]) |
92 | #define IPC_GET_ARG2(data) ((data).args[2]) |
93 | #define IPC_GET_ARG3(data) ((data).args[3]) |
93 | #define IPC_GET_ARG3(data) ((data).args[3]) |
94 | #define IPC_GET_ARG4(data) ((data).args[4]) |
94 | #define IPC_GET_ARG4(data) ((data).args[4]) |
95 | #define IPC_GET_ARG5(data) ((data).args[5]) |
95 | #define IPC_GET_ARG5(data) ((data).args[5]) |
96 | 96 | ||
97 | /* Well known phone descriptors */ |
97 | /* Well known phone descriptors */ |
98 | #define PHONE_NS 0 |
98 | #define PHONE_NS 0 |
99 | 99 | ||
100 | /* Forwarding flags. */ |
100 | /* Forwarding flags. */ |
101 | #define IPC_FF_NONE 0 |
101 | #define IPC_FF_NONE 0 |
102 | /** |
102 | /** |
103 | * The call will be routed as though it was initially sent via the phone used to |
103 | * The call will be routed as though it was initially sent via the phone used to |
104 | * forward it. This feature is intended to support the situation in which the |
104 | * forward it. This feature is intended to support the situation in which the |
105 | * forwarded call needs to be handled by the same connection fibril as any other |
105 | * forwarded call needs to be handled by the same connection fibril as any other |
106 | * calls that were initially sent by the forwarder to the same destination. This |
106 | * calls that were initially sent by the forwarder to the same destination. This |
107 | * flag has no imapct on routing replies. |
107 | * flag has no imapct on routing replies. |
108 | */ |
108 | */ |
109 | #define IPC_FF_ROUTE_FROM_ME (1 << 0) |
109 | #define IPC_FF_ROUTE_FROM_ME (1 << 0) |
110 | 110 | ||
111 | /* System-specific methods - only through special syscalls |
111 | /* System-specific methods - only through special syscalls |
112 | * These methods have special behaviour |
112 | * These methods have special behaviour |
113 | */ |
113 | */ |
114 | /** Protocol for CONNECT - TO - ME |
114 | /** Protocol for CONNECT - TO - ME |
115 | * |
115 | * |
116 | * Calling process asks the callee to create a callback connection, |
116 | * Calling process asks the callee to create a callback connection, |
117 | * so that it can start initiating new messages. |
117 | * so that it can start initiating new messages. |
118 | * |
118 | * |
119 | * The protocol for negotiating is: |
119 | * The protocol for negotiating is: |
120 | * - sys_connect_to_me - sends a message IPC_M_CONNECT_TO_ME |
120 | * - sys_connect_to_me - sends a message IPC_M_CONNECT_TO_ME |
121 | * - recipient - upon receipt tries to allocate new phone |
121 | * - recipient - upon receipt tries to allocate new phone |
122 | * - if it fails, responds with ELIMIT |
122 | * - if it fails, responds with ELIMIT |
123 | * - passes call to userspace. If userspace |
123 | * - passes call to userspace. If userspace |
124 | * responds with error, phone is deallocated and |
124 | * responds with error, phone is deallocated and |
125 | * error is sent back to caller. Otherwise |
125 | * error is sent back to caller. Otherwise |
126 | * the call is accepted and the response is sent back. |
126 | * the call is accepted and the response is sent back. |
127 | * - the allocated phoneid is passed to userspace |
127 | * - the allocated phoneid is passed to userspace |
128 | * (on the receiving side) as ARG5 of the call. |
128 | * (on the receiving side) as ARG5 of the call. |
129 | */ |
129 | */ |
130 | #define IPC_M_CONNECT_TO_ME 1 |
130 | #define IPC_M_CONNECT_TO_ME 1 |
131 | /** Protocol for CONNECT - ME - TO |
131 | /** Protocol for CONNECT - ME - TO |
132 | * |
132 | * |
133 | * Calling process asks the callee to create for him a new connection. |
133 | * Calling process asks the callee to create for him a new connection. |
134 | * E.g. the caller wants a name server to connect him to print server. |
134 | * E.g. the caller wants a name server to connect him to print server. |
135 | * |
135 | * |
136 | * The protocol for negotiating is: |
136 | * The protocol for negotiating is: |
137 | * - sys_connect_me_to - send a synchronous message to name server |
137 | * - sys_connect_me_to - send a synchronous message to name server |
138 | * indicating that it wants to be connected to some |
138 | * indicating that it wants to be connected to some |
139 | * service |
139 | * service |
140 | * - arg1/2/3 are user specified, arg5 contains |
140 | * - arg1/2/3 are user specified, arg5 contains |
141 | * address of the phone that should be connected |
141 | * address of the phone that should be connected |
142 | * (TODO: it leaks to userspace) |
142 | * (TODO: it leaks to userspace) |
143 | * - recipient - if ipc_answer == 0, then accept connection |
143 | * - recipient - if ipc_answer == 0, then accept connection |
144 | * - otherwise connection refused |
144 | * - otherwise connection refused |
145 | * - recepient may forward message. |
145 | * - recepient may forward message. |
146 | * |
146 | * |
147 | */ |
147 | */ |
148 | #define IPC_M_CONNECT_ME_TO 2 |
148 | #define IPC_M_CONNECT_ME_TO 2 |
149 | /** This message is sent to answerbox when the phone |
149 | /** This message is sent to answerbox when the phone |
150 | * is hung up |
150 | * is hung up |
151 | */ |
151 | */ |
152 | #define IPC_M_PHONE_HUNGUP 3 |
152 | #define IPC_M_PHONE_HUNGUP 3 |
153 | 153 | ||
154 | /** Send as_area over IPC. |
154 | /** Send as_area over IPC. |
155 | * - ARG1 - source as_area base address |
155 | * - ARG1 - source as_area base address |
156 | * - ARG2 - size of source as_area (filled automatically by kernel) |
156 | * - ARG2 - size of source as_area (filled automatically by kernel) |
157 | * - ARG3 - flags of the as_area being sent |
157 | * - ARG3 - flags of the as_area being sent |
158 | * |
158 | * |
159 | * on answer, the recipient must set: |
159 | * on answer, the recipient must set: |
160 | * - ARG1 - dst as_area base adress |
160 | * - ARG1 - dst as_area base adress |
161 | */ |
161 | */ |
162 | #define IPC_M_SHARE_OUT 4 |
162 | #define IPC_M_SHARE_OUT 4 |
163 | 163 | ||
164 | /** Receive as_area over IPC. |
164 | /** Receive as_area over IPC. |
165 | * - ARG1 - destination as_area base address |
165 | * - ARG1 - destination as_area base address |
166 | * - ARG2 - destination as_area size |
166 | * - ARG2 - destination as_area size |
167 | * - ARG3 - user defined argument |
167 | * - ARG3 - user defined argument |
168 | * |
168 | * |
169 | * on answer, the recipient must set: |
169 | * on answer, the recipient must set: |
170 | * |
170 | * |
171 | * - ARG1 - source as_area base address |
171 | * - ARG1 - source as_area base address |
172 | * - ARG2 - flags that will be used for sharing |
172 | * - ARG2 - flags that will be used for sharing |
173 | */ |
173 | */ |
174 | #define IPC_M_SHARE_IN 5 |
174 | #define IPC_M_SHARE_IN 5 |
175 | 175 | ||
176 | /** Send data to another address space over IPC. |
176 | /** Send data to another address space over IPC. |
177 | * - ARG1 - source address space virtual address |
177 | * - ARG1 - source address space virtual address |
178 | * - ARG2 - size of data to be copied, may be overriden by the recipient |
178 | * - ARG2 - size of data to be copied, may be overriden by the recipient |
179 | * |
179 | * |
180 | * on answer, the recipient must set: |
180 | * on answer, the recipient must set: |
181 | * |
181 | * |
182 | * - ARG1 - final destination address space virtual address |
182 | * - ARG1 - final destination address space virtual address |
183 | * - ARG2 - final size of data to be copied |
183 | * - ARG2 - final size of data to be copied |
184 | */ |
184 | */ |
185 | #define IPC_M_DATA_WRITE 6 |
185 | #define IPC_M_DATA_WRITE 6 |
186 | 186 | ||
187 | /** Receive data from another address space over IPC. |
187 | /** Receive data from another address space over IPC. |
188 | * - ARG1 - destination virtual address in the source address space |
188 | * - ARG1 - destination virtual address in the source address space |
189 | * - ARG2 - size of data to be received, may be cropped by the recipient |
189 | * - ARG2 - size of data to be received, may be cropped by the recipient |
190 | * |
190 | * |
191 | * on answer, the recipient must set: |
191 | * on answer, the recipient must set: |
192 | * |
192 | * |
193 | * - ARG1 - source virtual address in the destination address space |
193 | * - ARG1 - source virtual address in the destination address space |
194 | * - ARG2 - final size of data to be copied |
194 | * - ARG2 - final size of data to be copied |
195 | */ |
195 | */ |
196 | #define IPC_M_DATA_READ 7 |
196 | #define IPC_M_DATA_READ 7 |
197 | 197 | ||
198 | /** Start debugging the recipient. |
198 | /** Start debugging the recipient. |
199 | * Causes all threads in the receiving task to stop. When they |
199 | * Causes all threads in the receiving task to stop. When they |
200 | * are all stoped, an answer with retval 0 is generated. |
200 | * are all stoped, an answer with retval 0 is generated. |
201 | */ |
201 | */ |
202 | #define IPC_M_DEBUG_BEGIN 8 |
202 | #define IPC_M_DEBUG_BEGIN 8 |
203 | 203 | ||
204 | /** Finish debugging the recipient. |
204 | /** Finish debugging the recipient. |
205 | * Answers all pending GO and GUARD messages. |
205 | * Answers all pending GO and GUARD messages. |
206 | */ |
206 | */ |
207 | #define IPC_M_DEBUG_END 9 |
207 | #define IPC_M_DEBUG_END 9 |
208 | 208 | ||
209 | /** Make sure the debugged task is still there. |
209 | /** Make sure the debugged task is still there. |
210 | * This message is answered when the debugged task dies |
210 | * This message is answered when the debugged task dies |
211 | * or the debugging session ends. |
211 | * or the debugging session ends. |
212 | */ |
212 | */ |
213 | #define IPC_M_DEBUG_GUARD 10 |
213 | #define IPC_M_DEBUG_GUARD 10 |
214 | 214 | ||
215 | /** Run a thread until a debugging event occurs. |
215 | /** Run a thread until a debugging event occurs. |
216 | * This message is answered when the thread stops |
216 | * This message is answered when the thread stops |
217 | * in a debugging event. |
217 | * in a debugging event. |
218 | * |
218 | * |
219 | * - ARG1 - id of the thread to run |
219 | * - ARG1 - id of the thread to run |
220 | */ |
220 | */ |
221 | #define IPC_M_DEBUG_GO 11 |
221 | #define IPC_M_DEBUG_GO 11 |
222 | 222 | ||
223 | /** Stop a thread being debugged. |
223 | /** Stop a thread being debugged. |
224 | * Creates a special STOP event in the thread, causing |
224 | * Creates a special STOP event in the thread, causing |
225 | * it to answer a pending GO message (if any). |
225 | * it to answer a pending GO message (if any). |
226 | */ |
226 | */ |
227 | #define IPC_M_DEBUG_STOP 12 |
227 | #define IPC_M_DEBUG_STOP 12 |
228 | 228 | ||
229 | /** Read arguments of a syscall. |
229 | /** Read arguments of a syscall. |
230 | * |
230 | * |
231 | * - ARG1 - thread identification |
231 | * - ARG1 - thread identification |
232 | * - ARG2 - destination address in the caller's address space |
232 | * - ARG2 - destination address in the caller's address space |
233 | * - ARG3 - size of receiving buffer in bytes |
233 | * - ARG3 - size of receiving buffer in bytes |
234 | * |
234 | * |
235 | * on answer, the kernel will set: |
235 | * on answer, the kernel will set: |
236 | * |
236 | * |
237 | * - ARG1 - actual size in bytes of data read |
237 | * - ARG1 - actual size in bytes of data read |
238 | */ |
238 | */ |
239 | #define IPC_M_DEBUG_ARGS_READ 12 |
239 | #define IPC_M_DEBUG_ARGS_READ 12 |
240 | 240 | ||
241 | /** Read the list of the debugged tasks's threads. |
241 | /** Read the list of the debugged tasks's threads. |
242 | * |
242 | * |
243 | * - ARG1 - destination address in the caller's address space |
243 | * - ARG1 - destination address in the caller's address space |
244 | * - ARG2 - size of receiving buffer in bytes |
244 | * - ARG2 - size of receiving buffer in bytes |
245 | * |
245 | * |
246 | * The kernel fills the buffer with a series of sysarg_t values |
246 | * The kernel fills the buffer with a series of sysarg_t values |
247 | * (thread ids). On answer, the kernel will set: |
247 | * (thread ids). On answer, the kernel will set: |
248 | * |
248 | * |
249 | * - ARG1 - number of bytes that were actually copied |
249 | * - ARG1 - number of bytes that were actually copied |
250 | * - ARG2 - number of bytes of the complete data |
250 | * - ARG2 - number of bytes of the complete data |
251 | * |
251 | * |
252 | */ |
252 | */ |
253 | #define IPC_M_DEBUG_THREAD_READ 13 |
253 | #define IPC_M_DEBUG_THREAD_READ 13 |
254 | 254 | ||
- | 255 | /** Read the list of the debugged tasks's memory. |
|
- | 256 | * |
|
- | 257 | * - ARG1 - destination address in the caller's address space |
|
- | 258 | * - ARG2 - source address in the recipient's address space |
|
- | 259 | * - ARG3 - size of receiving buffer in bytes |
|
- | 260 | * |
|
- | 261 | */ |
|
- | 262 | #define IPC_M_DEBUG_MEM_READ 14 |
|
- | 263 | ||
255 | /* Well-known methods */ |
264 | /* Well-known methods */ |
256 | #define IPC_M_LAST_SYSTEM 511 |
265 | #define IPC_M_LAST_SYSTEM 511 |
257 | #define IPC_M_PING 512 |
266 | #define IPC_M_PING 512 |
258 | /* User methods */ |
267 | /* User methods */ |
259 | #define IPC_FIRST_USER_METHOD 1024 |
268 | #define IPC_FIRST_USER_METHOD 1024 |
260 | 269 | ||
261 | #ifdef KERNEL |
270 | #ifdef KERNEL |
262 | 271 | ||
263 | #define IPC_MAX_PHONES 16 |
272 | #define IPC_MAX_PHONES 16 |
264 | 273 | ||
265 | #include <synch/waitq.h> |
274 | #include <synch/waitq.h> |
266 | 275 | ||
267 | struct answerbox; |
276 | struct answerbox; |
268 | struct task; |
277 | struct task; |
269 | 278 | ||
270 | typedef enum { |
279 | typedef enum { |
271 | /** Phone is free and can be allocated */ |
280 | /** Phone is free and can be allocated */ |
272 | IPC_PHONE_FREE = 0, |
281 | IPC_PHONE_FREE = 0, |
273 | /** Phone is connecting somewhere */ |
282 | /** Phone is connecting somewhere */ |
274 | IPC_PHONE_CONNECTING, |
283 | IPC_PHONE_CONNECTING, |
275 | /** Phone is connected */ |
284 | /** Phone is connected */ |
276 | IPC_PHONE_CONNECTED, |
285 | IPC_PHONE_CONNECTED, |
277 | /** Phone is hung up, waiting for answers to come */ |
286 | /** Phone is hung up, waiting for answers to come */ |
278 | IPC_PHONE_HUNGUP, |
287 | IPC_PHONE_HUNGUP, |
279 | /** Phone was hungup from server */ |
288 | /** Phone was hungup from server */ |
280 | IPC_PHONE_SLAMMED |
289 | IPC_PHONE_SLAMMED |
281 | } ipc_phone_state_t; |
290 | } ipc_phone_state_t; |
282 | 291 | ||
283 | /** Structure identifying phone (in TASK structure) */ |
292 | /** Structure identifying phone (in TASK structure) */ |
284 | typedef struct { |
293 | typedef struct { |
285 | SPINLOCK_DECLARE(lock); |
294 | SPINLOCK_DECLARE(lock); |
286 | link_t link; |
295 | link_t link; |
287 | struct answerbox *callee; |
296 | struct answerbox *callee; |
288 | ipc_phone_state_t state; |
297 | ipc_phone_state_t state; |
289 | atomic_t active_calls; |
298 | atomic_t active_calls; |
290 | } phone_t; |
299 | } phone_t; |
291 | 300 | ||
292 | typedef struct answerbox { |
301 | typedef struct answerbox { |
293 | SPINLOCK_DECLARE(lock); |
302 | SPINLOCK_DECLARE(lock); |
294 | 303 | ||
295 | struct task *task; |
304 | struct task *task; |
296 | 305 | ||
297 | waitq_t wq; |
306 | waitq_t wq; |
298 | 307 | ||
299 | /** Phones connected to this answerbox. */ |
308 | /** Phones connected to this answerbox. */ |
300 | link_t connected_phones; |
309 | link_t connected_phones; |
301 | /** Received calls. */ |
310 | /** Received calls. */ |
302 | link_t calls; |
311 | link_t calls; |
303 | link_t dispatched_calls; /* Should be hash table in the future */ |
312 | link_t dispatched_calls; /* Should be hash table in the future */ |
304 | 313 | ||
305 | /** Answered calls. */ |
314 | /** Answered calls. */ |
306 | link_t answers; |
315 | link_t answers; |
307 | 316 | ||
308 | SPINLOCK_DECLARE(irq_lock); |
317 | SPINLOCK_DECLARE(irq_lock); |
309 | /** Notifications from IRQ handlers. */ |
318 | /** Notifications from IRQ handlers. */ |
310 | link_t irq_notifs; |
319 | link_t irq_notifs; |
311 | /** IRQs with notifications to this answerbox. */ |
320 | /** IRQs with notifications to this answerbox. */ |
312 | link_t irq_head; |
321 | link_t irq_head; |
313 | } answerbox_t; |
322 | } answerbox_t; |
314 | 323 | ||
315 | typedef struct { |
324 | typedef struct { |
316 | unative_t args[IPC_CALL_LEN]; |
325 | unative_t args[IPC_CALL_LEN]; |
317 | phone_t *phone; |
326 | phone_t *phone; |
318 | } ipc_data_t; |
327 | } ipc_data_t; |
319 | 328 | ||
320 | typedef struct { |
329 | typedef struct { |
321 | link_t link; |
330 | link_t link; |
322 | 331 | ||
323 | int flags; |
332 | int flags; |
324 | 333 | ||
325 | /** Identification of the caller. */ |
334 | /** Identification of the caller. */ |
326 | struct task *sender; |
335 | struct task *sender; |
327 | /** The caller box is different from sender->answerbox for synchronous |
336 | /** The caller box is different from sender->answerbox for synchronous |
328 | * calls. */ |
337 | * calls. */ |
329 | answerbox_t *callerbox; |
338 | answerbox_t *callerbox; |
330 | 339 | ||
331 | /** Private data to internal IPC. */ |
340 | /** Private data to internal IPC. */ |
332 | unative_t priv; |
341 | unative_t priv; |
333 | 342 | ||
334 | /** Data passed from/to userspace. */ |
343 | /** Data passed from/to userspace. */ |
335 | ipc_data_t data; |
344 | ipc_data_t data; |
336 | 345 | ||
337 | /** Buffer for IPC_M_DATA_WRITE and IPC_M_DATA_READ. */ |
346 | /** Buffer for IPC_M_DATA_WRITE and IPC_M_DATA_READ. */ |
338 | uint8_t *buffer; |
347 | uint8_t *buffer; |
339 | } call_t; |
348 | } call_t; |
340 | 349 | ||
341 | extern void ipc_init(void); |
350 | extern void ipc_init(void); |
342 | extern call_t * ipc_wait_for_call(answerbox_t *box, uint32_t usec, int flags); |
351 | extern call_t * ipc_wait_for_call(answerbox_t *box, uint32_t usec, int flags); |
343 | extern void ipc_answer(answerbox_t *box, call_t *request); |
352 | extern void ipc_answer(answerbox_t *box, call_t *request); |
344 | extern int ipc_call(phone_t *phone, call_t *call); |
353 | extern int ipc_call(phone_t *phone, call_t *call); |
345 | extern void ipc_call_sync(phone_t *phone, call_t *request); |
354 | extern void ipc_call_sync(phone_t *phone, call_t *request); |
346 | extern void ipc_phone_init(phone_t *phone); |
355 | extern void ipc_phone_init(phone_t *phone); |
347 | extern void ipc_phone_connect(phone_t *phone, answerbox_t *box); |
356 | extern void ipc_phone_connect(phone_t *phone, answerbox_t *box); |
348 | extern void ipc_call_free(call_t *call); |
357 | extern void ipc_call_free(call_t *call); |
349 | extern call_t * ipc_call_alloc(int flags); |
358 | extern call_t * ipc_call_alloc(int flags); |
350 | extern void ipc_answerbox_init(answerbox_t *box, struct task *task); |
359 | extern void ipc_answerbox_init(answerbox_t *box, struct task *task); |
351 | extern void ipc_call_static_init(call_t *call); |
360 | extern void ipc_call_static_init(call_t *call); |
352 | extern void task_print_list(void); |
361 | extern void task_print_list(void); |
353 | extern int ipc_forward(call_t *call, phone_t *newphone, answerbox_t *oldbox, |
362 | extern int ipc_forward(call_t *call, phone_t *newphone, answerbox_t *oldbox, |
354 | int mode); |
363 | int mode); |
355 | extern void ipc_cleanup(void); |
364 | extern void ipc_cleanup(void); |
356 | extern int ipc_phone_hangup(phone_t *phone); |
365 | extern int ipc_phone_hangup(phone_t *phone); |
357 | extern void ipc_backsend_err(phone_t *phone, call_t *call, unative_t err); |
366 | extern void ipc_backsend_err(phone_t *phone, call_t *call, unative_t err); |
358 | extern void ipc_print_task(task_id_t taskid); |
367 | extern void ipc_print_task(task_id_t taskid); |
359 | extern int ipc_connect_kbox(task_id_t taskid); |
368 | extern int ipc_connect_kbox(task_id_t taskid); |
360 | 369 | ||
361 | extern answerbox_t *ipc_phone_0; |
370 | extern answerbox_t *ipc_phone_0; |
362 | 371 | ||
363 | #endif |
372 | #endif |
364 | 373 | ||
365 | #endif |
374 | #endif |
366 | 375 | ||
367 | /** @} |
376 | /** @} |
368 | */ |
377 | */ |
369 | 378 |