WebSVN – HelenOS – Diff – /branches/dd/kernel/genarch/src/drivers/i8042/i8042.c


/*
 * Copyright (c) 2001-2004 Jakub Jermar
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * - Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 * - Redistributions in binary form must reproduce the above copyright
 *   notice, this list of conditions and the following disclaimer in the
 *   documentation and/or other materials provided with the distribution.
 * - The name of the author may not be used to endorse or promote products
 *   derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
 
/** @addtogroup genarch
 * @{
 */
/**
 * @file
 * @brief   i8042 processor driver.
 *
 * It takes care of low-level keyboard functions.
 */
 
#include <genarch/kbd/i8042.h>
#include <arch/drivers/kbd.h>
#include <genarch/kbd/key.h>
#include <genarch/kbd/scanc.h>
#include <genarch/kbd/scanc_pc.h>
#include <genarch/drivers/legacy/ia32/io.h>
#include <cpu.h>
#include <arch/asm.h>
#include <arch.h>
#include <console/chardev.h>
#include <console/console.h>
#include <interrupt.h>
#include <sysinfo/sysinfo.h>
 
 
i8042_instance_t lgcy_i8042_instance = {
    .i8042 = (i8042_t *) I8042_BASE,
};
 
/* Keyboard commands. */
#define KBD_ENABLE  0xf4
#define KBD_DISABLE 0xf5
#define KBD_ACK     0xfa
 
/*
 * 60  Write 8042 Command Byte: next data byte written to port 60h is
 *     placed in 8042 command register. Format:
 *
 *    |7|6|5|4|3|2|1|0|8042 Command Byte
 *     | | | | | | | `---- 1=enable output register full interrupt
 *     | | | | | | `----- should be 0
 *     | | | | | `------ 1=set status register system, 0=clear
 *     | | | | `------- 1=override keyboard inhibit, 0=allow inhibit
 *     | | | `-------- disable keyboard I/O by driving clock line low
 *     | | `--------- disable auxiliary device, drives clock line low
 *     | `---------- IBM scancode translation 0=AT, 1=PC/XT
 *     `----------- reserved, should be 0
 */
 
#define i8042_SET_COMMAND   0x60
#define i8042_COMMAND       0x69
 
#define i8042_BUFFER_FULL_MASK  0x01
#define i8042_WAIT_MASK         0x02
#define i8042_MOUSE_DATA        0x20
 
static void i8042_suspend(chardev_t *);
static void i8042_resume(chardev_t *);
 
static chardev_operations_t ops = {
    .suspend = i8042_suspend,
    .resume = i8042_resume,
};
 
/** Structure for i8042's IRQ. */
static irq_t i8042_kbd_irq;
static irq_t i8042_mouse_irq;
 
static irq_ownership_t i8042_claim(irq_t *irq)
{
    i8042_instance_t *i8042_instance = irq->instance;
    i8042_t *dev = i8042_instance->i8042;
    if (pio_read_8(&dev->status) & i8042_BUFFER_FULL_MASK)
        return IRQ_ACCEPT;
    else
        return IRQ_DECLINE;
}
 
static void i8042_irq_handler(irq_t *irq)
{
    i8042_instance_t *instance = irq->instance;
    i8042_t *dev = instance->i8042;
 
    uint8_t data;
    uint8_t status;
       
    if (((status = pio_read_8(&dev->status)) & i8042_BUFFER_FULL_MASK)) {
        data = pio_read_8(&dev->data);
           
        if ((status & i8042_MOUSE_DATA))
            return;
 
        if (data & KEY_RELEASE)
            key_released(data ^ KEY_RELEASE);
        else
            key_pressed(data);
    }
}
 
