Added wip usbkvm firmware

usbkvm/debug_terminal/go.mod

@@ -0,0 +1,7 @@
+module imuslab.com/remdes/send
+
+go 1.24.1
+
+require github.com/tarm/serial v0.0.0-20180830185346-98f6abe2eb07
+
+require golang.org/x/sys v0.31.0 // indirect

usbkvm/debug_terminal/go.sum

@@ -0,0 +1,4 @@
+github.com/tarm/serial v0.0.0-20180830185346-98f6abe2eb07 h1:UyzmZLoiDWMRywV4DUYb9Fbt8uiOSooupjTq10vpvnU=
+github.com/tarm/serial v0.0.0-20180830185346-98f6abe2eb07/go.mod h1:kDXzergiv9cbyO7IOYJZWg1U88JhDg3PB6klq9Hg2pA=
+golang.org/x/sys v0.31.0 h1:ioabZlmFYtWhL+TRYpcnNlLwhyxaM9kWTDEmfnprqik=
+golang.org/x/sys v0.31.0/go.mod h1:BJP2sWEmIv4KK5OTEluFJCKSidICx8ciO85XgH3Ak8k=

usbkvm/debug_terminal/keyboard_ctrl_alt_del.bat

@@ -0,0 +1,3 @@
+@echo off
+:: Press Ctrl + Alt + Del
+.\send.exe COM4 115200 0x01 0xFD 0x00

usbkvm/debug_terminal/keyboard_delete.bat

@@ -0,0 +1,9 @@
+@echo off
+:: Press Delete twice with a delay of 3 seconds between each press
+echo "Pressing Delete"
+send.exe COM4 115200 0x01 0x07 0xD4
+
+timeout /t 3 /nobreak >nul
+
+echo "Releasing Delete"
+send.exe COM4 115200 0x01 0x08 0xD4

usbkvm/debug_terminal/keyboard_funckey.bat

@@ -0,0 +1,5 @@
+@echo off
+:: Press F11
+echo "Pressing F11"
+send.exe COM4 115200 0x01 0x06 0xCC
+

usbkvm/debug_terminal/keyboard_modkey.bat

@@ -0,0 +1,7 @@
+@echo off
+:: Ctrl + Alt
+echo "Holding Ctrl + Alt"
+.\send.exe COM4 115200 0x01 0x04 0x05
+timeout /t 3 /nobreak >nul
+echo "Releasing Delete & Ctrl + Alt"
+.\send.exe COM4 115200 0x01 0x04 0x00

usbkvm/debug_terminal/keyboard_press.bat

@@ -0,0 +1,9 @@
+@echo off
+:: Press CAPS LOCK twice with a delay of 3 seconds between each press
+echo "Pressing CAPS LOCK"
+send.exe COM4 115200 0x01 0x07 0xC1 0x01 0x08 0xC1
+
+timeout /t 3 /nobreak >nul
+
+echo "Pressing CAPS LOCK again"
+send.exe COM4 115200 0x01 0x07 0xC1 0x01 0x08 0xC1

usbkvm/debug_terminal/keyboard_write.bat

@@ -0,0 +1,2 @@
+@echo off
+.\send.exe COM4 115200 0x01 0x01 0x48 0x01 0x01 0x65 0x01 0x01 0x6C 0x01 0x01 0x6C 0x01 0x01 0x6F 0x01 0x01 0x20 0x01 0x01 0x57 0x01 0x01 0x6F 0x01 0x01 0x72 0x01 0x01 0x6C 0x01 0x01 0x64

usbkvm/debug_terminal/main.go

@@ -0,0 +1,67 @@
+package main
+
+import (
+	"fmt"
+	"log"
+	"os"
+	"strconv"
+	"time"
+
+	"github.com/tarm/serial"
+)
+
+func main() {
+	if len(os.Args) < 4 {
+		log.Fatalf("Usage: %s <port> <baud> <data...>", os.Args[0])
+	}
+
+	portName := os.Args[1]
+	baudRate, err := strconv.Atoi(os.Args[2])
+	if err != nil {
+		log.Fatalf("Invalid baud rate: %v", err)
+	}
+
+	config := &serial.Config{
+		Name:   portName,
+		Baud:   baudRate,
+		Size:   8,
+		Parity: serial.ParityNone,
+	}
+
+	port, err := serial.OpenPort(config)
+	if err != nil {
+		log.Fatalf("Failed to open port: %v", err)
+	}
+	defer port.Close()
+
+	go func() {
+		buf := make([]byte, 128)
+		for {
+			n, err := port.Read(buf)
+			if err != nil {
+				log.Printf("Failed to read from port: %v", err)
+				return
+			}
+			if n > 0 {
+				fmt.Print("Received bytes: ")
+				for i := 0; i < n; i++ {
+					fmt.Printf("0x%02X ", buf[i])
+				}
+				fmt.Println()
+			}
+		}
+	}()
+
+	for _, arg := range os.Args[3:] {
+		data, err := strconv.ParseUint(arg, 0, 8)
+		if err != nil {
+			log.Fatalf("Invalid data byte: %v", err)
+		}
+		n, err := port.Write([]byte{byte(data)})
+		if err != nil {
+			log.Fatalf("Failed to write to port: %v", err)
+		}
+		fmt.Printf("Sent %d bytes to %s\n", n, portName)
+		time.Sleep(10 * time.Millisecond)
+	}
+}

usbkvm/usbkvm_fw/keyboard_emu.ino

@@ -0,0 +1,216 @@
+/*
+  keyboard_emu.ino
+  Author: tobychui
+
+  This code file handle keyboard emulation related functionality
+  When opr_type is set to 0x01, the sub-handler will process the
+  request here.
+
+ -- Keyboard Opcode --
+  0x00 = Reserved
+  0x01 = keyboard write
+  0x02 = keyboard press
+  0x03 = keyboard release
+    (ASCII bytes in range of 32 to 127)
+
+  0x04 = Modifier key combination set (bit flags in payload)
+    Bit 0 (0x01) = KEY_LEFT_CTRL
+    Bit 1 (0x02) = KEY_LEFT_SHIFT
+    Bit 2 (0x04) = KEY_LEFT_ALT
+    Bit 3 (0x08) = KEY_LEFT_GUI
+    Bit 4 (0x10) = KEY_RIGHT_CTRL
+    Bit 5 (0x20) = KEY_RIGHT_SHIFT
+    Bit 6 (0x40) = KEY_RIGHT_ALT
+    Bit 7 (0x80) = KEY_RIGHT_GUI
+  0x05 = Modifier key combination reset 
+
+  0x07 = Function key combinartion write
+    0xC2 = KEY_F1
+    0xC3 = KEY_F2
+    0xC4 = KEY_F3
+    ...
+    0xCC = KEY_F11 
+    0xCD = KEY_F12
+    0xF0 = KEY_F13
+    ...
+    0xFB = KEY_F24
+  
+  0x08 = Other keys press
+  0x09 = Other keys release
+    0xDA = KEY_UP_ARROW
+    0xD9 = KEY_DOWN_ARROW
+    0xD8 = KEY_LEFT_ARROW
+    0xD7 = KEY_RIGHT_ARROW
+    0xB2 = KEY_BACKSPACE
+    0xB3 = KEY_TAB
+    0xB0 = KEY_RETURN
+    0xB1 = KEY_ESC
+    0xD1 = KEY_INSERT
+    0xD4 = KEY_DELETE
+    0xD3 = KEY_PAGE_UP
+    0xD6 = KEY_PAGE_DOWN
+    0xD2 = KEY_HOME
+    0xD5 = KEY_END
+    0xC1 = KEY_CAPS_LOCK
+
+  -- Special Opcode --
+  0xFE = Ctrl + Alt + Delete
+  0xFF = Reset all keys state
+
+*/
+
+#include "usbkvm_fw.h"
+
+//Check if the value is a supported ascii code
+bool is_ascii(uint8_t value) {
+  return value >= 32 && value <= 127;
+}
+
+//Check if the value is a valid function key value
+bool is_funckey(uint8_t value) {
+  return ((value >= 0xC2 && value <= 0xCD) || (value >= 0xF0 && value <= 0xFB));
+}
+
+//Check if the key is valid key that do not belongs in ASCII or function key
+bool is_validkeys(uint8_t key) {
+  if (key >= 0xD7 && key <= 0xDA) {
+    //Arrow keys
+    return true;
+  }
+
+  if (key >= 0xB0 && key <= 0xB3) {
+    //ESC, tabs and other left-most keys
+    return true;
+  }
+
+  if (key >= 0xD1 && key <= 0xD6) {
+    //Keys above arrow keys like pageup and down
+    return true;
+  }
+
+  //CAP_LOCK
+  return key == 0xC1;
+}
+
+//Check if the nth bit is set in the value
+bool isBitSet(uint8_t value, uint8_t n) {
+  if (n > 7) return false;  // Ensure n is within 0-7
+  return (value & (1 << n)) != 0;
+}
+
+//Handle modifying key set or unset
+void keyboard_modifying_key_set(uint8_t key) {
+  if (key & 0x01) {  // Bit 0 = KEY_LEFT_CTRL
+    Keyboard_press(KEY_LEFT_CTRL);
+  } else {
+    Keyboard_release(KEY_LEFT_CTRL);
+  }
+
+  if (key & 0x02) {  // Bit 1 = KEY_LEFT_SHIFT
+    Keyboard_press(KEY_LEFT_SHIFT);
+  } else {
+    Keyboard_release(KEY_LEFT_SHIFT);
+  }
+
+  if (key & 0x04) {  // Bit 2 = KEY_LEFT_ALT
+    Keyboard_press(KEY_LEFT_ALT);
+  } else {
+    Keyboard_release(KEY_LEFT_ALT);
+  }
+
+  if (key & 0x08) {  // Bit 3 = KEY_LEFT_GUI
+    Keyboard_press(KEY_LEFT_GUI);
+  } else {
+    Keyboard_release(KEY_LEFT_GUI);
+  }
+
+  if (key & 0x10) {  // Bit 4 = KEY_RIGHT_CTRL
+    Keyboard_press(KEY_RIGHT_CTRL);
+  } else {
+    Keyboard_release(KEY_RIGHT_CTRL);
+  }
+
+  if (key & 0x20) {  // Bit 5 = KEY_RIGHT_SHIFT
+    Keyboard_press(KEY_RIGHT_SHIFT);
+  } else {
+    Keyboard_release(KEY_RIGHT_SHIFT);
+  }
+
+  if (key & 0x40) {  // Bit 6 = KEY_RIGHT_ALT
+    Keyboard_press(KEY_RIGHT_ALT);
+  } else {
+    Keyboard_release(KEY_RIGHT_ALT);
+  }
+
+  if (key & 0x80) {  // Bit 7 = KEY_RIGHT_GUI
+    Keyboard_press(KEY_RIGHT_GUI);
+  } else {
+    Keyboard_release(KEY_RIGHT_GUI);
+  }
+}
+
+//Entry point for keyboard emulation
+uint8_t keyboard_emulation(uint8_t subtype, uint8_t value) {
+  //Check if the input is a supported ascii value
+
+  switch (subtype) {
+    case SUBTYPE_KEYBOARD_ASCII_WRITE:
+      if (!is_ascii(value))
+        return resp_invalid_key_value;
+      Keyboard_write(value);
+      return resp_ok;
+    case SUBTYPE_KEYBOARD_ASCII_PRESS:
+      if (!is_ascii(value))
+        return resp_invalid_key_value;
+      Keyboard_press(value);
+      return resp_ok;
+    case SUBTYPE_KEYBOARD_ASCII_RELEASE:
+      if (!is_ascii(value))
+        return resp_invalid_key_value;
+      Keyboard_release(value);
+      return resp_ok;
+    case SUBTYPE_KEYBOARD_MODIFIER_SET:
+      keyboard_modifying_key_set(value);
+      return resp_ok;
+    case SUBTYPE_KEYBOARD_MODIFIER_CLEAR:
+      keyboard_modifying_key_set(0x00);
+      return resp_ok;
+    case SUBTYPE_KEYBOARD_FUNCTKEY_WRITE:
+      if (!is_funckey(value))
+        return resp_invalid_key_value;
+      Keyboard_press(value);
+      delay(100);
+      Keyboard_release(value);
+      return resp_ok;
+    case SUBTYPE_KEYBOARD_OTHERKEY_PRESS:
+      if (!is_validkeys(value))
+        return resp_invalid_key_value;
+      Keyboard_press(value);
+      return resp_ok;
+    case SUBTYPE_KEYBOARD_OTHERKEY_RELEASE:
+      if (!is_validkeys(value))
+        return resp_invalid_key_value;
+      Keyboard_release(value);
+      return resp_ok;
+    case SUBTYPE_KEYBOARD_SPECIAL_CTRLALTDEL:
+      // Press Ctrl + Alt + Del
+      Keyboard_press(KEY_LEFT_CTRL);
+      Keyboard_press(KEY_LEFT_ALT);
+      Keyboard_press(KEY_DELETE);
+      delay(100);  // Give a little longer time for all keys to be registered together
+
+      // Release Ctrl + Alt + Del in reverse order
+      Keyboard_release(KEY_DELETE);
+      delay(20);
+      Keyboard_release(KEY_LEFT_ALT);
+      delay(20);
+      Keyboard_release(KEY_LEFT_CTRL);
+      delay(20);
+      return resp_ok;
+    case SUBTYPE_KEYBOARD_SPECIAL_RESET:
+      Keyboard_releaseAll();
+      return resp_ok;
+    default:
+      return resp_invalid_opr_type;
+  }
+}

usbkvm/usbkvm_fw/src/remdesHid/HIDClassCommon.h

