WebSVN – HelenOS – Diff – /trunk/kernel/genarch/src/kbd/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 <genarch/kbd/key.h>
#include <genarch/kbd/scanc.h>
#include <genarch/kbd/scanc_pc.h>
#include <arch/drivers/i8042.h>
#include <arch/interrupt.h>
#include <cpu.h>
#include <arch/asm.h>
#include <arch.h>
#include <typedefs.h>
#include <console/chardev.h>
#include <console/console.h>
#include <interrupt.h>
 
/* 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,
    .read = i8042_key_read
};
 
static void i8042_interrupt(int n, istate_t *istate);
static void i8042_wait(void);
 
static iroutine oldvector;
/** Initialize keyboard and service interrupts using kernel routine */
void i8042_grab(void)
{
    oldvector = exc_register(VECTOR_KBD, "i8042_interrupt", (iroutine) i8042_interrupt);
    i8042_wait();
    i8042_command_write(i8042_SET_COMMAND);
    i8042_wait();
    i8042_data_write(i8042_COMMAND);
    i8042_wait();
}
/** Resume the former interrupt vector */
void i8042_release(void)
{
    if (oldvector)
        exc_register(VECTOR_KBD, "user_interrupt", oldvector);
}
 
/** Initialize i8042. */
void i8042_init(void)
{
    int i;
 
    i8042_grab();
        /* Prevent user from accidentaly releasing calling i8042_resume
     * and disabling keyboard
     */
    oldvector = NULL;
 
    trap_virtual_enable_irqs(1<<IRQ_KBD);
    chardev_initialize("i8042_kbd", &kbrd, &ops);
    stdin = &kbrd;
 
    /*
     * Clear input buffer.
     * Number of iterations is limited to prevent infinite looping.
     */
    for (i = 0; (i8042_status_read() & i8042_BUFFER_FULL_MASK) && i < 100; i++) {
        i8042_data_read();
    }  
}
 
/** Process i8042 interrupt.
 *
 * @param n Interrupt vector.
 * @param istate Interrupted state.
 */
void i8042_interrupt(int n, istate_t *istate)
{
    uint8_t x;
    uint8_t status;
 
    while (((status=i8042_status_read()) & i8042_BUFFER_FULL_MASK)) {
        x = i8042_data_read();
 
        if ((status & i8042_MOUSE_DATA))
            continue;
 
        if (x & KEY_RELEASE)
            key_released(x ^ KEY_RELEASE);
        else
            key_pressed(x);
    }
    trap_virtual_eoi();
}
 
/** Wait until the controller reads its data. */
void i8042_wait(void) {
    while (i8042_status_read() & i8042_WAIT_MASK) {
        /* wait */
    }
}
 
/* Called from getc(). */
void i8042_resume(chardev_t *d)
{
}
 
/* Called from getc(). */
void i8042_suspend(chardev_t *d)
{
}
 
char i8042_key_read(chardev_t *d)
{
    char ch;   
 
    while(!(ch = active_read_buff_read())) {
        uint8_t x;
        while (!(i8042_status_read() & i8042_BUFFER_FULL_MASK))
            ;
        x = i8042_data_read();
        if (x & KEY_RELEASE)
            key_released(x ^ KEY_RELEASE);
        else
            active_read_key_pressed(x);
    }
    return ch;
}
 
/** Poll for key press and release events.
 *
 * This function can be used to implement keyboard polling.
 */
void i8042_poll(void)
{
    uint8_t x;
 
    while (((x = i8042_status_read() & i8042_BUFFER_FULL_MASK))) {
        x = i8042_data_read();
        if (x & KEY_RELEASE)
            key_released(x ^ KEY_RELEASE);
        else
            key_pressed(x);
    }
}
 
/** @}
 */
 

