Expose DeviceID through USB descriptors in DFU mode, Microsoft WCID support

bootloader/import.mk

@@ -1,5 +1,5 @@
 BOOTLOADER_MODULE_PATH ?= $(PROJECT_ROOT)/bootloader
-BOOTLOADER_VERSION ?= 7
+BOOTLOADER_VERSION ?= 8
 BOOTLOADER_BUILD_PATH_EXT = $(BUILD_TARGET_PLATFORM)
 
 # bring in the include folders from inc and src/<platform> is includes

bootloader/src/stm32f2xx/deviceid_hal.c

@@ -0,0 +1,33 @@
+// pull in the sources from the HAL. It's a bit of a hack, but is simpler than trying to link the
+// full hal library.
+#define HAL_DEVICE_ID_NO_DCT
+#include "../src/stm32f2xx/deviceid_hal.c"
+
+// Pulled from system_cloud_internal.cpp
+
+static inline char ascii_nibble(uint8_t nibble) {
+    char hex_digit = nibble + 48;
+    if (57 < hex_digit)
+        hex_digit += 7;
+    return hex_digit;
+}
+
+static inline char* concat_nibble(char* p, uint8_t nibble)
+{
+    *p++ = ascii_nibble(nibble);
+    return p;
+}
+
+char* bytes2hexbuf(const uint8_t* buf, unsigned len, char* out)
+{
+    unsigned i;
+    char* result = out;
+    for (i = 0; i < len; ++i)
+    {
+        concat_nibble(out, (buf[i] >> 4));
+        out++;
+        concat_nibble(out, (buf[i] & 0xF));
+        out++;
+    }
+    return result;
+}

bootloader/src/stm32f2xx/dfu_usb.c

@@ -38,6 +38,7 @@ USB_OTG_CORE_HANDLE USB_OTG_dev;
 
 /* Extern variables ----------------------------------------------------------*/
 /* Private function prototypes -----------------------------------------------*/
+static uint8_t HAL_DFU_USB_Handle_Vendor_Request(USB_SETUP_REQ* req, uint8_t dataStage);
 /* Private functions ---------------------------------------------------------*/
 
 uint8_t is_application_valid(uint32_t address)
@@ -49,6 +50,21 @@ uint8_t is_application_valid(uint32_t address)
 #endif
 }
 