@@ -0,0 +1,536 @@
+/*
+             LUFA Library
+     Copyright (C) Dean Camera, 2021.
+
+  dean [at] fourwalledcubicle [dot] com
+           www.lufa-lib.org
+*/
+
+/*
+  Copyright 2021  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+
+  Permission to use, copy, modify, distribute, and sell this
+  software and its documentation for any purpose is hereby granted
+  without fee, provided that the above copyright notice appear in
+  all copies and that both that the copyright notice and this
+  permission notice and warranty disclaimer appear in supporting
+  documentation, and that the name of the author not be used in
+  advertising or publicity pertaining to distribution of the
+  software without specific, written prior permission.
+
+  The author disclaims all warranties with regard to this
+  software, including all implied warranties of merchantability
+  and fitness.  In no event shall the author be liable for any
+  special, indirect or consequential damages or any damages
+  whatsoever resulting from loss of use, data or profits, whether
+  in an action of contract, negligence or other tortious action,
+  arising out of or in connection with the use or performance of
+  this software.
+*/
+
+/** \file
+ *  \brief Common definitions and declarations for the library USB HID Class
+ * driver.
+ *
+ *  Common definitions and declarations for the library USB HID Class driver.
+ *
+ *  \note This file should not be included directly. It is automatically
+ * included as needed by the USB module driver dispatch header located in
+ * LUFA/Drivers/USB.h.
+ */
+
+/** \ingroup Group_USBClassHID
+ *  \defgroup Group_USBClassHIDCommon  Common Class Definitions
+ *
+ *  \section Sec_USBClassHIDCommon_ModDescription Module Description
+ *  Constants, Types and Enum definitions that are common to both Device and
+ * Host modes for the USB HID Class.
+ *
+ *  @{
+ */
+
+#ifndef _HID_CLASS_COMMON_H_
+#define _HID_CLASS_COMMON_H_
+
+/* Includes: */
+#include "StdDescriptors.h"
+// 	#include "HIDParser.h"
+
+// /* Enable C linkage for C++ Compilers: */
+// 	#if defined(__cplusplus)
+// 		extern "C" {
+// 	#endif
+
+// /* Preprocessor Checks: */
+// 	#if !defined(__INCLUDE_FROM_HID_DRIVER)
+// 		#error Do not include this file directly. Include
+// LUFA/Drivers/USB.h instead. 	#endif
+
+/* Macros: */
+/** \name Keyboard Standard Report Modifier Masks */
+/**@{*/
+/** Constant for a keyboard report modifier byte, indicating that the keyboard's
+ * left control key is currently pressed. */
+#define HID_KEYBOARD_MODIFIER_LEFTCTRL (1 << 0)
+
+/** Constant for a keyboard report modifier byte, indicating that the keyboard's
+ * left shift key is currently pressed. */
+#define HID_KEYBOARD_MODIFIER_LEFTSHIFT (1 << 1)
+
+/** Constant for a keyboard report modifier byte, indicating that the keyboard's
+ * left alt key is currently pressed. */
+#define HID_KEYBOARD_MODIFIER_LEFTALT (1 << 2)
+
+/** Constant for a keyboard report modifier byte, indicating that the keyboard's
+ * left GUI key is currently pressed. */
+#define HID_KEYBOARD_MODIFIER_LEFTGUI (1 << 3)
+
+/** Constant for a keyboard report modifier byte, indicating that the keyboard's
+ * right control key is currently pressed. */
+#define HID_KEYBOARD_MODIFIER_RIGHTCTRL (1 << 4)
+
+/** Constant for a keyboard report modifier byte, indicating that the keyboard's
+ * right shift key is currently pressed. */
+#define HID_KEYBOARD_MODIFIER_RIGHTSHIFT (1 << 5)
+
+/** Constant for a keyboard report modifier byte, indicating that the keyboard's
+ * right alt key is currently pressed. */
+#define HID_KEYBOARD_MODIFIER_RIGHTALT (1 << 6)
+
+/** Constant for a keyboard report modifier byte, indicating that the keyboard's
+ * right GUI key is currently pressed. */
+#define HID_KEYBOARD_MODIFIER_RIGHTGUI (1 << 7)
+/**@}*/
+
+/** \name Keyboard Standard Report LED Masks */
+/**@{*/
+/** Constant for a keyboard output report LED byte, indicating that the host's
+ * NUM LOCK mode is currently set. */
+#define HID_KEYBOARD_LED_NUMLOCK (1 << 0)
+
+/** Constant for a keyboard output report LED byte, indicating that the host's
+ * CAPS LOCK mode is currently set. */
+#define HID_KEYBOARD_LED_CAPSLOCK (1 << 1)
+
+/** Constant for a keyboard output report LED byte, indicating that the host's
+ * SCROLL LOCK mode is currently set. */
+#define HID_KEYBOARD_LED_SCROLLLOCK (1 << 2)
+
+/** Constant for a keyboard output report LED byte, indicating that the host's
+ * COMPOSE mode is currently set. */
+#define HID_KEYBOARD_LED_COMPOSE (1 << 3)
+
+/** Constant for a keyboard output report LED byte, indicating that the host's
+ * KANA mode is currently set. */
+#define HID_KEYBOARD_LED_KANA (1 << 4)
+/**@}*/
+
+/** \name Keyboard Standard Report Key Scan-codes */
+/**@{*/
+#define HID_KEYBOARD_SC_RESERVED 0x00
+#define HID_KEYBOARD_SC_ERROR_ROLLOVER 0x01
+#define HID_KEYBOARD_SC_POST_FAIL 0x02
+#define HID_KEYBOARD_SC_ERROR_UNDEFINED 0x03
+#define HID_KEYBOARD_SC_A 0x04
+#define HID_KEYBOARD_SC_B 0x05
+#define HID_KEYBOARD_SC_C 0x06
+#define HID_KEYBOARD_SC_D 0x07
+#define HID_KEYBOARD_SC_E 0x08
+#define HID_KEYBOARD_SC_F 0x09
+#define HID_KEYBOARD_SC_G 0x0A
+#define HID_KEYBOARD_SC_H 0x0B
+#define HID_KEYBOARD_SC_I 0x0C
+#define HID_KEYBOARD_SC_J 0x0D
+#define HID_KEYBOARD_SC_K 0x0E
+#define HID_KEYBOARD_SC_L 0x0F
+#define HID_KEYBOARD_SC_M 0x10
+#define HID_KEYBOARD_SC_N 0x11
+#define HID_KEYBOARD_SC_O 0x12
+#define HID_KEYBOARD_SC_P 0x13
+#define HID_KEYBOARD_SC_Q 0x14
+#define HID_KEYBOARD_SC_R 0x15
+#define HID_KEYBOARD_SC_S 0x16
+#define HID_KEYBOARD_SC_T 0x17
+#define HID_KEYBOARD_SC_U 0x18
+#define HID_KEYBOARD_SC_V 0x19
+#define HID_KEYBOARD_SC_W 0x1A
+#define HID_KEYBOARD_SC_X 0x1B
+#define HID_KEYBOARD_SC_Y 0x1C
+#define HID_KEYBOARD_SC_Z 0x1D
+#define HID_KEYBOARD_SC_1_AND_EXCLAMATION 0x1E
+#define HID_KEYBOARD_SC_2_AND_AT 0x1F
+#define HID_KEYBOARD_SC_3_AND_HASHMARK 0x20
+#define HID_KEYBOARD_SC_4_AND_DOLLAR 0x21
+#define HID_KEYBOARD_SC_5_AND_PERCENTAGE 0x22
+#define HID_KEYBOARD_SC_6_AND_CARET 0x23
+#define HID_KEYBOARD_SC_7_AND_AMPERSAND 0x24
+#define HID_KEYBOARD_SC_8_AND_ASTERISK 0x25
+#define HID_KEYBOARD_SC_9_AND_OPENING_PARENTHESIS 0x26
+#define HID_KEYBOARD_SC_0_AND_CLOSING_PARENTHESIS 0x27
+#define HID_KEYBOARD_SC_ENTER 0x28
+#define HID_KEYBOARD_SC_ESCAPE 0x29
+#define HID_KEYBOARD_SC_BACKSPACE 0x2A
+#define HID_KEYBOARD_SC_TAB 0x2B
+#define HID_KEYBOARD_SC_SPACE 0x2C
+#define HID_KEYBOARD_SC_MINUS_AND_UNDERSCORE 0x2D
+#define HID_KEYBOARD_SC_EQUAL_AND_PLUS 0x2E
+#define HID_KEYBOARD_SC_OPENING_BRACKET_AND_OPENING_BRACE 0x2F
+#define HID_KEYBOARD_SC_CLOSING_BRACKET_AND_CLOSING_BRACE 0x30
+#define HID_KEYBOARD_SC_BACKSLASH_AND_PIPE 0x31
+#define HID_KEYBOARD_SC_NON_US_HASHMARK_AND_TILDE 0x32
+#define HID_KEYBOARD_SC_SEMICOLON_AND_COLON 0x33
+#define HID_KEYBOARD_SC_APOSTROPHE_AND_QUOTE 0x34
+#define HID_KEYBOARD_SC_GRAVE_ACCENT_AND_TILDE 0x35
+#define HID_KEYBOARD_SC_COMMA_AND_LESS_THAN_SIGN 0x36
+#define HID_KEYBOARD_SC_DOT_AND_GREATER_THAN_SIGN 0x37
+#define HID_KEYBOARD_SC_SLASH_AND_QUESTION_MARK 0x38
+#define HID_KEYBOARD_SC_CAPS_LOCK 0x39
+#define HID_KEYBOARD_SC_F1 0x3A
+#define HID_KEYBOARD_SC_F2 0x3B
+#define HID_KEYBOARD_SC_F3 0x3C
+#define HID_KEYBOARD_SC_F4 0x3D
+#define HID_KEYBOARD_SC_F5 0x3E
+#define HID_KEYBOARD_SC_F6 0x3F
+#define HID_KEYBOARD_SC_F7 0x40
+#define HID_KEYBOARD_SC_F8 0x41
+#define HID_KEYBOARD_SC_F9 0x42
+#define HID_KEYBOARD_SC_F10 0x43
+#define HID_KEYBOARD_SC_F11 0x44
+#define HID_KEYBOARD_SC_F12 0x45
+#define HID_KEYBOARD_SC_PRINT_SCREEN 0x46
+#define HID_KEYBOARD_SC_SCROLL_LOCK 0x47
+#define HID_KEYBOARD_SC_PAUSE 0x48
+#define HID_KEYBOARD_SC_INSERT 0x49
+#define HID_KEYBOARD_SC_HOME 0x4A
+#define HID_KEYBOARD_SC_PAGE_UP 0x4B
+#define HID_KEYBOARD_SC_DELETE 0x4C
+#define HID_KEYBOARD_SC_END 0x4D
+#define HID_KEYBOARD_SC_PAGE_DOWN 0x4E
+#define HID_KEYBOARD_SC_RIGHT_ARROW 0x4F
+#define HID_KEYBOARD_SC_LEFT_ARROW 0x50
+#define HID_KEYBOARD_SC_DOWN_ARROW 0x51
+#define HID_KEYBOARD_SC_UP_ARROW 0x52
+#define HID_KEYBOARD_SC_NUM_LOCK 0x53
+#define HID_KEYBOARD_SC_KEYPAD_SLASH 0x54
+#define HID_KEYBOARD_SC_KEYPAD_ASTERISK 0x55
+#define HID_KEYBOARD_SC_KEYPAD_MINUS 0x56
+#define HID_KEYBOARD_SC_KEYPAD_PLUS 0x57
+#define HID_KEYBOARD_SC_KEYPAD_ENTER 0x58
+#define HID_KEYBOARD_SC_KEYPAD_1_AND_END 0x59
+#define HID_KEYBOARD_SC_KEYPAD_2_AND_DOWN_ARROW 0x5A
+#define HID_KEYBOARD_SC_KEYPAD_3_AND_PAGE_DOWN 0x5B
+#define HID_KEYBOARD_SC_KEYPAD_4_AND_LEFT_ARROW 0x5C
+#define HID_KEYBOARD_SC_KEYPAD_5 0x5D
+#define HID_KEYBOARD_SC_KEYPAD_6_AND_RIGHT_ARROW 0x5E
+#define HID_KEYBOARD_SC_KEYPAD_7_AND_HOME 0x5F
+#define HID_KEYBOARD_SC_KEYPAD_8_AND_UP_ARROW 0x60
+#define HID_KEYBOARD_SC_KEYPAD_9_AND_PAGE_UP 0x61
+#define HID_KEYBOARD_SC_KEYPAD_0_AND_INSERT 0x62
+#define HID_KEYBOARD_SC_KEYPAD_DOT_AND_DELETE 0x63
+#define HID_KEYBOARD_SC_NON_US_BACKSLASH_AND_PIPE 0x64
+#define HID_KEYBOARD_SC_APPLICATION 0x65
+#define HID_KEYBOARD_SC_POWER 0x66
+#define HID_KEYBOARD_SC_KEYPAD_EQUAL_SIGN 0x67
+#define HID_KEYBOARD_SC_F13 0x68
+#define HID_KEYBOARD_SC_F14 0x69
+#define HID_KEYBOARD_SC_F15 0x6A
+#define HID_KEYBOARD_SC_F16 0x6B
+#define HID_KEYBOARD_SC_F17 0x6C
+#define HID_KEYBOARD_SC_F18 0x6D
+#define HID_KEYBOARD_SC_F19 0x6E
+#define HID_KEYBOARD_SC_F20 0x6F
+#define HID_KEYBOARD_SC_F21 0x70
+#define HID_KEYBOARD_SC_F22 0x71
+#define HID_KEYBOARD_SC_F23 0x72
+#define HID_KEYBOARD_SC_F24 0x73
+#define HID_KEYBOARD_SC_EXECUTE 0x74
+#define HID_KEYBOARD_SC_HELP 0x75
+#define HID_KEYBOARD_SC_MENU 0x76
+#define HID_KEYBOARD_SC_SELECT 0x77
+#define HID_KEYBOARD_SC_STOP 0x78
+#define HID_KEYBOARD_SC_AGAIN 0x79
+#define HID_KEYBOARD_SC_UNDO 0x7A
+#define HID_KEYBOARD_SC_CUT 0x7B
+#define HID_KEYBOARD_SC_COPY 0x7C
+#define HID_KEYBOARD_SC_PASTE 0x7D
+#define HID_KEYBOARD_SC_FIND 0x7E
+#define HID_KEYBOARD_SC_MUTE 0x7F
+#define HID_KEYBOARD_SC_VOLUME_UP 0x80
+#define HID_KEYBOARD_SC_VOLUME_DOWN 0x81
+#define HID_KEYBOARD_SC_LOCKING_CAPS_LOCK 0x82
+#define HID_KEYBOARD_SC_LOCKING_NUM_LOCK 0x83
+#define HID_KEYBOARD_SC_LOCKING_SCROLL_LOCK 0x84
+#define HID_KEYBOARD_SC_KEYPAD_COMMA 0x85
+#define HID_KEYBOARD_SC_KEYPAD_EQUAL_SIGN_AS400 0x86
+#define HID_KEYBOARD_SC_INTERNATIONAL1 0x87
+#define HID_KEYBOARD_SC_INTERNATIONAL2 0x88
+#define HID_KEYBOARD_SC_INTERNATIONAL3 0x89
+#define HID_KEYBOARD_SC_INTERNATIONAL4 0x8A
+#define HID_KEYBOARD_SC_INTERNATIONAL5 0x8B
+#define HID_KEYBOARD_SC_INTERNATIONAL6 0x8C
+#define HID_KEYBOARD_SC_INTERNATIONAL7 0x8D
+#define HID_KEYBOARD_SC_INTERNATIONAL8 0x8E
+#define HID_KEYBOARD_SC_INTERNATIONAL9 0x8F
+#define HID_KEYBOARD_SC_LANG1 0x90
+#define HID_KEYBOARD_SC_LANG2 0x91
+#define HID_KEYBOARD_SC_LANG3 0x92
+#define HID_KEYBOARD_SC_LANG4 0x93
+#define HID_KEYBOARD_SC_LANG5 0x94
+#define HID_KEYBOARD_SC_LANG6 0x95
+#define HID_KEYBOARD_SC_LANG7 0x96
+#define HID_KEYBOARD_SC_LANG8 0x97
+#define HID_KEYBOARD_SC_LANG9 0x98
+#define HID_KEYBOARD_SC_ALTERNATE_ERASE 0x99
+#define HID_KEYBOARD_SC_SYSREQ 0x9A
+#define HID_KEYBOARD_SC_CANCEL 0x9B
+#define HID_KEYBOARD_SC_CLEAR 0x9C
+#define HID_KEYBOARD_SC_PRIOR 0x9D
+#define HID_KEYBOARD_SC_RETURN 0x9E
+#define HID_KEYBOARD_SC_SEPARATOR 0x9F
+#define HID_KEYBOARD_SC_OUT 0xA0
+#define HID_KEYBOARD_SC_OPER 0xA1
+#define HID_KEYBOARD_SC_CLEAR_AND_AGAIN 0xA2
+#define HID_KEYBOARD_SC_CRSEL_AND_PROPS 0xA3
+#define HID_KEYBOARD_SC_EXSEL 0xA4
+#define HID_KEYBOARD_SC_KEYPAD_00 0xB0
+#define HID_KEYBOARD_SC_KEYPAD_000 0xB1
+#define HID_KEYBOARD_SC_THOUSANDS_SEPARATOR 0xB2
+#define HID_KEYBOARD_SC_DECIMAL_SEPARATOR 0xB3
+#define HID_KEYBOARD_SC_CURRENCY_UNIT 0xB4
+#define HID_KEYBOARD_SC_CURRENCY_SUB_UNIT 0xB5
+#define HID_KEYBOARD_SC_KEYPAD_OPENING_PARENTHESIS 0xB6
+#define HID_KEYBOARD_SC_KEYPAD_CLOSING_PARENTHESIS 0xB7
+#define HID_KEYBOARD_SC_KEYPAD_OPENING_BRACE 0xB8
+#define HID_KEYBOARD_SC_KEYPAD_CLOSING_BRACE 0xB9
+#define HID_KEYBOARD_SC_KEYPAD_TAB 0xBA
+#define HID_KEYBOARD_SC_KEYPAD_BACKSPACE 0xBB
+#define HID_KEYBOARD_SC_KEYPAD_A 0xBC
+#define HID_KEYBOARD_SC_KEYPAD_B 0xBD
+#define HID_KEYBOARD_SC_KEYPAD_C 0xBE
+#define HID_KEYBOARD_SC_KEYPAD_D 0xBF
+#define HID_KEYBOARD_SC_KEYPAD_E 0xC0
+#define HID_KEYBOARD_SC_KEYPAD_F 0xC1
+#define HID_KEYBOARD_SC_KEYPAD_XOR 0xC2
+#define HID_KEYBOARD_SC_KEYPAD_CARET 0xC3
+#define HID_KEYBOARD_SC_KEYPAD_PERCENTAGE 0xC4
+#define HID_KEYBOARD_SC_KEYPAD_LESS_THAN_SIGN 0xC5
+#define HID_KEYBOARD_SC_KEYPAD_GREATER_THAN_SIGN 0xC6
+#define HID_KEYBOARD_SC_KEYPAD_AMP 0xC7
+#define HID_KEYBOARD_SC_KEYPAD_AMP_AMP 0xC8
+#define HID_KEYBOARD_SC_KEYPAD_PIPE 0xC9
+#define HID_KEYBOARD_SC_KEYPAD_PIPE_PIPE 0xCA
+#define HID_KEYBOARD_SC_KEYPAD_COLON 0xCB
+#define HID_KEYBOARD_SC_KEYPAD_HASHMARK 0xCC
+#define HID_KEYBOARD_SC_KEYPAD_SPACE 0xCD
+#define HID_KEYBOARD_SC_KEYPAD_AT 0xCE
+#define HID_KEYBOARD_SC_KEYPAD_EXCLAMATION_SIGN 0xCF
+#define HID_KEYBOARD_SC_KEYPAD_MEMORY_STORE 0xD0
+#define HID_KEYBOARD_SC_KEYPAD_MEMORY_RECALL 0xD1
+#define HID_KEYBOARD_SC_KEYPAD_MEMORY_CLEAR 0xD2
+#define HID_KEYBOARD_SC_KEYPAD_MEMORY_ADD 0xD3
+#define HID_KEYBOARD_SC_KEYPAD_MEMORY_SUBTRACT 0xD4
+#define HID_KEYBOARD_SC_KEYPAD_MEMORY_MULTIPLY 0xD5
+#define HID_KEYBOARD_SC_KEYPAD_MEMORY_DIVIDE 0xD6
+#define HID_KEYBOARD_SC_KEYPAD_PLUS_AND_MINUS 0xD7
+#define HID_KEYBOARD_SC_KEYPAD_CLEAR 0xD8
+#define HID_KEYBOARD_SC_KEYPAD_CLEAR_ENTRY 0xD9
+#define HID_KEYBOARD_SC_KEYPAD_BINARY 0xDA
+#define HID_KEYBOARD_SC_KEYPAD_OCTAL 0xDB
+#define HID_KEYBOARD_SC_KEYPAD_DECIMAL 0xDC
+#define HID_KEYBOARD_SC_KEYPAD_HEXADECIMAL 0xDD
+#define HID_KEYBOARD_SC_LEFT_CONTROL 0xE0
+#define HID_KEYBOARD_SC_LEFT_SHIFT 0xE1
+#define HID_KEYBOARD_SC_LEFT_ALT 0xE2
+#define HID_KEYBOARD_SC_LEFT_GUI 0xE3
+#define HID_KEYBOARD_SC_RIGHT_CONTROL 0xE4
+#define HID_KEYBOARD_SC_RIGHT_SHIFT 0xE5
+#define HID_KEYBOARD_SC_RIGHT_ALT 0xE6
+#define HID_KEYBOARD_SC_RIGHT_GUI 0xE7
+#define HID_KEYBOARD_SC_MEDIA_PLAY 0xE8
+#define HID_KEYBOARD_SC_MEDIA_STOP 0xE9
+#define HID_KEYBOARD_SC_MEDIA_PREVIOUS_TRACK 0xEA
+#define HID_KEYBOARD_SC_MEDIA_NEXT_TRACK 0xEB
+#define HID_KEYBOARD_SC_MEDIA_EJECT 0xEC
+#define HID_KEYBOARD_SC_MEDIA_VOLUME_UP 0xED
+#define HID_KEYBOARD_SC_MEDIA_VOLUME_DOWN 0xEE
+#define HID_KEYBOARD_SC_MEDIA_MUTE 0xEF
+#define HID_KEYBOARD_SC_MEDIA_WWW 0xF0
+#define HID_KEYBOARD_SC_MEDIA_BACKWARD 0xF1
+#define HID_KEYBOARD_SC_MEDIA_FORWARD 0xF2
+#define HID_KEYBOARD_SC_MEDIA_CANCEL 0xF3
+#define HID_KEYBOARD_SC_MEDIA_SEARCH 0xF4
+#define HID_KEYBOARD_SC_MEDIA_SLEEP 0xF8
+#define HID_KEYBOARD_SC_MEDIA_LOCK 0xF9
+#define HID_KEYBOARD_SC_MEDIA_RELOAD 0xFA
+#define HID_KEYBOARD_SC_MEDIA_CALCULATOR 0xFB
+/**@}*/
+
+/* Type Defines: */
+/** Enum for possible Class, Subclass and Protocol values of device and
+ * interface descriptors relating to the HID device class.
+ */
+enum HID_Descriptor_ClassSubclassProtocol_t {
+  HID_CSCP_HIDClass = 0x03, /**< Descriptor Class value indicating that the
+                             * device or interface belongs to the HID class.
+                             */
+  HID_CSCP_NonBootSubclass =
+      0x00, /**< Descriptor Subclass value indicating that the device or
+             * interface does not implement a HID boot protocol.
+             */
+  HID_CSCP_BootSubclass =
+      0x01, /**< Descriptor Subclass value indicating that the device or
+             * interface implements a HID boot protocol.
+             */
+  HID_CSCP_NonBootProtocol =
+      0x00, /**< Descriptor Protocol value indicating that the device or
+             * interface does not belong to a HID boot protocol.
+             */
+  HID_CSCP_KeyboardBootProtocol =
+      0x01, /**< Descriptor Protocol value indicating that the device or
+             * interface belongs to the Keyboard HID boot protocol.
+             */
+  HID_CSCP_MouseBootProtocol =
+      0x02, /**< Descriptor Protocol value indicating that the device or
+             * interface belongs to the Mouse HID boot protocol.
+             */
+};
+
+/** Enum for the HID class specific control requests that can be issued by the
+ * USB bus host. */
+enum HID_ClassRequests_t {
+  HID_REQ_GetReport = 0x01,   /**< HID class-specific Request to get the current
+                                 HID report from the device. */
+  HID_REQ_GetIdle = 0x02,     /**< HID class-specific Request to get the current
+                                 device idle count. */
+  HID_REQ_GetProtocol = 0x03, /**< HID class-specific Request to get the current
+                                 HID report protocol mode. */
+  HID_REQ_SetReport = 0x09,   /**< HID class-specific Request to set the current
+                                 HID report to the device. */
+  HID_REQ_SetIdle =
+      0x0A, /**< HID class-specific Request to set the device's idle count. */
+  HID_REQ_SetProtocol = 0x0B, /**< HID class-specific Request to set the current
+                                 HID report protocol mode. */
+};
+
+/** Enum for the HID class specific descriptor types. */
+enum HID_DescriptorTypes_t {
+  HID_DTYPE_HID = 0x21,    /**< Descriptor header type value, to indicate a HID
+                              class HID descriptor. */
+  HID_DTYPE_Report = 0x22, /**< Descriptor header type value, to indicate a HID
+                              class HID report descriptor. */
+};
+
+/** Enum for the different types of HID reports. */
+enum HID_ReportItemTypes_t {
+  HID_REPORT_ITEM_In = 0, /**< Indicates that the item is an IN report type. */
+  HID_REPORT_ITEM_Out =
+      1, /**< Indicates that the item is an OUT report type. */
+  HID_REPORT_ITEM_Feature =
+      2, /**< Indicates that the item is a FEATURE report type. */
+};
+
+/** \brief HID class-specific HID Descriptor (LUFA naming conventions).
+ *
+ *  Type define for the HID class-specific HID descriptor, to describe the HID
+ * device's specifications. Refer to the HID specification for details on the
+ * structure elements.
+ *
+ *  \see \ref USB_HID_StdDescriptor_HID_t for the version of this type with
+ * standard element names.
+ *
+ *  \note Regardless of CPU architecture, these values should be stored as
+ * little endian.
+ */
+typedef struct {
+  USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the
+                                     descriptor's type and length. */
+
+  uint16_t HIDSpec; /**< BCD encoded version that the HID descriptor and device
+                     * complies to.
+                     *
+                     *   \see \ref VERSION_BCD() utility macro.
+                     */
+  uint8_t CountryCode; /**< Country code of the localized device, or zero if
+                          universal. */
+
+  uint8_t TotalReportDescriptors; /**< Total number of HID report descriptors
+                                     for the interface. */
+
+  uint8_t
+      HIDReportType; /**< Type of HID report, set to \ref HID_DTYPE_Report. */
+  uint16_t HIDReportLength; /**< Length of the associated HID report descriptor,
+                               in bytes. */
+} USB_HID_Descriptor_HID_t;
+
+/** \brief HID class-specific HID Descriptor (USB-IF naming conventions).
+ *
+ *  Type define for the HID class-specific HID descriptor, to describe the HID
+ * device's specifications. Refer to the HID specification for details on the
+ * structure elements.
+ *
+ *  \see \ref USB_HID_Descriptor_HID_t for the version of this type with
+ * non-standard LUFA specific element names.
+ *
+ *  \note Regardless of CPU architecture, these values should be stored as
+ * little endian.
+ */
+typedef struct {
+  uint8_t bLength;         /**< Size of the descriptor, in bytes. */
+  uint8_t bDescriptorType; /**< Type of the descriptor, either a value in \ref
+                            * USB_DescriptorTypes_t or a value given by the
+                            * specific class.
+                            */
+
+  uint16_t bcdHID; /**< BCD encoded version that the HID descriptor and device
+                    * complies to.
+                    *
+                    *   \see \ref VERSION_BCD() utility macro.
+                    */
+  uint8_t bCountryCode; /**< Country code of the localized device, or zero if
+                           universal. */
+
+  uint8_t bNumDescriptors; /**< Total number of HID report descriptors for the
+                              interface. */
+
+  uint8_t bDescriptorType2;   /**< Type of HID report, set to \ref
+                                 HID_DTYPE_Report. */
+  uint16_t wDescriptorLength; /**< Length of the associated HID report
+                                 descriptor, in bytes. */
+} USB_HID_StdDescriptor_HID_t;
+
+/** \brief Standard HID Boot Protocol Mouse Report.
+ *
+ *  Type define for a standard Boot Protocol Mouse report
+ */
+typedef struct {
+  uint8_t
+      Button; /**< Button mask for currently pressed buttons in the mouse. */
+  int8_t X;   /**< Current delta X movement of the mouse. */
+  int8_t Y;   /**< Current delta Y movement on the mouse. */
+} USB_MouseReport_Data_t;
+
+/** \brief Standard HID Boot Protocol Keyboard Report.
+ *
+ *  Type define for a standard Boot Protocol Keyboard report
+ */
+typedef struct {
+  uint8_t
+      Modifier;       /**< Keyboard modifier byte, indicating pressed modifier
+                       * keys (a combination of   \c HID_KEYBOARD_MODIFER_* masks).
+                       */
+  uint8_t Reserved;   /**< Reserved for OEM use, always set to 0. */
+  uint8_t KeyCode[6]; /**< Key codes of the currently pressed keys. */
+} USB_KeyboardReport_Data_t;
+
+/** Type define for the data type used to store HID report descriptor elements.
+ */
+typedef uint8_t USB_Descriptor_HIDReport_Datatype_t;
+
+// /* Disable C linkage for C++ Compilers: */
+// 	#if defined(__cplusplus)
+// 		}
+// 	#endif
+
+#endif
+
+/** @} */

