usb hid host support

Author: inc

Makefile

@@ -7,6 +7,11 @@ RTL_PICO=rtl/sysctl_pico.v rtl/uart.v \
 	rtl/pll_ecp5.v \
 	rtl/cpu/picorv32/picorv32.v
 
+ifdef USB
+	RTL_PICO += ext/usb_hid_host/src/usb_hid_host.v \
+		ext/usb_hid_host/src/usb_hid_host_rom.v
+endif
+
 BOARD_LC = $(shell echo '$(BOARD)' | tr '[:upper:]' '[:lower:]')
 BOARD_UC = $(shell echo '$(BOARD)' | tr '[:lower:]' '[:upper:]')
 

README.md

@@ -57,6 +57,15 @@ For example:
 make BOARD=eis flash
 ```
 
+### Enable USB HID Host Support
+
+```
+$ cd ext
+$ git clone https://github.com/nand2mario/usb_hid_host
+$ cd ..
+$ make USB=1 BOARD=eis
+```
+
 ### Serial Console
 
 The default configuration assumes that a UART PMOD is connected to PMODB (or PMODA if there's only one PMOD on the device).

boards/obst_v0.lpf

@@ -5,13 +5,16 @@ LOCATE COMP "CLK_48" SITE "A7";
 IOBUF PORT "CLK_48" IO_TYPE=LVCMOS33;
 FREQUENCY PORT "CLK_48" 48.0 MHz;
 
-# SELTSAM on USB1
-#LOCATE COMP "UART0_RX" SITE "B1";	# USB1DP -> SELTSAM -> CH340N RX
-#IOBUF PORT "UART0_RX" IO_TYPE=LVCMOS33;
-#IOBUF PORT "UART0_RX" PULLMODE=NONE;
-#LOCATE COMP "UART0_TX" SITE "B2";	# USB1DN <- SELTSAM <- CH340N TX
-#IOBUF PORT "UART0_TX" IO_TYPE=LVCMOS33;
-#IOBUF PORT "UART0_TX" PULLMODE=NONE;
+# USB HOST
+LOCATE COMP "USBH0_DP" SITE "B1";
+IOBUF PORT "USBH0_DP" IO_TYPE=LVCMOS33;
+LOCATE COMP "USBH0_DN" SITE "B2";
+IOBUF PORT "USBH0_DN" IO_TYPE=LVCMOS33;
+
+LOCATE COMP "USBH1_DP" SITE "C1";
+IOBUF PORT "USBH1_DP" IO_TYPE=LVCMOS33;
+LOCATE COMP "USBH1_DN" SITE "C2";
+IOBUF PORT "USBH1_DN" IO_TYPE=LVCMOS33;
 
 # PMOD A (USB-UART)
 LOCATE COMP "UART0_RTS" SITE "E5";

firmware/firmware.c

@@ -17,6 +17,11 @@
 #define reg_sd (*(volatile uint8_t*)0xf0002000)
 #define reg_ps2_data (*(volatile uint8_t*)0xf0003000)
 #define reg_ps2_ctrl (*(volatile uint8_t*)0xf0003004)
+
+#define reg_uhh_info (*(volatile uint32_t*)0xf0004000)
+#define reg_uhh_keys (*(volatile uint32_t*)0xf0004004)
+#define reg_uhh_mouse (*(volatile uint32_t*)0xf0004008)
+
 #define reg_gamepad_l (*(volatile uint32_t*)0xf0005000)
 #define reg_gamepad_r (*(volatile uint32_t*)0xf0005004)
 #define reg_delay_us (*(volatile uint32_t*)0xf0006000)
@@ -36,6 +41,8 @@
 #define PS2_CTRL_BUSY 0x02
 #define PS2_CTRL_DR 0x01
 
+#define UHH_INFO_DR 0x80000000
+
 #define SD_MISO 0x01
 #define SD_MOSI 0x02
 #define SD_SCK 0x04
@@ -58,6 +65,7 @@
 #define LIX_SIZE				262144
 
 #include "scancodes.h"
+#include "hidcodes.h"
 
 uint16_t curs_x = 0;
 uint16_t curs_y = 0;
@@ -71,6 +79,7 @@ uint32_t xfer_recv(uint32_t addr);
 uint32_t crc32b(char *data, uint32_t len);
 void putchar_vga(const char c);
 char scantoascii(uint8_t scancode);
+char hidtoascii(uint8_t code);
 
 void sd_init(void);
 void sd_spi_xfer(uint8_t b);
@@ -130,14 +139,21 @@ int getchar()
 {
 	int uart_dr = ((reg_uart_ctrl & UART_CTRL_DR) == UART_CTRL_DR);
 	int kbd_dr = ((reg_ps2_ctrl & PS2_CTRL_DR) == PS2_CTRL_DR);
+	int uhh_dr = ((reg_uhh_info & UHH_INFO_DR) == UHH_INFO_DR);
 	char c;
 
-	if (!uart_dr && !kbd_dr) {
+	if (!uart_dr && !kbd_dr && !uhh_dr) {
 		return EOF;
 	} else {
 		if (kbd_dr) {
 			c = scantoascii(reg_ps2_data);
 			if (c) return c; else return EOF;
+		} else if (uhh_dr) {
+			uint32_t keys = reg_uhh_keys;
+			uint8_t key = (keys >> 24) & 0xff;
+			if (!key) return EOF;
+			uint8_t c = hidtoascii(key);
+			if (c) return c; else return EOF;
 		} else {
 			return reg_uart_data;
 		}
@@ -169,6 +185,15 @@ char scantoascii(uint8_t scancode) {
 
 };
 
+char hidtoascii(uint8_t scancode) {
+
+	for (int i = 0; i < sizeof(hid_codes); i++) {
+		if (hid_codes[i] == scancode) return i + 0x30;
+	}
+	return 0;
+
+};
+
 uint32_t xfer_recv(uint32_t addr_ptr)
 {
 
@@ -354,6 +379,18 @@ void cmd_info() {
 	print_hex(tmp, 2);
 	print(" ");
 
+	print("uhh info: 0x");
+	print_hex(reg_uhh_info, 8);
+	print(" ");
+
+	print("uhh keys: 0x");
+	print_hex(reg_uhh_keys, 8);
+	print(" ");
+
+	print("uhh mouse: 0x");
+	print_hex(reg_uhh_mouse, 8);
+	print("\n");
+
 	print("uptime: 0x");
 	tmp32 = reg_rtc;
 	print_hex(tmp32, 8);

firmware/hidcodes.h

@@ -0,0 +1,50 @@
+uint8_t hid_codes[] = {
+
+	// usage id		key
+	0x27,				// 0
+	0x1e,				// 1
+	0x1f,				// 2
+	0x20,				// 3
+	0x21,				// 4
+	0x22,				// 5
+	0x23,				// 6
+	0x24,				// 7
+	0x25,				// 8
+	0x27,				// 9
+
+	0x00,
+	0x00,
+	0x00,
+	0x00,
+	0x00,
+	0x00,
+	0x00,
+
+	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
+	
+};

rtl/boards.vh

@@ -209,6 +209,7 @@
 `define EN_VIDEO
 `define EN_VIDEO_VGA
 `define EN_QQSPI
