WebSVN – HelenOS – Diff – /branches/tracing/kernel/genarch/src/kbd/z8530.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   Zilog 8530 serial port / keyboard driver.
 */
 
#include <genarch/kbd/z8530.h>
#include <genarch/kbd/key.h>
#include <genarch/kbd/scanc.h>
#include <genarch/kbd/scanc_sun.h>
#include <arch/drivers/z8530.h>
#include <ddi/irq.h>
#include <ipc/irq.h>
#include <arch/interrupt.h>
#include <arch/drivers/kbd.h>
#include <arch/drivers/fhc.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>
#include <print.h>
 
/*
 * These codes read from z8530 data register are silently ignored.
 */
#define IGNORE_CODE 0x7f        /* all keys up */
 
static z8530_t z8530;       /**< z8530 device structure. */
static irq_t z8530_irq;     /**< z8530's IRQ. */
 
static void z8530_suspend(chardev_t *);
static void z8530_resume(chardev_t *);
 
static chardev_operations_t ops = {
    .suspend = z8530_suspend,
    .resume = z8530_resume,
    .read = z8530_key_read
};
 
/** Initialize keyboard and service interrupts using kernel routine. */
void z8530_grab(void)
{
    ipl_t ipl = interrupts_disable();
 
    (void) z8530_read_a(&z8530, RR8);
 
    /*
     * Clear any pending TX interrupts or we never manage
     * to set FHC UART interrupt state to idle.
     */
    z8530_write_a(&z8530, WR0, WR0_TX_IP_RST);
 
    z8530_write_a(&z8530, WR1, WR1_IARCSC);     /* interrupt on all characters */
 
    /* 8 bits per character and enable receiver */
    z8530_write_a(&z8530, WR3, WR3_RX8BITSCH | WR3_RX_ENABLE);
   
    z8530_write_a(&z8530, WR9, WR9_MIE);        /* Master Interrupt Enable. */
   
    spinlock_lock(&z8530_irq.lock);
    z8530_irq.notif_cfg.notify = false;
    spinlock_unlock(&z8530_irq.lock);
    interrupts_restore(ipl);
}
 
/** Resume the former IPC notification behavior. */
void z8530_release(void)
{
    ipl_t ipl = interrupts_disable();
    spinlock_lock(&z8530_irq.lock);
    if (z8530_irq.notif_cfg.answerbox)
        z8530_irq.notif_cfg.notify = true;
    spinlock_unlock(&z8530_irq.lock);
    interrupts_restore(ipl);
}
 
/** Initialize z8530. */
void z8530_init(devno_t devno, inr_t inr, uintptr_t vaddr)
{
    chardev_initialize("z8530_kbd", &kbrd, &ops);
    stdin = &kbrd;
 
    z8530.devno = devno;
    z8530.reg = (uint8_t *) vaddr;
 
    irq_initialize(&z8530_irq);
    z8530_irq.devno = devno;
    z8530_irq.inr = inr;
    z8530_irq.claim = z8530_claim;
    z8530_irq.handler = z8530_irq_handler;
    irq_register(&z8530_irq);
 
    sysinfo_set_item_val("kbd", NULL, true);
    sysinfo_set_item_val("kbd.type", NULL, KBD_Z8530);
    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);
 
    z8530_grab();
}
 
/** Process z8530 interrupt.
 *
 * @param n Interrupt vector.
 * @param istate Interrupted state.
 */
void z8530_interrupt(void)
{
    z8530_poll();
}
 
/* Called from getc(). */
void z8530_resume(chardev_t *d)
{
}
 
/* Called from getc(). */
void z8530_suspend(chardev_t *d)
{
}
 
