Merge branch 'master' into develop

README.md

@@ -10,6 +10,7 @@ This is a CDC/DFU/UF2 bootloader for nRF52 boards.
 - Particle Boron
 - Particle Xenon
 - MakerDiary MDK nRF52840 USB Dongle
+- [Electronut Labs Papyr](https://docs.electronut.in/papyr/)
 
 UF2 is an easy-to-use bootloader that appears as a flash drive. You can just copy `.uf2`-format
 application images to the flash drive to load new firmware.
@@ -70,6 +71,20 @@ There is an adjacent ground pad.
 
 For other boards, please check the board definition for details.
 
+### Making your own UF2
+
+To create your own UF2 DFU update image, simply use the [Python conversion script](https://github.com/Microsoft/uf2/blob/master/utils/uf2conv.py) on a .bin file or .hex file, specifying the family as **0xADA52840**. Be sure to compile your application to start at 0x26000 (152k). If using a .bin file with the conversion script you must specify this with the -b switch.
+
+To create a UF2 image from a .bin file:
+```
+uf2conv.py firmware.bin -c -b 0x26000 -f 0xADA52840
+```
+
+To create a UF2 image from a .hex file:
+```
+uf2conv.py firmware.hex -c -f 0xADA52840
+```
+
 ## Burn & Upgrade with pre-built binaries
 
 You can burn and/or upgrade the bootloader with either a J-link or DFU (serial) to a specific pre-built binary version

changelog.md

@@ -1,5 +1,11 @@
 # Adafruit nRF52 Bootloader Changelog
 
+## 0.2.10
+
+- Fixed various FAT issues, thanks to @henrygab
+- Added MakerDiary MDK nrf52840 USB dongle support, thanks to @gpshead
+- Fixed incorrect button mapping for Feather nRF52840
+
 ## 0.2.9
 
 - Fixed incomplete writes on Windows. Upated tinyusb to handle write10 completion, and use it for finalizing dfu process. Will prevent windows error message pop up. This will also give an extra time for flash writing to complete.

src/boards/electronut_labs_papyr.h

@@ -0,0 +1,99 @@
+/**************************************************************************/
+/*!
+    @file     elelctronutlabs_papyr.h
+    @author   Tavish Naruka <tavish@electronut.in>
+
+    @section LICENSE
+
+    Software License Agreement (BSD License)
+
+    Copyright (c) 2017, Adafruit Industries (adafruit.com)
+    All rights reserved.
+
+    Redistribution and use in source and binary forms, with or without
+    modification, are permitted provided that the following conditions are met:
+    1. Redistributions of source code must retain the above copyright
+    notice, this list of conditions and the following disclaimer.
+    2. Redistributions in binary form must reproduce the above copyright
+    notice, this list of conditions and the following disclaimer in the
+    documentation and/or other materials provided with the distribution.
+    3. Neither the name of the copyright holders nor the
+    names of its contributors may be used to endorse or promote products
+    derived from this software without specific prior written permission.
+
+    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ''AS IS'' AND ANY
+    EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+    WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+    DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE FOR ANY
+    DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+    (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+    LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+    ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+    (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+*/
+/**************************************************************************/
+
+#ifndef PAPYR_H
+#define PAPYR_H
+
+/*------------------------------------------------------------------*/
+/* LED
+ *------------------------------------------------------------------*/
+#define LEDS_NUMBER         2
+#define LED_PRIMARY_PIN     13
+#define LED_SECONDARY_PIN   14
+#define LED_STATE_ON        0
+
+/*------------------------------------------------------------------*/
+/* BUTTON
+ *------------------------------------------------------------------*/
+// NOTE: USB UF2 bootloader can be triggered by double pressing RESET
+// App can trigger OTA bootloader by writing DFU_MAGIC_OTA_APPJUM to
+// GPREGRET register if softdevice is not initialized; or by
+// writing DFU_MAGIC_OTA_RESET in case softdevice is initialized.
+#define BUTTONS_NUMBER      2
+#define BUTTON_1            18 // RESET also by default
+#define BUTTON_2            1  // P0.1 not exposed anywhere, FRST n/a
+#define BUTTON_PULL         NRF_GPIO_PIN_PULLUP
+
+/*------------------------------------------------------------------*/
+/* UART
+ *------------------------------------------------------------------*/
+#define RX_PIN_NUMBER       7
+#define TX_PIN_NUMBER       8
+#define CTS_PIN_NUMBER      0
+#define RTS_PIN_NUMBER      0
+#define HWFC                false
+
+// Used as model string in OTA mode
+#define DIS_MANUFACTURER    "Electronut Labs"
+#define DIS_MODEL           "Papyr"
+
+#define BOARD_ID            "Electronut Labs Papyr"
+#define INDEX_URL           "https://docs.electronut.in/papyr"
+
+#define USB_DESC_VID        0x239A
+#define USB_DESC_UF2_PID    0x003B
+
+#define USB_STRING_DESCRIPTORS {                                                                                    \
+    /* 0: is supported language = English */                                                                        \
+    TUD_DESC_STRCONV(0x0409),                                                                                       \
+                                                                                                                    \
+    /* 1: Manufacturer */                                                                                           \
+    TUD_DESC_STRCONV('E','l','e','c','t','r','o','n','u','t',' ','L','a','b','s'),                                  \
+                                                                                                                    \
+    /* 2: Product */                                                                                                \
+    TUD_DESC_STRCONV('P','a','p','y','r', ' ', 'D','F','U'),                                                        \
+                                                                                                                    \
+    /* 3: Serials TODO use chip ID */                                                                               \
+    usb_desc_str_serial,                                                                                            \
+                                                                                                                    \
+    /* 4: CDC Interface */                                                                                          \
+    TUD_DESC_STRCONV('P','a','p','y','r',' ','S','e','r','i','a','l'),                                              \
+                                                                                                                    \
+    /* 5: MSC Interface */                                                                                          \
+    TUD_DESC_STRCONV('P','a','p','y','r',' ','U','F','2'),                                                          \
+}
+
+#endif // PPAPYR_H

src/usb/usb_desc.c

@@ -63,30 +63,33 @@ enum {
 // STRING DESCRIPTORS
 //--------------------------------------------------------------------+
 
+#ifndef USB_STRING_DESCRIPTORS
+#define USB_STRING_DESCRIPTORS {                                                                                 \
+    /* 0: is supported language = English */                                                                        \
+    TUD_DESC_STRCONV(0x0409),                                                                                       \
+                                                                                                                    \
+    /* 1: Manufacturer */                                                                                           \
+    TUD_DESC_STRCONV('A','d','a','f','r','u','i','t',' ','I','n','d','u','s','t','r','i','e','s'),                  \
+                                                                                                                    \
+    /* 2: Product */                                                                                                \
+    TUD_DESC_STRCONV('B','l','u','e','f','r','u','i','t',' ','n','R','F','5','2','8','4','0', ' ', 'D','F','U'),    \
+                                                                                                                    \
+    /* 3: Serials TODO use chip ID */                                                                               \
+    usb_desc_str_serial,                                                                                            \
+                                                                                                                    \
+    /* 4: CDC Interface */                                                                                          \
+    TUD_DESC_STRCONV('B','l','u','e','f','r','u','i','t',' ','S','e','r','i','a','l'),                              \
+                                                                                                                    \
+    /* 5: MSC Interface */                                                                                          \
+    TUD_DESC_STRCONV('B','l','u','e','f','r','u','i','t',' ','U','F','2'),                                          \
+}
+#endif
+
 // Serial is 64-bit DeviceID -> 16 chars len
 uint16_t usb_desc_str_serial[1+16] = { TUD_DESC_STR_HEADER(16) };
 
 // array of pointer to string descriptors
-uint16_t const * const string_desc_arr [] =
+uint16_t const * const string_desc_arr [] = USB_STRING_DESCRIPTORS;
-{
-    // 0: is supported language = English
-    TUD_DESC_STRCONV(0x0409),
-
-    // 1: Manufacturer
-    TUD_DESC_STRCONV('A','d','a','f','r','u','i','t',' ','I','n','d','u','s','t','r','i','e','s'),
-
-    // 2: Product
-    TUD_DESC_STRCONV('B','l','u','e','f','r','u','i','t',' ','n','R','F','5','2','8','4','0', ' ', 'D','F','U'),
-
-    // 3: Serials TODO use chip ID
-    usb_desc_str_serial,
-
-    // 4: CDC Interface
-    TUD_DESC_STRCONV('B','l','u','e','f','r','u','i','t',' ','S','e','r','i','a','l'),
-
-    // 5: MSC Interface
-    TUD_DESC_STRCONV('B','l','u','e','f','r','u','i','t',' ','U','F','2'),
-};
 
 //--------------------------------------------------------------------+
 // Device Descriptor

src/usb/usb_desc.h

@@ -26,15 +26,23 @@
 #define USB_DESC_H_
 
 #include "tusb.h"
+#include "boards.h"
 
 #ifdef __cplusplus
  extern "C" {
 #endif
 
+#ifndef USB_DESC_VID
 #define USB_DESC_VID                0x239A
+#endif
 
+#ifndef USB_DESC_UF2_PID
 #define USB_DESC_UF2_PID            0x0029
+#endif
+
+#ifndef USB_DESC_SERIAL_ONLY_PID
 #define USB_DESC_SERIAL_ONLY_PID    0x002A
+#endif
 
 
 /*------------- Configuration Descriptor -------------*/