Subversion Repositories HelenOS-historic

Rev

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

Rev Author Line No. Line
1 jermar 1
/*
2
 * Copyright (C) 2001-2004 Jakub 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
 
894 jermar 29
#include <genarch/i8042/i8042.h>
30
#include <arch/drivers/i8042.h>
1 jermar 31
#include <arch/interrupt.h>
32
#include <cpu.h>
33
#include <arch/asm.h>
34
#include <arch.h>
35
#include <print.h>
508 jermar 36
#include <synch/spinlock.h>
37
#include <typedefs.h>
511 jermar 38
#include <console/chardev.h>
39
#include <console/console.h>
517 jermar 40
#include <macros.h>
576 palkovsky 41
#include <interrupt.h>
1 jermar 42
 
508 jermar 43
/**
1 jermar 44
 * i8042 processor driver.
508 jermar 45
 * It takes care of low-level keyboard functions.
1 jermar 46
 */
47
 
512 jermar 48
/** Keyboard commands. */
49
#define KBD_ENABLE	0xf4
50
#define KBD_DISABLE	0xf5
51
#define KBD_ACK		0xfa
52
 
670 vana 53
/*
893 jermar 54
 * 60  Write 8042 Command Byte: next data byte written to port 60h is
895 jermar 55
 *     placed in 8042 command register. Format:
893 jermar 56
 *
57
 *    |7|6|5|4|3|2|1|0|8042 Command Byte
58
 *     | | | | | | | `---- 1=enable output register full interrupt
59
 *     | | | | | | `----- should be 0
60
 *     | | | | | `------ 1=set status register system, 0=clear
61
 *     | | | | `------- 1=override keyboard inhibit, 0=allow inhibit
62
 *     | | | `-------- disable keyboard I/O by driving clock line low
63
 *     | | `--------- disable auxiliary device, drives clock line low
64
 *     | `---------- IBM scancode translation 0=AT, 1=PC/XT
65
 *     `----------- reserved, should be 0
66
 */
670 vana 67
 
893 jermar 68
#define i8042_SET_COMMAND 	0x60
69
#define i8042_COMMAND 		0x49
894 jermar 70
 
71
#define i8042_BUFFER_FULL_MASK	0x01
893 jermar 72
#define i8042_WAIT_MASK 	0x02
670 vana 73
 
508 jermar 74
#define SPECIAL		'?'
75
#define KEY_RELEASE	0x80
76
 
895 jermar 77
/**
78
 * These codes read from i8042 data register are silently ignored.
79
 */
80
#define IGNORE_CODE	0x7f
81
 
508 jermar 82
static void key_released(__u8 sc);
83
static void key_pressed(__u8 sc);
878 vana 84
static char key_read(chardev_t *d);
508 jermar 85
 
86
#define PRESSED_SHIFT		(1<<0)
87
#define PRESSED_CAPSLOCK	(1<<1)
88
#define LOCKED_CAPSLOCK		(1<<0)
89
 
894 jermar 90
#define ACTIVE_READ_BUFF_SIZE 16 	/* Must be power of 2 */
878 vana 91
 
894 jermar 92
static __u8 active_read_buff[ACTIVE_READ_BUFF_SIZE];
878 vana 93
 
623 jermar 94
SPINLOCK_INITIALIZE(keylock);		/**< keylock protects keyflags and lockflags. */
508 jermar 95
static volatile int keyflags;		/**< Tracking of multiple keypresses. */
509 jermar 96
static volatile int lockflags;		/**< Tracking of multiple keys lockings. */
508 jermar 97
 
575 palkovsky 98
static void i8042_suspend(chardev_t *);
99
static void i8042_resume(chardev_t *);
511 jermar 100
 
101
static chardev_t kbrd;
102
static chardev_operations_t ops = {
103
	.suspend = i8042_suspend,
878 vana 104
	.resume = i8042_resume,
105
	.read = key_read
511 jermar 106
};
107
 
