pico hid: better ps2x2pico integration (#149) (#151)

Co-authored-by: No0ne <[email protected]>

7 files changed, 74 insertions, 386 deletions

diff --git a/hid/pico/CMakeLists.txt b/hid/pico/CMakeLists.txt
index 819a5300..0523da09 100644
--- a/hid/pico/CMakeLists.txt
+++ b/hid/pico/CMakeLists.txt
@@ -2,7 +2,7 @@ cmake_minimum_required(VERSION 3.13)
 
 set(PICO_SDK_PATH ${CMAKE_CURRENT_LIST_DIR}/.pico-sdk)
 set(PICO_TINYUSB_PATH ${CMAKE_CURRENT_LIST_DIR}/.tinyusb)
-SET(PS2_PATH ${CMAKE_CURRENT_LIST_DIR}/.ps2x2pico)
+set(PS2_PATH ${CMAKE_CURRENT_LIST_DIR}/.ps2x2pico)
 
 # For TinyUSB
 set(FAMILY rp2040)
diff --git a/hid/pico/Makefile b/hid/pico/Makefile
index 7baca263..76ff2149 100644
--- a/hid/pico/Makefile
+++ b/hid/pico/Makefile
@@ -31,7 +31,7 @@ endef
 .tinyusb:
 	$(call libdep,tinyusb,hathach/tinyusb,d713571cd44f05d2fc72efc09c670787b74106e0)
 .ps2x2pico:
-	$(call libdep,ps2x2pico,No0ne/ps2x2pico,706b5c34cb6a2fcefeb7f1ee0f673c7de9452fc6)
+	$(call libdep,ps2x2pico,No0ne/ps2x2pico,d95332b4ea11cad4a11da070857e613c80f9b935)
 deps: .pico-sdk .tinyusb .ps2x2pico
 
 
diff --git a/hid/pico/src/CMakeLists.txt b/hid/pico/src/CMakeLists.txt
index facab804..904e7b7f 100644
--- a/hid/pico/src/CMakeLists.txt
+++ b/hid/pico/src/CMakeLists.txt
@@ -8,8 +8,6 @@ target_sources(${target_name} PRIVATE
 	ph_usb_kbd.c
 	ph_usb_mouse.c
 	ph_ps2.c
-	ph_ps2_kbd.c
-	ph_ps2_mouse.c
 	ph_cmds.c
 	ph_com.c
 	ph_com_bridge.c
@@ -18,6 +16,8 @@ target_sources(${target_name} PRIVATE
 	ph_debug.c
 
 	${PS2_PATH}/ps2phy.c
+	${PS2_PATH}/ps2kb.c
+	${PS2_PATH}/ps2ms.c
 )
 target_link_options(${target_name} PRIVATE -Xlinker --print-memory-usage)
 target_compile_options(${target_name} PRIVATE -Wall -Wextra)
diff --git a/hid/pico/src/ph_ps2.c b/hid/pico/src/ph_ps2.c
index a814103c..6dab2eb6 100644
--- a/hid/pico/src/ph_ps2.c
+++ b/hid/pico/src/ph_ps2.c
@@ -37,6 +37,12 @@ u8 ph_g_ps2_kbd_leds = 0;
 bool ph_g_ps2_kbd_online = 0;
 bool ph_g_ps2_mouse_online = 0;
 
+u8 ph_ps2_kbd_modifiers = 0;
+u8 ph_ps2_mouse_buttons = 0;
+
+void tuh_kb_set_leds(u8 leds) {
+	ph_g_ps2_kbd_leds = leds;
+}
 
 void ph_ps2_init(void) {
 	if (PH_O_HAS_PS2) {
@@ -51,13 +57,13 @@ void ph_ps2_init(void) {
 	}
 
 	if (PH_O_IS_KBD_PS2) {
-		ph_ps2_kbd_init(_KBD_DATA_PIN);
+		kb_init(_KBD_DATA_PIN);
 	} else {
 		INIT_STUB(_KBD_DATA_PIN);
 	}
 
 	if (PH_O_IS_MOUSE_PS2) {
-		ph_ps2_mouse_init(_MOUSE_DATA_PIN);
+		ms_init(_MOUSE_DATA_PIN);
 	} else {
 		INIT_STUB(_MOUSE_DATA_PIN);
 	}
@@ -67,16 +73,66 @@ void ph_ps2_init(void) {
 
 void ph_ps2_task(void) {
 	if (PH_O_IS_KBD_PS2) {
-		ph_ps2_kbd_task();
+		ph_g_ps2_kbd_online = kb_task();
+	}
+
+	if (PH_O_IS_MOUSE_PS2) {
+		ph_g_ps2_mouse_online = ms_task();
+	}
+}
+
+void ph_ps2_kbd_send_key(u8 key, bool state) {
+	if (PH_O_IS_KBD_PS2) {
+		if (key >= 0xe0 && key <= 0xe7) {
+			if (state) {
+				ph_ps2_kbd_modifiers = ph_ps2_kbd_modifiers | (1 << (key - 0xe0));
+			} else {
+				ph_ps2_kbd_modifiers = ph_ps2_kbd_modifiers & ~(1 << (key - 0xe0));
+			}
+		}
+
+		kb_send_key(key, state, ph_ps2_kbd_modifiers);
+	}
+}
+
+void ph_ps2_mouse_send_button(u8 button, bool state) {
+	if (PH_O_IS_MOUSE_PS2) {
+		button--;
+
+		if (state) {
+			ph_ps2_mouse_buttons = ph_ps2_mouse_buttons | (1 << button);
+		} else {
+			ph_ps2_mouse_buttons = ph_ps2_mouse_buttons & ~(1 << button);
+		}
+
+		ms_send_packet(ph_ps2_mouse_buttons, 0, 0, 0, 0);
 	}
+}
+
+void ph_ps2_mouse_send_rel(s8 x, s8 y) {
+	if (PH_O_IS_MOUSE_PS2) {
+		ms_send_packet(ph_ps2_mouse_buttons, x, y, 0, 0);
+	}
+}
 
+void ph_ps2_mouse_send_wheel(s8 h, s8 v) {
 	if (PH_O_IS_MOUSE_PS2) {
-		ph_ps2_mouse_task();
+		ms_send_packet(ph_ps2_mouse_buttons, 0, 0, h, v);
 	}
 }
 
 void ph_ps2_send_clear(void) {
-	// TODO: PS2: Release all pressed buttons and keys.
-	// If PH_O_IS_KBD_PS2, release all PS/2 buttons
-	// also if PH_O_IS_MOUSE_PS2 is true, release all mouse buttons
+	if (PH_O_IS_KBD_PS2) {
+		for(u8 key = 0xe0; key <= 0xe7; key++) {
+			kb_send_key(key, false, 0);
+		}
+
+		for(u8 key = 4; key <= 116; key++) {
+			kb_send_key(key, false, 0);
+		}
+	}
+
+	if (PH_O_IS_MOUSE_PS2) {
+		ms_send_packet(0, 0, 0, 0, 0);
+	}
 }
diff --git a/hid/pico/src/ph_ps2.h b/hid/pico/src/ph_ps2.h
index 6766cbf9..1050b919 100644
--- a/hid/pico/src/ph_ps2.h
+++ b/hid/pico/src/ph_ps2.h
@@ -33,12 +33,15 @@ extern bool ph_g_ps2_mouse_online;
 void ph_ps2_init(void);
 void ph_ps2_task(void);
 
-void ph_ps2_kbd_init(u8 gpio);
-void ph_ps2_kbd_task(void);
+void tuh_kb_set_leds(u8 leds);
+void kb_init(u8 gpio);
+bool kb_task();
+void kb_send_key(u8 key, bool state, u8 modifiers);
 void ph_ps2_kbd_send_key(u8 key, bool state);
 
-void ph_ps2_mouse_init(u8 gpio);
-void ph_ps2_mouse_task(void);
+void ms_init(u8 gpio);
+bool ms_task();
+void ms_send_packet(u8 buttons, s8 x, s8 y, s8 h, s8 v);
 void ph_ps2_mouse_send_button(u8 button, bool state);
 void ph_ps2_mouse_send_rel(s8 x, s8 y);
 void ph_ps2_mouse_send_wheel(s8 h, s8 v);
diff --git a/hid/pico/src/ph_ps2_kbd.c b/hid/pico/src/ph_ps2_kbd.c
deleted file mode 100644
index 02229e96..00000000
--- a/hid/pico/src/ph_ps2_kbd.c
+++ /dev/null
@@ -1,223 +0,0 @@
-#include "ps2phy.h"
-
-#include "ph_outputs.h"
-
-extern u8 ph_g_ps2_kbd_leds;
-extern bool ph_g_ps2_kbd_online;
-
-ps2phy ph_ps2_kbd;
-bool ph_ps2_kbd_scanning;
-u32 ph_ps2_kbd_repeat_us;
-u16 ph_ps2_kbd_delay_ms;
-u8 ph_ps2_kbd_repeat = 0;
-bool ph_ps2_kbd_repeatmod = false;
-alarm_id_t ph_ps2_kbd_repeater;
-s8 ph_ps2_is_ctrl = 0;
-
-u8 const ph_ps2_led2ps2[] = { 0, 4, 1, 5, 2, 6, 3, 7 };
-u8 const ph_ps2_mod2ps2[] = { 0x14, 0x12, 0x11, 0x1f, 0x14, 0x59, 0x11, 0x27 };
-u8 const ph_ps2_hid2ps2[] = {
-  0x00, 0x00, 0xfc, 0x00, 0x1c, 0x32, 0x21, 0x23, 0x24, 0x2b, 0x34, 0x33, 0x43, 0x3b, 0x42, 0x4b,
-  0x3a, 0x31, 0x44, 0x4d, 0x15, 0x2d, 0x1b, 0x2c, 0x3c, 0x2a, 0x1d, 0x22, 0x35, 0x1a, 0x16, 0x1e,
-  0x26, 0x25, 0x2e, 0x36, 0x3d, 0x3e, 0x46, 0x45, 0x5a, 0x76, 0x66, 0x0d, 0x29, 0x4e, 0x55, 0x54,
-  0x5b, 0x5d, 0x5d, 0x4c, 0x52, 0x0e, 0x41, 0x49, 0x4a, 0x58, 0x05, 0x06, 0x04, 0x0c, 0x03, 0x0b,
-  0x83, 0x0a, 0x01, 0x09, 0x78, 0x07, 0x7c, 0x7e, 0x7e, 0x70, 0x6c, 0x7d, 0x71, 0x69, 0x7a, 0x74,
-  0x6b, 0x72, 0x75, 0x77, 0x4a, 0x7c, 0x7b, 0x79, 0x5a, 0x69, 0x72, 0x7a, 0x6b, 0x73, 0x74, 0x6c,
-  0x75, 0x7d, 0x70, 0x71, 0x61, 0x2f, 0x37, 0x0f, 0x08, 0x10, 0x18, 0x20, 0x28, 0x30, 0x38, 0x40,
-  0x48, 0x50, 0x57, 0x5f
-};
-u8 const ph_ps2_maparray = sizeof(ph_ps2_hid2ps2);
-u32 const ph_ps2_repeats[] = {
-  33333, 37453, 41667, 45872, 48309, 54054, 58480, 62500,
-  66667, 75188, 83333, 91743, 100000, 108696, 116279, 125000,
-  133333, 149254, 166667, 181818, 200000, 217391, 232558, 250000,
-  270270, 303030, 333333, 370370, 400000, 434783, 476190, 500000
-};
-u16 const ph_ps2_delays[] = { 250, 500, 750, 1000 };
-
-void ph_ps2_kbd_send(u8 byte) {
-  queue_try_add(&ph_ps2_kbd.qbytes, &byte);
-}
-
-void ph_ps2_kbd_maybe_send_e0(u8 byte) {
-  if (byte == 0x46 ||
-     (byte >= 0x49 && byte <= 0x52) ||
-      byte == 0x54 || byte == 0x58 ||
-      byte == 0x65 || byte == 0x66 ||
-      byte >= 0x81) {
-    ph_ps2_kbd_send(0xe0);
-  }
-}
-
-int64_t ph_ps2_repeat_callback() {
-  if (ph_ps2_kbd_repeat) {
-    if (ph_ps2_kbd_repeatmod) {
-      
-      if (ph_ps2_kbd_repeat > 3 && ph_ps2_kbd_repeat != 6) ph_ps2_kbd_send(0xe0);
-      ph_ps2_kbd_send(ph_ps2_mod2ps2[ph_ps2_kbd_repeat - 1]);
-      
-    } else {
-      
-      ph_ps2_kbd_maybe_send_e0(ph_ps2_kbd_repeat);
-      ph_ps2_kbd_send(ph_ps2_hid2ps2[ph_ps2_kbd_repeat]);
-      
-    }
-    
-    return ph_ps2_kbd_repeat_us;
-  }
-  
-  ph_ps2_kbd_repeater = 0;
-  return 0;
-}
-
-int64_t ph_ps2_blink_callback() {
-  ph_g_ps2_kbd_leds = 0;
-  ph_ps2_kbd_send(0xaa);
-  return 0;
-}
-
-void ph_ps2_kbd_reset() {
-  ph_ps2_kbd_scanning = true;
-  ph_ps2_kbd_repeat_us = 91743;
-  ph_ps2_kbd_delay_ms = 500;
-  ph_ps2_kbd_repeat = 0;
-  ph_g_ps2_kbd_leds = 7;
-  add_alarm_in_ms(500, ph_ps2_blink_callback, NULL, false);
-}
-
-void ph_ps2_kbd_send_key(u8 key, bool state) {
-  if (PH_O_IS_KBD_PS2 && ph_ps2_kbd_scanning) {
-    if (key >= 0xe0 && key <= 0xe7) {
-      
-      if (key == 0xe0 || key == 0xe4) {
-        if (state) {
-          ph_ps2_is_ctrl++;
-        } else {
-          ph_ps2_is_ctrl--;
-        }
-        
-        if (ph_ps2_is_ctrl < 0 || ph_ps2_is_ctrl > 2) {
-          ph_ps2_is_ctrl = 0;
-        }
-      }
-      
-      key -= 0xe0;
-      
-      if (key > 2 && key != 5) {
-        ph_ps2_kbd_send(0xe0);
-      }
-      
-      if (state) {
-        ph_ps2_kbd_repeat = key + 1;
-        ph_ps2_kbd_repeatmod = true;
-        
-        if (ph_ps2_kbd_repeater) {
-          cancel_alarm(ph_ps2_kbd_repeater);
-        }
-        
-        ph_ps2_kbd_repeater = add_alarm_in_ms(ph_ps2_kbd_delay_ms, ph_ps2_repeat_callback, NULL, false);
-      } else {
-        if (ph_ps2_kbd_repeat == key + 1 && ph_ps2_kbd_repeatmod) {
-          ph_ps2_kbd_repeat = 0;
-        }
-        
-        ph_ps2_kbd_send(0xf0);
-      }
-      
-      ph_ps2_kbd_send(ph_ps2_mod2ps2[key]);
-      
-    } else if (key < ph_ps2_maparray) {
-      
-      if (key == 0x48) {
-        ph_ps2_kbd_repeat = 0;
-        
-        if (state) {
-          if (ph_ps2_is_ctrl) {
-            ph_ps2_kbd_send(0xe0); ph_ps2_kbd_send(0x7e); ph_ps2_kbd_send(0xe0); ph_ps2_kbd_send(0xf0); ph_ps2_kbd_send(0x7e);
-          } else {
-            ph_ps2_kbd_send(0xe1); ph_ps2_kbd_send(0x14); ph_ps2_kbd_send(0x77); ph_ps2_kbd_send(0xe1);
-            ph_ps2_kbd_send(0xf0); ph_ps2_kbd_send(0x14); ph_ps2_kbd_send(0xf0); ph_ps2_kbd_send(0x77);
-          }
-        }
-      } else {
-        ph_ps2_kbd_maybe_send_e0(key);
-        
-        if (state) {
-          ph_ps2_kbd_repeat = key;
-          ph_ps2_kbd_repeatmod = false;
-          
-          if (ph_ps2_kbd_repeater) {
-            cancel_alarm(ph_ps2_kbd_repeater);
-          }
-          
-          ph_ps2_kbd_repeater = add_alarm_in_ms(ph_ps2_kbd_delay_ms, ph_ps2_repeat_callback, NULL, false);
-        } else {
-          if (ph_ps2_kbd_repeat == key && !ph_ps2_kbd_repeatmod) {
-            ph_ps2_kbd_repeat = 0;
-          }
-          
-          ph_ps2_kbd_send(0xf0);
-        }
-        
-        ph_ps2_kbd_send(ph_ps2_hid2ps2[key]);
-      }
-    }
-  }
-}
-
-void ph_ps2_kbd_receive(u8 byte, u8 prev_byte) {
-  switch (prev_byte) {
-    case 0xed: // Set LEDs
-      if (byte > 7) byte = 0;
-      ph_g_ps2_kbd_leds = ph_ps2_led2ps2[byte];
-    break;
-    
-    case 0xf3: // Set typematic rate and delay
-      ph_ps2_kbd_repeat_us = ph_ps2_repeats[byte & 0x1f];
-      ph_ps2_kbd_delay_ms = ph_ps2_delays[(byte & 0x60) >> 5];
-    break;
-    
-    default:
-      switch (byte) {
-        case 0xff: // Reset
-          ph_ps2_kbd_reset();
-        break;
-        
-        case 0xee: // Echo
-          ph_ps2_kbd_send(0xee);
-        return;
-        
-        case 0xf2: // Identify keyboard
-          ph_ps2_kbd_send(0xfa);
-          ph_ps2_kbd_send(0xab);
-          ph_ps2_kbd_send(0x83);
-        return;
-        
-        case 0xf4: // Enable scanning
-          ph_ps2_kbd_scanning = true;
-        break;
-        
-        case 0xf5: // Disable scanning, restore default parameters
-        case 0xf6: // Set default parameters
-          ph_ps2_kbd_scanning = byte == 0xf6;
-          ph_ps2_kbd_repeat_us = 91743;
-          ph_ps2_kbd_delay_ms = 500;
-          ph_ps2_kbd_repeat = 0;
-          ph_g_ps2_kbd_leds = 0;
-        break;
-      }
-    break;
-  }
-  
-  ph_ps2_kbd_send(0xfa);
-}
-
-void ph_ps2_kbd_task(void) {
-  ps2phy_task(&ph_ps2_kbd);
-  ph_g_ps2_kbd_online = ph_ps2_kbd_scanning && !ph_ps2_kbd.busy;
-}
-
-void ph_ps2_kbd_init(u8 gpio) {
-  ps2phy_init(&ph_ps2_kbd, pio0, gpio, &ph_ps2_kbd_receive); 
-  ph_ps2_kbd_reset();
-}
diff --git a/hid/pico/src/ph_ps2_mouse.c b/hid/pico/src/ph_ps2_mouse.c
deleted file mode 100644
index a56b814a..00000000
--- a/hid/pico/src/ph_ps2_mouse.c
+++ /dev/null
@@ -1,148 +0,0 @@
-#include "ps2phy.h"
-
-#include "ph_outputs.h"
-
-extern bool ph_g_ps2_mouse_online;
-
-ps2phy ph_ps2_mouse;
-bool ph_ps2_mouse_streaming = false;
-u32 ph_ps2_mouse_magic_seq = 0;
-u8 ph_ps2_mouse_type = 0;
-u8 ph_ps2_mouse_buttons = 0;
-
-void ph_ps2_mouse_send(u8 byte) {
-  queue_try_add(&ph_ps2_mouse.qbytes, &byte);
-}
-
-void ph_ps2_mouse_pack(s8 x, s8 y, s8 h, s8 v) {
-  if (ph_ps2_mouse_streaming) {
-    u8 byte1 = 0x8 | (ph_ps2_mouse_buttons & 0x7);
-    s8 byte2 = x;
-    s8 byte3 = 0x100 - y;
-    s8 byte4 = 0; // = 0x100 - z;
-    
-    if (byte2 < 0) byte1 |= 0x10;
-    if (byte3 < 0) byte1 |= 0x20;
-    
-    ph_ps2_mouse_send(byte1);
-    ph_ps2_mouse_send(byte2);
-    ph_ps2_mouse_send(byte3);
-    
-    if (ph_ps2_mouse_type == 3 || ph_ps2_mouse_type == 4) {
-      //if (byte4 < -8) byte4 = -8;
-      //if (byte4 > 7) byte4 = 7;
-      //if (byte4 < 0) byte4 |= 0xf8;
-      
-      if (v < 0) byte4 = 0x01;
-      if (v > 0) byte4 = 0xff;
-      if (h < 0) byte4 = 0x02;
-      if (h > 0) byte4 = 0xfe;
-      
-      if (ph_ps2_mouse_type == 4) {
-        byte4 &= 0xf;
-        byte4 |= (ph_ps2_mouse_buttons << 1) & 0x30;
-      }
-      
-      ph_ps2_mouse_send(byte4);
-    }
-  }
-}
-
-void ph_ps2_mouse_send_button(u8 button, bool state) {
-  if (PH_O_IS_MOUSE_PS2) {
-    button--;
-    
-    if (state) {
-      ph_ps2_mouse_buttons = ph_ps2_mouse_buttons | (1 << button);
-    } else {
-      ph_ps2_mouse_buttons = ph_ps2_mouse_buttons & ~(1 << button);
-    }
-    
-    ph_ps2_mouse_pack(0, 0, 0, 0);
-  }
-}
-
-void ph_ps2_mouse_send_rel(s8 x, s8 y) {
-  if (PH_O_IS_MOUSE_PS2) {
-    ph_ps2_mouse_pack(x, y, 0, 0);
-  }
-}
-
-void ph_ps2_mouse_send_wheel(s8 h, s8 v) {
-  if (PH_O_IS_MOUSE_PS2) {
-    ph_ps2_mouse_pack(0, 0, h, v);
-  }
-}
-
-void ph_ps2_mouse_receive(u8 byte, u8 prev_byte) {
-  switch (prev_byte) {
-    case 0xf3: // Set Sample Rate
-      ph_ps2_mouse_magic_seq = ((ph_ps2_mouse_magic_seq << 8) | byte) & 0xffffff;
-      
-      if (ph_ps2_mouse_type == 0 && ph_ps2_mouse_magic_seq == 0xc86450) {
-        ph_ps2_mouse_type = 3;
-      } else if (ph_ps2_mouse_type == 3 && ph_ps2_mouse_magic_seq == 0xc8c850) {
-        ph_ps2_mouse_type = 4;
-      }
-    break;
-    
-    default:
-      switch (byte) {
-        case 0xff: // Reset
-          ph_ps2_mouse_streaming = false;
-          ph_ps2_mouse_type = 0;
-          
-          ph_ps2_mouse_send(0xfa);
-          ph_ps2_mouse_send(0xaa);
-          ph_ps2_mouse_send(ph_ps2_mouse_type);
-        return;
-        
-        case 0xf6: // Set Defaults
-          ph_ps2_mouse_streaming = false;
-          ph_ps2_mouse_type = 0;
-        break;
-        
-        case 0xf5: // Disable Data Reporting
-        case 0xea: // Set Stream Mode
-          ph_ps2_mouse_streaming = false;
-        break;
-        
-        case 0xf4: // Enable Data Reporting
-          ph_ps2_mouse_streaming = true;
-        break;
-        
-        case 0xf2: // Get Device ID
-          ph_ps2_mouse_send(0xfa);
-          ph_ps2_mouse_send(ph_ps2_mouse_type);
-        return;
-        
-        case 0xe9: // Status Request
-          ph_ps2_mouse_send(0xfa);
-          ph_ps2_mouse_send(0x00); // Bit6: Mode, Bit 5: Enable, Bit 4: Scaling, Bits[2,1,0] = Buttons[L,M,R]
-          ph_ps2_mouse_send(0x02); // Resolution
-          ph_ps2_mouse_send(100);  // Sample Rate
-        return;
-        
-        // TODO: Implement (more of) these?
-        // case 0xf0: // Set Remote Mode
-        // case 0xee: // Set Wrap Mode
-        // case 0xec: // Reset Wrap Mode
-        // case 0xeb: // Read Data
-        // case 0xe8: // Set Resolution
-        // case 0xe7: // Set Scaling 2:1
-        // case 0xe6: // Set Scaling 1:1
-      }
-    break;
-  }
-  
-  ph_ps2_mouse_send(0xfa);
-}
-
-void ph_ps2_mouse_task(void) {
-  ps2phy_task(&ph_ps2_mouse);
-  ph_g_ps2_mouse_online = ph_ps2_mouse_streaming && !ph_ps2_mouse.busy;
-}
-
-void ph_ps2_mouse_init(u8 gpio) {
-  ps2phy_init(&ph_ps2_mouse, pio0, gpio, &ph_ps2_mouse_receive);
-}