usbkvm/usbkvm_fw/src/remdesHid/README.txt

@@ -0,0 +1,3 @@
+RemdesHID library is modified from the open source CH55xduino example code
+https://github.com/DeqingSun/ch55xduino/tree/ch55xduino/ch55xduino/ch55x/libraries/Generic_Examples/examples/05.USB/HidKeyboardMouse
+

usbkvm/usbkvm_fw/src/remdesHid/StdDescriptors.h

@@ -0,0 +1,893 @@
+/*
+             LUFA Library
+     Copyright (C) Dean Camera, 2021.
+
+  dean [at] fourwalledcubicle [dot] com
+           www.lufa-lib.org
+*/
+
+/*
+  Copyright 2021  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+
+  Permission to use, copy, modify, distribute, and sell this
+  software and its documentation for any purpose is hereby granted
+  without fee, provided that the above copyright notice appear in
+  all copies and that both that the copyright notice and this
+  permission notice and warranty disclaimer appear in supporting
+  documentation, and that the name of the author not be used in
+  advertising or publicity pertaining to distribution of the
+  software without specific, written prior permission.
+
+  The author disclaims all warranties with regard to this
+  software, including all implied warranties of merchantability
+  and fitness.  In no event shall the author be liable for any
+  special, indirect or consequential damages or any damages
+  whatsoever resulting from loss of use, data or profits, whether
+  in an action of contract, negligence or other tortious action,
+  arising out of or in connection with the use or performance of
+  this software.
+*/
+
+/** \file
+ *  \brief Common standard USB Descriptor definitions for all architectures.
+ *  \copydetails Group_StdDescriptors
+ *
+ *  \note This file should not be included directly. It is automatically
+ * included as needed by the USB driver dispatch header located in
+ * LUFA/Drivers/USB/USB.h.
+ */
+
+/** \ingroup Group_USB
+ *  \defgroup Group_StdDescriptors USB Descriptors
+ *  \brief Standard USB Descriptor definitions.
+ *
+ *  Standard USB device descriptor defines and retrieval routines, for USB
+ * devices. This module contains structures and macros for the easy creation of
+ * standard USB descriptors in USB device projects.
+ *
+ *  @{
+ */
+
+#ifndef __USBDESCRIPTORS_H__
+#define __USBDESCRIPTORS_H__
+
+#include <stdint.h>
+
+/* Public Interface - May be used in end-application: */
+/* Macros: */
+
+/** Mask for a CONTROL type endpoint or pipe.
+ *
+ *  \note See \ref Group_EndpointManagement and \ref Group_PipeManagement for
+ * endpoint/pipe functions.
+ */
+#define EP_TYPE_CONTROL 0x00
+
+/** Mask for an ISOCHRONOUS type endpoint or pipe.
+ *
+ *  \note See \ref Group_EndpointManagement and \ref Group_PipeManagement for
+ * endpoint/pipe functions.
+ */
+#define EP_TYPE_ISOCHRONOUS 0x01
+
+/** Mask for a BULK type endpoint or pipe.
+ *
+ *  \note See \ref Group_EndpointManagement and \ref Group_PipeManagement for
+ * endpoint/pipe functions.
+ */
+#define EP_TYPE_BULK 0x02
+
+/** Mask for an INTERRUPT type endpoint or pipe.
+ *
+ *  \note See \ref Group_EndpointManagement and \ref Group_PipeManagement for
+ * endpoint/pipe functions.
+ */
+#define EP_TYPE_INTERRUPT 0x03
+
+/** Indicates that a given descriptor does not exist in the device. This can be
+ * used inside descriptors for string descriptor indexes, or may be use as a
+ * return value for GetDescriptor when the specified descriptor does not exist.
+ */
+#define NO_DESCRIPTOR 0
+
+/** Macro to calculate the power value for the configuration descriptor, from a
+ * given number of milliamperes.
+ *
+ *  \param[in] mA  Maximum number of milliamps the device consumes when the
+ * given configuration is selected.
+ */
+#define USB_CONFIG_POWER_MA(mA) ((mA) >> 1)
+
+/** Macro to calculate the Unicode length of a string with a given number of
+ * Unicode characters. Should be used in string descriptor's headers for giving
+ * the string descriptor's byte length.
+ *
+ *  \param[in] UnicodeChars  Number of Unicode characters in the string text.
+ */
+#define USB_STRING_LEN(UnicodeChars)                                           \
+  (sizeof(USB_Descriptor_Header_t) + ((UnicodeChars) << 1))
+
+/** Convenience macro to easily create \ref USB_Descriptor_String_t instances
+ * from a wide character string.
+ *
+ *  \note This macro is for little-endian systems only.
+ *
+ *  \param[in] String  String to initialize a USB String Descriptor structure
+ * with.
+ */
+#define USB_STRING_DESCRIPTOR(String)                                          \
+  {                                                                            \
+    .Header = {.Size = sizeof(USB_Descriptor_Header_t) + (sizeof(String) - 2), \
+               .Type = DTYPE_String},                                          \
+    .UnicodeString = String                                                    \
+  }
+
+/** Convenience macro to easily create \ref USB_Descriptor_String_t instances
+ * from an array of characters.
+ *
+ *  \param[in] ...  Characters to initialize a USB String Descriptor structure
+ * with.
+ */
+#define USB_STRING_DESCRIPTOR_ARRAY(...)                                       \
+  {                                                                            \
+    .Header = {.Size = sizeof(USB_Descriptor_Header_t) +                       \
+                       sizeof((uint16_t[]){__VA_ARGS__}),                      \
+               .Type = DTYPE_String},                                          \
+    .UnicodeString = {                                                         \
+      __VA_ARGS__                                                              \
+    }                                                                          \
+  }
+
+/** Macro to encode a given major/minor/revision version number into Binary
+ * Coded Decimal format for descriptor fields requiring BCD encoding, such as
+ * the USB version number in the standard device descriptor.
+ *
+ *  \note This value is automatically converted into Little Endian, suitable for
+ * direct use inside device descriptors on all architectures without endianness
+ * conversion macros.
+ *
+ *  \param[in]  Major     Major version number to encode.
+ *  \param[in]  Minor     Minor version number to encode.
+ *  \param[in]  Revision  Revision version number to encode.
+ */
+#define VERSION_BCD(Major, Minor, Revision)                                    \
+  (((Major & 0xFF) << 8) | ((Minor & 0x0F) << 4) | (Revision & 0x0F))
+
+/** String language ID for the English language. Should be used in \ref
+ * USB_Descriptor_String_t descriptors to indicate that the English language is
+ * supported by the device in its string descriptors.
+ */
+#define LANGUAGE_ID_ENG 0x0409
+
+/** \name USB Configuration Descriptor Attribute Masks */
+/**@{*/
+/** Mask for the reserved bit in the Configuration Descriptor's \c
+ * ConfigAttributes field, which must be always set on all USB devices for
+ * historical purposes.
+ */
+#define USB_CONFIG_ATTR_RESERVED 0x80
+
+/** Can be masked with other configuration descriptor attributes for a \ref
+ * USB_Descriptor_Configuration_Header_t descriptor's \c ConfigAttributes value
+ * to indicate that the specified configuration can draw its power from the
+ * device's own power source, instead of drawing it from the USB host.
+ *
+ *  Note that the host will probe this dynamically - the device should report
+ * its current power state via the \ref USB_Device_CurrentlySelfPowered global
+ * variable.
+ */
+#define USB_CONFIG_ATTR_SELFPOWERED 0x40
+
+/** Can be masked with other configuration descriptor attributes for a \ref
+ * USB_Descriptor_Configuration_Header_t descriptor's \c ConfigAttributes value
+ * to indicate that the specified configuration supports the remote wakeup
+ * feature of the USB standard, allowing a suspended USB device to wake up the
+ * host upon request.
+ *
+ *  If set, the host will dynamically enable and disable remote wakeup support,
+ * indicated via the \ref USB_Device_RemoteWakeupEnabled global variable. To
+ * initiate a remote wakeup of the host (when allowed) see \ref
+ * USB_Device_RemoteWakeupEnabled().
+ */
+#define USB_CONFIG_ATTR_REMOTEWAKEUP 0x20
+/**@}*/
+
+/** \name Endpoint Descriptor Attribute Masks */
+/**@{*/
+/** Can be masked with other endpoint descriptor attributes for a \ref
+ * USB_Descriptor_Endpoint_t descriptor's \c Attributes value to indicate that
+ * the specified endpoint is not synchronized.
+ *
+ *  \see The USB specification for more details on the possible Endpoint
+ * attributes.
+ */
+#define ENDPOINT_ATTR_NO_SYNC (0 << 2)
+
+/** Can be masked with other endpoint descriptor attributes for a \ref
+ * USB_Descriptor_Endpoint_t descriptor's \c Attributes value to indicate that
+ * the specified endpoint is asynchronous.
+ *
+ *  \see The USB specification for more details on the possible Endpoint
+ * attributes.
+ */
+#define ENDPOINT_ATTR_ASYNC (1 << 2)
+
+/** Can be masked with other endpoint descriptor attributes for a \ref
+ * USB_Descriptor_Endpoint_t descriptor's \c Attributes value to indicate that
+ * the specified endpoint is adaptive.
+ *
+ *  \see The USB specification for more details on the possible Endpoint
+ * attributes.
+ */
+#define ENDPOINT_ATTR_ADAPTIVE (2 << 2)
+
+/** Can be masked with other endpoint descriptor attributes for a \ref
+ * USB_Descriptor_Endpoint_t descriptor's \c Attributes value to indicate that
+ * the specified endpoint is synchronized.
+ *
+ *  \see The USB specification for more details on the possible Endpoint
+ * attributes.
+ */
+#define ENDPOINT_ATTR_SYNC (3 << 2)
+/**@}*/
+
+/** \name Endpoint Descriptor Usage Masks */
+/**@{*/
+/** Can be masked with other endpoint descriptor attributes for a \ref
+ * USB_Descriptor_Endpoint_t descriptor's \c Attributes value to indicate that
+ * the specified endpoint is used for data transfers.
+ *
+ *  \see The USB specification for more details on the possible Endpoint usage
+ * attributes.
+ */
+#define ENDPOINT_USAGE_DATA (0 << 4)
+
+/** Can be masked with other endpoint descriptor attributes for a \ref
+ * USB_Descriptor_Endpoint_t descriptor's \c Attributes value to indicate that
+ * the specified endpoint is used for feedback.
+ *
+ *  \see The USB specification for more details on the possible Endpoint usage
+ * attributes.
+ */
+#define ENDPOINT_USAGE_FEEDBACK (1 << 4)
+
+/** Can be masked with other endpoint descriptor attributes for a \ref
+ * USB_Descriptor_Endpoint_t descriptor's \c Attributes value to indicate that
+ * the specified endpoint is used for implicit feedback.
+ *
+ *  \see The USB specification for more details on the possible Endpoint usage
+ * attributes.
+ */
+#define ENDPOINT_USAGE_IMPLICIT_FEEDBACK (2 << 4)
+/**@}*/
+
+/* Enums: */
+/** Enum for the possible standard descriptor types, as given in each
+ * descriptor's header. */
+enum USB_DescriptorTypes_t {
+  DTYPE_Device =
+      0x01, /**< Indicates that the descriptor is a device descriptor. */
+  DTYPE_Configuration =
+      0x02, /**< Indicates that the descriptor is a configuration descriptor. */
+  DTYPE_String =
+      0x03, /**< Indicates that the descriptor is a string descriptor. */
+  DTYPE_Interface =
+      0x04, /**< Indicates that the descriptor is an interface descriptor. */
+  DTYPE_Endpoint =
+      0x05, /**< Indicates that the descriptor is an endpoint descriptor. */
+  DTYPE_DeviceQualifier = 0x06, /**< Indicates that the descriptor is a device
+                                   qualifier descriptor. */
+  DTYPE_Other = 0x07, /**< Indicates that the descriptor is of other type. */
+  DTYPE_InterfacePower = 0x08,       /**< Indicates that the descriptor is an
+                                        interface power descriptor. */
+  DTYPE_InterfaceAssociation = 0x0B, /**< Indicates that the descriptor is an
+                                        interface association descriptor. */
+};
+
+/** Enum for possible Class, Subclass and Protocol values of device and
+ * interface descriptors. */
+enum USB_Descriptor_ClassSubclassProtocol_t {
+  USB_CSCP_NoDeviceClass =
+      0x00, /**< Descriptor Class value indicating that the device does not
+             * belong to a particular class at the device level.
+             */
+  USB_CSCP_NoDeviceSubclass =
+      0x00, /**< Descriptor Subclass value indicating that the device does not
+             * belong to a particular subclass at the device level.
+             */
+  USB_CSCP_NoDeviceProtocol =
+      0x00, /**< Descriptor Protocol value indicating that the device does not
+             * belong to a particular protocol at the device level.
+             */
+  USB_CSCP_VendorSpecificClass =
+      0xFF, /**< Descriptor Class value indicating that the device/interface
+             * belongs to a vendor specific class.
+             */
+  USB_CSCP_VendorSpecificSubclass =
+      0xFF, /**< Descriptor Subclass value indicating that the device/interface
+             * belongs to a vendor specific subclass.
+             */
+  USB_CSCP_VendorSpecificProtocol =
+      0xFF, /**< Descriptor Protocol value indicating that the device/interface
+             * belongs to a vendor specific protocol.
+             */
+  USB_CSCP_IADDeviceClass =
+      0xEF, /**< Descriptor Class value indicating that the device belongs to
+             * the Interface Association Descriptor class.
+             */
+  USB_CSCP_IADDeviceSubclass =
+      0x02, /**< Descriptor Subclass value indicating that the device belongs to
+             * the Interface Association Descriptor subclass.
+             */
+  USB_CSCP_IADDeviceProtocol =
+      0x01, /**< Descriptor Protocol value indicating that the device belongs to
+             * the Interface Association Descriptor protocol.
+             */
+};
+
+/* Type Defines: */
+/** \brief Standard USB Descriptor Header (LUFA naming conventions).
+ *
+ *  Type define for all descriptors' standard header, indicating the
+ * descriptor's length and type. This structure uses LUFA-specific element names
+ * to make each element's purpose clearer.
+ *
+ *  \see \ref USB_StdDescriptor_Header_t for the version of this type with
+ * standard element names.
+ *
+ *  \note Regardless of CPU architecture, these values should be stored as
+ * little endian.
+ */
+typedef struct {
+  uint8_t Size; /**< Size of the descriptor, in bytes. */
+  uint8_t Type; /**< Type of the descriptor, either a value in \ref
+                 * USB_DescriptorTypes_t or a value given by the specific class.
+                 */
+} USB_Descriptor_Header_t;
+
+/** \brief Standard USB Device Descriptor (LUFA naming conventions).
+ *
+ *  Type define for a standard Device Descriptor. This structure uses
+ * LUFA-specific element names to make each element's purpose clearer.
+ *
+ *  \see \ref USB_StdDescriptor_Device_t for the version of this type with
+ * standard element names.
+ *
+ *  \note Regardless of CPU architecture, these values should be stored as
+ * little endian.
+ */
+typedef struct {
+  USB_Descriptor_Header_t
+      Header; /**< Descriptor header, including type and size. */
+
+  uint16_t USBSpecification; /**< BCD of the supported USB specification.
+                              *
+                              *   \see \ref VERSION_BCD() utility macro.
+                              */
+  uint8_t Class;             /**< USB device class. */
+  uint8_t SubClass;          /**< USB device subclass. */
+  uint8_t Protocol;          /**< USB device protocol. */
+
+  uint8_t Endpoint0Size; /**< Size of the control (address 0) endpoint's bank in
+                            bytes. */
+
+  uint16_t VendorID;      /**< Vendor ID for the USB product. */
+  uint16_t ProductID;     /**< Unique product ID for the USB product. */
+  uint16_t ReleaseNumber; /**< Product release (version) number.
+                           *
+                           *   \see \ref VERSION_BCD() utility macro.
+                           */
+  uint8_t
+      ManufacturerStrIndex; /**< String index for the manufacturer's name. The
+                             *   host will request this string via a separate
+                             *   control request for the string descriptor.
+                             *
+                             *   \note If no string supplied, use \ref
+                             * NO_DESCRIPTOR.
+                             */
+  uint8_t ProductStrIndex;  /**< String index for the product name/details.
+                             *
+                             *  \see ManufacturerStrIndex structure entry.
+                             */
+  uint8_t
+      SerialNumStrIndex; /**< String index for the product's globally unique
+                          * hexadecimal serial number, in uppercase Unicode
+                          * ASCII.
+                          *
+                          *  \note On some microcontroller models, there is an
+                          * embedded serial number in the chip which can be used
+                          * for the device serial number. To use this serial
+                          * number, set this to \c USE_INTERNAL_SERIAL. On
+                          * unsupported devices, this will evaluate to \ref
+                          * NO_DESCRIPTOR and will cause the host to generate a
+                          * pseudo-unique value for the device upon insertion.
+                          *
+                          *  \see \c ManufacturerStrIndex structure entry.
+                          */
+  uint8_t NumberOfConfigurations; /**< Total number of configurations supported
+                                     by the device.*/
+} USB_Descriptor_Device_t;
+
+// 		/** \brief Standard USB Device Qualifier Descriptor (LUFA naming
+// conventions).
+// 		 *
+// 		 *  Type define for a standard Device Qualifier Descriptor. This
+// structure uses LUFA-specific element names
+// 		 *  to make each element's purpose clearer.
+// 		 *
+// 		 *  \see \ref USB_StdDescriptor_DeviceQualifier_t for the
+// version of this type with standard element names.
+// 		 */
+// 		typedef struct
+// 		{
+// 			USB_Descriptor_Header_t Header; /**< Descriptor header,
+// including type and size. */
+
+// 			uint16_t USBSpecification; /**< BCD of the supported USB
+// specification.
+// 			                            *
+// 			                            *   \see \ref VERSION_BCD()
+// utility macro.
+// 			                            */
+// 			uint8_t  Class; /**< USB device class. */
+// 			uint8_t  SubClass; /**< USB device subclass. */
+// 			uint8_t  Protocol; /**< USB device protocol. */
+
+// 			uint8_t  Endpoint0Size; /**< Size of the control
+// (address 0) endpoint's bank in bytes. */ 			uint8_t
+// NumberOfConfigurations;
+// /**< Total number of configurations supported by
+// 			                                  *   the device.
+// 			                                  */
+// 			uint8_t  Reserved; /**< Reserved for future use, must be
+// 0.
+// */ 		} ATTR_PACKED USB_Descriptor_DeviceQualifier_t;
+
+// 		/** \brief Standard USB Device Qualifier Descriptor (USB-IF
+// naming conventions).
+// 		 *
+// 		 *  Type define for a standard Device Qualifier Descriptor. This
+// structure uses the relevant standard's given element names
+// 		 *  to ensure compatibility with the standard.
+// 		 *
+// 		 *  \see \ref USB_Descriptor_DeviceQualifier_t for the version
+// of this type with non-standard LUFA specific element names.
+// 		 */
+// 		typedef struct
+// 		{
+// 			uint8_t  bLength; /**< Size of the descriptor, in bytes.
+// */ 			uint8_t  bDescriptorType; /**< Type of the descriptor,
+// either a value in \ref USB_DescriptorTypes_t or a value
+// 			                           *   given by the specific
+// class.
+// 			                           */
+// 			uint16_t bcdUSB; /**< BCD of the supported USB
+// specification.
+// 			                  *
+// 			                  *   \see \ref VERSION_BCD() utility
+// macro.
+// 			                  */
+// 			uint8_t  bDeviceClass; /**< USB device class. */
+// 			uint8_t  bDeviceSubClass; /**< USB device subclass. */
+// 			uint8_t  bDeviceProtocol; /**< USB device protocol. */
+// 			uint8_t  bMaxPacketSize0; /**< Size of the control
+// (address 0)
+// endpoint's bank in bytes. */ 			uint8_t
+// bNumConfigurations;
+// /**< Total number of configurations supported by
+// 			                              *   the device.
+// 			                              */
+// 			uint8_t  bReserved; /**< Reserved for future use, must
+// be 0.
+// */ 		} ATTR_PACKED USB_StdDescriptor_DeviceQualifier_t;
+
+/** \brief Standard USB Configuration Descriptor (LUFA naming conventions).
+ *
+ *  Type define for a standard Configuration Descriptor header. This structure
+ * uses LUFA-specific element names to make each element's purpose clearer.
+ *
+ *  \see \ref USB_StdDescriptor_Configuration_Header_t for the version of this
+ * type with standard element names.
+ *
+ *  \note Regardless of CPU architecture, these values should be stored as
+ * little endian.
+ */
+typedef struct {
+  USB_Descriptor_Header_t
+      Header; /**< Descriptor header, including type and size. */
+
+  uint16_t TotalConfigurationSize; /**< Size of the configuration descriptor
+                                    * header, and all sub descriptors inside the
+                                    * configuration.
+                                    */
+  uint8_t
+      TotalInterfaces; /**< Total number of interfaces in the configuration. */
+
+  uint8_t ConfigurationNumber;   /**< Configuration index of the current
+                                    configuration. */
+  uint8_t ConfigurationStrIndex; /**< Index of a string descriptor describing
+                                    the configuration. */
+
+  uint8_t
+      ConfigAttributes; /**< Configuration attributes, comprised of a mask of \c
+                         * USB_CONFIG_ATTR_* masks. On all devices, this should
+                         * include USB_CONFIG_ATTR_RESERVED at a minimum.
+                         */
+
+  uint8_t MaxPowerConsumption; /**< Maximum power consumption of the device
+                                * while in the current configuration, calculated
+                                * by the \ref USB_CONFIG_POWER_MA() macro.
+                                */
+} USB_Descriptor_Configuration_Header_t;
+
+// 		/** \brief Standard USB Configuration Descriptor (USB-IF naming
+// conventions).
+// 		 *
+// 		 *  Type define for a standard Configuration Descriptor header.
+// This structure uses the relevant standard's given element names
+// 		 *  to ensure compatibility with the standard.
+// 		 *
+// 		 *  \see \ref USB_Descriptor_Device_t for the version of this
+// type with non-standard LUFA specific element names.
+// 		 *
+// 		 *  \note Regardless of CPU architecture, these values should be
+// stored as little endian.
+// 		 */
+// 		typedef struct
+// 		{
+// 			uint8_t  bLength; /**< Size of the descriptor, in bytes.
+// */ 			uint8_t  bDescriptorType; /**< Type of the descriptor,
+// either a value in \ref USB_DescriptorTypes_t or a value
+// 			                           *   given by the specific
+// class.
+// 			                           */
+// 			uint16_t wTotalLength; /**< Size of the configuration
+// descriptor header,
+// 			                           *   and all sub descriptors
+// inside the configuration.
+// 			                           */
+// 			uint8_t  bNumInterfaces; /**< Total number of interfaces
+// in
+// the configuration. */ 			uint8_t  bConfigurationValue;
+// /**< Configuration index
+// of the current configuration. */ 			uint8_t  iConfiguration;
+// /**< Index of a string descriptor describing the configuration. */
+// uint8_t bmAttributes;
+// /**< Configuration attributes, comprised of a mask of \c USB_CONFIG_ATTR_*
+// masks.
+// 			                        *   On all devices, this should
+// include USB_CONFIG_ATTR_RESERVED at a minimum.
+// 			                        */
+// 			uint8_t  bMaxPower; /**< Maximum power consumption of
+// the device while in the
+// 			                     *   current configuration,
+// calculated by the \ref USB_CONFIG_POWER_MA()
+// 			                     *   macro.
+// 			                     */
+// 		} ATTR_PACKED USB_StdDescriptor_Configuration_Header_t;
+
+/** \brief Standard USB Interface Descriptor (LUFA naming conventions).
+ *
+ *  Type define for a standard Interface Descriptor. This structure uses
+ * LUFA-specific element names to make each element's purpose clearer.
+ *
+ *  \see \ref USB_StdDescriptor_Interface_t for the version of this type with
+ * standard element names.
+ *
+ *  \note Regardless of CPU architecture, these values should be stored as
+ * little endian.
+ */
+typedef struct {
+  USB_Descriptor_Header_t
+      Header; /**< Descriptor header, including type and size. */
+
+  uint8_t InterfaceNumber;  /**< Index of the interface in the current
+                               configuration. */
+  uint8_t AlternateSetting; /**< Alternate setting for the interface number. The
+                             * same interface number can have multiple alternate
+                             * settings with different endpoint configurations,
+                             * which can be selected by the host.
+                             */
+  uint8_t TotalEndpoints;   /**< Total number of endpoints in the interface. */
+
+  uint8_t Class;    /**< Interface class ID. */
+  uint8_t SubClass; /**< Interface subclass ID. */
+  uint8_t Protocol; /**< Interface protocol ID. */
+
+  uint8_t InterfaceStrIndex; /**< Index of the string descriptor describing the
+                                interface. */
+} USB_Descriptor_Interface_t;
+
+// 		/** \brief Standard USB Interface Descriptor (USB-IF naming
+// conventions).
+// 		 *
+// 		 *  Type define for a standard Interface Descriptor. This
+// structure uses the relevant standard's given element names
+// 		 *  to ensure compatibility with the standard.
+// 		 *
+// 		 *  \see \ref USB_Descriptor_Interface_t for the version of this
+// type with non-standard LUFA specific element names.
+// 		 *
+// 		 *  \note Regardless of CPU architecture, these values should be
+// stored as little endian.
+// 		 */
+// 		typedef struct
+// 		{
+// 			uint8_t bLength; /**< Size of the descriptor, in bytes.
+// */ 			uint8_t bDescriptorType; /**< Type of the descriptor,
+// either a value in \ref USB_DescriptorTypes_t or a value
+// 			                          *   given by the specific
+// class.
+// 			                          */
+// 			uint8_t bInterfaceNumber; /**< Index of the interface in
+// the
+// current configuration. */ 			uint8_t bAlternateSetting; /**<
+// Alternate setting for the interface number. The same
+// 			                            *   interface number can
+// have multiple alternate settings
+// 			                            *   with different endpoint
+// configurations, which can be
+// 			                            *   selected by the host.
+// 			                            */
+// 			uint8_t bNumEndpoints; /**< Total number of endpoints in
+// the
+// interface. */ 			uint8_t bInterfaceClass; /**< Interface
+// class ID. */ 			uint8_t bInterfaceSubClass; /**<
+// Interface subclass ID. */ 			uint8_t bInterfaceProtocol; /**<
+// Interface protocol ID. */ 			uint8_t iInterface; /**< Index
+// of the string descriptor describing the
+// 			                     *   interface.
+// 			                     */
+// 		} ATTR_PACKED USB_StdDescriptor_Interface_t;
+
+/** \brief Standard USB Interface Association Descriptor (LUFA naming
+ * conventions).
+ *
+ *  Type define for a standard Interface Association Descriptor. This structure
+ * uses LUFA-specific element names to make each element's purpose clearer.
+ *
+ *  This descriptor has been added as a supplement to the USB2.0 standard, in
+ * the ECN located at
+ *  <a>http://www.usb.org/developers/docs/InterfaceAssociationDescriptor_ecn.pdf</a>.
+ * It allows composite devices with multiple interfaces related to the same
+ * function to have the multiple interfaces bound together at the point of
+ * enumeration, loading one generic driver for all the interfaces in the single
+ *  function. Read the ECN for more information.
+ *
+ *  \see \ref USB_StdDescriptor_Interface_Association_t for the version of this
+ * type with standard element names.
+ *
+ *  \note Regardless of CPU architecture, these values should be stored as
+ * little endian.
+ */
+typedef struct {
+  USB_Descriptor_Header_t
+      Header; /**< Descriptor header, including type and size. */
+
+  uint8_t FirstInterfaceIndex; /**< Index of the first associated interface. */
+  uint8_t TotalInterfaces;     /**< Total number of associated interfaces. */
+
+  uint8_t Class;    /**< Interface class ID. */
+  uint8_t SubClass; /**< Interface subclass ID. */
+  uint8_t Protocol; /**< Interface protocol ID. */
+
+  uint8_t IADStrIndex; /**< Index of the string descriptor describing the
+                        *   interface association.
+                        */
+} USB_Descriptor_Interface_Association_t;
+
+// 		/** \brief Standard USB Interface Association Descriptor (USB-IF
+// naming conventions).
+// 		 *
+// 		 *  Type define for a standard Interface Association Descriptor.
+// This structure uses the relevant standard's given
+// 		 *  element names to ensure compatibility with the standard.
+// 		 *
+// 		 *  This descriptor has been added as a supplement to the USB2.0
+// standard, in the ECN located at
+// 		 *
+// <a>http://www.usb.org/developers/docs/InterfaceAssociationDescriptor_ecn.pdf</a>.
+// It allows composite
+// 		 *  devices with multiple interfaces related to the same
+// function to have the multiple interfaces bound
+// 		 *  together at the point of enumeration, loading one generic
+// driver for all the interfaces in the single
+// 		 *  function. Read the ECN for more information.
+// 		 *
+// 		 *  \see \ref USB_Descriptor_Interface_Association_t for the
+// version of this type with non-standard LUFA specific
+// 		 *       element names.
+// 		 *
+// 		 *  \note Regardless of CPU architecture, these values should be
+// stored as little endian.
+// 		 */
+// 		typedef struct
+// 		{
+// 			uint8_t bLength; /**< Size of the descriptor, in bytes.
+// */ 			uint8_t bDescriptorType; /**< Type of the descriptor,
+// either a value in \ref USB_DescriptorTypes_t or a value
+// 			                          *   given by the specific
+// class.
+// 			                          */
+// 			uint8_t bFirstInterface; /**< Index of the first
+// associated
+// interface. */ 			uint8_t bInterfaceCount; /**< Total
+// number of associated interfaces. */ 			uint8_t bFunctionClass;
+// /**< Interface class ID. */ 			uint8_t bFunctionSubClass; /**<
+// Interface subclass ID. */ 			uint8_t bFunctionProtocol;
+// /**< Interface protocol ID. */ 			uint8_t iFunction; /**<
+// Index of the string descriptor describing the
+// 			                    *   interface association.
+// 			                    */
+// 		} ATTR_PACKED USB_StdDescriptor_Interface_Association_t;
+
+/** \brief Standard USB Endpoint Descriptor (LUFA naming conventions).
+ *
+ *  Type define for a standard Endpoint Descriptor. This structure uses
+ * LUFA-specific element names to make each element's purpose clearer.
+ *
+ *  \see \ref USB_StdDescriptor_Endpoint_t for the version of this type with
+ * standard element names.
+ *
+ *  \note Regardless of CPU architecture, these values should be stored as
+ * little endian.
+ */
+typedef struct {
+  USB_Descriptor_Header_t
+      Header; /**< Descriptor header, including type and size. */
+
+  uint8_t EndpointAddress; /**< Logical address of the endpoint within the
+                            * device for the current configuration, including
+                            * direction mask.
+                            */
+  uint8_t
+      Attributes; /**< Endpoint attributes, comprised of a mask of the endpoint
+                   * type (EP_TYPE_*) and attributes (ENDPOINT_ATTR_*) masks.
+                   */
+  uint16_t EndpointSize; /**< Size of the endpoint bank, in bytes. This
+                          * indicates the maximum packet size that the endpoint
+                          * can receive at a time.
+                          */
+  uint8_t
+      PollingIntervalMS; /**< Polling interval in milliseconds for the endpoint
+                          * if it is an INTERRUPT or ISOCHRONOUS type.
+                          */
+} USB_Descriptor_Endpoint_t;
+
+// 		/** \brief Standard USB Endpoint Descriptor (USB-IF naming
+// conventions).
+// 		 *
+// 		 *  Type define for a standard Endpoint Descriptor. This
+// structure uses the relevant standard's given
+// 		 *  element names to ensure compatibility with the standard.
+// 		 *
+// 		 *  \see \ref USB_Descriptor_Endpoint_t for the version of this
+// type with non-standard LUFA specific
+// 		 *       element names.
+// 		 *
+// 		 *  \note Regardless of CPU architecture, these values should be
+// stored as little endian.
+// 		 */
+// 		typedef struct
+// 		{
+// 			uint8_t  bLength; /**< Size of the descriptor, in bytes.
+// */ 			uint8_t  bDescriptorType; /**< Type of the descriptor,
+// either a value in \ref USB_DescriptorTypes_t or a
+// 			                           *   value given by the
+// specific class.
+// 			                           */
+// 			uint8_t  bEndpointAddress; /**< Logical address of the
+// endpoint within the device for the current
+// 			                            *   configuration, including
+// direction mask.
+// 			                            */
+// 			uint8_t  bmAttributes; /**< Endpoint attributes,
+// comprised of a mask of the endpoint type (EP_TYPE_*)
+// 			                        *   and attributes
+// (ENDPOINT_ATTR_*) masks.
+// 			                        */
+// 			uint16_t wMaxPacketSize; /**< Size of the endpoint bank,
+// in bytes. This indicates the maximum packet size
+// 			                          *   that the endpoint can
+// receive at a time.
+// 			                          */
+// 			uint8_t  bInterval; /**< Polling interval in
+// milliseconds for the endpoint if it is an INTERRUPT or
+// 			                     *   ISOCHRONOUS type.
+// 			                     */
+// 		} ATTR_PACKED USB_StdDescriptor_Endpoint_t;
+
+/** \brief Standard USB String Descriptor (LUFA naming conventions).
+ *
+ *  Type define for a standard string descriptor. Unlike other standard
+ * descriptors, the length of the descriptor for placement in the descriptor
+ * header must be determined by the \ref USB_STRING_LEN() macro rather than by
+ * the size of the descriptor structure, as the length is not fixed.
+ *
+ *  This structure should also be used for string index 0, which contains the
+ * supported language IDs for the device as an array.
+ *
+ *  This structure uses LUFA-specific element names to make each element's
+ * purpose clearer.
+ *
+ *  \see \ref USB_StdDescriptor_String_t for the version of this type with
+ * standard element names.
+ *
+ *  \note Regardless of CPU architecture, these values should be stored as
+ * little endian.
+ */
+typedef struct {
+  USB_Descriptor_Header_t
+      Header; /**< Descriptor header, including type and size. */
+
+  uint16_t
+      UnicodeString[]; /**< String data, as unicode characters (alternatively,
+                        *   string language IDs). If normal ASCII characters are
+                        *   to be used, they must be added as an array of
+                        * characters rather than a normal C string so that they
+                        * are widened to Unicode size.
+                        *
+                        *   Under GCC, strings prefixed with the "L" character
+                        * (before the opening string quotation mark) are
+                        * considered to be Unicode strings, and may be used
+                        * instead of an explicit array of ASCII characters on
+                        * little endian devices with UTF-16-LE \c wchar_t
+                        * encoding.
+                        */
+} USB_Descriptor_String_t;
+
+// 		/** \brief Standard USB String Descriptor (USB-IF naming
+// conventions).
+// 		 *
+// 		 *  Type define for a standard string descriptor. Unlike other
+// standard descriptors, the length
+// 		 *  of the descriptor for placement in the descriptor header
+// must be determined by the \ref USB_STRING_LEN()
+// 		 *  macro rather than by the size of the descriptor structure,
+// as the length is not fixed.
+// 		 *
+// 		 *  This structure should also be used for string index 0, which
+// contains the supported language IDs for
+// 		 *  the device as an array.
+// 		 *
+// 		 *  This structure uses the relevant standard's given element
+// names to ensure compatibility with the standard.
+// 		 *
+// 		 *  \see \ref USB_Descriptor_String_t for the version of this
+// type with with non-standard LUFA specific
+// 		 *       element names.
+// 		 *
+// 		 *  \note Regardless of CPU architecture, these values should be
+// stored as little endian.
+// 		 */
+// 		typedef struct
+// 		{
+// 			uint8_t bLength; /**< Size of the descriptor, in bytes.
+// */ 			uint8_t bDescriptorType; /**< Type of the descriptor,
+// either a value in \ref USB_DescriptorTypes_t
+// 			                          *   or a value given by the
+// specific class.
+// 			                          */
+// 			uint16_t bString[]; /**< String data, as unicode
+// characters (alternatively, string language IDs).
+// 			                     *   If normal ASCII characters are
+// to be used, they must be added as an array
+// 			                     *   of characters rather than a
+// normal C string so that they are widened to
+// 			                     *   Unicode size.
+// 			                     *
+// 			                     *   Under GCC, strings prefixed
+// with the "L" character (before the opening string
+// 			                     *   quotation mark) are considered
+// to be Unicode strings, and may be used instead
+// 			                     *   of an explicit array of ASCII
+// characters.
+// 			                     */
+// 		} ATTR_PACKED USB_StdDescriptor_String_t;
+
+// /* Disable C linkage for C++ Compilers: */
+// 	#if defined(__cplusplus)
+// 		}
+// 	#endif
+
+#endif