/** Initialize i8042. */
void
i8042_init(devno_t kbd_devno, inr_t kbd_inr, devno_t mouse_devno,
    inr_t mouse_inr)
{
    i8042_t *dev = lgcy_i8042_instance.i8042;
 
    chardev_initialize("i8042_kbd", &kbrd, &ops);
    stdin = &kbrd;
   
    irq_initialize(&i8042_kbd_irq);
    i8042_kbd_irq.devno = kbd_devno;
    i8042_kbd_irq.inr = kbd_inr;
    i8042_kbd_irq.claim = i8042_claim;
    i8042_kbd_irq.handler = i8042_irq_handler;
    i8042_kbd_irq.instance = &lgcy_i8042_instance;
    irq_register(&i8042_kbd_irq);
   
    irq_initialize(&i8042_mouse_irq);
    i8042_mouse_irq.devno = mouse_devno;
    i8042_mouse_irq.inr = mouse_inr;
    i8042_mouse_irq.claim = i8042_claim;
    i8042_mouse_irq.handler = i8042_irq_handler;
    i8042_mouse_irq.instance = &lgcy_i8042_instance;
    irq_register(&i8042_mouse_irq);
   
    trap_virtual_enable_irqs(1 << kbd_inr);
    trap_virtual_enable_irqs(1 << mouse_inr);
   
    /*
     * Clear input buffer.
 
     */
 
    while (pio_read_8(&dev->status) & i8042_BUFFER_FULL_MASK)
 
        (void) pio_read_8(&dev->data);
 
   
    /*
     * This is the necessary evil until the userspace driver is entirely
     * self-sufficient.
     */
    sysinfo_set_item_val("kbd", NULL, true);
    sysinfo_set_item_val("kbd.devno", NULL, kbd_devno);
    sysinfo_set_item_val("kbd.inr", NULL, kbd_inr);
#ifdef KBD_LEGACY
    sysinfo_set_item_val("kbd.type", NULL, KBD_LEGACY);
#endif
    sysinfo_set_item_val("mouse", NULL, true);
    sysinfo_set_item_val("mouse.devno", NULL, mouse_devno);
    sysinfo_set_item_val("mouse.inr", NULL, mouse_inr);
}
 
/* Called from getc(). */
void i8042_resume(chardev_t *d)
{
}
 
/* Called from getc(). */
void i8042_suspend(chardev_t *d)
{
}
 
/** @}
 */
 

Subversion Repositories HelenOS

(root)/branches/dd/kernel/genarch/src/drivers/i8042/i8042.c @ 4201 – Rev 3947 → 3958

