Merge branch 'adafruit:master' into nrf52840-bboard

Author: ddB0515

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,61 @@
+name: Bug Report
+description: Report a problem
+labels: 'Bug'
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this bug report!
+        It's okay to leave some blank if it doesn't apply to your problem.
+
+  - type: dropdown
+    attributes:
+      label: Operating System
+      options:
+              - Linux
+              - MacOS
+              - RaspberryPi OS
+              - Windows 7
+              - Windows 10
+              - Windows 11
+              - Others
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: INFO_UF2.TXT
+      placeholder: Paste your INFO_UF2.TXT contents here
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: What happened ?
+      placeholder: A clear and concise description of what the bug is.
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: How to reproduce ?
+      placeholder: |
+        1. Go to '...'
+        2. Click on '....'
+        3. See error      
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Debug Log
+      placeholder: Debug log attached txt file.
+    validations:
+      required: false
+
+  - type: textarea
+    attributes:
+      label: Screenshots
+      description: If applicable, add screenshots to help explain your problem.
+    validations:
+      required: false

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -23,21 +23,24 @@ jobs:
           - 'feather_nrf52840_sense'
           - 'itsybitsy_nrf52840_express'
           - 'metro_nrf52840_express'
-          # Alphabetical order
+          - 'ledglasses_nrf52840'
+          # Other Makers (Alphabetical order)
           - 'adm_b_nrf52840_1'
           - 'ae_bl652_bo'
           - 'aramcon_badge_2019'
           - 'aramcon2_badge'
           - 'arcade_feather_nrf52840_express'
           - 'arduino_nano_33_ble'
           - 'bast_ble'
+          - 'bluemicro_nrf52833'
           - 'bluemicro_nrf52840'
           - 'ebyte_e104_bt5032a'
           - 'ebyte_e73_tbb'
           - 'electronut_labs_papyr'
           - 'ikigaisense_vita'
           - 'm60_keyboard'
           - 'mdk_nrf52840_dongle'
+          - 'mikoto'
           - 'nice_nano'
           - 'nrf52840_m2'
           - 'nrf52840_bboard'
@@ -49,6 +52,7 @@ jobs:
           - 'pca10059'
           - 'pca10100'
           - 'pitaya_go'
+          - 'raytac_mdbt50q_db_40'
           - 'raytac_mdbt50q_rx'
           - 'sparkfun_nrf52840_micromod'
           - 'waveshare_nrf52840_eval'
@@ -63,11 +67,18 @@ jobs:
     - name: Checkout Code
       uses: actions/checkout@v1
       with:
-        submodules: true      
+        submodules: true
+
+    - name: Checkout linkermap
+      uses: actions/checkout@v2
+      with:
+         repository: hathach/linkermap
+         path: linkermap
 
     - name: Install Toolchains
       run: |
         pip3 install adafruit-nrfutil uritemplate requests intelhex
+        pip3 install linkermap/
         npm install --global xpm
         # 9.3.1-1.2.1 is xpack modified version which significantly increased compiled size to 6-7KB and cause flash overflow.
         # Skip this version for now, we will try again with next official release from ARM
@@ -78,34 +89,20 @@ jobs:
       run: |
         make BOARD=${{ matrix.board }} all
         make BOARD=${{ matrix.board }} copy-artifact
+
+    - name: Linker Map
+      run: make BOARD=${{ matrix.board }} linkermap
 
     - uses: actions/upload-artifact@v2
       with:
         name: ${{ matrix.board }}
         path: _bin/${{ matrix.board }}
 
-    - name: Create Release Asset
-      if: ${{ github.event_name == 'release' }}
-      run: zip -jr ${{ matrix.board }}_bootloader-${{ github.event.release.tag_name }}.zip _bin/${{ matrix.board }}
-
     - name: Upload Release Asset