508 jermar 108
/** Primary meaning of scancodes. */
109
static char sc_primary_map[] = {
110
	SPECIAL, /* 0x00 */
111
	SPECIAL, /* 0x01 - Esc */
112
	'1', '2', '3', '4', '5', '6', '7', '8', '9', '0', '-', '=',
588 palkovsky 113
	'\b', /* 0x0e - Backspace */
508 jermar 114
	'\t', 'q', 'w', 'e', 'r', 't', 'y', 'u', 'i', 'o', 'p', '[', ']', '\n',
115
	SPECIAL, /* 0x1d - LCtrl */
116
	'a', 's', 'd', 'f', 'g', 'h', 'j', 'k', 'l', ';', '\'',
117
	'`',
118
	SPECIAL, /* 0x2a - LShift */ 
119
	'\\',
120
	'z', 'x', 'c', 'v', 'b', 'n', 'm', ',', '.', '/',
121
	SPECIAL, /* 0x36 - RShift */
122
	'*',
123
	SPECIAL, /* 0x38 - LAlt */
124
	' ',
125
	SPECIAL, /* 0x3a - CapsLock */
126
	SPECIAL, /* 0x3b - F1 */
127
	SPECIAL, /* 0x3c - F2 */
128
	SPECIAL, /* 0x3d - F3 */
129
	SPECIAL, /* 0x3e - F4 */
130
	SPECIAL, /* 0x3f - F5 */
131
	SPECIAL, /* 0x40 - F6 */
132
	SPECIAL, /* 0x41 - F7 */
133
	SPECIAL, /* 0x42 - F8 */
134
	SPECIAL, /* 0x43 - F9 */
135
	SPECIAL, /* 0x44 - F10 */
136
	SPECIAL, /* 0x45 - NumLock */
137
	SPECIAL, /* 0x46 - ScrollLock */
138
	'7', '8', '9', '-',
139
	'4', '5', '6', '+',
140
	'1', '2', '3',
141
	'0', '.',
142
	SPECIAL, /* 0x54 - Alt-SysRq */
143
	SPECIAL, /* 0x55 - F11/F12/PF1/FN */
144
	SPECIAL, /* 0x56 - unlabelled key next to LAlt */
145
	SPECIAL, /* 0x57 - F11 */
146
	SPECIAL, /* 0x58 - F12 */
147
	SPECIAL, /* 0x59 */
148
	SPECIAL, /* 0x5a */
149
	SPECIAL, /* 0x5b */
150
	SPECIAL, /* 0x5c */
151
	SPECIAL, /* 0x5d */
152
	SPECIAL, /* 0x5e */
153
	SPECIAL, /* 0x5f */
154
	SPECIAL, /* 0x60 */
155
	SPECIAL, /* 0x61 */
156
	SPECIAL, /* 0x62 */
157
	SPECIAL, /* 0x63 */
158
	SPECIAL, /* 0x64 */
159
	SPECIAL, /* 0x65 */
160
	SPECIAL, /* 0x66 */
161
	SPECIAL, /* 0x67 */
162
	SPECIAL, /* 0x68 */
163
	SPECIAL, /* 0x69 */
164
	SPECIAL, /* 0x6a */
165
	SPECIAL, /* 0x6b */
166
	SPECIAL, /* 0x6c */
167
	SPECIAL, /* 0x6d */
168
	SPECIAL, /* 0x6e */
169
	SPECIAL, /* 0x6f */
170
	SPECIAL, /* 0x70 */
171
	SPECIAL, /* 0x71 */
172
	SPECIAL, /* 0x72 */
173
	SPECIAL, /* 0x73 */
174
	SPECIAL, /* 0x74 */
175
	SPECIAL, /* 0x75 */
176
	SPECIAL, /* 0x76 */
177
	SPECIAL, /* 0x77 */
178
	SPECIAL, /* 0x78 */
179
	SPECIAL, /* 0x79 */
180
	SPECIAL, /* 0x7a */
181
	SPECIAL, /* 0x7b */
182
	SPECIAL, /* 0x7c */
183
	SPECIAL, /* 0x7d */
184
	SPECIAL, /* 0x7e */
185
	SPECIAL, /* 0x7f */
186
};
187
 
