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