lunaix-os/kernel/peripheral/ps2kbd.c

   1 #include <lunaix/peripheral/ps2kbd.h>
   2 #include <lunaix/clock.h>
   3 #include <lunaix/timer.h>
   4 #include <lunaix/common.h>
   5 #include <lunaix/syslog.h>
   6 #include <hal/acpi/acpi.h>
   7 #include <hal/ioapic.h>
   8
   9 #include <hal/cpu.h>
  10 #include <arch/x86/interrupts.h>
  11 #include <klibc/string.h>
  12
  13 #include <stdint.h>
  14
  15 #define PS2_DEV_CMD_MAX_ATTEMPTS 5
  16
  17 LOG_MODULE("PS2KBD");
  18
  19 static struct ps2_cmd_queue cmd_q;
  20 static struct ps2_key_buffer key_buf;
  21 static struct ps2_kbd_state kbd_state;
  22
  23 #define KEY_NUM(x)      (x + 0x30)
  24 #define KEY_NPAD(x)      ON_KEYPAD(KEY_NUM(x))
  25
  26 // 我们使用 Scancode Set 2
  27
  28 // 大部分的扫描码（键码）
  29 static kbd_keycode_t scancode_set2[] = {
  30     0, KEY_F9, 0, KEY_F5, KEY_F3, KEY_F1, KEY_F2, KEY_F12, 0, KEY_F10, KEY_F8, KEY_F6,
  31     KEY_F4, KEY_HTAB, '`', 0, 0, KEY_LALT, KEY_LSHIFT, 0, KEY_LCTRL, 'q', KEY_NUM(1),
  32     0, 0, 0, 'z', 's', 'a', 'w', KEY_NUM(2), 0, 0, 'c', 'x', 'd', 'e', KEY_NUM(4), KEY_NUM(3),
  33     0, 0, KEY_SPACE, 'v', 'f', 't', 'r', KEY_NUM(5),
  34     0, 0, 'n', 'b', 'h', 'g', 'y', KEY_NUM(6), 0, 0, 0, 'm', 'j', 'u', KEY_NUM(7), KEY_NUM(8),
  35     0, 0, ',', 'k', 'i', 'o', KEY_NUM(0), KEY_NUM(9), 0, 0, '.', '/', 'l', ';', 'p', '-', 0, 0,
  36     0, '\'', 0, '[', '=', 0, 0, KEY_CAPSLK, KEY_RSHIFT, KEY_LF, ']', 0, '\\', 0, 0, 0, 0, 0, 0, 0,
  37     0, KEY_BS, 0, 0, KEY_NPAD(1), 0, KEY_NPAD(4), KEY_NPAD(7), 0, 0, 0, KEY_NPAD(0), ON_KEYPAD('.'),
  38     KEY_NPAD(2), KEY_NPAD(5), KEY_NPAD(6), KEY_NPAD(8), KEY_ESC, KEY_NUMSLK, KEY_F11, ON_KEYPAD('+'),
  39     KEY_NPAD(3), ON_KEYPAD('-'), ON_KEYPAD('*'), KEY_NPAD(9), KEY_SCRLLK, 0, 0, 0, 0, KEY_F7
  40 };
  41
  42 // 一些特殊的键码（以 0xe0 位前缀的）
  43 static kbd_keycode_t scancode_set2_ex[] = {
  44     0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, KEY_RALT, 0, 0,
  45     KEY_RCTRL, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
  46     0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
  47     0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, ON_KEYPAD('/'), 0, 0, 0, 0, 0, 0, 0, 0,
  48     0, 0, 0, 0, 0, 0, 0, ON_KEYPAD(KEY_LF), 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
  49     KEY_END, 0, KEY_LEFT, KEY_HOME,
  50     0, 0, 0, KEY_INSERT, KEY_DELETE, KEY_DOWN, 0, KEY_RIGHT, KEY_UP, 0, 0,
  51     0, 0, KEY_PG_DOWN, 0, 0, KEY_PG_UP
  52 };
  53
  54 // 用于处理 Shift+<key> 的情况
  55 static kbd_keycode_t scancode_set2_shift[] = {
  56     0, KEY_F9, 0, KEY_F5, KEY_F3, KEY_F1, KEY_F2, KEY_F12, 0, KEY_F10, KEY_F8, KEY_F6,
  57     KEY_F4, KEY_HTAB, '~', 0, 0, KEY_LALT, KEY_LSHIFT, 0, KEY_LCTRL, 'Q', '!',
  58     0, 0, 0, 'Z', 'S', 'A', 'W', '@', 0, 0, 'C', 'X', 'D', 'E', '$', '#',
  59     0, 0, KEY_SPACE, 'V', 'F', 'T', 'R', '%',
  60     0, 0, 'N', 'B', 'H', 'G', 'Y', '^', 0, 0, 0, 'M', 'J', 'U', '&', '*',
  61     0, 0, '<', 'K', 'I', 'O', ')', '(', 0, 0, '>', '?', 'L', ':', 'P', '_', 0, 0,
  62     0, '"', 0, '{', '+', 0, 0, KEY_CAPSLK, KEY_RSHIFT, KEY_LF, '}', 0, '|', 0, 0, 0, 0, 0, 0, 0,
  63     0, KEY_BS, 0, 0, KEY_NPAD(1), 0, KEY_NPAD(4), KEY_NPAD(7), 0, 0, 0, KEY_NPAD(0), ON_KEYPAD('.'),
  64     KEY_NPAD(2), KEY_NPAD(5), KEY_NPAD(6), KEY_NPAD(8), KEY_ESC, KEY_NUMSLK, KEY_F11, ON_KEYPAD('+'),
  65     KEY_NPAD(3), ON_KEYPAD('-'), ON_KEYPAD('*'), KEY_SCRLLK, 0, 0, 0, 0, KEY_F7
  66 };
  67
  68
  69 #define KBD_STATE_KWAIT         0x00
  70 #define KBD_STATE_KSPECIAL      0x01
  71 #define KBD_STATE_KRELEASED     0x02
  72 #define KBD_STATE_CMDPROCS      0x40
  73
  74 void intr_ps2_kbd_handler(const isr_param* param);
  75 static struct kdb_keyinfo_pkt* ps2_keybuffer_next_write();
  76
  77 // TODO: Abstract the bounded buffer out.
  78 void ps2_device_post_cmd(char cmd, char arg) {
  79     mutex_lock(&cmd_q.mutex);
  80     int index = (cmd_q.queue_ptr + cmd_q.queue_len) % PS2_CMD_QUEUE_SIZE;
  81     if (index == cmd_q.queue_ptr && cmd_q.queue_len) {
  82         // 队列已满！
  83         mutex_unlock(&cmd_q.mutex);
  84         return;
  85     }
  86
  87     struct ps2_cmd *container = &cmd_q.cmd_queue[index];
  88     container->cmd = cmd;
  89     container->arg = arg;
  90     cmd_q.queue_len++;
  91
  92     // 释放锁，同理。
  93     mutex_unlock(&cmd_q.mutex);
  94 }
  95
  96 void ps2_kbd_init() {
  97
  98     memset(&cmd_q, 0, sizeof(cmd_q));
  99     memset(&key_buf, 0, sizeof(key_buf));
 100     memset(&kbd_state, 0, sizeof(kbd_state));
 101
 102     mutex_init(&cmd_q.mutex);
 103     mutex_init(&key_buf.mutex);
 104
 105
 106     kbd_state.translation_table = scancode_set2;
 107     kbd_state.state = KBD_STATE_KWAIT;
 108
 109     acpi_context* acpi_ctx = acpi_get_context();
 110     if (acpi_ctx->fadt.header.rev > 1) {
 111         /*
 112          *  只有当前ACPI版本大于1时，我们才使用FADT的IAPC_BOOT_ARCH去判断8042是否存在。
 113          *  这是一个坑，在ACPI v1中，这个字段是reserved！而这及至APCI v2才出现。
 114          *  需要注意：Bochs 和 QEMU 使用的是ACPI v1，而非 v2 （virtualbox好像是v4）
 115          *
 116          *  请看Bochs的bios源码（QEMU的BIOS其实是照抄bochs的，所以也是一个德行。。）：
 117          *      https://bochs.sourceforge.io/cgi-bin/lxr/source/bios/rombios32.c#L1314
 118          */
 119         if (!(acpi_ctx->fadt.boot_arch & IAPC_ARCH_8042)) {
 120             kprintf(KERROR "No PS/2 controller detected.\n");
 121             // FUTURE: Some alternative fallback on this? Check PCI bus for USB controller instead?
 122             return;
 123         }
 124     }
 125     else {
 126         kprintf(KWARN "Outdated FADT used, assuming 8042 always exist.\n");
 127     }
 128
 129
 130     cpu_disable_interrupt();
 131
 132     // 1、禁用任何的PS/2设备
 133     ps2_post_cmd(PS2_PORT_CTRL_CMDREG, PS2_CMD_PORT1_DISABLE, PS2_NO_ARG);
 134     ps2_post_cmd(PS2_PORT_CTRL_CMDREG, PS2_CMD_PORT2_DISABLE, PS2_NO_ARG);
 135
 136     // 2、清空控制器缓冲区
 137     io_inb(PS2_PORT_ENC_DATA);
 138
 139     char result;
 140
 141     // 3、屏蔽所有PS/2设备（端口1&2）IRQ，并且禁用键盘键码转换功能
 142     result = ps2_issue_cmd(PS2_CMD_READ_CFG, PS2_NO_ARG);
 143     result = result & ~(PS2_CFG_P1INT | PS2_CFG_P2INT | PS2_CFG_TRANSLATION);
 144     ps2_post_cmd(PS2_PORT_CTRL_CMDREG, PS2_CMD_WRITE_CFG, result);
 145
 146     // 4、控制器自检
 147     result = ps2_issue_cmd(PS2_CMD_SELFTEST, PS2_NO_ARG);
 148     if (result != PS2_RESULT_TEST_OK) {
 149         kprintf(KERROR "Controller self-test failed.");
 150         goto done;
 151     }
 152
 153     // 5、设备自检（端口1自检，通常是我们的键盘）
 154     result = ps2_issue_cmd(PS2_CMD_SELFTEST_PORT1, PS2_NO_ARG);
 155     if (result != 0) {
 156         kprintf(KERROR "Interface test on port 1 failed.");
 157         goto done;
 158     }
 159
 160     // 6、开启位于端口1的 IRQ，并启用端口1。不用理会端口2，那儿一般是鼠标。
 161     ps2_post_cmd(PS2_PORT_CTRL_CMDREG, PS2_CMD_PORT1_ENABLE, PS2_NO_ARG);
 162     result = ps2_issue_cmd(PS2_CMD_READ_CFG, PS2_NO_ARG);
 163     result = result | PS2_CFG_P1INT;
 164     ps2_post_cmd(PS2_PORT_CTRL_CMDREG, PS2_CMD_WRITE_CFG, result);
 165
 166     // 至此，PS/2控制器和设备已完成初始化，可以正常使用。
 167
 168     // 将我们的键盘驱动挂载到第204号中断上（已由IOAPIC映射至IRQ#1），
 169     intr_subscribe(PC_KBD_IV, intr_ps2_kbd_handler);
 170
 171     // 搞一个计时器，将我们的 ps2_process_cmd 挂上去。每隔5毫秒执行排在队头的命令。
 172     //  为什么只执行队头的命令，而不是全部的命令？
 173     //      因为我们需要保证isr尽量的简短，运行起来快速。而发送这些命令非常的耗时。
 174     timer_run_ms(5, ps2_process_cmd, NULL, TIMER_MODE_PERIODIC);
 175
 176     /*
 177      *   一切准备就绪后，我们才教ioapic去启用IRQ#1。
 178      *   至于为什么要在这里，原因是：初始化所使用的一些指令可能会导致IRQ#1的触发（因为返回码），或者是一些什么
 179      *  情况导致IRQ#1的误触发（可能是未初始化导致IRQ#1线上不稳定）。于是这些IRQ#1会堆积在APIC的队列里（因为此时我们正在
 180      *  初始化8042，屏蔽了所有中断，IF=0）。
 181      *  当sti后，这些堆积的中断会紧跟着递送进CPU里，导致我们的键盘handler误认为由按键按下，从而将这个毫无意义的数值加入
 182      *  我们的队列中，以供上层读取。
 183      *
 184      *  所以，保险的方法是：在初始化后才去设置ioapic，这样一来我们就能有一个稳定的IRQ#1以放心使用。
 185     */
 186     uint8_t irq_kbd = ioapic_get_irq(acpi_ctx, PC_AT_IRQ_KBD);
 187     ioapic_redirect(irq_kbd, PC_KBD_IV, 0, IOAPIC_DELMOD_FIXED);
 188
 189 done:
 190     cpu_enable_interrupt();
 191 }
 192
 193 void ps2_process_cmd(void* arg) {
 194     // 检查锁是否已被启用，如果启用，则表明该timer中断发生时，某个指令正在入队。
 195     // 如果是这种情况则跳过，留到下一轮再尝试处理。
 196     // 注意，这里其实是ISR的一部分（timer中断），对于单核CPU来说，ISR等同于单个的原子操作。
 197     // （因为EFLAGS.IF=0，所有可屏蔽中断被屏蔽。对于NMI的情况，那么就直接算是triple fault了，所以也没有讨论的意义）
 198     // 所以，假若我们遵从互斥锁的严格定义（即这里需要阻塞），那么中断将会被阻塞，进而造成死锁。
 199     // 因此，我们这里仅仅进行判断。
 200     // 会不会产生指令堆积？不会，因为指令发送的频率远远低于指令队列清空的频率。在目前，我们发送的唯一指令
 201     // 就只是用来开关键盘上的LED灯（如CAPSLOCK）。
 202     if (mutex_on_hold(&cmd_q.mutex) || !cmd_q.queue_len) {
 203         return;
 204     }
 205
 206     // 处理队列排头的指令
 207     struct ps2_cmd *pending_cmd = &cmd_q.cmd_queue[cmd_q.queue_ptr];
 208     char result;
 209     int attempts = 0;
 210
 211     // 尝试将命令发送至PS/2键盘（通过PS/2控制器）
 212     // 如果不成功（0x60 IO口返回 0xfe，即 NAK 或 Resend）
 213     // 则尝试最多五次
 214     do {
 215         result = ps2_issue_dev_cmd(pending_cmd->cmd, pending_cmd->arg);
 216         kbd_state.state += KBD_STATE_CMDPROCS;
 217         attempts++;
 218     } while(result == PS2_RESULT_NAK && attempts < PS2_DEV_CMD_MAX_ATTEMPTS);
 219
 220     // XXX: 是否需要处理不成功的指令？
 221
 222     cmd_q.queue_ptr = (cmd_q.queue_ptr + 1) % PS2_CMD_QUEUE_SIZE;
 223     cmd_q.queue_len--;
 224 }
 225
 226 void kbd_buffer_key_event(kbd_keycode_t key, uint8_t scancode, kbd_kstate_t state) {
 227     // forgive me on these ugly bit-level tricks,
 228     // I really hate doing branching on these "fliping switch" things
 229     if (key == KEY_CAPSLK) {
 230         kbd_state.key_state ^= KBD_KEY_FCAPSLKED & -state;
 231     } else if (key == KEY_NUMSLK) {
 232         kbd_state.key_state ^= KBD_KEY_FNUMBLKED & -state;
 233     } else if (key == KEY_SCRLLK) {
 234         kbd_state.key_state ^= KBD_KEY_FSCRLLKED & -state;
 235     } else {
 236         if ((key & MODIFR)) {
 237             kbd_kstate_t tmp = (KBD_KEY_FLSHIFT_HELD << (key & 0x00ff));
 238             kbd_state.key_state = (kbd_state.key_state & ~tmp) | (tmp & -state);
 239         }
 240         else if (!(key & 0xff00) && (kbd_state.key_state & (KBD_KEY_FLSHIFT_HELD | KBD_KEY_FRSHIFT_HELD))) {
 241             key = scancode_set2_shift[scancode];
 242         }
 243         state = state | kbd_state.key_state;
 244         key = key & (0xffdf | -('a' > key || key > 'z' || !(state & KBD_KEY_FCAPSLKED)));
 245
 246         if (!mutex_on_hold(&key_buf.mutex)) {
 247             struct kdb_keyinfo_pkt* keyevent_pkt = ps2_keybuffer_next_write();
 248             *keyevent_pkt = (struct kdb_keyinfo_pkt) {
 249                 .keycode = key,
 250                 .scancode = scancode,
 251                 .state = state,
 252                 .timestamp = clock_systime()
 253             };
 254         }
 255
 256         // kprintf(KDEBUG "%c (t=%d, s=%x, c=%d)\n", key & 0x00ff, timestamp, state, key >> 8);
 257         return; // do not delete this return
 258     }
 259
 260     // Ooops, this guy generates irq!
 261     ps2_device_post_cmd(PS2_KBD_CMD_SETLED, (kbd_state.key_state >> 1) & 0x00ff);
 262 }
 263
 264 void intr_ps2_kbd_handler(const isr_param* param) {
 265
 266     // Do not move this line. It is in the right place and right order.
 267     // This is to ensure we've cleared the output buffer everytime, so it won't pile up across irqs.
 268     uint8_t scancode = io_inb(PS2_PORT_ENC_DATA);
 269     kbd_keycode_t key;
 270
 271     /*
 272      *    判断键盘是否处在指令发送状态，防止误触发。（伪输入中断）
 273      * 这是因为我们需要向ps/2设备发送指令（比如控制led灯），而指令会有返回码。
 274      * 这就会有可能导致ps/2控制器在受到我们的命令后（在ps2_process_cmd中），
 275      * 产生IRQ#1中断（虽然说这种情况取决于底层BIOS实现，但还是会发生，比如QEMU和bochs）。
 276      * 所以这就是说，当IRQ#1中断产生时，我们的CPU正处在另一个ISR中。这样就会导致所有的外部中断被缓存在APIC内部的
 277      * FIFO队列里，进行排队等待（APIC长度为二的队列 {IRR, TMR}；参考 Intel Manual Vol.3A 10.8.4）
 278      * 那么当ps2_process_cmd执行完后（内嵌在#APIC_TIMER_IV），CPU返回EOI给APIC，APIC紧接着将排在队里的IRQ#1发送给CPU
 279      * 造成误触发。也就是说，我们此时读入的scancode实则上是上一个指令的返回代码。
 280      *
 281      * Problem 1 (Fixed):
 282      *      但是这种方法有个问题，那就是，假若我们的某一个命令失败了一次，ps/2给出0xfe，我们重传，ps/2收到指令并给出0xfa。
 283      *  那么这样一来，将会由两个连续的IRQ#1产生。而APIC是最多可以缓存两个IRQ，于是我们就会漏掉一个IRQ，依然会误触发。
 284      * Solution:
 285      *      累加掩码 ;)
 286      */
 287     if ((kbd_state.state & 0xc0)) {
 288         kbd_state.state -= KBD_STATE_CMDPROCS;
 289         return;
 290     }
 291
 292     //kprintf(KDEBUG "%x\n", scancode & 0xff);
 293
 294     switch (kbd_state.state)
 295     {
 296     case KBD_STATE_KWAIT:
 297         if (scancode == 0xf0) { // release code
 298             kbd_state.state = KBD_STATE_KRELEASED;
 299         } else if (scancode == 0xe0) {
 300             kbd_state.state = KBD_STATE_KSPECIAL;
 301             kbd_state.translation_table = scancode_set2_ex;
 302         } else {
 303             key = kbd_state.translation_table[scancode];
 304             kbd_buffer_key_event(key, scancode, KBD_KEY_FPRESSED);
 305         }
 306         break;
 307     case KBD_STATE_KSPECIAL:
 308         if (scancode == 0xf0) { //release code
 309             kbd_state.state = KBD_STATE_KRELEASED;
 310         } else {
 311             key = kbd_state.translation_table[scancode];
 312             kbd_buffer_key_event(key, scancode, KBD_KEY_FPRESSED);
 313
 314             kbd_state.state = KBD_STATE_KWAIT;
 315             kbd_state.translation_table = scancode_set2;
 316         }
 317         break;
 318     case KBD_STATE_KRELEASED:
 319         key = kbd_state.translation_table[scancode];
 320         kbd_buffer_key_event(key, scancode, KBD_KEY_FRELEASED);
 321
 322         // reset the translation table to scancode_set2
 323         kbd_state.state = KBD_STATE_KWAIT;
 324         kbd_state.translation_table = scancode_set2;
 325         break;
 326
 327     default:
 328         break;
 329     }
 330 }
 331
 332 static uint8_t ps2_issue_cmd(char cmd, uint16_t arg) {
 333     ps2_post_cmd(PS2_PORT_CTRL_CMDREG, cmd, arg);
 334
 335     char result;
 336
 337     // 等待PS/2控制器返回。通过轮询（polling）状态寄存器的 bit 0
 338     // 如置位，则表明返回代码此时就在 0x60 IO口上等待读取。
 339     while(!((result = io_inb(PS2_PORT_CTRL_STATUS)) & PS2_STATUS_OFULL));
 340
 341     return io_inb(PS2_PORT_ENC_CMDREG);
 342 }
 343
 344 static uint8_t ps2_issue_dev_cmd(char cmd, uint16_t arg) {
 345     ps2_post_cmd(PS2_PORT_ENC_CMDREG, cmd, arg);
 346
 347     char result;
 348
 349     // 等待PS/2控制器返回。通过轮询（polling）状态寄存器的 bit 0
 350     // 如置位，则表明返回代码此时就在 0x60 IO口上等待读取。
 351     while(!((result = io_inb(PS2_PORT_CTRL_STATUS)) & PS2_STATUS_OFULL));
 352
 353     return io_inb(PS2_PORT_ENC_CMDREG);
 354 }
 355
 356 static void ps2_post_cmd(uint8_t port, char cmd, uint16_t arg) {
 357     char result;
 358     // 等待PS/2输入缓冲区清空，这样我们才可以写入命令
 359     while((result = io_inb(PS2_PORT_CTRL_STATUS)) & PS2_STATUS_IFULL);
 360
 361     io_outb(port, cmd);
 362     io_delay(PS2_DELAY);
 363
 364     if (!(arg & PS2_NO_ARG)) {
 365         // 所有参数一律通过0x60传入。
 366         io_outb(PS2_PORT_ENC_CMDREG, (uint8_t)(arg & 0x00ff));
 367         io_delay(PS2_DELAY);
 368     }
 369 }
 370
 371 int kbd_recv_key(struct kdb_keyinfo_pkt* key_event) {
 372     if (!key_buf.buffered_len) {
 373         return 0;
 374     }
 375     mutex_lock(&key_buf.mutex);
 376
 377     struct kdb_keyinfo_pkt* pkt_current = &key_buf.buffer[key_buf.read_ptr];
 378
 379     *key_event = *pkt_current;
 380     key_buf.buffered_len--;
 381     key_buf.read_ptr = (key_buf.read_ptr + 1) % PS2_KBD_RECV_BUFFER_SIZE;
 382
 383     mutex_unlock(&key_buf.mutex);
 384     return 1;
 385 }
 386
 387 static struct kdb_keyinfo_pkt* ps2_keybuffer_next_write() {
 388     int index = (key_buf.read_ptr + key_buf.buffered_len) % PS2_KBD_RECV_BUFFER_SIZE;
 389     if (index == key_buf.read_ptr && key_buf.buffered_len) {
 390         // the reader is lagged so much such that the buffer is full.
 391         // It is suggested to read from beginning for nearly up-to-date readings.
 392         key_buf.read_ptr = 0;
 393         key_buf.buffered_len = index;
 394     }
 395     else {
 396         key_buf.buffered_len++;
 397     }
 398     return &key_buf.buffer[index];
 399 }