+`define EN_USB_HID_HOST
 
 `elsif LAKRITZ
 

rtl/pll_ecp5.v

@@ -4,14 +4,16 @@ module pll0
 (
     input clkin, // 48 MHz, 0 deg
     output clkout0, // 100 MHz, 0 deg
-    output clkout2, // 75 MHz, 0 deg
-    output clkout3, // 50 MHz, 0 deg
+    output clkout1, // 75 MHz, 0 deg
+    output clkout2, // 50 MHz, 0 deg
+    output clkout3, // 12 MHz, 0 deg
     output locked
 );
 (* FREQUENCY_PIN_CLKI="48" *)
 (* FREQUENCY_PIN_CLKOP="100" *)
-(* FREQUENCY_PIN_CLKOS2="75" *)
-(* FREQUENCY_PIN_CLKOS3="50" *)
+(* FREQUENCY_PIN_CLKOS="75" *)
+(* FREQUENCY_PIN_CLKOS2="50" *)
+(* FREQUENCY_PIN_CLKOS3="12" *)
 (* ICP_CURRENT="12" *) (* LPF_RESISTOR="8" *) (* MFG_ENABLE_FILTEROPAMP="1" *) (* MFG_GMCREF_SEL="2" *)
 EHXPLLL #(
         .PLLRST_ENA("DISABLED"),
@@ -27,12 +29,16 @@ EHXPLLL #(
         .CLKOP_DIV(6),
         .CLKOP_CPHASE(2),
         .CLKOP_FPHASE(0),
+        .CLKOS_ENABLE("ENABLED"),
+        .CLKOS_DIV(8),
+        .CLKOS_CPHASE(2),
+        .CLKOS_FPHASE(0),
         .CLKOS2_ENABLE("ENABLED"),
-        .CLKOS2_DIV(8),
+        .CLKOS2_DIV(12),
         .CLKOS2_CPHASE(2),
         .CLKOS2_FPHASE(0),
         .CLKOS3_ENABLE("ENABLED"),
