Subversion Repositories HelenOS

Rev

Rev 1875 | Rev 1932 | Go to most recent revision | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
1281 palkovsky 1
/*
2
 * Copyright (C) 2006 Ondrej Palkovsky
1923 jermar 3
 * Copyright (C) 2006 Jakub Jermar
1281 palkovsky 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
 
1757 jermar 30
/** @addtogroup genericipc
1702 cejka 31
 * @{
32
 */
1757 jermar 33
/**
34
 * @file
35
 * @brief IRQ notification framework.
1284 palkovsky 36
 *
37
 * This framework allows applications to register to receive a notification
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
40
 * (read/write port/memory, add information to notification ipc message).
41
 *
42
 * The structure of a notification message is as follows:
1923 jermar 43
 * - METHOD: method as registered by the SYS_IPC_REGISTER_IRQ syscall
1693 palkovsky 44
 * - ARG1: payload modified by a 'top-half' handler
1923 jermar 45
 * - ARG2: payload modified by a 'top-half' handler
46
 * - ARG3: payload modified by a 'top-half' handler
1693 palkovsky 47
 * - in_phone_hash: interrupt counter (may be needed to assure correct order
1284 palkovsky 48
 *         in multithreaded drivers)
49
 */
50
 
1281 palkovsky 51
#include <arch.h>
52
#include <mm/slab.h>
53
#include <errno.h>
1923 jermar 54
#include <ddi/irq.h>
1281 palkovsky 55
#include <ipc/ipc.h>
56
#include <ipc/irq.h>
1288 jermar 57
#include <syscall/copy.h>
1507 vana 58
#include <console/console.h>
1875 jermar 59
#include <print.h>
1281 palkovsky 60
 
1923 jermar 61
/** Execute code associated with IRQ notification.
62
 *
63
 * @param call Notification call.
64
 * @param code Top-half pseudocode.
65
 */
1281 palkovsky 66
static void code_execute(call_t *call, irq_code_t *code)
67
{
68
    int i;
1780 jermar 69
    unative_t dstval = 0;
1628 decky 70
 
1281 palkovsky 71
    if (!code)
72
        return;
73
 
74
    for (i=0; i < code->cmdcount;i++) {
75
        switch (code->cmds[i].cmd) {
76
        case CMD_MEM_READ_1:
1780 jermar 77
            dstval = *((uint8_t *)code->cmds[i].addr);
1281 palkovsky 78
            break;
79
        case CMD_MEM_READ_2:
1780 jermar 80
            dstval = *((uint16_t *)code->cmds[i].addr);
1281 palkovsky 81
            break;
82
        case CMD_MEM_READ_4:
1780 jermar 83
            dstval = *((uint32_t *)code->cmds[i].addr);
1281 palkovsky 84
            break;
85
        case CMD_MEM_READ_8:
1780 jermar 86
            dstval = *((uint64_t *)code->cmds[i].addr);
1281 palkovsky 87
            break;
88
        case CMD_MEM_WRITE_1:
1780 jermar 89
            *((uint8_t *)code->cmds[i].addr) = code->cmds[i].value;
1281 palkovsky 90
            break;
91
        case CMD_MEM_WRITE_2:
1780 jermar 92
            *((uint16_t *)code->cmds[i].addr) = code->cmds[i].value;
1281 palkovsky 93
            break;
94
        case CMD_MEM_WRITE_4:
1780 jermar 95
            *((uint32_t *)code->cmds[i].addr) = code->cmds[i].value;
1281 palkovsky 96
            break;
97
        case CMD_MEM_WRITE_8:
1780 jermar 98
            *((uint64_t *)code->cmds[i].addr) = code->cmds[i].value;
1281 palkovsky 99
            break;
1284 palkovsky 100
#if defined(ia32) || defined(amd64)
101
        case CMD_PORT_READ_1:
1693 palkovsky 102
            dstval = inb((long)code->cmds[i].addr);
1284 palkovsky 103
            break;
104
        case CMD_PORT_WRITE_1:
105
            outb((long)code->cmds[i].addr, code->cmds[i].value);
106
            break;
107
#endif
1507 vana 108
#if defined(ia64) 
109
        case CMD_IA64_GETCHAR:
1693 palkovsky 110
            dstval = _getc(&ski_uconsole);
1507 vana 111
            break;
112
#endif
1628 decky 113
#if defined(ppc32)
1625 decky 114
        case CMD_PPC32_GETCHAR:
1693 palkovsky 115
            dstval = cuda_get_scancode();
1625 decky 116
            break;
117
#endif
1281 palkovsky 118
        default:
119
            break;
120
        }
1693 palkovsky 121
        if (code->cmds[i].dstarg && code->cmds[i].dstarg < 4) {
122
            call->data.args[code->cmds[i].dstarg] = dstval;
123
        }
1281 palkovsky 124
    }
125
}
126
 
