source: mainline/uspace/lib/libc/include/ipc/ipc.h@ 2e51969

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

Modify synchronous IPC to make use of all six syscall arguments. The preferred
means of synchronous communication is now via the set of ipc_call_sync_m_n()
macros, where m is the number of payload arguments passed to the kernel and n is
the number of return values. These macros will automatically decide between the
fast and the universal slow version of ipc_call_sync.
  • Property mode set to 100644
File size: 10.6 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 <kernel/ipc/ipc.h>
39#include <kernel/ddi/irq.h>
40#include <libc.h>
41#include <sys/types.h>
42#include <kernel/synch/synch.h>
43
44typedef sysarg_t ipcarg_t;
45typedef struct {
46 ipcarg_t args[IPC_CALL_LEN];
47 ipcarg_t in_phone_hash;
48} ipc_call_t;
49typedef sysarg_t ipc_callid_t;
50
51typedef void (* ipc_async_callback_t)(void *private, int retval,
52 ipc_call_t *data);
53
54/*
55 * User-friendly wrappers for ipc_call_sync_fast() and ipc_call_sync_slow().
56 * They are in the form ipc_call_sync_m_n(), where m denotes the number of
57 * arguments of payload and n denotes number of return values. Whenever
58 * possible, the fast version is used.
59 */
60#define ipc_call_sync_0_0(phoneid, method) \
61 ipc_call_sync_fast((phoneid), (method), 0, 0, 0, 0, 0, 0, 0, 0)
62#define ipc_call_sync_0_1(phoneid, method, res1) \
63 ipc_call_sync_fast((phoneid), (method), 0, 0, 0, (res1), 0, 0, 0, 0)
64#define ipc_call_sync_0_2(phoneid, method, res1, res2) \
65 ipc_call_sync_fast((phoneid), (method), 0, 0, 0, (res1), (res2), 0, 0, 0)
66#define ipc_call_sync_0_3(phoneid, method, res1, res2, res3) \
67 ipc_call_sync_fast((phoneid), (method), 0, 0, 0, (res1), (res2), (res3), \
68 0, 0)
69#define ipc_call_sync_0_4(phoneid, method, res1, res2, res3, res4) \
70 ipc_call_sync_fast((phoneid), (method), 0, 0, 0, (res1), (res2), (res3), \
71 (res4), 0)
72#define ipc_call_sync_0_5(phoneid, method, res1, res2, res3, res4, res5) \
73 ipc_call_sync_fast((phoneid), (method), 0, 0, 0, (res1), (res2), (res3), \
74 (res4), (res5))
75#define ipc_call_sync_1_0(phoneid, method, arg1) \
76 ipc_call_sync_fast((phoneid), (method), (arg1), 0, 0, 0, 0, 0, 0, 0)
77#define ipc_call_sync_1_1(phoneid, method, arg1, res1) \
78 ipc_call_sync_fast((phoneid), (method), (arg1), 0, 0, (res1), 0, 0, 0, 0)
79#define ipc_call_sync_1_2(phoneid, method, arg1, res1, res2) \
80 ipc_call_sync_fast((phoneid), (method), (arg1), 0, 0, (res1), (res2), 0, \
81 0, 0)
82#define ipc_call_sync_1_3(phoneid, method, arg1, res1, res2, res3) \
83 ipc_call_sync_fast((phoneid), (method), (arg1), 0, 0, (res1), (res2), \
84 (res3), 0, 0)
85#define ipc_call_sync_1_4(phoneid, method, arg1, res1, res2, res3, res4) \
86 ipc_call_sync_fast((phoneid), (method), (arg1), 0, 0, (res1), (res2), \
87 (res3), (res4), 0)
88#define ipc_call_sync_1_5(phoneid, method, arg1, res1, res2, res3, res4, \
89 res5) \
90 ipc_call_sync_fast((phoneid), (method), (arg1), 0, 0, (res1), (res2), \
91 (res3), (res4), (res5))
92#define ipc_call_sync_2_0(phoneid, method, arg1, arg2) \
93 ipc_call_sync_fast((phoneid), (method), (arg1), (arg2), 0, 0, 0, 0, \
94 0, 0)
95#define ipc_call_sync_2_1(phoneid, method, arg1, arg2, res1) \
96 ipc_call_sync_fast((phoneid), (method), (arg1), (arg2), 0, (res1), 0, 0, \
97 0, 0)
98#define ipc_call_sync_2_2(phoneid, method, arg1, arg2, res1, res2) \
99 ipc_call_sync_fast((phoneid), (method), (arg1), (arg2), 0, (res1), \
100 (res2), 0, 0, 0)
101#define ipc_call_sync_2_3(phoneid, method, arg1, arg2, res1, res2, res3) \
102 ipc_call_sync_fast((phoneid), (method), (arg1), (arg2), 0, (res1), \
103 (res2), (res3), 0, 0)
104#define ipc_call_sync_2_4(phoneid, method, arg1, arg2, res1, res2, res3, \
105 res4) \
106 ipc_call_sync_fast((phoneid), (method), (arg1), (arg2), 0, (res1), \
107 (res2), (res3), (res4), 0)
108#define ipc_call_sync_2_5(phoneid, method, arg1, arg2, res1, res2, res3, \
109 res4, res5)\
110 ipc_call_sync_fast((phoneid), (method), (arg1), (arg2), 0, (res1), \
111 (res2), (res3), (res4), (res5))
112#define ipc_call_sync_3_0(phoneid, method, arg1, arg2, arg3) \
113 ipc_call_sync_fast((phoneid), (method), (arg1), (arg2), (arg3), 0, 0, 0, \
114 0, 0)
115#define ipc_call_sync_3_1(phoneid, method, arg1, arg2, arg3, res1) \
116 ipc_call_sync_fast((phoneid), (method), (arg1), (arg2), (arg3), (res1), \
117 0, 0, 0, 0)
118#define ipc_call_sync_3_2(phoneid, method, arg1, arg2, arg3, res1, res2) \
119 ipc_call_sync_fast((phoneid), (method), (arg1), (arg2), (arg3), (res1), \
120 (res2), 0, 0, 0)
121#define ipc_call_sync_3_3(phoneid, method, arg1, arg2, arg3, res1, res2, \
122 res3) \
123 ipc_call_sync_fast((phoneid), (method), (arg1), (arg2), (arg3), \
124 (res1), (res2), (res3), 0, 0)
125#define ipc_call_sync_3_4(phoneid, method, arg1, arg2, arg3, res1, res2, \
126 res3, res4) \
127 ipc_call_sync_fast((phoneid), (method), (arg1), (arg2), (arg3), \
128 (res1), (res2), (res3), (res4), 0)
129#define ipc_call_sync_3_5(phoneid, method, arg1, arg2, arg3, res1, res2, \
130 res3, res4, res5) \
131 ipc_call_sync_fast((phoneid), (method), (arg1), (arg2), (arg3), \
132 (res1), (res2), (res3), (res4), (res5))
133#define ipc_call_sync_4_0(phoneid, method, arg1, arg2, arg3, arg4) \
134 ipc_call_sync_slow((phoneid), (method), (arg1), (arg2), (arg3), (arg4), \
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), \
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), \
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), (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), (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), (res1), (res2), (res3), (res4), (res5))
154#define ipc_call_sync_5_0(phoneid, method, arg1, arg2, arg3, arg4, arg5) \
155 ipc_call_sync_slow((phoneid), (method), (arg1), (arg2), (arg3), (arg4), \
156 (arg5), 0, 0, 0, 0, 0)
157#define ipc_call_sync_5_1(phoneid, method, arg1, arg2, arg3, arg4, arg5, res1) \
158 ipc_call_sync_slow((phoneid), (method), (arg1), (arg2), (arg3), (arg4), \
159 (arg5), (res1), 0, 0, 0, 0)
160#define ipc_call_sync_5_2(phoneid, method, arg1, arg2, arg3, arg4, arg5, res1, \
161 res2) \
162 ipc_call_sync_slow((phoneid), (method), (arg1), (arg2), (arg3), \
163 (arg4), (arg5), (res1), (res2), 0, 0, 0)
164#define ipc_call_sync_5_3(phoneid, method, arg1, arg2, arg3, arg4, arg5, res1, \
165 res2, res3) \
166 ipc_call_sync_slow((phoneid), (method), (arg1), (arg2), (arg3), \
167 (arg4), (arg5), (res1), (res2), (res3), 0, 0)
168#define ipc_call_sync_5_4(phoneid, method, arg1, arg2, arg3, arg4, arg5, res1, \
169 res2, res3, res4) \
170 ipc_call_sync_slow((phoneid), (method), (arg1), (arg2), (arg3), \
171 (arg4), (arg5), (res1), (res2), (res3), (res4), 0)
172#define ipc_call_sync_5_5(phoneid, method, arg1, arg2, arg3, arg4, arg5, res1, \
173 res2, res3, res4, res5) \
174 ipc_call_sync_slow((phoneid), (method), (arg1), (arg2), (arg3), \
175 (arg4), (arg5), (res1), (res2), (res3), (res4), (res5))
176
177extern int ipc_call_sync_fast(int phoneid, ipcarg_t method, ipcarg_t arg1,
178 ipcarg_t arg2, ipcarg_t arg3, ipcarg_t *result1, ipcarg_t *result2,
179 ipcarg_t *result3, ipcarg_t *result4, ipcarg_t *result5);
180
181extern int ipc_call_sync_slow(int phoneid, ipcarg_t method, ipcarg_t arg1,
182 ipcarg_t arg2, ipcarg_t arg3, ipcarg_t arg4, ipcarg_t arg5,
183 ipcarg_t *result1, ipcarg_t *result2, ipcarg_t *result3, ipcarg_t *result4,
184 ipcarg_t *result5);
185
186
187extern ipc_callid_t ipc_wait_cycle(ipc_call_t *call, uint32_t usec, int flags);
188extern ipc_callid_t ipc_wait_for_call_timeout(ipc_call_t *data, uint32_t usec);
189static inline ipc_callid_t ipc_wait_for_call(ipc_call_t *data)
190{
191 return ipc_wait_for_call_timeout(data, SYNCH_NO_TIMEOUT);
192}
193extern ipc_callid_t ipc_trywait_for_call(ipc_call_t *data);
194
195#define ipc_answer_fast_0(callid, retval) \
196 ipc_answer_fast((callid), (retval), 0, 0)
197#define ipc_answer_fast_1(callid, retval, arg1) \
198 ipc_answer_fast((callid), (retval), (arg1), 0)
199extern ipcarg_t ipc_answer_fast(ipc_callid_t callid, ipcarg_t retval,
200 ipcarg_t arg1, ipcarg_t arg2);
201extern ipcarg_t ipc_answer(ipc_callid_t callid, ipc_call_t *call);
202
203#define ipc_call_async(phoneid, method, arg1, private, callback, can_preempt) \
204 (ipc_call_async_2(phoneid, method, arg1, 0, private, callback, can_preempt))
205extern void ipc_call_async_2(int phoneid, ipcarg_t method, ipcarg_t arg1,
206 ipcarg_t arg2, void *private, ipc_async_callback_t callback,
207 int can_preempt);
208extern void ipc_call_async_3(int phoneid, ipcarg_t method, ipcarg_t arg1,
209 ipcarg_t arg2, ipcarg_t arg3, void *private, ipc_async_callback_t callback,
210 int can_preempt);
211
212extern int ipc_connect_to_me(int phoneid, int arg1, int arg2, ipcarg_t *phone);
213extern int ipc_connect_me_to(int phoneid, int arg1, int arg2);
214extern int ipc_hangup(int phoneid);
215extern int ipc_register_irq(int inr, int devno, int method, irq_code_t *code);
216extern int ipc_unregister_irq(int inr, int devno);
217extern int ipc_forward_fast(ipc_callid_t callid, int phoneid, int method,
218 ipcarg_t arg1);
219extern int ipc_data_send(int phoneid, void *src, size_t size);
220extern int ipc_data_receive(ipc_callid_t *callid, ipc_call_t *call, void **dst,
221 size_t *size);
222extern ipcarg_t ipc_data_deliver(ipc_callid_t callid, ipc_call_t *call,
223 void *dst, size_t size);
224
225#endif
226
227/** @}
228 */
Note: See TracBrowser for help on using the repository browser.