Subversion Repositories HelenOS

Rev

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

Rev 3932 Rev 3934
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 <arch/drivers/kbd.h>
40
#include <arch/drivers/kbd.h>
41
#include <genarch/kbd/key.h>
41
#include <genarch/kbd/key.h>
42
#include <genarch/kbd/scanc.h>
42
#include <genarch/kbd/scanc.h>
43
#include <genarch/kbd/scanc_pc.h>
43
#include <genarch/kbd/scanc_pc.h>
44
#include <genarch/drivers/legacy/ia32/io.h>
44
#include <genarch/drivers/legacy/ia32/io.h>
45
#include <cpu.h>
45
#include <cpu.h>
46
#include <arch/asm.h>
46
#include <arch/asm.h>
47
#include <arch.h>
47
#include <arch.h>
48
#include <console/chardev.h>
48
#include <console/chardev.h>
49
#include <console/console.h>
49
#include <console/console.h>
50
#include <interrupt.h>
50
#include <interrupt.h>
51
#include <sysinfo/sysinfo.h>
51
#include <sysinfo/sysinfo.h>
52
#include <ipc/irq.h>
52
#include <ipc/irq.h>
53
 
53
 
54
i8042_instance_t lgcy_i8042_instance = {
54
i8042_instance_t lgcy_i8042_instance = {
55
    .i8042 = (i8042_t *) i8042_BASE,
55
    .i8042 = (i8042_t *) I8042_BASE,
56
};
56
};
57
 
57
 
58
/* Keyboard commands. */
58
/* Keyboard commands. */
59
#define KBD_ENABLE  0xf4
59
#define KBD_ENABLE  0xf4
60
#define KBD_DISABLE 0xf5
60
#define KBD_DISABLE 0xf5
61
#define KBD_ACK     0xfa
61
#define KBD_ACK     0xfa
62
 
62
 
63
/*
63
/*
64
 * 60  Write 8042 Command Byte: next data byte written to port 60h is
64
 * 60  Write 8042 Command Byte: next data byte written to port 60h is
65
 *     placed in 8042 command register. Format:
65
 *     placed in 8042 command register. Format:
66
 *
66
 *
67
 *    |7|6|5|4|3|2|1|0|8042 Command Byte
67
 *    |7|6|5|4|3|2|1|0|8042 Command Byte
68
 *     | | | | | | | `---- 1=enable output register full interrupt
68
 *     | | | | | | | `---- 1=enable output register full interrupt
69
 *     | | | | | | `----- should be 0
69
 *     | | | | | | `----- should be 0
70
 *     | | | | | `------ 1=set status register system, 0=clear
70
 *     | | | | | `------ 1=set status register system, 0=clear
71
 *     | | | | `------- 1=override keyboard inhibit, 0=allow inhibit
71
 *     | | | | `------- 1=override keyboard inhibit, 0=allow inhibit
72
 *     | | | `-------- disable keyboard I/O by driving clock line low
72
 *     | | | `-------- disable keyboard I/O by driving clock line low
73
 *     | | `--------- disable auxiliary device, drives clock line low
73
 *     | | `--------- disable auxiliary device, drives clock line low
74
 *     | `---------- IBM scancode translation 0=AT, 1=PC/XT
74
 *     | `---------- IBM scancode translation 0=AT, 1=PC/XT
75
 *     `----------- reserved, should be 0
75
 *     `----------- reserved, should be 0
76
 */
76
 */
77
 
77
 
78
#define i8042_SET_COMMAND   0x60
78
#define i8042_SET_COMMAND   0x60
79
#define i8042_COMMAND       0x69
79
#define i8042_COMMAND       0x69
80
 
80
 
81
#define i8042_BUFFER_FULL_MASK  0x01
81
#define i8042_BUFFER_FULL_MASK  0x01
82
#define i8042_WAIT_MASK         0x02
82
#define i8042_WAIT_MASK         0x02
83
#define i8042_MOUSE_DATA        0x20
83
#define i8042_MOUSE_DATA        0x20
84
 
84
 
85
static void i8042_suspend(chardev_t *);
85
static void i8042_suspend(chardev_t *);
86
static void i8042_resume(chardev_t *);
86
static void i8042_resume(chardev_t *);
87
 
