source: mainline/uspace/lib/libc/include/ipc/ipc.h@ 9f51afc

lfn serial ticket/834-toolchain-update topic/msim-upgrade topic/simplify-dev-export
Last change on this file since 9f51afc was ba8f8cb, checked in by Jakub Jermar <jakub@…>, 16 years ago

The original ipc_data_*() and ipc_share_*() should use plain HelenOS IPC.
Remove ipc_*_receive() because it cannot be easily expressed without the async
framework.

  • Property mode set to 100644
File size: 13.3 KB
Line 
1/*
2 * Copyright (c) 2006 Ondrej Palkovsky
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 libcipc
30 * @{
31 */
32/** @file
33 */
34
35#ifndef LIBIPC_IPC_H_
36#define LIBIPC_IPC_H_
37
38#include <task.h>
39#include <kernel/ipc/ipc.h>
40#include <kernel/ddi/irq.h>
41#include <sys/types.h>
42#include <kernel/synch/synch.h>
43
44#define IPC_FLAG_BLOCKING 0x01
45
46typedef sysarg_t ipcarg_t;
47
48typedef struct {
49 ipcarg_t args[IPC_CALL_LEN];
50 ipcarg_t in_phone_hash;
51} ipc_call_t;
52
53typedef sysarg_t ipc_callid_t;
54
55typedef void (* ipc_async_callback_t)(void *, int, ipc_call_t *);
56
57/*
58 * User-friendly wrappers for ipc_call_sync_fast() and ipc_call_sync_slow().
59 * They are in the form ipc_call_sync_m_n(), where m denotes the number of
60 * arguments of payload and n denotes number of return values. Whenever
61 * possible, the fast version is used.
62 */
63#define ipc_call_sync_0_0(phoneid, method) \
64 ipc_call_sync_fast((phoneid), (method), 0, 0, 0, 0, 0, 0, 0, 0)
65#define ipc_call_sync_0_1(phoneid, method, res1) \
66 ipc_call_sync_fast((phoneid), (method), 0, 0, 0, (res1), 0, 0, 0, 0)
67#define ipc_call_sync_0_2(phoneid, method, res1, res2) \
68 ipc_call_sync_fast((phoneid), (method), 0, 0, 0, (res1), (res2), 0, 0, 0)
69#define ipc_call_sync_0_3(phoneid, method, res1, res2, res3) \
70 ipc_call_sync_fast((phoneid), (method), 0, 0, 0, (res1), (res2), (res3), \
71 0, 0)
72#define ipc_call_sync_0_4(phoneid, method, res1, res2, res3, res4) \
73 ipc_call_sync_fast((phoneid), (method), 0, 0, 0, (res1), (res2), (res3), \
74 (res4), 0)
75#define ipc_call_sync_0_5(phoneid, method, res1, res2, res3, res4, res5) \
76 ipc_call_sync_fast((phoneid), (method), 0, 0, 0, (res1), (res2), (res3), \
77 (res4), (res5))
78
79#define ipc_call_sync_1_0(phoneid, method, arg1) \
80 ipc_call_sync_fast((phoneid), (method), (arg1), 0, 0, 0, 0, 0, 0, 0)
81#define ipc_call_sync_1_1(phoneid, method, arg1, res1) \
82 ipc_call_sync_fast((phoneid), (method), (arg1), 0, 0, (res1), 0, 0, 0, 0)
83#define ipc_call_sync_1_2(phoneid, method, arg1, res1, res2) \
84 ipc_call_sync_fast((phoneid), (method), (arg1), 0, 0, (res1), (res2), 0, \
85 0, 0)
86#define ipc_call_sync_1_3(phoneid, method, arg1, res1, res2, res3) \
87 ipc_call_sync_fast((phoneid), (method), (arg1), 0, 0, (res1), (res2), \
88 (res3), 0, 0)
89#define ipc_call_sync_1_4(phoneid, method, arg1, res1, res2, res3, res4) \
90 ipc_call_sync_fast((phoneid), (method), (arg1), 0, 0, (res1), (res2), \
91 (res3), (res4), 0)
92#define ipc_call_sync_1_5(phoneid, method, arg1, res1, res2, res3, res4, \
93 res5) \
94 ipc_call_sync_fast((phoneid), (method), (arg1), 0, 0, (res1), (res2), \
95 (res3), (res4), (res5))
96
97#define ipc_call_sync_2_0(phoneid, method, arg1, arg2) \
98 ipc_call_sync_fast((phoneid), (method), (arg1), (arg2), 0, 0, 0, 0, \
99 0, 0)
100#define ipc_call_sync_2_1(phoneid, method, arg1, arg2, res1) \
101 ipc_call_sync_fast((phoneid), (method), (arg1), (arg2), 0, (res1), 0, 0, \
102 0, 0)
103#define ipc_call_sync_2_2(phoneid, method, arg1, arg2, res1, res2) \
104 ipc_call_sync_fast((phoneid), (method), (arg1), (arg2), 0, (res1), \
105 (res2), 0, 0, 0)
106#define ipc_call_sync_2_3(phoneid, method, arg1, arg2, res1, res2, res3) \
107 ipc_call_sync_fast((phoneid), (method), (arg1), (arg2), 0, (res1), \
108 (res2), (res3), 0, 0)
109#define ipc_call_sync_2_4(phoneid, method, arg1, arg2, res1, res2, res3, \
110 res4) \
111 ipc_call_sync_fast((phoneid), (method), (arg1), (arg2), 0, (res1), \
112 (res2), (res3), (res4), 0)
113#define ipc_call_sync_2_5(phoneid, method, arg1, arg2, res1, res2, res3, \
114 res4, res5)\
115 ipc_call_sync_fast((phoneid), (method), (arg1), (arg2), 0, (res1), \
116 (res2), (res3), (res4), (res5))
117
118#define ipc_call_sync_3_0(phoneid, method, arg1, arg2, arg3) \
119 ipc_call_sync_fast((phoneid), (method), (arg1), (arg2), (arg3), 0, 0, 0, \
120 0, 0)
121#define ipc_call_sync_3_1(phoneid, method, arg1, arg2, arg3, res1) \
122 ipc_call_sync_fast((phoneid), (method), (arg1), (arg2), (arg3), (res1), \
123 0, 0, 0, 0)
124#define ipc_call_sync_3_2(phoneid, method, arg1, arg2, arg3, res1, res2) \
125 ipc_call_sync_fast((phoneid), (method), (arg1), (arg2), (arg3), (res1), \
126 (res2), 0, 0, 0)
127#define ipc_call_sync_3_3(phoneid, method, arg1, arg2, arg3, res1, res2, \
128 res3) \
129 ipc_call_sync_fast((phoneid), (method), (arg1), (arg2), (arg3), \
130 (res1), (res2), (res3), 0, 0)
131#define ipc_call_sync_3_4(phoneid, method, arg1, arg2, arg3, res1, res2, \
132 res3, res4) \
133 ipc_call_sync_fast((phoneid), (method), (arg1), (arg2), (arg3), \
134 (res1), (res2), (res3), (res4), 0)
135#define ipc_call_sync_3_5(phoneid, method, arg1, arg2, arg3, res1, res2, \
136 res3, res4, res5) \
137 ipc_call_sync_fast((phoneid), (method), (arg1), (arg2), (arg3), \
138 (res1), (res2), (res3), (res4), (res5))
139
140#define ipc_call_sync_4_0(phoneid, method, arg1, arg2, arg3, arg4) \
141 ipc_call_sync_slow((phoneid), (method), (arg1), (arg2), (arg3), (arg4), 0, \
142 0, 0, 0, 0, 0)
143#define ipc_call_sync_4_1(phoneid, method, arg1, arg2, arg3, arg4, res1) \
144 ipc_call_sync_slow((phoneid), (method), (arg1), (arg2), (arg3), (arg4), 0, \
145 (res1), 0, 0, 0, 0)
146#define ipc_call_sync_4_2(phoneid, method, arg1, arg2, arg3, arg4, res1, res2) \
147 ipc_call_sync_slow((phoneid), (method), (arg1), (arg2), (arg3), (arg4), 0, \
148 (res1), (res2), 0, 0, 0)
149#define ipc_call_sync_4_3(phoneid, method, arg1, arg2, arg3, arg4, res1, res2, \
150 res3) \
151 ipc_call_sync_slow((phoneid), (method), (arg1), (arg2), (arg3), \
152 (arg4), 0, (res1), (res2), (res3), 0, 0)
153#define ipc_call_sync_4_4(phoneid, method, arg1, arg2, arg3, arg4, res1, res2, \
154 res3, res4) \
155 ipc_call_sync_slow((phoneid), (method), (arg1), (arg2), (arg3), \
156 (arg4), 0, (res1), (res2), (res3), (res4), 0)
157#define ipc_call_sync_4_5(phoneid, method, arg1, arg2, arg3, arg4, res1, res2, \
158 res3, res4, res5) \
159 ipc_call_sync_slow((phoneid), (method), (arg1), (arg2), (arg3), \
160 (arg4), 0, (res1), (res2), (res3), (res4), (res5))
161
162#define ipc_call_sync_5_0(phoneid, method, arg1, arg2, arg3, arg4, arg5) \
163 ipc_call_sync_slow((phoneid), (method), (arg1), (arg2), (arg3), (arg4), \
164 (arg5), 0, 0, 0, 0, 0)
165#define ipc_call_sync_5_1(phoneid, method, arg1, arg2, arg3, arg4, arg5, res1) \
166 ipc_call_sync_slow((phoneid), (method), (arg1), (arg2), (arg3), (arg4), \
167 (arg5), (res1), 0, 0, 0, 0)
168#define ipc_call_sync_5_2(phoneid, method, arg1, arg2, arg3, arg4, arg5, res1, \
169 res2) \
170 ipc_call_sync_slow((phoneid), (method), (arg1), (arg2), (arg3), \
171 (arg4), (arg5), (res1), (res2), 0, 0, 0)
172#define ipc_call_sync_5_3(phoneid, method, arg1, arg2, arg3, arg4, arg5, res1, \
173 res2, res3) \
174 ipc_call_sync_slow((phoneid), (method), (arg1), (arg2), (arg3), \
175 (arg4), (arg5), (res1), (res2), (res3), 0, 0)
176#define ipc_call_sync_5_4(phoneid, method, arg1, arg2, arg3, arg4, arg5, res1, \
177 res2, res3, res4) \
178 ipc_call_sync_slow((phoneid), (method), (arg1), (arg2), (arg3), \
179 (arg4), (arg5), (res1), (res2), (res3), (res4), 0)
180#define ipc_call_sync_5_5(phoneid, method, arg1, arg2, arg3, arg4, arg5, res1, \
181 res2, res3, res4, res5) \
182 ipc_call_sync_slow((phoneid), (method), (arg1), (arg2), (arg3), \
183 (arg4), (arg5), (res1), (res2), (res3), (res4), (res5))
184
185extern int ipc_call_sync_fast(int, ipcarg_t, ipcarg_t, ipcarg_t, ipcarg_t,
186 ipcarg_t *, ipcarg_t *, ipcarg_t *, ipcarg_t *, ipcarg_t *);
187
188extern int ipc_call_sync_slow(int, ipcarg_t, ipcarg_t, ipcarg_t, ipcarg_t,
189 ipcarg_t, ipcarg_t, ipcarg_t *, ipcarg_t *, ipcarg_t *, ipcarg_t *,
190 ipcarg_t *);
191
192extern ipc_callid_t ipc_wait_cycle(ipc_call_t *, uint32_t, int);
193extern ipc_callid_t ipc_wait_for_call_timeout(ipc_call_t *, uint32_t);
194extern void ipc_poke(void);
195
196static inline ipc_callid_t ipc_wait_for_call(ipc_call_t *data)
197{
198 return ipc_wait_for_call_timeout(data, SYNCH_NO_TIMEOUT);
199}
200
201extern ipc_callid_t ipc_trywait_for_call(ipc_call_t *);
202
203/*
204 * User-friendly wrappers for ipc_answer_fast() and ipc_answer_slow().
205 * They are in the form of ipc_answer_m(), where m is the number of return
206 * arguments. The macros decide between the fast and the slow version according
207 * to m.
208 */
209#define ipc_answer_0(callid, retval) \
210 ipc_answer_fast((callid), (retval), 0, 0, 0, 0)
211#define ipc_answer_1(callid, retval, arg1) \
212 ipc_answer_fast((callid), (retval), (arg1), 0, 0, 0)
213#define ipc_answer_2(callid, retval, arg1, arg2) \
214 ipc_answer_fast((callid), (retval), (arg1), (arg2), 0, 0)
215#define ipc_answer_3(callid, retval, arg1, arg2, arg3) \
216 ipc_answer_fast((callid), (retval), (arg1), (arg2), (arg3), 0)
217#define ipc_answer_4(callid, retval, arg1, arg2, arg3, arg4) \
218 ipc_answer_fast((callid), (retval), (arg1), (arg2), (arg3), (arg4))
219#define ipc_answer_5(callid, retval, arg1, arg2, arg3, arg4, arg5) \
220 ipc_answer_slow((callid), (retval), (arg1), (arg2), (arg3), (arg4), (arg5))
221
222extern ipcarg_t ipc_answer_fast(ipc_callid_t, ipcarg_t, ipcarg_t, ipcarg_t,
223 ipcarg_t, ipcarg_t);
224extern ipcarg_t ipc_answer_slow(ipc_callid_t, ipcarg_t, ipcarg_t, ipcarg_t,
225 ipcarg_t, ipcarg_t, ipcarg_t);
226
227/*
228 * User-friendly wrappers for ipc_call_async_fast() and ipc_call_async_slow().
229 * They are in the form of ipc_call_async_m(), where m is the number of payload
230 * arguments. The macros decide between the fast and the slow version according
231 * to m.
232 */
233#define ipc_call_async_0(phoneid, method, private, callback, can_preempt) \
234 ipc_call_async_fast((phoneid), (method), 0, 0, 0, 0, (private), \
235 (callback), (can_preempt))
236#define ipc_call_async_1(phoneid, method, arg1, private, callback, \
237 can_preempt) \
238 ipc_call_async_fast((phoneid), (method), (arg1), 0, 0, 0, (private), \
239 (callback), (can_preempt))
240#define ipc_call_async_2(phoneid, method, arg1, arg2, private, callback, \
241 can_preempt) \
242 ipc_call_async_fast((phoneid), (method), (arg1), (arg2), 0, 0, \
243 (private), (callback), (can_preempt))
244#define ipc_call_async_3(phoneid, method, arg1, arg2, arg3, private, callback, \
245 can_preempt) \
246 ipc_call_async_fast((phoneid), (method), (arg1), (arg2), (arg3), 0, \
247 (private), (callback), (can_preempt))
248#define ipc_call_async_4(phoneid, method, arg1, arg2, arg3, arg4, private, \
249 callback, can_preempt) \
250 ipc_call_async_fast((phoneid), (method), (arg1), (arg2), (arg3), \
251 (arg4), (private), (callback), (can_preempt))
252#define ipc_call_async_5(phoneid, method, arg1, arg2, arg3, arg4, arg5, \
253 private, callback, can_preempt) \
254 ipc_call_async_slow((phoneid), (method), (arg1), (arg2), (arg3), \
255 (arg4), (arg5), (private), (callback), (can_preempt))
256
257extern void ipc_call_async_fast(int, ipcarg_t, ipcarg_t, ipcarg_t, ipcarg_t,
258 ipcarg_t, void *, ipc_async_callback_t, int);
259extern void ipc_call_async_slow(int, ipcarg_t, ipcarg_t, ipcarg_t, ipcarg_t,
260 ipcarg_t, ipcarg_t, void *, ipc_async_callback_t, int);
261
262extern int ipc_connect_to_me(int, int, int, int, ipcarg_t *);
263extern int ipc_connect_me_to(int, int, int, int);
264extern int ipc_connect_me_to_blocking(int, int, int, int);
265extern int ipc_hangup(int);
266extern int ipc_register_irq(int, int, int, irq_code_t *);
267extern int ipc_unregister_irq(int, int);
268extern int ipc_forward_fast(ipc_callid_t, int, int, ipcarg_t, ipcarg_t, int);
269extern int ipc_forward_slow(ipc_callid_t, int, int, ipcarg_t, ipcarg_t,
270 ipcarg_t, ipcarg_t, ipcarg_t, int);
271
272/*
273 * User-friendly wrappers for ipc_share_in_start().
274 */
275#define ipc_share_in_start_0_0(phoneid, dst, size) \
276 ipc_share_in_start((phoneid), (dst), (size), 0, NULL)
277#define ipc_share_in_start_0_1(phoneid, dst, size, flags) \
278 ipc_share_in_start((phoneid), (dst), (size), 0, (flags))
279#define ipc_share_in_start_1_0(phoneid, dst, size, arg) \
280 ipc_share_in_start((phoneid), (dst), (size), (arg), NULL)
281#define ipc_share_in_start_1_1(phoneid, dst, size, arg, flags) \
282 ipc_share_in_start((phoneid), (dst), (size), (arg), (flags))
283
284extern int ipc_share_in_start(int, void *, size_t, ipcarg_t, int *);
285extern int ipc_share_in_finalize(ipc_callid_t, void *, int );
286extern int ipc_share_out_start(int, void *, int);
287extern int ipc_share_out_finalize(ipc_callid_t, void *);
288extern int ipc_data_read_start(int, void *, size_t);
289extern int ipc_data_read_finalize(ipc_callid_t, const void *, size_t);
290extern int ipc_data_write_start(int, const void *, size_t);
291extern int ipc_data_write_finalize(ipc_callid_t, void *, size_t);
292
293extern int ipc_connect_kbox(task_id_t);
294
295#endif
296
297/** @}
298 */
Note: See TracBrowser for help on using the repository browser.