344 lines
12 KiB
C
344 lines
12 KiB
C
/*
|
|
* Copyright (c) 2024, sakumisu
|
|
*
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
#include "usbd_core.h"
|
|
#include "usbd_hid.h"
|
|
|
|
#define WEBUSB_VENDOR_CODE (0x22)
|
|
#define WINUSB_VENDOR_CODE (0x21)
|
|
|
|
#define URL_DESCRIPTOR_LENGTH (3 + 36)
|
|
|
|
#define WEBUSB_INTF_NUM 0x01
|
|
|
|
#define WEBUSB_URL_STRINGS \
|
|
'g', 'i', 't', 'h', 'u', 'b', '.', 'c', 'o', 'm', '/', \
|
|
'c', 'h', 'e', 'r', 'r', 'y', '-', 'e', 'm', 'b', 'e', 'd', 'd', 'e', 'd', '/', 'C', 'h', 'e', 'r', 'r', 'y', 'U', 'S', 'B',
|
|
|
|
const uint8_t USBD_WebUSBURLDescriptor[URL_DESCRIPTOR_LENGTH] = {
|
|
URL_DESCRIPTOR_LENGTH,
|
|
WEBUSB_URL_TYPE,
|
|
WEBUSB_URL_SCHEME_HTTPS,
|
|
WEBUSB_URL_STRINGS
|
|
};
|
|
|
|
const uint8_t WINUSB_WCIDDescriptor[] = {
|
|
USB_MSOSV2_COMP_ID_SET_HEADER_DESCRIPTOR_INIT(10 + USB_MSOSV2_COMP_ID_FUNCTION_WINUSB_MULTI_DESCRIPTOR_LEN),
|
|
USB_MSOSV2_COMP_ID_FUNCTION_WINUSB_MULTI_DESCRIPTOR_INIT(WEBUSB_INTF_NUM),
|
|
};
|
|
|
|
__ALIGN_BEGIN const uint8_t USBD_BinaryObjectStoreDescriptor[] = {
|
|
USB_BOS_HEADER_DESCRIPTOR_INIT(5 + USB_BOS_CAP_PLATFORM_WEBUSB_DESCRIPTOR_LEN + USB_BOS_CAP_PLATFORM_WINUSB_DESCRIPTOR_LEN, 2),
|
|
USB_BOS_CAP_PLATFORM_WEBUSB_DESCRIPTOR_INIT(WEBUSB_VENDOR_CODE, 0x01),
|
|
USB_BOS_CAP_PLATFORM_WINUSB_DESCRIPTOR_INIT(WINUSB_VENDOR_CODE, sizeof(WINUSB_WCIDDescriptor)),
|
|
};
|
|
|
|
struct usb_webusb_descriptor webusb_url_desc = {
|
|
.vendor_code = WEBUSB_VENDOR_CODE,
|
|
.string = USBD_WebUSBURLDescriptor,
|
|
.string_len = URL_DESCRIPTOR_LENGTH
|
|
};
|
|
|
|
struct usb_msosv2_descriptor msosv2_desc = {
|
|
.vendor_code = WINUSB_VENDOR_CODE,
|
|
.compat_id = WINUSB_WCIDDescriptor,
|
|
.compat_id_len = sizeof(WINUSB_WCIDDescriptor),
|
|
};
|
|
|
|
struct usb_bos_descriptor bos_desc = {
|
|
.string = USBD_BinaryObjectStoreDescriptor,
|
|
.string_len = sizeof(USBD_BinaryObjectStoreDescriptor)
|
|
};
|
|
|
|
#define USBD_VID 0xffff
|
|
#define USBD_PID 0xffff
|
|
#define USBD_MAX_POWER 100
|
|
#define USBD_LANGID_STRING 1033
|
|
|
|
#define HID_INT_EP 0x81
|
|
#define HID_INT_EP_SIZE 8
|
|
#define HID_INT_EP_INTERVAL 10
|
|
|
|
#define USB_CONFIG_SIZE (34 + 9)
|
|
#define HID_KEYBOARD_REPORT_DESC_SIZE 63
|
|
|
|
#ifdef CONFIG_USBDEV_ADVANCE_DESC
|
|
static const uint8_t device_descriptor[] = {
|
|
USB_DEVICE_DESCRIPTOR_INIT(USB_2_1, 0x00, 0x00, 0x00, USBD_VID, USBD_PID, 0x0002, 0x01)
|
|
};
|
|
|
|
static const uint8_t config_descriptor[] = {
|
|
USB_CONFIG_DESCRIPTOR_INIT(USB_CONFIG_SIZE, 0x02, 0x01, USB_CONFIG_BUS_POWERED, USBD_MAX_POWER),
|
|
HID_KEYBOARD_DESCRIPTOR_INIT(0x00, 0x01, HID_KEYBOARD_REPORT_DESC_SIZE, HID_INT_EP, HID_INT_EP_SIZE, HID_INT_EP_INTERVAL),
|
|
USB_INTERFACE_DESCRIPTOR_INIT(WEBUSB_INTF_NUM, 0x00, 0x00, 0xff, 0x00, 0x00, 0x00)
|
|
};
|
|
|
|
static const uint8_t device_quality_descriptor[] = {
|
|
///////////////////////////////////////
|
|
/// device qualifier descriptor
|
|
///////////////////////////////////////
|
|
0x0a,
|
|
USB_DESCRIPTOR_TYPE_DEVICE_QUALIFIER,
|
|
0x00,
|
|
0x02,
|
|
0x00,
|
|
0x00,
|
|
0x00,
|
|
0x40,
|
|
0x00,
|
|
0x00,
|
|
};
|
|
|
|
static const char *string_descriptors[] = {
|
|
(const char[]){ 0x09, 0x04 }, /* Langid */
|
|
"CherryUSB", /* Manufacturer */
|
|
"CherryUSB WEBUSB HID DEMO", /* Product */
|
|
"2022123456", /* Serial Number */
|
|
};
|
|
|
|
static const uint8_t *device_descriptor_callback(uint8_t speed)
|
|
{
|
|
return device_descriptor;
|
|
}
|
|
|
|
static const uint8_t *config_descriptor_callback(uint8_t speed)
|
|
{
|
|
return config_descriptor;
|
|
}
|
|
|
|
static const uint8_t *device_quality_descriptor_callback(uint8_t speed)
|
|
{
|
|
return device_quality_descriptor;
|
|
}
|
|
|
|
static const char *string_descriptor_callback(uint8_t speed, uint8_t index)
|
|
{
|
|
if (index > 3) {
|
|
return NULL;
|
|
}
|
|
return string_descriptors[index];
|
|
}
|
|
|
|
const struct usb_descriptor webusb_hid_descriptor = {
|
|
.device_descriptor_callback = device_descriptor_callback,
|
|
.config_descriptor_callback = config_descriptor_callback,
|
|
.device_quality_descriptor_callback = device_quality_descriptor_callback,
|
|
.string_descriptor_callback = string_descriptor_callback,
|
|
.msosv2_descriptor = &msosv2_desc,
|
|
.webusb_url_descriptor = &webusb_url_desc,
|
|
.bos_descriptor = &bos_desc
|
|
};
|
|
#else
|
|
static const uint8_t webusb_hid_descriptor[] = {
|
|
USB_DEVICE_DESCRIPTOR_INIT(USB_2_1, 0x00, 0x00, 0x00, USBD_VID, USBD_PID, 0x0002, 0x01),
|
|
USB_CONFIG_DESCRIPTOR_INIT(USB_CONFIG_SIZE, 0x02, 0x01, USB_CONFIG_BUS_POWERED, USBD_MAX_POWER),
|
|
HID_KEYBOARD_DESCRIPTOR_INIT(0x00, 0x01, HID_KEYBOARD_REPORT_DESC_SIZE, HID_INT_EP, HID_INT_EP_SIZE, HID_INT_EP_INTERVAL),
|
|
USB_INTERFACE_DESCRIPTOR_INIT(WEBUSB_INTF_NUM, 0x00, 0x00, 0xff, 0x00, 0x00, 0x00),
|
|
///////////////////////////////////////
|
|
/// string0 descriptor
|
|
///////////////////////////////////////
|
|
USB_LANGID_INIT(USBD_LANGID_STRING),
|
|
///////////////////////////////////////
|
|
/// string1 descriptor
|
|
///////////////////////////////////////
|
|
0x14, /* bLength */
|
|
USB_DESCRIPTOR_TYPE_STRING, /* bDescriptorType */
|
|
'C', 0x00, /* wcChar0 */
|
|
'h', 0x00, /* wcChar1 */
|
|
'e', 0x00, /* wcChar2 */
|
|
'r', 0x00, /* wcChar3 */
|
|
'r', 0x00, /* wcChar4 */
|
|
'y', 0x00, /* wcChar5 */
|
|
'U', 0x00, /* wcChar6 */
|
|
'S', 0x00, /* wcChar7 */
|
|
'B', 0x00, /* wcChar8 */
|
|
///////////////////////////////////////
|
|
/// string2 descriptor
|
|
///////////////////////////////////////
|
|
0x2C, /* bLength */
|
|
USB_DESCRIPTOR_TYPE_STRING, /* bDescriptorType */
|
|
'C', 0x00, /* wcChar0 */
|
|
'h', 0x00, /* wcChar1 */
|
|
'e', 0x00, /* wcChar2 */
|
|
'r', 0x00, /* wcChar3 */
|
|
'r', 0x00, /* wcChar4 */
|
|
'y', 0x00, /* wcChar5 */
|
|
'U', 0x00, /* wcChar6 */
|
|
'S', 0x00, /* wcChar7 */
|
|
'B', 0x00, /* wcChar8 */
|
|
' ', 0x00, /* wcChar9 */
|
|
'W', 0x00, /* wcChar10 */
|
|
'E', 0x00, /* wcChar11 */
|
|
'B', 0x00, /* wcChar12 */
|
|
'U', 0x00, /* wcChar13 */
|
|
'S', 0x00, /* wcChar14 */
|
|
'B', 0x00, /* wcChar15 */
|
|
' ', 0x00, /* wcChar16 */
|
|
'D', 0x00, /* wcChar17 */
|
|
'E', 0x00, /* wcChar18 */
|
|
'M', 0x00, /* wcChar19 */
|
|
'O', 0x00, /* wcChar20 */
|
|
///////////////////////////////////////
|
|
/// string3 descriptor
|
|
///////////////////////////////////////
|
|
0x16, /* bLength */
|
|
USB_DESCRIPTOR_TYPE_STRING, /* bDescriptorType */
|
|
'2', 0x00, /* wcChar0 */
|
|
'0', 0x00, /* wcChar1 */
|
|
'2', 0x00, /* wcChar2 */
|
|
'2', 0x00, /* wcChar3 */
|
|
'1', 0x00, /* wcChar4 */
|
|
'2', 0x00, /* wcChar5 */
|
|
'3', 0x00, /* wcChar6 */
|
|
'4', 0x00, /* wcChar7 */
|
|
'5', 0x00, /* wcChar8 */
|
|
'6', 0x00, /* wcChar9 */
|
|
#ifdef CONFIG_USB_HS
|
|
///////////////////////////////////////
|
|
/// device qualifier descriptor
|
|
///////////////////////////////////////
|
|
0x0a,
|
|
USB_DESCRIPTOR_TYPE_DEVICE_QUALIFIER,
|
|
0x00,
|
|
0x02,
|
|
0x00,
|
|
0x00,
|
|
0x00,
|
|
0x40,
|
|
0x00,
|
|
0x00,
|
|
#endif
|
|
0x00
|
|
};
|
|
#endif
|
|
|
|
/* USB HID device Configuration Descriptor */
|
|
static uint8_t hid_desc[9] __ALIGN_END = {
|
|
/* 18 */
|
|
0x09, /* bLength: HID Descriptor size */
|
|
HID_DESCRIPTOR_TYPE_HID, /* bDescriptorType: HID */
|
|
0x11, /* bcdHID: HID Class Spec release number */
|
|
0x01,
|
|
0x00, /* bCountryCode: Hardware target country */
|
|
0x01, /* bNumDescriptors: Number of HID class descriptors to follow */
|
|
0x22, /* bDescriptorType */
|
|
HID_KEYBOARD_REPORT_DESC_SIZE, /* wItemLength: Total length of Report descriptor */
|
|
0x00,
|
|
};
|
|
|
|
static const uint8_t hid_keyboard_report_desc[HID_KEYBOARD_REPORT_DESC_SIZE] = {
|
|
0x05, 0x01, // USAGE_PAGE (Generic Desktop)
|
|
0x09, 0x06, // USAGE (Keyboard)
|
|
0xa1, 0x01, // COLLECTION (Application)
|
|
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)
|
|
0x75, 0x01, // REPORT_SIZE (1)
|
|
0x95, 0x08, // REPORT_COUNT (8)
|
|
0x81, 0x02, // INPUT (Data,Var,Abs)
|
|
0x95, 0x01, // REPORT_COUNT (1)
|
|
0x75, 0x08, // REPORT_SIZE (8)
|
|
0x81, 0x03, // INPUT (Cnst,Var,Abs)
|
|
0x95, 0x05, // REPORT_COUNT (5)
|
|
0x75, 0x01, // REPORT_SIZE (1)
|
|
0x05, 0x08, // USAGE_PAGE (LEDs)
|
|
0x19, 0x01, // USAGE_MINIMUM (Num Lock)
|
|
0x29, 0x05, // USAGE_MAXIMUM (Kana)
|
|
0x91, 0x02, // OUTPUT (Data,Var,Abs)
|
|
0x95, 0x01, // REPORT_COUNT (1)
|
|
0x75, 0x03, // REPORT_SIZE (3)
|
|
0x91, 0x03, // OUTPUT (Cnst,Var,Abs)
|
|
0x95, 0x06, // REPORT_COUNT (6)
|
|
0x75, 0x08, // REPORT_SIZE (8)
|
|
0x15, 0x00, // LOGICAL_MINIMUM (0)
|
|
0x25, 0xFF, // LOGICAL_MAXIMUM (255)
|
|
0x05, 0x07, // USAGE_PAGE (Keyboard)
|
|
0x19, 0x00, // USAGE_MINIMUM (Reserved (no event indicated))
|
|
0x29, 0x65, // USAGE_MAXIMUM (Keyboard Application)
|
|
0x81, 0x00, // INPUT (Data,Ary,Abs)
|
|
0xc0 // END_COLLECTION
|
|
};
|
|
|
|
#define HID_STATE_IDLE 0
|
|
#define HID_STATE_BUSY 1
|
|
|
|
/*!< hid state ! Data can be sent only when state is idle */
|
|
static volatile uint8_t hid_state = HID_STATE_IDLE;
|
|
|
|
static void usbd_event_handler(uint8_t busid, uint8_t event)
|
|
{
|
|
switch (event) {
|
|
case USBD_EVENT_RESET:
|
|
break;
|
|
case USBD_EVENT_CONNECTED:
|
|
break;
|
|
case USBD_EVENT_DISCONNECTED:
|
|
break;
|
|
case USBD_EVENT_RESUME:
|
|
break;
|
|
case USBD_EVENT_SUSPEND:
|
|
break;
|
|
case USBD_EVENT_CONFIGURED:
|
|
hid_state = HID_STATE_IDLE;
|
|
break;
|
|
case USBD_EVENT_SET_REMOTE_WAKEUP:
|
|
break;
|
|
case USBD_EVENT_CLR_REMOTE_WAKEUP:
|
|
break;
|
|
|
|
default:
|
|
break;
|
|
}
|
|
}
|
|
|
|
void usbd_hid_int_callback(uint8_t busid, uint8_t ep, uint32_t nbytes)
|
|
{
|
|
hid_state = HID_STATE_IDLE;
|
|
}
|
|
|
|
static struct usbd_endpoint hid_in_ep = {
|
|
.ep_cb = usbd_hid_int_callback,
|
|
.ep_addr = HID_INT_EP
|
|
};
|
|
|
|
static struct usbd_interface intf0;
|
|
|
|
void webusb_hid_keyboard_init(uint8_t busid, uintptr_t reg_base)
|
|
{
|
|
#ifdef CONFIG_USBDEV_ADVANCE_DESC
|
|
usbd_desc_register(busid, &webusb_hid_descriptor);
|
|
#else
|
|
usbd_desc_register(busid, webusb_hid_descriptor);
|
|
#endif
|
|
#ifndef CONFIG_USBDEV_ADVANCE_DESC
|
|
usbd_bos_desc_register(busid, &bos_desc);
|
|
usbd_msosv2_desc_register(busid, &msosv2_desc);
|
|
usbd_webusb_desc_register(busid, &webusb_url_desc);
|
|
#endif
|
|
usbd_add_interface(busid, usbd_hid_init_intf(busid, &intf0, hid_keyboard_report_desc, HID_KEYBOARD_REPORT_DESC_SIZE));
|
|
usbd_add_endpoint(busid, &hid_in_ep);
|
|
|
|
usbd_initialize(busid, reg_base, usbd_event_handler);
|
|
}
|
|
|
|
USB_NOCACHE_RAM_SECTION USB_MEM_ALIGNX uint8_t write_buffer[64];
|
|
|
|
void hid_keyboard_test(uint8_t busid)
|
|
{
|
|
const uint8_t sendbuffer[8] = { 0x00, 0x00, HID_KBD_USAGE_A, 0x00, 0x00, 0x00, 0x00, 0x00 };
|
|
|
|
if (usb_device_is_configured(busid) == false) {
|
|
return;
|
|
}
|
|
|
|
memcpy(write_buffer, sendbuffer, 8);
|
|
hid_state = HID_STATE_BUSY;
|
|
usbd_ep_start_write(busid, HID_INT_EP, write_buffer, 8);
|
|
while (hid_state == HID_STATE_BUSY) {
|
|
}
|
|
}
|