-        .CLKOS3_DIV(12),
+        .CLKOS3_DIV(50),
         .CLKOS3_CPHASE(2),
         .CLKOS3_FPHASE(0),
         .FEEDBK_PATH("CLKOP"),
@@ -42,6 +48,7 @@ EHXPLLL #(
         .STDBY(1'b0),
         .CLKI(clkin),
         .CLKOP(clkout0),
+        .CLKOS(clkout1),
         .CLKOS2(clkout2),
         .CLKOS3(clkout3),
         .CLKFB(clkout0),

rtl/sysctl_pico.v

@@ -255,6 +255,13 @@ module sysctl #()
 	input RP_HOLD,
 `endif
 
+`ifdef EN_USB_HID_HOST
+	inout USBH0_DP,
+	inout USBH0_DN,
+	//inout USBH1_DP,
+	//inout USBH1_DN,
+`endif
+
 );
 
 	reg [31:0] reg_cfg_sys = (SYSCLK / 1_000_000);
@@ -264,6 +271,7 @@ module sysctl #()
 
 	wire clk;
 
+	wire clk12mhz;
 	wire clk25mhz;
 	wire clk50mhz;
 	wire clk75mhz;
@@ -484,8 +492,9 @@ module sysctl #()
 	pll0 #() ecp5_pll0 (
 		.clkin(CLK_48),
 		.clkout0(clk100mhz),
-		.clkout2(clk75mhz),
-		.clkout3(clk50mhz),
+		.clkout1(clk75mhz),
+		.clkout2(clk50mhz),
+		.clkout3(clk12mhz),
 	);
 	pll1 #() ecp5_pll1 (
 		.clkin(clk100mhz),
@@ -594,6 +603,27 @@ module sysctl #()
 	);
 `endif
 
+`ifdef EN_USB_HID_HOST
+
+	reg uhh_dr;
+	wire uhh_usb_report;
+	wire [1:0] uhh_usb_type;
+	wire [7:0] uhh_key_modifiers, uhh_key1, uhh_key2, uhh_key3, uhh_key4;
+	wire [7:0] uhh_mouse_btn;
+	wire signed [7:0] uhh_mouse_dx, uhh_mouse_dy;
+
+	usb_hid_host usb (
+		.usbclk(clk12mhz), .usbrst_n(resetn),
+		.usb_dm(USBH0_DN), .usb_dp(USBH0_DP),
+		.typ(uhh_usb_type), .report(uhh_usb_report),
+		.key_modifiers(uhh_key_modifiers),
+		.key1(uhh_key1), .key2(uhh_key2), .key3(uhh_key3), .key4(uhh_key4),
+		.mouse_btn(uhh_mouse_btn),
+		.mouse_dx(uhh_mouse_dx), .mouse_dy(uhh_mouse_dy),
+);
+
+`endif
+
 `ifdef EN_RPINT
 	wire [31:0] rpint_rdata;
 	wire [1:0] rpint_reg;
@@ -1344,6 +1374,10 @@ module sysctl #()
 		ps2_rstrb <= 0;
 `endif
 
+`ifdef EN_USB_HID_HOST
+		if (!uhh_dr) uhh_dr <= uhh_usb_report;
+`endif
+
 		uart0_transmit <= 0;
 
 `ifdef EN_GPU_FB
@@ -1654,6 +1688,10 @@ module sysctl #()
 		gpu_blit_ctr <= 0;
 `endif
 
+`ifdef EN_USB_HID_HOST
+		uhh_dr <= 0;
+`endif
+
 		end else if (mem_valid && !mem_ready) begin
 
 			(* parallel_case *)
@@ -2177,6 +2215,33 @@ module sysctl #()
 
 `endif
 
+`ifdef EN_USB_HID_HOST
+						16'h4000: begin
+							if (!mem_wstrb) begin
+								mem_rdata <= { uhh_dr, 5'b0, uhh_usb_type,
+									16'b0,
+									uhh_key_modifiers };
+							end
+							mem_ready <= 1;
+						end
+
+						16'h4004: begin
+							if (!mem_wstrb) begin
+								mem_rdata <= { uhh_key1, uhh_key2, uhh_key3, uhh_key4 };
+							end
+							uhh_dr <= 0;
+							mem_ready <= 1;
+						end
+
+						16'h4008: begin
+							if (!mem_wstrb) begin
+								mem_rdata <= { 8'b0, uhh_mouse_btn,
+									uhh_mouse_dx, uhh_mouse_dy };
+							end
+							mem_ready <= 1;
+						end
+`endif
+
 `ifdef EN_RPINT
 						16'h5000: begin
 							if (!mem_wstrb) begin