Subversion Repositories HelenOS

Rev

Rev 2588 | Rev 2618 | Go to most recent revision | Only display areas with differences | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed

Rev 2588 Rev 2615
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 libcipc
 29 
/** @addtogroup libcipc
30 
 * @{
 30 
 * @{
31 
 */
 31 
 */
32 
/** @file
 32 
/** @file
33 
 */
 33 
 */
34 
 
 34 
 
35 
#ifndef LIBIPC_IPC_H_
 35 
#ifndef LIBIPC_IPC_H_
36 
#define LIBIPC_IPC_H_
 36 
#define LIBIPC_IPC_H_
37 
 
 37 
 
38 
#include <kernel/ipc/ipc.h>
 38 
#include <kernel/ipc/ipc.h>
39 
#include <kernel/ddi/irq.h>
 39 
#include <kernel/ddi/irq.h>
40 
#include <libc.h>
 40 
#include <libc.h>
41 
#include <sys/types.h>
 41 
#include <sys/types.h>
42 
#include <kernel/synch/synch.h>
 42 
#include <kernel/synch/synch.h>
43 
 
 43 
 
44 
typedef sysarg_t ipcarg_t;
 44 
typedef sysarg_t ipcarg_t;
45 
typedef struct {
 45 
typedef struct {
46 
    ipcarg_t args[IPC_CALL_LEN];
 46 
    ipcarg_t args[IPC_CALL_LEN];
47 
    ipcarg_t in_phone_hash;
 47 
    ipcarg_t in_phone_hash;
48 
} ipc_call_t;
 48 
} ipc_call_t;
49 
typedef sysarg_t ipc_callid_t;
 49 
typedef sysarg_t ipc_callid_t;
50 
 
 50 
 
51 
typedef void (* ipc_async_callback_t)(void *private, int retval,
 51 
typedef void (* ipc_async_callback_t)(void *private, int retval,
52 
    ipc_call_t *data);
 52 
    ipc_call_t *data);
53 
 
 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)
54 
#define ipc_call_sync_2(phoneid, method, arg1, arg2, res1, res2) \
 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)\
55 
    ipc_call_sync_3((phoneid), (method), (arg1), (arg2), 0, (res1), \
 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, \
56 
        (res2), 0)
 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 
 
57 
extern int ipc_call_sync_3(int phoneid, ipcarg_t method, ipcarg_t arg1,
 177 
extern int ipc_call_sync_fast(int phoneid, ipcarg_t method, ipcarg_t arg1,
58 
    ipcarg_t arg2, ipcarg_t arg3, ipcarg_t *result1, ipcarg_t *result2,
 178 
    ipcarg_t arg2, ipcarg_t arg3, ipcarg_t *result1, ipcarg_t *result2,
- 
 
 179 
    ipcarg_t *result3, ipcarg_t *result4, ipcarg_t *result5);
- 
 
 180 
 
- 
 
 181 
extern 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,
59 
    ipcarg_t *result3);
 184 
    ipcarg_t *result5);
60 
 
 185 
 
61 
extern int ipc_call_sync(int phoneid, ipcarg_t method, ipcarg_t arg1,
 - 
 
62 
    ipcarg_t *result);
 - 
 
63 
 
 186 
 
64 
extern ipc_callid_t ipc_wait_cycle(ipc_call_t *call, uint32_t usec, int flags);
 187 
extern ipc_callid_t ipc_wait_cycle(ipc_call_t *call, uint32_t usec, int flags);
65 
extern ipc_callid_t ipc_wait_for_call_timeout(ipc_call_t *data, uint32_t usec);
 188 
extern ipc_callid_t ipc_wait_for_call_timeout(ipc_call_t *data, uint32_t usec);
66 
static inline ipc_callid_t ipc_wait_for_call(ipc_call_t *data)
 189 
static inline ipc_callid_t ipc_wait_for_call(ipc_call_t *data)
67 
{
 190 
{
68 
    return ipc_wait_for_call_timeout(data, SYNCH_NO_TIMEOUT);
 191 
    return ipc_wait_for_call_timeout(data, SYNCH_NO_TIMEOUT);
69 
}
 192 
}
70 
extern ipc_callid_t ipc_trywait_for_call(ipc_call_t *data);
 193 
extern ipc_callid_t ipc_trywait_for_call(ipc_call_t *data);
71 
 
 194 
 
72 
#define ipc_answer_fast_0(callid, retval) \
 195 
