source: mainline/kernel/generic/src/ipc/irq.c@ 6abda242

lfn serial ticket/834-toolchain-update topic/msim-upgrade topic/simplify-dev-export
Last change on this file since 6abda242 was 9233e9d, checked in by Jiří Zárevúcky <zarevucky.jiri@…>, 8 years ago

Return capability handle in SYS_IPC_IRQ_SUBSCRIBE separately from error code.
  • Property mode set to 100644
File size: 14.6 KB
Line 
1/*
2 * Copyright (c) 2006 Ondrej Palkovsky
3 * Copyright (c) 2006 Jakub Jermar
4 * All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
8 * are met:
9 *
10 * - Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * - Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 * - The name of the author may not be used to endorse or promote products
16 * derived from this software without specific prior written permission.
17 *
18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
19 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
20 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
21 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
22 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
23 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 */
29
30/** @addtogroup genericipc
31 * @{
32 */
33
34/**
35 * @file
36 * @brief IRQ notification framework.
37 *
38 * This framework allows applications to subscribe to receive a notification
39 * when an interrupt is detected. The application may provide a simple
40 * 'top-half' handler as part of its registration, which can perform simple
41 * operations (read/write port/memory, add information to notification IPC
42 * message).
43 *
44 * The structure of a notification message is as follows:
45 * - IMETHOD: interface and method as set by the SYS_IPC_IRQ_SUBSCRIBE syscall
46 * - ARG1: payload modified by a 'top-half' handler (scratch[1])
47 * - ARG2: payload modified by a 'top-half' handler (scratch[2])
48 * - ARG3: payload modified by a 'top-half' handler (scratch[3])
49 * - ARG4: payload modified by a 'top-half' handler (scratch[4])
50 * - ARG5: payload modified by a 'top-half' handler (scratch[5])
51 * - in_phone_hash: interrupt counter (may be needed to assure correct order
52 * in multithreaded drivers)
53 */
54
55#include <arch.h>
56#include <assert.h>
57#include <mm/slab.h>
58#include <mm/page.h>
59#include <mm/km.h>
60#include <errno.h>
61#include <ddi/irq.h>
62#include <ipc/ipc.h>
63#include <ipc/irq.h>
64#include <syscall/copy.h>
65#include <console/console.h>
66#include <print.h>
67#include <macros.h>
68#include <cap/cap.h>
69
70static void ranges_unmap(irq_pio_range_t *ranges, size_t rangecount)
71{
72 for (size_t i = 0; i < rangecount; i++) {
73#ifdef IO_SPACE_BOUNDARY
74 if ((void *) ranges[i].base >= IO_SPACE_BOUNDARY)
75#endif
76 km_unmap(ranges[i].base, ranges[i].size);
77 }
78}
79
80static int ranges_map_and_apply(irq_pio_range_t *ranges, size_t rangecount,
81 irq_cmd_t *cmds, size_t cmdcount)
82{
83 /* Copy the physical base addresses aside. */
84 uintptr_t *pbase = malloc(rangecount * sizeof(uintptr_t), 0);
85 for (size_t i = 0; i < rangecount; i++)
86 pbase[i] = ranges[i].base;
87
88 /* Map the PIO ranges into the kernel virtual address space. */
89 for (size_t i = 0; i < rangecount; i++) {
90#ifdef IO_SPACE_BOUNDARY
91 if ((void *) ranges[i].base < IO_SPACE_BOUNDARY)
92 continue;
93#endif
94 ranges[i].base = km_map(pbase[i], ranges[i].size,
95 PAGE_READ | PAGE_WRITE | PAGE_KERNEL | PAGE_NOT_CACHEABLE);
96 if (!ranges[i].base) {
97 ranges_unmap(ranges, i);
98 free(pbase);
99 return ENOMEM;
100 }
101 }
102
103 /* Rewrite the IRQ code addresses from physical to kernel virtual. */
104 for (size_t i = 0; i < cmdcount; i++) {
105 uintptr_t addr;
106 size_t size;
107
108 /* Process only commands that use an address. */
109 switch (cmds[i].cmd) {
110 case CMD_PIO_READ_8:
111 case CMD_PIO_WRITE_8:
112 case CMD_PIO_WRITE_A_8:
113 size = 1;
114 break;
115 case CMD_PIO_READ_16:
116 case CMD_PIO_WRITE_16:
117 case CMD_PIO_WRITE_A_16:
118 size = 2;
119 break;
120 case CMD_PIO_READ_32:
121 case CMD_PIO_WRITE_32:
122 case CMD_PIO_WRITE_A_32:
123 size = 4;
124 break;
125 default:
126 /* Move onto the next command. */
127 continue;
128 }
129
130 addr = (uintptr_t) cmds[i].addr;
131
132 size_t j;
133 for (j = 0; j < rangecount; j++) {
134 /* Find the matching range. */
135 if (!iswithin(pbase[j], ranges[j].size, addr, size))
136 continue;
137
138 /* Switch the command to a kernel virtual address. */
139 addr -= pbase[j];
140 addr += ranges[j].base;
141
142 cmds[i].addr = (void *) addr;
143 break;
144 }
145
146 if (j == rangecount) {
147 /*
148 * The address used in this command is outside of all
149 * defined ranges.
150 */
151 ranges_unmap(ranges, rangecount);
152 free(pbase);
153 return EINVAL;
154 }
155 }
156
157 free(pbase);
158 return EOK;
159}
160
161/** Statically check the top-half IRQ code
162 *
163 * Check the top-half IRQ code for invalid or unsafe constructs.
164 *
165 */
166static int code_check(irq_cmd_t *cmds, size_t cmdcount)
167{
168 for (size_t i = 0; i < cmdcount; i++) {
169 /*
170 * Check for accepted ranges.
171 */
172 if (cmds[i].cmd >= CMD_LAST)
173 return EINVAL;
174
175 if (cmds[i].srcarg >= IPC_CALL_LEN)
176 return EINVAL;
177
178 if (cmds[i].dstarg >= IPC_CALL_LEN)
179 return EINVAL;
180
181 switch (cmds[i].cmd) {
182 case CMD_PREDICATE:
183 /*
184 * Check for control flow overflow.
185 * Note that jumping just beyond the last
186 * command is a correct behaviour.
187 */
188 if (i + cmds[i].value > cmdcount)
189 return EINVAL;
190
191 break;
192 default:
193 break;
194 }
195 }
196
197 return EOK;
198}
199
200/** Free the top-half IRQ code.
201 *
202 * @param code Pointer to the top-half IRQ code.
203 *
204 */
205static void code_free(irq_code_t *code)
206{
207 if (code) {
208 ranges_unmap(code->ranges, code->rangecount);
209 free(code->ranges);
210 free(code->cmds);
211 free(code);
212 }
213}
214
215/** Copy the top-half IRQ code from userspace into the kernel.
216 *
217 * @param ucode Userspace address of the top-half IRQ code.
218 *
219 * @return Kernel address of the copied IRQ code.
220 *
221 */
222static irq_code_t *code_from_uspace(irq_code_t *ucode)
223{
224 irq_pio_range_t *ranges = NULL;
225 irq_cmd_t *cmds = NULL;
226
227 irq_code_t *code = malloc(sizeof(*code), 0);
228 int rc = copy_from_uspace(code, ucode, sizeof(*code));
229 if (rc != EOK)
230 goto error;
231
232 if ((code->rangecount > IRQ_MAX_RANGE_COUNT) ||
233 (code->cmdcount > IRQ_MAX_PROG_SIZE))
234 goto error;
235
236 ranges = malloc(sizeof(code->ranges[0]) * code->rangecount, 0);
237 rc = copy_from_uspace(ranges, code->ranges,
238 sizeof(code->ranges[0]) * code->rangecount);
239 if (rc != EOK)
240 goto error;
241
242 cmds = malloc(sizeof(code->cmds[0]) * code->cmdcount, 0);
243 rc = copy_from_uspace(cmds, code->cmds,
244 sizeof(code->cmds[0]) * code->cmdcount);
245 if (rc != EOK)
246 goto error;
247
248 rc = code_check(cmds, code->cmdcount);
249 if (rc != EOK)
250 goto error;
251
252 rc = ranges_map_and_apply(ranges, code->rangecount, cmds,
253 code->cmdcount);
254 if (rc != EOK)
255 goto error;
256
257 code->ranges = ranges;
258 code->cmds = cmds;
259
260 return code;
261
262error:
263 if (cmds)
264 free(cmds);
265
266 if (ranges)
267 free(ranges);
268
269 free(code);
270 return NULL;
271}
272
273static void irq_hash_out(irq_t *irq)
274{
275 irq_spinlock_lock(&irq_uspace_hash_table_lock, true);
276 irq_spinlock_lock(&irq->lock, false);
277
278 if (irq->notif_cfg.hashed_in) {
279 /* Remove the IRQ from the uspace IRQ hash table. */
280 hash_table_remove_item(&irq_uspace_hash_table, &irq->link);
281 irq->notif_cfg.hashed_in = false;
282 }
283
284 irq_spinlock_unlock(&irq->lock, false);
285 irq_spinlock_unlock(&irq_uspace_hash_table_lock, true);
286}
287
288static void irq_destroy(void *arg)
289{
290 irq_t *irq = (irq_t *) arg;
291
292 irq_hash_out(irq);
293
294 /* Free up the IRQ code and associated structures. */
295 code_free(irq->notif_cfg.code);
296 slab_free(irq_cache, irq);
297}
298
299static kobject_ops_t irq_kobject_ops = {
300 .destroy = irq_destroy
301};
302
303/** Subscribe an answerbox as a receiving end for IRQ notifications.
304 *
305 * @param box Receiving answerbox.
306 * @param inr IRQ number.
307 * @param imethod Interface and method to be associated with the notification.
308 * @param ucode Uspace pointer to top-half IRQ code.
309 *
310 * @param[out] uspace_handle Uspace pointer to IRQ capability handle
311 *
312 * @return Error code.
313 *
314 */
315int ipc_irq_subscribe(answerbox_t *box, inr_t inr, sysarg_t imethod,
316 irq_code_t *ucode, cap_handle_t *uspace_handle)
317{
318 if ((inr < 0) || (inr > last_inr))
319 return ELIMIT;
320
321 irq_code_t *code;
322 if (ucode) {
323 code = code_from_uspace(ucode);
324 if (!code)
325 return EBADMEM;
326 } else
327 code = NULL;
328
329 /*
330 * Allocate and populate the IRQ kernel object.
331 */
332 cap_handle_t handle = cap_alloc(TASK);
333 if (handle < 0)
334 return handle;
335
336 int rc = copy_to_uspace(uspace_handle, &handle, sizeof(cap_handle_t));
337 if (rc != EOK) {
338 cap_free(TASK, handle);
339 return rc;
340 }
341
342 irq_t *irq = (irq_t *) slab_alloc(irq_cache, FRAME_ATOMIC);
343 if (!irq) {
344 cap_free(TASK, handle);
345 return ENOMEM;
346 }
347
348 kobject_t *kobject = malloc(sizeof(kobject_t), FRAME_ATOMIC);
349 if (!kobject) {
350 cap_free(TASK, handle);
351 slab_free(irq_cache, irq);
352 return ENOMEM;
353 }
354
355 irq_initialize(irq);
356 irq->inr = inr;
357 irq->claim = ipc_irq_top_half_claim;
358 irq->handler = ipc_irq_top_half_handler;
359 irq->notif_cfg.notify = true;
360 irq->notif_cfg.answerbox = box;
361 irq->notif_cfg.imethod = imethod;
362 irq->notif_cfg.code = code;
363 irq->notif_cfg.counter = 0;
364
365 /*
366 * Insert the IRQ structure into the uspace IRQ hash table.
367 */
368 irq_spinlock_lock(&irq_uspace_hash_table_lock, true);
369 irq_spinlock_lock(&irq->lock, false);
370
371 irq->notif_cfg.hashed_in = true;
372 hash_table_insert(&irq_uspace_hash_table, &irq->link);
373
374 irq_spinlock_unlock(&irq->lock, false);
375 irq_spinlock_unlock(&irq_uspace_hash_table_lock, true);
376
377 kobject_initialize(kobject, KOBJECT_TYPE_IRQ, irq, &irq_kobject_ops);
378 cap_publish(TASK, handle, kobject);
379
380 return EOK;
381}
382
383/** Unsubscribe task from IRQ notification.
384 *
385 * @param box Answerbox associated with the notification.
386 * @param handle IRQ capability handle.
387 *
388 * @return EOK on success or a negative error code.
389 *
390 */
391int ipc_irq_unsubscribe(answerbox_t *box, int handle)
392{
393 kobject_t *kobj = cap_unpublish(TASK, handle, KOBJECT_TYPE_IRQ);
394 if (!kobj)
395 return ENOENT;
396
397 assert(kobj->irq->notif_cfg.answerbox == box);
398
399 irq_hash_out(kobj->irq);
400
401 kobject_put(kobj);
402 cap_free(TASK, handle);
403
404 return EOK;
405}
406
407/** Add a call to the proper answerbox queue.
408 *
409 * Assume irq->lock is locked and interrupts disabled.
410 *
411 * @param irq IRQ structure referencing the target answerbox.
412 * @param call IRQ notification call.
413 *
414 */
415static void send_call(irq_t *irq, call_t *call)
416{
417 irq_spinlock_lock(&irq->notif_cfg.answerbox->irq_lock, false);
418 list_append(&call->ab_link, &irq->notif_cfg.answerbox->irq_notifs);
419 irq_spinlock_unlock(&irq->notif_cfg.answerbox->irq_lock, false);
420
421 waitq_wakeup(&irq->notif_cfg.answerbox->wq, WAKEUP_FIRST);
422}
423
424/** Apply the top-half IRQ code to find out whether to accept the IRQ or not.
425 *
426 * @param irq IRQ structure.
427 *
428 * @return IRQ_ACCEPT if the interrupt is accepted by the IRQ code.
429 * @return IRQ_DECLINE if the interrupt is not accepted byt the IRQ code.
430 *
431 */
432irq_ownership_t ipc_irq_top_half_claim(irq_t *irq)
433{
434 irq_code_t *code = irq->notif_cfg.code;
435 uint32_t *scratch = irq->notif_cfg.scratch;
436
437 if (!irq->notif_cfg.notify)
438 return IRQ_DECLINE;
439
440 if (!code)
441 return IRQ_DECLINE;
442
443 for (size_t i = 0; i < code->cmdcount; i++) {
444 uintptr_t srcarg = code->cmds[i].srcarg;
445 uintptr_t dstarg = code->cmds[i].dstarg;
446
447 switch (code->cmds[i].cmd) {
448 case CMD_PIO_READ_8:
449 scratch[dstarg] =
450 pio_read_8((ioport8_t *) code->cmds[i].addr);
451 break;
452 case CMD_PIO_READ_16:
453 scratch[dstarg] =
454 pio_read_16((ioport16_t *) code->cmds[i].addr);
455 break;
456 case CMD_PIO_READ_32:
457 scratch[dstarg] =
458 pio_read_32((ioport32_t *) code->cmds[i].addr);
459 break;
460 case CMD_PIO_WRITE_8:
461 pio_write_8((ioport8_t *) code->cmds[i].addr,
462 (uint8_t) code->cmds[i].value);
463 break;
464 case CMD_PIO_WRITE_16:
465 pio_write_16((ioport16_t *) code->cmds[i].addr,
466 (uint16_t) code->cmds[i].value);
467 break;
468 case CMD_PIO_WRITE_32:
469 pio_write_32((ioport32_t *) code->cmds[i].addr,
470 (uint32_t) code->cmds[i].value);
471 break;
472 case CMD_PIO_WRITE_A_8:
473 pio_write_8((ioport8_t *) code->cmds[i].addr,
474 (uint8_t) scratch[srcarg]);
475 break;
476 case CMD_PIO_WRITE_A_16:
477 pio_write_16((ioport16_t *) code->cmds[i].addr,
478 (uint16_t) scratch[srcarg]);
479 break;
480 case CMD_PIO_WRITE_A_32:
481 pio_write_32((ioport32_t *) code->cmds[i].addr,
482 (uint32_t) scratch[srcarg]);
483 break;
484 case CMD_LOAD:
485 scratch[dstarg] = code->cmds[i].value;
486 break;
487 case CMD_AND:
488 scratch[dstarg] = scratch[srcarg] &
489 code->cmds[i].value;
490 break;
491 case CMD_PREDICATE:
492 if (scratch[srcarg] == 0)
493 i += code->cmds[i].value;
494
495 break;
496 case CMD_ACCEPT:
497 return IRQ_ACCEPT;
498 case CMD_DECLINE:
499 default:
500 return IRQ_DECLINE;
501 }
502 }
503
504 return IRQ_DECLINE;
505}
506
507/* IRQ top-half handler.
508 *
509 * We expect interrupts to be disabled and the irq->lock already held.
510 *
511 * @param irq IRQ structure.
512 *
513 */
514void ipc_irq_top_half_handler(irq_t *irq)
515{
516 assert(irq);
517
518 assert(interrupts_disabled());
519 assert(irq_spinlock_locked(&irq->lock));
520
521 if (irq->notif_cfg.answerbox) {
522 call_t *call = ipc_call_alloc(FRAME_ATOMIC);
523 if (!call)
524 return;
525
526 call->flags |= IPC_CALL_NOTIF;
527 /* Put a counter to the message */
528 call->priv = ++irq->notif_cfg.counter;
529
530 /* Set up args */
531 IPC_SET_IMETHOD(call->data, irq->notif_cfg.imethod);
532 IPC_SET_ARG1(call->data, irq->notif_cfg.scratch[1]);
533 IPC_SET_ARG2(call->data, irq->notif_cfg.scratch[2]);
534 IPC_SET_ARG3(call->data, irq->notif_cfg.scratch[3]);
535 IPC_SET_ARG4(call->data, irq->notif_cfg.scratch[4]);
536 IPC_SET_ARG5(call->data, irq->notif_cfg.scratch[5]);
537
538 send_call(irq, call);
539 }
540}
541
542/** Send notification message.
543 *
544 * @param irq IRQ structure.
545 * @param a1 Driver-specific payload argument.
546 * @param a2 Driver-specific payload argument.
547 * @param a3 Driver-specific payload argument.
548 * @param a4 Driver-specific payload argument.
549 * @param a5 Driver-specific payload argument.
550 *
551 */
552void ipc_irq_send_msg(irq_t *irq, sysarg_t a1, sysarg_t a2, sysarg_t a3,
553 sysarg_t a4, sysarg_t a5)
554{
555 irq_spinlock_lock(&irq->lock, true);
556
557 if (irq->notif_cfg.answerbox) {
558 call_t *call = ipc_call_alloc(FRAME_ATOMIC);
559 if (!call) {
560 irq_spinlock_unlock(&irq->lock, true);
561 return;
562 }
563
564 call->flags |= IPC_CALL_NOTIF;
565 /* Put a counter to the message */
566 call->priv = ++irq->notif_cfg.counter;
567
568 IPC_SET_IMETHOD(call->data, irq->notif_cfg.imethod);
569 IPC_SET_ARG1(call->data, a1);
570 IPC_SET_ARG2(call->data, a2);
571 IPC_SET_ARG3(call->data, a3);
572 IPC_SET_ARG4(call->data, a4);
573 IPC_SET_ARG5(call->data, a5);
574
575 send_call(irq, call);
576 }
577
578 irq_spinlock_unlock(&irq->lock, true);
579}
580
581/** @}
582 */
Note: See TracBrowser for help on using the repository browser.