WebSVN – HelenOS – Diff – /branches/dynload/kernel/generic/src/ipc/irq.c


/*
 * Copyright (c) 2006 Ondrej Palkovsky
 * Copyright (c) 2006 Jakub Jermar
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * - Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 * - Redistributions in binary form must reproduce the above copyright
 *   notice, this list of conditions and the following disclaimer in the
 *   documentation and/or other materials provided with the distribution.
 * - The name of the author may not be used to endorse or promote products
 *   derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
 
/** @addtogroup genericipc
 * @{
 */
/**
 * @file
 * @brief IRQ notification framework.
 *
 * This framework allows applications to register to receive a notification
 * when interrupt is detected. The application may provide a simple 'top-half'
 * handler as part of its registration, which can perform simple operations
 * (read/write port/memory, add information to notification ipc message).
 *
 * The structure of a notification message is as follows:
 * - METHOD: method as registered by the SYS_IPC_REGISTER_IRQ syscall
 * - ARG1: payload modified by a 'top-half' handler
 * - ARG2: payload modified by a 'top-half' handler
 * - ARG3: payload modified by a 'top-half' handler
 * - in_phone_hash: interrupt counter (may be needed to assure correct order
 *         in multithreaded drivers)
 */
 
#include <arch.h>
#include <mm/slab.h>
#include <errno.h>
#include <ddi/irq.h>
#include <ipc/ipc.h>
#include <ipc/irq.h>
#include <syscall/copy.h>
#include <console/console.h>
#include <print.h>
 
/** Execute code associated with IRQ notification.
 *
 * @param call      Notification call.
 * @param code      Top-half pseudocode.
 */
static void code_execute(call_t *call, irq_code_t *code)
{
    unsigned int i;
    unative_t dstval = 0;
   
    if (!code)
        return;
   
    for (i = 0; i < code->cmdcount; i++) {
        switch (code->cmds[i].cmd) {
        case CMD_MEM_READ_1:
            dstval = *((uint8_t *) code->cmds[i].addr);
            break;
        case CMD_MEM_READ_2:
            dstval = *((uint16_t *) code->cmds[i].addr);
            break;
        case CMD_MEM_READ_4:
            dstval = *((uint32_t *) code->cmds[i].addr);
            break;
        case CMD_MEM_READ_8:
            dstval = *((uint64_t *) code->cmds[i].addr);
            break;
        case CMD_MEM_WRITE_1:
            *((uint8_t *) code->cmds[i].addr) = code->cmds[i].value;
            break;
        case CMD_MEM_WRITE_2:
            *((uint16_t *) code->cmds[i].addr) =
                code->cmds[i].value;
            break;
        case CMD_MEM_WRITE_4:
            *((uint32_t *) code->cmds[i].addr) =
                code->cmds[i].value;
            break;
        case CMD_MEM_WRITE_8:
            *((uint64_t *) code->cmds[i].addr) =
                code->cmds[i].value;
            break;
#if defined(ia32) || defined(amd64) || defined(ia64)
        case CMD_PORT_READ_1:
            dstval = inb((long) code->cmds[i].addr);
            break;
        case CMD_PORT_WRITE_1:
            outb((long) code->cmds[i].addr, code->cmds[i].value);
            break;
#endif
#if defined(ia64) && defined(SKI)
        case CMD_IA64_GETCHAR:
            dstval = _getc(&ski_uconsole);
            break;
#endif
#if defined(ppc32)
        case CMD_PPC32_GETCHAR:
            dstval = cuda_get_scancode();
            break;
#endif
        default:
            break;
        }
        if (code->cmds[i].dstarg && code->cmds[i].dstarg <
            IPC_CALL_LEN) {
            call->data.args[code->cmds[i].dstarg] = dstval;
        }
    }
}
 
/** Free top-half pseudocode.
 *
 * @param code      Pointer to the top-half pseudocode.
 */
static void code_free(irq_code_t *code)
{
    if (code) {
        free(code->cmds);
        free(code);
    }
}
 
/** Copy top-half pseudocode from userspace into the kernel.
 *
 * @param ucode     Userspace address of the top-half pseudocode.
 *
 * @return      Kernel address of the copied pseudocode.
 */
static irq_code_t *code_from_uspace(irq_code_t *ucode)
{
    irq_code_t *code;
    irq_cmd_t *ucmds;
    int rc;
 
    code = malloc(sizeof(*code), 0);
    rc = copy_from_uspace(code, ucode, sizeof(*code));
    if (rc != 0) {
        free(code);
        return NULL;
    }
   
    if (code->cmdcount > IRQ_MAX_PROG_SIZE) {
        free(code);
        return NULL;
    }
    ucmds = code->cmds;
    code->cmds = malloc(sizeof(code->cmds[0]) * code->cmdcount, 0);
    rc = copy_from_uspace(code->cmds, ucmds,
        sizeof(code->cmds[0]) * code->cmdcount);
    if (rc != 0) {
        free(code->cmds);
        free(code);
        return NULL;
    }
 
    return code;
}
 