usbkvm/usbkvm_fw/src/remdesHid/USBHIDKeyboardMouse.c

@@ -0,0 +1,353 @@
+// clang-format off
+#include <stdint.h>
+#include <stdbool.h>
+#include "include/ch5xx.h"
+#include "include/ch5xx_usb.h"
+#include "USBconstant.h"
+#include "USBhandler.h"
+// clang-format on
+
+// clang-format off
+extern __xdata __at (EP0_ADDR) uint8_t Ep0Buffer[];
+extern __xdata __at (EP1_ADDR) uint8_t Ep1Buffer[];
+// clang-format on
+
+__xdata uint8_t keyboardLedStatus = 0;
+
+volatile __xdata uint8_t UpPoint1_Busy =
+    0; // Flag of whether upload pointer is busy
+
+__xdata uint8_t HIDKey[8] = {0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0};
+__xdata uint8_t HIDMouse[4] = {0x0, 0x0, 0x0, 0x0};
+
+#define SHIFT 0x80
+__code uint8_t _asciimap[128] = {
+    0x00, // NUL
+    0x00, // SOH
+    0x00, // STX
+    0x00, // ETX
+    0x00, // EOT
+    0x00, // ENQ
+    0x00, // ACK
+    0x00, // BEL
+    0x2a, // BS	Backspace
+    0x2b, // TAB	Tab
+    0x28, // LF	Enter
+    0x00, // VT
+    0x00, // FF
+    0x00, // CR
+    0x00, // SO
+    0x00, // SI
+    0x00, // DEL
+    0x00, // DC1
+    0x00, // DC2
+    0x00, // DC3
+    0x00, // DC4
+    0x00, // NAK
+    0x00, // SYN
+    0x00, // ETB
+    0x00, // CAN
+    0x00, // EM
+    0x00, // SUB
+    0x00, // ESC
+    0x00, // FS
+    0x00, // GS
+    0x00, // RS
+    0x00, // US
+
+    0x2c,         //  ' '
+    0x1e | SHIFT, // !
+    0x34 | SHIFT, // "
+    0x20 | SHIFT, // #
+    0x21 | SHIFT, // $
+    0x22 | SHIFT, // %
+    0x24 | SHIFT, // &
+    0x34,         // '
+    0x26 | SHIFT, // (
+    0x27 | SHIFT, // )
+    0x25 | SHIFT, // *
+    0x2e | SHIFT, // +
+    0x36,         // ,
+    0x2d,         // -
+    0x37,         // .
+    0x38,         // /
+    0x27,         // 0
+    0x1e,         // 1
+    0x1f,         // 2
+    0x20,         // 3
+    0x21,         // 4
+    0x22,         // 5
+    0x23,         // 6
+    0x24,         // 7
+    0x25,         // 8
+    0x26,         // 9
+    0x33 | SHIFT, // :
+    0x33,         // ;
+    0x36 | SHIFT, // <
+    0x2e,         // =
+    0x37 | SHIFT, // >
+    0x38 | SHIFT, // ?
+    0x1f | SHIFT, // @
+    0x04 | SHIFT, // A
+    0x05 | SHIFT, // B
+    0x06 | SHIFT, // C
+    0x07 | SHIFT, // D
+    0x08 | SHIFT, // E
+    0x09 | SHIFT, // F
+    0x0a | SHIFT, // G
+    0x0b | SHIFT, // H
+    0x0c | SHIFT, // I
+    0x0d | SHIFT, // J
+    0x0e | SHIFT, // K
+    0x0f | SHIFT, // L
+    0x10 | SHIFT, // M
+    0x11 | SHIFT, // N
+    0x12 | SHIFT, // O
+    0x13 | SHIFT, // P
+    0x14 | SHIFT, // Q
+    0x15 | SHIFT, // R
+    0x16 | SHIFT, // S
+    0x17 | SHIFT, // T
+    0x18 | SHIFT, // U
+    0x19 | SHIFT, // V
+    0x1a | SHIFT, // W
+    0x1b | SHIFT, // X
+    0x1c | SHIFT, // Y
+    0x1d | SHIFT, // Z
+    0x2f,         // [
+    0x31,         // bslash
+    0x30,         // ]
+    0x23 | SHIFT, // ^
+    0x2d | SHIFT, // _
+    0x35,         // `
+    0x04,         // a
+    0x05,         // b
+    0x06,         // c
+    0x07,         // d
+    0x08,         // e
+    0x09,         // f
+    0x0a,         // g
+    0x0b,         // h
+    0x0c,         // i
+    0x0d,         // j
+    0x0e,         // k
+    0x0f,         // l
+    0x10,         // m
+    0x11,         // n
+    0x12,         // o
+    0x13,         // p
+    0x14,         // q
+    0x15,         // r
+    0x16,         // s
+    0x17,         // t
+    0x18,         // u
+    0x19,         // v
+    0x1a,         // w
+    0x1b,         // x
+    0x1c,         // y
+    0x1d,         // z
+    0x2f | SHIFT, // {
+    0x31 | SHIFT, // |
+    0x30 | SHIFT, // }
+    0x35 | SHIFT, // ~
+    0             // DEL
+};
+
+typedef void (*pTaskFn)(void);
+
+void delayMicroseconds(uint16_t us);
+
+void USBInit() {
+  USBDeviceCfg();         // Device mode configuration
+  USBDeviceEndPointCfg(); // Endpoint configuration
+  USBDeviceIntCfg();      // Interrupt configuration
+  UEP0_T_LEN = 0;
+  UEP1_T_LEN = 0; // Pre-use send length must be cleared
+  UEP2_T_LEN = 0;
+}
+
+void USB_EP1_IN() {
+  UEP1_T_LEN = 0;
+  UEP1_CTRL = UEP1_CTRL & ~MASK_UEP_T_RES | UEP_T_RES_NAK; // Default NAK
+  UpPoint1_Busy = 0;                                       // Clear busy flag
+}
+
+void USB_EP1_OUT() {
+  if (U_TOG_OK) // Discard unsynchronized packets
+  {
+    if (Ep1Buffer[0] == 1) {
+      keyboardLedStatus = Ep1Buffer[1];
+    }
+  }
+}
+
+uint8_t USB_EP1_send(__data uint8_t reportID) {
+  if (UsbConfig == 0) {
+    return 0;
+  }
+
+  __data uint16_t waitWriteCount = 0;
+
+  waitWriteCount = 0;
+  while (UpPoint1_Busy) { // wait for 250ms or give up
+    waitWriteCount++;
+    delayMicroseconds(5);
+    if (waitWriteCount >= 50000)
+      return 0;
+  }
+
+  if (reportID == 1) {
+    Ep1Buffer[64 + 0] = 1;
+    for (__data uint8_t i = 0; i < sizeof(HIDKey); i++) { // load data for
+                                                          // upload
+      Ep1Buffer[64 + 1 + i] = HIDKey[i];
+    }
+    UEP1_T_LEN = 1 + sizeof(HIDKey); // data length
+  } else if (reportID == 2) {
+    Ep1Buffer[64 + 0] = 2;
+    for (__data uint8_t i = 0; i < sizeof(HIDMouse);
+         i++) { // load data for upload
+      Ep1Buffer[64 + 1 + i] = ((uint8_t *)HIDMouse)[i];
+    }
+    UEP1_T_LEN = 1 + sizeof(HIDMouse); // data length
+  } else {
+    UEP1_T_LEN = 0;
+  }
+
+  UpPoint1_Busy = 1;
+  UEP1_CTRL = UEP1_CTRL & ~MASK_UEP_T_RES |
+              UEP_T_RES_ACK; // upload data and respond ACK
+
+  return 1;
+}
+
+uint8_t Keyboard_press(__data uint8_t k) {
+  __data uint8_t i;
+  if (k >= 136) { // it's a non-printing key (not a modifier)
+    k = k - 136;
+  } else if (k >= 128) { // it's a modifier key
+    HIDKey[0] |= (1 << (k - 128));
+    k = 0;
+  } else { // it's a printing key
+    k = _asciimap[k];
+    if (!k) {
+      // setWriteError();
+      return 0;
+    }
+    if (k &
+        0x80) { // it's a capital letter or other character reached with shift
+      HIDKey[0] |= 0x02; // the left shift modifier
+      k &= 0x7F;
+    }
+  }
+
+  // Add k to the key report only if it's not already present
+  // and if there is an empty slot.
+  if (HIDKey[2] != k && HIDKey[3] != k && HIDKey[4] != k && HIDKey[5] != k &&
+      HIDKey[6] != k && HIDKey[7] != k) {
+
+    for (i = 2; i < 8; i++) {
+      if (HIDKey[i] == 0x00) {
+        HIDKey[i] = k;
+        break;
+      }
+    }
+    if (i == 8) {
+      // setWriteError();
+      return 0;
+    }
+  }
+  USB_EP1_send(1);
+  return 1;
+}
+
+uint8_t Keyboard_release(__data uint8_t k) {
+  __data uint8_t i;
+  if (k >= 136) { // it's a non-printing key (not a modifier)
+    k = k - 136;
+  } else if (k >= 128) { // it's a modifier key
+    HIDKey[0] &= ~(1 << (k - 128));
+    k = 0;
+  } else { // it's a printing key
+    k = _asciimap[k];
+    if (!k) {
+      return 0;
+    }
+    if (k &
+        0x80) { // it's a capital letter or other character reached with shift
+      HIDKey[0] &= ~(0x02); // the left shift modifier
+      k &= 0x7F;
+    }
+  }
+
+  // Test the key report to see if k is present.  Clear it if it exists.
+  // Check all positions in case the key is present more than once (which it
+  // shouldn't be)
+  for (i = 2; i < 8; i++) {
+    if (0 != k && HIDKey[i] == k) {
+      HIDKey[i] = 0x00;
+    }
+  }
+
+  USB_EP1_send(1);
+  return 1;
+}
+
+void Keyboard_releaseAll(void) {
+  for (__data uint8_t i = 0; i < sizeof(HIDKey); i++) { // load data for upload
+    HIDKey[i] = 0;
+  }
+  USB_EP1_send(1);
+}
+
+uint8_t Keyboard_write(__data uint8_t c) {
+  __data uint8_t p = Keyboard_press(c); // Keydown
+  Keyboard_release(c);                  // Keyup
+  return p; // just return the result of press() since release() almost always
+            // returns 1
+}
+
+void Keyboard_print(const char *str) {
+  // using a generic pointer to handle pointer in any address space
+  __data uint8_t c;
+  while ((c = *str++)) {
+    Keyboard_write(c);
+  }
+}
+
+uint8_t Keyboard_getLEDStatus() {
+  // keyboardLedStatus is updated from USB_EP1_OUT
+  return keyboardLedStatus;
+}
+
+uint8_t Mouse_press(__data uint8_t k) {
+  HIDMouse[0] |= k;
+  USB_EP1_send(2);
+  return 1;
+}
+
+uint8_t Mouse_release(__data uint8_t k) {
+  HIDMouse[0] &= ~k;
+  USB_EP1_send(2);
+  return 1;
+}
+
+uint8_t Mouse_click(__data uint8_t k) {
+  Mouse_press(k);
+  delayMicroseconds(10000);
+  Mouse_release(k);
+  return 1;
+}
+
+uint8_t Mouse_move(__data int8_t x, __xdata int8_t y) {
+  HIDMouse[1] = x;
+  HIDMouse[2] = y;
+  USB_EP1_send(2);
+  return 1;
+}
+
+uint8_t Mouse_scroll(__data int8_t tilt) {
+  HIDMouse[3] = tilt;
+  USB_EP1_send(2);
+  return 1;
+}