-      uses: actions/upload-release-asset@v1
-      env:
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-      if: ${{ github.event_name == 'release' }}
-      with:
-        upload_url: ${{ github.event.release.upload_url }}
-        asset_path: ${{ matrix.board }}_bootloader-${{ github.event.release.tag_name }}.zip
-        asset_name: ${{ matrix.board }}_bootloader-${{ github.event.release.tag_name }}.zip
-        asset_content_type: application/zip
-      
-    - name: Upload Release Asset for Self-Update
-      uses: actions/upload-release-asset@v1
-      env:
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      uses: softprops/action-gh-release@v1
       if: ${{ github.event_name == 'release' }}
       with:
-        upload_url: ${{ github.event.release.upload_url }}
-        asset_path: _bin/${{ matrix.board }}/update-${{ matrix.board }}_bootloader-${{ github.event.release.tag_name }}_nosd.uf2
-        asset_name: update-${{ matrix.board }}_bootloader-${{ github.event.release.tag_name }}_nosd.uf2
-        asset_content_type: application/x-binary
+        files: |
+          _bin/${{ matrix.board }}/${{ matrix.board }}_bootloader-*.zip
+          _bin/${{ matrix.board }}/${{ matrix.board }}_bootloader-*.hex
+          _bin/${{ matrix.board }}/update-${{ matrix.board }}_bootloader-*.uf2

.github/workflows/githubci.yml

@@ -15,7 +15,10 @@ TUSB_PATH    = lib/tinyusb/src
 NRFX_PATH    = lib/nrfx
 SD_PATH      = lib/softdevice/$(SD_FILENAME)
 
-SD_VERSION   = 6.1.1
+ifndef SD_VERSION
+   SD_VERSION   = 6.1.1
+endif
+
 SD_FILENAME  = $(SD_NAME)_nrf52_$(SD_VERSION)
 SD_HEX       = $(SD_PATH)/$(SD_FILENAME)_softdevice.hex
 
@@ -104,14 +107,17 @@ ifeq ($(MCU_SUB_VARIANT),nrf52)
   SD_NAME = s132
   DFU_DEV_REV = 0xADAF
   CFLAGS += -DNRF52 -DNRF52832_XXAA -DS132
+  CFLAGS += -DDFU_APP_DATA_RESERVED=7*4096
 else ifeq ($(MCU_SUB_VARIANT),nrf52833)
   SD_NAME = s140
   DFU_DEV_REV = 52840
   CFLAGS += -DNRF52833_XXAA -DS140
+  CFLAGS += -DDFU_APP_DATA_RESERVED=7*4096
 else ifeq ($(MCU_SUB_VARIANT),nrf52840)
   SD_NAME = s140
   DFU_DEV_REV = 52840
   CFLAGS += -DNRF52840_XXAA -DS140
+  CFLAGS += -DDFU_APP_DATA_RESERVED=10*4096
 else
   $(error Sub Variant $(MCU_SUB_VARIANT) is unknown)
 endif
@@ -121,13 +127,14 @@ endif
 #------------------------------------------------------------------------------
 
 # all files in src