/** Unregister task from IRQ notification.
 *
 * @param box       Answerbox associated with the notification.
 * @param inr       IRQ number.
 * @param devno     Device number.
 */
void ipc_irq_unregister(answerbox_t *box, inr_t inr, devno_t devno)
{
    ipl_t ipl;
    irq_t *irq;
 
    ipl = interrupts_disable();
    irq = irq_find_and_lock(inr, devno);
    if (irq) {
        if (irq->notif_cfg.answerbox == box) {
            code_free(irq->notif_cfg.code);
            irq->notif_cfg.notify = false;
            irq->notif_cfg.answerbox = NULL;
            irq->notif_cfg.code = NULL;
            irq->notif_cfg.method = 0;
            irq->notif_cfg.counter = 0;
 
            spinlock_lock(&box->irq_lock);
            list_remove(&irq->notif_cfg.link);
            spinlock_unlock(&box->irq_lock);
           
            spinlock_unlock(&irq->lock);
        }
    }
    interrupts_restore(ipl);
}
 
/** Register an answerbox as a receiving end for IRQ notifications.
 *
 * @param box       Receiving answerbox.
 * @param inr       IRQ number.
 * @param devno     Device number.
 * @param method    Method to be associated with the notification.
 * @param ucode     Uspace pointer to top-half pseudocode.
 *
 * @return      EBADMEM, ENOENT or EEXISTS on failure or 0 on success.
 */
int ipc_irq_register(answerbox_t *box, inr_t inr, devno_t devno,
    unative_t method, irq_code_t *ucode)
{
    ipl_t ipl;
    irq_code_t *code;
    irq_t *irq;
 
    if (ucode) {
        code = code_from_uspace(ucode);
        if (!code)
            return EBADMEM;
    } else {
        code = NULL;
    }
 
    ipl = interrupts_disable();
    irq = irq_find_and_lock(inr, devno);
    if (!irq) {
        interrupts_restore(ipl);
        code_free(code);
        return ENOENT;
    }
   
    if (irq->notif_cfg.answerbox) {
        spinlock_unlock(&irq->lock);
        interrupts_restore(ipl);
        code_free(code);
        return EEXISTS;
    }
   
    irq->notif_cfg.notify = true;
    irq->notif_cfg.answerbox = box;
    irq->notif_cfg.method = method;
    irq->notif_cfg.code = code;
    irq->notif_cfg.counter = 0;
 
    spinlock_lock(&box->irq_lock);
    list_append(&irq->notif_cfg.link, &box->irq_head);
    spinlock_unlock(&box->irq_lock);
 
    spinlock_unlock(&irq->lock);
    interrupts_restore(ipl);
 
    return 0;
}
 
/** Add a call to the proper answerbox queue.
 *
 * Assume irq->lock is locked.
 *
 * @param irq       IRQ structure referencing the target answerbox.
 * @param call      IRQ notification call.
 */
static void send_call(irq_t *irq, call_t *call)
{
    spinlock_lock(&irq->notif_cfg.answerbox->irq_lock);
    list_append(&call->link, &irq->notif_cfg.answerbox->irq_notifs);
    spinlock_unlock(&irq->notif_cfg.answerbox->irq_lock);
       
    waitq_wakeup(&irq->notif_cfg.answerbox->wq, WAKEUP_FIRST);
}
 
/** Send notification message.
 *
 * @param irq       IRQ structure.
 * @param a1        Driver-specific payload argument.
 * @param a2        Driver-specific payload argument.
 * @param a3        Driver-specific payload argument.
 * @param a4        Driver-specific payload argument.
 * @param a5        Driver-specific payload argument.
 */
void ipc_irq_send_msg(irq_t *irq, unative_t a1, unative_t a2, unative_t a3,
    unative_t a4, unative_t a5)
{
    call_t *call;
 
    spinlock_lock(&irq->lock);
 
    if (irq->notif_cfg.answerbox) {
        call = ipc_call_alloc(FRAME_ATOMIC);
        if (!call) {
            spinlock_unlock(&irq->lock);
            return;
        }
        call->flags |= IPC_CALL_NOTIF;
        IPC_SET_METHOD(call->data, irq->notif_cfg.method);
        IPC_SET_ARG1(call->data, a1);
        IPC_SET_ARG2(call->data, a2);
        IPC_SET_ARG3(call->data, a3);
        IPC_SET_ARG4(call->data, a4);
        IPC_SET_ARG5(call->data, a5);
        /* Put a counter to the message */
        call->priv = ++irq->notif_cfg.counter;
       
        send_call(irq, call);
    }
    spinlock_unlock(&irq->lock);
}
 
/** Notify a task that an IRQ had occurred.
 *
 * We expect interrupts to be disabled and the irq->lock already held.
 *
 * @param irq       IRQ structure.
 */
