lunaix-os/kernel/peripheral/ps2kbd.c

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