188
/** Secondary meaning of scancodes. */
189
static char sc_secondary_map[] = {
190
	SPECIAL, /* 0x00 */
191
	SPECIAL, /* 0x01 - Esc */
192
	'!', '@', '#', '$', '%', '^', '&', '*', '(', ')', '_', '+',
193
	SPECIAL, /* 0x0e - Backspace */
194
	'\t', 'Q', 'W', 'E', 'R', 'T', 'Y', 'U', 'I', 'O', 'P', '{', '}', '\n',
195
	SPECIAL, /* 0x1d - LCtrl */
196
	'A', 'S', 'D', 'F', 'G', 'H', 'J', 'K', 'L', ':', '"',
197
	'~',
198
	SPECIAL, /* 0x2a - LShift */ 
199
	'|',
200
	'Z', 'X', 'C', 'V', 'B', 'N', 'M', '<', '>', '?',
201
	SPECIAL, /* 0x36 - RShift */
202
	'*',
203
	SPECIAL, /* 0x38 - LAlt */
204
	' ',
205
	SPECIAL, /* 0x3a - CapsLock */
206
	SPECIAL, /* 0x3b - F1 */
207
	SPECIAL, /* 0x3c - F2 */
208
	SPECIAL, /* 0x3d - F3 */
209
	SPECIAL, /* 0x3e - F4 */
210
	SPECIAL, /* 0x3f - F5 */
211
	SPECIAL, /* 0x40 - F6 */
212
	SPECIAL, /* 0x41 - F7 */
213
	SPECIAL, /* 0x42 - F8 */
214
	SPECIAL, /* 0x43 - F9 */
215
	SPECIAL, /* 0x44 - F10 */
216
	SPECIAL, /* 0x45 - NumLock */
217
	SPECIAL, /* 0x46 - ScrollLock */
218
	'7', '8', '9', '-',
219
	'4', '5', '6', '+',
220
	'1', '2', '3',
221
	'0', '.',
222
	SPECIAL, /* 0x54 - Alt-SysRq */
223
	SPECIAL, /* 0x55 - F11/F12/PF1/FN */
224
	SPECIAL, /* 0x56 - unlabelled key next to LAlt */
225
	SPECIAL, /* 0x57 - F11 */
226
	SPECIAL, /* 0x58 - F12 */
227
	SPECIAL, /* 0x59 */
228
	SPECIAL, /* 0x5a */
229
	SPECIAL, /* 0x5b */
230
	SPECIAL, /* 0x5c */
231
	SPECIAL, /* 0x5d */
232
	SPECIAL, /* 0x5e */
233
	SPECIAL, /* 0x5f */
234
	SPECIAL, /* 0x60 */
235
	SPECIAL, /* 0x61 */
236
	SPECIAL, /* 0x62 */
237
	SPECIAL, /* 0x63 */
238
	SPECIAL, /* 0x64 */
239
	SPECIAL, /* 0x65 */
240
	SPECIAL, /* 0x66 */
241
	SPECIAL, /* 0x67 */
242
	SPECIAL, /* 0x68 */
243
	SPECIAL, /* 0x69 */
244
	SPECIAL, /* 0x6a */
245
	SPECIAL, /* 0x6b */
246
	SPECIAL, /* 0x6c */
247
	SPECIAL, /* 0x6d */
248
	SPECIAL, /* 0x6e */
249
	SPECIAL, /* 0x6f */
250
	SPECIAL, /* 0x70 */
251
	SPECIAL, /* 0x71 */
252
	SPECIAL, /* 0x72 */
253
	SPECIAL, /* 0x73 */
254
	SPECIAL, /* 0x74 */
255
	SPECIAL, /* 0x75 */
256
	SPECIAL, /* 0x76 */
257
	SPECIAL, /* 0x77 */
258
	SPECIAL, /* 0x78 */
259
	SPECIAL, /* 0x79 */
260
	SPECIAL, /* 0x7a */
261
	SPECIAL, /* 0x7b */
262
	SPECIAL, /* 0x7c */
263
	SPECIAL, /* 0x7d */
264
	SPECIAL, /* 0x7e */
265
	SPECIAL, /* 0x7f */	
266
};
267
 
958 jermar 268
static void i8042_interrupt(int n, istate_t *istate);
895 jermar 269
static void i8042_wait(void);
576 palkovsky 270
 
508 jermar 271
/** Initialize i8042. */
1 jermar 272
void i8042_init(void)
273
{
958 jermar 274
	exc_register(VECTOR_KBD, "i8042_interrupt", (iroutine) i8042_interrupt);
895 jermar 275
	i8042_wait();
894 jermar 276
	i8042_command_write(i8042_SET_COMMAND);
895 jermar 277
	i8042_wait();
894 jermar 278
	i8042_data_write(i8042_COMMAND);
895 jermar 279
	i8042_wait();
670 vana 280
 
512 jermar 281
	trap_virtual_enable_irqs(1<<IRQ_KBD);
575 palkovsky 282
	chardev_initialize("i8042_kbd", &kbrd, &ops);
511 jermar 283
	stdin = &kbrd;
1193 vana 284
	{
285
		int a=0;
286
		while(a<20) {i8042_data_read();a++;}  /*Clear input buffer*/
287
	}
1 jermar 288
}
289
 
508 jermar 290
/** Process i8042 interrupt.
291
 *
292
 * @param n Interrupt vector.
293
 * @param stack Interrupted stack.
294
 */