#define ipc_answer_fast_0(callid, retval) \
73 
    ipc_answer_fast((callid), (retval), 0, 0)
 196 
    ipc_answer_fast((callid), (retval), 0, 0)
74 
#define ipc_answer_fast_1(callid, retval, arg1) \
 197 
#define ipc_answer_fast_1(callid, retval, arg1) \
75 
    ipc_answer_fast((callid), (retval), (arg1), 0)
 198 
    ipc_answer_fast((callid), (retval), (arg1), 0)
76 
extern ipcarg_t ipc_answer_fast(ipc_callid_t callid, ipcarg_t retval,
 199 
extern ipcarg_t ipc_answer_fast(ipc_callid_t callid, ipcarg_t retval,
77 
    ipcarg_t arg1, ipcarg_t arg2);
 200 
    ipcarg_t arg1, ipcarg_t arg2);
78 
extern ipcarg_t ipc_answer(ipc_callid_t callid, ipc_call_t *call);
 201 
extern ipcarg_t ipc_answer(ipc_callid_t callid, ipc_call_t *call);
79 
 
 202 
 
80 
#define ipc_call_async(phoneid, method, arg1, private, callback, can_preempt) \
 203 
#define ipc_call_async(phoneid, method, arg1, private, callback, can_preempt) \
81 
    (ipc_call_async_2(phoneid, method, arg1, 0, private, callback, can_preempt))
 204 
    (ipc_call_async_2(phoneid, method, arg1, 0, private, callback, can_preempt))
82 
extern void ipc_call_async_2(int phoneid, ipcarg_t method, ipcarg_t arg1,
 205 
extern void ipc_call_async_2(int phoneid, ipcarg_t method, ipcarg_t arg1,
83 
    ipcarg_t arg2, void *private, ipc_async_callback_t callback,
 206 
    ipcarg_t arg2, void *private, ipc_async_callback_t callback,
84 
    int can_preempt);
 207 
    int can_preempt);
85 
extern void ipc_call_async_3(int phoneid, ipcarg_t method, ipcarg_t arg1,
 208 
extern void ipc_call_async_3(int phoneid, ipcarg_t method, ipcarg_t arg1,
86 
    ipcarg_t arg2, ipcarg_t arg3, void *private, ipc_async_callback_t callback,
 209 
    ipcarg_t arg2, ipcarg_t arg3, void *private, ipc_async_callback_t callback,
87 
    int can_preempt);
 210 
    int can_preempt);
88 
 
 211 
 
89 
extern int ipc_connect_to_me(int phoneid, int arg1, int arg2, ipcarg_t *phone);
 212 
extern int ipc_connect_to_me(int phoneid, int arg1, int arg2, ipcarg_t *phone);
90 
extern int ipc_connect_me_to(int phoneid, int arg1, int arg2);
 213 
extern int ipc_connect_me_to(int phoneid, int arg1, int arg2);
91 
extern int ipc_hangup(int phoneid);
 214 
extern int ipc_hangup(int phoneid);
92 
extern int ipc_register_irq(int inr, int devno, int method, irq_code_t *code);
 215 
extern int ipc_register_irq(int inr, int devno, int method, irq_code_t *code);
93 
extern int ipc_unregister_irq(int inr, int devno);
 216 
extern int ipc_unregister_irq(int inr, int devno);
94 
extern int ipc_forward_fast(ipc_callid_t callid, int phoneid, int method,
 217 
extern int ipc_forward_fast(ipc_callid_t callid, int phoneid, int method,
95 
    ipcarg_t arg1);
 218 
    ipcarg_t arg1);
96 
extern int ipc_data_send(int phoneid, void *src, size_t size);
 219 
extern int ipc_data_send(int phoneid, void *src, size_t size);
97 
extern int ipc_data_receive(ipc_callid_t *callid, ipc_call_t *call, void **dst,
 220 
extern int ipc_data_receive(ipc_callid_t *callid, ipc_call_t *call, void **dst,
98 
    size_t *size);
 221 
    size_t *size);
99 
extern ipcarg_t ipc_data_deliver(ipc_callid_t callid, ipc_call_t *call,
 222 
extern ipcarg_t ipc_data_deliver(ipc_callid_t callid, ipc_call_t *call,
100 
    void *dst, size_t size);
 223 
    void *dst, size_t size);
101 
 
 224 
 
102 
#endif
 225 
#endif
103 
 
 226 
 
104 
/** @}
 227 
/** @}
105 
 */
 228 
 */
106 
 
 229