From e6981e85cdc3f96c305cc22b349c15fcf978341e Mon Sep 17 00:00:00 2001 From: Karel Bilek Date: Sun, 17 Dec 2017 03:57:13 +0100 Subject: [PATCH] Add WinUSB (WebUSB preparation) Some code taken from https://github.com/devanlai/dapboot Some code written according to the WCID documentation - https://github.com/pbatard/libwdi/wiki/WCID-Devices --- winusb.c | 160 ++++++++++++++++++++++++++++++++++++++++++++++++++ winusb.h | 30 ++++++++++ winusb_defs.h | 86 +++++++++++++++++++++++++++ 3 files changed, 276 insertions(+) create mode 100644 winusb.c create mode 100644 winusb.h create mode 100644 winusb_defs.h diff --git a/winusb.c b/winusb.c new file mode 100644 index 0000000000..1d8d645bb1 --- /dev/null +++ b/winusb.c @@ -0,0 +1,160 @@ +/* + * Copyright (c) 2016, Devan Lai + * + * Permission to use, copy, modify, and/or distribute this software + * for any purpose with or without fee is hereby granted, provided + * that the above copyright notice and this permission notice + * appear in all copies. + * + * THE SOFTWARE IS PROVIDED "AS IS" AND 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, DIRECT, 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. + */ + +#include +#include "util.h" +#include "winusb.h" + +static int usb_descriptor_type(uint16_t wValue) { + return wValue >> 8; +} + +static int usb_descriptor_index(uint16_t wValue) { + return wValue & 0xFF; +} + +static struct winusb_compatible_id_descriptor winusb_wcid = { + .header = { + .dwLength = sizeof(struct winusb_compatible_id_descriptor_header) + + 1 * sizeof(struct winusb_compatible_id_function_section), + .bcdVersion = WINUSB_BCD_VERSION, + .wIndex = WINUSB_REQ_GET_COMPATIBLE_ID_FEATURE_DESCRIPTOR, + .bNumSections = 1, + .reserved = { 0, 0, 0, 0, 0, 0, 0 }, + }, + .functions = { + { + // note - bInterfaceNumber is rewritten in winusb_setup with the correct interface number + .bInterfaceNumber = 0, + .reserved0 = { 1 }, + .compatibleId = "WINUSB", + .subCompatibleId = "", + .reserved1 = { 0, 0, 0, 0, 0, 0} + }, + } +}; + +static struct usb_string_descriptor winusb_string_descriptor = { + .bLength = sizeof(WINUSB_EXTRA_STRING) + sizeof(struct usb_string_descriptor), + .bDescriptorType = USB_DT_STRING, + .wData = WINUSB_EXTRA_STRING +}; + +static const struct winusb_extended_properties_descriptor guid = { + .header = { + .dwLength = sizeof(struct winusb_extended_properties_descriptor_header) + + 1 * sizeof (struct winusb_extended_properties_feature_descriptor), + .bcdVersion = WINUSB_BCD_VERSION, + .wIndex = WINUSB_REQ_GET_EXTENDED_PROPERTIES_OS_FEATURE_DESCRIPTOR, + .wNumFeatures = 1, + }, + .features = { + { + .dwLength = sizeof(struct winusb_extended_properties_feature_descriptor), + .dwPropertyDataType = WINUSB_EXTENDED_PROPERTIES_MULTISZ_DATA_TYPE, + .wNameLength = sizeof(u"DeviceInterfaceGUIDs"), + .name = u"DeviceInterfaceGUIDs", + .dwPropertyDataLength = (WINUSB_EXTENDED_PROPERTIES_GUIDS_SIZE_C), + .propertyData = WINUSB_EXTENDED_PROPERTIES_RANDOM_GUID, + }, + } +}; + +static int winusb_descriptor_request(usbd_device *usbd_dev, + struct usb_setup_data *req, + uint8_t **buf, uint16_t *len, + usbd_control_complete_callback* complete) { + (void)complete; + (void)usbd_dev; + + if ((req->bmRequestType & USB_REQ_TYPE_TYPE) != USB_REQ_TYPE_STANDARD) { + return USBD_REQ_NEXT_CALLBACK; + } + + if (req->bRequest == USB_REQ_GET_DESCRIPTOR && usb_descriptor_type(req->wValue) == USB_DT_STRING) { + if (usb_descriptor_index(req->wValue) == WINUSB_EXTRA_STRING_INDEX) { + *buf = (uint8_t*)(&winusb_string_descriptor); + *len = MIN(*len, winusb_string_descriptor.bLength); + return USBD_REQ_HANDLED; + } + } + return USBD_REQ_NEXT_CALLBACK; +} + +static int winusb_control_vendor_request(usbd_device *usbd_dev, + struct usb_setup_data *req, + uint8_t **buf, uint16_t *len, + usbd_control_complete_callback* complete) { + (void)complete; + (void)usbd_dev; + + if (req->bRequest != WINUSB_MS_VENDOR_CODE) { + return USBD_REQ_NEXT_CALLBACK; + } + + int status = USBD_REQ_NOTSUPP; + if (((req->bmRequestType & USB_REQ_TYPE_RECIPIENT) == USB_REQ_TYPE_DEVICE) && + (req->wIndex == WINUSB_REQ_GET_COMPATIBLE_ID_FEATURE_DESCRIPTOR)) { + *buf = (uint8_t*)(&winusb_wcid); + *len = MIN(*len, winusb_wcid.header.dwLength); + status = USBD_REQ_HANDLED; + + } else if (((req->bmRequestType & USB_REQ_TYPE_RECIPIENT) == USB_REQ_TYPE_INTERFACE) && + (req->wIndex == WINUSB_REQ_GET_EXTENDED_PROPERTIES_OS_FEATURE_DESCRIPTOR)) { + + *buf = (uint8_t*)(&guid); + *len = MIN(*len, guid.header.dwLength); + status = USBD_REQ_HANDLED; + + } else { + status = USBD_REQ_NOTSUPP; + } + + return status; +} + +static void winusb_set_config(usbd_device* usbd_dev, uint16_t wValue) { + (void)wValue; + usbd_register_control_callback( + usbd_dev, + USB_REQ_TYPE_VENDOR, + USB_REQ_TYPE_TYPE, + winusb_control_vendor_request); +} + +void winusb_setup(usbd_device* usbd_dev, uint8_t interface) { + winusb_wcid.functions[0].bInterfaceNumber = interface; + + usbd_register_set_config_callback(usbd_dev, winusb_set_config); + + /* Windows probes the compatible ID before setting the configuration, + so also register the callback now */ + + usbd_register_control_callback( + usbd_dev, + USB_REQ_TYPE_VENDOR, + USB_REQ_TYPE_TYPE, + winusb_control_vendor_request); + + usbd_register_control_callback( + usbd_dev, + USB_REQ_TYPE_DEVICE, + USB_REQ_TYPE_RECIPIENT, + winusb_descriptor_request); +} + diff --git a/winusb.h b/winusb.h new file mode 100644 index 0000000000..1f2ff9a3c9 --- /dev/null +++ b/winusb.h @@ -0,0 +1,30 @@ +/* + * Copyright (c) 2016, Devan Lai + * + * Permission to use, copy, modify, and/or distribute this software + * for any purpose with or without fee is hereby granted, provided + * that the above copyright notice and this permission notice + * appear in all copies. + * + * THE SOFTWARE IS PROVIDED "AS IS" AND 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, DIRECT, 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. + */ + +#ifndef WINUSB_H_INCLUDED +#define WINUSB_H_INCLUDED + +#include "winusb_defs.h" + +// Arbitrary, but must be equivalent to the last character in extra string +#define WINUSB_MS_VENDOR_CODE '!' +#define WINUSB_EXTRA_STRING u"MSFT100!" + +extern void winusb_setup(usbd_device* usbd_dev, uint8_t interface); + +#endif diff --git a/winusb_defs.h b/winusb_defs.h new file mode 100644 index 0000000000..3b249dd5a4 --- /dev/null +++ b/winusb_defs.h @@ -0,0 +1,86 @@ +/* + * Copyright (c) 2016, Devan Lai + * + * Permission to use, copy, modify, and/or distribute this software + * for any purpose with or without fee is hereby granted, provided + * that the above copyright notice and this permission notice + * appear in all copies. + * + * THE SOFTWARE IS PROVIDED "AS IS" AND 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, DIRECT, 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. + */ + +#ifndef WINUSB_DEFS_H_INCLUDED +#define WINUSB_DEFS_H_INCLUDED + +#include + +/* Microsoft OS 1.0 descriptors */ + +/* Extended Compat ID OS Feature Descriptor Specification */ +#define WINUSB_REQ_GET_COMPATIBLE_ID_FEATURE_DESCRIPTOR 0x04 +#define WINUSB_REQ_GET_EXTENDED_PROPERTIES_OS_FEATURE_DESCRIPTOR 0x05 +#define WINUSB_BCD_VERSION 0x0100 + +#define WINUSB_EXTENDED_PROPERTIES_GUID_NAME_SIZE_C (sizeof(u"DeviceInterfaceGUIDs")) +#define WINUSB_EXTENDED_PROPERTIES_GUID_NAME_SIZE_U (sizeof("DeviceInterfaceGUIDs")) +#define WINUSB_EXTENDED_PROPERTIES_RANDOM_GUID u"{0263b512-88cb-4136-9613-5c8e109d8ef5}\0" +// double null is intentional - it's an array of guids with 1 item + +#define WINUSB_EXTENDED_PROPERTIES_GUIDS_SIZE_C sizeof(WINUSB_EXTENDED_PROPERTIES_RANDOM_GUID) +#define WINUSB_EXTENDED_PROPERTIES_GUIDS_SIZE_U (sizeof(WINUSB_EXTENDED_PROPERTIES_RANDOM_GUID) / 2) +#define WINUSB_EXTENDED_PROPERTIES_MULTISZ_DATA_TYPE 7 + +#define WINUSB_EXTRA_STRING_INDEX 0xee + +/* Table 2. Function Section */ +struct winusb_compatible_id_function_section { + uint8_t bInterfaceNumber; + uint8_t reserved0[1]; + char compatibleId[8]; + char subCompatibleId[8]; + uint8_t reserved1[6]; +} __attribute__((packed)); + +/* Table 1. Header Section */ +struct winusb_compatible_id_descriptor_header { + uint32_t dwLength; + uint16_t bcdVersion; + uint16_t wIndex; + uint8_t bNumSections; + uint8_t reserved[7]; +} __attribute__((packed)); + +struct winusb_compatible_id_descriptor { + struct winusb_compatible_id_descriptor_header header; + struct winusb_compatible_id_function_section functions[]; +} __attribute__((packed)); + +struct winusb_extended_properties_feature_descriptor { + uint32_t dwLength; + uint32_t dwPropertyDataType; + uint16_t wNameLength; + uint16_t name[WINUSB_EXTENDED_PROPERTIES_GUID_NAME_SIZE_U]; + uint32_t dwPropertyDataLength; + uint16_t propertyData[WINUSB_EXTENDED_PROPERTIES_GUIDS_SIZE_U]; +} __attribute__((packed)); + +struct winusb_extended_properties_descriptor_header { + uint32_t dwLength; + uint16_t bcdVersion; + uint16_t wIndex; + uint16_t wNumFeatures; +} __attribute__((packed)); + +struct winusb_extended_properties_descriptor { + struct winusb_extended_properties_descriptor_header header; + struct winusb_extended_properties_feature_descriptor features[]; +} __attribute__((packed)); + +#endif