void ipc_irq_send_notif(irq_t *irq)
{
    call_t *call;
 
    ASSERT(irq);
 
    if (irq->notif_cfg.answerbox) {
        call = ipc_call_alloc(FRAME_ATOMIC);
        if (!call) {
            return;
        }
        call->flags |= IPC_CALL_NOTIF;
        /* Put a counter to the message */
        call->priv = ++irq->notif_cfg.counter;
        /* Set up args */
        IPC_SET_METHOD(call->data, irq->notif_cfg.method);
 
        /* Execute code to handle irq */
        code_execute(call, irq->notif_cfg.code);
       
        send_call(irq, call);
    }
}
 
/** Disconnect all IRQ notifications from an answerbox.
 *
 * This function is effective because the answerbox contains
 * list of all irq_t structures that are registered to
 * send notifications to it.
 *
 * @param box       Answerbox for which we want to carry out the cleanup.
 */
void ipc_irq_cleanup(answerbox_t *box)
{
    ipl_t ipl;
   
loop:
    ipl = interrupts_disable();
    spinlock_lock(&box->irq_lock);
   
    while (box->irq_head.next != &box->irq_head) {
        link_t *cur = box->irq_head.next;
        irq_t *irq;
        DEADLOCK_PROBE_INIT(p_irqlock);
       
        irq = list_get_instance(cur, irq_t, notif_cfg.link);
        if (!spinlock_trylock(&irq->lock)) {
            /*
             * Avoid deadlock by trying again.
             */
            spinlock_unlock(&box->irq_lock);
            interrupts_restore(ipl);
            DEADLOCK_PROBE(p_irqlock, DEADLOCK_THRESHOLD);
            goto loop;
        }
       
        ASSERT(irq->notif_cfg.answerbox == box);
       
        list_remove(&irq->notif_cfg.link);
       
        /*
         * Don't forget to free any top-half pseudocode.
         */
        code_free(irq->notif_cfg.code);
       
        irq->notif_cfg.notify = false;
        irq->notif_cfg.answerbox = NULL;
        irq->notif_cfg.code = NULL;
        irq->notif_cfg.method = 0;
        irq->notif_cfg.counter = 0;
 
        spinlock_unlock(&irq->lock);
    }
   
    spinlock_unlock(&box->irq_lock);
    interrupts_restore(ipl);
}
 
/** @}
 */
 

