lunaix-os/hal/char/ps2kbd.c

   1 #include <lunaix/clock.h>
   2 #include <lunaix/ds/mutex.h>
   3 #include <lunaix/input.h>
   4 #include <lunaix/isrm.h>
   5 #include <lunaix/keyboard.h>
   6 #include <lunaix/syslog.h>
   7 #include <lunaix/timer.h>
   8 #include <lunaix/pcontext.h>
   9
  10 #include <hal/intc.h>
  11
  12 #include <klibc/string.h>
  13
  14 #include <sys/cpu.h>
  15 #include <sys/port_io.h>
  16
  17 #define PS2_PORT_ENC_DATA 0x60
  18 #define PS2_PORT_ENC_CMDREG 0x60
  19 #define PS2_PORT_CTRL_STATUS 0x64
  20 #define PS2_PORT_CTRL_CMDREG 0x64
  21
  22 #define PS2_STATUS_OFULL 0x1
  23 #define PS2_STATUS_IFULL 0x2
  24
  25 #define PS2_RESULT_ACK 0xfa
  26 #define PS2_RESULT_NAK 0xfe // resend
  27 #define PS2_RESULT_ECHO 0xee
  28 #define PS2_RESULT_TEST_OK 0x55
  29
  30 // PS/2 keyboard device related commands
  31 #define PS2_KBD_CMD_SETLED 0xed
  32 #define PS2_KBD_CMD_ECHO 0xee
  33 #define PS2_KBD_CMD_SCANCODE_SET 0xf0
  34 #define PS2_KBD_CMD_IDENTIFY 0xf2
  35 #define PS2_KBD_CMD_SCAN_ENABLE 0xf4
  36 #define PS2_KBD_CMD_SCAN_DISABLE 0xf5
  37
  38 // PS/2 *controller* related commands
  39 #define PS2_CMD_PORT1_DISABLE 0xad
  40 #define PS2_CMD_PORT1_ENABLE 0xae
  41 #define PS2_CMD_PORT2_DISABLE 0xa7
  42 #define PS2_CMD_PORT2_ENABLE 0xa8
  43 #define PS2_CMD_SELFTEST 0xaa
  44 #define PS2_CMD_SELFTEST_PORT1 0xab
  45
  46 #define PS2_CMD_READ_CFG 0x20
  47 #define PS2_CMD_WRITE_CFG 0x60
  48
  49 #define PS2_CFG_P1INT 0x1
  50 #define PS2_CFG_P2INT 0x2
  51 #define PS2_CFG_TRANSLATION 0x40
  52
  53 #define PS2_DELAY 1000
  54
  55 #define PS2_CMD_QUEUE_SIZE 8
  56
  57 #define PS2_NO_ARG 0xff00
  58
  59 struct ps2_cmd
  60 {
  61     char cmd;
  62     char arg;
  63 };
  64
  65 struct ps2_kbd_state
  66 {
  67     volatile char state;
  68     volatile char masked;
  69     volatile kbd_kstate_t key_state;
  70     kbd_keycode_t* translation_table;
  71 };
  72
  73 struct ps2_cmd_queue
  74 {
  75     struct ps2_cmd cmd_queue[PS2_CMD_QUEUE_SIZE];
  76     int queue_ptr;
  77     int queue_len;
  78     mutex_t mutex;
  79 };
  80
  81 /**
  82  * @brief 向PS/2控制器的控制端口(0x64)发送指令并等待返回代码。
  83  * 注意，对于没有返回代码的命令请使用`ps2_post_cmd`，否则会造成死锁。
  84  * 通过调用该方法向控制器发送指令，请区别 ps2_issue_dev_cmd
  85  *
  86  * @param cmd
  87  * @param args
  88  */
  89 static u8_t
  90 ps2_issue_cmd(char cmd, u16_t arg);
  91
  92 /**
  93  * @brief 向PS/2控制器的编码器端口(0x60)发送指令并等待返回代码。
  94  * 注意，对于没有返回代码的命令请使用`ps2_post_cmd`，否则会造成死锁。
  95  * 通过调用该方法向PS/2设备发送指令，请区别 ps2_issue_cmd
  96  *
  97  * @param cmd
  98  * @param args
  99  */
 100 static u8_t
 101 ps2_issue_dev_cmd(char cmd, u16_t arg);
 102
 103 /**
 104  * @brief 向PS/2控制器发送指令，不等待返回代码。
 105  *
 106  * @param port 端口号
 107  * @param cmd
 108  * @param args
 109  * @return char
 110  */
 111 static void
 112 ps2_post_cmd(u8_t port, char cmd, u16_t arg);
 113
 114 static void
 115 ps2_device_post_cmd(char cmd, char arg);
 116
 117 static void
 118 ps2_process_cmd(void* arg);
 119
 120 #define PS2_DEV_CMD_MAX_ATTEMPTS 5
 121
 122 LOG_MODULE("i8042");
 123
 124 static struct ps2_cmd_queue cmd_q;
 125 static struct ps2_kbd_state kbd_state;
 126
 127 #define KEY_NUM(x) (x + 0x30)
 128 #define KEY_NPAD(x) ON_KEYPAD(KEY_NUM(x))
 129
 130 // 我们使用 Scancode Set 2
 131
 132 // clang-format off
 133
 134 // 大部分的扫描码（键码）
 135 static kbd_keycode_t scancode_set2[] = {
 136     0, KEY_F9, 0, KEY_F5, KEY_F3, KEY_F1, KEY_F2, KEY_F12, 0, KEY_F10, KEY_F8, KEY_F6,
 137     KEY_F4, KEY_HTAB, '`', 0, 0, KEY_LALT, KEY_LSHIFT, 0, KEY_LCTRL, 'q', KEY_NUM(1),
 138     0, 0, 0, 'z', 's', 'a', 'w', KEY_NUM(2), 0, 0, 'c', 'x', 'd', 'e', KEY_NUM(4), KEY_NUM(3),
 139     0, 0, KEY_SPACE, 'v', 'f', 't', 'r', KEY_NUM(5),
 140     0, 0, 'n', 'b', 'h', 'g', 'y', KEY_NUM(6), 0, 0, 0, 'm', 'j', 'u', KEY_NUM(7), KEY_NUM(8),
 141     0, 0, ',', 'k', 'i', 'o', KEY_NUM(0), KEY_NUM(9), 0, 0, '.', '/', 'l', ';', 'p', '-', 0, 0,
 142     0, '\'', 0, '[', '=', 0, 0, KEY_CAPSLK, KEY_RSHIFT, KEY_LF, ']', 0, '\\', 0, 0, 0, 0, 0, 0, 0,
 143     0, KEY_BS, 0, 0, KEY_NPAD(1), 0, KEY_NPAD(4), KEY_NPAD(7), 0, 0, 0, KEY_NPAD(0), ON_KEYPAD('.'),
 144     KEY_NPAD(2), KEY_NPAD(5), KEY_NPAD(6), KEY_NPAD(8), KEY_ESC, KEY_NUMSLK, KEY_F11, ON_KEYPAD('+'),
 145     KEY_NPAD(3), ON_KEYPAD('-'), ON_KEYPAD('*'), KEY_NPAD(9), KEY_SCRLLK, 0, 0, 0, 0, KEY_F7
 146 };
 147
 148 // 一些特殊的键码（以 0xe0 位前缀的）
 149 static kbd_keycode_t scancode_set2_ex[] = {
 150     0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, KEY_RALT, 0, 0,
 151     KEY_RCTRL, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
 152     0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
 153     0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, ON_KEYPAD('/'), 0, 0, 0, 0, 0, 0, 0, 0,
 154     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,
 155     KEY_END, 0, KEY_LEFT, KEY_HOME,
 156     0, 0, 0, KEY_INSERT, KEY_DELETE, KEY_DOWN, 0, KEY_RIGHT, KEY_UP, 0, 0,
 157     0, 0, KEY_PG_DOWN, 0, 0, KEY_PG_UP
 158 };
 159
 160 // 用于处理 Shift+<key> 的情况
 161 static kbd_keycode_t scancode_set2_shift[] = {
 162     0, KEY_F9, 0, KEY_F5, KEY_F3, KEY_F1, KEY_F2, KEY_F12, 0, KEY_F10, KEY_F8, KEY_F6,
 163     KEY_F4, KEY_HTAB, '~', 0, 0, KEY_LALT, KEY_LSHIFT, 0, KEY_LCTRL, 'Q', '!',
 164     0, 0, 0, 'Z', 'S', 'A', 'W', '@', 0, 0, 'C', 'X', 'D', 'E', '$', '#',
 165     0, 0, KEY_SPACE, 'V', 'F', 'T', 'R', '%',
 166     0, 0, 'N', 'B', 'H', 'G', 'Y', '^', 0, 0, 0, 'M', 'J', 'U', '&', '*',
 167     0, 0, '<', 'K', 'I', 'O', ')', '(', 0, 0, '>', '?', 'L', ':', 'P', '_', 0, 0,
 168     0, '"', 0, '{', '+', 0, 0, KEY_CAPSLK, KEY_RSHIFT, KEY_LF, '}', 0, '|', 0, 0, 0, 0, 0, 0, 0,
 169     0, KEY_BS, 0, 0, KEY_NPAD(1), 0, KEY_NPAD(4), KEY_NPAD(7), 0, 0, 0, KEY_NPAD(0), ON_KEYPAD('.'),
 170     KEY_NPAD(2), KEY_NPAD(5), KEY_NPAD(6), KEY_NPAD(8), KEY_ESC, KEY_NUMSLK, KEY_F11, ON_KEYPAD('+'),
 171     KEY_NPAD(3), ON_KEYPAD('-'), ON_KEYPAD('*'), KEY_SCRLLK, 0, 0, 0, 0, KEY_F7
 172 };
 173
 174 // clang-format on
 175
 176 static struct input_device* kbd_idev;
 177
 178 #define KBD_STATE_KWAIT 0x00
 179 #define KBD_STATE_KSPECIAL 0x01
 180 #define KBD_STATE_KRELEASED 0x02
 181 #define KBD_STATE_E012 0x03
 182 #define KBD_STATE_KRELEASED_E0 0x04
 183 #define KBD_STATE_CMDPROCS 0x40
 184
 185 // #define KBD_ENABLE_SPIRQ_FIX
 186 #define KBD_ENABLE_SPIRQ_FIX2
 187 // #define KBD_DBGLOG
 188
 189 static void
 190 intr_ps2_kbd_handler(const isr_param* param);
 191
 192 static u8_t
 193 ps2_issue_cmd_wretry(char cmd, u16_t arg);
 194
 195 static void
 196 ps2_device_post_cmd(char cmd, char arg)
 197 {
 198     mutex_lock(&cmd_q.mutex);
 199     int index = (cmd_q.queue_ptr + cmd_q.queue_len) % PS2_CMD_QUEUE_SIZE;
 200     if (index == cmd_q.queue_ptr && cmd_q.queue_len) {
 201         // 队列已满！
 202         mutex_unlock(&cmd_q.mutex);
 203         return;
 204     }
 205
 206     struct ps2_cmd* container = &cmd_q.cmd_queue[index];
 207     container->cmd = cmd;
 208     container->arg = arg;
 209     cmd_q.queue_len++;
 210
 211     // 释放锁，同理。
 212     mutex_unlock(&cmd_q.mutex);
 213 }
 214
 215 static int
 216 ps2_kbd_init(struct device_def* devdef)
 217 {
 218
 219     memset(&cmd_q, 0, sizeof(cmd_q));
 220     memset(&kbd_state, 0, sizeof(kbd_state));
 221
 222     mutex_init(&cmd_q.mutex);
 223
 224     kbd_state.translation_table = scancode_set2;
 225     kbd_state.state = KBD_STATE_KWAIT;
 226
 227     kbd_idev = input_add_device(&devdef->class, devdef->name);
 228
 229     /* FIXME This require systematical rework! */
 230     // acpi_context* acpi_ctx = acpi_get_context();
 231     // if (acpi_ctx->fadt.header.rev > 1) {
 232     //     /*
 233     //      *
 234     //      只有当前ACPI版本大于1时，我们才使用FADT的IAPC_BOOT_ARCH去判断8042是否存在。
 235     //      *  这是一个坑，在ACPI v1中，这个字段是reserved！而这及至ACPI
 236     //      v2才出现。
 237     //      *  需要注意：Bochs 和 QEMU 使用的是ACPI v1，而非 v2
 238     //      * （virtualbox好像是v4）
 239     //      *
 240     //      *  (2022/6/29)
 241     //      *
 242     //      QEMU在7.0.0版本中，修复了FADT::IAPC_BOOT无法正确提供关于i8042的信息的bug
 243     //      *      https://wiki.qemu.org/ChangeLog/7.0#ACPI_.2F_SMBIOS
 244     //      *
 245     //      *
 246     //      请看Bochs的bios源码（QEMU的BIOS其实是照抄bochs的，所以也是一个德行。。）：
 247     //      *
 248     //      https://bochs.sourceforge.io/cgi-bin/lxr/source/bios/rombios32.c#L1314
 249     //      */
 250     //     if (!(acpi_ctx->fadt.boot_arch & IAPC_ARCH_8042)) {
 251     //         ERROR("not found\n");
 252     //         // FUTURE: Some alternative fallback on this? Check PCI bus for
 253     //         USB
 254     //         // controller instead?
 255     //         return;
 256     //     }
 257     // } else {
 258     //     WARN("outdated FADT used, assuming exists.\n");
 259     // }
 260
 261     char result;
 262
 263     // 1、禁用任何的PS/2设备
 264     ps2_post_cmd(PS2_PORT_CTRL_CMDREG, PS2_CMD_PORT1_DISABLE, PS2_NO_ARG);
 265     ps2_post_cmd(PS2_PORT_CTRL_CMDREG, PS2_CMD_PORT2_DISABLE, PS2_NO_ARG);
 266
 267     // 2、清空控制器缓冲区
 268     port_rdbyte(PS2_PORT_ENC_DATA);
 269
 270     // 3、屏蔽所有PS/2设备（端口1&2）IRQ，并且禁用键盘键码转换功能
 271     result = ps2_issue_cmd(PS2_CMD_READ_CFG, PS2_NO_ARG);
 272     result = result & ~(PS2_CFG_P1INT | PS2_CFG_P2INT);
 273     ps2_post_cmd(PS2_PORT_CTRL_CMDREG, PS2_CMD_WRITE_CFG, result);
 274
 275     // 4、控制器自检
 276     result = ps2_issue_cmd_wretry(PS2_CMD_SELFTEST, PS2_NO_ARG);
 277     if (result != PS2_RESULT_TEST_OK) {
 278         WARN("controller self-test failed. (%x)", result);
 279         goto done;
 280     }
 281
 282     // 5、设备自检（端口1自检，通常是我们的键盘）
 283     result = ps2_issue_cmd_wretry(PS2_CMD_SELFTEST_PORT1, PS2_NO_ARG);
 284     if (result != 0) {
 285         ERROR("interface test on port 1 failed. (%x)", result);
 286         goto done;
 287     }
 288
 289     ps2_post_cmd(PS2_PORT_CTRL_CMDREG, PS2_CMD_PORT2_DISABLE, PS2_NO_ARG);
 290
 291     // 6、开启位于端口1的 IRQ，并启用端口1。不用理会端口2，那儿一般是鼠标。
 292     ps2_post_cmd(PS2_PORT_CTRL_CMDREG, PS2_CMD_PORT1_ENABLE, PS2_NO_ARG);
 293     result = ps2_issue_cmd(PS2_CMD_READ_CFG, PS2_NO_ARG);
 294     // 重新设置配置字节，因为控制器自检有可能重置我们先前做的改动。
 295     result = (result | PS2_CFG_P1INT) & ~(PS2_CFG_TRANSLATION | PS2_CFG_P2INT);
 296     ps2_post_cmd(PS2_PORT_CTRL_CMDREG, PS2_CMD_WRITE_CFG, result);
 297
 298     // 至此，PS/2控制器和设备已完成初始化，可以正常使用。
 299
 300     /*
 301      *   一切准备就绪后，我们才教ioapic去启用IRQ#1。
 302      *   至于为什么要在这里，原因是：初始化所使用的一些指令可能会导致IRQ#1的触发（因为返回码），或者是一些什么
 303      *  情况导致IRQ#1的误触发（可能是未初始化导致IRQ#1线上不稳定）。于是这些IRQ#1会堆积在APIC的队列里（因为此时我们正在
 304      *  初始化8042，屏蔽了所有中断，IF=0）。
 305      *  当sti后，这些堆积的中断会紧跟着递送进CPU里，导致我们的键盘handler误认为由按键按下，从而将这个毫无意义的数值加入
 306      *  我们的队列中，以供上层读取。
 307      *
 308      *  所以，保险的方法是：在初始化后才去设置ioapic，这样一来我们就能有一个稳定的IRQ#1以放心使用。
 309      */
 310     isrm_bindirq(PC_AT_IRQ_KBD, intr_ps2_kbd_handler);
 311
 312     return 0;
 313
 314 done:
 315     return 1;
 316 }
 317
 318 static void
 319 ps2_process_cmd(void* arg)
 320 {
 321     /*
 322      * 检查锁是否已被启用，如果启用，则表明该timer中断发生时，某个指令正在入队。
 323      * 如果是这种情况则跳过，留到下一轮再尝试处理。
 324      * 注意，这里其实是ISR的一部分（timer中断），对于单核CPU来说，ISR等同于单个的原子操作。
 325      * （因为EFLAGS.IF=0，所有可屏蔽中断被屏蔽。对于NMI的情况，那么就直接算是triple
 326      * fault了，所以也没有讨论的意义）
 327      * 所以，假若我们遵从互斥锁的严格定义（即这里需要阻塞），那么中断将会被阻塞，进而造成死锁。
 328      * 因此，我们这里仅仅进行判断。
 329      * 会不会产生指令堆积？不会，因为指令发送的频率远远低于指令队列清空的频率。在目前，我们发送的唯一指令
 330      * 就只是用来开关键盘上的LED灯（如CAPSLOCK）。
 331      */
 332     if (mutex_on_hold(&cmd_q.mutex) || !cmd_q.queue_len) {
 333         return;
 334     }
 335
 336     // 处理队列排头的指令
 337     struct ps2_cmd* pending_cmd = &cmd_q.cmd_queue[cmd_q.queue_ptr];
 338     u8_t result;
 339     int attempts = 0;
 340
 341     // 尝试将命令发送至PS/2键盘（通过PS/2控制器）
 342     // 如果不成功（0x60 IO口返回 0xfe，即 NAK i.e. Resend）
 343     // 则尝试最多五次
 344     do {
 345         result = ps2_issue_dev_cmd(pending_cmd->cmd, pending_cmd->arg);
 346 #ifdef KBD_ENABLE_SPIRQ_FIX
 347         kbd_state.state += KBD_STATE_CMDPROCS;
 348 #endif
 349         attempts++;
 350     } while (result == PS2_RESULT_NAK && attempts < PS2_DEV_CMD_MAX_ATTEMPTS);
 351     // XXX: 是否需要处理不成功的指令？
 352
 353     cmd_q.queue_ptr = (cmd_q.queue_ptr + 1) % PS2_CMD_QUEUE_SIZE;
 354     cmd_q.queue_len--;
 355 }
 356
 357 static void
 358 kbd_buffer_key_event(kbd_keycode_t key, u8_t scancode, kbd_kstate_t state)
 359 {
 360     /*
 361         forgive me on these ugly bit-level tricks,
 362         I really hate doing branching on these "fliping switch" things
 363     */
 364     if (key == KEY_CAPSLK) {
 365         kbd_state.key_state ^= KBD_KEY_FCAPSLKED & -state;
 366     } else if (key == KEY_NUMSLK) {
 367         kbd_state.key_state ^= KBD_KEY_FNUMBLKED & -state;
 368     } else if (key == KEY_SCRLLK) {
 369         kbd_state.key_state ^= KBD_KEY_FSCRLLKED & -state;
 370     } else {
 371         if ((key & MODIFR)) {
 372             kbd_kstate_t tmp = (KBD_KEY_FLSHIFT_HELD << (key & 0x00ff));
 373             kbd_state.key_state = (kbd_state.key_state & ~tmp) | (tmp & -state);
 374         } else if (!(key & 0xff00) &&
 375                    (kbd_state.key_state &
 376                     (KBD_KEY_FLSHIFT_HELD | KBD_KEY_FRSHIFT_HELD))) {
 377             key = scancode_set2_shift[scancode];
 378         }
 379         state = state | kbd_state.key_state;
 380         key = key & (0xffdf |
 381                      -('a' > key || key > 'z' || !(state & KBD_KEY_FCAPSLKED)));
 382
 383         struct input_evt_pkt ipkt = { .pkt_type = (state & KBD_KEY_FPRESSED)
 384                                                     ? PKT_PRESS
 385                                                     : PKT_RELEASE,
 386                                       .scan_code = scancode,
 387                                       .sys_code = (state << 16) | key };
 388
 389         input_fire_event(kbd_idev, &ipkt);
 390
 391         return;
 392     }
 393
 394     if (state & KBD_KEY_FPRESSED) {
 395         // Ooops, this guy generates irq!
 396         ps2_device_post_cmd(PS2_KBD_CMD_SETLED,
 397                             (kbd_state.key_state >> 1) & 0x00ff);
 398     }
 399 }
 400
 401 static void
 402 intr_ps2_kbd_handler(const isr_param* param)
 403 {
 404
 405     // This is important! Don't believe me? try comment it out and run on Bochs!
 406     // while (!(port_rdbyte(PS2_PORT_CTRL_STATUS) & PS2_STATUS_OFULL))
 407     //    ;
 408
 409     // I know you are tempting to move this chunk after the keyboard state
 410     // check. But DO NOT. This chunk is in right place and right order. Moving
 411     // it at your own risk This is to ensure we've cleared the output buffer
 412     // everytime, so it won't pile up across irqs.
 413     u8_t scancode = port_rdbyte(PS2_PORT_ENC_DATA);
 414     kbd_keycode_t key;
 415
 416     /*
 417      *    判断键盘是否处在指令发送状态，防止误触发。（伪输入中断）
 418      * 这是因为我们需要向ps/2设备发送指令（比如控制led灯），而指令会有返回码。
 419      * 这就会有可能导致ps/2控制器在受到我们的命令后（在ps2_process_cmd中），
 420      * 产生IRQ#1中断（虽然说这种情况取决于底层BIOS实现，但还是会发生，比如QEMU和bochs）。
 421      * 所以这就是说，当IRQ#1中断产生时，我们的CPU正处在另一个ISR中。这样就会导致所有的外部中断被缓存在APIC内部的
 422      * FIFO队列里，进行排队等待（APIC长度为二的队列 {IRR, TMR}；参考 Intel
 423      * Manual Vol.3A 10.8.4）
 424      * 那么当ps2_process_cmd执行完后（内嵌在#APIC_TIMER_IV），CPU返回EOI给APIC，APIC紧接着将排在队里的IRQ#1发送给CPU
 425      * 造成误触发。也就是说，我们此时读入的scancode实则上是上一个指令的返回代码。
 426      *
 427      * Problem 1 (Fixed):
 428      *      但是这种方法有个问题，那就是，假若我们的某一个命令失败了一次，ps/2给出0xfe，我们重传，ps/2收到指令并给出0xfa。
 429      *  那么这样一来，将会由两个连续的IRQ#1产生。而APIC是最多可以缓存两个IRQ，于是我们就会漏掉一个IRQ，依然会误触发。
 430      * Solution:
 431      *      累加掩码 ;)
 432      *
 433      * Problem 2:
 434      *    +
 435      * 这种累加掩码的操作是基于只有一号IRQ产生的中断的假设，万一中间夹杂了别的中断？Race
 436      * Condition!
 437      *    +
 438      * 不很稳定x1，假如连续4次发送失败，那么就会导致累加的掩码上溢出，从而导致下述判断失败。
 439      */
 440 #ifdef KBD_ENABLE_SPIRQ_FIX
 441     if ((kbd_state.state & 0xc0)) {
 442         kbd_state.state -= KBD_STATE_CMDPROCS;
 443
 444         return;
 445     }
 446 #endif
 447
 448 #ifdef KBD_ENABLE_SPIRQ_FIX2
 449     if (scancode == PS2_RESULT_ACK || scancode == PS2_RESULT_NAK) {
 450         ps2_process_cmd(NULL);
 451         return;
 452     }
 453 #endif
 454
 455 #ifdef KBD_DBGLOG
 456     DEBUG("%x\n", scancode & 0xff);
 457 #endif
 458
 459     switch (kbd_state.state) {
 460         case KBD_STATE_KWAIT:
 461             if (scancode == 0xf0) { // release code
 462                 kbd_state.state = KBD_STATE_KRELEASED;
 463             } else if (scancode == 0xe0) {
 464                 kbd_state.state = KBD_STATE_KSPECIAL;
 465                 kbd_state.translation_table = scancode_set2_ex;
 466             } else {
 467                 key = kbd_state.translation_table[scancode];
 468                 kbd_buffer_key_event(key, scancode, KBD_KEY_FPRESSED);
 469             }
 470             break;
 471         case KBD_STATE_KSPECIAL:
 472             if (scancode == 0x12) {
 473                 kbd_state.state = KBD_STATE_E012;
 474             } else if (scancode == 0xf0) { // release code
 475                 kbd_state.state = KBD_STATE_KRELEASED_E0;
 476             } else {
 477                 key = kbd_state.translation_table[scancode];
 478                 kbd_buffer_key_event(key, scancode, KBD_KEY_FPRESSED);
 479
 480                 kbd_state.state = KBD_STATE_KWAIT;
 481                 kbd_state.translation_table = scancode_set2;
 482             }
 483             break;
 484         // handle the '0xE0, 0x12, 0xE0, xx' sequence
 485         case KBD_STATE_E012:
 486             if (scancode == 0xe0) {
 487                 kbd_state.state = KBD_STATE_KSPECIAL;
 488                 kbd_state.translation_table = scancode_set2_ex;
 489             }
 490             break;
 491         case KBD_STATE_KRELEASED_E0:
 492             if (scancode == 0x12) {
 493                 goto escape_release;
 494             }
 495             // fall through
 496         case KBD_STATE_KRELEASED:
 497             key = kbd_state.translation_table[scancode];
 498             kbd_buffer_key_event(key, scancode, KBD_KEY_FRELEASED);
 499
 500         escape_release:
 501             // reset the translation table to scancode_set2
 502             kbd_state.state = KBD_STATE_KWAIT;
 503             kbd_state.translation_table = scancode_set2;
 504             break;
 505
 506         default:
 507             break;
 508     }
 509 }
 510
 511 static u8_t
 512 ps2_issue_cmd(char cmd, u16_t arg)
 513 {
 514     ps2_post_cmd(PS2_PORT_CTRL_CMDREG, cmd, arg);
 515
 516     // 等待PS/2控制器返回。通过轮询（polling）状态寄存器的 bit 0
 517     // 如置位，则表明返回代码此时就在 0x60 IO口上等待读取。
 518     while (!(port_rdbyte(PS2_PORT_CTRL_STATUS) & PS2_STATUS_OFULL))
 519         ;
 520
 521     return port_rdbyte(PS2_PORT_ENC_CMDREG);
 522 }
 523
 524 static u8_t
 525 ps2_issue_cmd_wretry(char cmd, u16_t arg)
 526 {
 527     u8_t r, c = 0;
 528     while ((r = ps2_issue_cmd(cmd, arg)) == PS2_RESULT_NAK && c < 5) {
 529         c++;
 530     }
 531     if (c >= 5) {
 532         WARN("max attempt reached.");
 533     }
 534     return r;
 535 }
 536
 537 static void
 538 ps2_post_cmd(u8_t port, char cmd, u16_t arg)
 539 {
 540     // 等待PS/2输入缓冲区清空，这样我们才可以写入命令
 541     while (port_rdbyte(PS2_PORT_CTRL_STATUS) & PS2_STATUS_IFULL)
 542         ;
 543
 544     port_wrbyte(port, cmd);
 545     port_delay(PS2_DELAY);
 546
 547     if (!(arg & PS2_NO_ARG)) {
 548         // 所有参数一律通过0x60传入。
 549         while (port_rdbyte(PS2_PORT_CTRL_STATUS) & PS2_STATUS_IFULL)
 550             ;
 551         port_wrbyte(PS2_PORT_ENC_CMDREG, (u8_t)(arg & 0x00ff));
 552         port_delay(PS2_DELAY);
 553     }
 554 }
 555
 556 static u8_t
 557 ps2_issue_dev_cmd(char cmd, u16_t arg)
 558 {
 559     ps2_post_cmd(PS2_PORT_ENC_CMDREG, cmd, arg);
 560
 561     // 等待PS/2控制器返回。通过轮询（polling）状态寄存器的 bit 0
 562     // 如置位，则表明返回代码此时就在 0x60 IO口上等待读取。
 563     while (!(port_rdbyte(PS2_PORT_CTRL_STATUS) & PS2_STATUS_OFULL))
 564         ;
 565
 566     return port_rdbyte(PS2_PORT_ENC_CMDREG);
 567 }
 568
 569 static struct device_def devrtc_i8042kbd = {
 570     .name = "i8042 Keyboard",
 571     .class = DEVCLASS(DEVIF_SOC, DEVFN_INPUT, DEV_KBD),
 572     .init = ps2_kbd_init
 573 };
 574 EXPORT_DEVICE(i8042_kbd, &devrtc_i8042kbd, load_onboot);