atmel-samd: More USB polish

tannewt · tannewt · commit 4aeef100f6d7 · 2017-10-30T18:29:20.000-07:00
* Introduce a python script to generate the USB descriptor instead of a bunch of C macros. In the future, we can use this dynamically in CircuitPython. * Add support for detecting read-only mass storage mounts. Fixes adafruit#377
diff --git a/extmod/vfs_fat.h b/extmod/vfs_fat.h
@@ -35,8 +35,8 @@
 #define FSUSER_NATIVE        (0x0001) // readblocks[2]/writeblocks[2] contain native func
 #define FSUSER_FREE_OBJ      (0x0002) // fs_user_mount_t obj should be freed on umount
 #define FSUSER_HAVE_IOCTL    (0x0004) // new protocol with ioctl
-// Device is write-able over USB and read-only to MicroPython.
-#define FSUSER_USB_WRITEABLE (0x0008)
+// Device is writable over USB and read-only to MicroPython.
+#define FSUSER_USB_WRITABLE (0x0008)
 
 typedef struct _fs_user_mount_t {
     mp_obj_base_t base;
diff --git a/extmod/vfs_fat_diskio.c b/extmod/vfs_fat_diskio.c
@@ -98,9 +98,9 @@ DSTATUS disk_status (
     }
 
     // This is used to determine the writeability of the disk from MicroPython.
-    // So, if its USB writeable we make it read-only from MicroPython.
+    // So, if its USB writable we make it read-only from MicroPython.
     if (vfs->writeblocks[0] == MP_OBJ_NULL ||
-        (vfs->flags & FSUSER_USB_WRITEABLE) != 0) {
+        (vfs->flags & FSUSER_USB_WRITABLE) != 0) {
         return STA_PROTECT;
     } else {
         return 0;
diff --git a/main.c b/main.c
@@ -234,8 +234,8 @@ int __attribute__((used)) main(void) {
     autoreload_enable();
 
     // By default our internal flash is readonly to local python code and
-    // writeable over USB. Set it here so that boot.py can change it.
-    filesystem_default_writeable(false);
+    // writable over USB. Set it here so that boot.py can change it.
+    filesystem_writable_by_python(false);
 
     // If not in safe mode, run boot before initing USB and capture output in a
     // file.
@@ -244,12 +244,12 @@ int __attribute__((used)) main(void) {
         #ifdef CIRCUITPY_BOOT_OUTPUT_FILE
         // Since USB isn't up yet we can cheat and let ourselves write the boot
         // output file.
-        filesystem_default_writeable(true);
+        filesystem_writable_by_python(true);
         FIL file_pointer;
         boot_output_file = &file_pointer;
         f_open(&((fs_user_mount_t *) MP_STATE_VM(vfs_mount_table)->obj)->fatfs,
             boot_output_file, CIRCUITPY_BOOT_OUTPUT_FILE, FA_WRITE | FA_CREATE_ALWAYS);
-        filesystem_default_writeable(false);
+        filesystem_writable_by_python(false);
         #endif
 
         // TODO(tannewt): Re-add support for flashing boot error output.
diff --git a/ports/atmel-samd/Makefile b/ports/atmel-samd/Makefile
@@ -73,8 +73,6 @@ BASE_CFLAGS = \
 	-Wcast-align \
 	-Wno-error=lto-type-mismatch \
 	-D__$(CHIP_VARIANT)__ \
-	-DCONF_USB_COMPOSITE_IDPRODUCT=$(USB_PID) \
-	-DCONF_USB_COMPOSITE_IDVENDER=$(USB_VID) \
 	-ffunction-sections \
 	-fdata-sections \
 	-fshort-enums \
@@ -233,6 +231,7 @@ SRC_C = \
 	lib/utils/sys_stdio_mphal.c \
 	lib/libc/string0.c \
 	lib/mp-readline/readline.c \
+	$(BUILD)/autogen_usb_descriptor.c \
 	# freetouch/adafruit_ptc.c
 
 # Choose which flash filesystem impl to use.
@@ -359,6 +358,14 @@ $(BUILD)/firmware.uf2: $(BUILD)/firmware.bin
 	$(ECHO) "Create $@"
 	python2 $(TOP)/tools/uf2/utils/uf2conv.py -b $(BOOTLOADER_SIZE) -c -o $@ $^
 
+$(BUILD)/autogen_usb_descriptor.c: tools/gen_usb_descriptor.py Makefile
+	python3 tools/gen_usb_descriptor.py \
+		--manufacturer $(USB_MANUFACTURER)\
+		--product $(USB_PRODUCT)\
+		--vid $(USB_VID)\
+		--pid $(USB_PID)\
+		$@
+
 deploy: $(BUILD)/firmware.bin
 	$(ECHO) "Writing $< to the board"
 	$(BOSSAC) -u $<
diff --git a/ports/atmel-samd/asf4 b/ports/atmel-samd/asf4
@@ -1 +1 @@
-Subproject commit e1d02fde5d23a704d33d74e18fcf624eb56132c5
+Subproject commit 1ca9e1f86921d99f0fbc907698f864a60caf675a
diff --git a/ports/atmel-samd/asf4_conf/samd21/hpl_usb_config.h b/ports/atmel-samd/asf4_conf/samd21/hpl_usb_config.h
@@ -39,7 +39,7 @@
 // <CONF_USB_D_N_EP_MAX"> Max possible (by "Max Endpoint Number" config)
 // <id> usbd_num_ep_sp
 #ifndef CONF_USB_D_NUM_EP_SP
-#define CONF_USB_D_NUM_EP_SP CONF_USB_D_EP_N_MAX
+#define CONF_USB_D_NUM_EP_SP CONF_USB_D_N_EP_MAX
 #endif
 
 // </h>
@@ -118,7 +118,7 @@
 // <1024=> Cached by 1024 bytes buffer (interrupt or isochronous EP)
 // <id> usb_ep1_I_CACHE
 #ifndef CONF_USB_EP1_I_CACHE
-#define CONF_USB_EP1_I_CACHE 64
+#define CONF_USB_EP1_I_CACHE 0
 #endif
 // </h>
 
@@ -176,7 +176,7 @@
 // <1024=> Cached by 1024 bytes buffer (interrupt or isochronous EP)
 // <id> usb_arch_ep3_cache
 #ifndef CONF_USB_EP3_CACHE
-#define CONF_USB_EP3_CACHE 64
+#define CONF_USB_EP3_CACHE 0
 #endif
 
 // <o> Cache buffer size for EP3 IN
@@ -194,7 +194,7 @@
 // <1024=> Cached by 1024 bytes buffer (interrupt or isochronous EP)
 // <id> usb_ep3_I_CACHE
 #ifndef CONF_USB_EP3_I_CACHE
-#define CONF_USB_EP3_I_CACHE 0
+#define CONF_USB_EP3_I_CACHE 64
 #endif
 // </h>
 
@@ -252,7 +252,7 @@
 // <1024=> Cached by 1024 bytes buffer (interrupt or isochronous EP)
 // <id> usb_arch_ep5_cache
 #ifndef CONF_USB_EP5_CACHE
-#define CONF_USB_EP5_CACHE 64
+#define CONF_USB_EP5_CACHE 0
 #endif
 
 // <o> Cache buffer size for EP5 IN
@@ -290,7 +290,7 @@
 // <1024=> Cached by 1024 bytes buffer (interrupt or isochronous EP)
 // <id> usb_arch_ep6_cache
 #ifndef CONF_USB_EP6_CACHE
-#define CONF_USB_EP6_CACHE 64
+#define CONF_USB_EP6_CACHE 0
 #endif
 
 // <o> Cache buffer size for EP6 IN
@@ -308,7 +308,7 @@
 // <1024=> Cached by 1024 bytes buffer (interrupt or isochronous EP)
 // <id> usb_ep6_I_CACHE
 #ifndef CONF_USB_EP6_I_CACHE
-#define CONF_USB_EP6_I_CACHE 64
+#define CONF_USB_EP6_I_CACHE 0
 #endif
 // </h>
 
@@ -328,7 +328,7 @@
 // <1024=> Cached by 1024 bytes buffer (interrupt or isochronous EP)
 // <id> usb_arch_ep7_cache
 #ifndef CONF_USB_EP7_CACHE
-#define CONF_USB_EP7_CACHE 64
+#define CONF_USB_EP7_CACHE 0
 #endif
 
 // <o> Cache buffer size for EP7 IN
diff --git a/ports/atmel-samd/asf4_conf/samd51/hpl_usb_config.h b/ports/atmel-samd/asf4_conf/samd51/hpl_usb_config.h
@@ -120,7 +120,7 @@
 // <1024=> Cached by 1024 bytes buffer (interrupt or isochronous EP)
 // <id> usb_ep1_I_CACHE
 #ifndef CONF_USB_EP1_I_CACHE
-#define CONF_USB_EP1_I_CACHE 64
+#define CONF_USB_EP1_I_CACHE 0
 #endif
 // </h>
 
@@ -158,7 +158,7 @@
 // <1024=> Cached by 1024 bytes buffer (interrupt or isochronous EP)
 // <id> usb_ep2_I_CACHE
 #ifndef CONF_USB_EP2_I_CACHE
-#define CONF_USB_EP2_I_CACHE 0
+#define CONF_USB_EP2_I_CACHE 64
 #endif
 // </h>
 
diff --git a/ports/atmel-samd/boards/arduino_zero/mpconfigboard.mk b/ports/atmel-samd/boards/arduino_zero/mpconfigboard.mk
@@ -1,6 +1,8 @@
 LD_FILE = boards/samd21x18-bootloader.ld
 USB_VID = 0x2341
 USB_PID = 0x824D
+USB_PRODUCT = "Arduino Zero"
+USB_MANUFACTURER = "Arduino"
 
 INTERNAL_FLASH_FILESYSTEM = 1
 
diff --git a/ports/atmel-samd/boards/circuitplayground_express/mpconfigboard.mk b/ports/atmel-samd/boards/circuitplayground_express/mpconfigboard.mk
@@ -1,6 +1,8 @@
 LD_FILE = boards/samd21x18-bootloader-crystalless.ld
 USB_VID = 0x239A
 USB_PID = 0x8019
+USB_PRODUCT = "CircuitPlayground Express"
+USB_MANUFACTURER = "Adafruit Industries LLC"
 
 #SPI_FLASH_FILESYSTEM = 1
 INTERNAL_FLASH_FILESYSTEM = 1
diff --git a/ports/atmel-samd/boards/feather_m0_adalogger/mpconfigboard.mk b/ports/atmel-samd/boards/feather_m0_adalogger/mpconfigboard.mk
@@ -1,6 +1,8 @@
 LD_FILE = boards/samd21x18-bootloader.ld
 USB_VID = 0x239A
 USB_PID = 0x8015
+USB_PRODUCT = "Feather M0 Adalogger"
+USB_MANUFACTURER = "Adafruit Industries LLC"
 
 INTERNAL_FLASH_FILESYSTEM = 1
 
diff --git a/ports/atmel-samd/boards/feather_m0_basic/mpconfigboard.mk b/ports/atmel-samd/boards/feather_m0_basic/mpconfigboard.mk
@@ -1,6 +1,8 @@
 LD_FILE = boards/samd21x18-bootloader.ld
 USB_VID = 0x239A
 USB_PID = 0x8015
+USB_PRODUCT = "Feather M0"
+USB_MANUFACTURER = "Adafruit Industries LLC"
 
 INTERNAL_FLASH_FILESYSTEM = 1
 
diff --git a/ports/atmel-samd/boards/feather_m0_express/mpconfigboard.mk b/ports/atmel-samd/boards/feather_m0_express/mpconfigboard.mk
@@ -1,6 +1,8 @@
 LD_FILE = boards/samd21x18-bootloader.ld
 USB_VID = 0x239A
 USB_PID = 0x801b
+USB_PRODUCT = "Feather M0 Express"
+USB_MANUFACTURER = "Adafruit Industries LLC"
 
 #SPI_FLASH_FILESYSTEM = 1
 INTERNAL_FLASH_FILESYSTEM = 1
diff --git a/ports/atmel-samd/boards/gemma_m0/mpconfigboard.mk b/ports/atmel-samd/boards/gemma_m0/mpconfigboard.mk
@@ -1,6 +1,8 @@
 LD_FILE = boards/samd21x18-bootloader.ld
 USB_VID = 0x239A
 USB_PID = 0x801D
+USB_PRODUCT = "Gemma M0"
+USB_MANUFACTURER = "Adafruit Industries LLC"
 
 INTERNAL_FLASH_FILESYSTEM = 1
 
diff --git a/ports/atmel-samd/boards/metro_m0_express/mpconfigboard.mk b/ports/atmel-samd/boards/metro_m0_express/mpconfigboard.mk
@@ -1,6 +1,8 @@
 LD_FILE = boards/samd21x18-bootloader.ld
 USB_VID = 0x239A
 USB_PID = 0x8014
+USB_PRODUCT = "Metro M0 Express"
+USB_MANUFACTURER = "Adafruit Industries LLC"
 
 #SPI_FLASH_FILESYSTEM = 1
 INTERNAL_FLASH_FILESYSTEM = 1
diff --git a/ports/atmel-samd/boards/metro_m4_express/mpconfigboard.mk b/ports/atmel-samd/boards/metro_m4_express/mpconfigboard.mk
@@ -1,6 +1,8 @@
 LD_FILE = boards/samd51x19-bootloader.ld
 USB_VID = 0x239A
 USB_PID = 0x8021
+USB_PRODUCT = "Metro M4 Express"
+USB_MANUFACTURER = "Adafruit Industries LLC"
 
 #SPI_FLASH_FILESYSTEM = 1
 INTERNAL_FLASH_FILESYSTEM = 1
diff --git a/ports/atmel-samd/boards/trinket_m0/mpconfigboard.mk b/ports/atmel-samd/boards/trinket_m0/mpconfigboard.mk
@@ -1,6 +1,8 @@
 LD_FILE = boards/samd21x18-bootloader.ld
 USB_VID = 0x239A
 USB_PID = 0x801F
+USB_PRODUCT = "Trinket M0"
+USB_MANUFACTURER = "Adafruit Industries LLC"
 
 INTERNAL_FLASH_FILESYSTEM = 1
 
diff --git a/ports/atmel-samd/boards/trinket_m0_haxpress/mpconfigboard.mk b/ports/atmel-samd/boards/trinket_m0_haxpress/mpconfigboard.mk
@@ -1,6 +1,8 @@
 LD_FILE = boards/samd21x18-bootloader-external-flash-crystalless.ld
 USB_VID = 0x239A
 USB_PID = 0x801F
+USB_PRODUCT="Trinket M0 Haxpress"
+USB_MANUFACTURER="Radomir Dopieralski"
 
 #SPI_FLASH_FILESYSTEM = 1
 INTERNAL_FLASH_FILESYSTEM = 1
diff --git a/ports/atmel-samd/common-hal/storage/__init__.c b/ports/atmel-samd/common-hal/storage/__init__.c
@@ -42,5 +42,5 @@ void common_hal_storage_remount(const char* mount_path, bool readonly) {
         mp_raise_RuntimeError("Cannot remount '/' when USB is active.");
     }
 
-    flash_set_usb_writeable(readonly);
+    flash_set_usb_writable(readonly);
 }
diff --git a/ports/atmel-samd/flash_api.c b/ports/atmel-samd/flash_api.c
@@ -30,7 +30,7 @@
 
 #define VFS_INDEX 0
 
-void flash_set_usb_writeable(bool usb_writeable) {
+void flash_set_usb_writable(bool usb_writable) {
     mp_vfs_mount_t* current_mount = MP_STATE_VM(vfs_mount_table);
     for (uint8_t i = 0; current_mount != NULL; i++) {
         if (i == VFS_INDEX) {
@@ -43,9 +43,9 @@ void flash_set_usb_writeable(bool usb_writeable) {
     }
     fs_user_mount_t *vfs = (fs_user_mount_t *) current_mount->obj;
 
-    if (usb_writeable) {
-        vfs->flags |= FSUSER_USB_WRITEABLE;
+    if (usb_writable) {
+        vfs->flags |= FSUSER_USB_WRITABLE;
     } else {
-        vfs->flags &= ~FSUSER_USB_WRITEABLE;
+        vfs->flags &= ~FSUSER_USB_WRITABLE;
     }
 }
diff --git a/ports/atmel-samd/flash_api.h b/ports/atmel-samd/flash_api.h
@@ -31,6 +31,6 @@
 extern void flash_init_vfs(fs_user_mount_t *vfs);
 extern void flash_flush(void);
 
-void flash_set_usb_writeable(bool usb_writeable);
+void flash_set_usb_writable(bool usb_writable);
 
 #endif  // MICROPY_INCLUDED_ATMEL_SAMD_FLASH_API_H
diff --git a/ports/atmel-samd/supervisor/filesystem.c b/ports/atmel-samd/supervisor/filesystem.c
@@ -85,8 +85,8 @@ void filesystem_flush(void) {
     flash_flush();
 }
 
-void filesystem_default_writeable(bool writeable) {
-    flash_set_usb_writeable(writeable);
+void filesystem_writable_by_python(bool writable) {
+    flash_set_usb_writable(!writable);
 }
 
 bool filesystem_present(void) {
diff --git a/ports/atmel-samd/supervisor/serial.c b/ports/atmel-samd/supervisor/serial.c
@@ -29,25 +29,33 @@
 #include "supervisor/serial.h"
 
 #include "usb.h"
+#include "tools/autogen_usb_descriptor.h"
 
-// Serial number as hex characters.
-// char serial_number[USB_DEVICE_GET_SERIAL_NAME_LENGTH];
-// void load_serial_number(void) {
-//     char nibble_to_hex[16] = {'0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'A',
-//         'B', 'C', 'D', 'E', 'F'};
-//     uint32_t* addresses[4] = {(uint32_t *) 0x0080A00C, (uint32_t *) 0x0080A040,
-//                               (uint32_t *) 0x0080A044, (uint32_t *) 0x0080A048};
-//     for (int i = 0; i < 4; i++) {
-//         for (int j = 0; j < 8; j++) {
-//             uint8_t nibble = (*(addresses[i]) >> j * 4) & 0xf;
-//             serial_number[i * 8 + j] = nibble_to_hex[nibble];
-//         }
-//     }
-// }
-
-// SAMD51 addresses: 0x008061FC, 0x00806010, 0x00806014, 0x00806018
+// Serial number as hex characters. This writes directly to the USB
+// descriptor.
+void load_serial_number(void) {
+    char nibble_to_hex[16] = {'0', '1', '2', '3', '4', '5', '6', '7', '8', '9',
+                              'A', 'B', 'C', 'D', 'E', 'F'};
+    #ifdef SAMD21
+    uint32_t* addresses[4] = {(uint32_t *) 0x0080A00C, (uint32_t *) 0x0080A040,
+                              (uint32_t *) 0x0080A044, (uint32_t *) 0x0080A048};
+    #endif
+    #ifdef SAMD51
+    uint32_t* addresses[4] = {(uint32_t *) 0x008061FC, (uint32_t *) 0x00806010,
+                              (uint32_t *) 0x00806014, (uint32_t *) 0x00806018};
+    #endif
+    for (int i = 0; i < 4; i++) {
+        for (int j = 0; j < 8; j++) {
+            uint8_t nibble = (*(addresses[i]) >> j * 4) & 0xf;
+            // Strings are UTF-16-LE encoded.
+            serial_number[i * 16 + j * 2] = nibble_to_hex[nibble];
+            serial_number[i * 16 + j * 2 + 1] = 0;
+        }
+    }
+}
 
 void serial_init(void) {
+    load_serial_number();
     init_usb();
 }
 
diff --git a/ports/atmel-samd/tools/autogen_usb_descriptor.h b/ports/atmel-samd/tools/autogen_usb_descriptor.h
@@ -0,0 +1,36 @@
+/*
+ * This file is part of the Micro Python project, http://micropython.org/
+ *
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2017 Scott Shawcroft for Adafruit Industries
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+#ifndef __MICROPY_INCLUDED_ATMEL_SAMD_TOOLS_AUTOGEN_USB_DESCRIPTOR_H__
+#define __MICROPY_INCLUDED_ATMEL_SAMD_TOOLS_AUTOGEN_USB_DESCRIPTOR_H__
+
+#include "usb/device/usbdc.h"
+
+struct usbd_descriptors descriptor_bounds;
+uint8_t* serial_number;
+uint8_t serial_number_length;
+
+#endif // __MICROPY_INCLUDED_ATMEL_SAMD_TOOLS_AUTOGEN_USB_DESCRIPTOR_H__
diff --git a/ports/atmel-samd/tools/gen_usb_descriptor.py b/ports/atmel-samd/tools/gen_usb_descriptor.py
diff --git a/ports/atmel-samd/usb.c b/ports/atmel-samd/usb.c
diff --git a/ports/atmel-samd/usb_mass_storage.c b/ports/atmel-samd/usb_mass_storage.c
diff --git a/ports/atmel-samd/usb_mass_storage.h b/ports/atmel-samd/usb_mass_storage.h
diff --git a/supervisor/filesystem.h b/supervisor/filesystem.h
diff --git a/supervisor/stub/filesystem.c b/supervisor/stub/filesystem.c
diff --git a/tools/usb_descriptor/cdc.py b/tools/usb_descriptor/cdc.py
diff --git a/tools/usb_descriptor/core.py b/tools/usb_descriptor/core.py