958 jermar 295
void i8042_interrupt(int n, istate_t *istate)
1 jermar 296
{
297
	__u8 x;
298
 
299
	trap_virtual_eoi();
894 jermar 300
	x = i8042_data_read();
508 jermar 301
	if (x & KEY_RELEASE)
302
		key_released(x ^ KEY_RELEASE);
303
	else
304
		key_pressed(x);
1 jermar 305
}
508 jermar 306
 
895 jermar 307
/** Wait until the controller reads its data. */
308
void i8042_wait(void) {
309
	while (i8042_status_read() & i8042_WAIT_MASK) {
310
		/* wait */
311
	}
312
}
313
 
508 jermar 314
/** Process release of key.
315
 *
316
 * @param sc Scancode of the key being released.
317
 */
318
void key_released(__u8 sc)
319
{
320
	spinlock_lock(&keylock);
321
	switch (sc) {
322
	    case SC_LSHIFT:
323
	    case SC_RSHIFT:
324
		keyflags &= ~PRESSED_SHIFT;
325
		break;
326
	    case SC_CAPSLOCK:
327
		keyflags &= ~PRESSED_CAPSLOCK;
328
		if (lockflags & LOCKED_CAPSLOCK)
329
			lockflags &= ~LOCKED_CAPSLOCK;
330
		else
331
			lockflags |= LOCKED_CAPSLOCK;
332
		break;
333
	    default:
334
		break;
335
	}
336
	spinlock_unlock(&keylock);
337
}
338
 
339
/** Process keypress.
340
 *
341
 * @param sc Scancode of the key being pressed.
342
 */
343
void key_pressed(__u8 sc)
344
{
345
	char *map = sc_primary_map;
346
	char ascii = sc_primary_map[sc];
347
	bool shift, capslock;
348
	bool letter = false;
349
 
350
	spinlock_lock(&keylock);
351
	switch (sc) {
601 palkovsky 352
	case SC_LSHIFT:
353
	case SC_RSHIFT:
508 jermar 354
	    	keyflags |= PRESSED_SHIFT;
355
		break;
601 palkovsky 356
	case SC_CAPSLOCK:
508 jermar 357
		keyflags |= PRESSED_CAPSLOCK;
358
		break;
601 palkovsky 359
	case SC_SPEC_ESCAPE:
360
		break;
361
	case SC_LEFTARR:
362
		chardev_push_character(&kbrd, 0x1b);
363
		chardev_push_character(&kbrd, 0x5b);
364
		chardev_push_character(&kbrd, 0x44);
365
		break;
366
	case SC_RIGHTARR:
367
		chardev_push_character(&kbrd, 0x1b);
368
		chardev_push_character(&kbrd, 0x5b);
369
		chardev_push_character(&kbrd, 0x43);
370
		break;
371
	case SC_UPARR:
372
		chardev_push_character(&kbrd, 0x1b);
373
		chardev_push_character(&kbrd, 0x5b);
374
		chardev_push_character(&kbrd, 0x41);
375
		break;
376
	case SC_DOWNARR:
377
		chardev_push_character(&kbrd, 0x1b);
378
		chardev_push_character(&kbrd, 0x5b);
379
		chardev_push_character(&kbrd, 0x42);
380
		break;
606 palkovsky 381
	case SC_HOME:
382
		chardev_push_character(&kbrd, 0x1b);
383
		chardev_push_character(&kbrd, 0x4f);
384
		chardev_push_character(&kbrd, 0x48);
385
		break;
386
	case SC_END:
387
		chardev_push_character(&kbrd, 0x1b);
388
		chardev_push_character(&kbrd, 0x4f);
389
		chardev_push_character(&kbrd, 0x46);
390
		break;
391
	case SC_DELETE:
392
		chardev_push_character(&kbrd, 0x1b);
393
		chardev_push_character(&kbrd, 0x5b);
394
		chardev_push_character(&kbrd, 0x33);
395
		chardev_push_character(&kbrd, 0x7e);
396
		break;
601 palkovsky 397
	default:
517 jermar 398
	    	letter = is_lower(ascii);
508 jermar 399
		capslock = (keyflags & PRESSED_CAPSLOCK) || (lockflags & LOCKED_CAPSLOCK);
400
		shift = keyflags & PRESSED_SHIFT;
401
		if (letter && capslock)
402
			shift = !shift;
403
		if (shift)
404
			map = sc_secondary_map;
511 jermar 405
		chardev_push_character(&kbrd, map[sc]);
508 jermar 406
		break;
407
	}
408
	spinlock_unlock(&keylock);
409
}
511 jermar 410
 
411
/* Called from getc(). */
575 palkovsky 412
void i8042_resume(chardev_t *d)
511 jermar 413
{
414
}
415
 