Rev 1843	Rev 1896
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 <arch/interrupt.h>	44	#include <arch/interrupt.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 <typedefs.h>	48	#include <typedefs.h>
49	#include <console/chardev.h>	49	#include <console/chardev.h>
50	#include <console/console.h>	50	#include <console/console.h>
51	#include <interrupt.h>	51	#include <interrupt.h>
52		52
53	/* Keyboard commands. */	53	/* Keyboard commands. */
54	#define KBD_ENABLE 0xf4	54	#define KBD_ENABLE 0xf4
55	#define KBD_DISABLE 0xf5	55	#define KBD_DISABLE 0xf5
56	#define KBD_ACK 0xfa	56	#define KBD_ACK 0xfa
57		57
58	/*	58	/*
59	* 60 Write 8042 Command Byte: next data byte written to port 60h is	59	* 60 Write 8042 Command Byte: next data byte written to port 60h is
60	* placed in 8042 command register. Format:	60	* placed in 8042 command register. Format:
61	*	61	*
62	* \|7\|6\|5\|4\|3\|2\|1\|0\|8042 Command Byte	62	* \|7\|6\|5\|4\|3\|2\|1\|0\|8042 Command Byte
63	* \| \| \| \| \| \| \| `---- 1=enable output register full interrupt	63	* \| \| \| \| \| \| \| `---- 1=enable output register full interrupt
64	* \| \| \| \| \| \| `----- should be 0	64	* \| \| \| \| \| \| `----- should be 0
65	* \| \| \| \| \| `------ 1=set status register system, 0=clear	65	* \| \| \| \| \| `------ 1=set status register system, 0=clear
66	* \| \| \| \| `------- 1=override keyboard inhibit, 0=allow inhibit	66	* \| \| \| \| `------- 1=override keyboard inhibit, 0=allow inhibit
67	* \| \| \| `-------- disable keyboard I/O by driving clock line low	67	* \| \| \| `-------- disable keyboard I/O by driving clock line low
68	* \| \| `--------- disable auxiliary device, drives clock line low	68	* \| \| `--------- disable auxiliary device, drives clock line low
69	* \| `---------- IBM scancode translation 0=AT, 1=PC/XT	69	* \| `---------- IBM scancode translation 0=AT, 1=PC/XT
70	* `----------- reserved, should be 0	70	* `----------- reserved, should be 0
71	*/	71	*/
72		72
73	#define i8042_SET_COMMAND 0x60	73	#define i8042_SET_COMMAND 0x60
74	#define i8042_COMMAND 0x69	74	#define i8042_COMMAND 0x69
75		75
76	#define i8042_BUFFER_FULL_MASK 0x01	76	#define i8042_BUFFER_FULL_MASK 0x01
77	#define i8042_WAIT_MASK 0x02	77	#define i8042_WAIT_MASK 0x02
78	#define i8042_MOUSE_DATA 0x20	78	#define i8042_MOUSE_DATA 0x20
79		79
80	static void i8042_suspend(chardev_t *);	80	static void i8042_suspend(chardev_t *);
81	static void i8042_resume(chardev_t *);	81	static void i8042_resume(chardev_t *);
82		82
83	chardev_t kbrd;	-
84	static chardev_operations_t ops = {	83	static chardev_operations_t ops = {
85	.suspend = i8042_suspend,	84	.suspend = i8042_suspend,
86	.resume = i8042_resume,	85	.resume = i8042_resume,
87	.read = key_read	86	.read = i8042_key_read
88	};	87	};
89		88
90	static void i8042_interrupt(int n, istate_t *istate);	89	static void i8042_interrupt(int n, istate_t *istate);
91	static void i8042_wait(void);	90	static void i8042_wait(void);
92		91
93	static iroutine oldvector;	92	static iroutine oldvector;
94	/** Initialize keyboard and service interrupts using kernel routine */	93	/** Initialize keyboard and service interrupts using kernel routine */
95	void i8042_grab(void)	94	void i8042_grab(void)
96	{	95	{
97	oldvector = exc_register(VECTOR_KBD, "i8042_interrupt", (iroutine) i8042_interrupt);	96	oldvector = exc_register(VECTOR_KBD, "i8042_interrupt", (iroutine) i8042_interrupt);
98	i8042_wait();	97	i8042_wait();
99	i8042_command_write(i8042_SET_COMMAND);	98	i8042_command_write(i8042_SET_COMMAND);
100	i8042_wait();	99	i8042_wait();
101	i8042_data_write(i8042_COMMAND);	100	i8042_data_write(i8042_COMMAND);
102	i8042_wait();	101	i8042_wait();
103	}	102	}
104	/** Resume the former interrupt vector */	103	/** Resume the former interrupt vector */
105	void i8042_release(void)	104	void i8042_release(void)
106	{	105	{
107	if (oldvector)	106	if (oldvector)
108	exc_register(VECTOR_KBD, "user_interrupt", oldvector);	107	exc_register(VECTOR_KBD, "user_interrupt", oldvector);
109	}	108	}
110		109
111	/** Initialize i8042. */	110	/** Initialize i8042. */
112	void i8042_init(void)	111	void i8042_init(void)
113	{	112	{
114	int i;	113	int i;
115		114
116	i8042_grab();	115	i8042_grab();
117	/* Prevent user from accidentaly releasing calling i8042_resume	116	/* Prevent user from accidentaly releasing calling i8042_resume
118	* and disabling keyboard	117	* and disabling keyboard
119	*/	118	*/
120	oldvector = NULL;	119	oldvector = NULL;
121		120
122	trap_virtual_enable_irqs(1<<IRQ_KBD);	121	trap_virtual_enable_irqs(1<<IRQ_KBD);
123	chardev_initialize("i8042_kbd", &kbrd, &ops);	122	chardev_initialize("i8042_kbd", &kbrd, &ops);
124	stdin = &kbrd;	123	stdin = &kbrd;
125		124
126	/*	125	/*
127	* Clear input buffer.	126	* Clear input buffer.
128	* Number of iterations is limited to prevent infinite looping.	127	* Number of iterations is limited to prevent infinite looping.
129	*/	128	*/
130	for (i = 0; (i8042_status_read() & i8042_BUFFER_FULL_MASK) && i < 100; i++) {	129	for (i = 0; (i8042_status_read() & i8042_BUFFER_FULL_MASK) && i < 100; i++) {
131	i8042_data_read();	130	i8042_data_read();
132	}	131	}
133	}	132	}
134		133
135	/** Process i8042 interrupt.	134	/** Process i8042 interrupt.
136	*	135	*
137	* @param n Interrupt vector.	136	* @param n Interrupt vector.
138	* @param istate Interrupted state.	137	* @param istate Interrupted state.
139	*/	138	*/
140	void i8042_interrupt(int n, istate_t *istate)	139	void i8042_interrupt(int n, istate_t *istate)
141	{	140	{
142	uint8_t x;	141	uint8_t x;
143	uint8_t status;	142	uint8_t status;
144		143
145	while (((status=i8042_status_read()) & i8042_BUFFER_FULL_MASK)) {	144	while (((status=i8042_status_read()) & i8042_BUFFER_FULL_MASK)) {
146	x = i8042_data_read();	145	x = i8042_data_read();
147		146
148	if ((status & i8042_MOUSE_DATA))	147	if ((status & i8042_MOUSE_DATA))
149	continue;	148	continue;
150		149
151	if (x & KEY_RELEASE)	150	if (x & KEY_RELEASE)
152	key_released(x ^ KEY_RELEASE);	151	key_released(x ^ KEY_RELEASE);
153	else	152	else
154	key_pressed(x);	153	key_pressed(x);
155	}	154	}
156	trap_virtual_eoi();	155	trap_virtual_eoi();
157	}	156	}
158		157
159	/** Wait until the controller reads its data. */	158	/** Wait until the controller reads its data. */
160	void i8042_wait(void) {	159	void i8042_wait(void) {
161	while (i8042_status_read() & i8042_WAIT_MASK) {	160	while (i8042_status_read() & i8042_WAIT_MASK) {
162	/* wait */	161	/* wait */
163	}	162	}
164	}	163	}
165		164
166	/* Called from getc(). */	165	/* Called from getc(). */
167	void i8042_resume(chardev_t *d)	166	void i8042_resume(chardev_t *d)
168	{	167	{
169	}	168	}
170		169
171	/* Called from getc(). */	170	/* Called from getc(). */
172	void i8042_suspend(chardev_t *d)	171	void i8042_suspend(chardev_t *d)
173	{	172	{
174	}	173	}
175		174
176	char key_read(chardev_t *d)	175	char i8042_key_read(chardev_t *d)
177	{	176	{
178	char ch;	177	char ch;
179		178
180	while(!(ch = active_read_buff_read())) {	179	while(!(ch = active_read_buff_read())) {
181	uint8_t x;	180	uint8_t x;
182	while (!(i8042_status_read() & i8042_BUFFER_FULL_MASK))	181	while (!(i8042_status_read() & i8042_BUFFER_FULL_MASK))
183	;	182	;
184	x = i8042_data_read();	183	x = i8042_data_read();
185	if (x & KEY_RELEASE)	184	if (x & KEY_RELEASE)
186	key_released(x ^ KEY_RELEASE);	185	key_released(x ^ KEY_RELEASE);
187	else	186	else
188	active_read_key_pressed(x);	187	active_read_key_pressed(x);
189	}	188	}
190	return ch;	189	return ch;
191	}	190	}
192		191
193	/** Poll for key press and release events.	192	/** Poll for key press and release events.
194	*	193	*
195	* This function can be used to implement keyboard polling.	194	* This function can be used to implement keyboard polling.
196	*/	195	*/
197	void i8042_poll(void)	196	void i8042_poll(void)
198	{	197	{
199	uint8_t x;	198	uint8_t x;
200		199
201	while (((x = i8042_status_read() & i8042_BUFFER_FULL_MASK))) {	200	while (((x = i8042_status_read() & i8042_BUFFER_FULL_MASK))) {
202	x = i8042_data_read();	201	x = i8042_data_read();
203	if (x & KEY_RELEASE)	202	if (x & KEY_RELEASE)
204	key_released(x ^ KEY_RELEASE);	203	key_released(x ^ KEY_RELEASE);
205	else	204	else
206	key_pressed(x);	205	key_pressed(x);
207	}	206	}
208	}	207	}
209		208
210	/** @}	209	/** @}
211	*/	210	*/
212		211

Subversion Repositories HelenOS

(root)/trunk/kernel/genarch/src/kbd/i8042.c – Rev 1843 → 1896