lunaix-os/arch/x86/hal/ps2kbd.c

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