Rev 3947		Rev 3958
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>	-
53		52
54	i8042_instance_t lgcy_i8042_instance = {	53	i8042_instance_t lgcy_i8042_instance = {
55	.i8042 = (i8042_t *) I8042_BASE,	54	.i8042 = (i8042_t *) I8042_BASE,
56	};	55	};
57		56
58	/* Keyboard commands. */	57	/* Keyboard commands. */
59	#define KBD_ENABLE 0xf4	58	#define KBD_ENABLE 0xf4
60	#define KBD_DISABLE 0xf5	59	#define KBD_DISABLE 0xf5
61	#define KBD_ACK 0xfa	60	#define KBD_ACK 0xfa
62		61
63	/*	62	/*
64	* 60 Write 8042 Command Byte: next data byte written to port 60h is	63	* 60 Write 8042 Command Byte: next data byte written to port 60h is
65	* placed in 8042 command register. Format:	64	* placed in 8042 command register. Format:
66	*	65	*
67	* \|7\|6\|5\|4\|3\|2\|1\|0\|8042 Command Byte	66	* \|7\|6\|5\|4\|3\|2\|1\|0\|8042 Command Byte
68	* \| \| \| \| \| \| \| `---- 1=enable output register full interrupt	67	* \| \| \| \| \| \| \| `---- 1=enable output register full interrupt
69	* \| \| \| \| \| \| `----- should be 0	68	* \| \| \| \| \| \| `----- should be 0
70	* \| \| \| \| \| `------ 1=set status register system, 0=clear	69	* \| \| \| \| \| `------ 1=set status register system, 0=clear
71	* \| \| \| \| `------- 1=override keyboard inhibit, 0=allow inhibit	70	* \| \| \| \| `------- 1=override keyboard inhibit, 0=allow inhibit
72	* \| \| \| `-------- disable keyboard I/O by driving clock line low	71	* \| \| \| `-------- disable keyboard I/O by driving clock line low
73	* \| \| `--------- disable auxiliary device, drives clock line low	72	* \| \| `--------- disable auxiliary device, drives clock line low
74	* \| `---------- IBM scancode translation 0=AT, 1=PC/XT	73	* \| `---------- IBM scancode translation 0=AT, 1=PC/XT
75	* `----------- reserved, should be 0	74	* `----------- reserved, should be 0
76	*/	75	*/
77		76
78	#define i8042_SET_COMMAND 0x60	77	#define i8042_SET_COMMAND 0x60
79	#define i8042_COMMAND 0x69	78	#define i8042_COMMAND 0x69
80		79
81	#define i8042_BUFFER_FULL_MASK 0x01	80	#define i8042_BUFFER_FULL_MASK 0x01
82	#define i8042_WAIT_MASK 0x02	81	#define i8042_WAIT_MASK 0x02
83	#define i8042_MOUSE_DATA 0x20	82	#define i8042_MOUSE_DATA 0x20
84		83
85	static void i8042_suspend(chardev_t *);	84	static void i8042_suspend(chardev_t *);
86	static void i8042_resume(chardev_t *);	85	static void i8042_resume(chardev_t *);
87		86
88	static chardev_operations_t ops = {	87	static chardev_operations_t ops = {
89	.suspend = i8042_suspend,	88	.suspend = i8042_suspend,
90	.resume = i8042_resume,	89	.resume = i8042_resume,
91	};	90	};
92		91
93	/** Structure for i8042's IRQ. */	92	/** Structure for i8042's IRQ. */
94	static irq_t i8042_kbd_irq;	93	static irq_t i8042_kbd_irq;
95	static irq_t i8042_mouse_irq;	94	static irq_t i8042_mouse_irq;
96		95
97	static irq_ownership_t i8042_claim(irq_t *irq)	96	static irq_ownership_t i8042_claim(irq_t *irq)
98	{	97	{
99	i8042_instance_t *i8042_instance = irq->instance;	98	i8042_instance_t *i8042_instance = irq->instance;
100	i8042_t *dev = i8042_instance->i8042;	99	i8042_t *dev = i8042_instance->i8042;
101	if (pio_read_8(&dev->status) & i8042_BUFFER_FULL_MASK)	100	if (pio_read_8(&dev->status) & i8042_BUFFER_FULL_MASK)
102	return IRQ_ACCEPT;	101	return IRQ_ACCEPT;
103	else	102	else
104	return IRQ_DECLINE;	103	return IRQ_DECLINE;
105	}	104	}
106		105
107	static void i8042_irq_handler(irq_t *irq)	106	static void i8042_irq_handler(irq_t *irq)
108	{	107	{
109	i8042_instance_t *instance = irq->instance;	108	i8042_instance_t *instance = irq->instance;
110	i8042_t *dev = instance->i8042;	109	i8042_t *dev = instance->i8042;
111		110
112	uint8_t data;	111	uint8_t data;
113	uint8_t status;	112	uint8_t status;
114		113
115	if (((status = pio_read_8(&dev->status)) & i8042_BUFFER_FULL_MASK)) {	114	if (((status = pio_read_8(&dev->status)) & i8042_BUFFER_FULL_MASK)) {
116	data = pio_read_8(&dev->data);	115	data = pio_read_8(&dev->data);
117		116
118	if ((status & i8042_MOUSE_DATA))	117	if ((status & i8042_MOUSE_DATA))
119	return;	118	return;
120		119
121	if (data & KEY_RELEASE)	120	if (data & KEY_RELEASE)
122	key_released(data ^ KEY_RELEASE);	121	key_released(data ^ KEY_RELEASE);
123	else	122	else
124	key_pressed(data);	123	key_pressed(data);
125	}	124	}
126	}	125	}
127		126
128	/** Initialize i8042. */	127	/** Initialize i8042. */
129	void	128	void
130	i8042_init(devno_t kbd_devno, inr_t kbd_inr, devno_t mouse_devno,	129	i8042_init(devno_t kbd_devno, inr_t kbd_inr, devno_t mouse_devno,
131	inr_t mouse_inr)	130	inr_t mouse_inr)
132	{	131	{
133	i8042_t *dev = lgcy_i8042_instance.i8042;	132	i8042_t *dev = lgcy_i8042_instance.i8042;
134		133
135	chardev_initialize("i8042_kbd", &kbrd, &ops);	134	chardev_initialize("i8042_kbd", &kbrd, &ops);
136	stdin = &kbrd;	135	stdin = &kbrd;
137		136
138	irq_initialize(&i8042_kbd_irq);	137	irq_initialize(&i8042_kbd_irq);
139	i8042_kbd_irq.devno = kbd_devno;	138	i8042_kbd_irq.devno = kbd_devno;
140	i8042_kbd_irq.inr = kbd_inr;	139	i8042_kbd_irq.inr = kbd_inr;
141	i8042_kbd_irq.claim = i8042_claim;	140	i8042_kbd_irq.claim = i8042_claim;
142	i8042_kbd_irq.handler = i8042_irq_handler;	141	i8042_kbd_irq.handler = i8042_irq_handler;
143	i8042_kbd_irq.instance = &lgcy_i8042_instance;	142	i8042_kbd_irq.instance = &lgcy_i8042_instance;
144	irq_register(&i8042_kbd_irq);	143	irq_register(&i8042_kbd_irq);
145		144
146	irq_initialize(&i8042_mouse_irq);	145	irq_initialize(&i8042_mouse_irq);
147	i8042_mouse_irq.devno = mouse_devno;	146	i8042_mouse_irq.devno = mouse_devno;
148	i8042_mouse_irq.inr = mouse_inr;	147	i8042_mouse_irq.inr = mouse_inr;
149	i8042_mouse_irq.claim = i8042_claim;	148	i8042_mouse_irq.claim = i8042_claim;
150	i8042_mouse_irq.handler = i8042_irq_handler;	149	i8042_mouse_irq.handler = i8042_irq_handler;
151	i8042_mouse_irq.instance = &lgcy_i8042_instance;	150	i8042_mouse_irq.instance = &lgcy_i8042_instance;
152	irq_register(&i8042_mouse_irq);	151	irq_register(&i8042_mouse_irq);
153		152
154	trap_virtual_enable_irqs(1 << kbd_inr);	153	trap_virtual_enable_irqs(1 << kbd_inr);
155	trap_virtual_enable_irqs(1 << mouse_inr);	154	trap_virtual_enable_irqs(1 << mouse_inr);
156		155
157	/*	156	/*
158	* Clear input buffer.	157	* Clear input buffer.
159	* Number of iterations is limited to prevent infinite looping.	-
160	*/	158	*/
161	int i;	-
162	for (i = 0; (pio_read_8(&dev->status) & i8042_BUFFER_FULL_MASK) &&	159	while (pio_read_8(&dev->status) & i8042_BUFFER_FULL_MASK)
163	i < 100; i++) {	-
164	(void) pio_read_8(&dev->data);	160	(void) pio_read_8(&dev->data);
165	}	-
166		161
-		162	/*
-		163	* This is the necessary evil until the userspace driver is entirely
-		164	* self-sufficient.
-		165	*/
167	sysinfo_set_item_val("kbd", NULL, true);	166	sysinfo_set_item_val("kbd", NULL, true);
168	sysinfo_set_item_val("kbd.devno", NULL, kbd_devno);	167	sysinfo_set_item_val("kbd.devno", NULL, kbd_devno);
169	sysinfo_set_item_val("kbd.inr", NULL, kbd_inr);	168	sysinfo_set_item_val("kbd.inr", NULL, kbd_inr);
170	#ifdef KBD_LEGACY	169	#ifdef KBD_LEGACY
171	sysinfo_set_item_val("kbd.type", NULL, KBD_LEGACY);	170	sysinfo_set_item_val("kbd.type", NULL, KBD_LEGACY);
172	#endif	171	#endif
173	sysinfo_set_item_val("mouse", NULL, true);	172	sysinfo_set_item_val("mouse", NULL, true);
174	sysinfo_set_item_val("mouse.devno", NULL, mouse_devno);	173	sysinfo_set_item_val("mouse.devno", NULL, mouse_devno);
175	sysinfo_set_item_val("mouse.inr", NULL, mouse_inr);	174	sysinfo_set_item_val("mouse.inr", NULL, mouse_inr);
176	}	175	}
177		176
178	/* Called from getc(). */	177	/* Called from getc(). */
179	void i8042_resume(chardev_t *d)	178	void i8042_resume(chardev_t *d)
180	{	179	{
181	}	180	}
182		181
183	/* Called from getc(). */	182	/* Called from getc(). */
184	void i8042_suspend(chardev_t *d)	183	void i8042_suspend(chardev_t *d)
185	{	184	{
186	}	185	}
187		186
188	/** @}	187	/** @}
189	*/	188	*/
190		189