source: mainline/kernel/generic/src/ipc/irq.c@ 48bcf49

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

Introduce reference-counted kobjects

Capabilities are thus reduced to task-local names for references to kobjects.
  • Property mode set to 100644
File size: 14.5 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_destroy(void *arg)
274{
275 irq_t *irq = (irq_t *) arg;
276
277 /* Free up the IRQ code and associated structures. */
278 code_free(irq->notif_cfg.code);
279 slab_free(irq_slab, irq);
280}
281
282static kobject_ops_t irq_kobject_ops = {
283 .destroy = irq_destroy
284};
285
286/** Subscribe an answerbox as a receiving end for IRQ notifications.
287 *
288 * @param box Receiving answerbox.
289 * @param inr IRQ number.
290 * @param imethod Interface and method to be associated with the notification.
291 * @param ucode Uspace pointer to top-half IRQ code.
292 *
293 * @return IRQ capability handle.
294 * @return Negative error code.
295 *
296 */
297int ipc_irq_subscribe(answerbox_t *box, inr_t inr, sysarg_t imethod,
298 irq_code_t *ucode)
299{
300 sysarg_t key[] = {
301 [IRQ_HT_KEY_INR] = (sysarg_t) inr,
302 [IRQ_HT_KEY_MODE] = (sysarg_t) IRQ_HT_MODE_NO_CLAIM
303 };
304
305 if ((inr < 0) || (inr > last_inr))
306 return ELIMIT;
307
308 irq_code_t *code;
309 if (ucode) {
310 code = code_from_uspace(ucode);
311 if (!code)
312 return EBADMEM;
313 } else
314 code = NULL;
315
316 /*
317 * Allocate and populate the IRQ kernel object.
318 */
319 cap_handle_t handle = cap_alloc(TASK);
320 if (handle < 0)
321 return handle;
322
323 irq_t *irq = (irq_t *) slab_alloc(irq_slab, FRAME_ATOMIC);
324 if (!irq) {
325 cap_free(TASK, handle);
326 return ENOMEM;
327 }
328
329 kobject_t *kobject = malloc(sizeof(kobject_t), FRAME_ATOMIC);
330 if (!kobject) {
331 cap_free(TASK, handle);
332 slab_free(irq_slab, irq);
333 return ENOMEM;
334 }
335
336 irq_initialize(irq);
337 irq->inr = inr;
338 irq->claim = ipc_irq_top_half_claim;
339 irq->handler = ipc_irq_top_half_handler;
340 irq->notif_cfg.notify = true;
341 irq->notif_cfg.answerbox = box;
342 irq->notif_cfg.imethod = imethod;
343 irq->notif_cfg.code = code;
344 irq->notif_cfg.counter = 0;
345
346 /*
347 * Insert the IRQ structure into the uspace IRQ hash table.
348 */
349 irq_spinlock_lock(&irq_uspace_hash_table_lock, true);
350 irq_spinlock_lock(&irq->lock, false);
351
352 irq->notif_cfg.hashed_in = true;
353 hash_table_insert(&irq_uspace_hash_table, key, &irq->link);
354
355 irq_spinlock_unlock(&irq->lock, false);
356 irq_spinlock_unlock(&irq_uspace_hash_table_lock, true);
357
358 kobject_initialize(kobject, KOBJECT_TYPE_IRQ, irq, &irq_kobject_ops);
359 cap_publish(TASK, handle, kobject);
360
361 return handle;
362}
363
364/** Unsubscribe task from IRQ notification.
365 *
366 * @param box Answerbox associated with the notification.
367 * @param handle IRQ capability handle.
368 *
369 * @return EOK on success or a negative error code.
370 *
371 */
372int ipc_irq_unsubscribe(answerbox_t *box, int handle)
373{
374 kobject_t *kobj = cap_unpublish(TASK, handle, KOBJECT_TYPE_IRQ);
375 if (!kobj)
376 return ENOENT;
377
378 assert(kobj->irq->notif_cfg.answerbox == box);
379
380 irq_spinlock_lock(&irq_uspace_hash_table_lock, true);
381 irq_spinlock_lock(&kobj->irq->lock, false);
382
383 if (kobj->irq->notif_cfg.hashed_in) {
384 /* Remove the IRQ from the uspace IRQ hash table. */
385 hash_table_remove_item(&irq_uspace_hash_table,
386 &kobj->irq->link);
387 kobj->irq->notif_cfg.hashed_in = false;
388 }
389
390 /* kobj->irq->lock unlocked by the hash table remove_callback */
391 irq_spinlock_unlock(&irq_uspace_hash_table_lock, true);
392
393 kobject_put(kobj);
394 cap_free(TASK, handle);
395
396 return EOK;
397}
398
399/** Add a call to the proper answerbox queue.
400 *
401 * Assume irq->lock is locked and interrupts disabled.
402 *
403 * @param irq IRQ structure referencing the target answerbox.
404 * @param call IRQ notification call.
405 *
406 */
407static void send_call(irq_t *irq, call_t *call)
408{
409 irq_spinlock_lock(&irq->notif_cfg.answerbox->irq_lock, false);
410 list_append(&call->ab_link, &irq->notif_cfg.answerbox->irq_notifs);
411 irq_spinlock_unlock(&irq->notif_cfg.answerbox->irq_lock, false);
412
413 waitq_wakeup(&irq->notif_cfg.answerbox->wq, WAKEUP_FIRST);
414}
415
416/** Apply the top-half IRQ code to find out whether to accept the IRQ or not.
417 *
418 * @param irq IRQ structure.
419 *
420 * @return IRQ_ACCEPT if the interrupt is accepted by the IRQ code.
421 * @return IRQ_DECLINE if the interrupt is not accepted byt the IRQ code.
422 *
423 */
424irq_ownership_t ipc_irq_top_half_claim(irq_t *irq)
425{
426 irq_code_t *code = irq->notif_cfg.code;
427 uint32_t *scratch = irq->notif_cfg.scratch;
428
429 if (!irq->notif_cfg.notify)
430 return IRQ_DECLINE;
431
432 if (!code)
433 return IRQ_DECLINE;
434
435 for (size_t i = 0; i < code->cmdcount; i++) {
436 uintptr_t srcarg = code->cmds[i].srcarg;
437 uintptr_t dstarg = code->cmds[i].dstarg;
438
439 switch (code->cmds[i].cmd) {
440 case CMD_PIO_READ_8:
441 scratch[dstarg] =
442 pio_read_8((ioport8_t *) code->cmds[i].addr);
443 break;
444 case CMD_PIO_READ_16:
445 scratch[dstarg] =
446 pio_read_16((ioport16_t *) code->cmds[i].addr);
447 break;
448 case CMD_PIO_READ_32:
449 scratch[dstarg] =
450 pio_read_32((ioport32_t *) code->cmds[i].addr);
451 break;
452 case CMD_PIO_WRITE_8:
453 pio_write_8((ioport8_t *) code->cmds[i].addr,
454 (uint8_t) code->cmds[i].value);
455 break;
456 case CMD_PIO_WRITE_16:
457 pio_write_16((ioport16_t *) code->cmds[i].addr,
458 (uint16_t) code->cmds[i].value);
459 break;
460 case CMD_PIO_WRITE_32:
461 pio_write_32((ioport32_t *) code->cmds[i].addr,
462 (uint32_t) code->cmds[i].value);
463 break;
464 case CMD_PIO_WRITE_A_8:
465 pio_write_8((ioport8_t *) code->cmds[i].addr,
466 (uint8_t) scratch[srcarg]);
467 break;
468 case CMD_PIO_WRITE_A_16:
469 pio_write_16((ioport16_t *) code->cmds[i].addr,
470 (uint16_t) scratch[srcarg]);
471 break;
472 case CMD_PIO_WRITE_A_32:
473 pio_write_32((ioport32_t *) code->cmds[i].addr,
474 (uint32_t) scratch[srcarg]);
475 break;
476 case CMD_LOAD:
477 scratch[dstarg] = code->cmds[i].value;
478 break;
479 case CMD_AND:
480 scratch[dstarg] = scratch[srcarg] &
481 code->cmds[i].value;
482 break;
483 case CMD_PREDICATE:
484 if (scratch[srcarg] == 0)
485 i += code->cmds[i].value;
486
487 break;
488 case CMD_ACCEPT:
489 return IRQ_ACCEPT;
490 case CMD_DECLINE:
491 default:
492 return IRQ_DECLINE;
493 }
494 }
495
496 return IRQ_DECLINE;
497}
498
499/* IRQ top-half handler.
500 *
501 * We expect interrupts to be disabled and the irq->lock already held.
502 *
503 * @param irq IRQ structure.
504 *
505 */
506void ipc_irq_top_half_handler(irq_t *irq)
507{
508 assert(irq);
509
510 assert(interrupts_disabled());
511 assert(irq_spinlock_locked(&irq->lock));
512
513 if (irq->notif_cfg.answerbox) {
514 call_t *call = ipc_call_alloc(FRAME_ATOMIC);
515 if (!call)
516 return;
517
518 call->flags |= IPC_CALL_NOTIF;
519 /* Put a counter to the message */
520 call->priv = ++irq->notif_cfg.counter;
521
522 /* Set up args */
523 IPC_SET_IMETHOD(call->data, irq->notif_cfg.imethod);
524 IPC_SET_ARG1(call->data, irq->notif_cfg.scratch[1]);
525 IPC_SET_ARG2(call->data, irq->notif_cfg.scratch[2]);
526 IPC_SET_ARG3(call->data, irq->notif_cfg.scratch[3]);
527 IPC_SET_ARG4(call->data, irq->notif_cfg.scratch[4]);
528 IPC_SET_ARG5(call->data, irq->notif_cfg.scratch[5]);
529
530 send_call(irq, call);
531 }
532}
533
534/** Send notification message.
535 *
536 * @param irq IRQ structure.
537 * @param a1 Driver-specific payload argument.
538 * @param a2 Driver-specific payload argument.
539 * @param a3 Driver-specific payload argument.
540 * @param a4 Driver-specific payload argument.
541 * @param a5 Driver-specific payload argument.
542 *
543 */
544void ipc_irq_send_msg(irq_t *irq, sysarg_t a1, sysarg_t a2, sysarg_t a3,
545 sysarg_t a4, sysarg_t a5)
546{
547 irq_spinlock_lock(&irq->lock, true);
548
549 if (irq->notif_cfg.answerbox) {
550 call_t *call = ipc_call_alloc(FRAME_ATOMIC);
551 if (!call) {
552 irq_spinlock_unlock(&irq->lock, true);
553 return;
554 }
555
556 call->flags |= IPC_CALL_NOTIF;
557 /* Put a counter to the message */
558 call->priv = ++irq->notif_cfg.counter;
559
560 IPC_SET_IMETHOD(call->data, irq->notif_cfg.imethod);
561 IPC_SET_ARG1(call->data, a1);
562 IPC_SET_ARG2(call->data, a2);
563 IPC_SET_ARG3(call->data, a3);
564 IPC_SET_ARG4(call->data, a4);
565 IPC_SET_ARG5(call->data, a5);
566
567 send_call(irq, call);
568 }
569
570 irq_spinlock_unlock(&irq->lock, true);
571}
572
573/** @}
574 */
Note: See TracBrowser for help on using the repository browser.