87
 
88
static chardev_operations_t ops = {
88
static chardev_operations_t ops = {
89
    .suspend = i8042_suspend,
89
    .suspend = i8042_suspend,
90
    .resume = i8042_resume,
90
    .resume = i8042_resume,
91
    .read = i8042_key_read
-
 
92
};
91
};
93
 
92
 
94
/** Structure for i8042's IRQ. */
93
/** Structure for i8042's IRQ. */
95
static irq_t i8042_kbd_irq;
94
static irq_t i8042_kbd_irq;
96
static irq_t i8042_mouse_irq;
95
static irq_t i8042_mouse_irq;
97
 
96
 
98
void i8042_grab(void)
97
void i8042_grab(void)
99
{
98
{
100
    ipl_t ipl = interrupts_disable();
99
    ipl_t ipl = interrupts_disable();
101
   
100
   
102
    spinlock_lock(&i8042_kbd_irq.lock);
101
    spinlock_lock(&i8042_kbd_irq.lock);
103
    i8042_kbd_irq.notif_cfg.notify = false;
102
    i8042_kbd_irq.notif_cfg.notify = false;
104
    spinlock_unlock(&i8042_kbd_irq.lock);
103
    spinlock_unlock(&i8042_kbd_irq.lock);
105
   
104
   
106
    spinlock_lock(&i8042_mouse_irq.lock);
105
    spinlock_lock(&i8042_mouse_irq.lock);
107
    i8042_mouse_irq.notif_cfg.notify = false;
106
    i8042_mouse_irq.notif_cfg.notify = false;
108
    spinlock_unlock(&i8042_mouse_irq.lock);
107
    spinlock_unlock(&i8042_mouse_irq.lock);
109
   
108
   
110
    interrupts_restore(ipl);
109
    interrupts_restore(ipl);
111
}
110
}
112
 
111
 
113
void i8042_release(void)
112
void i8042_release(void)
114
{
113
{
115
    ipl_t ipl = interrupts_disable();
114
    ipl_t ipl = interrupts_disable();
116
   
115
   
117
    spinlock_lock(&i8042_kbd_irq.lock);
116
    spinlock_lock(&i8042_kbd_irq.lock);
118
    if (i8042_kbd_irq.notif_cfg.answerbox)
117
    if (i8042_kbd_irq.notif_cfg.answerbox)
119
        i8042_kbd_irq.notif_cfg.notify = true;
118
        i8042_kbd_irq.notif_cfg.notify = true;
120
    spinlock_unlock(&i8042_kbd_irq.lock);
119
    spinlock_unlock(&i8042_kbd_irq.lock);
121
   
120
   
122
    spinlock_lock(&i8042_mouse_irq.lock);
121
    spinlock_lock(&i8042_mouse_irq.lock);
123
    if (i8042_mouse_irq.notif_cfg.answerbox)
122
    if (i8042_mouse_irq.notif_cfg.answerbox)
124
        i8042_mouse_irq.notif_cfg.notify = true;
123
        i8042_mouse_irq.notif_cfg.notify = true;
125
    spinlock_unlock(&i8042_mouse_irq.lock);
124
    spinlock_unlock(&i8042_mouse_irq.lock);
126
   
125
   
127
    interrupts_restore(ipl);
126
    interrupts_restore(ipl);
128
}
127
}
129
 
128
 
130
static irq_ownership_t i8042_claim(void *instance)
129
static irq_ownership_t i8042_claim(void *instance)
131
{
130
{
132
    i8042_instance_t *i8042_instance = instance;
131
    i8042_instance_t *i8042_instance = instance;
133
    i8042_t *dev = i8042_instance->i8042;
132
    i8042_t *dev = i8042_instance->i8042;
134
    if (pio_read_8(&dev->status) & i8042_BUFFER_FULL_MASK)
133
    if (pio_read_8(&dev->status) & i8042_BUFFER_FULL_MASK)
135
        return IRQ_ACCEPT;
134
        return IRQ_ACCEPT;
136
    else
135
    else
137
        return IRQ_DECLINE;
136
        return IRQ_DECLINE;
138
}
137
}
139
 
