update VID/PID/serial

code cleanup & fix compile with pico-sdk 2.2.0
improve websocket implementation
2025-08-12 11:30:03 -04:00 · 2025-08-12 07:49:12 -04:00 · 2025-07-28 10:15:49 -04:00
9 changed files with 180 additions and 108 deletions
@@ -37,7 +37,6 @@ target_sources(${PROJECT} PRIVATE
 )

 pico_enable_stdio_usb(${PROJECT} 1)
-pico_enable_stdio_uart(${PROJECT} 1)

 pico_add_extra_outputs(${PROJECT})

@@ -49,6 +48,7 @@ target_link_libraries(${PROJECT}
 	pico_stdlib
 	pico_multicore
 	pico_mbedtls
+	tinyusb_board
 	tinyusb_device
 )

@@ -12,6 +12,8 @@ graphical interface served on the webpage.

 ## Setup

+[Installation and demo video](https://youtu.be/uORnxt5DLTw)
+
 Download the webkeyboard.uf2 file from the latest
 [release](https://git.kkozai.com/kenji/webkeyboard/releases) and flash
 onto the Raspberry Pi Pico W by holding down the BOOTSEL button while plugging
@@ -1,5 +1,5 @@
-#ifndef MBEDTLS_CONFIG_EXAMPLES_COMMON_H
-#define MBEDTLS_CONFIG_EXAMPLES_COMMON_H
+#ifndef MBEDTLS_CONFIG_H
+#define MBEDTLS_CONFIG_H

 /* Workaround for some mbedtls source files using INT_MAX without including limits.h */
 #include <limits.h>
@@ -11,6 +11,7 @@

 #define MBEDTLS_ALLOW_PRIVATE_ACCESS
 #define MBEDTLS_HAVE_TIME
+#define MBEDTLS_PLATFORM_MS_TIME_ALT

 #define MBEDTLS_CIPHER_MODE_CBC
 #define MBEDTLS_ECP_DP_SECP192R1_ENABLED
@@ -7,6 +7,8 @@
 #include "parse_keys.h"
 #include "usb_descriptors.h"

+static unsigned char boot_buf[8];
+
 // take a list of Javascript keys representing pressed keys and turn into
 // a 8 byte USB boot keyboard report format
 void parse_key_list(char * keys) {
@@ -3,7 +3,6 @@

 #define MOUSE_SPEED 10

-static unsigned char boot_buf[8];

 void parse_key_list(char * keys);
 void parse_mouse_list(char * keys);
@@ -12,7 +11,6 @@ uint8_t parse_mod(char * key);

 typedef struct { char * key; uint8_t val; } keycode_dict;

-
 // modifier key bit codes
 #define KEY_MOD_LCTRL  0x01
 #define KEY_MOD_LSHIFT 0x02
@@ -25,54 +25,44 @@
 */

 #include "tusb.h"
+#include "bsp/board_api.h"
+
 #include "usb_descriptors.h"

-/* A combination of interfaces must have a unique product id, since PC will save device driver after the first plug.
- * Same VID/PID with different interface e.g MSC (first), then CDC (later) will possibly cause system error on PC.
- *
- * Auto ProductID layout's Bitmap:
- *   [MSB]         HID | MSC | CDC          [LSB]
- */
-#define _PID_MAP(itf, n)  ( (CFG_TUD_##itf) << (n) )
-#define USB_PID           (0x4000 | _PID_MAP(CDC, 0) | _PID_MAP(MSC, 1) | _PID_MAP(HID, 2) | \
-                           _PID_MAP(MIDI, 3) | _PID_MAP(VENDOR, 4) )
-
-#define USB_VID   0xCafe
-#define USB_BCD   0x0200

 //--------------------------------------------------------------------+
 // Device Descriptors
 //--------------------------------------------------------------------+
 tusb_desc_device_t const desc_device =
 {
-  .bLength            = sizeof(tusb_desc_device_t),
-  .bDescriptorType    = TUSB_DESC_DEVICE,
-  .bcdUSB             = USB_BCD,
+	.bLength            = sizeof(tusb_desc_device_t),
+	.bDescriptorType    = TUSB_DESC_DEVICE,
+	.bcdUSB             = USB_BCD,

-  // Use Interface Association Descriptor (IAD) for CDC
-  // As required by USB Specs IAD's subclass must be common class (2) and protocol must be IAD (1)
-  .bDeviceClass       = TUSB_CLASS_MISC,
-  .bDeviceSubClass    = MISC_SUBCLASS_COMMON,
-  .bDeviceProtocol    = MISC_PROTOCOL_IAD,
+	// Use Interface Association Descriptor (IAD) for CDC
+	// As required by USB Specs IAD's subclass must be common class (2) and protocol must be IAD (1)
+	.bDeviceClass       = TUSB_CLASS_MISC,
+	.bDeviceSubClass    = MISC_SUBCLASS_COMMON,
+	.bDeviceProtocol    = MISC_PROTOCOL_IAD,

-  .bMaxPacketSize0    = CFG_TUD_ENDPOINT0_SIZE,
+	.bMaxPacketSize0    = CFG_TUD_ENDPOINT0_SIZE,

-  .idVendor           = USB_VID,
-  .idProduct          = USB_PID,
-  .bcdDevice          = 0x0100,
+	.idVendor           = USB_VID,
+	.idProduct          = USB_PID,
+	.bcdDevice          = 0x0100,

-  .iManufacturer      = 0x01,
-  .iProduct           = 0x02,
-  .iSerialNumber      = 0x03,
+	.iManufacturer      = 0x01,
+	.iProduct           = 0x02,
+	.iSerialNumber      = 0x03,

-  .bNumConfigurations = 0x01
+	.bNumConfigurations = 0x01
 };

 // Invoked when received GET DEVICE DESCRIPTOR
 // Application return pointer to descriptor
 uint8_t const * tud_descriptor_device_cb(void)
 {
-  return (uint8_t const *) &desc_device;
+	return (uint8_t const *) &desc_device;
 }


@@ -80,17 +70,10 @@ uint8_t const * tud_descriptor_device_cb(void)
 // Configuration Descriptor
 //--------------------------------------------------------------------+

-#define EPNUM_CDC_NOTIF	0x81
-#define EPNUM_CDC_OUT	0x02
-#define EPNUM_CDC_IN	0x82
-#define EPNUM_HID		0x83
-
-#define CONFIG_TOTAL_LEN    (TUD_CONFIG_DESC_LEN + TUD_CDC_DESC_LEN + TUD_HID_DESC_LEN)
-
 uint8_t const desc_hid_report[] =
 {
-  TUD_HID_REPORT_DESC_KEYBOARD( HID_REPORT_ID(REPORT_ID_KEYBOARD)),
-  TUD_HID_REPORT_DESC_MOUSE( HID_REPORT_ID(REPORT_ID_MOUSE))
+	TUD_HID_REPORT_DESC_KEYBOARD( HID_REPORT_ID(REPORT_ID_KEYBOARD)),
+	TUD_HID_REPORT_DESC_MOUSE( HID_REPORT_ID(REPORT_ID_MOUSE))
 };


@@ -98,10 +81,10 @@ uint8_t const desc_hid_report[] =
 // full speed configuration
 uint8_t const desc_fs_configuration[] =
 {
-  // Config number, interface count, string index, total length, attribute, power in mA - atttribute 0xa0 enables wakeup
-  TUD_CONFIG_DESCRIPTOR(1, ITF_NUM_TOTAL, 0, CONFIG_TOTAL_LEN, 0xa0, 100),
+	// Config number, interface count, string index, total length, attribute, power in mA - atttribute 0xa0 enables wakeup
+	TUD_CONFIG_DESCRIPTOR(1, ITF_NUM_TOTAL, 0, CONFIG_TOTAL_LEN, 0xa0, 100),

-    // Interface number, string index, protocol, report descriptor len, EP In address, size & polling interval
+	// Interface number, string index, protocol, report descriptor len, EP In address, size & polling interval
 	TUD_CDC_DESCRIPTOR(ITF_NUM_CDC, 4, EPNUM_CDC_NOTIF, 8, EPNUM_CDC_OUT, EPNUM_CDC_IN, 64),
 	TUD_HID_DESCRIPTOR(ITF_NUM_HID, 5, HID_ITF_PROTOCOL_NONE, sizeof(desc_hid_report), EPNUM_HID, CFG_TUD_HID_EP_BUFSIZE, 5),
 };
@@ -111,8 +94,8 @@ uint8_t const desc_fs_configuration[] =
 // Descriptor contents must exist long enough for transfer to complete
 uint8_t const * tud_descriptor_configuration_cb(uint8_t index)
 {
-  (void) index; // for multiple configurations
-  return desc_fs_configuration;
+	(void) index; // for multiple configurations
+	return desc_fs_configuration;
 }


@@ -123,55 +106,55 @@ uint8_t const * tud_descriptor_configuration_cb(uint8_t index)
 // array of pointer to string descriptors
 char const* string_desc_arr [] =
 {
-  (const char[]) { 0x09, 0x04 }, // 0: is supported language is English (0x0409)
-  "Raspberry Pi",                // 1: Manufacturer
-  "Pico Web Keyboard",           // 2: Product
-  "1234567890123456789",         // 3: Serials, should use chip ID
-  "Pico Web Keyboard CDC",       // 4: CDC Interface
-  "Pico Web Keyboard HID",       // 5: HID Keyboard Interface
+	(const char[]) { 0x09, 0x04 },	// 0: is supported language is English (0x0409)
+	"Raspberry Pi",					// 1: Manufacturer
+	"Pico Web Keyboard",			// 2: Product
+	NULL,					        // 3: Serials, should use chip ID
 };

-static uint16_t _desc_str[32];
+static uint16_t _desc_str[32+1];

 // Invoked when received GET STRING DESCRIPTOR request
 // Application return pointer to descriptor, whose contents must exist long enough for transfer to complete
 uint16_t const* tud_descriptor_string_cb(uint8_t index, uint16_t langid)
 {
-  (void) langid;
+	(void) langid;

-  uint8_t chr_count;
+	uint8_t chr_count;

-  if ( index == 0)
-  {
-    memcpy(&_desc_str[1], string_desc_arr[0], 2);
-    chr_count = 1;
-  }else
-  {
-    // Note: the 0xEE index string is a Microsoft OS 1.0 Descriptors.
-    // https://docs.microsoft.com/en-us/windows-hardware/drivers/usbcon/microsoft-defined-usb-descriptors
+	switch (index) {
+		case 0: // langid
+			memcpy(&_desc_str[1], string_desc_arr[0], 2);
+			chr_count = 1;
+			break;
+		case 3: // serial
+			chr_count = board_usb_get_serial(_desc_str+1, 32);	
+			break;
+		default:
+			// Note: the 0xEE index string is a Microsoft OS 1.0 Descriptors.
+			// https://docs.microsoft.com/en-us/windows-hardware/drivers/usbcon/microsoft-defined-usb-descriptors

-    if ( !(index < sizeof(string_desc_arr)/sizeof(string_desc_arr[0])) ) return NULL;
+			if ( !(index < sizeof(string_desc_arr)/sizeof(string_desc_arr[0])) ) return NULL;

-    const char* str = string_desc_arr[index];
+			char* str = string_desc_arr[index];

-    // Cap at max char
-    chr_count = (uint8_t) strlen(str);
-    if ( chr_count > 31 ) chr_count = 31;
+			// Cap at max char
+			chr_count = (uint8_t) strlen(str);
+			if ( chr_count > 31 ) chr_count = 31;

-    // Convert ASCII string into UTF-16
-    for(uint8_t i=0; i<chr_count; i++)
-    {
-      _desc_str[1+i] = str[i];
-    }
-  }
+			// Convert ASCII string into UTF-16
+			for(uint8_t i=0; i<chr_count; i++) {
+				_desc_str[1+i] = str[i];
+			}
+			break;
+	}

-  // first byte is length (including header), second byte is string type
-  _desc_str[0] = (TUSB_DESC_STRING << 8 ) | (2*chr_count + 2);
+	// first byte is length (including header), second byte is string type
+	_desc_str[0] = (TUSB_DESC_STRING << 8 ) | (2*chr_count + 2);

-  return _desc_str;
+	return _desc_str;
 }

-
 //--------------------------------------------------------------------+
 // Device HID
 //--------------------------------------------------------------------+
@@ -41,5 +41,15 @@ enum
 	ITF_NUM_TOTAL
 };

+#define USB_PID		0x0ebd
+#define USB_VID		0xCEC0
+#define USB_BCD		0x0200
+
+#define EPNUM_CDC_NOTIF	0x81
+#define EPNUM_CDC_OUT	0x02
+#define EPNUM_CDC_IN	0x82
+#define EPNUM_HID		0x83
+
+#define CONFIG_TOTAL_LEN    (TUD_CONFIG_DESC_LEN + TUD_CDC_DESC_LEN + TUD_HID_DESC_LEN)

 #endif /* USB_DESCRIPTORS_H_ */
@@ -13,12 +13,30 @@ static const char WS_RESPONSE[] = "HTTP/1.1 101 Switching Protocols\r\n" \
 	"Connection: Upgrade\r\n" \
 	"Sec-WebSocket-Accept: ";

+static uint8_t buf[WS_BUFFER_SIZE];
+static uint16_t buf_len=0;
+
 static tWSHandler ws_receive_cb = NULL;
 static tWSOpenHandler ws_open_cb = NULL;

 static struct ws_state * ws_connections;
 static uint8_t ws_num_conns = 0;

+static struct ws_state* ws_state_alloc(void);
+static void ws_state_init(struct ws_state *wss);
+static void ws_state_free(struct ws_state *wss);
+static void ws_server_init_pcb( struct altcp_pcb *pcb, uint16_t port);
+static err_t ws_accept(void *arg, struct altcp_pcb *pcb, err_t err);
+static err_t ws_recv(void *arg, struct altcp_pcb *pcb, struct pbuf *p, err_t err);
+static err_t ws_sent(void *arg, struct altcp_pcb *pcb, uint16_t len);
+static void ws_err (void *arg, err_t err);
+static err_t ws_close_conn(struct altcp_pcb *pcb, struct ws_state *wss);
+static err_t ws_close_or_abort_conn(struct altcp_pcb *pcb, struct ws_state *wss, uint8_t abort_conn);
+static err_t ws_poll(void *arg, struct altcp_pcb *pcb);
+static err_t ws_handshake(struct altcp_pcb *pcb, struct ws_state *wss, struct pbuf *p);
+static err_t ws_read(struct altcp_pcb *pcb, struct ws_state *wss, struct pbuf *p);
+static err_t ws_send(struct ws_state *wss, uint8_t *data, uint16_t len);
+
 // allocate memory for ws_state instance
 static struct ws_state * ws_state_alloc(void) {
 	struct ws_state *ret =  WS_ALLOC_WS_STATE();
@@ -330,30 +348,94 @@ static err_t ws_read(struct altcp_pcb *pcb, struct ws_state *wss, struct pbuf *p
 		// successful read, reset timeout
 		wss->retries = 0;

-		uint8_t mode = data[0] & 0x0F;
+		uint8_t fin = data[0] & 0x80;
+		uint8_t opcode = data[0] & 0x0F;
+		uint8_t masked = data[1] & 0x80;
 		uint16_t msg_len = data[1] & 0x7F;
-		switch (mode) {
-			case 0x01: //text
+		uint8_t *msg;
+		
+		switch (msg_len) {
+			case 126: // next two bytes are length
+				memcpy(&msg_len, &data[2], 2);
+				if (len >= 8) {
+					msg = &data[8];
+				}
+				break;
+			case 127: // next four bytes are length
+				// lwIP's pbuf only handles 16-bit lengths, so error
+				LWIP_DEBUGF(WS_DEBUG, ("ws_read: received 64-bit length %u\n", msg_len));
+				return ERR_MEM;
+				
+				//memcpy(&msg_len, &data[2], 4);
+				//if (len >= 10) {
+				//	msg = &data[10];
+				//}
+				//break;
+			default:
+				if (len >= 6) {
+					msg = &data[6];
+				}
+				break;
+		}
+		switch (opcode) {
+			case OP_CONT:
+				LWIP_DEBUGF(WS_DEBUG, ("ws_read: received continuation frame\n"));
+			case OP_TEXT:
 				LWIP_DEBUGF(WS_DEBUG, ("ws_read: received text data\n"));
-			case 0x02: //binary
-				LWIP_DEBUGF(WS_DEBUG, ("ws_read: decoding data\n"));
-				if (len >= 6 && ws_receive_cb != NULL) {
-					uint8_t *mask = &data[2];
-					uint8_t *msg = &data[6];
-
-					for (int i=0; i<msg_len; i++) {
-						msg[i] ^= mask[i % 4];
+			case OP_BINARY:
+				LWIP_DEBUGF(WS_DEBUG, ("ws_read: decoding data, len=%u\n", msg_len));
+				if (msg && ws_receive_cb != NULL) {
+					// unmask the data if mask bit is received
+					if (masked) {
+						uint8_t *mask = &data[2];
+	
+						for (int i=0; i<msg_len; i++) {
+							msg[i] ^= mask[i % 4];
+						}
+					} else {
+						// messages from client must be masked - disconnect
+						LWIP_DEBUGF(WS_DEBUG, ("ws_read: received unmasked message"));
+						return ERR_CLSD;
 					}
 					msg[msg_len]=0;

-					ws_receive_cb(msg, msg_len);
+					if (opcode != OP_CONT) { // not a continuation frame, reset buffer
+						buf_len=0;
+						memset(buf, 0x00, sizeof(buf));
+					}
+
+					if (buf_len + msg_len > WS_BUFFER_SIZE) {
+						LWIP_DEBUGF(WS_DEBUG, ("ws_read: message exceeds buffer size %u+%u\n", buf_len, msg_len));
+						return ERR_MEM;
+					}
+
+					memcpy(&buf[buf_len], msg, msg_len);
+					buf_len += msg_len;
+					
+					if (fin) { // last packet in message, process completed message
+						ws_receive_cb(buf, buf_len);
+					}
 				}
 				break;
-			case 0x08: //close
+			case OP_CLOSE:
 				LWIP_DEBUGF(WS_DEBUG, ("ws_read: close request"));
 				return ERR_CLSD;
+			case OP_PING:
+				// control frames cannot exceed 125 bytes in length
+				if (msg && msg_len <= 125) {
+					// send back a pong
+					uint8_t pong[2+msg_len];
+					pong[0]=0x8A;
+					pong[1]=msg_len;
+					memcpy(&pong[2], msg, msg_len);
+
+					return ws_send(wss, pong, msg_len+2);
+				}
+				return ERR_ARG;
+			case OP_PONG: // no response required for pong
+				return ERR_OK;
 			default:
-				LWIP_DEBUGF(WS_DEBUG, ("ws_read: invalid data mode %02X\n", mode));
+				LWIP_DEBUGF(WS_DEBUG, ("ws_read: invalid opcode %02X\n", opcode));
 				return ERR_ARG;
 		}

@@ -7,6 +7,14 @@
 #define WS_MAX_RETRIES		10
 #define WS_POLL_INTERVAL	60 // WS_POLL_INTERVAL/2 seconds
 #define WS_MAX_CONN			4
+#define WS_BUFFER_SIZE		512
+
+#define OP_CONT		0x00
+#define OP_TEXT		0x01
+#define OP_BINARY	0x02
+#define OP_CLOSE	0x08
+#define OP_PING		0x09
+#define OP_PONG		0x0A

 struct ws_state {
 	bool active;
@@ -20,21 +28,7 @@ struct ws_state {
 typedef void (* tWSHandler ) (uint8_t *data, uint16_t len);
 typedef void (* tWSOpenHandler ) (struct ws_state * wss);

-static struct ws_state* ws_state_alloc(void);
-static void ws_state_init(struct ws_state *wss);
-static void ws_state_free(struct ws_state *wss);
 void ws_server_init(void);
-static void ws_server_init_pcb( struct altcp_pcb *pcb, uint16_t port);
-static err_t ws_accept(void *arg, struct altcp_pcb *pcb, err_t err);
-static err_t ws_recv(void *arg, struct altcp_pcb *pcb, struct pbuf *p, err_t err);
-static err_t ws_sent(void *arg, struct altcp_pcb *pcb, uint16_t len);
-static void ws_err (void *arg, err_t err);
-static err_t ws_close_conn(struct altcp_pcb *pcb, struct ws_state *wss);
-static err_t ws_close_or_abort_conn(struct altcp_pcb *pcb, struct ws_state *wss, uint8_t abort_conn);
-static err_t ws_poll(void *arg, struct altcp_pcb *pcb);
-static err_t ws_handshake(struct altcp_pcb *pcb, struct ws_state *wss, struct pbuf *p);
-static err_t ws_read(struct altcp_pcb *pcb, struct ws_state *wss, struct pbuf *p);
-static err_t ws_send(struct ws_state *wss, uint8_t *data, uint16_t len);
 void ws_send_all(uint8_t *data, uint16_t len);
 void ws_set_receive_handler( tWSHandler ws_handler);
 void ws_set_open_handler( tWSOpenHandler ws_handler);
Author	SHA1	Message	Date
kenji	cf17420973	update VID/PID/serial	2025-08-12 11:30:03 -04:00
kenji	692c5af8c9	code cleanup & fix compile with pico-sdk 2.2.0	2025-08-12 07:49:12 -04:00
kenji	4f313b3336	improve websocket implementation	2025-07-28 10:15:49 -04:00