WebSVN – HelenOS – Diff – /branches/sparc/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 <arch/asm.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 3665	Rev 3862
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 <arch/asm.h>
52	#include <mm/slab.h>	53	#include <mm/slab.h>
53	#include <errno.h>	54	#include <errno.h>
54	#include <ddi/irq.h>	55	#include <ddi/irq.h>
55	#include <ipc/ipc.h>	56	#include <ipc/ipc.h>
56	#include <ipc/irq.h>	57	#include <ipc/irq.h>
57	#include <syscall/copy.h>	58	#include <syscall/copy.h>
58	#include <console/console.h>	59	#include <console/console.h>
59	#include <print.h>	60	#include <print.h>
60		61
61	/** Execute code associated with IRQ notification.	62	/** Execute code associated with IRQ notification.
62	*	63	*
63	* @param call Notification call.	64	* @param call Notification call.
64	* @param code Top-half pseudocode.	65	* @param code Top-half pseudocode.
65	*/	66	*/
66	static void code_execute(call_t call, irq_code_t code)	67	static void code_execute(call_t call, irq_code_t code)
67	{	68	{
68	unsigned int i;	69	unsigned int i;
69	unative_t dstval = 0;	70	unative_t dstval = 0;
70		71
71	if (!code)	72	if (!code)
72	return;	73	return;
73		74
74	for (i = 0; i < code->cmdcount; i++) {	75	for (i = 0; i < code->cmdcount; i++) {
75	switch (code->cmds[i].cmd) {	76	switch (code->cmds[i].cmd) {
76	case CMD_MEM_READ_1:	77	case CMD_MEM_READ_1:
77	dstval = ((uint8_t ) code->cmds[i].addr);	78	dstval = ((uint8_t ) code->cmds[i].addr);
78	break;	79	break;
79	case CMD_MEM_READ_2:	80	case CMD_MEM_READ_2:
80	dstval = ((uint16_t ) code->cmds[i].addr);	81	dstval = ((uint16_t ) code->cmds[i].addr);
81	break;	82	break;
82	case CMD_MEM_READ_4:	83	case CMD_MEM_READ_4:
83	dstval = ((uint32_t ) code->cmds[i].addr);	84	dstval = ((uint32_t ) code->cmds[i].addr);
84	break;	85	break;
85	case CMD_MEM_READ_8:	86	case CMD_MEM_READ_8:
86	dstval = ((uint64_t ) code->cmds[i].addr);	87	dstval = ((uint64_t ) code->cmds[i].addr);
87	break;	88	break;
88	case CMD_MEM_WRITE_1:	89	case CMD_MEM_WRITE_1:
89	((uint8_t ) code->cmds[i].addr) = code->cmds[i].value;	90	((uint8_t ) code->cmds[i].addr) = code->cmds[i].value;
90	break;	91	break;
91	case CMD_MEM_WRITE_2:	92	case CMD_MEM_WRITE_2:
92	((uint16_t ) code->cmds[i].addr) =	93	((uint16_t ) code->cmds[i].addr) =
93	code->cmds[i].value;	94	code->cmds[i].value;
94	break;	95	break;
95	case CMD_MEM_WRITE_4:	96	case CMD_MEM_WRITE_4:
96	((uint32_t ) code->cmds[i].addr) =	97	((uint32_t ) code->cmds[i].addr) =
97	code->cmds[i].value;	98	code->cmds[i].value;
98	break;	99	break;
99	case CMD_MEM_WRITE_8:	100	case CMD_MEM_WRITE_8:
100	((uint64_t ) code->cmds[i].addr) =	101	((uint64_t ) code->cmds[i].addr) =
101	code->cmds[i].value;	102	code->cmds[i].value;
102	break;	103	break;
103	#if defined(ia32) \|\| defined(amd64) \|\| defined(ia64)	104	#if defined(ia32) \|\| defined(amd64) \|\| defined(ia64)
104	case CMD_PORT_READ_1:	105	case CMD_PORT_READ_1:
105	dstval = inb((long) code->cmds[i].addr);	106	dstval = inb((long) code->cmds[i].addr);
106	break;	107	break;
107	case CMD_PORT_WRITE_1:	108	case CMD_PORT_WRITE_1:
108	outb((long) code->cmds[i].addr, code->cmds[i].value);	109	outb((long) code->cmds[i].addr, code->cmds[i].value);
109	break;	110	break;
110	#endif	111	#endif
111	#if defined(ia64) && defined(SKI)	112	#if defined(ia64) && defined(SKI)
112	case CMD_IA64_GETCHAR:	113	case CMD_IA64_GETCHAR:
113	dstval = _getc(&ski_uconsole);	114	dstval = _getc(&ski_uconsole);
114	break;	115	break;
115	#endif	116	#endif
116	#if defined(ppc32)	117	#if defined(ppc32)
117	case CMD_PPC32_GETCHAR:	118	case CMD_PPC32_GETCHAR:
118	dstval = cuda_get_scancode();	119	dstval = cuda_get_scancode();
119	break;	120	break;
120	#endif	121	#endif
121	default:	122	default:
122	break;	123	break;
123	}	124	}
124	if (code->cmds[i].dstarg && code->cmds[i].dstarg <	125	if (code->cmds[i].dstarg && code->cmds[i].dstarg <
125	IPC_CALL_LEN) {	126	IPC_CALL_LEN) {
126	call->data.args[code->cmds[i].dstarg] = dstval;	127	call->data.args[code->cmds[i].dstarg] = dstval;
127	}	128	}
128	}	129	}
129	}	130	}
130		131
131	/** Free top-half pseudocode.	132	/** Free top-half pseudocode.
132	*	133	*
133	* @param code Pointer to the top-half pseudocode.	134	* @param code Pointer to the top-half pseudocode.
134	*/	135	*/
135	static void code_free(irq_code_t *code)	136	static void code_free(irq_code_t *code)
136	{	137	{
137	if (code) {	138	if (code) {
138	free(code->cmds);	139	free(code->cmds);
139	free(code);	140	free(code);
140	}	141	}
141	}	142	}
142		143
143	/** Copy top-half pseudocode from userspace into the kernel.	144	/** Copy top-half pseudocode from userspace into the kernel.
144	*	145	*
145	* @param ucode Userspace address of the top-half pseudocode.	146	* @param ucode Userspace address of the top-half pseudocode.
146	*	147	*
147	* @return Kernel address of the copied pseudocode.	148	* @return Kernel address of the copied pseudocode.
148	*/	149	*/
149	static irq_code_t code_from_uspace(irq_code_t ucode)	150	static irq_code_t code_from_uspace(irq_code_t ucode)
150	{	151	{
151	irq_code_t *code;	152	irq_code_t *code;
152	irq_cmd_t *ucmds;	153	irq_cmd_t *ucmds;
153	int rc;	154	int rc;
154		155
155	code = malloc(sizeof(*code), 0);	156	code = malloc(sizeof(*code), 0);
156	rc = copy_from_uspace(code, ucode, sizeof(*code));	157	rc = copy_from_uspace(code, ucode, sizeof(*code));
157	if (rc != 0) {	158	if (rc != 0) {
158	free(code);	159	free(code);
159	return NULL;	160	return NULL;
160	}	161	}
161		162
162	if (code->cmdcount > IRQ_MAX_PROG_SIZE) {	163	if (code->cmdcount > IRQ_MAX_PROG_SIZE) {
163	free(code);	164	free(code);
164	return NULL;	165	return NULL;
165	}	166	}
166	ucmds = code->cmds;	167	ucmds = code->cmds;
167	code->cmds = malloc(sizeof(code->cmds[0]) * code->cmdcount, 0);	168	code->cmds = malloc(sizeof(code->cmds[0]) * code->cmdcount, 0);
168	rc = copy_from_uspace(code->cmds, ucmds,	169	rc = copy_from_uspace(code->cmds, ucmds,
169	sizeof(code->cmds[0]) * code->cmdcount);	170	sizeof(code->cmds[0]) * code->cmdcount);
170	if (rc != 0) {	171	if (rc != 0) {
171	free(code->cmds);	172	free(code->cmds);
172	free(code);	173	free(code);
173	return NULL;	174	return NULL;
174	}	175	}
175		176
176	return code;	177	return code;
177	}	178	}
178		179
179	/** Unregister task from IRQ notification.	180	/** Unregister task from IRQ notification.
180	*	181	*
181	* @param box Answerbox associated with the notification.	182	* @param box Answerbox associated with the notification.
182	* @param inr IRQ number.	183	* @param inr IRQ number.
183	* @param devno Device number.	184	* @param devno Device number.
184	*/	185	*/
185	void ipc_irq_unregister(answerbox_t *box, inr_t inr, devno_t devno)	186	void ipc_irq_unregister(answerbox_t *box, inr_t inr, devno_t devno)
186	{	187	{
187	ipl_t ipl;	188	ipl_t ipl;
188	irq_t *irq;	189	irq_t *irq;
189		190
190	ipl = interrupts_disable();	191	ipl = interrupts_disable();
191	irq = irq_find_and_lock(inr, devno);	192	irq = irq_find_and_lock(inr, devno);
192	if (irq) {	193	if (irq) {
193	if (irq->notif_cfg.answerbox == box) {	194	if (irq->notif_cfg.answerbox == box) {
194	code_free(irq->notif_cfg.code);	195	code_free(irq->notif_cfg.code);
195	irq->notif_cfg.notify = false;	196	irq->notif_cfg.notify = false;
196	irq->notif_cfg.answerbox = NULL;	197	irq->notif_cfg.answerbox = NULL;
197	irq->notif_cfg.code = NULL;	198	irq->notif_cfg.code = NULL;
198	irq->notif_cfg.method = 0;	199	irq->notif_cfg.method = 0;
199	irq->notif_cfg.counter = 0;	200	irq->notif_cfg.counter = 0;
200		201
201	spinlock_lock(&box->irq_lock);	202	spinlock_lock(&box->irq_lock);
202	list_remove(&irq->notif_cfg.link);	203	list_remove(&irq->notif_cfg.link);
203	spinlock_unlock(&box->irq_lock);	204	spinlock_unlock(&box->irq_lock);
204		205
205	spinlock_unlock(&irq->lock);	206	spinlock_unlock(&irq->lock);
206	}	207	}
207	}	208	}
208	interrupts_restore(ipl);	209	interrupts_restore(ipl);
209	}	210	}
210		211
211	/** Register an answerbox as a receiving end for IRQ notifications.	212	/** Register an answerbox as a receiving end for IRQ notifications.
212	*	213	*
213	* @param box Receiving answerbox.	214	* @param box Receiving answerbox.
214	* @param inr IRQ number.	215	* @param inr IRQ number.
215	* @param devno Device number.	216	* @param devno Device number.
216	* @param method Method to be associated with the notification.	217	* @param method Method to be associated with the notification.
217	* @param ucode Uspace pointer to top-half pseudocode.	218	* @param ucode Uspace pointer to top-half pseudocode.
218	*	219	*
219	* @return EBADMEM, ENOENT or EEXISTS on failure or 0 on success.	220	* @return EBADMEM, ENOENT or EEXISTS on failure or 0 on success.
220	*/	221	*/
221	int ipc_irq_register(answerbox_t *box, inr_t inr, devno_t devno,	222	int ipc_irq_register(answerbox_t *box, inr_t inr, devno_t devno,
222	unative_t method, irq_code_t *ucode)	223	unative_t method, irq_code_t *ucode)
223	{	224	{
224	ipl_t ipl;	225	ipl_t ipl;
225	irq_code_t *code;	226	irq_code_t *code;
226	irq_t *irq;	227	irq_t *irq;
227		228
228	if (ucode) {	229	if (ucode) {
229	code = code_from_uspace(ucode);	230	code = code_from_uspace(ucode);
230	if (!code)	231	if (!code)
231	return EBADMEM;	232	return EBADMEM;
232	} else {	233	} else {
233	code = NULL;	234	code = NULL;
234	}	235	}
235		236
236	ipl = interrupts_disable();	237	ipl = interrupts_disable();
237	irq = irq_find_and_lock(inr, devno);	238	irq = irq_find_and_lock(inr, devno);
238	if (!irq) {	239	if (!irq) {
239	interrupts_restore(ipl);	240	interrupts_restore(ipl);
240	code_free(code);	241	code_free(code);
241	return ENOENT;	242	return ENOENT;
242	}	243	}
243		244
244	if (irq->notif_cfg.answerbox) {	245	if (irq->notif_cfg.answerbox) {
245	spinlock_unlock(&irq->lock);	246	spinlock_unlock(&irq->lock);
246	interrupts_restore(ipl);	247	interrupts_restore(ipl);
247	code_free(code);	248	code_free(code);
248	return EEXISTS;	249	return EEXISTS;
249	}	250	}
250		251
251	irq->notif_cfg.notify = true;	252	irq->notif_cfg.notify = true;
252	irq->notif_cfg.answerbox = box;	253	irq->notif_cfg.answerbox = box;
253	irq->notif_cfg.method = method;	254	irq->notif_cfg.method = method;
254	irq->notif_cfg.code = code;	255	irq->notif_cfg.code = code;
255	irq->notif_cfg.counter = 0;	256	irq->notif_cfg.counter = 0;
256		257
257	spinlock_lock(&box->irq_lock);	258	spinlock_lock(&box->irq_lock);
258	list_append(&irq->notif_cfg.link, &box->irq_head);	259	list_append(&irq->notif_cfg.link, &box->irq_head);
259	spinlock_unlock(&box->irq_lock);	260	spinlock_unlock(&box->irq_lock);
260		261
261	spinlock_unlock(&irq->lock);	262	spinlock_unlock(&irq->lock);
262	interrupts_restore(ipl);	263	interrupts_restore(ipl);
263		264
264	return 0;	265	return 0;
265	}	266	}
266		267
267	/** Add a call to the proper answerbox queue.	268	/** Add a call to the proper answerbox queue.
268	*	269	*
269	* Assume irq->lock is locked.	270	* Assume irq->lock is locked.
270	*	271	*
271	* @param irq IRQ structure referencing the target answerbox.	272	* @param irq IRQ structure referencing the target answerbox.
272	* @param call IRQ notification call.	273	* @param call IRQ notification call.
273	*/	274	*/
274	static void send_call(irq_t irq, call_t call)	275	static void send_call(irq_t irq, call_t call)
275	{	276	{
276	spinlock_lock(&irq->notif_cfg.answerbox->irq_lock);	277	spinlock_lock(&irq->notif_cfg.answerbox->irq_lock);
277	list_append(&call->link, &irq->notif_cfg.answerbox->irq_notifs);	278	list_append(&call->link, &irq->notif_cfg.answerbox->irq_notifs);
278	spinlock_unlock(&irq->notif_cfg.answerbox->irq_lock);	279	spinlock_unlock(&irq->notif_cfg.answerbox->irq_lock);
279		280
280	waitq_wakeup(&irq->notif_cfg.answerbox->wq, WAKEUP_FIRST);	281	waitq_wakeup(&irq->notif_cfg.answerbox->wq, WAKEUP_FIRST);
281	}	282	}
282		283
283	/** Send notification message.	284	/** Send notification message.
284	*	285	*
285	* @param irq IRQ structure.	286	* @param irq IRQ structure.
286	* @param a1 Driver-specific payload argument.	287	* @param a1 Driver-specific payload argument.
287	* @param a2 Driver-specific payload argument.	288	* @param a2 Driver-specific payload argument.
288	* @param a3 Driver-specific payload argument.	289	* @param a3 Driver-specific payload argument.
289	* @param a4 Driver-specific payload argument.	290	* @param a4 Driver-specific payload argument.
290	* @param a5 Driver-specific payload argument.	291	* @param a5 Driver-specific payload argument.
291	*/	292	*/
292	void ipc_irq_send_msg(irq_t *irq, unative_t a1, unative_t a2, unative_t a3,	293	void ipc_irq_send_msg(irq_t *irq, unative_t a1, unative_t a2, unative_t a3,
293	unative_t a4, unative_t a5)	294	unative_t a4, unative_t a5)
294	{	295	{
295	call_t *call;	296	call_t *call;
296		297
297	spinlock_lock(&irq->lock);	298	spinlock_lock(&irq->lock);
298		299
299	if (irq->notif_cfg.answerbox) {	300	if (irq->notif_cfg.answerbox) {
300	call = ipc_call_alloc(FRAME_ATOMIC);	301	call = ipc_call_alloc(FRAME_ATOMIC);
301	if (!call) {	302	if (!call) {
302	spinlock_unlock(&irq->lock);	303	spinlock_unlock(&irq->lock);
303	return;	304	return;
304	}	305	}
305	call->flags \|= IPC_CALL_NOTIF;	306	call->flags \|= IPC_CALL_NOTIF;
306	IPC_SET_METHOD(call->data, irq->notif_cfg.method);	307	IPC_SET_METHOD(call->data, irq->notif_cfg.method);
307	IPC_SET_ARG1(call->data, a1);	308	IPC_SET_ARG1(call->data, a1);
308	IPC_SET_ARG2(call->data, a2);	309	IPC_SET_ARG2(call->data, a2);
309	IPC_SET_ARG3(call->data, a3);	310	IPC_SET_ARG3(call->data, a3);
310	IPC_SET_ARG4(call->data, a4);	311	IPC_SET_ARG4(call->data, a4);
311	IPC_SET_ARG5(call->data, a5);	312	IPC_SET_ARG5(call->data, a5);
312	/* Put a counter to the message */	313	/* Put a counter to the message */
313	call->priv = ++irq->notif_cfg.counter;	314	call->priv = ++irq->notif_cfg.counter;
314		315
315	send_call(irq, call);	316	send_call(irq, call);
316	}	317	}
317	spinlock_unlock(&irq->lock);	318	spinlock_unlock(&irq->lock);
318	}	319	}
319		320
320	/** Notify a task that an IRQ had occurred.	321	/** Notify a task that an IRQ had occurred.
321	*	322	*
322	* We expect interrupts to be disabled and the irq->lock already held.	323	* We expect interrupts to be disabled and the irq->lock already held.
323	*	324	*
324	* @param irq IRQ structure.	325	* @param irq IRQ structure.
325	*/	326	*/
326	void ipc_irq_send_notif(irq_t *irq)	327	void ipc_irq_send_notif(irq_t *irq)
327	{	328	{
328	call_t *call;	329	call_t *call;
329		330
330	ASSERT(irq);	331	ASSERT(irq);
331		332
332	if (irq->notif_cfg.answerbox) {	333	if (irq->notif_cfg.answerbox) {
333	call = ipc_call_alloc(FRAME_ATOMIC);	334	call = ipc_call_alloc(FRAME_ATOMIC);
334	if (!call) {	335	if (!call) {
335	return;	336	return;
336	}	337	}
337	call->flags \|= IPC_CALL_NOTIF;	338	call->flags \|= IPC_CALL_NOTIF;
338	/* Put a counter to the message */	339	/* Put a counter to the message */
339	call->priv = ++irq->notif_cfg.counter;	340	call->priv = ++irq->notif_cfg.counter;
340	/* Set up args */	341	/* Set up args */
341	IPC_SET_METHOD(call->data, irq->notif_cfg.method);	342	IPC_SET_METHOD(call->data, irq->notif_cfg.method);
342		343
343	/* Execute code to handle irq */	344	/* Execute code to handle irq */
344	code_execute(call, irq->notif_cfg.code);	345	code_execute(call, irq->notif_cfg.code);
345		346
346	send_call(irq, call);	347	send_call(irq, call);
347	}	348	}
348	}	349	}
349		350
350	/** Disconnect all IRQ notifications from an answerbox.	351	/** Disconnect all IRQ notifications from an answerbox.
351	*	352	*
352	* This function is effective because the answerbox contains	353	* This function is effective because the answerbox contains
353	* list of all irq_t structures that are registered to	354	* list of all irq_t structures that are registered to
354	* send notifications to it.	355	* send notifications to it.
355	*	356	*
356	* @param box Answerbox for which we want to carry out the cleanup.	357	* @param box Answerbox for which we want to carry out the cleanup.
357	*/	358	*/
358	void ipc_irq_cleanup(answerbox_t *box)	359	void ipc_irq_cleanup(answerbox_t *box)
359	{	360	{
360	ipl_t ipl;	361	ipl_t ipl;
361		362
362	loop:	363	loop:
363	ipl = interrupts_disable();	364	ipl = interrupts_disable();
364	spinlock_lock(&box->irq_lock);	365	spinlock_lock(&box->irq_lock);
365		366
366	while (box->irq_head.next != &box->irq_head) {	367	while (box->irq_head.next != &box->irq_head) {
367	link_t *cur = box->irq_head.next;	368	link_t *cur = box->irq_head.next;
368	irq_t *irq;	369	irq_t *irq;
369	DEADLOCK_PROBE_INIT(p_irqlock);	370	DEADLOCK_PROBE_INIT(p_irqlock);
370		371
371	irq = list_get_instance(cur, irq_t, notif_cfg.link);	372	irq = list_get_instance(cur, irq_t, notif_cfg.link);
372	if (!spinlock_trylock(&irq->lock)) {	373	if (!spinlock_trylock(&irq->lock)) {
373	/*	374	/*
374	* Avoid deadlock by trying again.	375	* Avoid deadlock by trying again.
375	*/	376	*/
376	spinlock_unlock(&box->irq_lock);	377	spinlock_unlock(&box->irq_lock);
377	interrupts_restore(ipl);	378	interrupts_restore(ipl);
378	DEADLOCK_PROBE(p_irqlock, DEADLOCK_THRESHOLD);	379	DEADLOCK_PROBE(p_irqlock, DEADLOCK_THRESHOLD);
379	goto loop;	380	goto loop;
380	}	381	}
381		382
382	ASSERT(irq->notif_cfg.answerbox == box);	383	ASSERT(irq->notif_cfg.answerbox == box);
383		384
384	list_remove(&irq->notif_cfg.link);	385	list_remove(&irq->notif_cfg.link);
385		386
386	/*	387	/*
387	* Don't forget to free any top-half pseudocode.	388	* Don't forget to free any top-half pseudocode.
388	*/	389	*/
389	code_free(irq->notif_cfg.code);	390	code_free(irq->notif_cfg.code);
390		391
391	irq->notif_cfg.notify = false;	392	irq->notif_cfg.notify = false;
392	irq->notif_cfg.answerbox = NULL;	393	irq->notif_cfg.answerbox = NULL;
393	irq->notif_cfg.code = NULL;	394	irq->notif_cfg.code = NULL;
394	irq->notif_cfg.method = 0;	395	irq->notif_cfg.method = 0;
395	irq->notif_cfg.counter = 0;	396	irq->notif_cfg.counter = 0;
396		397
397	spinlock_unlock(&irq->lock);	398	spinlock_unlock(&irq->lock);
398	}	399	}
399		400
400	spinlock_unlock(&box->irq_lock);	401	spinlock_unlock(&box->irq_lock);
401	interrupts_restore(ipl);	402	interrupts_restore(ipl);
402	}	403	}
403		404
404	/** @}	405	/** @}
405	*/	406	*/
406		407

Subversion Repositories HelenOS

(root)/branches/sparc/kernel/generic/src/ipc/irq.c – Rev 3665 → 3862