+static void dummy(void) {}
+static void dummy1(uint8_t speed) {}
+
+USBD_Usr_cb_TypeDef DFU_USR_cb =
+{
+        dummy, // USBD_USR_Init,
+        dummy1, // USBD_USR_DeviceReset,
+        dummy, // USBD_USR_DeviceConfigured,
+        dummy, // USBD_USR_DeviceSuspended,
+        dummy, // USBD_USR_DeviceResumed,
+        dummy, // USBD_USR_DeviceConnected,
+        dummy, // USBD_USR_DeviceDisconnected,
+        HAL_DFU_USB_Handle_Vendor_Request
+};
+
 /*******************************************************************************
  * Function Name  : HAL_DFU_USB_Init.
  * Description    : Initialize USB for DFU class.
@@ -65,5 +81,14 @@ void HAL_DFU_USB_Init(void)
               USB_OTG_HS_CORE_ID,
 #endif
               &USR_desc, &DFU_cb,
-              NULL); // Passing NULL here to reduce bootloader flash requirements
+              &DFU_USR_cb); // Passing NULL here to reduce bootloader flash requirements
+}
+
+uint8_t HAL_DFU_USB_Handle_Vendor_Request(USB_SETUP_REQ* req, uint8_t dataStage) {
+    // Forward to DFU class driver
+    if (req != NULL && req->bRequest == 0xee && req->wIndex == 0x0004 && req->wValue == 0x0000) {
+        return DFU_cb.Setup(&USB_OTG_dev, req);
+    }
+
+    return USBD_FAIL;
 }

bootloader/src/stm32f2xx/usbd_desc.c

@@ -31,21 +31,26 @@
 #include "usbd_desc.h"
 #include "usbd_req.h"
 #include "usb_regs.h"
+#include "usbd_wcid.h"
+
+#include "deviceid_hal.h"
+extern char* bytes2hexbuf(const uint8_t* buf, unsigned len, char* out);
 
 #define USBD_LANGID_STRING              0x0409  //U.S. English
 #define USBD_MANUFACTURER_STRING        "Particle"
 
-#define USBD_PRODUCT_HS_STRING          "Photon DFU Mode"
-#define USBD_SERIALNUMBER_HS_STRING     "00000000010B"
-
-#define USBD_PRODUCT_FS_STRING          "Photon DFU Mode"
-#define USBD_SERIALNUMBER_FS_STRING     "00000000010C"
+#if PLATFORM_ID == 10
+# define USBD_PRODUCT_NAME              "Electron"
+#elif PLATFORM_ID == 8
+# define USBD_PRODUCT_NAME              "P1"
+#else
+# define USBD_PRODUCT_NAME              "Photon"
+#endif
+#define USBD_PRODUCT_STRING             USBD_PRODUCT_NAME " " "DFU Mode"
+#define USBD_CONFIGURATION_STRING       "DFU"
+#define USBD_INTERFACE_STRING           "DFU"
 
-#define USBD_CONFIGURATION_HS_STRING    "DFU Config"
-#define USBD_INTERFACE_HS_STRING        "DFU Interface"
-
-#define USBD_CONFIGURATION_FS_STRING    "DFU Config"
-#define USBD_INTERFACE_FS_STRING        "DFU Interface"
+static uint8_t *  USBD_USR_MsftStrDescriptor( uint8_t speed , uint16_t *length);
 
 USBD_DEVICE USR_desc =
 {
@@ -56,6 +61,7 @@ USBD_DEVICE USR_desc =
         USBD_USR_SerialStrDescriptor,
         USBD_USR_ConfigStrDescriptor,
         USBD_USR_InterfaceStrDescriptor,
+        USBD_USR_MsftStrDescriptor
 };
 
 /* USB Standard Device Descriptor */
@@ -73,8 +79,8 @@ uint8_t USBD_DeviceDesc[USB_SIZ_DEVICE_DESC] =
         HIBYTE(USBD_VID_SPARK),     /*idVendor*/
         LOBYTE(USBD_PID_DFU),       /*idProduct*/
         HIBYTE(USBD_PID_DFU),       /*idProduct*/
-        0x00,                       /*bcdDevice rel. 2.00*/
-        0x02,
+        LOBYTE(0x0250),             /*bcdDevice (2.50) */
+        HIBYTE(0x0250),             /*bcdDevice (2.50) */
         USBD_IDX_MFC_STR,           /*Index of manufacturer  string*/
         USBD_IDX_PRODUCT_STR,       /*Index of product string*/
         USBD_IDX_SERIAL_STR,        /*Index of serial number string*/
@@ -105,6 +111,15 @@ uint8_t USBD_LangIDDesc[USB_SIZ_STRING_LANGID] =
         HIBYTE(USBD_LANGID_STRING),
 };
 
+/* MS OS String Descriptor */
+static const uint8_t USBD_MsftStrDesc[] = {
+    USB_WCID_MS_OS_STRING_DESCRIPTOR(
+        // "MSFT100"
+        USB_WCID_DATA('M', '\0', 'S', '\0', 'F', '\0', 'T', '\0', '1', '\0', '0', '\0', '0', '\0'),
+        0xee
+    )
+};
+
 /**
  * @brief  USBD_USR_DeviceDescriptor
  *         return the device descriptor
@@ -140,14 +155,7 @@ uint8_t *  USBD_USR_LangIDStrDescriptor( uint8_t speed , uint16_t *length)
  */
 uint8_t *  USBD_USR_ProductStrDescriptor( uint8_t speed , uint16_t *length)
 {
-    if(speed == USB_OTG_SPEED_HIGH)
-    {
-        USBD_GetString (USBD_PRODUCT_HS_STRING, USBD_StrDesc, length);
-    }
-    else
-    {
-        USBD_GetString (USBD_PRODUCT_FS_STRING, USBD_StrDesc, length);
-    }
+    USBD_GetString (USBD_PRODUCT_STRING, USBD_StrDesc, length);
     return USBD_StrDesc;
 }
 