127
static void code_free(irq_code_t *code)
128
{
129
    if (code) {
130
        free(code->cmds);
131
        free(code);
132
    }
133
}
134
 
135
static irq_code_t * code_from_uspace(irq_code_t *ucode)
136
{
137
    irq_code_t *code;
138
    irq_cmd_t *ucmds;
1288 jermar 139
    int rc;
1281 palkovsky 140
 
141
    code = malloc(sizeof(*code), 0);
1288 jermar 142
    rc = copy_from_uspace(code, ucode, sizeof(*code));
143
    if (rc != 0) {
144
        free(code);
145
        return NULL;
146
    }
1281 palkovsky 147
 
148
    if (code->cmdcount > IRQ_MAX_PROG_SIZE) {
149
        free(code);
150
        return NULL;
151
    }
152
    ucmds = code->cmds;
153
    code->cmds = malloc(sizeof(code->cmds[0]) * (code->cmdcount), 0);
1288 jermar 154
    rc = copy_from_uspace(code->cmds, ucmds, sizeof(code->cmds[0]) * (code->cmdcount));
155
    if (rc != 0) {
156
        free(code->cmds);
157
        free(code);
158
        return NULL;
159
    }
1281 palkovsky 160
 
161
    return code;
162
}
163
 
1923 jermar 164
/** Unregister task from IRQ notification.
165
 *
166
 * @param box Answerbox associated with the notification.
167
 * @param inr IRQ numbe.
168
 * @param devno Device number.
169
 */
170
void ipc_irq_unregister(answerbox_t *box, inr_t inr, devno_t devno)
1281 palkovsky 171
{
172
    ipl_t ipl;
1923 jermar 173
    irq_t *irq;
1281 palkovsky 174
 
175
    ipl = interrupts_disable();
1923 jermar 176
    irq = irq_find_and_lock(inr, devno);
177
    if (irq) {
178
        if (irq->notif_cfg.answerbox == box) {
179
            code_free(irq->notif_cfg.code);
180
            irq->notif_cfg.code = NULL;
181
            irq->notif_cfg.answerbox = NULL;
182
            irq->notif_cfg.method = 0;
183
            irq->notif_cfg.counter = 0;
184
            spinlock_unlock(&irq->lock);
185
        }
1281 palkovsky 186
    }
187
    interrupts_restore(ipl);
188
}
189
 
1923 jermar 190
/** Register an answerbox as a receiving end for IRQ notifications.
191
 *
192
 * @param box Receiving answerbox.
193
 * @param inr IRQ number.
194
 * @param devno Device number.
195
 * @param method Method to be associated with the notification.
196
 * @param ucode Uspace pointer to top-half pseudocode.
197
 *
198
 * @return EBADMEM, ENOENT or EEXISTS on failure or 0 on success.
199
 */
200
int
201
ipc_irq_register(answerbox_t *box, inr_t inr, devno_t devno, unative_t method, irq_code_t *ucode)
1281 palkovsky 202
{
203
    ipl_t ipl;
204
    irq_code_t *code;
1923 jermar 205
    irq_t *irq;
1281 palkovsky 206
 
207
    if (ucode) {
208
        code = code_from_uspace(ucode);
209
        if (!code)
210
            return EBADMEM;
211
    } else
212
        code = NULL;
213
 
214
    ipl = interrupts_disable();
1923 jermar 215
    irq = irq_find_and_lock(inr, devno);
216
    if (!irq) {
1281 palkovsky 217
        interrupts_restore(ipl);
218
        code_free(code);
1923 jermar 219
        return ENOENT;
220
    }
221
 
222
    if (irq->notif_cfg.answerbox) {
223
        spinlock_unlock(&irq->lock);
224
        interrupts_restore(ipl);
225
        code_free(code);
1281 palkovsky 226
        return EEXISTS;
227
    }
1923 jermar 228
 
229
    irq->notif_cfg.answerbox = box;
230
    irq->notif_cfg.method = method;
231
    irq->notif_cfg.code = code;
232
    irq->notif_cfg.counter = 0;
233
    spinlock_unlock(&irq->lock);
1281 palkovsky 234
    interrupts_restore(ipl);
235
 
236
    return 0;
237
}
238
 