usbkvm/usbkvm_fw/src/remdesHid/USBHIDKeyboardMouse.h

@@ -0,0 +1,90 @@
+#ifndef __USB_HID_KBD_H__
+#define __USB_HID_KBD_H__
+
+// clang-format off
+#include <stdint.h>
+#include "include/ch5xx.h"
+#include "include/ch5xx_usb.h"
+// clang-format on
+
+#define KEY_LEFT_CTRL 0x80
+#define KEY_LEFT_SHIFT 0x81
+#define KEY_LEFT_ALT 0x82
+#define KEY_LEFT_GUI 0x83
+#define KEY_RIGHT_CTRL 0x84
+#define KEY_RIGHT_SHIFT 0x85
+#define KEY_RIGHT_ALT 0x86
+#define KEY_RIGHT_GUI 0x87
+
+#define KEY_UP_ARROW 0xDA
+#define KEY_DOWN_ARROW 0xD9
+#define KEY_LEFT_ARROW 0xD8
+#define KEY_RIGHT_ARROW 0xD7
+#define KEY_BACKSPACE 0xB2
+#define KEY_TAB 0xB3
+#define KEY_RETURN 0xB0
+#define KEY_ESC 0xB1
+#define KEY_INSERT 0xD1
+#define KEY_DELETE 0xD4
+#define KEY_PAGE_UP 0xD3
+#define KEY_PAGE_DOWN 0xD6
+#define KEY_HOME 0xD2
+#define KEY_END 0xD5
+#define KEY_CAPS_LOCK 0xC1
+#define KEY_F1 0xC2
+#define KEY_F2 0xC3
+#define KEY_F3 0xC4
+#define KEY_F4 0xC5
+#define KEY_F5 0xC6
+#define KEY_F6 0xC7
+#define KEY_F7 0xC8
+#define KEY_F8 0xC9
+#define KEY_F9 0xCA
+#define KEY_F10 0xCB
+#define KEY_F11 0xCC
+#define KEY_F12 0xCD
+#define KEY_F13 0xF0
+#define KEY_F14 0xF1
+#define KEY_F15 0xF2
+#define KEY_F16 0xF3
+#define KEY_F17 0xF4
+#define KEY_F18 0xF5
+#define KEY_F19 0xF6
+#define KEY_F20 0xF7
+#define KEY_F21 0xF8
+#define KEY_F22 0xF9
+#define KEY_F23 0xFA
+#define KEY_F24 0xFB
+
+enum MOUSE_BUTTON {
+  MOUSE_LEFT = 1,
+  MOUSE_RIGHT = 2,
+  MOUSE_MIDDLE = 4,
+};
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+void USBInit(void);
+
+uint8_t Keyboard_press(__data uint8_t k);
+uint8_t Keyboard_release(__data uint8_t k);
+void Keyboard_releaseAll(void);
+
+uint8_t Keyboard_write(__data uint8_t c);
+void Keyboard_print(const char *str);
+
+uint8_t Keyboard_getLEDStatus();
+
+uint8_t Mouse_press(__data uint8_t k);
+uint8_t Mouse_release(__data uint8_t k);
+uint8_t Mouse_click(__data uint8_t k);
+uint8_t Mouse_move(__data int8_t x, __xdata int8_t y);
+uint8_t Mouse_scroll(__data int8_t tilt);
+
+#ifdef __cplusplus
+} // extern "C"
+#endif
+
+#endif

