WebSVN – HelenOS – Diff – /trunk/uspace/lib/libc/include/ipc/ipc.h


/*
 * Copyright (c) 2006 Ondrej Palkovsky
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * - Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 * - Redistributions in binary form must reproduce the above copyright
 *   notice, this list of conditions and the following disclaimer in the
 *   documentation and/or other materials provided with the distribution.
 * - The name of the author may not be used to endorse or promote products
 *   derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
 
/** @addtogroup libcipc
 * @{
 */
/** @file
 */
 
#ifndef LIBIPC_IPC_H_
#define LIBIPC_IPC_H_
 
#include <kernel/ipc/ipc.h>
#include <kernel/ddi/irq.h>
#include <libc.h>
#include <sys/types.h>
#include <kernel/synch/synch.h>
 
typedef sysarg_t ipcarg_t;
typedef struct {
    ipcarg_t args[IPC_CALL_LEN];
    ipcarg_t in_phone_hash;
} ipc_call_t;
typedef sysarg_t ipc_callid_t;
 
typedef void (* ipc_async_callback_t)(void *private, int retval,
    ipc_call_t *data);
 
#define ipc_call_sync_2(phoneid, method, arg1, arg2, res1, res2) \
    ipc_call_sync_3((phoneid), (method), (arg1), (arg2), 0, (res1), (res2), \
        0)
extern int ipc_call_sync_3(int phoneid, ipcarg_t method, ipcarg_t arg1,
    ipcarg_t arg2, ipcarg_t arg3, ipcarg_t *result1, ipcarg_t *result2,
    ipcarg_t *result3);
 
extern int ipc_call_sync(int phoneid, ipcarg_t method, ipcarg_t arg1,
    ipcarg_t *result);
 
extern ipc_callid_t ipc_wait_cycle(ipc_call_t *call, uint32_t usec, int flags);
extern ipc_callid_t ipc_wait_for_call_timeout(ipc_call_t *data, uint32_t usec);
static inline ipc_callid_t ipc_wait_for_call(ipc_call_t *data)
{
    return ipc_wait_for_call_timeout(data, SYNCH_NO_TIMEOUT);
}
extern ipc_callid_t ipc_trywait_for_call(ipc_call_t *data);
 
extern ipcarg_t ipc_answer_fast(ipc_callid_t callid, ipcarg_t retval,
    ipcarg_t arg1, ipcarg_t arg2);
extern ipcarg_t ipc_answer(ipc_callid_t callid, ipc_call_t *call);
 
#define ipc_call_async(phoneid, method, arg1, private, callback, can_preempt) \
    (ipc_call_async_2(phoneid, method, arg1, 0, private, callback, can_preempt))
extern void ipc_call_async_2(int phoneid, ipcarg_t method, ipcarg_t arg1,
    ipcarg_t arg2, void *private, ipc_async_callback_t callback,
    int can_preempt);
extern void ipc_call_async_3(int phoneid, ipcarg_t method, ipcarg_t arg1,
    ipcarg_t arg2, ipcarg_t arg3, void *private, ipc_async_callback_t callback,
    int can_preempt);
 
extern int ipc_connect_to_me(int phoneid, int arg1, int arg2, ipcarg_t *phone);
extern int ipc_connect_me_to(int phoneid, int arg1, int arg2);
extern int ipc_hangup(int phoneid);
extern int ipc_register_irq(int inr, int devno, int method, irq_code_t *code);
extern int ipc_unregister_irq(int inr, int devno);
extern int ipc_forward_fast(ipc_callid_t callid, int phoneid, int method,
    ipcarg_t arg1);
extern int ipc_data_send(int phoneid, void *src, size_t size);
extern int ipc_data_receive(ipc_callid_t *callid, ipc_call_t *call, void **dst,
    size_t *size);
extern ipcarg_t ipc_data_deliver(ipc_callid_t callid, ipc_call_t *call,
    void *dst, size_t size);
 
#endif
 
/** @}
 */
 

Subversion Repositories HelenOS

(root)/trunk/uspace/lib/libc/include/ipc/ipc.h @ 3334 – Rev 2531 → 2541