138
 
140
static void i8042_irq_handler(irq_t *irq)
139
static void i8042_irq_handler(irq_t *irq)
141
{
140
{
142
    if (irq->notif_cfg.notify && irq->notif_cfg.answerbox) {
141
    if (irq->notif_cfg.notify && irq->notif_cfg.answerbox) {
143
        /*
142
        /*
144
         * This will hopefully go to the IRQ dispatcher code soon.
143
         * This will hopefully go to the IRQ dispatcher code soon.
145
         */
144
         */
146
        ipc_irq_send_notif(irq);
145
        ipc_irq_send_notif(irq);
147
        return;
146
        return;
148
    }
147
    }
149
 
148
 
150
    i8042_instance_t *instance = irq->instance;
149
    i8042_instance_t *instance = irq->instance;
151
    i8042_t *dev = instance->i8042;
150
    i8042_t *dev = instance->i8042;
152
 
151
 
153
    uint8_t data;
152
    uint8_t data;
154
    uint8_t status;
153
    uint8_t status;
155
       
154
       
156
    if (((status = pio_read_8(&dev->status)) & i8042_BUFFER_FULL_MASK)) {
155
    if (((status = pio_read_8(&dev->status)) & i8042_BUFFER_FULL_MASK)) {
157
        data = pio_read_8(&dev->data);
156
        data = pio_read_8(&dev->data);
158
           
157
           
159
        if ((status & i8042_MOUSE_DATA))
158
        if ((status & i8042_MOUSE_DATA))
160
            return;
159
            return;
161
 
160
 
162
        if (data & KEY_RELEASE)
161
        if (data & KEY_RELEASE)
163
            key_released(data ^ KEY_RELEASE);
162
            key_released(data ^ KEY_RELEASE);
164
        else
163
        else
165
            key_pressed(data);
164
            key_pressed(data);
166
    }
165
    }
167
}
166
}
168
 
167
 
169
/** Initialize i8042. */
168
/** Initialize i8042. */
170
void
169
void
171
i8042_init(devno_t kbd_devno, inr_t kbd_inr, devno_t mouse_devno,
170
i8042_init(devno_t kbd_devno, inr_t kbd_inr, devno_t mouse_devno,
172
    inr_t mouse_inr)
171
    inr_t mouse_inr)