usbkvm/usbkvm_fw/src/remdesHid/USBconstant.c

@@ -0,0 +1,194 @@
+#include "USBconstant.h"
+
+// Device descriptor
+__code USB_Descriptor_Device_t DeviceDescriptor = {
+    .Header = {.Size = sizeof(USB_Descriptor_Device_t), .Type = DTYPE_Device},
+
+    .USBSpecification = VERSION_BCD(1, 1, 0),
+    .Class = 0x00,
+    .SubClass = 0x00,
+    .Protocol = 0x00,
+
+    .Endpoint0Size = DEFAULT_ENDP0_SIZE,
+
+    .VendorID = 0x1209,
+    .ProductID = 0xc55D,
+    .ReleaseNumber = VERSION_BCD(1, 0, 0),
+
+    .ManufacturerStrIndex = 1,
+    .ProductStrIndex = 2,
+    .SerialNumStrIndex = 3,
+
+    .NumberOfConfigurations = 1};
+
+/** Configuration descriptor structure. This descriptor, located in FLASH
+ * memory, describes the usage of the device in one of its supported
+ * configurations, including information about any device interfaces and
+ * endpoints. The descriptor is read out by the USB host during the enumeration
+ * process when selecting a configuration so that the host may correctly
+ * communicate with the USB device.
+ */
+__code USB_Descriptor_Configuration_t ConfigurationDescriptor = {
+    .Config = {.Header = {.Size = sizeof(USB_Descriptor_Configuration_Header_t),
+                          .Type = DTYPE_Configuration},
+
+               .TotalConfigurationSize = sizeof(USB_Descriptor_Configuration_t),
+               .TotalInterfaces = 1,
+
+               .ConfigurationNumber = 1,
+               .ConfigurationStrIndex = NO_DESCRIPTOR,
+
+               .ConfigAttributes = (USB_CONFIG_ATTR_RESERVED),
+
+               .MaxPowerConsumption = USB_CONFIG_POWER_MA(200)},
+
+    .HID_Interface = {.Header = {.Size = sizeof(USB_Descriptor_Interface_t),
+                                 .Type = DTYPE_Interface},
+
+                      .InterfaceNumber = 0,
+                      .AlternateSetting = 0x00,
+
+                      .TotalEndpoints = 2,
+
+                      .Class = HID_CSCP_HIDClass,
+                      .SubClass = HID_CSCP_BootSubclass,
+                      .Protocol = HID_CSCP_KeyboardBootProtocol,
+
+                      .InterfaceStrIndex = NO_DESCRIPTOR},
+
+    .HID_KeyboardHID = {.Header = {.Size = sizeof(USB_HID_Descriptor_HID_t),
+                                   .Type = HID_DTYPE_HID},
+
+                        .HIDSpec = VERSION_BCD(1, 1, 0),
+                        .CountryCode = 0x00,
+                        .TotalReportDescriptors = 1,
+                        .HIDReportType = HID_DTYPE_Report,
+                        .HIDReportLength = sizeof(ReportDescriptor)},
+
+    .HID_ReportINEndpoint = {.Header = {.Size =
+                                            sizeof(USB_Descriptor_Endpoint_t),
+                                        .Type = DTYPE_Endpoint},
+
+                             .EndpointAddress = KEYBOARD_EPADDR,
+                             .Attributes =
+                                 (EP_TYPE_INTERRUPT | ENDPOINT_ATTR_NO_SYNC |
+                                  ENDPOINT_USAGE_DATA),
+                             .EndpointSize = KEYBOARD_MOUSE_EPSIZE,
+                             .PollingIntervalMS = 10},
+
+    .HID_ReportOUTEndpoint = {.Header = {.Size =
+                                             sizeof(USB_Descriptor_Endpoint_t),
+                                         .Type = DTYPE_Endpoint},
+
+                              .EndpointAddress = KEYBOARD_LED_EPADDR,
+                              .Attributes =
+                                  (EP_TYPE_INTERRUPT | ENDPOINT_ATTR_NO_SYNC |
+                                   ENDPOINT_USAGE_DATA),
+                              .EndpointSize = KEYBOARD_MOUSE_EPSIZE,
+                              .PollingIntervalMS = 10},
+};
+
+__code uint8_t ReportDescriptor[] = {
+    0x05, 0x01,       // USAGE_PAGE (Generic Desktop)
+    0x09, 0x06,       // USAGE (Keyboard)
+    0xa1, 0x01,       // COLLECTION (Application)
+    0x85, 0x01,       //   REPORT_ID (1)
+    0x05, 0x07,       //   USAGE_PAGE (Keyboard)
+    0x19, 0xe0,       //   USAGE_MINIMUM (Keyboard LeftControl)
+    0x29, 0xe7,       //   USAGE_MAXIMUM (Keyboard Right GUI)
+    0x15, 0x00,       //   LOGICAL_MINIMUM (0)
+    0x25, 0x01,       //   LOGICAL_MAXIMUM (1)
+    0x95, 0x08,       //   REPORT_COUNT (8)
+    0x75, 0x01,       //   REPORT_SIZE (1)
+    0x81, 0x02,       //   INPUT (Data,Var,Abs)
+    0x95, 0x01,       //   REPORT_COUNT (1)
+    0x75, 0x08,       //   REPORT_SIZE (8)
+    0x81, 0x03,       //   INPUT (Cnst,Var,Abs)
+    0x95, 0x06,       //   REPORT_COUNT (6)
+    0x75, 0x08,       //   REPORT_SIZE (8)
+    0x15, 0x00,       //   LOGICAL_MINIMUM (0)
+    0x26, 0xff, 0x00, //   LOGICAL_MAXIMUM (255)
+    0x05, 0x07,       //   USAGE_PAGE (Keyboard)
+    0x19, 0x00,       //   USAGE_MINIMUM (Reserved (no event indicated))
+    0x29, 0xe7,       //   USAGE_MAXIMUM (Keyboard Right GUI)
+    0x81, 0x00,       //   INPUT (Data,Ary,Abs)
+    0x05, 0x08,       //   USAGE_PAGE (LEDs)
+    0x19, 0x01,       //   USAGE_MINIMUM (Num Lock)
+    0x29, 0x05,       //   USAGE_MAXIMUM (Kana)
+    0x15, 0x00,       //   LOGICAL_MINIMUM (0)
+    0x25, 0x01,       //   LOGICAL_MAXIMUM (1)
+    0x95, 0x05,       //   REPORT_COUNT (5)
+    0x75, 0x01,       //   REPORT_SIZE (1)
+    0x91, 0x02,       //   OUTPUT (Data,Var,Abs)
+    0x95, 0x01,       //   REPORT_COUNT (1)
+    0x75, 0x03,       //   REPORT_SIZE (3)
+    0x91, 0x03,       //   OUTPUT (Cnst,Var,Abs)
+    0xc0,             // END_COLLECTION
+    0x05, 0x01,       // USAGE_PAGE (Generic Desktop)
+    0x09, 0x02,       // USAGE (Mouse)
+    0xa1, 0x01,       // COLLECTION (Application)
+    0x09, 0x01,       //   USAGE (Pointer)
+    0xa1, 0x00,       //   COLLECTION (Physical)
+    0x85, 0x02,       //   REPORT_ID (2)
+    0x05, 0x09,       //     USAGE_PAGE (Button)
+    0x19, 0x01,       //     USAGE_MINIMUM (Button 1)
+    0x29, 0x03,       //     USAGE_MAXIMUM (Button 3)
+    0x15, 0x00,       //     LOGICAL_MINIMUM (0)
+    0x25, 0x01,       //     LOGICAL_MAXIMUM (1)
+    0x95, 0x03,       //     REPORT_COUNT (3)
+    0x75, 0x01,       //     REPORT_SIZE (1)
+    0x81, 0x02,       //     INPUT (Data,Var,Abs)
+    0x95, 0x01,       //     REPORT_COUNT (1)
+    0x75, 0x05,       //     REPORT_SIZE (5)
+    0x81, 0x03,       //     INPUT (Cnst,Var,Abs)
+    0x05, 0x01,       //     USAGE_PAGE (Generic Desktop)
+    0x09, 0x30,       //     USAGE (X)
+    0x09, 0x31,       //     USAGE (Y)
+    0x09, 0x38,       //     USAGE (Wheel)
+    0x15, 0x81,       //     LOGICAL_MINIMUM (-127)
+    0x25, 0x7f,       //     LOGICAL_MAXIMUM (127)
+    0x75, 0x08,       //     REPORT_SIZE (8)
+    0x95, 0x03,       //     REPORT_COUNT (3)
+    0x81, 0x06,       //     INPUT (Data,Var,Rel)
+    0xc0,             //     END_COLLECTION
+    0xc0              // END_COLLECTION
+};
+
+// String Descriptors
+__code uint8_t LanguageDescriptor[] = {0x04, 0x03, 0x09,
+                                       0x04}; // Language Descriptor
+__code uint16_t SerialDescriptor[] = {
+    // Serial String Descriptor
+    (((13 + 1) * 2) | (DTYPE_String << 8)),
+    'C',
+    'H',
+    '5',
+    '5',
+    'x',
+    ' ',
+    'k',
+    'b',
+    'd',
+    ' ',
+    'm',
+    'o',
+    's',
+};
+__code uint16_t ProductDescriptor[] = {
+    // Produce String Descriptor
+    (((10 + 1) * 2) | (DTYPE_String << 8)),
+    'C',
+    'H',
+    '5',
+    '5',
+    'x',
+    'd',
+    'u',
+    'i',
+    'n',
+    'o',
+};
+__code uint16_t ManufacturerDescriptor[] = {
+    // SDCC is little endian
+    (((6 + 1) * 2) | (DTYPE_String << 8)), 'D', 'e', 'q', 'i', 'n', 'g',
+};

