WebSVN – HelenOS – Diff – /trunk/kernel/genarch/src/kbd/ns16550.c


/*
 * Copyright (c) 2001-2006 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   NS 16550 serial port / keyboard driver.
 */
 
#include <genarch/kbd/ns16550.h>
#include <genarch/kbd/key.h>
#include <genarch/kbd/scanc.h>
#include <genarch/kbd/scanc_sun.h>
#include <arch/drivers/kbd.h>
#include <arch/drivers/ns16550.h>
#include <ddi/irq.h>
#include <ipc/irq.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>
#include <arch/interrupt.h>
#include <sysinfo/sysinfo.h>
#include <synch/spinlock.h>
 
#define LSR_DATA_READY  0x01
 
/** Structure representing the ns16550. */
static ns16550_t ns16550;
 
/** Structure for ns16550's IRQ. */
static irq_t ns16550_irq;
 
/*
 * These codes read from ns16550 data register are silently ignored.
 */
#define IGNORE_CODE 0x7f        /* all keys up */
 
static void ns16550_suspend(chardev_t *);
static void ns16550_resume(chardev_t *);
 
static chardev_operations_t ops = {
    .suspend = ns16550_suspend,
    .resume = ns16550_resume,
    .read = ns16550_key_read
};
 
void ns16550_interrupt(void);
 
/** Initialize keyboard and service interrupts using kernel routine */
void ns16550_grab(void)
{
    ipl_t ipl = interrupts_disable();
 
    ns16550_ier_write(&ns16550, IER_ERBFI);     /* enable receiver interrupt */
   
    while (ns16550_lsr_read(&ns16550) & LSR_DATA_READY)
        (void) ns16550_rbr_read(&ns16550);
 
    spinlock_lock(&ns16550_irq.lock);
    ns16550_irq.notif_cfg.notify = false;
    spinlock_unlock(&ns16550_irq.lock);
    interrupts_restore(ipl);
}
 
/** Resume the former interrupt vector */
void ns16550_release(void)
{
    ipl_t ipl = interrupts_disable();
    spinlock_lock(&ns16550_irq.lock);
    if (ns16550_irq.notif_cfg.answerbox)
        ns16550_irq.notif_cfg.notify = true;
    spinlock_unlock(&ns16550_irq.lock);
    interrupts_restore(ipl);
}
 
/** Initialize ns16550.
 *
 * @param devno Device number.
 * @param inr Interrupt number.
 * @param vaddr Virtual address of device's registers.
 */
void ns16550_init(devno_t devno, inr_t inr, uintptr_t vaddr)
{
    chardev_initialize("ns16550_kbd", &kbrd, &ops);
    stdin = &kbrd;
   
    ns16550.devno = devno;
    ns16550.reg = (uint8_t *) vaddr;
   
    irq_initialize(&ns16550_irq);
    ns16550_irq.devno = devno;
    ns16550_irq.inr = inr;
    ns16550_irq.claim = ns16550_claim;
    ns16550_irq.handler = ns16550_irq_handler;
    irq_register(&ns16550_irq);
   
    sysinfo_set_item_val("kbd", NULL, true);
    sysinfo_set_item_val("kbd.type", NULL, KBD_NS16550);
    sysinfo_set_item_val("kbd.devno", NULL, devno);
    sysinfo_set_item_val("kbd.inr", NULL, inr);
    sysinfo_set_item_val("kbd.address.virtual", NULL, vaddr);
   
    ns16550_grab();
}
 
/** Process ns16550 interrupt. */
void ns16550_interrupt(void)
{
    /* TODO
     *
     * ns16550 works in the polled mode so far.
     */
}
 
/* Called from getc(). */
void ns16550_resume(chardev_t *d)
{
}
 
/* Called from getc(). */
void ns16550_suspend(chardev_t *d)
{
}
 
