source: mainline/uspace/lib/c/include/ipc/ipc.h@ 09696b54

lfn serial ticket/834-toolchain-update topic/msim-upgrade topic/simplify-dev-export
Last change on this file since 09696b54 was 10477601, checked in by Martin Decky <martin@…>, 14 years ago

cstyle changes (improve comments, use unsigned types for bit flags, etc.)
no change in functionality

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