usbkvm/usbkvm_fw/src/remdesHid/USBconstant.h

@@ -0,0 +1,42 @@
+#ifndef __USB_CONST_DATA_H__
+#define __USB_CONST_DATA_H__
+
+// clang-format off
+#include <stdint.h>
+#include "include/ch5xx.h"
+#include "include/ch5xx_usb.h"
+#include "StdDescriptors.h"
+#include "HIDClassCommon.h"
+// clang-format on
+
+#define EP0_ADDR 0
+#define EP1_ADDR 10
+
+#define KEYBOARD_EPADDR 0x81
+#define KEYBOARD_LED_EPADDR 0x01
+#define KEYBOARD_MOUSE_EPSIZE 9
+
+/** Type define for the device configuration descriptor structure. This must be
+ * defined in the application code, as the configuration descriptor contains
+ * several sub-descriptors which vary between devices, and which describe the
+ * device's usage to the host.
+ */
+typedef struct {
+  USB_Descriptor_Configuration_Header_t Config;
+
+  // Keyboard HID Interface
+  USB_Descriptor_Interface_t HID_Interface;
+  USB_HID_Descriptor_HID_t HID_KeyboardHID;
+  USB_Descriptor_Endpoint_t HID_ReportINEndpoint;
+  USB_Descriptor_Endpoint_t HID_ReportOUTEndpoint;
+} USB_Descriptor_Configuration_t;
+
+extern __code USB_Descriptor_Device_t DeviceDescriptor;
+extern __code USB_Descriptor_Configuration_t ConfigurationDescriptor;
+extern __code uint8_t ReportDescriptor[];
+extern __code uint8_t LanguageDescriptor[];
+extern __code uint16_t SerialDescriptor[];
+extern __code uint16_t ProductDescriptor[];
+extern __code uint16_t ManufacturerDescriptor[];
+
+#endif

usbkvm/usbkvm_fw/src/remdesHid/USBhandler.c

@@ -0,0 +1,518 @@
+/*
+ created by Deqing Sun for use with CH55xduino
+ */
+
+#include "USBhandler.h"
+
+#include "USBconstant.h"
+
+// Keyboard functions:
+
+void USB_EP2_IN();
+void USB_EP2_OUT();
+
+// clang-format off
+__xdata __at (EP0_ADDR) uint8_t Ep0Buffer[8];
+__xdata __at (EP1_ADDR) uint8_t Ep1Buffer[128];       //on page 47 of data sheet, the receive buffer need to be min(possible packet size+2,64), IN and OUT buffer, must be even address
+// clang-format on
+
+#if (EP1_ADDR + 128) > USER_USB_RAM
+#error "This example needs more USB ram. Increase this setting in menu."
+#endif
+
+__data uint16_t SetupLen;
+__data uint8_t SetupReq;
+volatile __xdata uint8_t UsbConfig;
+
+__code uint8_t *__data pDescr;
+
+volatile uint8_t usbMsgFlags = 0; // uint8_t usbMsgFlags copied from VUSB
+
+inline void NOP_Process(void) {}
+
+void USB_EP0_SETUP() {
+  __data uint8_t len = USB_RX_LEN;
+  if (len == (sizeof(USB_SETUP_REQ))) {
+    SetupLen = ((uint16_t)UsbSetupBuf->wLengthH << 8) | (UsbSetupBuf->wLengthL);
+    len = 0; // Default is success and upload 0 length
+    SetupReq = UsbSetupBuf->bRequest;
+    usbMsgFlags = 0;
+    if ((UsbSetupBuf->bRequestType & USB_REQ_TYP_MASK) !=
+        USB_REQ_TYP_STANDARD) // Not standard request
+    {
+
+      // here is the commnunication starts, refer to usbFunctionSetup of USBtiny
+      // or usb_setup in usbtiny
+
+      switch ((UsbSetupBuf->bRequestType & USB_REQ_TYP_MASK)) {
+      case USB_REQ_TYP_VENDOR: {
+        switch (SetupReq) {
+        default:
+          len = 0xFF; // command not supported
+          break;
+        }
+        break;
+      }
+      case USB_REQ_TYP_CLASS: {
+        switch (SetupReq) {
+        default:
+          len = 0xFF; // command not supported
+          break;
+        }
+        break;
+      }
+      default:
+        len = 0xFF; // command not supported
+        break;
+      }
+
+    } else // Standard request
+    {
+      switch (SetupReq) // Request ccfType
+      {
+      case USB_GET_DESCRIPTOR:
+        switch (UsbSetupBuf->wValueH) {
+        case 1: // Device Descriptor
+          pDescr = (__code uint8_t *)
+              DeviceDescriptor; // Put Device Descriptor into outgoing buffer
+          len = sizeof(USB_Descriptor_Device_t);
+          break;
+        case 2: // Configure Descriptor
+          pDescr = (__code uint8_t *)ConfigurationDescriptor;
+          len = sizeof(USB_Descriptor_Configuration_t);
+          break;
+        case 3:
+          if (UsbSetupBuf->wValueL == 0) {
+            pDescr = LanguageDescriptor;
+          } else if (UsbSetupBuf->wValueL == 1) {
+            pDescr = (__code uint8_t *)ManufacturerDescriptor;
+          } else if (UsbSetupBuf->wValueL == 2) {
+            pDescr = (__code uint8_t *)ProductDescriptor;
+          } else if (UsbSetupBuf->wValueL == 3) {
+            pDescr = (__code uint8_t *)SerialDescriptor;
+          } else {
+            len = 0xff;
+            break;
+          }
+          len = pDescr[0];
+          break;
+        case 0x22:
+          if (UsbSetupBuf->wValueL == 0) {
+            pDescr = (__code uint8_t *)ReportDescriptor;
+            len = ConfigurationDescriptor.HID_KeyboardHID.HIDReportLength;
+          } else {
+            len = 0xff;
+          }
+          break;
+        default:
+          len = 0xff; // Unsupported descriptors or error
+          break;
+        }
+        if (len != 0xff) {
+          if (SetupLen > len) {
+            SetupLen = len; // Limit length
+          }
+          len = SetupLen >= DEFAULT_ENDP0_SIZE
+                    ? DEFAULT_ENDP0_SIZE
+                    : SetupLen; // transmit length for this packet
+          for (__data uint8_t i = 0; i < len; i++) {
+            Ep0Buffer[i] = pDescr[i];
+          }
+          SetupLen -= len;
+          pDescr += len;
+        }
+        break;
+      case USB_SET_ADDRESS:
+        SetupLen = UsbSetupBuf->wValueL; // Save the assigned address
+        break;
+      case USB_GET_CONFIGURATION:
+        Ep0Buffer[0] = UsbConfig;
+        if (SetupLen >= 1) {
+          len = 1;
+        }
+        break;
+      case USB_SET_CONFIGURATION:
+        UsbConfig = UsbSetupBuf->wValueL;
+        break;
+      case USB_GET_INTERFACE:
+        break;
+      case USB_SET_INTERFACE:
+        break;
+      case USB_CLEAR_FEATURE: // Clear Feature
+        if ((UsbSetupBuf->bRequestType & 0x1F) ==
+            USB_REQ_RECIP_DEVICE) // Clear the device featuee.
+        {
+          if ((((uint16_t)UsbSetupBuf->wValueH << 8) | UsbSetupBuf->wValueL) ==
+              0x01) {
+            if (ConfigurationDescriptor.Config.ConfigAttributes & 0x20) {
+              // wake up
+            } else {
+              len = 0xFF; // Failed
+            }
+          } else {
+            len = 0xFF; // Failed
+          }
+        } else if ((UsbSetupBuf->bRequestType & USB_REQ_RECIP_MASK) ==
+                   USB_REQ_RECIP_ENDP) // endpoint
+        {
+          switch (UsbSetupBuf->wIndexL) {
+          case 0x84:
+            UEP4_CTRL =
+                UEP4_CTRL & ~(bUEP_T_TOG | MASK_UEP_T_RES) | UEP_T_RES_NAK;
+            break;
+          case 0x04:
+            UEP4_CTRL =
+                UEP4_CTRL & ~(bUEP_R_TOG | MASK_UEP_R_RES) | UEP_R_RES_ACK;
+            break;
+          case 0x83:
+            UEP3_CTRL =
+                UEP3_CTRL & ~(bUEP_T_TOG | MASK_UEP_T_RES) | UEP_T_RES_NAK;
+            break;
+          case 0x03:
+            UEP3_CTRL =
+                UEP3_CTRL & ~(bUEP_R_TOG | MASK_UEP_R_RES) | UEP_R_RES_ACK;
+            break;
+          case 0x82:
+            UEP2_CTRL =
+                UEP2_CTRL & ~(bUEP_T_TOG | MASK_UEP_T_RES) | UEP_T_RES_NAK;
+            break;
+          case 0x02:
+            UEP2_CTRL =
+                UEP2_CTRL & ~(bUEP_R_TOG | MASK_UEP_R_RES) | UEP_R_RES_ACK;
+            break;
+          case 0x81:
+            UEP1_CTRL =
+                UEP1_CTRL & ~(bUEP_T_TOG | MASK_UEP_T_RES) | UEP_T_RES_NAK;
+            break;
+          case 0x01:
+            UEP1_CTRL =
+                UEP1_CTRL & ~(bUEP_R_TOG | MASK_UEP_R_RES) | UEP_R_RES_ACK;
+            break;
+          default:
+            len = 0xFF; // Unsupported endpoint
+            break;
+          }
+        } else {
+          len = 0xFF; // Unsupported for non-endpoint
+        }
+        break;
+      case USB_SET_FEATURE: // Set Feature
+        if ((UsbSetupBuf->bRequestType & 0x1F) ==
+            USB_REQ_RECIP_DEVICE) // Set  the device featuee.
+        {
+          if ((((uint16_t)UsbSetupBuf->wValueH << 8) | UsbSetupBuf->wValueL) ==
+              0x01) {
+            if (ConfigurationDescriptor.Config.ConfigAttributes & 0x20) {
+              // suspend
+
+              // while ( XBUS_AUX & bUART0_TX );    //Wait till uart0 sending
+              // complete SAFE_MOD = 0x55; SAFE_MOD = 0xAA; WAKE_CTRL =
+              // bWAK_BY_USB | bWAK_RXD0_LO | bWAK_RXD1_LO; //wake up by USB or
+              // RXD0/1 signal PCON |= PD; //sleep SAFE_MOD = 0x55; SAFE_MOD =
+              // 0xAA; WAKE_CTRL = 0x00;
+            } else {
+              len = 0xFF; // Failed
+            }
+          } else {
+            len = 0xFF; // Failed
+          }
+        } else if ((UsbSetupBuf->bRequestType & 0x1F) ==
+                   USB_REQ_RECIP_ENDP) // endpoint
+        {
+          if ((((uint16_t)UsbSetupBuf->wValueH << 8) | UsbSetupBuf->wValueL) ==
+              0x00) {
+            switch (((uint16_t)UsbSetupBuf->wIndexH << 8) |
+                    UsbSetupBuf->wIndexL) {
+            case 0x84:
+              UEP4_CTRL = UEP4_CTRL & (~bUEP_T_TOG) |
+                          UEP_T_RES_STALL; // Set endpoint4 IN STALL
+              break;
+            case 0x04:
+              UEP4_CTRL = UEP4_CTRL & (~bUEP_R_TOG) |
+                          UEP_R_RES_STALL; // Set endpoint4 OUT Stall
+              break;
+            case 0x83:
+              UEP3_CTRL = UEP3_CTRL & (~bUEP_T_TOG) |
+                          UEP_T_RES_STALL; // Set endpoint3 IN STALL
+              break;
+            case 0x03:
+              UEP3_CTRL = UEP3_CTRL & (~bUEP_R_TOG) |
+                          UEP_R_RES_STALL; // Set endpoint3 OUT Stall
+              break;
+            case 0x82:
+              UEP2_CTRL = UEP2_CTRL & (~bUEP_T_TOG) |
+                          UEP_T_RES_STALL; // Set endpoint2 IN STALL
+              break;
+            case 0x02:
+              UEP2_CTRL = UEP2_CTRL & (~bUEP_R_TOG) |
+                          UEP_R_RES_STALL; // Set endpoint2 OUT Stall
+              break;
+            case 0x81:
+              UEP1_CTRL = UEP1_CTRL & (~bUEP_T_TOG) |
+                          UEP_T_RES_STALL; // Set endpoint1 IN STALL
+              break;
+            case 0x01:
+              UEP1_CTRL = UEP1_CTRL & (~bUEP_R_TOG) |
+                          UEP_R_RES_STALL; // Set endpoint1 OUT Stall
+            default:
+              len = 0xFF; // Failed
+              break;
+            }
+          } else {
+            len = 0xFF; // Failed
+          }
+        } else {
+          len = 0xFF; // Failed
+        }
+        break;
+      case USB_GET_STATUS:
+        Ep0Buffer[0] = 0x00;
+        Ep0Buffer[1] = 0x00;
+        if (SetupLen >= 2) {
+          len = 2;
+        } else {
+          len = SetupLen;
+        }
+        break;
+      default:
+        len = 0xff; // Failed
+        break;
+      }
+    }
+  } else {
+    len = 0xff; // Wrong packet length
+  }
+  if (len == 0xff) {
+    SetupReq = 0xFF;
+    UEP0_CTRL =
+        bUEP_R_TOG | bUEP_T_TOG | UEP_R_RES_STALL | UEP_T_RES_STALL; // STALL
+  } else if (len <=
+             DEFAULT_ENDP0_SIZE) // Tx data to host or send 0-length packet
+  {
+    UEP0_T_LEN = len;
+    UEP0_CTRL = bUEP_R_TOG | bUEP_T_TOG | UEP_R_RES_ACK |
+                UEP_T_RES_ACK; // Expect DATA1, Answer ACK
+  } else {
+    UEP0_T_LEN = 0; // Tx data to host or send 0-length packet
+    UEP0_CTRL = bUEP_R_TOG | bUEP_T_TOG | UEP_R_RES_ACK |
+                UEP_T_RES_ACK; // Expect DATA1, Answer ACK
+  }
+}
+
+void USB_EP0_IN() {
+  switch (SetupReq) {
+  case USB_GET_DESCRIPTOR: {
+    __data uint8_t len = SetupLen >= DEFAULT_ENDP0_SIZE
+                             ? DEFAULT_ENDP0_SIZE
+                             : SetupLen; // send length
+    for (__data uint8_t i = 0; i < len; i++) {
+      Ep0Buffer[i] = pDescr[i];
+    }
+    // memcpy( Ep0Buffer, pDescr, len );
+    SetupLen -= len;
+    pDescr += len;
+    UEP0_T_LEN = len;
+    UEP0_CTRL ^= bUEP_T_TOG; // Switch between DATA0 and DATA1
+  } break;
+  case USB_SET_ADDRESS:
+    USB_DEV_AD = USB_DEV_AD & bUDA_GP_BIT | SetupLen;
+    UEP0_CTRL = UEP_R_RES_ACK | UEP_T_RES_NAK;
+    break;
+  default:
+    UEP0_T_LEN = 0; // End of transaction
+    UEP0_CTRL = UEP_R_RES_ACK | UEP_T_RES_NAK;
+    break;
+  }
+}
+
+void USB_EP0_OUT() {
+  {
+    UEP0_T_LEN = 0;
+    UEP0_CTRL |= UEP_R_RES_ACK | UEP_T_RES_NAK; // Respond Nak
+  }
+}
+
+#pragma save
+#pragma nooverlay
+void USBInterrupt(void) { // inline not really working in multiple files in SDCC
+  if (UIF_TRANSFER) {
+    // Dispatch to service functions
+    __data uint8_t callIndex = USB_INT_ST & MASK_UIS_ENDP;
+    switch (USB_INT_ST & MASK_UIS_TOKEN) {
+    case UIS_TOKEN_OUT: { // SDCC will take IRAM if array of function pointer is
+                          // used.
+      switch (callIndex) {
+      case 0:
+        EP0_OUT_Callback();
+        break;
+      case 1:
+        EP1_OUT_Callback();
+        break;
+      case 2:
+        EP2_OUT_Callback();
+        break;
+      case 3:
+        EP3_OUT_Callback();
+        break;
+      case 4:
+        EP4_OUT_Callback();
+        break;
+      default:
+        break;
+      }
+    } break;
+    case UIS_TOKEN_SOF: { // SDCC will take IRAM if array of function pointer is
+                          // used.
+      switch (callIndex) {
+      case 0:
+        EP0_SOF_Callback();
+        break;
+      case 1:
+        EP1_SOF_Callback();
+        break;
+      case 2:
+        EP2_SOF_Callback();
+        break;
+      case 3:
+        EP3_SOF_Callback();
+        break;
+      case 4:
+        EP4_SOF_Callback();
+        break;
+      default:
+        break;
+      }
+    } break;
+    case UIS_TOKEN_IN: { // SDCC will take IRAM if array of function pointer is
+                         // used.
+      switch (callIndex) {
+      case 0:
+        EP0_IN_Callback();
+        break;
+      case 1:
+        EP1_IN_Callback();
+        break;
+      case 2:
+        EP2_IN_Callback();
+        break;
+      case 3:
+        EP3_IN_Callback();
+        break;
+      case 4:
+        EP4_IN_Callback();
+        break;
+      default:
+        break;
+      }
+    } break;
+    case UIS_TOKEN_SETUP: { // SDCC will take IRAM if array of function pointer
+                            // is used.
+      switch (callIndex) {
+      case 0:
+        EP0_SETUP_Callback();
+        break;
+      case 1:
+        EP1_SETUP_Callback();
+        break;
+      case 2:
+        EP2_SETUP_Callback();
+        break;
+      case 3:
+        EP3_SETUP_Callback();
+        break;
+      case 4:
+        EP4_SETUP_Callback();
+        break;
+      default:
+        break;
+      }
+    } break;
+    }
+
+    UIF_TRANSFER = 0; // Clear interrupt flag
+  }
+
+  // Device mode USB bus reset
+  if (UIF_BUS_RST) {
+    UEP0_CTRL = UEP_R_RES_ACK | UEP_T_RES_NAK;
+    UEP1_CTRL = bUEP_AUTO_TOG | UEP_T_RES_NAK | UEP_R_RES_ACK;
+
+    USB_DEV_AD = 0x00;
+    UIF_SUSPEND = 0;
+    UIF_TRANSFER = 0;
+    UIF_BUS_RST = 0;
+
+    UsbConfig = 0;
+
+    // Clear interrupt flag
+  }
+
+  // USB bus suspend / wake up
+  if (UIF_SUSPEND) {
+    UIF_SUSPEND = 0;
+    if (USB_MIS_ST & bUMS_SUSPEND) { // Suspend
+
+      // while ( XBUS_AUX & bUART0_TX );                    // Wait for Tx
+      // SAFE_MOD = 0x55;
+      // SAFE_MOD = 0xAA;
+      // WAKE_CTRL = bWAK_BY_USB | bWAK_RXD0_LO;    // Wake up by USB or RxD0
+      // PCON |= PD; // Chip sleep SAFE_MOD = 0x55; SAFE_MOD = 0xAA; WAKE_CTRL =
+      // 0x00;
+
+    } else {             // Unexpected interrupt, not supposed to happen !
+      USB_INT_FG = 0xFF; // Clear interrupt flag
+    }
+  }
+}
+#pragma restore
+
+void USBDeviceCfg() {
+  USB_CTRL = 0x00;            // Clear USB control register
+  USB_CTRL &= ~bUC_HOST_MODE; // This bit is the device selection mode
+  USB_CTRL |= bUC_DEV_PU_EN | bUC_INT_BUSY |
+              bUC_DMA_EN; // USB device and internal pull-up enable,
+                          // automatically return to NAK before interrupt flag
+                          // is cleared during interrupt
+  USB_DEV_AD = 0x00;      // Device address initialization
+  //     USB_CTRL |= bUC_LOW_SPEED;
+  //     UDEV_CTRL |= bUD_LOW_SPEED; //Run for 1.5M
+  USB_CTRL &= ~bUC_LOW_SPEED;
+  UDEV_CTRL &= ~bUD_LOW_SPEED; // Select full speed 12M mode, default mode
+#if defined(CH551) || defined(CH552) || defined(CH549)
+  UDEV_CTRL = bUD_PD_DIS; // Disable DP/DM pull-down resistor
+#endif
+#if defined(CH559)
+  UDEV_CTRL = bUD_DP_PD_DIS; // Disable DP/DM pull-down resistor
+#endif
+  UDEV_CTRL |= bUD_PORT_EN; // Enable physical port
+}
+
+void USBDeviceIntCfg() {
+  USB_INT_EN |= bUIE_SUSPEND;  // Enable device hang interrupt
+  USB_INT_EN |= bUIE_TRANSFER; // Enable USB transfer completion interrupt
+  USB_INT_EN |= bUIE_BUS_RST;  // Enable device mode USB bus reset interrupt
+  USB_INT_FG |= 0x1F;          // Clear interrupt flag
+  IE_USB = 1;                  // Enable USB interrupt
+  EA = 1;                      // Enable global interrupts
+}
+
+void USBDeviceEndPointCfg() {
+#if defined(CH559)
+  // CH559 use differend endianness for these registers
+  UEP0_DMA_H = ((uint16_t)Ep0Buffer >> 8); // Endpoint 0 data transfer address
+  UEP0_DMA_L = ((uint16_t)Ep0Buffer >> 0); // Endpoint 0 data transfer address
+  UEP1_DMA_H = ((uint16_t)Ep1Buffer >> 8); // Endpoint 1 data transfer address
+  UEP1_DMA_L = ((uint16_t)Ep1Buffer >> 0); // Endpoint 1 data transfer address
+#else
+  UEP0_DMA = (uint16_t)Ep0Buffer; // Endpoint 0 data transfer address
+  UEP1_DMA = (uint16_t)Ep1Buffer; // Endpoint 1 data transfer address
+#endif
+
+  UEP1_CTRL = bUEP_AUTO_TOG | UEP_T_RES_NAK |
+              UEP_R_RES_ACK; // Endpoint 2 automatically flips the sync flag, IN
+                             // transaction returns NAK, OUT returns ACK
+  UEP4_1_MOD = 0XC0;         // endpoint1 TX RX enable
+  UEP0_CTRL =
+      UEP_R_RES_ACK | UEP_T_RES_NAK; // Manual flip, OUT transaction returns
+                                     // ACK, IN transaction returns NAK
+}

