Subversion Repositories HelenOS

Rev

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

Rev Author Line No. Line
1 jermar 1
/*
2071 jermar 2
 * Copyright (c) 2001-2004 Jakub Jermar
1 jermar 3
 * All rights reserved.
4
 *
5
 * Redistribution and use in source and binary forms, with or without
6
 * modification, are permitted provided that the following conditions
7
 * are met:
8
 *
9
 * - Redistributions of source code must retain the above copyright
10
 *   notice, this list of conditions and the following disclaimer.
11
 * - Redistributions in binary form must reproduce the above copyright
12
 *   notice, this list of conditions and the following disclaimer in the
13
 *   documentation and/or other materials provided with the distribution.
14
 * - The name of the author may not be used to endorse or promote products
15
 *   derived from this software without specific prior written permission.
16
 *
17
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27
 */
28
 
1754 jermar 29
/** @addtogroup genarch
1702 cejka 30
 * @{
31
 */
1754 jermar 32
/**
1757 jermar 33
 * @file
1754 jermar 34
 * @brief   i8042 processor driver.
35
 *
36
 * It takes care of low-level keyboard functions.
1702 cejka 37
 */
38
 
1842 jermar 39
#include <genarch/kbd/i8042.h>
1843 jermar 40
#include <genarch/kbd/key.h>
1842 jermar 41
#include <genarch/kbd/scanc.h>
42
#include <genarch/kbd/scanc_pc.h>
894 jermar 43
#include <arch/drivers/i8042.h>
1 jermar 44
#include <cpu.h>
45
#include <arch/asm.h>
46
#include <arch.h>
511 jermar 47
#include <console/chardev.h>
48
#include <console/console.h>
576 palkovsky 49
#include <interrupt.h>
1956 decky 50
#include <sysinfo/sysinfo.h>
2089 decky 51
#include <ipc/irq.h>
2463 hudecek 52
#include <synch/rcu.h>
1 jermar 53
 
1754 jermar 54
/* Keyboard commands. */
512 jermar 55
#define KBD_ENABLE  0xf4
56
#define KBD_DISABLE 0xf5
57
#define KBD_ACK     0xfa
58
 
670 vana 59
/*
893 jermar 60
 * 60  Write 8042 Command Byte: next data byte written to port 60h is
895 jermar 61
 *     placed in 8042 command register. Format:
893 jermar 62
 *
63
 *    |7|6|5|4|3|2|1|0|8042 Command Byte
64
 *     | | | | | | | `---- 1=enable output register full interrupt
65
 *     | | | | | | `----- should be 0
66
 *     | | | | | `------ 1=set status register system, 0=clear
67
 *     | | | | `------- 1=override keyboard inhibit, 0=allow inhibit
68
 *     | | | `-------- disable keyboard I/O by driving clock line low
69
 *     | | `--------- disable auxiliary device, drives clock line low
70
 *     | `---------- IBM scancode translation 0=AT, 1=PC/XT
71
 *     `----------- reserved, should be 0
72
 */
670 vana 73
 
893 jermar 74
#define i8042_SET_COMMAND   0x60
1759 palkovsky 75
#define i8042_COMMAND       0x69
894 jermar 76
 
77
#define i8042_BUFFER_FULL_MASK  0x01
893 jermar 78
#define i8042_WAIT_MASK     0x02
1759 palkovsky 79
#define i8042_MOUSE_DATA        0x20
670 vana 80
 
575 palkovsky 81
static void i8042_suspend(chardev_t *);
82
static void i8042_resume(chardev_t *);
511 jermar 83
 
84
static chardev_operations_t ops = {
85
    .suspend = i8042_suspend,
878 vana 86
    .resume = i8042_resume,
1896 jermar 87
    .read = i8042_key_read
511 jermar 88
};
89
 
1956 decky 90
/** Structure for i8042's IRQ. */
1957 decky 91
static irq_t i8042_kbd_irq;
92
static irq_t i8042_mouse_irq;
576 palkovsky 93
 