@@ -173,14 +181,12 @@ uint8_t *  USBD_USR_ManufacturerStrDescriptor( uint8_t speed , uint16_t *length)
  */
 uint8_t *  USBD_USR_SerialStrDescriptor( uint8_t speed , uint16_t *length)
 {
-    if(speed == USB_OTG_SPEED_HIGH)
-    {
-        USBD_GetString (USBD_SERIALNUMBER_HS_STRING, USBD_StrDesc, length);
-    }
-    else
-    {
-        USBD_GetString (USBD_SERIALNUMBER_FS_STRING, USBD_StrDesc, length);
-    }
+    uint8_t deviceId[16];
+    char deviceIdHex[sizeof(deviceId) * 2 + 1] = {0};
+    unsigned deviceIdLen = 0;
+    deviceIdLen = HAL_device_ID(deviceId, sizeof(deviceId));
+    bytes2hexbuf(deviceId, deviceIdLen, deviceIdHex);
+    USBD_GetString (deviceIdHex, USBD_StrDesc, length);
     return USBD_StrDesc;
 }
 
@@ -193,14 +199,7 @@ uint8_t *  USBD_USR_SerialStrDescriptor( uint8_t speed , uint16_t *length)
  */
 uint8_t *  USBD_USR_ConfigStrDescriptor( uint8_t speed , uint16_t *length)
 {
-    if(speed == USB_OTG_SPEED_HIGH)
-    {
-        USBD_GetString (USBD_CONFIGURATION_HS_STRING, USBD_StrDesc, length);
-    }
-    else
-    {
-        USBD_GetString (USBD_CONFIGURATION_FS_STRING, USBD_StrDesc, length);
-    }
+    USBD_GetString (USBD_CONFIGURATION_STRING, USBD_StrDesc, length);
     return USBD_StrDesc;
 }
 
@@ -213,13 +212,19 @@ uint8_t *  USBD_USR_ConfigStrDescriptor( uint8_t speed , uint16_t *length)
  */
 uint8_t *  USBD_USR_InterfaceStrDescriptor( uint8_t speed , uint16_t *length)
 {
-    if(speed == USB_OTG_SPEED_HIGH)
-    {
-        USBD_GetString (USBD_INTERFACE_HS_STRING, USBD_StrDesc, length);
-    }
-    else
-    {
-        USBD_GetString (USBD_INTERFACE_FS_STRING, USBD_StrDesc, length);
-    }
+    USBD_GetString (USBD_INTERFACE_STRING, USBD_StrDesc, length);
     return USBD_StrDesc;
 }
+
+/**
+ * @brief  USBD_USR_MsftStrDescriptor
+ *         return MS OS String Descriptor
+ * @param  speed : current device speed
+ * @param  length : pointer to data length variable
+ * @retval pointer to descriptor buffer
+ */
+uint8_t *  USBD_USR_MsftStrDescriptor( uint8_t speed , uint16_t *length)
+{
+    *length = sizeof(USBD_MsftStrDesc);
+    return (uint8_t*)USBD_MsftStrDesc;
+}

hal-dynalib/src/hal_usb.c

@@ -0,0 +1 @@
+#include "hal_dynalib_usb.h"

hal/inc/hal_dynalib_usart.h

