Subversion Repositories HelenOS

Rev

Rev 959 | Rev 998 | Go to most recent revision | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
955 palkovsky 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
#ifndef __IPC_H__
30
#define __IPC_H__
31
 
965 palkovsky 32
/* Length of data being transfered with IPC call */
33
/* - the uspace may not be able to utilize full length */
34
#define IPC_CALL_LEN    4
955 palkovsky 35
 
36
/* Flags for calls */
965 palkovsky 37
#define IPC_CALL_ANSWERED      1 /**< This is answer to a call */
38
#define IPC_CALL_STATIC_ALLOC  2 /**< This call will not be freed on error */
39
 
955 palkovsky 40
/* Flags for ipc_wait_for_call */
965 palkovsky 41
#define IPC_WAIT_NONBLOCKING   1
955 palkovsky 42
 
965 palkovsky 43
/* Flags of callid */
44
#define IPC_CALLID_ANSWERED  1
45
 
46
/* Return values from IPC_ASYNC */
47
#define IPC_CALLRET_FATAL         -1
48
#define IPC_CALLRET_TEMPORARY     -2
49
 
50
 
51
/* Macros for manipulating calling data */
52
#define IPC_SET_RETVAL(data, retval)   ((data)[0] = (retval))
53
#define IPC_SET_METHOD(data, val)   ((data)[0] = (val))
54
#define IPC_SET_ARG1(data, val)   ((data)[1] = (val))
55
#define IPC_SET_ARG2(data, val)   ((data)[2] = (val))
56
#define IPC_SET_ARG3(data, val)   ((data)[3] = (val))
57
 
58
#define IPC_GET_METHOD(data)           ((data)[0])
59
#define IPC_GET_RETVAL(data)           ((data)[0])
60
 
61
#define IPC_GET_ARG1(data)              ((data)[1])
62
#define IPC_GET_ARG2(data)              ((data)[2])
63
#define IPC_GET_ARG3(data)              ((data)[3])
64
 
65
/* Well known phone descriptors */
66
#define PHONE_NS              0
67
 
955 palkovsky 68
#ifdef KERNEL
69
 
965 palkovsky 70
#include <synch/mutex.h>
71
#include <synch/condvar.h>
955 palkovsky 72
#include <adt/list.h>
73
 
74
#define IPC_MAX_PHONES  16
75
 
76
 
77
typedef struct answerbox answerbox_t;
78
 
79
typedef struct {
80
    link_t list;
81
    answerbox_t *callerbox;
82
    int flags;
83
    __native data[IPC_CALL_LEN];
84
} call_t;
85
 
86
struct answerbox {
87
    SPINLOCK_DECLARE(lock);
88
 
965 palkovsky 89
    mutex_t mutex;
90
    condvar_t cv;
955 palkovsky 91
 
92
    link_t connected_phones; /**< Phones connected to this answerbox */
93
    link_t calls;            /**< Received calls */
94
    link_t dispatched_calls; /* Should be hash table in the future */
95
 
96
    link_t answers;          /**< Answered calls */
97
};
98
 
99
typedef struct {
100
    SPINLOCK_DECLARE(lock);
101
    link_t list;
102
    answerbox_t *callee;
103
} phone_t;
104
 
105
extern void ipc_init(void);
106
extern call_t * ipc_wait_for_call(answerbox_t *box, int flags);
107
extern void ipc_answer(answerbox_t *box, call_t *request);
108
extern void ipc_call(phone_t *phone, call_t *request);
959 palkovsky 109
extern void ipc_call_sync(phone_t *phone, call_t *request);
955 palkovsky 110
extern void ipc_phone_destroy(phone_t *phone);
111
extern void ipc_phone_init(phone_t *phone, answerbox_t *box);
112
extern void ipc_call_free(call_t *call);
113
extern call_t * ipc_call_alloc(void);
965 palkovsky 114
extern void ipc_answerbox_init(answerbox_t *box);
115
extern void ipc_phone_init(phone_t *phone, answerbox_t *box);
116
extern void ipc_call_init(call_t *call);
955 palkovsky 117
 
965 palkovsky 118
extern answerbox_t *ipc_phone_0;
955 palkovsky 119
 
120
#endif
121
 
122
#endif