Rev 2927	Rev 3674
1	/*	1	/*
2	* Copyright (c) 2006 Ondrej Palkovsky	2	* Copyright (c) 2006 Ondrej Palkovsky
3	* Copyright (c) 2006 Jakub Jermar	3	* Copyright (c) 2006 Jakub Jermar
4	* All rights reserved.	4	* All rights reserved.
5	*	5	*
6	* Redistribution and use in source and binary forms, with or without	6	* Redistribution and use in source and binary forms, with or without
7	* modification, are permitted provided that the following conditions	7	* modification, are permitted provided that the following conditions
8	* are met:	8	* are met:
9	*	9	*
10	* - Redistributions of source code must retain the above copyright	10	* - Redistributions of source code must retain the above copyright
11	* notice, this list of conditions and the following disclaimer.	11	* notice, this list of conditions and the following disclaimer.
12	* - Redistributions in binary form must reproduce the above copyright	12	* - Redistributions in binary form must reproduce the above copyright
13	* notice, this list of conditions and the following disclaimer in the	13	* notice, this list of conditions and the following disclaimer in the
14	* documentation and/or other materials provided with the distribution.	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	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.	16	* derived from this software without specific prior written permission.
17	*	17	*
18	* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR	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	19	* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
20	* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.	20	* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
21	* IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,	21	* IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
22	* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT	22	* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
23	* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,	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	24	* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25	* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT	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	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.	27	* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28	*/	28	*/
29		29
30	/** @addtogroup genericipc	30	/** @addtogroup genericipc
31	* @{	31	* @{
32	*/	32	*/
33	/**	33	/**
34	* @file	34	* @file
35	* @brief IRQ notification framework.	35	* @brief IRQ notification framework.
36	*	36	*
37	* This framework allows applications to register to receive a notification	37	* This framework allows applications to register to receive a notification
38	* when interrupt is detected. The application may provide a simple 'top-half'	38	* when interrupt is detected. The application may provide a simple 'top-half'
39	* handler as part of its registration, which can perform simple operations	39	* handler as part of its registration, which can perform simple operations
40	* (read/write port/memory, add information to notification ipc message).	40	* (read/write port/memory, add information to notification ipc message).
41	*	41	*
42	* The structure of a notification message is as follows:	42	* The structure of a notification message is as follows:
43	* - METHOD: method as registered by the SYS_IPC_REGISTER_IRQ syscall	43	* - METHOD: method as registered by the SYS_IPC_REGISTER_IRQ syscall
44	* - ARG1: payload modified by a 'top-half' handler	44	* - ARG1: payload modified by a 'top-half' handler
45	* - ARG2: payload modified by a 'top-half' handler	45	* - ARG2: payload modified by a 'top-half' handler
46	* - ARG3: payload modified by a 'top-half' handler	46	* - ARG3: payload modified by a 'top-half' handler
47	* - in_phone_hash: interrupt counter (may be needed to assure correct order	47	* - in_phone_hash: interrupt counter (may be needed to assure correct order
48	* in multithreaded drivers)	48	* in multithreaded drivers)
49	*/	49	*/
50		50
51	#include <arch.h>	51	#include <arch.h>
52	#include <mm/slab.h>	52	#include <mm/slab.h>
53	#include <errno.h>	53	#include <errno.h>
54	#include <ddi/irq.h>	54	#include <ddi/irq.h>
55	#include <ipc/ipc.h>	55	#include <ipc/ipc.h>
56	#include <ipc/irq.h>	56	#include <ipc/irq.h>
57	#include <syscall/copy.h>	57	#include <syscall/copy.h>
58	#include <console/console.h>	58	#include <console/console.h>
59	#include <print.h>	59	#include <print.h>
60		60
61	/** Execute code associated with IRQ notification.	61	/** Execute code associated with IRQ notification.
62	*	62	*
63	* @param call Notification call.	63	* @param call Notification call.
64	* @param code Top-half pseudocode.	64	* @param code Top-half pseudocode.
65	*/	65	*/
66	static void code_execute(call_t call, irq_code_t code)	66	static void code_execute(call_t call, irq_code_t code)
67	{	67	{
68	unsigned int i;	68	unsigned int i;
69	unative_t dstval = 0;	69	unative_t dstval = 0;
70		70
71	if (!code)	71	if (!code)
72	return;	72	return;
73		73
74	for (i = 0; i < code->cmdcount; i++) {	74	for (i = 0; i < code->cmdcount; i++) {
75	switch (code->cmds[i].cmd) {	75	switch (code->cmds[i].cmd) {
76	case CMD_MEM_READ_1:	76	case CMD_MEM_READ_1:
77	dstval = ((uint8_t ) code->cmds[i].addr);	77	dstval = ((uint8_t ) code->cmds[i].addr);
78	break;	78	break;
79	case CMD_MEM_READ_2:	79	case CMD_MEM_READ_2:
80	dstval = ((uint16_t ) code->cmds[i].addr);	80	dstval = ((uint16_t ) code->cmds[i].addr);
81	break;	81	break;
82	case CMD_MEM_READ_4:	82	case CMD_MEM_READ_4:
83	dstval = ((uint32_t ) code->cmds[i].addr);	83	dstval = ((uint32_t ) code->cmds[i].addr);
84	break;	84	break;
85	case CMD_MEM_READ_8:	85	case CMD_MEM_READ_8:
86	dstval = ((uint64_t ) code->cmds[i].addr);	86	dstval = ((uint64_t ) code->cmds[i].addr);
87	break;	87	break;
88	case CMD_MEM_WRITE_1:	88	case CMD_MEM_WRITE_1:
89	((uint8_t ) code->cmds[i].addr) = code->cmds[i].value;	89	((uint8_t ) code->cmds[i].addr) = code->cmds[i].value;
90	break;	90	break;
91	case CMD_MEM_WRITE_2:	91	case CMD_MEM_WRITE_2:
92	((uint16_t ) code->cmds[i].addr) =	92	((uint16_t ) code->cmds[i].addr) =
93	code->cmds[i].value;	93	code->cmds[i].value;
94	break;	94	break;
95	case CMD_MEM_WRITE_4:	95	case CMD_MEM_WRITE_4:
96	((uint32_t ) code->cmds[i].addr) =	96	((uint32_t ) code->cmds[i].addr) =
97	code->cmds[i].value;	97	code->cmds[i].value;
98	break;	98	break;
99	case CMD_MEM_WRITE_8:	99	case CMD_MEM_WRITE_8:
100	((uint64_t ) code->cmds[i].addr) =	100	((uint64_t ) code->cmds[i].addr) =
101	code->cmds[i].value;	101	code->cmds[i].value;
102	break;	102	break;
103	#if defined(ia32) \|\| defined(amd64)	103	#if defined(ia32) \|\| defined(amd64) \|\| defined(ia64)
104	case CMD_PORT_READ_1:	104	case CMD_PORT_READ_1:
105	dstval = inb((long) code->cmds[i].addr);	105	dstval = inb((long) code->cmds[i].addr);
106	break;	106	break;
107	case CMD_PORT_WRITE_1:	107	case CMD_PORT_WRITE_1:
108	outb((long) code->cmds[i].addr, code->cmds[i].value);	108	outb((long) code->cmds[i].addr, code->cmds[i].value);
109	break;	109	break;
110	#endif	110	#endif
111	#if defined(ia64) && defined(SKI)	111	#if defined(ia64) && defined(SKI)
112	case CMD_IA64_GETCHAR:	112	case CMD_IA64_GETCHAR:
113	dstval = _getc(&ski_uconsole);	113	dstval = _getc(&ski_uconsole);
114	break;	114	break;
115	#endif	115	#endif
116	#if defined(ppc32)	116	#if defined(ppc32)
117	case CMD_PPC32_GETCHAR:	117	case CMD_PPC32_GETCHAR:
118	dstval = cuda_get_scancode();	118	dstval = cuda_get_scancode();
119	break;	119	break;
120	#endif	120	#endif
121	default:	121	default:
122	break;	122	break;
123	}	123	}
124	if (code->cmds[i].dstarg && code->cmds[i].dstarg <	124	if (code->cmds[i].dstarg && code->cmds[i].dstarg <
125	IPC_CALL_LEN) {	125	IPC_CALL_LEN) {
126	call->data.args[code->cmds[i].dstarg] = dstval;	126	call->data.args[code->cmds[i].dstarg] = dstval;
127	}	127	}
128	}	128	}
129	}	129	}
130		130
131	/** Free top-half pseudocode.	131	/** Free top-half pseudocode.
132	*	132	*
133	* @param code Pointer to the top-half pseudocode.	133	* @param code Pointer to the top-half pseudocode.
134	*/	134	*/
135	static void code_free(irq_code_t *code)	135	static void code_free(irq_code_t *code)
136	{	136	{
137	if (code) {	137	if (code) {
138	free(code->cmds);	138	free(code->cmds);
139	free(code);	139	free(code);
140	}	140	}
141	}	141	}
142		142
143	/** Copy top-half pseudocode from userspace into the kernel.	143	/** Copy top-half pseudocode from userspace into the kernel.
144	*	144	*
145	* @param ucode Userspace address of the top-half pseudocode.	145	* @param ucode Userspace address of the top-half pseudocode.
146	*	146	*
147	* @return Kernel address of the copied pseudocode.	147	* @return Kernel address of the copied pseudocode.
148	*/	148	*/
149	static irq_code_t code_from_uspace(irq_code_t ucode)	149	static irq_code_t code_from_uspace(irq_code_t ucode)
150	{	150	{
151	irq_code_t *code;	151	irq_code_t *code;
152	irq_cmd_t *ucmds;	152	irq_cmd_t *ucmds;
153	int rc;	153	int rc;
154		154
155	code = malloc(sizeof(*code), 0);	155	code = malloc(sizeof(*code), 0);
156	rc = copy_from_uspace(code, ucode, sizeof(*code));	156	rc = copy_from_uspace(code, ucode, sizeof(*code));
157	if (rc != 0) {	157	if (rc != 0) {
158	free(code);	158	free(code);
159	return NULL;	159	return NULL;
160	}	160	}
161		161
162	if (code->cmdcount > IRQ_MAX_PROG_SIZE) {	162	if (code->cmdcount > IRQ_MAX_PROG_SIZE) {
163	free(code);	163	free(code);
164	return NULL;	164	return NULL;
165	}	165	}
166	ucmds = code->cmds;	166	ucmds = code->cmds;
167	code->cmds = malloc(sizeof(code->cmds[0]) * code->cmdcount, 0);	167	code->cmds = malloc(sizeof(code->cmds[0]) * code->cmdcount, 0);
168	rc = copy_from_uspace(code->cmds, ucmds,	168	rc = copy_from_uspace(code->cmds, ucmds,
169	sizeof(code->cmds[0]) * code->cmdcount);	169	sizeof(code->cmds[0]) * code->cmdcount);
170	if (rc != 0) {	170	if (rc != 0) {
171	free(code->cmds);	171	free(code->cmds);
172	free(code);	172	free(code);
173	return NULL;	173	return NULL;
174	}	174	}
175		175
176	return code;	176	return code;
177	}	177	}
178		178
179	/** Unregister task from IRQ notification.	179	/** Unregister task from IRQ notification.
180	*	180	*
181	* @param box Answerbox associated with the notification.	181	* @param box Answerbox associated with the notification.
182	* @param inr IRQ number.	182	* @param inr IRQ number.
183	* @param devno Device number.	183	* @param devno Device number.
184	*/	184	*/
185	void ipc_irq_unregister(answerbox_t *box, inr_t inr, devno_t devno)	185	void ipc_irq_unregister(answerbox_t *box, inr_t inr, devno_t devno)
186	{	186	{
187	ipl_t ipl;	187	ipl_t ipl;
188	irq_t *irq;	188	irq_t *irq;
189		189
190	ipl = interrupts_disable();	190	ipl = interrupts_disable();
191	irq = irq_find_and_lock(inr, devno);	191	irq = irq_find_and_lock(inr, devno);
192	if (irq) {	192	if (irq) {
193	if (irq->notif_cfg.answerbox == box) {	193	if (irq->notif_cfg.answerbox == box) {
194	code_free(irq->notif_cfg.code);	194	code_free(irq->notif_cfg.code);
195	irq->notif_cfg.notify = false;	195	irq->notif_cfg.notify = false;
196	irq->notif_cfg.answerbox = NULL;	196	irq->notif_cfg.answerbox = NULL;
197	irq->notif_cfg.code = NULL;	197	irq->notif_cfg.code = NULL;
198	irq->notif_cfg.method = 0;	198	irq->notif_cfg.method = 0;
199	irq->notif_cfg.counter = 0;	199	irq->notif_cfg.counter = 0;
200		200
201	spinlock_lock(&box->irq_lock);	201	spinlock_lock(&box->irq_lock);
202	list_remove(&irq->notif_cfg.link);	202	list_remove(&irq->notif_cfg.link);
203	spinlock_unlock(&box->irq_lock);	203	spinlock_unlock(&box->irq_lock);
204		204
205	spinlock_unlock(&irq->lock);	205	spinlock_unlock(&irq->lock);
206	}	206	}
207	}	207	}
208	interrupts_restore(ipl);	208	interrupts_restore(ipl);
209	}	209	}
210		210
211	/** Register an answerbox as a receiving end for IRQ notifications.	211	/** Register an answerbox as a receiving end for IRQ notifications.
212	*	212	*
213	* @param box Receiving answerbox.	213	* @param box Receiving answerbox.
214	* @param inr IRQ number.	214	* @param inr IRQ number.
215	* @param devno Device number.	215	* @param devno Device number.
216	* @param method Method to be associated with the notification.	216	* @param method Method to be associated with the notification.
217	* @param ucode Uspace pointer to top-half pseudocode.	217	* @param ucode Uspace pointer to top-half pseudocode.
218	*	218	*
219	* @return EBADMEM, ENOENT or EEXISTS on failure or 0 on success.	219	* @return EBADMEM, ENOENT or EEXISTS on failure or 0 on success.
220	*/	220	*/
221	int ipc_irq_register(answerbox_t *box, inr_t inr, devno_t devno,	221	int ipc_irq_register(answerbox_t *box, inr_t inr, devno_t devno,
222	unative_t method, irq_code_t *ucode)	222	unative_t method, irq_code_t *ucode)
223	{	223	{
224	ipl_t ipl;	224	ipl_t ipl;
225	irq_code_t *code;	225	irq_code_t *code;
226	irq_t *irq;	226	irq_t *irq;
227		227
228	if (ucode) {	228	if (ucode) {
229	code = code_from_uspace(ucode);	229	code = code_from_uspace(ucode);
230	if (!code)	230	if (!code)
231	return EBADMEM;	231	return EBADMEM;
232	} else {	232	} else {
233	code = NULL;	233	code = NULL;
234	}	234	}
235		235
236	ipl = interrupts_disable();	236	ipl = interrupts_disable();
237	irq = irq_find_and_lock(inr, devno);	237	irq = irq_find_and_lock(inr, devno);
238	if (!irq) {	238	if (!irq) {
239	interrupts_restore(ipl);	239	interrupts_restore(ipl);
240	code_free(code);	240	code_free(code);
241	return ENOENT;	241	return ENOENT;
242	}	242	}
243		243
244	if (irq->notif_cfg.answerbox) {	244	if (irq->notif_cfg.answerbox) {
245	spinlock_unlock(&irq->lock);	245	spinlock_unlock(&irq->lock);
246	interrupts_restore(ipl);	246	interrupts_restore(ipl);
247	code_free(code);	247	code_free(code);
248	return EEXISTS;	248	return EEXISTS;
249	}	249	}
250		250
251	irq->notif_cfg.notify = true;	251	irq->notif_cfg.notify = true;
252	irq->notif_cfg.answerbox = box;	252	irq->notif_cfg.answerbox = box;
253	irq->notif_cfg.method = method;	253	irq->notif_cfg.method = method;
254	irq->notif_cfg.code = code;	254	irq->notif_cfg.code = code;
255	irq->notif_cfg.counter = 0;	255	irq->notif_cfg.counter = 0;
256		256
257	spinlock_lock(&box->irq_lock);	257	spinlock_lock(&box->irq_lock);
258	list_append(&irq->notif_cfg.link, &box->irq_head);	258	list_append(&irq->notif_cfg.link, &box->irq_head);
259	spinlock_unlock(&box->irq_lock);	259	spinlock_unlock(&box->irq_lock);
260		260
261	spinlock_unlock(&irq->lock);	261	spinlock_unlock(&irq->lock);
262	interrupts_restore(ipl);	262	interrupts_restore(ipl);
263		263
264	return 0;	264	return 0;
265	}	265	}
266		266
267	/** Add a call to the proper answerbox queue.	267	/** Add a call to the proper answerbox queue.
268	*	268	*
269	* Assume irq->lock is locked.	269	* Assume irq->lock is locked.
270	*	270	*
271	* @param irq IRQ structure referencing the target answerbox.	271	* @param irq IRQ structure referencing the target answerbox.
272	* @param call IRQ notification call.	272	* @param call IRQ notification call.
273	*/	273	*/
274	static void send_call(irq_t irq, call_t call)	274	static void send_call(irq_t irq, call_t call)
275	{	275	{
276	spinlock_lock(&irq->notif_cfg.answerbox->irq_lock);	276	spinlock_lock(&irq->notif_cfg.answerbox->irq_lock);
277	list_append(&call->link, &irq->notif_cfg.answerbox->irq_notifs);	277	list_append(&call->link, &irq->notif_cfg.answerbox->irq_notifs);
278	spinlock_unlock(&irq->notif_cfg.answerbox->irq_lock);	278	spinlock_unlock(&irq->notif_cfg.answerbox->irq_lock);
279		279
280	waitq_wakeup(&irq->notif_cfg.answerbox->wq, WAKEUP_FIRST);	280	waitq_wakeup(&irq->notif_cfg.answerbox->wq, WAKEUP_FIRST);
281	}	281	}
282		282
283	/** Send notification message.	283	/** Send notification message.
284	*	284	*
285	* @param irq IRQ structure.	285	* @param irq IRQ structure.
286	* @param a1 Driver-specific payload argument.	286	* @param a1 Driver-specific payload argument.
287	* @param a2 Driver-specific payload argument.	287	* @param a2 Driver-specific payload argument.
288	* @param a3 Driver-specific payload argument.	288	* @param a3 Driver-specific payload argument.
289	* @param a4 Driver-specific payload argument.	289	* @param a4 Driver-specific payload argument.
290	* @param a5 Driver-specific payload argument.	290	* @param a5 Driver-specific payload argument.
291	*/	291	*/
292	void ipc_irq_send_msg(irq_t *irq, unative_t a1, unative_t a2, unative_t a3,	292	void ipc_irq_send_msg(irq_t *irq, unative_t a1, unative_t a2, unative_t a3,
293	unative_t a4, unative_t a5)	293	unative_t a4, unative_t a5)
294	{	294	{
295	call_t *call;	295	call_t *call;
296		296
297	spinlock_lock(&irq->lock);	297	spinlock_lock(&irq->lock);
298		298
299	if (irq->notif_cfg.answerbox) {	299	if (irq->notif_cfg.answerbox) {
300	call = ipc_call_alloc(FRAME_ATOMIC);	300	call = ipc_call_alloc(FRAME_ATOMIC);
301	if (!call) {	301	if (!call) {
302	spinlock_unlock(&irq->lock);	302	spinlock_unlock(&irq->lock);
303	return;	303	return;
304	}	304	}
305	call->flags \|= IPC_CALL_NOTIF;	305	call->flags \|= IPC_CALL_NOTIF;
306	IPC_SET_METHOD(call->data, irq->notif_cfg.method);	306	IPC_SET_METHOD(call->data, irq->notif_cfg.method);
307	IPC_SET_ARG1(call->data, a1);	307	IPC_SET_ARG1(call->data, a1);
308	IPC_SET_ARG2(call->data, a2);	308	IPC_SET_ARG2(call->data, a2);
309	IPC_SET_ARG3(call->data, a3);	309	IPC_SET_ARG3(call->data, a3);
310	IPC_SET_ARG4(call->data, a4);	310	IPC_SET_ARG4(call->data, a4);
311	IPC_SET_ARG5(call->data, a5);	311	IPC_SET_ARG5(call->data, a5);
312	/* Put a counter to the message */	312	/* Put a counter to the message */
313	call->priv = ++irq->notif_cfg.counter;	313	call->priv = ++irq->notif_cfg.counter;
314		314
315	send_call(irq, call);	315	send_call(irq, call);
316	}	316	}
317	spinlock_unlock(&irq->lock);	317	spinlock_unlock(&irq->lock);
318	}	318	}
319		319
320	/** Notify a task that an IRQ had occurred.	320	/** Notify a task that an IRQ had occurred.
321	*	321	*
322	* We expect interrupts to be disabled and the irq->lock already held.	322	* We expect interrupts to be disabled and the irq->lock already held.
323	*	323	*
324	* @param irq IRQ structure.	324	* @param irq IRQ structure.
325	*/	325	*/
326	void ipc_irq_send_notif(irq_t *irq)	326	void ipc_irq_send_notif(irq_t *irq)
327	{	327	{
328	call_t *call;	328	call_t *call;
329		329
330	ASSERT(irq);	330	ASSERT(irq);
331		331
332	if (irq->notif_cfg.answerbox) {	332	if (irq->notif_cfg.answerbox) {
333	call = ipc_call_alloc(FRAME_ATOMIC);	333	call = ipc_call_alloc(FRAME_ATOMIC);
334	if (!call) {	334	if (!call) {
335	return;	335	return;
336	}	336	}
337	call->flags \|= IPC_CALL_NOTIF;	337	call->flags \|= IPC_CALL_NOTIF;
338	/* Put a counter to the message */	338	/* Put a counter to the message */
339	call->priv = ++irq->notif_cfg.counter;	339	call->priv = ++irq->notif_cfg.counter;
340	/* Set up args */	340	/* Set up args */
341	IPC_SET_METHOD(call->data, irq->notif_cfg.method);	341	IPC_SET_METHOD(call->data, irq->notif_cfg.method);
342		342
343	/* Execute code to handle irq */	343	/* Execute code to handle irq */
344	code_execute(call, irq->notif_cfg.code);	344	code_execute(call, irq->notif_cfg.code);
345		345
346	send_call(irq, call);	346	send_call(irq, call);
347	}	347	}
348	}	348	}
349		349
350	/** Disconnect all IRQ notifications from an answerbox.	350	/** Disconnect all IRQ notifications from an answerbox.
351	*	351	*
352	* This function is effective because the answerbox contains	352	* This function is effective because the answerbox contains
353	* list of all irq_t structures that are registered to	353	* list of all irq_t structures that are registered to
354	* send notifications to it.	354	* send notifications to it.
355	*	355	*
356	* @param box Answerbox for which we want to carry out the cleanup.	356	* @param box Answerbox for which we want to carry out the cleanup.
357	*/	357	*/
358	void ipc_irq_cleanup(answerbox_t *box)	358	void ipc_irq_cleanup(answerbox_t *box)
359	{	359	{
360	ipl_t ipl;	360	ipl_t ipl;
361		361
362	loop:	362	loop:
363	ipl = interrupts_disable();	363	ipl = interrupts_disable();
364	spinlock_lock(&box->irq_lock);	364	spinlock_lock(&box->irq_lock);
365		365
366	while (box->irq_head.next != &box->irq_head) {	366	while (box->irq_head.next != &box->irq_head) {
367	link_t *cur = box->irq_head.next;	367	link_t *cur = box->irq_head.next;
368	irq_t *irq;	368	irq_t *irq;
369	DEADLOCK_PROBE_INIT(p_irqlock);	369	DEADLOCK_PROBE_INIT(p_irqlock);
370		370
371	irq = list_get_instance(cur, irq_t, notif_cfg.link);	371	irq = list_get_instance(cur, irq_t, notif_cfg.link);
372	if (!spinlock_trylock(&irq->lock)) {	372	if (!spinlock_trylock(&irq->lock)) {
373	/*	373	/*
374	* Avoid deadlock by trying again.	374	* Avoid deadlock by trying again.
375	*/	375	*/
376	spinlock_unlock(&box->irq_lock);	376	spinlock_unlock(&box->irq_lock);
377	interrupts_restore(ipl);	377	interrupts_restore(ipl);
378	DEADLOCK_PROBE(p_irqlock, DEADLOCK_THRESHOLD);	378	DEADLOCK_PROBE(p_irqlock, DEADLOCK_THRESHOLD);
379	goto loop;	379	goto loop;
380	}	380	}
381		381
382	ASSERT(irq->notif_cfg.answerbox == box);	382	ASSERT(irq->notif_cfg.answerbox == box);
383		383
384	list_remove(&irq->notif_cfg.link);	384	list_remove(&irq->notif_cfg.link);
385		385
386	/*	386	/*
387	* Don't forget to free any top-half pseudocode.	387	* Don't forget to free any top-half pseudocode.
388	*/	388	*/
389	code_free(irq->notif_cfg.code);	389	code_free(irq->notif_cfg.code);
390		390
391	irq->notif_cfg.notify = false;	391	irq->notif_cfg.notify = false;
392	irq->notif_cfg.answerbox = NULL;	392	irq->notif_cfg.answerbox = NULL;
393	irq->notif_cfg.code = NULL;	393	irq->notif_cfg.code = NULL;
394	irq->notif_cfg.method = 0;	394	irq->notif_cfg.method = 0;
395	irq->notif_cfg.counter = 0;	395	irq->notif_cfg.counter = 0;
396		396
397	spinlock_unlock(&irq->lock);	397	spinlock_unlock(&irq->lock);
398	}	398	}
399		399
400	spinlock_unlock(&box->irq_lock);	400	spinlock_unlock(&box->irq_lock);
401	interrupts_restore(ipl);	401	interrupts_restore(ipl);
402	}	402	}
403		403
404	/** @}	404	/** @}
405	*/	405	*/
406		406

Subversion Repositories HelenOS

(root)/branches/dynload/kernel/generic/src/ipc/irq.c – Rev 2927 → 3674