416
/* Called from getc(). */
575 palkovsky 417
void i8042_suspend(chardev_t *d)
511 jermar 418
{
419
}
878 vana 420
 
421
static __u8 active_read_buff_read(void)
422
{
423
	static int i=0;
894 jermar 424
	i &= (ACTIVE_READ_BUFF_SIZE-1);
425
	if(!active_read_buff[i]) {
878 vana 426
		return 0;
427
	}
428
	return active_read_buff[i++];
429
}
430
 
431
static void active_read_buff_write(__u8 ch)
432
{
433
	static int i=0;
894 jermar 434
	active_read_buff[i] = ch;
878 vana 435
	i++;
894 jermar 436
	i &= (ACTIVE_READ_BUFF_SIZE-1);
878 vana 437
	active_read_buff[i]=0;
438
}
439
 
440
 
893 jermar 441
static void active_read_key_pressed(__u8 sc)
878 vana 442
{
443
	char *map = sc_primary_map;
444
	char ascii = sc_primary_map[sc];
445
	bool shift, capslock;
446
	bool letter = false;
447
 
448
	/*spinlock_lock(&keylock);*/
449
	switch (sc) {
450
	case SC_LSHIFT:
451
	case SC_RSHIFT:
452
	    	keyflags |= PRESSED_SHIFT;
453
		break;
454
	case SC_CAPSLOCK:
455
		keyflags |= PRESSED_CAPSLOCK;
456
		break;
457
	case SC_SPEC_ESCAPE:
458
		break;
459
	case SC_LEFTARR:
460
		active_read_buff_write(0x1b);
461
		active_read_buff_write(0x5b);
462
		active_read_buff_write(0x44);
463
		break;
464
	case SC_RIGHTARR:
465
		active_read_buff_write(0x1b);
466
		active_read_buff_write(0x5b);
467
		active_read_buff_write(0x43);
468
		break;
469
	case SC_UPARR:
470
		active_read_buff_write(0x1b);
471
		active_read_buff_write(0x5b);
472
		active_read_buff_write(0x41);
473
		break;
474
	case SC_DOWNARR:
475
		active_read_buff_write(0x1b);
476
		active_read_buff_write(0x5b);
477
		active_read_buff_write(0x42);
478
		break;
479
	case SC_HOME:
480
		active_read_buff_write(0x1b);
481
		active_read_buff_write(0x4f);
482
		active_read_buff_write(0x48);
483
		break;
484
	case SC_END:
485
		active_read_buff_write(0x1b);
486
		active_read_buff_write(0x4f);
487
		active_read_buff_write(0x46);
488
		break;
489
	case SC_DELETE:
490
		active_read_buff_write(0x1b);
491
		active_read_buff_write(0x5b);
492
		active_read_buff_write(0x33);
493
		active_read_buff_write(0x7e);
494
		break;
495
	default:
496
	    	letter = is_lower(ascii);
497
		capslock = (keyflags & PRESSED_CAPSLOCK) || (lockflags & LOCKED_CAPSLOCK);
498
		shift = keyflags & PRESSED_SHIFT;
499
		if (letter && capslock)
500
			shift = !shift;
501
		if (shift)
502
			map = sc_secondary_map;
503
		active_read_buff_write(map[sc]);
504
		break;
505
	}
506
	/*spinlock_unlock(&keylock);*/
507
 
508
}
509
 
510
static char key_read(chardev_t *d)
511
{
512
	char ch;	
513
 
894 jermar 514
	while(!(ch = active_read_buff_read())) {
878 vana 515
		__u8 x;
894 jermar 516
		while (!((x=i8042_status_read() & i8042_BUFFER_FULL_MASK)))
517
			;
518
		x = i8042_data_read();
895 jermar 519
		if (x != IGNORE_CODE) {
520
			if (x & KEY_RELEASE)
521
				key_released(x ^ KEY_RELEASE);
522
			else
523
				active_read_key_pressed(x);
524
		}
878 vana 525
	}
526
	return ch;
527
}
895 jermar 528
 
529
/** Poll for key press and release events.
530
 *
531
 * This function can be used to implement keyboard polling.
532
 */
533
void i8042_poll(void)
534
{
535
	__u8 x;
536
 
537
	while (((x = i8042_status_read() & i8042_BUFFER_FULL_MASK))) {
538
		x = i8042_data_read();
539
		if (x != IGNORE_CODE) {
540
			if (x & KEY_RELEASE)
541
				key_released(x ^ KEY_RELEASE);
542
			else
543
				key_pressed(x);
544
		}
545
	}
546
}