a63ffdc5690b97c3fe71937cfe9f4e4dc9a7570f
[lunaix-os.git] / lunaix-os / includes / lunaix / peripheral / ps2kbd.h
1 #ifndef __LUNAIX_PS2KBD_H
2 #define __LUNAIX_PS2KBD_H
3
4 #include <hal/io.h>
5 #include <lunaix/keyboard.h>
6
7 #define PS2_PORT_ENC_DATA 0x60
8 #define PS2_PORT_ENC_CMDREG 0x60
9 #define PS2_PORT_CTRL_STATUS 0x64
10 #define PS2_PORT_CTRL_CMDREG 0x64
11
12 #define PS2_STATUS_OFULL   0x1
13 #define PS2_STATUS_IFULL   0x2
14
15 #define PS2_RESULT_ACK  0xfa
16 #define PS2_RESULT_NAK  0xfe    //resend
17 #define PS2_RESULT_ECHO 0xee    
18 #define PS2_RESULT_TEST_OK 0x55    
19
20 // PS/2 keyboard device related commands
21 #define PS2_KBD_CMD_SETLED  0xed
22 #define PS2_KBD_CMD_ECHO  0xee
23 #define PS2_KBD_CMD_SCANCODE_SET  0xf0
24 #define PS2_KBD_CMD_IDENTIFY  0xf2
25 #define PS2_KBD_CMD_SCAN_ENABLE  0xf4
26 #define PS2_KBD_CMD_SCAN_DISABLE  0xf5
27
28 // PS/2 *controller* related commands
29 #define PS2_CMD_PORT1_DISABLE  0xad
30 #define PS2_CMD_PORT1_ENABLE  0xae
31 #define PS2_CMD_PORT2_DISABLE  0xa7
32 #define PS2_CMD_PORT2_ENABLE  0xa8
33 #define PS2_CMD_SELFTEST      0xaa
34 #define PS2_CMD_SELFTEST_PORT1      0xab
35
36 #define PS2_CMD_READ_CFG       0x20
37 #define PS2_CMD_WRITE_CFG       0x60
38
39 #define PS2_CFG_P1INT             0x1
40 #define PS2_CFG_P2INT             0x2
41 #define PS2_CFG_TRANSLATION       0x40
42
43 #define PS2_DELAY       1000
44
45 #define PS2_CMD_QUEUE_SIZE 8
46 #define PS2_KBD_RECV_BUFFER_SIZE 8
47
48 #define PS2_NO_ARG 0xff00
49
50
51 struct ps2_cmd {
52     char cmd;
53     char arg;
54 };
55
56 struct ps2_kbd_state {
57     char state;
58     volatile char masked;
59     kbd_keycode_t* translation_table;
60     kbd_kstate_t key_state;
61 };
62
63 struct ps2_cmd_queue {
64     struct ps2_cmd cmd_queue[PS2_CMD_QUEUE_SIZE];
65     int queue_ptr;
66     int queue_len;
67     // FIXME: replace lock with something specialized.
68     volatile char lock;
69 };
70
71 struct ps2_key_buffer {
72     struct kdb_keyinfo_pkt buffer[PS2_KBD_RECV_BUFFER_SIZE];
73     int read_ptr;
74     int buffered_len;
75     // FIXME: replace lock with something specialized.
76     volatile char lock;
77 };
78
79 /**
80  * @brief 向PS/2控制器的控制端口(0x64)发送指令并等待返回代码。
81  * 注意,对于没有返回代码的命令请使用`ps2_post_cmd`,否则会造成死锁。
82  * 通过调用该方法向控制器发送指令,请区别 ps2_issue_dev_cmd
83  * 
84  * @param cmd 
85  * @param args
86  */
87 static uint8_t ps2_issue_cmd(char cmd, uint16_t arg);
88
89 /**
90  * @brief 向PS/2控制器的编码器端口(0x60)发送指令并等待返回代码。
91  * 注意,对于没有返回代码的命令请使用`ps2_post_cmd`,否则会造成死锁。
92  * 通过调用该方法向PS/2设备发送指令,请区别 ps2_issue_cmd
93  * 
94  * @param cmd 
95  * @param args
96  */
97 static uint8_t ps2_issue_dev_cmd(char cmd, uint16_t arg);
98
99 /**
100  * @brief 向PS/2控制器发送指令,不等待返回代码。
101  * 
102  * @param port 端口号
103  * @param cmd 
104  * @param args 
105  * @return char 
106  */
107 static void ps2_post_cmd(uint8_t port, char cmd, uint16_t arg);
108
109 void ps2_device_post_cmd(char cmd, char arg);
110
111 void ps2_kbd_init();
112
113 void ps2_process_cmd(void* arg);
114
115
116
117
118 #endif /* __LUNAIX_PS2KBD_H */