1956 decky 94
/** Wait until the controller reads its data. */
95
static void i8042_wait(void) {
96
    while (i8042_status_read() & i8042_WAIT_MASK) {
97
        /* wait */
98
    }
99
}
100
 
1474 palkovsky 101
void i8042_grab(void)
1 jermar 102
{
1956 decky 103
    ipl_t ipl = interrupts_disable();
104
 
895 jermar 105
    i8042_wait();
894 jermar 106
    i8042_command_write(i8042_SET_COMMAND);
895 jermar 107
    i8042_wait();
894 jermar 108
    i8042_data_write(i8042_COMMAND);
895 jermar 109
    i8042_wait();
1956 decky 110
 
2456 hudecek 111
    //rcu_read_lock() is not needed, ints are disabled
112
    //rcu: atomic update doesn't need reallocation
113
    rcu_dereference_pointer(i8042_kbd_irq.notif_cfg).notify = false;
1957 decky 114
 
2456 hudecek 115
    rcu_dereference_pointer(i8042_mouse_irq.notif_cfg).notify = false;
1957 decky 116
 
1956 decky 117
    interrupts_restore(ipl);
1474 palkovsky 118
}
1956 decky 119
 
1474 palkovsky 120
void i8042_release(void)
121
{
1956 decky 122
    ipl_t ipl = interrupts_disable();
2456 hudecek 123
    //rcu: atomic update doesn't need reallocation
1957 decky 124
    spinlock_lock(&i8042_kbd_irq.lock);
2456 hudecek 125
    if (rcu_dereference_pointer(i8042_kbd_irq.notif_cfg).answerbox)
126
        rcu_dereference_pointer(i8042_kbd_irq.notif_cfg).notify = true;
1957 decky 127
    spinlock_unlock(&i8042_kbd_irq.lock);
128
 
129
    spinlock_lock(&i8042_mouse_irq.lock);
2456 hudecek 130
    if (rcu_dereference_pointer(i8042_mouse_irq.notif_cfg).answerbox)
131
        rcu_dereference_pointer(i8042_mouse_irq.notif_cfg).notify = true;
1957 decky 132
    spinlock_unlock(&i8042_mouse_irq.lock);
133
 
1956 decky 134
    interrupts_restore(ipl);
1474 palkovsky 135
}
670 vana 136
 
1956 decky 137
static irq_ownership_t i8042_claim(void)
1474 palkovsky 138
{
1956 decky 139
    return IRQ_ACCEPT;
140
}
1474 palkovsky 141
 
1957 decky 142
static void i8042_kbd_irq_handler(irq_t *irq, void *arg, ...)
1956 decky 143
{
2456 hudecek 144
    if (rcu_dereference_pointer(irq->notif_cfg).notify && rcu_dereference_pointer(irq->notif_cfg).answerbox)
1956 decky 145
        ipc_irq_send_notif(irq);
146
    else {
147
        uint8_t x;
148
        uint8_t status;
149
 
150
        while (((status = i8042_status_read()) & i8042_BUFFER_FULL_MASK)) {
151
            x = i8042_data_read();
152
 
153
            if ((status & i8042_MOUSE_DATA))
154
                continue;
155
 
156
            if (x & KEY_RELEASE)
157
                key_released(x ^ KEY_RELEASE);
158
            else
159
                key_pressed(x);
160
        }
161
    }
162
}
1474 palkovsky 163
 
1957 decky 164
static void i8042_mouse_irq_handler(irq_t *irq, void *arg, ...)
165
{
2456 hudecek 166
    if (rcu_dereference_pointer(irq->notif_cfg).notify && rcu_dereference_pointer(irq->notif_cfg).answerbox)
1957 decky 167
        ipc_irq_send_notif(irq);
168
}
169
 