char z8530_key_read(chardev_t *d)
{
    char ch;   
 
    while(!(ch = active_read_buff_read())) {
        uint8_t x;
        while (!(z8530_read_a(&z8530, RR0) & RR0_RCA))
            ;
        x = z8530_read_a(&z8530, RR8);
        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 z8530_poll(void)
{
    uint8_t x;
 
    while (z8530_read_a(&z8530, RR0) & RR0_RCA) {
        x = z8530_read_a(&z8530, RR8);
        if (x != IGNORE_CODE) {
            if (x & KEY_RELEASE)
                key_released(x ^ KEY_RELEASE);
            else
                key_pressed(x);
        }
    }
}
 
irq_ownership_t z8530_claim(void)
{
    return (z8530_read_a(&z8530, RR0) & RR0_RCA);
}
 
void z8530_irq_handler(irq_t *irq, void *arg, ...)
{
    /*
     * So far, we know we got this interrupt through the FHC.
     * Since we don't have enough documentation about the FHC
     * and because the interrupt looks like level sensitive,
     * we cannot handle it by scheduling one of the level
     * interrupt traps. Process the interrupt directly.
     */
    if (irq->notif_cfg.notify && irq->notif_cfg.answerbox)
        ipc_irq_send_notif(irq);
    else
        z8530_interrupt();
    fhc_clear_interrupt(central_fhc, irq->inr);
}
 
/** @}
 */
 

Rev 2089	Rev 2787
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 Zilog 8530 serial port / keyboard driver.	34	* @brief Zilog 8530 serial port / keyboard driver.
35	*/	35	*/
36		36
37	#include <genarch/kbd/z8530.h>	37	#include <genarch/kbd/z8530.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/z8530.h>	41	#include <arch/drivers/z8530.h>
42	#include <ddi/irq.h>	42	#include <ddi/irq.h>
43	#include <ipc/irq.h>	43	#include <ipc/irq.h>
44	#include <arch/interrupt.h>	44	#include <arch/interrupt.h>
45	#include <arch/drivers/kbd.h>	45	#include <arch/drivers/kbd.h>
46	#include <arch/drivers/fhc.h>	46	#include <arch/drivers/fhc.h>
47	#include <cpu.h>	47	#include <cpu.h>
48	#include <arch/asm.h>	48	#include <arch/asm.h>
49	#include <arch.h>	49	#include <arch.h>
50	#include <console/chardev.h>	50	#include <console/chardev.h>
51	#include <console/console.h>	51	#include <console/console.h>
52	#include <interrupt.h>	52	#include <interrupt.h>
53	#include <sysinfo/sysinfo.h>	53	#include <sysinfo/sysinfo.h>
54	#include <print.h>	54	#include <print.h>
55		55
56	/*	56	/*
57	* These codes read from z8530 data register are silently ignored.	57	* These codes read from z8530 data register are silently ignored.
58	*/	58	*/
59	#define IGNORE_CODE 0x7f /* all keys up */	59	#define IGNORE_CODE 0x7f /* all keys up */
60		60
61	static z8530_t z8530; /*< z8530 device structure. /	61	static z8530_t z8530; /*< z8530 device structure. /
62	static irq_t z8530_irq; /*< z8530's IRQ. /	62	static irq_t z8530_irq; /*< z8530's IRQ. /
63		63
64	static void z8530_suspend(chardev_t *);	64	static void z8530_suspend(chardev_t *);
65	static void z8530_resume(chardev_t *);	65	static void z8530_resume(chardev_t *);
66		66
67	static chardev_operations_t ops = {	67	static chardev_operations_t ops = {
68	.suspend = z8530_suspend,	68	.suspend = z8530_suspend,
69	.resume = z8530_resume,	69	.resume = z8530_resume,
70	.read = z8530_key_read	70	.read = z8530_key_read
71	};	71	};
72		72
73	/** Initialize keyboard and service interrupts using kernel routine. */	73	/** Initialize keyboard and service interrupts using kernel routine. */
74	void z8530_grab(void)	74	void z8530_grab(void)
75	{	75	{
76	ipl_t ipl = interrupts_disable();	76	ipl_t ipl = interrupts_disable();
77		77
78	(void) z8530_read_a(&z8530, RR8);	78	(void) z8530_read_a(&z8530, RR8);
79		79
80	/*	80	/*
81	* Clear any pending TX interrupts or we never manage	81	* Clear any pending TX interrupts or we never manage
82	* to set FHC UART interrupt state to idle.	82	* to set FHC UART interrupt state to idle.
83	*/	83	*/
84	z8530_write_a(&z8530, WR0, WR0_TX_IP_RST);	84	z8530_write_a(&z8530, WR0, WR0_TX_IP_RST);
85		85
86	z8530_write_a(&z8530, WR1, WR1_IARCSC); /* interrupt on all characters */	86	z8530_write_a(&z8530, WR1, WR1_IARCSC); /* interrupt on all characters */
87		87
88	/* 8 bits per character and enable receiver */	88	/* 8 bits per character and enable receiver */
89	z8530_write_a(&z8530, WR3, WR3_RX8BITSCH \| WR3_RX_ENABLE);	89	z8530_write_a(&z8530, WR3, WR3_RX8BITSCH \| WR3_RX_ENABLE);
90		90
91	z8530_write_a(&z8530, WR9, WR9_MIE); /* Master Interrupt Enable. */	91	z8530_write_a(&z8530, WR9, WR9_MIE); /* Master Interrupt Enable. */
92		92
93	spinlock_lock(&z8530_irq.lock);	93	spinlock_lock(&z8530_irq.lock);
94	z8530_irq.notif_cfg.notify = false;	94	z8530_irq.notif_cfg.notify = false;
95	spinlock_unlock(&z8530_irq.lock);	95	spinlock_unlock(&z8530_irq.lock);
96	interrupts_restore(ipl);	96	interrupts_restore(ipl);
97	}	97	}
98		98
99	/** Resume the former IPC notification behavior. */	99	/** Resume the former IPC notification behavior. */
100	void z8530_release(void)	100	void z8530_release(void)
101	{	101	{
102	ipl_t ipl = interrupts_disable();	102	ipl_t ipl = interrupts_disable();
103	spinlock_lock(&z8530_irq.lock);	103	spinlock_lock(&z8530_irq.lock);
104	if (z8530_irq.notif_cfg.answerbox)	104	if (z8530_irq.notif_cfg.answerbox)
105	z8530_irq.notif_cfg.notify = true;	105	z8530_irq.notif_cfg.notify = true;
106	spinlock_unlock(&z8530_irq.lock);	106	spinlock_unlock(&z8530_irq.lock);
107	interrupts_restore(ipl);	107	interrupts_restore(ipl);
108	}	108	}
109		109
110	/** Initialize z8530. */	110	/** Initialize z8530. */
111	void z8530_init(devno_t devno, inr_t inr, uintptr_t vaddr)	111	void z8530_init(devno_t devno, inr_t inr, uintptr_t vaddr)
112	{	112	{
113	chardev_initialize("z8530_kbd", &kbrd, &ops);	113	chardev_initialize("z8530_kbd", &kbrd, &ops);
114	stdin = &kbrd;	114	stdin = &kbrd;
115		115
116	z8530.devno = devno;	116	z8530.devno = devno;
117	z8530.reg = (uint8_t *) vaddr;	117	z8530.reg = (uint8_t *) vaddr;
118		118
119	irq_initialize(&z8530_irq);	119	irq_initialize(&z8530_irq);
120	z8530_irq.devno = devno;	120	z8530_irq.devno = devno;
121	z8530_irq.inr = inr;	121	z8530_irq.inr = inr;
122	z8530_irq.claim = z8530_claim;	122	z8530_irq.claim = z8530_claim;
123	z8530_irq.handler = z8530_irq_handler;	123	z8530_irq.handler = z8530_irq_handler;
124	irq_register(&z8530_irq);	124	irq_register(&z8530_irq);
125		125
126	sysinfo_set_item_val("kbd", NULL, true);	126	sysinfo_set_item_val("kbd", NULL, true);
127	sysinfo_set_item_val("kbd.type", NULL, KBD_Z8530);	127	sysinfo_set_item_val("kbd.type", NULL, KBD_Z8530);
128	sysinfo_set_item_val("kbd.devno", NULL, devno);	128	sysinfo_set_item_val("kbd.devno", NULL, devno);
129	sysinfo_set_item_val("kbd.inr", NULL, inr);	129	sysinfo_set_item_val("kbd.inr", NULL, inr);
130	sysinfo_set_item_val("kbd.address.virtual", NULL, vaddr);	130	sysinfo_set_item_val("kbd.address.virtual", NULL, vaddr);
131		131
132	z8530_grab();	132	z8530_grab();
133	}	133	}
134		134
135	/** Process z8530 interrupt.	135	/** Process z8530 interrupt.
136	*	136	*
137	* @param n Interrupt vector.	137	* @param n Interrupt vector.
138	* @param istate Interrupted state.	138	* @param istate Interrupted state.
139	*/	139	*/
140	void z8530_interrupt(void)	140	void z8530_interrupt(void)
141	{	141	{
142	z8530_poll();	142	z8530_poll();
143	}	143	}
144		144
145	/* Called from getc(). */	145	/* Called from getc(). */
146	void z8530_resume(chardev_t *d)	146	void z8530_resume(chardev_t *d)
147	{	147	{
148	}	148	}
149		149
150	/* Called from getc(). */	150	/* Called from getc(). */
151	void z8530_suspend(chardev_t *d)	151	void z8530_suspend(chardev_t *d)
152	{	152	{
153	}	153	}
154		154
155	char z8530_key_read(chardev_t *d)	155	char z8530_key_read(chardev_t *d)
156	{	156	{
157	char ch;	157	char ch;
158		158
159	while(!(ch = active_read_buff_read())) {	159	while(!(ch = active_read_buff_read())) {
160	uint8_t x;	160	uint8_t x;
161	while (!(z8530_read_a(&z8530, RR0) & RR0_RCA))	161	while (!(z8530_read_a(&z8530, RR0) & RR0_RCA))
162	;	162	;
163	x = z8530_read_a(&z8530, RR8);	163	x = z8530_read_a(&z8530, RR8);
164	if (x != IGNORE_CODE) {	164	if (x != IGNORE_CODE) {
165	if (x & KEY_RELEASE)	165	if (x & KEY_RELEASE)
166	key_released(x ^ KEY_RELEASE);	166	key_released(x ^ KEY_RELEASE);
167	else	167	else
168	active_read_key_pressed(x);	168	active_read_key_pressed(x);
169	}	169	}
170	}	170	}
171	return ch;	171	return ch;
172	}	172	}
173		173
174	/** Poll for key press and release events.	174	/** Poll for key press and release events.
175	*	175	*
176	* This function can be used to implement keyboard polling.	176	* This function can be used to implement keyboard polling.
177	*/	177	*/
178	void z8530_poll(void)	178	void z8530_poll(void)
179	{	179	{
180	uint8_t x;	180	uint8_t x;
181		181
182	while (z8530_read_a(&z8530, RR0) & RR0_RCA) {	182	while (z8530_read_a(&z8530, RR0) & RR0_RCA) {
183	x = z8530_read_a(&z8530, RR8);	183	x = z8530_read_a(&z8530, RR8);
184	if (x != IGNORE_CODE) {	184	if (x != IGNORE_CODE) {
185	if (x & KEY_RELEASE)	185	if (x & KEY_RELEASE)
186	key_released(x ^ KEY_RELEASE);	186	key_released(x ^ KEY_RELEASE);
187	else	187	else
188	key_pressed(x);	188	key_pressed(x);
189	}	189	}
190	}	190	}
191	}	191	}
192		192
193	irq_ownership_t z8530_claim(void)	193	irq_ownership_t z8530_claim(void)
194	{	194	{
195	return (z8530_read_a(&z8530, RR0) & RR0_RCA);	195	return (z8530_read_a(&z8530, RR0) & RR0_RCA);
196	}	196	}
197		197
198	void z8530_irq_handler(irq_t irq, void arg, ...)	198	void z8530_irq_handler(irq_t irq, void arg, ...)
199	{	199	{
200	/*	200	/*
201	* So far, we know we got this interrupt through the FHC.	201	* So far, we know we got this interrupt through the FHC.
202	* Since we don't have enough documentation about the FHC	202	* Since we don't have enough documentation about the FHC
203	* and because the interrupt looks like level sensitive,	203	* and because the interrupt looks like level sensitive,
204	* we cannot handle it by scheduling one of the level	204	* we cannot handle it by scheduling one of the level
205	* interrupt traps. Process the interrupt directly.	205	* interrupt traps. Process the interrupt directly.
206	*/	206	*/
207	if (irq->notif_cfg.notify && irq->notif_cfg.answerbox)	207	if (irq->notif_cfg.notify && irq->notif_cfg.answerbox)
208	ipc_irq_send_notif(irq);	208	ipc_irq_send_notif(irq);
209	else	209	else
210	z8530_interrupt();	210	z8530_interrupt();
211	fhc_clear_interrupt(central_fhc, irq->inr);	211	fhc_clear_interrupt(central_fhc, irq->inr);
212	}	212	}
213		213
214	/** @}	214	/** @}
215	*/	215	*/
216		216

Subversion Repositories HelenOS

(root)/branches/tracing/kernel/genarch/src/kbd/z8530.c @ 3675 – Rev 2089 → 2787