@@ -78,6 +78,7 @@ DYNALIB_FN(BASE_IDX2 + 1, hal_usart, HAL_USART_Write_NineBitData, uint32_t(HAL_U
 DYNALIB_FN(BASE_IDX2 + 2, hal_usart, HAL_USART_Send_Break, void(HAL_USART_Serial, void*))
 DYNALIB_FN(BASE_IDX2 + 3, hal_usart, HAL_USART_Break_Detected, uint8_t(HAL_USART_Serial))
 
+
 DYNALIB_END(hal_usart)
 
 #undef BASE_IDX

hal/inc/hal_dynalib_usb.h

@@ -0,0 +1,80 @@
+/**
+ ******************************************************************************
+ * @file    hal_dynalib_usb.h
+ * @authors Andrey Tolstoy
+ * @date    24 April 2016
+ ******************************************************************************
+  Copyright (c) 2016 Particle Industries, Inc.  All rights reserved.
+  This library is free software; you can redistribute it and/or
+  modify it under the terms of the GNU Lesser General Public
+  License as published by the Free Software Foundation, either
+  version 3 of the License, or (at your option) any later version.
+  This library is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+  Lesser General Public License for more details.
+  You should have received a copy of the GNU Lesser General Public
+  License along with this library; if not, see <http://www.gnu.org/licenses/>.
+ ******************************************************************************
+ */
+
+#ifndef HAL_DYNALIB_USB_H
+#define HAL_DYNALIB_USB_H
+
+#include "dynalib.h"
+#include "usb_config_hal.h"
+
+#ifdef DYNALIB_EXPORT
+#include "usb_hal.h"
+#endif
+
+DYNALIB_BEGIN(hal_usb)
+
+#ifdef USB_CDC_ENABLE
+DYNALIB_FN(0, hal_usb, HAL_USB_USART_Init, void(HAL_USB_USART_Serial, const HAL_USB_USART_Config*))
+DYNALIB_FN(1, hal_usb, HAL_USB_USART_Begin, void(HAL_USB_USART_Serial, uint32_t, void *))
+DYNALIB_FN(2, hal_usb, HAL_USB_USART_End, void(HAL_USB_USART_Serial))
+DYNALIB_FN(3, hal_usb, HAL_USB_USART_Baud_Rate, unsigned int(HAL_USB_USART_Serial))
+DYNALIB_FN(4, hal_usb, HAL_USB_USART_Available_Data, int32_t(HAL_USB_USART_Serial))
+DYNALIB_FN(5, hal_usb, HAL_USB_USART_Available_Data_For_Write, int32_t(HAL_USB_USART_Serial))
+DYNALIB_FN(6, hal_usb, HAL_USB_USART_Receive_Data, int32_t(HAL_USB_USART_Serial, uint8_t))
+DYNALIB_FN(7, hal_usb, HAL_USB_USART_Send_Data, int32_t(HAL_USB_USART_Serial, uint8_t))
+DYNALIB_FN(8, hal_usb, HAL_USB_USART_Flush_Data, void(HAL_USB_USART_Serial))
+DYNALIB_FN(9, hal_usb, HAL_USB_USART_Is_Enabled, bool(HAL_USB_USART_Serial))
+DYNALIB_FN(10, hal_usb, HAL_USB_USART_Is_Connected, bool(HAL_USB_USART_Serial))
+#define BASE_IDX 11
+#else
+#define BASE_IDX 0
+#endif
+
+#ifdef USB_HID_ENABLE
+DYNALIB_FN(BASE_IDX + 0, hal_usb, HAL_USB_HID_Init, void(uint8_t, void*))
+DYNALIB_FN(BASE_IDX + 1, hal_usb, HAL_USB_HID_Begin, void(uint8_t, void*))
+DYNALIB_FN(BASE_IDX + 2, hal_usb, HAL_USB_HID_Send_Report, void(uint8_t, void*, uint16_t, void*))
+DYNALIB_FN(BASE_IDX + 3, hal_usb, HAL_USB_HID_End, void(uint8_t))
+# define BASE_IDX1 (BASE_IDX + 4)
+#else
+# define BASE_IDX1 BASE_IDX
+#endif
+
+#if defined(USB_CDC_ENABLE) || defined(USB_HID_ENABLE)
+DYNALIB_FN(BASE_IDX1 + 0, hal_usb, HAL_USB_Init, void(void))
+DYNALIB_FN(BASE_IDX1 + 1, hal_usb, HAL_USB_Attach, void(void))
+DYNALIB_FN(BASE_IDX1 + 2, hal_usb, HAL_USB_Detach, void(void))
+# define BASE_IDX2 (BASE_IDX1 + 3)
+#else
+# define BASE_IDX2 BASE_IDX1
+#endif
+
+#ifdef USB_VENDOR_REQUEST_ENABLE
+DYNALIB_FN(BASE_IDX2 + 0, hal_usb, HAL_USB_Set_Vendor_Request_Callback, void(HAL_USB_Vendor_Request_Callback, void*))
+# define BASE_IDX3 (BASE_IDX2 + 1)
+#else
+# define BASE_IDX3 BASE_IDX2
+#endif
+
+DYNALIB_END(hal_usb)
+
+#undef BASE_IDX
+
+#endif  /* HAL_DYNALIB_USB_H */

hal/inc/usb_config_hal.h

@@ -27,17 +27,36 @@
 /* We are temporary defining this macro over here */
 /* This could also be passed via -D option in build script */
 #define SPARK_USB_SERIAL        //Default is Virtual COM Port
-//#define SPARK_USB_MOUSE
-//#define SPARK_USB_KEYBOARD
-
-#if !defined (SPARK_USB_SERIAL) && !defined (SPARK_USB_MOUSE) && !defined (SPARK_USB_KEYBOARD)
-#define USB_CDC_ENABLE	//Use USB Serial feature by default if none is defined
-#elif defined (SPARK_USB_SERIAL)
-#define USB_CDC_ENABLE	//Enable USB CDC code
-#elif defined (SPARK_USB_MOUSE) || defined (SPARK_USB_KEYBOARD)
-#define USB_HID_ENABLE	//Enable USB HID code
+
+#if PLATFORM_ID >= 6
+# define SPARK_USB_MOUSE
+# define SPARK_USB_KEYBOARD
+
+# if !defined (SPARK_USB_SERIAL) && !defined (SPARK_USB_MOUSE) && !defined (SPARK_USB_KEYBOARD)
+#  define USB_CDC_ENABLE  //Use USB Serial feature by default if none is defined
+# else
+#  if defined(SPARK_USB_SERIAL)
+#   define USB_CDC_ENABLE  //Enable USB CDC code
+#  endif
+#  if defined (SPARK_USB_MOUSE) || defined (SPARK_USB_KEYBOARD)
+#   define USB_HID_ENABLE  //Enable USB HID code
+#  endif
+# endif
+
+#else
+
+# if !defined (SPARK_USB_SERIAL) && !defined (SPARK_USB_MOUSE) && !defined (SPARK_USB_KEYBOARD)
+#  define USB_CDC_ENABLE	//Use USB Serial feature by default if none is defined
+# elif defined (SPARK_USB_SERIAL)
+#  define USB_CDC_ENABLE	//Enable USB CDC code
+# elif defined (SPARK_USB_MOUSE) || defined (SPARK_USB_KEYBOARD)
+#  define USB_HID_ENABLE	//Enable USB HID code
+# endif
 #endif
 
+#if PLATFORM_ID == 6 || PLATFORM_ID == 8 || PLATFORM_ID == 10
+# define USB_VENDOR_REQUEST_ENABLE
+#endif // PLATFORM_ID == 6 || 8 || 10
 
 #endif	/* USB_CONFIG_HAL_H */