173
{
172
{
174
    i8042_t *dev = lgcy_i8042_instance.i8042;
173
    i8042_t *dev = lgcy_i8042_instance.i8042;
175
 
174
 
176
    chardev_initialize("i8042_kbd", &kbrd, &ops);
175
    chardev_initialize("i8042_kbd", &kbrd, &ops);
177
    stdin = &kbrd;
176
    stdin = &kbrd;
178
   
177
   
179
    irq_initialize(&i8042_kbd_irq);
178
    irq_initialize(&i8042_kbd_irq);
180
    i8042_kbd_irq.devno = kbd_devno;
179
    i8042_kbd_irq.devno = kbd_devno;
181
    i8042_kbd_irq.inr = kbd_inr;
180
    i8042_kbd_irq.inr = kbd_inr;
182
    i8042_kbd_irq.claim = i8042_claim;
181
    i8042_kbd_irq.claim = i8042_claim;
183
    i8042_kbd_irq.handler = i8042_irq_handler;
182
    i8042_kbd_irq.handler = i8042_irq_handler;
184
    i8042_kbd_irq.instance = &lgcy_i8042_instance;
183
    i8042_kbd_irq.instance = &lgcy_i8042_instance;
185
    irq_register(&i8042_kbd_irq);
184
    irq_register(&i8042_kbd_irq);
186
   
185
   
187
    irq_initialize(&i8042_mouse_irq);
186
    irq_initialize(&i8042_mouse_irq);
188
    i8042_mouse_irq.devno = mouse_devno;
187
    i8042_mouse_irq.devno = mouse_devno;
189
    i8042_mouse_irq.inr = mouse_inr;
188
    i8042_mouse_irq.inr = mouse_inr;
190
    i8042_mouse_irq.claim = i8042_claim;
189
    i8042_mouse_irq.claim = i8042_claim;
191
    i8042_mouse_irq.handler = i8042_irq_handler;
190
    i8042_mouse_irq.handler = i8042_irq_handler;
192
    i8042_mouse_irq.instance = &lgcy_i8042_instance;
191
    i8042_mouse_irq.instance = &lgcy_i8042_instance;
193
    irq_register(&i8042_mouse_irq);
192
    irq_register(&i8042_mouse_irq);
194
   
193
   
195
    trap_virtual_enable_irqs(1 << kbd_inr);
194
    trap_virtual_enable_irqs(1 << kbd_inr);
196
    trap_virtual_enable_irqs(1 << mouse_inr);
195
    trap_virtual_enable_irqs(1 << mouse_inr);
197
   
196
   
198
    /*
197
    /*
199
     * Clear input buffer.
198
     * Clear input buffer.
200
     * Number of iterations is limited to prevent infinite looping.
199
     * Number of iterations is limited to prevent infinite looping.
201
     */
200
     */
202
    int i;
201
    int i;
203
    for (i = 0; (pio_read_8(&dev->status) & i8042_BUFFER_FULL_MASK) &&
202
    for (i = 0; (pio_read_8(&dev->status) & i8042_BUFFER_FULL_MASK) &&
204
        i < 100; i++) {
203
        i < 100; i++) {
205
        (void) pio_read_8(&dev->data);
204
        (void) pio_read_8(&dev->data);
206
    }
205
    }
207
   
206
   
208
    sysinfo_set_item_val("kbd", NULL, true);
207
    sysinfo_set_item_val("kbd", NULL, true);
209
    sysinfo_set_item_val("kbd.devno", NULL, kbd_devno);
208
    sysinfo_set_item_val("kbd.devno", NULL, kbd_devno);
210
    sysinfo_set_item_val("kbd.inr", NULL, kbd_inr);
209
    sysinfo_set_item_val("kbd.inr", NULL, kbd_inr);
211
#ifdef KBD_LEGACY
210
#ifdef KBD_LEGACY
212
    sysinfo_set_item_val("kbd.type", NULL, KBD_LEGACY);
211
    sysinfo_set_item_val("kbd.type", NULL, KBD_LEGACY);
213
#endif
212
#endif
214
    sysinfo_set_item_val("mouse", NULL, true);
213
    sysinfo_set_item_val("mouse", NULL, true);
215
    sysinfo_set_item_val("mouse.devno", NULL, mouse_devno);
214
    sysinfo_set_item_val("mouse.devno", NULL, mouse_devno);
216
    sysinfo_set_item_val("mouse.inr", NULL, mouse_inr);
215
    sysinfo_set_item_val("mouse.inr", NULL, mouse_inr);
217
   
216
   
218
    i8042_grab();
217
    i8042_grab();
219
}
218
}
220
 
219
 
221
/* Called from getc(). */
220
/* Called from getc(). */
222
void i8042_resume(chardev_t *d)
221
void i8042_resume(chardev_t *d)
223
{
222
{
224
}
223
}
225
 
224
 
226
/* Called from getc(). */
225
/* Called from getc(). */
227
void i8042_suspend(chardev_t *d)
226
void i8042_suspend(chardev_t *d)
228
{
227
{
229
}
228
}
230
 
-
 
231
char i8042_key_read(chardev_t *d)
-
 
232
{
-
 
233
    i8042_t *dev = lgcy_i8042_instance.i8042;
-
 
234
    char ch;
-
 
235
   
-
 
236
    while (!(ch = active_read_buff_read())) {
-
 
237
        uint8_t x;
-
 
238
       
-
 
239
        while (!(pio_read_8(&dev->status) & i8042_BUFFER_FULL_MASK))
-
 
240
            ;
-
 
241
       
-
 
242
        x = pio_read_8(&dev->data);
-
 
243
        if (x & KEY_RELEASE)
-
 
244
            key_released(x ^ KEY_RELEASE);
-
 
245
        else
-
 
246
            active_read_key_pressed(x);
-
 
247
    }
-
 
248
    return ch;
-
 
249
}
-
 
250
 
229
 
251
/** @}
230
/** @}
252
 */
231
 */
253
 
232