1956 decky 170
/** Initialize i8042. */
1957 decky 171
void i8042_init(devno_t kbd_devno, inr_t kbd_inr, devno_t mouse_devno, inr_t mouse_inr)
1956 decky 172
{
575 palkovsky 173
    chardev_initialize("i8042_kbd", &kbrd, &ops);
511 jermar 174
    stdin = &kbrd;
1956 decky 175
 
1957 decky 176
    irq_initialize(&i8042_kbd_irq);
177
    i8042_kbd_irq.devno = kbd_devno;
178
    i8042_kbd_irq.inr = kbd_inr;
179
    i8042_kbd_irq.claim = i8042_claim;
180
    i8042_kbd_irq.handler = i8042_kbd_irq_handler;
181
    irq_register(&i8042_kbd_irq);
1956 decky 182
 
1957 decky 183
    irq_initialize(&i8042_mouse_irq);
184
    i8042_mouse_irq.devno = mouse_devno;
185
    i8042_mouse_irq.inr = mouse_inr;
186
    i8042_mouse_irq.claim = i8042_claim;
187
    i8042_mouse_irq.handler = i8042_mouse_irq_handler;
188
    irq_register(&i8042_mouse_irq);
1956 decky 189
 
1957 decky 190
    trap_virtual_enable_irqs(1 << kbd_inr);
191
    trap_virtual_enable_irqs(1 << mouse_inr);
192
 
1194 vana 193
    /*
1195 jermar 194
     * Clear input buffer.
195
     * Number of iterations is limited to prevent infinite looping.
196
     */
1956 decky 197
    int i;
1195 jermar 198
    for (i = 0; (i8042_status_read() & i8042_BUFFER_FULL_MASK) && i < 100; i++) {
1194 vana 199
        i8042_data_read();
1753 palkovsky 200
    }
1956 decky 201
 
202
    sysinfo_set_item_val("kbd", NULL, true);
1957 decky 203
    sysinfo_set_item_val("kbd.devno", NULL, kbd_devno);
204
    sysinfo_set_item_val("kbd.inr", NULL, kbd_inr);
1956 decky 205
 
1957 decky 206
    sysinfo_set_item_val("mouse", NULL, true);
207
    sysinfo_set_item_val("mouse.devno", NULL, mouse_devno);
208
    sysinfo_set_item_val("mouse.inr", NULL, mouse_inr);
209
 
1956 decky 210
    i8042_grab();
1 jermar 211
}
508 jermar 212
 
511 jermar 213
/* Called from getc(). */
575 palkovsky 214
void i8042_resume(chardev_t *d)
511 jermar 215
{
216
}
217
 
218
/* Called from getc(). */
575 palkovsky 219
void i8042_suspend(chardev_t *d)
511 jermar 220
{
221
}
878 vana 222
 
1896 jermar 223
char i8042_key_read(chardev_t *d)
878 vana 224
{
225
    char ch;   
226
 
894 jermar 227
    while(!(ch = active_read_buff_read())) {
1780 jermar 228
        uint8_t x;
1753 palkovsky 229
        while (!(i8042_status_read() & i8042_BUFFER_FULL_MASK))
894 jermar 230
            ;
231
        x = i8042_data_read();
1842 jermar 232
        if (x & KEY_RELEASE)
233
            key_released(x ^ KEY_RELEASE);
234
        else
235
            active_read_key_pressed(x);
878 vana 236
    }
237
    return ch;
238
}
895 jermar 239
 
240
/** Poll for key press and release events.
241
 *
242
 * This function can be used to implement keyboard polling.
243
 */
244
void i8042_poll(void)
245
{
1780 jermar 246
    uint8_t x;
895 jermar 247
 
248
    while (((x = i8042_status_read() & i8042_BUFFER_FULL_MASK))) {
249
        x = i8042_data_read();
1842 jermar 250
        if (x & KEY_RELEASE)
251
            key_released(x ^ KEY_RELEASE);
252
        else
253
            key_pressed(x);
895 jermar 254
    }
255
}
1702 cejka 256
 
1754 jermar 257
/** @}
1702 cejka 258
 */