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