-C_SRC += $(wildcard src/*.c)
+C_SRC += \
+  src/dfu_ble_svc.c \
+  src/dfu_init.c \
+  src/flash_nrf5x.c \
+  src/main.c \
 
 # all files in boards
-C_SRC += $(wildcard src/boards/*.c)
-
-# all sources files in specific board
-C_SRC += $(wildcard src/boards/$(BOARD)/*.c)
+C_SRC += src/boards/boards.c
 
 # nrfx
 C_SRC += $(NRFX_PATH)/drivers/src/nrfx_power.c
@@ -169,18 +176,25 @@ IPATH += $(SDK_PATH)/drivers_nrf/uart
 
 else
 
+# pinconfig is required for 840 for CF2
+C_SRC += src/boards/$(BOARD)/pinconfig.c
+
 # USB Application ( MSC + UF2 )
-C_SRC += $(wildcard src/usb/*.c)
-C_SRC += $(wildcard src/usb/uf2/*.c)
+C_SRC += \
+	src/usb/msc_uf2.c \
+	src/usb/usb_desc.c \
+	src/usb/usb.c \
+	src/usb/uf2/ghostfat.c
 
 # TinyUSB stack
-C_SRC += $(TUSB_PATH)/portable/nordic/nrf5x/dcd_nrf5x.c
-C_SRC += $(TUSB_PATH)/common/tusb_fifo.c
-C_SRC += $(TUSB_PATH)/device/usbd.c
-C_SRC += $(TUSB_PATH)/device/usbd_control.c
-C_SRC += $(TUSB_PATH)/class/cdc/cdc_device.c
-C_SRC += $(TUSB_PATH)/class/msc/msc_device.c
-C_SRC += $(TUSB_PATH)/tusb.c
+C_SRC += \
+	$(TUSB_PATH)/portable/nordic/nrf5x/dcd_nrf5x.c \
+	$(TUSB_PATH)/common/tusb_fifo.c \
+	$(TUSB_PATH)/device/usbd.c \
+	$(TUSB_PATH)/device/usbd_control.c \
+	$(TUSB_PATH)/class/cdc/cdc_device.c \
+	$(TUSB_PATH)/class/msc/msc_device.c \
+	$(TUSB_PATH)/tusb.c
 
 endif
 
@@ -232,15 +246,6 @@ IPATH += $(SD_PATH)/$(SD_FILENAME)_API/include/nrf52
 # Compiler Flags
 #------------------------------------------------------------------------------
 
-# Debug option use RTT for printf
-ifeq ($(DEBUG), 1)
-	RTT_SRC = lib/SEGGER_RTT
-	
-	CFLAGS += -DCFG_DEBUG -DSEGGER_RTT_MODE_DEFAULT=SEGGER_RTT_MODE_BLOCK_IF_FIFO_FULL
-	IPATH += $(RTT_SRC)/RTT
-  C_SRC += $(RTT_SRC)/RTT/SEGGER_RTT.c
-endif
-
 #flags common to all targets
 CFLAGS += \
 	-mthumb \
@@ -276,6 +281,18 @@ CFLAGS += -Wno-unused-parameter -Wno-expansion-to-defined
 # TinyUSB tusb_hal_nrf_power_event
 CFLAGS += -Wno-cast-function-type
 
+# Nordic Softdevice SDK header files contains inline assembler that has
+# broken constraints. As a result the IPA-modref pass, introduced in gcc-11,
+# is able to "prove" that arguments to wrapper functions generated with
+# the SVCALL() macro are unused and, as a result, the optimizer will remove
+# code within the callers that sets up these arguments (which results in
+# a broken bootloader). The broken headers come from Nordic-supplied zip
+# files and are not trivial to patch so, for now, we'll simply disable the
+# new gcc-11 inter-procedural optimizations.
+ifeq (,$(findstring unrecognized,$(shell $(CC) $(CFLAGS) -fno-ipa-modref 2>&1)))
+CFLAGS += -fno-ipa-modref
+endif
+
 # Defined Symbol (MACROS)
 CFLAGS += -D__HEAP_SIZE=0
 CFLAGS += -DCONFIG_GPIO_AS_PINRESET
@@ -286,14 +303,20 @@ ifneq ($(USE_NFCT),yes)
 endif
 
 CFLAGS += -DSOFTDEVICE_PRESENT
-CFLAGS += -DDFU_APP_DATA_RESERVED=7*4096
-
 CFLAGS += -DUF2_VERSION='"$(GIT_VERSION) $(GIT_SUBMODULE_VERSIONS)"'
 CFLAGS += -DBLEDIS_FW_VERSION='"$(GIT_VERSION) $(SD_NAME) $(SD_VERSION)"'
 
 _VER = $(subst ., ,$(word 1, $(subst -, ,$(GIT_VERSION))))
 CFLAGS += -DMK_BOOTLOADER_VERSION='($(word 1,$(_VER)) << 16) + ($(word 2,$(_VER)) << 8) + $(word 3,$(_VER))'
 
+# Debug option use RTT for printf
+ifeq ($(DEBUG), 1)
+  CFLAGS += -DCFG_DEBUG -DSEGGER_RTT_MODE_DEFAULT=SEGGER_RTT_MODE_BLOCK_IF_FIFO_FULL
+  RTT_SRC = lib/SEGGER_RTT
+  IPATH += $(RTT_SRC)/RTT
+  C_SRC += $(RTT_SRC)/RTT/SEGGER_RTT.c
+endif
+
 #------------------------------------------------------------------------------
 # Linker Flags
 #------------------------------------------------------------------------------
@@ -353,6 +376,10 @@ clean:
 	@$(RM) $(BUILD)
 	@$(RM) $(BIN)
 
+# linkermap must be install previously at https://github.com/hathach/linkermap
+linkermap: $(BUILD)/$(OUT_NAME).out
+	@linkermap -v $<.map
+
 # Create objects from C SRC files
 $(BUILD)/%.o: %.c
 	@echo CC $(notdir $<)

Makefile

@@ -10,6 +10,7 @@ This is a CDC/DFU/UF2 bootloader for nRF52 boards.
 - [Adafruit Feather nRF52840 Express](https://www.adafruit.com/product/4062)
 - [Adafruit Feather nRF52840 Sense](https://www.adafruit.com/product/4516)
 - [Adafruit ItsyBitsy nRF52840 Express](https://www.adafruit.com/product/4481)
+- [Adafruit LED Glasses Driver nRF52840](https://www.adafruit.com/product/5217)
 - Adafruit Metro nRF52840 Express
 - [Akizukidenshi AE-BL652-BO](https://akizukidenshi.com/catalog/g/gK-15567/)
 - [Electronut Labs Papyr](https://docs.electronut.in/papyr/)
@@ -78,16 +79,24 @@ 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**. If using a .bin file with the conversion script you must specify application address with the -b switch, this address depend on the SoftDevice size/version e.g S140 v6 is 0x26000
+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** (nRF52840) or **0x621E937A** (nRF52833). 
 
-To create a UF2 image from a .bin file:
 ```
-uf2conv.py firmware.bin -c -b 0x26000 -f 0xADA52840
+nRF52840
+uf2conv.py firmware.hex -c -f 0xADA52840
+
+nRF52833
+uf2conv.py firmware.hex -c -f 0x621E937A
 ```
 
-To create a UF2 image from a .hex file:
+If using a .bin file with the conversion script you must specify application address with the -b switch, this address depend on the SoftDevice size/version e.g S140 v6 is 0x26000, v7 is 0x27000
+
 ```
-uf2conv.py firmware.hex -c -f 0xADA52840
+nRF52840
+uf2conv.py firmware.bin -c -b 0x26000 -f 0xADA52840
+
+nRF52833
+uf2conv.py firmware.bin -c -b 0x27000 -f 0x621E937A
 ```
 
 To create a UF2 image for bootloader from a .hex file using separated family of **0xd663823c**

README.md

@@ -1,5 +1,14 @@
 # Adafruit nRF52 Bootloader Changelog
 
+## 0.6.2 - 2021.09.10
+
+- Add new board "LED Glasses Driver nRF52840"
+
+## 0.6.1 - 2021.08.04
+
+- Fix failed to upgrade ssue when flashing uf2 with more than 512KB payload
+- Increased application reserved from 28KB  to 40KB for nrf52840 to match circuitpython usage. 
+
 ## 0.6.0 - 2021.06.19
 
 - Update tinyusb to latest to fix the race condition with control transfer, which could cause failed to connect to DFU Serial occasionally.