Differences

This shows you the differences between two versions of the page.

--- s340_softdevice_adafruit_nrf52840_feather_express [2020/02/07 21:21]
orrmany [Get the ANT SoftDevice]
+++ s340_softdevice_adafruit_nrf52840_feather_express [2020/03/04 12:12]
orrmany [C. Modify the Adafruit bootloader]
@@ Line 22: / Line 22: @@
 **BEWARE**: trying to install the CircuitPython UF2 package to a S340-adapted Feather will brick your Feather and you will need to use a SWD programmer device to make your Feather usable again!
 ==== Credits ====
-A number of internet resources helped me. The biggest help came as form of a personal mail from "Ryan", whom I got acquainted with by [[https://www.arduinolibraries.info/authors/cujomalainey|Curtis Malainey]]. It was "Ryan", who first managed the S340 SoftDevice to work with his Feather and he kindly shared his steps with me. This guide is based primarily on his work.
+A number of internet resources helped me. The biggest help came as form of a personal mail from [[https://github.com/rtgree01|rtgree01]], whom I got acquainted with by [[https://www.arduinolibraries.info/authors/cujomalainey|Curtis Malainey]]. It was him, who first managed the S340 SoftDevice to work with his Feather and he kindly shared his steps with me. This guide is based primarily on his work.
   *   [[https://github.com/charlesportwoodii/Adafruit_nRF52_Bootloader]] -- some interesting learnings about the bootloader
   * [[https://learn.sparkfun.com/tutorials/nrf52840-advanced-development-with-the-nrf5-sdk]] -- I learnt a lot about using the nRF5 SDK and the ARM-GCC workflow
-  * [[https://learn.sparkfun.com/tutorials/nrf52840-development-with-arduino-and-circuitpython]] tons of info about what does it take to add a new board-type to the Arduino IDE. This also helped a lot in understanding Ryan's comments about his PlatformIO adaptation.
+  * [[https://learn.sparkfun.com/tutorials/nrf52840-development-with-arduino-and-circuitpython]] tons of info about what does it take to add a new board-type to the Arduino IDE. This also helped a lot in understanding rtgree01's comments about his PlatformIO adaptation.
   * The Adafruit nrf52 bootloader: [[https://github.com/adafruit/Adafruit_nRF52_Bootloader]]
   * A blog entry of a similar bootloader hack success. but with the SparkFun PRo Mini board:  . https://judepereira.com/blog/nrf52840-flash-s340/
-===== Prequisites =====
+===== Prerequisites =====
 ==== Must to have  ====
   * You will need, obviously, an [[https://www.adafruit.com/product/4062|Adafruit Feather nRF52840 Express]]
@@ Line 45: / Line 45: @@
   * This can be also used for the [[https://platformio.org/platformio-ide|PlatformIO IDE]] support
 ===== Adapting the bootloader =====
-==== Warm-up: Rebuild the Adafruit bootloader ====
+Note: this tutorial is based on the v.6.1.1 versions of the NordicSemi softdevices and the 0.3.0 version of the Adafruit bootloader
+==== A. Warm-up: Rebuild the Adafruit bootloader ====
 . Clone the Adafruit bootloader from https://github.com/adafruit/Adafruit_nRF52_Bootloader. It contains two submodules, hence you need to clone it recursively. I used to the [[https://desktop.github.com/|GitHub Desktop]], which does recursive cloning automagically
@@ Line 67: / Line 68: @@
 </code>
-If you run into any trouble, then **DO NOT PROCEED until you can successfully rebuild the original bootloader and flash it into your device!!** (If you can't build and flash the original version, then it makes no sense to try to hack it.
+If you run into any trouble, then **DO NOT PROCEED further down within this lazy-guide until you can successfully rebuild the original bootloader and flash it into your device!!** (If you can't build and flash the original version, then it makes no sense to try to hack it.)
-==== Get the ANT SoftDevice ====
+==== B. Get the ANT SoftDevice ====
-Download S340 SoftDevice from
+Download [[https://www.thisisant.com/developer/components/nrf52832#tab_protocol_stacks_tab|S340 SoftDevice]] from thisisant.com.
-==== Modify the Adafruit bootloader ====
+Unpack it somewhere. You will need to rename and copy it later.
-=== Adapt the Makefile ===
-<code cpp>
+==== C. Modify the Adafruit bootloader ====
-@@ -104,6 +104,11 @@ else ifeq ($(MCU_SUB_VARIANT),nrf52840)
+=== 1. Adapt the Makefile ===
-else
+Insert the following after setting flags according to MCU_SUB_VARIANTS after line #106:
-  $(error Sub Variant $(MCU_SUB_VARIANT) is unknown)
+<code Makefile>
-endif
 ifdef USE_S340
 #if S340 then adjust SD_NAME and MCU
@@ Line 83: / Line 83: @@
   MCU_FLAGS = -DNRF52840_XXAA -DS340
 endif
+</code>
+The graphical diff looks like this (left is orginal, right is modified)
+{{ :make-diff.png?direct |Makefile diff}}
+=== 2. Insert the S340 SoftDevice headers and binary into the source tree ===
+Go to ...\lib\softdevice\. Create a dir called s340_nrf52_6.1.1:
+<code bash>
+...\lib\softdevice $ mkdir s340_nrf52_6.1.1
+</code>
+This directory needs to store the v6.1.1 version of the BLE+ANT combinded S340 softdevice headers + the .hex binary.
+The way you can get that is described here: [[https://www.nordicsemi.com/Software-and-tools/Software/S340-ANT]]
+**IMPORTANT:**
+  - you should rename the .hex file to: s340_nrf52_6.1.1_softdevice.hex
+  - You should put the S340 library headers under: s340_nrf52_6.1.1_API
+That is, your resulted library tree should look exactly like this:
+<code>
+s340_nrf52_6.1.1/
+├── s340_nrf52_6.1.1_API
+│   └── include
+│       ├── ant_error.h
+│       ├── ant_interface.h
+│       ├── ant_parameters.h
+│       ├── ble.h
+│       ├── ble_err.h
+│       ├── ble_gap.h
+│       ├── ble_gatt.h
+│       ├── ble_gattc.h
+│       ├── ble_gatts.h
+│       ├── ble_hci.h
+│       ├── ble_l2cap.h
+│       ├── ble_ranges.h
+│       ├── ble_types.h
+│       ├── nrf52
+│       │   └── nrf_mbr.h
+│       ├── nrf_error.h
+│       ├── nrf_error_sdm.h
+│       ├── nrf_error_soc.h
+│       ├── nrf_nvic.h
+│       ├── nrf_sd_def.h
+│       ├── nrf_sdm.h
+│       ├── nrf_soc.h
+│       └── nrf_svc.h
+└── s340_nrf52_6.1.1_softdevice.hex
+</code>
+=== 3. Modify nrf_sdm.h ===
+  * Go to .../lib/softdevice/s340_nrf52_6.1.1/s340_nrf52_6.1.1_API/include/
+  * Modify 'nrf_sdm.h' at line #191: uncomment the ANT_LICENSE_KEY //in case your use of the softdevice conforms to the Garmin licensing conditions for [[https://www.thisisant.com/developer/ant/licensing|ANT evaluation license]]//!. If not, then you must obtain a commercial license.
+The graphical diff looks like this (left is orginal, right is modified)
+{{ ::nrfsdm.png?direct |}}
+=== 4. Create a new board definition called ''feather_nrf52840_express_s340''===
+  * Go to ... /src/boards/.
+  * Copy the 'feather_nrf52840_express' dir to 'feather_nrf52840_express_s340'
+  * Go into the 'feather_nrf52840_express_s340' subdir, which was just freshly created by copying 'feather_nrf52840_express' over.
+== Modify src/boards/feather_nrf52840_express_s340/board.h ==
+  * Change the #include guards from "_FEATHER_NRF52840_H" to something else, say _FEATHER_NRF52840_S340_H
+  * Change the "BLEDIS_MODEL" to something else, say "Feather nRF52840 Express w.ANT"
+  * Change the "UF2_PRODUCT_NAME" to something else, say ""Adafruit Feather nRF52840 Express w.ANT"
+The graphical diff looks like this (left is orginal, right is modified)
+{{ ::boardh-diff.png?direct |}}
+== Modify src/boards/feather_nrf52840_express_s340/board.mk ==
+  - Add "USE_S340 = true" to the end of the file as a new line
+The graphical diff looks like this (left is orginal, right is modified)
+{{ ::boardmk-diff.png?direct |}}
+=== 5. Modify the linker script of the UF2 bootloader ===
+Go to .../src/usb/uf2. Modify the "USER_FLASH_START" definition inside uf2cfg.h:
+  * In case of the original S140 the flash area shall start at 0x26000
+  * In case of the S340 the flash area shall start at 0x31000
+That is, the "USER_FLASH_START" shall be defined as follows:
+<code cpp>
+#ifdef S340
+#define USER_FLASH_START   0x31000
+#else // #ifdef S340
+#define USER_FLASH_START   0x26000
+#endif // #ifdef S340
+</code>
+The graphical diff looks like this (left is orginal, right is modified)
+{{ ::flash-diff.png?direct |}}
+=== 6. Create a new GCC linker script for the freshly defined board ===
+   - Go to .../src/linker directory.
+   - Copy the S140 linker script as S340 linker, as follows
+<code bash>
+src/linker $ cp nrf52840_s140_v6.ld nrf52840_s340_v6.ld
+</code>
+=== 7. Adapt the main.c program ===
+  - Go to .../src/
+  - Adapt .../src/main.c to supply the ANT_LICENSE_KEY for the softdevice  enable in case of S340, otherwise call the function //without// the key, as follows:
+<code cpp>
+#ifndef ANT_LICENSE_KEY
+APP_ERROR_CHECK( sd_softdevice_enable(&clock_cfg, app_error_fault_handler) );
+#else
+APP_ERROR_CHECK( sd_softdevice_enable(&clock_cfg, app_error_fault_handler, ANT_LICENSE_KEY) );
+#endif
+</code>
+The graphical diff looks like this (left is orginal, right is modified)
+{{ ::mainc-diff.png?direct |}}
+==== D. Build and flash the modified Adafruit bootloader ====
+Go to the root of the bootloader directory tree. Build and flash as follows.
+**NOTE**: adapt the GNU_INSTALL_ROOT and SERIAL definitions according to your local setup!
+<code bash>
+make GNU_INSTALL_ROOT="C:/Program Files (x86)/GNU Tools Arm Embedded/9 2019-q4-major/bin/"  BOARD=feather_nrf52840_express_s340 all combinehex
+make GNU_INSTALL_ROOT="C:/Program Files (x86)/GNU Tools Arm Embedded/9 2019-q4-major/bin/"  BOARD=feather_nrf52840_express_s340 SERIAL=COM5 dfu-flash
+</code>
+Enjoy :)
+If you got confused you can check my forked repo at: https://github.com/orrmany/Adafruit_nRF52_Bootloader/tree/s340-for-nrf52840-Feather
+==== E. Appendix: a transcript of my build ====
+<code bash>
+C:\Users\egbozie\Google Drive\Arduino\libraries\Adafruit_nRF52_Bootloader>make BOARD=feather_nrf52840_express all combinehex
+CC main.c
+CC boards.c
+CC flash_nrf5x.c
+CC dfu_ble_svc.c
+CC dfu_init.c
+CC nrfx_power.c
+CC nrfx_nvmc.c
+CC system_nrf52840.c
+CC bootloader.c
+CC bootloader_settings.c
+CC bootloader_util.c
+CC dfu_transport_serial.c
+CC dfu_transport_ble.c
+CC dfu_single_bank.c
+CC pstorage_raw.c
+CC ble_dfu.c
+CC ble_dis.c
+CC app_timer.c
+CC app_scheduler.c
+CC app_error.c
+CC app_util_platform.c
+CC crc16.c
+CC hci_mem_pool.c
+CC hci_slip.c
+CC hci_transport.c
+CC nrf_assert.c
+CC usb_desc.c
+CC usb.c
+CC msc_uf2.c
+CC ghostfat.c
+CC dcd_nrf5x.c
+CC tusb_fifo.c
+CC usbd.c
+CC usbd_control.c
+CC cdc_device.c
+CC msc_device.c
+CC tusb.c
+AS gcc_startup_nrf52840.S
+LD feather_nrf52840_express_bootloader-0.2.13-21-g454b281-dirty-nosd.out
+''
+   text    data     bss     dec     hex filename
+     212   22426   53014    cf16 _build-feather_nrf52840_express/feather_nrf52840_express_bootloader-0.2.13-21-g454b281-dirty-nosd.out
+''
+CR feather_nrf52840_express_bootloader-0.2.13-21-g454b281-dirty-nosd.hex
+CR feather_nrf52840_express_bootloader-0.2.13-21-g454b281-dirty_s340_6.1.1.hex
+C:\Users\egbozie\Google Drive\Arduino\libraries\Adafruit_nRF52_Bootloader>make BOARD=feather_nrf52840_express SERIAL=COM5 dfu-flash
+LD feather_nrf52840_express_bootloader-0.2.13-21-g454b281-dirty-nosd.out
+CR feather_nrf52840_express_bootloader-0.2.13-21-g454b281-dirty-nosd.hex
+Zip created at _build-feather_nrf52840_express/feather_nrf52840_express_bootloader-0.2.13-21-g454b281-dirty_s340_6.1.1.zip
+adafruit-nrfutil --verbose dfu serial --package _build-feather_nrf52840_express/feather_nrf52840_express_bootloader-0.2.13-21-g454b281-dirty_s340_6.1.1.zip -p COM5 -b 115200 --singlebank --touch 1200
+Upgrading target on COM5 with DFU package C:\Users\egbozie\Google Drive\Arduino\libraries\Adafruit_nRF52_Bootloader\_build-feather_nrf52840_express\feather_nrf52840_express_bootloader-0.2.13-21-g454b281-dirty_s340_6.1.1.zip. Flow control is disabled, Single bank, Touch 1200
+Touched serial port COM5
+Opened serial port COM5
+Starting DFU upgrade of type 3, SoftDevice size: 190272, bootloader size: 30580, application size: 0
+Sending DFU start packet
+Sending DFU init packet
+Sending firmware file
+########################################
+########################################
+########################################
+########################################
+########################################
+########################################
+########################################
+########################################
+########################################
+########################################
+################################
+Activating new firmware
+DFU upgrade took 24.582117557525635s
+Device programmed.
+C:\Users\egbozie\Google Drive\Arduino\libraries\Adafruit_nRF52_Bootloader>
-#******************************************************************************
-# SOURCE FILES
 </code>

Orrmany wiki

User Tools

Site Tools

Differences

Page Tools