| 1 | /*
|
|---|
| 2 | * Copyright (c) 2001-2004 Jakub Jermar
|
|---|
| 3 | * All rights reserved.
|
|---|
| 4 | *
|
|---|
| 5 | * Redistribution and use in source and binary forms, with or without
|
|---|
| 6 | * modification, are permitted provided that the following conditions
|
|---|
| 7 | * are met:
|
|---|
| 8 | *
|
|---|
| 9 | * - Redistributions of source code must retain the above copyright
|
|---|
| 10 | * notice, this list of conditions and the following disclaimer.
|
|---|
| 11 | * - Redistributions in binary form must reproduce the above copyright
|
|---|
| 12 | * notice, this list of conditions and the following disclaimer in the
|
|---|
| 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
|
|---|
| 15 | * derived from this software without specific prior written permission.
|
|---|
| 16 | *
|
|---|
| 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
|
|---|
| 19 | * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
|
|---|
| 20 | * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
|
|---|
| 21 | * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
|
|---|
| 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
|
|---|
| 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
|
|---|
| 26 | * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|---|
| 27 | */
|
|---|
| 28 |
|
|---|
| 29 | /** @addtogroup genarch
|
|---|
| 30 | * @{
|
|---|
| 31 | */
|
|---|
| 32 | /**
|
|---|
| 33 | * @file
|
|---|
| 34 | * @brief i8042 processor driver.
|
|---|
| 35 | *
|
|---|
| 36 | * It takes care of low-level keyboard functions.
|
|---|
| 37 | */
|
|---|
| 38 |
|
|---|
| 39 | #include <genarch/kbd/i8042.h>
|
|---|
| 40 | #include <arch/drivers/kbd.h>
|
|---|
| 41 | #include <genarch/kbd/key.h>
|
|---|
| 42 | #include <genarch/kbd/scanc.h>
|
|---|
| 43 | #include <genarch/kbd/scanc_pc.h>
|
|---|
| 44 | #include <genarch/drivers/legacy/ia32/io.h>
|
|---|
| 45 | #include <cpu.h>
|
|---|
| 46 | #include <arch/asm.h>
|
|---|
| 47 | #include <arch.h>
|
|---|
| 48 | #include <console/chardev.h>
|
|---|
| 49 | #include <console/console.h>
|
|---|
| 50 | #include <interrupt.h>
|
|---|
| 51 | #include <sysinfo/sysinfo.h>
|
|---|
| 52 | #include <ipc/irq.h>
|
|---|
| 53 |
|
|---|
| 54 | i8042_instance_t lgcy_i8042_instance = {
|
|---|
| 55 | .i8042 = (i8042_t *) I8042_BASE,
|
|---|
| 56 | };
|
|---|
| 57 |
|
|---|
| 58 | /* Keyboard commands. */
|
|---|
| 59 | #define KBD_ENABLE 0xf4
|
|---|
| 60 | #define KBD_DISABLE 0xf5
|
|---|
| 61 | #define KBD_ACK 0xfa
|
|---|
| 62 |
|
|---|
| 63 | /*
|
|---|
| 64 | * 60 Write 8042 Command Byte: next data byte written to port 60h is
|
|---|
| 65 | * placed in 8042 command register. Format:
|
|---|
| 66 | *
|
|---|
| 67 | * |7|6|5|4|3|2|1|0|8042 Command Byte
|
|---|
| 68 | * | | | | | | | `---- 1=enable output register full interrupt
|
|---|
| 69 | * | | | | | | `----- should be 0
|
|---|
| 70 | * | | | | | `------ 1=set status register system, 0=clear
|
|---|
| 71 | * | | | | `------- 1=override keyboard inhibit, 0=allow inhibit
|
|---|
| 72 | * | | | `-------- disable keyboard I/O by driving clock line low
|
|---|
| 73 | * | | `--------- disable auxiliary device, drives clock line low
|
|---|
| 74 | * | `---------- IBM scancode translation 0=AT, 1=PC/XT
|
|---|
| 75 | * `----------- reserved, should be 0
|
|---|
| 76 | */
|
|---|
| 77 |
|
|---|
| 78 | #define i8042_SET_COMMAND 0x60
|
|---|
| 79 | #define i8042_COMMAND 0x69
|
|---|
| 80 |
|
|---|
| 81 | #define i8042_BUFFER_FULL_MASK 0x01
|
|---|
| 82 | #define i8042_WAIT_MASK 0x02
|
|---|
| 83 | #define i8042_MOUSE_DATA 0x20
|
|---|
| 84 |
|
|---|
| 85 | static void i8042_suspend(chardev_t *);
|
|---|
| 86 | static void i8042_resume(chardev_t *);
|
|---|
| 87 |
|
|---|
| 88 | static chardev_operations_t ops = {
|
|---|
| 89 | .suspend = i8042_suspend,
|
|---|
| 90 | .resume = i8042_resume,
|
|---|
| 91 | };
|
|---|
| 92 |
|
|---|
| 93 | /** Structure for i8042's IRQ. */
|
|---|
| 94 | static irq_t i8042_kbd_irq;
|
|---|
| 95 | static irq_t i8042_mouse_irq;
|
|---|
| 96 |
|
|---|
| 97 | void i8042_grab(void)
|
|---|
| 98 | {
|
|---|
| 99 | ipl_t ipl = interrupts_disable();
|
|---|
| 100 |
|
|---|
| 101 | spinlock_lock(&i8042_kbd_irq.lock);
|
|---|
| 102 | i8042_kbd_irq.notif_cfg.notify = false;
|
|---|
| 103 | spinlock_unlock(&i8042_kbd_irq.lock);
|
|---|
| 104 |
|
|---|
| 105 | spinlock_lock(&i8042_mouse_irq.lock);
|
|---|
| 106 | i8042_mouse_irq.notif_cfg.notify = false;
|
|---|
| 107 | spinlock_unlock(&i8042_mouse_irq.lock);
|
|---|
| 108 |
|
|---|
| 109 | interrupts_restore(ipl);
|
|---|
| 110 | }
|
|---|
| 111 |
|
|---|
| 112 | void i8042_release(void)
|
|---|
| 113 | {
|
|---|
| 114 | ipl_t ipl = interrupts_disable();
|
|---|
| 115 |
|
|---|
| 116 | spinlock_lock(&i8042_kbd_irq.lock);
|
|---|
| 117 | if (i8042_kbd_irq.notif_cfg.answerbox)
|
|---|
| 118 | i8042_kbd_irq.notif_cfg.notify = true;
|
|---|
| 119 | spinlock_unlock(&i8042_kbd_irq.lock);
|
|---|
| 120 |
|
|---|
| 121 | spinlock_lock(&i8042_mouse_irq.lock);
|
|---|
| 122 | if (i8042_mouse_irq.notif_cfg.answerbox)
|
|---|
| 123 | i8042_mouse_irq.notif_cfg.notify = true;
|
|---|
| 124 | spinlock_unlock(&i8042_mouse_irq.lock);
|
|---|
| 125 |
|
|---|
| 126 | interrupts_restore(ipl);
|
|---|
| 127 | }
|
|---|
| 128 |
|
|---|
| 129 | static irq_ownership_t i8042_claim(irq_t *irq)
|
|---|
| 130 | {
|
|---|
| 131 | i8042_instance_t *i8042_instance = irq->instance;
|
|---|
| 132 | i8042_t *dev = i8042_instance->i8042;
|
|---|
| 133 | if (pio_read_8(&dev->status) & i8042_BUFFER_FULL_MASK)
|
|---|
| 134 | return IRQ_ACCEPT;
|
|---|
| 135 | else
|
|---|
| 136 | return IRQ_DECLINE;
|
|---|
| 137 | }
|
|---|
| 138 |
|
|---|
| 139 | static void i8042_irq_handler(irq_t *irq)
|
|---|
| 140 | {
|
|---|
| 141 | if (irq->notif_cfg.notify && irq->notif_cfg.answerbox) {
|
|---|
| 142 | /*
|
|---|
| 143 | * This will hopefully go to the IRQ dispatcher code soon.
|
|---|
| 144 | */
|
|---|
| 145 | ipc_irq_send_notif(irq);
|
|---|
| 146 | return;
|
|---|
| 147 | }
|
|---|
| 148 |
|
|---|
| 149 | i8042_instance_t *instance = irq->instance;
|
|---|
| 150 | i8042_t *dev = instance->i8042;
|
|---|
| 151 |
|
|---|
| 152 | uint8_t data;
|
|---|
| 153 | uint8_t status;
|
|---|
| 154 |
|
|---|
| 155 | if (((status = pio_read_8(&dev->status)) & i8042_BUFFER_FULL_MASK)) {
|
|---|
| 156 | data = pio_read_8(&dev->data);
|
|---|
| 157 |
|
|---|
| 158 | if ((status & i8042_MOUSE_DATA))
|
|---|
| 159 | return;
|
|---|
| 160 |
|
|---|
| 161 | if (data & KEY_RELEASE)
|
|---|
| 162 | key_released(data ^ KEY_RELEASE);
|
|---|
| 163 | else
|
|---|
| 164 | key_pressed(data);
|
|---|
| 165 | }
|
|---|
| 166 | }
|
|---|
| 167 |
|
|---|
| 168 | /** Initialize i8042. */
|
|---|
| 169 | void
|
|---|
| 170 | i8042_init(devno_t kbd_devno, inr_t kbd_inr, devno_t mouse_devno,
|
|---|
| 171 | inr_t mouse_inr)
|
|---|
| 172 | {
|
|---|
| 173 | i8042_t *dev = lgcy_i8042_instance.i8042;
|
|---|
| 174 |
|
|---|
| 175 | chardev_initialize("i8042_kbd", &kbrd, &ops);
|
|---|
| 176 | stdin = &kbrd;
|
|---|
| 177 |
|
|---|
| 178 | irq_initialize(&i8042_kbd_irq);
|
|---|
| 179 | i8042_kbd_irq.devno = kbd_devno;
|
|---|
| 180 | i8042_kbd_irq.inr = kbd_inr;
|
|---|
| 181 | i8042_kbd_irq.claim = i8042_claim;
|
|---|
| 182 | i8042_kbd_irq.handler = i8042_irq_handler;
|
|---|
| 183 | i8042_kbd_irq.instance = &lgcy_i8042_instance;
|
|---|
| 184 | irq_register(&i8042_kbd_irq);
|
|---|
| 185 |
|
|---|
| 186 | irq_initialize(&i8042_mouse_irq);
|
|---|
| 187 | i8042_mouse_irq.devno = mouse_devno;
|
|---|
| 188 | i8042_mouse_irq.inr = mouse_inr;
|
|---|
| 189 | i8042_mouse_irq.claim = i8042_claim;
|
|---|
| 190 | i8042_mouse_irq.handler = i8042_irq_handler;
|
|---|
| 191 | i8042_mouse_irq.instance = &lgcy_i8042_instance;
|
|---|
| 192 | irq_register(&i8042_mouse_irq);
|
|---|
| 193 |
|
|---|
| 194 | trap_virtual_enable_irqs(1 << kbd_inr);
|
|---|
| 195 | trap_virtual_enable_irqs(1 << mouse_inr);
|
|---|
| 196 |
|
|---|
| 197 | /*
|
|---|
| 198 | * Clear input buffer.
|
|---|
| 199 | * Number of iterations is limited to prevent infinite looping.
|
|---|
| 200 | */
|
|---|
| 201 | int i;
|
|---|
| 202 | for (i = 0; (pio_read_8(&dev->status) & i8042_BUFFER_FULL_MASK) &&
|
|---|
| 203 | i < 100; i++) {
|
|---|
| 204 | (void) pio_read_8(&dev->data);
|
|---|
| 205 | }
|
|---|
| 206 |
|
|---|
| 207 | sysinfo_set_item_val("kbd", NULL, true);
|
|---|
| 208 | sysinfo_set_item_val("kbd.devno", NULL, kbd_devno);
|
|---|
| 209 | sysinfo_set_item_val("kbd.inr", NULL, kbd_inr);
|
|---|
| 210 | #ifdef KBD_LEGACY
|
|---|
| 211 | sysinfo_set_item_val("kbd.type", NULL, KBD_LEGACY);
|
|---|
| 212 | #endif
|
|---|
| 213 | sysinfo_set_item_val("mouse", NULL, true);
|
|---|
| 214 | sysinfo_set_item_val("mouse.devno", NULL, mouse_devno);
|
|---|
| 215 | sysinfo_set_item_val("mouse.inr", NULL, mouse_inr);
|
|---|
| 216 |
|
|---|
| 217 | i8042_grab();
|
|---|
| 218 | }
|
|---|
| 219 |
|
|---|
| 220 | /* Called from getc(). */
|
|---|
| 221 | void i8042_resume(chardev_t *d)
|
|---|
| 222 | {
|
|---|
| 223 | }
|
|---|
| 224 |
|
|---|
| 225 | /* Called from getc(). */
|
|---|
| 226 | void i8042_suspend(chardev_t *d)
|
|---|
| 227 | {
|
|---|
| 228 | }
|
|---|
| 229 |
|
|---|
| 230 | /** @}
|
|---|
| 231 | */
|
|---|