char ns16550_key_read(chardev_t *d)
{
    char ch;   
 
    while(!(ch = active_read_buff_read())) {
        uint8_t x;
        while (!(ns16550_lsr_read(&ns16550) & LSR_DATA_READY))
            ;
        x = ns16550_rbr_read(&ns16550);
        if (x != IGNORE_CODE) {
            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 ns16550_poll(void)
{
    ipl_t ipl;
 
    ipl = interrupts_disable();
    spinlock_lock(&ns16550_irq.lock);
 
    if (ns16550_lsr_read(&ns16550) & LSR_DATA_READY) {
        if (ns16550_irq.notif_cfg.notify && ns16550_irq.notif_cfg.answerbox) {
            /*
             * Send IPC notification.
             */
            ipc_irq_send_notif(&ns16550_irq);
            spinlock_unlock(&ns16550_irq.lock);
            interrupts_restore(ipl);
            return;
        }
    }
 
    spinlock_unlock(&ns16550_irq.lock);
    interrupts_restore(ipl);
 
    while (ns16550_lsr_read(&ns16550) & LSR_DATA_READY) {
        uint8_t x;
       
        x = ns16550_rbr_read(&ns16550);
        if (x != IGNORE_CODE) {
            if (x & KEY_RELEASE)
                key_released(x ^ KEY_RELEASE);
            else
                key_pressed(x);
        }
    }
}
 
irq_ownership_t ns16550_claim(void)
{
    return (ns16550_lsr_read(&ns16550) & LSR_DATA_READY);
}
 
void ns16550_irq_handler(irq_t *irq, void *arg, ...)
{
    panic("Not yet implemented, ns16550 works in polled mode.\n");
}
 
/** @}
 */
 

Rev 1944	Rev 2071
1	/*	1	/*
2	* Copyright (C) 2001-2006 Jakub Jermar	2	* Copyright (c) 2001-2006 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 NS 16550 serial port / keyboard driver.	34	* @brief NS 16550 serial port / keyboard driver.
35	*/	35	*/
36		36
37	#include <genarch/kbd/ns16550.h>	37	#include <genarch/kbd/ns16550.h>
38	#include <genarch/kbd/key.h>	38	#include <genarch/kbd/key.h>
39	#include <genarch/kbd/scanc.h>	39	#include <genarch/kbd/scanc.h>
40	#include <genarch/kbd/scanc_sun.h>	40	#include <genarch/kbd/scanc_sun.h>
41	#include <arch/drivers/kbd.h>	41	#include <arch/drivers/kbd.h>
42	#include <arch/drivers/ns16550.h>	42	#include <arch/drivers/ns16550.h>
43	#include <ddi/irq.h>	43	#include <ddi/irq.h>
44	#include <ipc/irq.h>	44	#include <ipc/irq.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	#include <arch/interrupt.h>	52	#include <arch/interrupt.h>
53	#include <sysinfo/sysinfo.h>	53	#include <sysinfo/sysinfo.h>
54	#include <synch/spinlock.h>	54	#include <synch/spinlock.h>
55		55
56	#define LSR_DATA_READY 0x01	56	#define LSR_DATA_READY 0x01
57		57
58	/** Structure representing the ns16550. */	58	/** Structure representing the ns16550. */
59	static ns16550_t ns16550;	59	static ns16550_t ns16550;
60		60
61	/** Structure for ns16550's IRQ. */	61	/** Structure for ns16550's IRQ. */
62	static irq_t ns16550_irq;	62	static irq_t ns16550_irq;
63		63
64	/*	64	/*
65	* These codes read from ns16550 data register are silently ignored.	65	* These codes read from ns16550 data register are silently ignored.
66	*/	66	*/
67	#define IGNORE_CODE 0x7f /* all keys up */	67	#define IGNORE_CODE 0x7f /* all keys up */
68		68
69	static void ns16550_suspend(chardev_t *);	69	static void ns16550_suspend(chardev_t *);
70	static void ns16550_resume(chardev_t *);	70	static void ns16550_resume(chardev_t *);
71		71
72	static chardev_operations_t ops = {	72	static chardev_operations_t ops = {
73	.suspend = ns16550_suspend,	73	.suspend = ns16550_suspend,
74	.resume = ns16550_resume,	74	.resume = ns16550_resume,
75	.read = ns16550_key_read	75	.read = ns16550_key_read
76	};	76	};
77		77
78	void ns16550_interrupt(void);	78	void ns16550_interrupt(void);
79		79
80	/** Initialize keyboard and service interrupts using kernel routine */	80	/** Initialize keyboard and service interrupts using kernel routine */
81	void ns16550_grab(void)	81	void ns16550_grab(void)
82	{	82	{
83	ipl_t ipl = interrupts_disable();	83	ipl_t ipl = interrupts_disable();
84		84
85	ns16550_ier_write(&ns16550, IER_ERBFI); /* enable receiver interrupt */	85	ns16550_ier_write(&ns16550, IER_ERBFI); /* enable receiver interrupt */
86		86
87	while (ns16550_lsr_read(&ns16550) & LSR_DATA_READY)	87	while (ns16550_lsr_read(&ns16550) & LSR_DATA_READY)
88	(void) ns16550_rbr_read(&ns16550);	88	(void) ns16550_rbr_read(&ns16550);
89		89
90	spinlock_lock(&ns16550_irq.lock);	90	spinlock_lock(&ns16550_irq.lock);
91	ns16550_irq.notif_cfg.notify = false;	91	ns16550_irq.notif_cfg.notify = false;
92	spinlock_unlock(&ns16550_irq.lock);	92	spinlock_unlock(&ns16550_irq.lock);
93	interrupts_restore(ipl);	93	interrupts_restore(ipl);
94	}	94	}
95		95
96	/** Resume the former interrupt vector */	96	/** Resume the former interrupt vector */
97	void ns16550_release(void)	97	void ns16550_release(void)
98	{	98	{
99	ipl_t ipl = interrupts_disable();	99	ipl_t ipl = interrupts_disable();
100	spinlock_lock(&ns16550_irq.lock);	100	spinlock_lock(&ns16550_irq.lock);
101	if (ns16550_irq.notif_cfg.answerbox)	101	if (ns16550_irq.notif_cfg.answerbox)
102	ns16550_irq.notif_cfg.notify = true;	102	ns16550_irq.notif_cfg.notify = true;
103	spinlock_unlock(&ns16550_irq.lock);	103	spinlock_unlock(&ns16550_irq.lock);
104	interrupts_restore(ipl);	104	interrupts_restore(ipl);
105	}	105	}
106		106
107	/** Initialize ns16550.	107	/** Initialize ns16550.
108	*	108	*
109	* @param devno Device number.	109	* @param devno Device number.
110	* @param inr Interrupt number.	110	* @param inr Interrupt number.
111	* @param vaddr Virtual address of device's registers.	111	* @param vaddr Virtual address of device's registers.
112	*/	112	*/
113	void ns16550_init(devno_t devno, inr_t inr, uintptr_t vaddr)	113	void ns16550_init(devno_t devno, inr_t inr, uintptr_t vaddr)
114	{	114	{
115	chardev_initialize("ns16550_kbd", &kbrd, &ops);	115	chardev_initialize("ns16550_kbd", &kbrd, &ops);
116	stdin = &kbrd;	116	stdin = &kbrd;
117		117
118	ns16550.devno = devno;	118	ns16550.devno = devno;
119	ns16550.reg = (uint8_t *) vaddr;	119	ns16550.reg = (uint8_t *) vaddr;
120		120
121	irq_initialize(&ns16550_irq);	121	irq_initialize(&ns16550_irq);
122	ns16550_irq.devno = devno;	122	ns16550_irq.devno = devno;
123	ns16550_irq.inr = inr;	123	ns16550_irq.inr = inr;
124	ns16550_irq.claim = ns16550_claim;	124	ns16550_irq.claim = ns16550_claim;
125	ns16550_irq.handler = ns16550_irq_handler;	125	ns16550_irq.handler = ns16550_irq_handler;
126	irq_register(&ns16550_irq);	126	irq_register(&ns16550_irq);
127		127
128	sysinfo_set_item_val("kbd", NULL, true);	128	sysinfo_set_item_val("kbd", NULL, true);
129	sysinfo_set_item_val("kbd.type", NULL, KBD_NS16550);	129	sysinfo_set_item_val("kbd.type", NULL, KBD_NS16550);
130	sysinfo_set_item_val("kbd.devno", NULL, devno);	130	sysinfo_set_item_val("kbd.devno", NULL, devno);
131	sysinfo_set_item_val("kbd.inr", NULL, inr);	131	sysinfo_set_item_val("kbd.inr", NULL, inr);
132	sysinfo_set_item_val("kbd.address.virtual", NULL, vaddr);	132	sysinfo_set_item_val("kbd.address.virtual", NULL, vaddr);
133		133
134	ns16550_grab();	134	ns16550_grab();
135	}	135	}
136		136
137	/** Process ns16550 interrupt. */	137	/** Process ns16550 interrupt. */
138	void ns16550_interrupt(void)	138	void ns16550_interrupt(void)
139	{	139	{
140	/* TODO	140	/* TODO
141	*	141	*
142	* ns16550 works in the polled mode so far.	142	* ns16550 works in the polled mode so far.
143	*/	143	*/
144	}	144	}
145		145
146	/* Called from getc(). */	146	/* Called from getc(). */
147	void ns16550_resume(chardev_t *d)	147	void ns16550_resume(chardev_t *d)
148	{	148	{
149	}	149	}
150		150
151	/* Called from getc(). */	151	/* Called from getc(). */
152	void ns16550_suspend(chardev_t *d)	152	void ns16550_suspend(chardev_t *d)
153	{	153	{
154	}	154	}
155		155
156	char ns16550_key_read(chardev_t *d)	156	char ns16550_key_read(chardev_t *d)
157	{	157	{
158	char ch;	158	char ch;
159		159
160	while(!(ch = active_read_buff_read())) {	160	while(!(ch = active_read_buff_read())) {
161	uint8_t x;	161	uint8_t x;
162	while (!(ns16550_lsr_read(&ns16550) & LSR_DATA_READY))	162	while (!(ns16550_lsr_read(&ns16550) & LSR_DATA_READY))
163	;	163	;
164	x = ns16550_rbr_read(&ns16550);	164	x = ns16550_rbr_read(&ns16550);
165	if (x != IGNORE_CODE) {	165	if (x != IGNORE_CODE) {
166	if (x & KEY_RELEASE)	166	if (x & KEY_RELEASE)
167	key_released(x ^ KEY_RELEASE);	167	key_released(x ^ KEY_RELEASE);
168	else	168	else
169	active_read_key_pressed(x);	169	active_read_key_pressed(x);
170	}	170	}
171	}	171	}
172	return ch;	172	return ch;
173	}	173	}
174		174
175	/** Poll for key press and release events.	175	/** Poll for key press and release events.
176	*	176	*
177	* This function can be used to implement keyboard polling.	177	* This function can be used to implement keyboard polling.
178	*/	178	*/
179	void ns16550_poll(void)	179	void ns16550_poll(void)
180	{	180	{
181	ipl_t ipl;	181	ipl_t ipl;
182		182
183	ipl = interrupts_disable();	183	ipl = interrupts_disable();
184	spinlock_lock(&ns16550_irq.lock);	184	spinlock_lock(&ns16550_irq.lock);
185		185
186	if (ns16550_lsr_read(&ns16550) & LSR_DATA_READY) {	186	if (ns16550_lsr_read(&ns16550) & LSR_DATA_READY) {
187	if (ns16550_irq.notif_cfg.notify && ns16550_irq.notif_cfg.answerbox) {	187	if (ns16550_irq.notif_cfg.notify && ns16550_irq.notif_cfg.answerbox) {
188	/*	188	/*
189	* Send IPC notification.	189	* Send IPC notification.
190	*/	190	*/
191	ipc_irq_send_notif(&ns16550_irq);	191	ipc_irq_send_notif(&ns16550_irq);
192	spinlock_unlock(&ns16550_irq.lock);	192	spinlock_unlock(&ns16550_irq.lock);
193	interrupts_restore(ipl);	193	interrupts_restore(ipl);
194	return;	194	return;
195	}	195	}
196	}	196	}
197		197
198	spinlock_unlock(&ns16550_irq.lock);	198	spinlock_unlock(&ns16550_irq.lock);
199	interrupts_restore(ipl);	199	interrupts_restore(ipl);
200		200
201	while (ns16550_lsr_read(&ns16550) & LSR_DATA_READY) {	201	while (ns16550_lsr_read(&ns16550) & LSR_DATA_READY) {
202	uint8_t x;	202	uint8_t x;
203		203
204	x = ns16550_rbr_read(&ns16550);	204	x = ns16550_rbr_read(&ns16550);
205	if (x != IGNORE_CODE) {	205	if (x != IGNORE_CODE) {
206	if (x & KEY_RELEASE)	206	if (x & KEY_RELEASE)
207	key_released(x ^ KEY_RELEASE);	207	key_released(x ^ KEY_RELEASE);
208	else	208	else
209	key_pressed(x);	209	key_pressed(x);
210	}	210	}
211	}	211	}
212	}	212	}
213		213
214	irq_ownership_t ns16550_claim(void)	214	irq_ownership_t ns16550_claim(void)
215	{	215	{
216	return (ns16550_lsr_read(&ns16550) & LSR_DATA_READY);	216	return (ns16550_lsr_read(&ns16550) & LSR_DATA_READY);
217	}	217	}
218		218
219	void ns16550_irq_handler(irq_t irq, void arg, ...)	219	void ns16550_irq_handler(irq_t irq, void arg, ...)
220	{	220	{
221	panic("Not yet implemented, ns16550 works in polled mode.\n");	221	panic("Not yet implemented, ns16550 works in polled mode.\n");
222	}	222	}
223		223
224	/** @}	224	/** @}
225	*/	225	*/
226		226

Subversion Repositories HelenOS

(root)/trunk/kernel/genarch/src/kbd/ns16550.c – Rev 1944 → 2071