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 <hal/ioapic.h>
   9
  10 #include <arch/x86/interrupts.h>
  11 #include <stdint.h>
  12 #include <klibc/string.h>
  13
  14 #define PS2_DEV_CMD_MAX_ATTEMPTS 5
  15
  16 LOG_MODULE("PS2KBD");
  17
  18 static struct ps2_cmd_queue cmd_q;
  19 static struct ps2_key_buffer key_buf;
  20 static struct ps2_kbd_state kbd_state;
  21
  22 #define KEY_NUM(x)      (x + 0x30)
  23 #define KEY_NPAD(x)      ON_KEYPAD(KEY_NUM(x))
  24
  25 // 我们使用 Scancode Set 2
  26
  27 // 大部分的扫描码（键码）
  28 static kbd_keycode scancode_set2[] = {
  29     0, KEY_F9, 0, KEY_F5, KEY_F3, KEY_F1, KEY_F2, KEY_F12, 0, KEY_F10, KEY_F8, KEY_F6,
  30     KEY_F4, KEY_HTAB, '`', 0, 0, KEY_LALT, KEY_LSHIFT, 0, KEY_LCTRL, 'q', KEY_NUM(1),
  31     0, 0, 0, 'z', 's', 'a', 'w', KEY_NUM(2), 0, 0, 'c', 'x', 'd', 'e', KEY_NUM(4), KEY_NUM(3),
  32     0, 0, KEY_SPACE, 'v', 'f', 't', 'r', KEY_NUM(5),
  33     0, 0, 'n', 'b', 'h', 'g', 'y', KEY_NUM(6), 0, 0, 0, 'm', 'j', 'u', KEY_NUM(7), KEY_NUM(8),
  34     0, 0, ',', 'k', 'i', 'o', KEY_NUM(0), KEY_NUM(9), 0, 0, '.', '/', 'l', ';', 'p', '-', 0, 0,
  35     0, '\'', 0, '[', '=', 0, 0, KEY_CAPSLK, KEY_RSHIFT, KEY_LF, ']', 0, '\\', 0, 0, 0, 0, 0, 0, 0,
  36     0, KEY_BS, 0, 0, KEY_NPAD(1), 0, KEY_NPAD(4), KEY_NPAD(7), 0, 0, 0, KEY_NPAD(0), ON_KEYPAD('.'),
  37     KEY_NPAD(2), KEY_NPAD(5), KEY_NPAD(6), KEY_NPAD(8), KEY_ESC, KEY_NUMSLK, KEY_F11, ON_KEYPAD('+'),
  38     KEY_NPAD(3), ON_KEYPAD('-'), ON_KEYPAD('*'), KEY_NPAD(9), KEY_SCRLLK, 0, 0, 0, 0, KEY_F7
  39 };
  40
  41 // 一些特殊的键码（以 0xe0 位前缀的）
  42 static kbd_keycode scancode_set2_ex[] = {
  43     0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, KEY_RALT, 0, 0,
  44     KEY_RCTRL, 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, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
  46     0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, ON_KEYPAD('/'), 0, 0, 0, 0, 0, 0, 0, 0,
  47     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,
  48     KEY_END, 0, KEY_LEFT, KEY_HOME,
  49     0, 0, 0, KEY_INSERT, KEY_DELETE, KEY_DOWN, 0, KEY_RIGHT, KEY_UP, 0, 0,
  50     0, 0, KEY_PG_DOWN, 0, 0, KEY_PG_UP
  51 };
  52
  53 // 用于处理 Shift+<key> 的情况
  54 static kbd_keycode scancode_set2_shift[] = {
  55     0, KEY_F9, 0, KEY_F5, KEY_F3, KEY_F1, KEY_F2, KEY_F12, 0, KEY_F10, KEY_F8, KEY_F6,
  56     KEY_F4, KEY_HTAB, '~', 0, 0, KEY_LALT, KEY_LSHIFT, 0, KEY_LCTRL, 'Q', '!',
  57     0, 0, 0, 'Z', 'S', 'A', 'W', '@', 0, 0, 'C', 'X', 'D', 'E', '$', '#',
  58     0, 0, KEY_SPACE, 'V', 'F', 'T', 'R', '%',
  59     0, 0, 'N', 'B', 'H', 'G', 'Y', '^', 0, 0, 0, 'M', 'J', 'U', '&', '*',
  60     0, 0, '<', 'K', 'I', 'O', ')', '(', 0, 0, '>', '？', 'L', ':', 'P', '_', 0, 0,
  61     0, '"', '{', '+', 0, 0, KEY_CAPSLK, KEY_RSHIFT, KEY_LF, '}', 0, '|', 0, 0, 0, 0, 0, 0, 0,
  62     0, KEY_BS, 0, 0, KEY_NPAD(1), 0, KEY_NPAD(4), KEY_NPAD(7), 0, 0, 0, KEY_NPAD(0), ON_KEYPAD('.'),
  63     KEY_NPAD(2), KEY_NPAD(5), KEY_NPAD(6), KEY_NPAD(8), KEY_ESC, KEY_NUMSLK, KEY_F11, ON_KEYPAD('+'),
  64     KEY_NPAD(3), ON_KEYPAD('-'), ON_KEYPAD('*'), KEY_SCRLLK, 0, 0, 0, 0, KEY_F7
  65 };
  66
  67
  68 #define KBD_STATE_WAIT_KEY 0
  69 #define KBD_STATE_SPECIAL 1
  70 #define KBD_STATE_RELEASED 2
  71
  72 void intr_ps2_kbd_handler(const isr_param* param);
  73
  74 void ps2_device_post_cmd(char cmd, char arg) {
  75     // FIXME: Need a mutex lock on this.
  76     int index = (cmd_q.queue_ptr + cmd_q.queue_len) % PS2_CMD_QUEUE_SIZE;
  77     int diff = index - cmd_q.queue_ptr;
  78     if (diff > 0 && diff != cmd_q.queue_len) {
  79         // 队列已满！
  80         return;
  81     }
  82
  83     struct ps2_cmd *container = &cmd_q.cmd_queue[index];
  84     container->cmd = cmd;
  85     container->arg = arg;
  86     cmd_q.queue_len++;
  87 }
  88
  89 void ps2_kbd_init() {
  90
  91     memset(&cmd_q, 0, sizeof(cmd_q));
  92     memset(&key_buf, 0, sizeof(key_buf));
  93     memset(&kbd_state, 0, sizeof(kbd_state));
  94     kbd_state.translation_table = scancode_set2;
  95     kbd_state.state = KBD_STATE_WAIT_KEY;
  96
  97     cpu_disable_interrupt();
  98
  99     // XXX: 是否需要使用FADT探测PS/2控制器的存在？
 100
 101     // 1、禁用任何的PS/2设备
 102     ps2_post_cmd(PS2_CMD_PORT1_DISABLE, PS2_NO_ARG);
 103     ps2_post_cmd(PS2_CMD_PORT2_DISABLE, PS2_NO_ARG);
 104
 105     // 2、清空控制器缓冲区
 106     io_inb(PS2_PORT_DATA);
 107
 108     char result;
 109
 110     // 3、屏蔽所有PS/2设备（端口1&2）IRQ，并且禁用键盘键码转换功能
 111     result = ps2_issue_cmd(PS2_CMD_READ_CFG, PS2_NO_ARG);
 112     result = result & ~(PS2_CFG_P1INT | PS2_CFG_P2INT | PS2_CFG_TRANSLATION);
 113     ps2_post_cmd(PS2_CMD_WRITE_CFG, result);
 114
 115     // 4、控制器自检
 116     result = ps2_issue_cmd(PS2_CMD_SELFTEST, PS2_NO_ARG);
 117     if (result != PS2_RESULT_TEST_OK) {
 118         kprintf(KERROR "Controller self-test failed.");
 119         goto done;
 120     }
 121
 122     // 5、设备自检（端口1自检，通常是我们的键盘）
 123     result = ps2_issue_cmd(PS2_CMD_SELFTEST_PORT1, PS2_NO_ARG);
 124     if (result != 0) {
 125         kprintf(KERROR "Interface test on port 1 failed.");
 126         goto done;
 127     }
 128
 129     // 6、开启位于端口1的 IRQ，并启用端口1。不用理会端口2，那儿一般是鼠标。
 130     ps2_post_cmd(PS2_CMD_PORT1_ENABLE, PS2_NO_ARG);
 131     result = ps2_issue_cmd(PS2_CMD_READ_CFG, PS2_NO_ARG);
 132     result = result | PS2_CFG_P1INT;
 133     ps2_post_cmd(PS2_CMD_WRITE_CFG, result);
 134
 135     // 至此，PS/2控制器和设备已完成初始化，可以正常使用。
 136
 137     // 将我们的键盘驱动挂载到第204号中断上（已由IOAPIC映射至IRQ#1），
 138     intr_subscribe(PC_KBD_IV, intr_ps2_kbd_handler);
 139
 140     // 搞一个计时器，将我们的 ps2_process_cmd 挂上去。每隔5毫秒执行排在队头的命令。
 141     //  为什么只执行队头的命令，而不是全部的命令？
 142     //      因为我们需要保证isr尽量的简短，运行起来快速。而发送这些命令非常的耗时。
 143     timer_run_ms(5, ps2_process_cmd, NULL, TIMER_MODE_PERIODIC);
 144
 145 done:
 146     cpu_enable_interrupt();
 147 }
 148
 149 void ps2_process_cmd(void* arg) {
 150     // FIXME: Need a mutex lock on this.
 151     // if lock is hold by other, then it just simply return (not wait! as we are in isr).
 152     if (!cmd_q.queue_len) {
 153         return;
 154     }
 155
 156     // 处理队列排头的指令
 157     struct ps2_cmd *pending_cmd = &cmd_q.cmd_queue[cmd_q.queue_ptr];
 158     char result;
 159     int attempts = 0;
 160
 161     // 尝试将命令发送至PS/2键盘（通过PS/2控制器）
 162     // 如果不成功（0x60 IO口返回 0xfe，即 NAK 或 Resend）
 163     // 则尝试最多五次
 164     do {
 165         result = ps2_issue_cmd(pending_cmd->cmd, pending_cmd->arg);
 166         attempts++;
 167     } while(result == PS2_RESULT_NAK && attempts < PS2_DEV_CMD_MAX_ATTEMPTS);
 168
 169     // TODO: 是否需要处理不成功的指令？
 170
 171     cmd_q.queue_ptr = (cmd_q.queue_ptr + 1) % PS2_CMD_QUEUE_SIZE;
 172     cmd_q.queue_len--;
 173 }
 174
 175 void kbd_buffer_key_event(kbd_keycode key, uint8_t scancode, kbd_kstate_t state) {
 176     if (key == KEY_CAPSLK) {
 177         kbd_state.key_state = kbd_state.key_state ^ (KBD_KEY_CAPSLKED & -state);
 178     } else if (key == KEY_NUMSLK) {
 179         kbd_state.key_state = kbd_state.key_state ^ (KBD_KEY_NUMBLKED & -state);
 180     } else if (key == KEY_SCRLLK) {
 181         kbd_state.key_state = kbd_state.key_state ^ (KBD_KEY_SCRLLKED & -state);
 182     } else {
 183         state = state | kbd_state.key_state;
 184         time_t timestamp = clock_systime();
 185         // TODO: Construct the packet.
 186         kprintf(KDEBUG "%c (t=%d, s=%x, c=%d)\n", key & 0x00ff, timestamp, state, (key & 0xff00) >> 8);
 187         return; // do not delete this return
 188     }
 189
 190     ps2_device_post_cmd(PS2_KBD_CMD_SETLED, kbd_state.key_state >> 1);
 191 }
 192
 193 void intr_ps2_kbd_handler(const isr_param* param) {
 194     uint8_t scancode = io_inb(PS2_PORT_DATA) & 0xff;
 195     kbd_keycode key;
 196
 197     kprintf(KINFO "%x\n", scancode & 0xff);
 198
 199     // FIXME: 实现 Shift+<key>
 200     switch (kbd_state.state)
 201     {
 202     case KBD_STATE_WAIT_KEY:
 203         if (scancode == 0xf0) { // release code
 204             kbd_state.state = KBD_STATE_RELEASED;
 205         } else if (scancode == 0xe0) {
 206             kbd_state.state = KBD_STATE_SPECIAL;
 207             kbd_state.translation_table = scancode_set2_ex;
 208         } else {
 209             key = kbd_state.translation_table[scancode];
 210             kbd_buffer_key_event(key, scancode, KBD_KEY_PRESSED);
 211         }
 212         break;
 213     case KBD_STATE_SPECIAL:
 214         if (scancode == 0xf0) { //release code
 215             kbd_state.state = KBD_STATE_RELEASED;
 216         } else {
 217             key = kbd_state.translation_table[scancode];
 218             kbd_buffer_key_event(key, scancode, KBD_KEY_PRESSED);
 219
 220             kbd_state.state = KBD_STATE_WAIT_KEY;
 221             kbd_state.translation_table = scancode_set2;
 222         }
 223         break;
 224     case KBD_STATE_RELEASED:
 225         key = kbd_state.translation_table[scancode];
 226         kbd_buffer_key_event(key, scancode, KBD_KEY_RELEASED);
 227
 228         // reset the translation table to scancode_set2
 229         kbd_state.translation_table = scancode_set2;
 230         kbd_state.state = KBD_STATE_WAIT_KEY;
 231         break;
 232
 233     default:
 234         break;
 235     }
 236 }
 237
 238 static uint8_t ps2_issue_cmd(char cmd, uint16_t arg) {
 239     ps2_post_cmd(cmd, arg);
 240
 241     char result;
 242
 243     // 等待PS/2控制器返回。通过轮询（polling）状态寄存器的 bit 0
 244     // 如置位，则表明返回代码此时就在 0x60 IO口上等待读取。
 245     while(!((result = io_inb(PS2_PORT_STATUS)) & PS2_STATUS_OFULL));
 246
 247     return io_inb(PS2_PORT_DATA);
 248 }
 249
 250 static void ps2_post_cmd(char cmd, uint16_t arg) {
 251     char result;
 252     // 等待PS/2输入缓冲区清空，这样我们才可以写入命令
 253     while((result = io_inb(PS2_PORT_STATUS)) & PS2_STATUS_IFULL);
 254
 255     io_outb(PS2_PORT_CMDREG, cmd);
 256     if (!(arg & PS2_NO_ARG)) {
 257         io_outb(PS2_PORT_DATA, (uint8_t)(arg & 0x00ff));
 258     }
 259 }