source: mainline/uspace/lib/drv/generic/driver.c@ 7329e6a

lfn serial ticket/834-toolchain-update topic/msim-upgrade topic/simplify-dev-export
Last change on this file since 7329e6a was 7e752b2, checked in by Martin Decky <martin@…>, 15 years ago
  • correct printf() formatting strings and corresponding arguments
  • minor cstyle changes and other small fixes
  • Property mode set to 100644
File size: 10.1 KB
Line 
1/*
2 * Copyright (c) 2010 Lenka Trochtova
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/**
30 * @defgroup libdrv generic device driver support.
31 * @brief HelenOS generic device driver support.
32 * @{
33 */
34
35/** @file
36 */
37
38#include <assert.h>
39#include <ipc/services.h>
40#include <ipc/ns.h>
41#include <async.h>
42#include <stdio.h>
43#include <errno.h>
44#include <bool.h>
45#include <fibril_synch.h>
46#include <stdlib.h>
47#include <str.h>
48#include <ctype.h>
49#include <errno.h>
50#include <inttypes.h>
51
52#include <ipc/driver.h>
53
54#include "driver.h"
55
56/* driver structure */
57
58static driver_t *driver;
59
60/* devices */
61
62LIST_INITIALIZE(devices);
63FIBRIL_MUTEX_INITIALIZE(devices_mutex);
64
65/* interrupts */
66
67static interrupt_context_list_t interrupt_contexts;
68
69static irq_cmd_t default_cmds[] = {
70 {
71 .cmd = CMD_ACCEPT
72 }
73};
74
75static irq_code_t default_pseudocode = {
76 sizeof(default_cmds) / sizeof(irq_cmd_t),
77 default_cmds
78};
79
80
81static void driver_irq_handler(ipc_callid_t iid, ipc_call_t *icall)
82{
83 int id = (int)IPC_GET_METHOD(*icall);
84 interrupt_context_t *ctx;
85
86 ctx = find_interrupt_context_by_id(&interrupt_contexts, id);
87 if (NULL != ctx && NULL != ctx->handler)
88 (*ctx->handler)(ctx->dev, iid, icall);
89}
90
91int
92register_interrupt_handler(device_t *dev, int irq, interrupt_handler_t *handler,
93 irq_code_t *pseudocode)
94{
95 interrupt_context_t *ctx = create_interrupt_context();
96
97 ctx->dev = dev;
98 ctx->irq = irq;
99 ctx->handler = handler;
100
101 add_interrupt_context(&interrupt_contexts, ctx);
102
103 if (NULL == pseudocode)
104 pseudocode = &default_pseudocode;
105
106 int res = ipc_register_irq(irq, dev->handle, ctx->id, pseudocode);
107 if (0 != res) {
108 remove_interrupt_context(&interrupt_contexts, ctx);
109 delete_interrupt_context(ctx);
110 }
111
112 return res;
113}
114
115int unregister_interrupt_handler(device_t *dev, int irq)
116{
117 interrupt_context_t *ctx = find_interrupt_context(&interrupt_contexts,
118 dev, irq);
119 int res = ipc_unregister_irq(irq, dev->handle);
120
121 if (NULL != ctx) {
122 remove_interrupt_context(&interrupt_contexts, ctx);
123 delete_interrupt_context(ctx);
124 }
125 return res;
126}
127
128static void add_to_devices_list(device_t *dev)
129{
130 fibril_mutex_lock(&devices_mutex);
131 list_append(&dev->link, &devices);
132 fibril_mutex_unlock(&devices_mutex);
133}
134
135static void remove_from_devices_list(device_t *dev)
136{
137 fibril_mutex_lock(&devices_mutex);
138 list_remove(&dev->link);
139 fibril_mutex_unlock(&devices_mutex);
140}
141
142static device_t * driver_get_device(link_t *devices, devman_handle_t handle)
143{
144 device_t *dev = NULL;
145
146 fibril_mutex_lock(&devices_mutex);
147 link_t *link = devices->next;
148 while (link != devices) {
149 dev = list_get_instance(link, device_t, link);
150 if (handle == dev->handle) {
151 fibril_mutex_unlock(&devices_mutex);
152 return dev;
153 }
154 link = link->next;
155 }
156 fibril_mutex_unlock(&devices_mutex);
157
158 return NULL;
159}
160
161static void driver_add_device(ipc_callid_t iid, ipc_call_t *icall)
162{
163 char *dev_name = NULL;
164 int res = EOK;
165
166 devman_handle_t dev_handle = IPC_GET_ARG1(*icall);
167 device_t *dev = create_device();
168 dev->handle = dev_handle;
169
170 async_data_write_accept((void **) &dev_name, true, 0, 0, 0, 0);
171 dev->name = dev_name;
172
173 add_to_devices_list(dev);
174 res = driver->driver_ops->add_device(dev);
175 if (0 == res) {
176 printf("%s: new device with handle=%" PRIun " was added.\n",
177 driver->name, dev_handle);
178 } else {
179 printf("%s: failed to add a new device with handle = %" PRIun ".\n",
180 driver->name, dev_handle);
181 remove_from_devices_list(dev);
182 delete_device(dev);
183 }
184
185 ipc_answer_0(iid, res);
186}
187
188static void driver_connection_devman(ipc_callid_t iid, ipc_call_t *icall)
189{
190 /* Accept connection */
191 ipc_answer_0(iid, EOK);
192
193 bool cont = true;
194 while (cont) {
195 ipc_call_t call;
196 ipc_callid_t callid = async_get_call(&call);
197
198 switch (IPC_GET_METHOD(call)) {
199 case IPC_M_PHONE_HUNGUP:
200 cont = false;
201 continue;
202 case DRIVER_ADD_DEVICE:
203 driver_add_device(callid, &call);
204 break;
205 default:
206 ipc_answer_0(callid, ENOENT);
207 }
208 }
209}
210
211/**
212 * Generic client connection handler both for applications and drivers.
213 *
214 * @param drv True for driver client, false for other clients
215 * (applications, services etc.).
216 */
217static void driver_connection_gen(ipc_callid_t iid, ipc_call_t *icall, bool drv)
218{
219 /*
220 * Answer the first IPC_M_CONNECT_ME_TO call and remember the handle of
221 * the device to which the client connected.
222 */
223 devman_handle_t handle = IPC_GET_ARG2(*icall);
224 device_t *dev = driver_get_device(&devices, handle);
225
226 if (dev == NULL) {
227 printf("%s: driver_connection_gen error - no device with handle"
228 " %" PRIun " was found.\n", driver->name, handle);
229 ipc_answer_0(iid, ENOENT);
230 return;
231 }
232
233
234 /*
235 * TODO - if the client is not a driver, check whether it is allowed to
236 * use the device.
237 */
238
239 int ret = EOK;
240 /* open the device */
241 if (NULL != dev->ops && NULL != dev->ops->open)
242 ret = (*dev->ops->open)(dev);
243
244 ipc_answer_0(iid, ret);
245 if (EOK != ret)
246 return;
247
248 while (1) {
249 ipc_callid_t callid;
250 ipc_call_t call;
251 callid = async_get_call(&call);
252 ipcarg_t method = IPC_GET_METHOD(call);
253 int iface_idx;
254
255 switch (method) {
256 case IPC_M_PHONE_HUNGUP:
257 /* close the device */
258 if (NULL != dev->ops && NULL != dev->ops->close)
259 (*dev->ops->close)(dev);
260 ipc_answer_0(callid, EOK);
261 return;
262 default:
263 /* convert ipc interface id to interface index */
264
265 iface_idx = DEV_IFACE_IDX(method);
266
267 if (!is_valid_iface_idx(iface_idx)) {
268 remote_handler_t *default_handler =
269 device_get_default_handler(dev);
270 if (NULL != default_handler) {
271 (*default_handler)(dev, callid, &call);
272 break;
273 }
274 /*
275 * This is not device's interface and the
276 * default handler is not provided.
277 */
278 printf("%s: driver_connection_gen error - "
279 "invalid interface id %d.",
280 driver->name, iface_idx);
281 ipc_answer_0(callid, ENOTSUP);
282 break;
283 }
284
285 /* calling one of the device's interfaces */
286
287 /* get the device interface structure */
288 void *iface = device_get_iface(dev, iface_idx);
289 if (NULL == iface) {
290 printf("%s: driver_connection_gen error - ",
291 driver->name);
292 printf("device with handle %" PRIun " has no interface "
293 "with id %d.\n", handle, iface_idx);
294 ipc_answer_0(callid, ENOTSUP);
295 break;
296 }
297
298 /*
299 * Get the corresponding interface for remote request
300 * handling ("remote interface").
301 */
302 remote_iface_t* rem_iface = get_remote_iface(iface_idx);
303 assert(NULL != rem_iface);
304
305 /* get the method of the remote interface */
306 ipcarg_t iface_method_idx = IPC_GET_ARG1(call);
307 remote_iface_func_ptr_t iface_method_ptr =
308 get_remote_method(rem_iface, iface_method_idx);
309 if (NULL == iface_method_ptr) {
310 // the interface has not such method
311 printf("%s: driver_connection_gen error - "
312 "invalid interface method.", driver->name);
313 ipc_answer_0(callid, ENOTSUP);
314 break;
315 }
316
317 /*
318 * Call the remote interface's method, which will
319 * receive parameters from the remote client and it will
320 * pass it to the corresponding local interface method
321 * associated with the device by its driver.
322 */
323 (*iface_method_ptr)(dev, iface, callid, &call);
324 break;
325 }
326 }
327}
328
329static void driver_connection_driver(ipc_callid_t iid, ipc_call_t *icall)
330{
331 driver_connection_gen(iid, icall, true);
332}
333
334static void driver_connection_client(ipc_callid_t iid, ipc_call_t *icall)
335{
336 driver_connection_gen(iid, icall, false);
337}
338
339
340/** Function for handling connections to device driver. */
341static void driver_connection(ipc_callid_t iid, ipc_call_t *icall)
342{
343 /* Select interface */
344 switch ((ipcarg_t) (IPC_GET_ARG1(*icall))) {
345 case DRIVER_DEVMAN:
346 /* handle PnP events from device manager */
347 driver_connection_devman(iid, icall);
348 break;
349 case DRIVER_DRIVER:
350 /* handle request from drivers of child devices */
351 driver_connection_driver(iid, icall);
352 break;
353 case DRIVER_CLIENT:
354 /* handle requests from client applications */
355 driver_connection_client(iid, icall);
356 break;
357
358 default:
359 /* No such interface */
360 ipc_answer_0(iid, ENOENT);
361 }
362}
363
364int child_device_register(device_t *child, device_t *parent)
365{
366 assert(NULL != child->name);
367
368 int res;
369
370 add_to_devices_list(child);
371 res = devman_child_device_register(child->name, &child->match_ids,
372 parent->handle, &child->handle);
373 if (EOK == res)
374 return res;
375 remove_from_devices_list(child);
376 return res;
377}
378
379int driver_main(driver_t *drv)
380{
381 /*
382 * Remember the driver structure - driver_ops will be called by generic
383 * handler for incoming connections.
384 */
385 driver = drv;
386
387 /* Initialize the list of interrupt contexts. */
388 init_interrupt_context_list(&interrupt_contexts);
389
390 /* Set generic interrupt handler. */
391 async_set_interrupt_received(driver_irq_handler);
392
393 /*
394 * Register driver by device manager with generic handler for incoming
395 * connections.
396 */
397 devman_driver_register(driver->name, driver_connection);
398
399 async_manager();
400
401 /* Never reached. */
402 return 0;
403}
404
405/**
406 * @}
407 */
Note: See TracBrowser for help on using the repository browser.