source: mainline/kernel/generic/include/ipc/ipc.h@ 921b84f

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

Track client data by client task ID instead of client task hash.
  • Property mode set to 100644
File size: 4.5 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 genericipc
30 * @{
31 */
32/** @file
33 */
34
35#ifndef KERN_IPC_H_
36#define KERN_IPC_H_
37
38#include <abi/ipc/ipc.h>
39#include <synch/spinlock.h>
40#include <synch/mutex.h>
41#include <synch/waitq.h>
42#include <typedefs.h>
43
44#define IPC_MAX_PHONES 32
45
46struct answerbox;
47struct task;
48
49typedef enum {
50 /** Phone is free and can be allocated */
51 IPC_PHONE_FREE = 0,
52 /** Phone is connecting somewhere */
53 IPC_PHONE_CONNECTING,
54 /** Phone is connected */
55 IPC_PHONE_CONNECTED,
56 /** Phone is hung up, waiting for answers to come */
57 IPC_PHONE_HUNGUP,
58 /** Phone was hungup from server */
59 IPC_PHONE_SLAMMED
60} ipc_phone_state_t;
61
62/** Structure identifying phone (in TASK structure) */
63typedef struct {
64 mutex_t lock;
65 link_t link;
66 struct answerbox *callee;
67 ipc_phone_state_t state;
68 atomic_t active_calls;
69} phone_t;
70
71typedef struct answerbox {
72 IRQ_SPINLOCK_DECLARE(lock);
73
74 struct task *task;
75
76 waitq_t wq;
77
78 /** Linkage for the list of task's synchronous answerboxes. */
79 link_t sync_box_link;
80
81 /** Phones connected to this answerbox. */
82 list_t connected_phones;
83 /** Received calls. */
84 list_t calls;
85 list_t dispatched_calls; /* Should be hash table in the future */
86
87 /** Answered calls. */
88 list_t answers;
89
90 IRQ_SPINLOCK_DECLARE(irq_lock);
91
92 /** Notifications from IRQ handlers. */
93 list_t irq_notifs;
94 /** IRQs with notifications to this answerbox. */
95 list_t irq_list;
96} answerbox_t;
97
98typedef struct {
99 sysarg_t args[IPC_CALL_LEN];
100 /** Task which made or forwarded the call with IPC_FF_ROUTE_FROM_ME. */
101 task_id_t task_id;
102 /** Phone which made or last masqueraded this call. */
103 phone_t *phone;
104} ipc_data_t;
105
106typedef struct {
107 link_t link;
108
109 unsigned int flags;
110
111 /** Identification of the caller. */
112 struct task *sender;
113
114 /*
115 * The caller box is different from sender->answerbox
116 * for synchronous calls.
117 */
118 answerbox_t *callerbox;
119
120 /** Private data to internal IPC. */
121 sysarg_t priv;
122
123 /** Data passed from/to userspace. */
124 ipc_data_t data;
125
126 /** Buffer for IPC_M_DATA_WRITE and IPC_M_DATA_READ. */
127 uint8_t *buffer;
128
129 /*
130 * The forward operation can masquerade the caller phone. For those
131 * cases, we must keep it aside so that the answer is processed
132 * correctly.
133 */
134 phone_t *caller_phone;
135} call_t;
136
137extern answerbox_t *ipc_phone_0;
138
139extern void ipc_init(void);
140
141extern call_t *ipc_call_alloc(unsigned int);
142extern void ipc_call_free(call_t *);
143
144extern int ipc_call(phone_t *, call_t *);
145extern int ipc_call_sync(phone_t *, call_t *);
146extern call_t * ipc_wait_for_call(answerbox_t *, uint32_t, unsigned int);
147extern int ipc_forward(call_t *, phone_t *, answerbox_t *, unsigned int);
148extern void ipc_answer(answerbox_t *, call_t *);
149
150extern void ipc_phone_init(phone_t *);
151extern void ipc_phone_connect(phone_t *, answerbox_t *);
152extern int ipc_phone_hangup(phone_t *);
153
154extern void ipc_answerbox_init(answerbox_t *, struct task *);
155
156extern void ipc_cleanup(void);
157extern void ipc_backsend_err(phone_t *, call_t *, sysarg_t);
158extern void ipc_answerbox_slam_phones(answerbox_t *, bool);
159extern void ipc_cleanup_call_list(list_t *);
160
161extern void ipc_print_task(task_id_t);
162
163#endif
164
165/** @}
166 */
Note: See TracBrowser for help on using the repository browser.