usbkvm/usbkvm_fw/src/remdesHid/USBhandler.h

@@ -0,0 +1,60 @@
+#ifndef __USB_HANDLER_H__
+#define __USB_HANDLER_H__
+
+// clang-format off
+#include <stdint.h>
+#include "include/ch5xx.h"
+#include "include/ch5xx_usb.h"
+#include "USBconstant.h"
+// clang-format on
+
+// clang-format off
+extern __xdata __at (EP0_ADDR) uint8_t Ep0Buffer[];
+extern __xdata __at (EP1_ADDR) uint8_t Ep1Buffer[];
+// clang-format on
+
+extern __data uint16_t SetupLen;
+extern __data uint8_t SetupReq;
+volatile extern __xdata uint8_t UsbConfig;
+
+extern const __code uint8_t *__data pDescr;
+
+void USB_EP1_IN();
+void USB_EP1_OUT();
+
+#define UsbSetupBuf ((PUSB_SETUP_REQ)Ep0Buffer)
+
+// Out
+#define EP0_OUT_Callback USB_EP0_OUT
+#define EP1_OUT_Callback USB_EP1_OUT
+#define EP2_OUT_Callback NOP_Process
+#define EP3_OUT_Callback NOP_Process
+#define EP4_OUT_Callback NOP_Process
+
+// SOF
+#define EP0_SOF_Callback NOP_Process
+#define EP1_SOF_Callback NOP_Process
+#define EP2_SOF_Callback NOP_Process
+#define EP3_SOF_Callback NOP_Process
+#define EP4_SOF_Callback NOP_Process
+
+// IN
+#define EP0_IN_Callback USB_EP0_IN
+#define EP1_IN_Callback USB_EP1_IN
+#define EP2_IN_Callback NOP_Process
+#define EP3_IN_Callback NOP_Process
+#define EP4_IN_Callback NOP_Process
+
+// SETUP
+#define EP0_SETUP_Callback USB_EP0_SETUP
+#define EP1_SETUP_Callback NOP_Process
+#define EP2_SETUP_Callback NOP_Process
+#define EP3_SETUP_Callback NOP_Process
+#define EP4_SETUP_Callback NOP_Process
+
+void USBInterrupt(void);
+void USBDeviceCfg();
+void USBDeviceIntCfg();
+void USBDeviceEndPointCfg();
+
+#endif

usbkvm/usbkvm_fw/usbkvm_fw.h

@@ -0,0 +1,51 @@
+/*
+  usbkvm_fw.h
+  Author: tobychui
+
+*/
+#ifndef _usbkvm_
+#define _usbkvm_
+
+/* Hardware Configurations */
+#define LED_RW_SIG 16
+#define USB_SW_SEL 32
+
+/* Operation Types */
+#define OPR_TYPE_RESERVED 0x00           // Reserved
+#define OPR_TYPE_KEYBOARD_WRITE 0x01     // Keyboard-related operation
+#define OPR_TYPE_MOUSE_WRITE 0x02        // Mouse-related operation
+#define OPR_TYPE_SWITCH_WRITE 0x03       // Switch/button operation
+#define OPR_TYPE_LED_WRITE 0x04          // LED control operation
+#define OPR_TYPE_RESET_INSTR_COUNT 0xFE  // Reset instruction counter
+#define OPR_TYPE_DATA_RESET 0xFF         //Reset opr data queue, if state of device is unknown, clear before use
+
+/* Operation Sub-types */
+#define SUBTYPE_RESERVED 0x00
+
+/* Keyboard Subtypes */
+#define SUBTYPE_KEYBOARD_ASCII_WRITE 0x01         // Write ASCII characters (32-127)
+#define SUBTYPE_KEYBOARD_ASCII_PRESS 0x02         // Press a key (ASCII 32-127)
+#define SUBTYPE_KEYBOARD_ASCII_RELEASE 0x03       // Release a key (ASCII 32-127)
+#define SUBTYPE_KEYBOARD_MODIFIER_SET 0x04      // Modifier key write (bit flags)
+#define SUBTYPE_KEYBOARD_MODIFIER_CLEAR 0x05      // Modifier key press (bit flags)
+#define SUBTYPE_KEYBOARD_FUNCTKEY_WRITE 0x06      //Function key write
+#define SUBTYPE_KEYBOARD_OTHERKEY_PRESS 0x07      //Other keys press
+#define SUBTYPE_KEYBOARD_OTHERKEY_RELEASE 0x08    //Other keys release
+#define SUBTYPE_KEYBOARD_SPECIAL_CTRLALTDEL 0xFD  //Ctrl + Alt + Del
+#define SUBTYPE_KEYBOARD_SPECIAL_RESET 0xFE       //Reset all keypress state
+#define SUBTYPE_KEYBOARD_SPECIAL_RESERVED 0xFF    //Reserved
+
+/* Response Codes */
+#define resp_ok 0x00
+#define resp_unknown_opr 0x01
+#define resp_invalid_opr_type 0x02
+#define resp_invalid_key_value 0x03
+#define resp_not_implemented 0x04
+
+
+#define resp_start_of_debug_msg 0xE0
+#define resp_end_of_debug_msg 0xE1
+
+#define resp_start_of_err_msg 0xEE
+#define resp_end_of_err_msg 0xEF
+#endif

usbkvm/usbkvm_fw/usbkvm_fw.ino

@@ -0,0 +1,138 @@
+/*
+  RemdesKVM USB-KVM Firmware
+  Author: tobychui
+
+  This is the USB KVM part of RemdesKVM. 
+  It can be used seperately as a dedicated USB-KVM 
+  module as well as connected to a Linux SBC running
+  remdeskvmd via a USB 2.0 connection.
+
+  Upload Settings
+  CH552G 
+*/
+
+#ifndef USER_USB_RAM
+#error "This firmware needs to be compiled with a USER USB setting"
+#endif
+
+//#define ENABLE_DEBUG_PRINT
+
+#include "usbkvm_fw.h"
+#include "src/remdesHid/USBHIDKeyboardMouse.h"
+
+
+/*
+  instr_count store the current read index
+  index of current instruction, all instructions have 3 bytes
+  byte orders as follows
+  byte 0 = opr_type
+  byte 1 = opr_subtype
+  byte 2 = data
+*/
+uint8_t instr_count = 0;
+
+/*
+  opr_type defines the type of the incoming data
+  for the next byte. See usbkvm_fw.h for details.
+*/
+uint8_t opr_type = 0x00;
+
+/*
+  opr_subtype defines the sub-type of the operation
+  Based on opr_type, there will be different catergory
+  of operations. However, 0x00 is always reserved
+*/
+
+uint8_t opr_subtype = 0x00;
+uint8_t opr_payload = 0x00;
+
+uint8_t serial_data = 0x00;
+
+/* Function Prototypes */
+uint8_t keyboard_emulation(uint8_t, uint8_t);
+
+
+uint8_t kvm_execute_opr() {
+  switch (opr_type) {
+    case OPR_TYPE_RESERVED:
+      //Ping test
+      return resp_ok;
+    case OPR_TYPE_KEYBOARD_WRITE:
+      //keyboard operations
+      return keyboard_emulation(opr_subtype, opr_payload);
+    case OPR_TYPE_MOUSE_WRITE:
+      //mouse operations
+      return resp_ok;
+    default:
+      return resp_unknown_opr;
+  }
+  return resp_ok;
+}
+
+void setup() {
+  Serial0_begin(115200);
+  pinMode(USB_SW_SEL, OUTPUT);
+  pinMode(LED_RW_SIG, OUTPUT);
+  digitalWrite(LED_RW_SIG, HIGH);
+  digitalWrite(USB_SW_SEL, LOW);
+  USBInit();
+}
+
+void loop() {
+  if (Serial0_available()) {
+    serial_data = 0x00;
+    serial_data = Serial0_read();
+
+#ifdef ENABLE_DEBUG_PRINT
+    //Debug print the Serial input message
+    Serial0_write(resp_start_of_debug_msg);
+    Serial0_write(serial_data);
+    Serial0_write(resp_end_of_debug_msg);
+#endif
+
+    if (serial_data == OPR_TYPE_DATA_RESET) {
+      //Reset opr data
+      opr_type = 0x00;
+      opr_subtype = 0x00;
+      opr_payload = 0x00;
+      instr_count = 0;
+      Serial0_write(resp_ok);
+    } else if (instr_count == 0) {
+      //Set opr type
+      opr_type = serial_data;
+      instr_count++;
+      Serial0_write(resp_ok);
+    } else if (instr_count == 1) {
+      //Set opr subtype
+      opr_subtype = serial_data;
+      instr_count++;
+      Serial0_write(resp_ok);
+    } else {
+      opr_payload = serial_data;
+
+#ifdef ENABLE_DEBUG_PRINT
+      //Debug print the opr sequence
+      Serial0_write(resp_start_of_debug_msg);
+      Serial0_write(opr_type);
+      Serial0_write(opr_subtype);
+      Serial0_write(opr_payload);
+      Serial0_write(resp_end_of_debug_msg);
+#endif
+
+      //Execute the kvm operation
+      uint8_t err = kvm_execute_opr();
+      if (err != resp_ok) {
+        //Check if there are any execution error. If yes, return error code with 0xEE prefix
+        Serial0_write(resp_start_of_err_msg);
+        Serial0_write(err);
+        Serial0_write(resp_end_of_err_msg);
+      } else {
+        Serial0_write(resp_ok);
+      }
+
+      //Reset the instruction counter and ready for the next instruction
+      instr_count = 0;
+    }
+  }
+  delay(1);
+}