Rev 2531		Rev 2541
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 <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	#define ipc_call_sync_2(phoneid, method, arg1, arg2, res1, res2) \	54	#define ipc_call_sync_2(phoneid, method, arg1, arg2, res1, res2) \
55	ipc_call_sync_3((phoneid), (method), (arg1), (arg2), 0, (res1), (res2), \	55	ipc_call_sync_3((phoneid), (method), (arg1), (arg2), 0, (res1), (res2), \
56	0)	56	0)
57	extern int ipc_call_sync_3(int phoneid, ipcarg_t method, ipcarg_t arg1,	57	extern int ipc_call_sync_3(int phoneid, ipcarg_t method, ipcarg_t arg1,
58	ipcarg_t arg2, ipcarg_t arg3, ipcarg_t result1, ipcarg_t result2,	58	ipcarg_t arg2, ipcarg_t arg3, ipcarg_t result1, ipcarg_t result2,
59	ipcarg_t *result3);	59	ipcarg_t *result3);
60		60
61	extern int ipc_call_sync(int phoneid, ipcarg_t method, ipcarg_t arg1,	61	extern int ipc_call_sync(int phoneid, ipcarg_t method, ipcarg_t arg1,
62	ipcarg_t *result);	62	ipcarg_t *result);
63		63
64	extern ipc_callid_t ipc_wait_cycle(ipc_call_t *call, uint32_t usec, int flags);	64	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);	65	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)	66	static inline ipc_callid_t ipc_wait_for_call(ipc_call_t *data)
67	{	67	{
68	return ipc_wait_for_call_timeout(data, SYNCH_NO_TIMEOUT);	68	return ipc_wait_for_call_timeout(data, SYNCH_NO_TIMEOUT);
69	}	69	}
70	extern ipc_callid_t ipc_trywait_for_call(ipc_call_t *data);	70	extern ipc_callid_t ipc_trywait_for_call(ipc_call_t *data);
71		71
72	extern ipcarg_t ipc_answer_fast(ipc_callid_t callid, ipcarg_t retval,	72	extern ipcarg_t ipc_answer_fast(ipc_callid_t callid, ipcarg_t retval,
73	ipcarg_t arg1, ipcarg_t arg2);	73	ipcarg_t arg1, ipcarg_t arg2);
74	extern ipcarg_t ipc_answer(ipc_callid_t callid, ipc_call_t *call);	74	extern ipcarg_t ipc_answer(ipc_callid_t callid, ipc_call_t *call);
75		75
76	#define ipc_call_async(phoneid, method, arg1, private, callback, can_preempt) \	76	#define ipc_call_async(phoneid, method, arg1, private, callback, can_preempt) \
77	(ipc_call_async_2(phoneid, method, arg1, 0, private, callback, can_preempt))	77	(ipc_call_async_2(phoneid, method, arg1, 0, private, callback, can_preempt))
78	extern void ipc_call_async_2(int phoneid, ipcarg_t method, ipcarg_t arg1,	78	extern void ipc_call_async_2(int phoneid, ipcarg_t method, ipcarg_t arg1,
79	ipcarg_t arg2, void *private, ipc_async_callback_t callback,	79	ipcarg_t arg2, void *private, ipc_async_callback_t callback,
80	int can_preempt);	80	int can_preempt);
81	extern void ipc_call_async_3(int phoneid, ipcarg_t method, ipcarg_t arg1,	81	extern void ipc_call_async_3(int phoneid, ipcarg_t method, ipcarg_t arg1,
82	ipcarg_t arg2, ipcarg_t arg3, void *private, ipc_async_callback_t callback,	82	ipcarg_t arg2, ipcarg_t arg3, void *private, ipc_async_callback_t callback,
83	int can_preempt);	83	int can_preempt);
84		84
85	extern int ipc_connect_to_me(int phoneid, int arg1, int arg2, ipcarg_t *phone);	85	extern int ipc_connect_to_me(int phoneid, int arg1, int arg2, ipcarg_t *phone);
86	extern int ipc_connect_me_to(int phoneid, int arg1, int arg2);	86	extern int ipc_connect_me_to(int phoneid, int arg1, int arg2);
87	extern int ipc_hangup(int phoneid);	87	extern int ipc_hangup(int phoneid);
88	extern int ipc_register_irq(int inr, int devno, int method, irq_code_t *code);	88	extern int ipc_register_irq(int inr, int devno, int method, irq_code_t *code);
89	extern int ipc_unregister_irq(int inr, int devno);	89	extern int ipc_unregister_irq(int inr, int devno);
90	extern int ipc_forward_fast(ipc_callid_t callid, int phoneid, int method,	90	extern int ipc_forward_fast(ipc_callid_t callid, int phoneid, int method,
91	ipcarg_t arg1);	91	ipcarg_t arg1);
92	extern int ipc_data_send(int phoneid, void *src, size_t size);	92	extern int ipc_data_send(int phoneid, void *src, size_t size);
93	extern int ipc_data_receive(ipc_callid_t callid, ipc_call_t call, void **dst,	93	extern int ipc_data_receive(ipc_callid_t callid, ipc_call_t call, void **dst,
94	size_t *size);	94	size_t *size);
95	extern ipcarg_t ipc_data_deliver(ipc_callid_t callid, ipc_call_t *call,	95	extern ipcarg_t ipc_data_deliver(ipc_callid_t callid, ipc_call_t *call,
96	void *dst, size_t size);	96	void *dst, size_t size);
97		97
98	#endif	98	#endif
99		99
100	/** @}	100	/** @}
101	*/	101	*/
102		102