1923 jermar 239
/** Add call to proper answerbox queue.
1595 palkovsky 240
 *
1923 jermar 241
 * Assume irq->lock is locked.
242
 *
243
 */
244
static void send_call(irq_t *irq, call_t *call)
1595 palkovsky 245
{
1923 jermar 246
    spinlock_lock(&irq->notif_cfg.answerbox->irq_lock);
247
    list_append(&call->link, &irq->notif_cfg.answerbox->irq_notifs);
248
    spinlock_unlock(&irq->notif_cfg.answerbox->irq_lock);
1595 palkovsky 249
 
1923 jermar 250
    waitq_wakeup(&irq->notif_cfg.answerbox->wq, WAKEUP_FIRST);
1595 palkovsky 251
}
252
 
253
/** Send notification message
254
 *
255
 */
1923 jermar 256
void ipc_irq_send_msg(irq_t *irq, unative_t a1, unative_t a2, unative_t a3)
1595 palkovsky 257
{
258
    call_t *call;
259
 
1923 jermar 260
    spinlock_lock(&irq->lock);
1595 palkovsky 261
 
1923 jermar 262
    if (irq->notif_cfg.answerbox) {
1595 palkovsky 263
        call = ipc_call_alloc(FRAME_ATOMIC);
264
        if (!call) {
1923 jermar 265
            spinlock_unlock(&irq->lock);
1595 palkovsky 266
            return;
267
        }
268
        call->flags |= IPC_CALL_NOTIF;
1923 jermar 269
        IPC_SET_METHOD(call->data, irq->notif_cfg.method);
1693 palkovsky 270
        IPC_SET_ARG1(call->data, a1);
1595 palkovsky 271
        IPC_SET_ARG2(call->data, a2);
272
        IPC_SET_ARG3(call->data, a3);
1693 palkovsky 273
        /* Put a counter to the message */
1923 jermar 274
        call->private = ++irq->notif_cfg.counter;
1595 palkovsky 275
 
1923 jermar 276
        send_call(irq, call);
1595 palkovsky 277
    }
1923 jermar 278
    spinlock_unlock(&irq->lock);
1595 palkovsky 279
}
280
 
1698 jermar 281
/** Notify task that an irq had occurred.
1281 palkovsky 282
 *
1923 jermar 283
 * We expect interrupts to be disabled and the irq->lock already held.
1281 palkovsky 284
 */
1923 jermar 285
void ipc_irq_send_notif(irq_t *irq)
1281 palkovsky 286
{
287
    call_t *call;
288
 
1923 jermar 289
    ASSERT(irq);
1281 palkovsky 290
 
1923 jermar 291
    if (irq->notif_cfg.answerbox) {
1281 palkovsky 292
        call = ipc_call_alloc(FRAME_ATOMIC);
1591 palkovsky 293
        if (!call) {
294
            return;
295
        }
1281 palkovsky 296
        call->flags |= IPC_CALL_NOTIF;
1693 palkovsky 297
        /* Put a counter to the message */
1923 jermar 298
        call->private = ++irq->notif_cfg.counter;
1693 palkovsky 299
        /* Set up args */
1923 jermar 300
        IPC_SET_METHOD(call->data, irq->notif_cfg.method);
1281 palkovsky 301
 
302
        /* Execute code to handle irq */
1923 jermar 303
        code_execute(call, irq->notif_cfg.code);
1595 palkovsky 304
 
1923 jermar 305
        send_call(irq, call);
1281 palkovsky 306
    }
307
}
308
 
1923 jermar 309
/** Disconnect all IRQ notifications from an answerbox.
1595 palkovsky 310
 *
1923 jermar 311
 * @param box Answerbox for which we want to carry out the cleanup.
1595 palkovsky 312
 */
1281 palkovsky 313
void ipc_irq_cleanup(answerbox_t *box)
314
{
1923 jermar 315
    /* TODO */
1281 palkovsky 316
}
1702 cejka 317
 
1757 jermar 318
/** @}
1702 cejka 319
 */