Subversion Repositories HelenOS

Rev

Rev 2131 | Go to most recent revision | Only display areas with differences | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed

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