Merge pull request #66 from adafruit/develop

Clean up board and makefile

Author: dhalbert

Makefile

@@ -1,11 +1,11 @@
 #******************************************************************************
 # CONFIGURE
-# - SDK_PATH : path to SDK directory
-# - SRC_PATH : path to src folder
+# - SDK_PATH    : path to SDK directory
+# - SRC_PATH    : path to src folder
 #
-# - SD_NAME  : e.g s132, s140
-# - SD_VER1, SD_VER2, SD_VER3: SoftDevice version e.g 6.0.0
-# - SD_HEX   : to bootloader hex binary
+# - SD_NAME     : e.g s132, s140
+# - SD_VERSION : SoftDevice version e.g 6.0.0
+# - SD_HEX      : to bootloader hex binary
 #******************************************************************************
 SRC_PATH     = src
 
@@ -16,26 +16,20 @@ SD_PATH      = lib/softdevice/$(SD_FILENAME)
 TUSB_PATH    = lib/tinyusb/src
 NRFX_PATH    = lib/nrfx
 
-SD_VER1      = 6
-SD_VER2      = 1
-SD_VER3      = 1
-
-SD_VERSION   = $(SD_VER1).$(SD_VER2).$(SD_VER3)
+SD_VERSION   = 6.1.1
 SD_FILENAME  = $(SD_NAME)_nrf52_$(SD_VERSION)
 SD_API_PATH  = $(SD_PATH)/$(SD_FILENAME)_API
 SD_HEX       = $(SD_PATH)/$(SD_FILENAME)_softdevice.hex
 
-LD_FILE      = $(SRC_PATH)/linker/$(SD_NAME)_v$(SD_VER1).ld
+LD_FILE      = $(SRC_PATH)/linker/$(SD_NAME)_v$(word 1, $(subst ., ,$(SD_VERSION))).ld
 
 MERGED_FNAME = $(OUTPUT_FILENAME)_$(SD_NAME)_$(SD_VERSION)
 
-
-MK_DIS_FIRMWARE = "$(SD_NAME) $(SD_VERSION)"
-
 GIT_VERSION = $(shell git describe --dirty --always --tags)
 GIT_SUBMODULE_VERSIONS = $(shell git submodule status | cut -d' ' -f3,4 | paste -s -d" " -)
 
 OUTPUT_FILENAME = $(BOARD)_bootloader-$(GIT_VERSION)
+
 #******************************************************************************
 # Tool configure
 #******************************************************************************
@@ -80,22 +74,15 @@ remduplicates = $(strip $(if $1,$(firstword $1) $(call remduplicates,$(filter-ou
 #*********************************
 # Select the board to build
 #*********************************
-BOARD_LIST = $(sort $(subst .h,,$(subst src/boards/,,$(wildcard src/boards/*.h))))
+BOARD_LIST = $(sort $(subst .h,,$(subst src/boards/,,$(wildcard src/boards/*))))
 
 NRF52832_BOARDLIST = feather_nrf52832
 IS_52832 = $(filter $(BOARD),$(NRF52832_BOARDLIST))
 
-ifeq ($(filter $(MAKECMDGOALS),all-board help),)
-  ifeq ($(BOARD),)
-    $(info You must provide a BOARD parameter with 'BOARD=')
-    $(info Supported boards are: $(BOARD_LIST))
-    $(info Run 'make help' for usage)
-    $(error BOARD not defined)
-  else
-    ifeq ($(filter $(BOARD),$(BOARD_LIST)),)
-      $(error Invalid BOARD specified)
-    endif
-  endif
+ifeq ($(filter $(BOARD),$(BOARD_LIST)),)
+  $(info You must provide a BOARD parameter with 'BOARD='. Supported boards are:)
+  $(info $(BOARD_LIST))
+  $(error Invalid BOARD specified)
 endif
 
 BUILD = _build-$(BOARD)
@@ -108,8 +95,6 @@ SD_NAME = s140
 DFU_DEV_REV = 52840
 endif
 
-
-
 #******************************************************************************
 # SOURCE FILES
 #******************************************************************************
@@ -201,6 +186,8 @@ endif
 
 # src
 IPATH += $(SRC_PATH)
+IPATH += $(SRC_PATH)/boards/$(BOARD)
+
 IPATH += $(SRC_PATH)/cmsis/include
 IPATH += $(SRC_PATH)/usb
 IPATH += $(SRC_PATH)/boards
@@ -232,7 +219,6 @@ IPATH += $(SDK_PATH)/drivers_nrf/delay
 IPATH += $(SD_API_PATH)/include
 IPATH += $(SD_API_PATH)/include/nrf52
 
-
 INC_PATHS = $(addprefix -I,$(IPATH))
 
 #******************************************************************************
@@ -251,23 +237,20 @@ CFLAGS += -ffunction-sections -fdata-sections -fno-strict-aliasing
 CFLAGS += -fno-builtin --short-enums -fstack-usage
 
 # Defined Symbol (MACROS)
-
-# TODO use GIT_VERSION (numberic format)
-CFLAGS += -DMK_BOOTLOADER_VERSION=0x0$(SD_VER1)0$(SD_VER2)0$(SD_VER3)UL
-
 CFLAGS += -D__HEAP_SIZE=0
 CFLAGS += -DCONFIG_GPIO_AS_PINRESET
+CFLAGS += -DCONFIG_NFCT_PINS_AS_GPIOS
 CFLAGS += -DBLE_STACK_SUPPORT_REQD
-CFLAGS += -DBSP_DEFINES_ONLY
 CFLAGS += -DSWI_DISABLE0
 CFLAGS += -DSOFTDEVICE_PRESENT
 CFLAGS += -DFLOAT_ABI_HARD
-CFLAGS += -DMK_DIS_FIRMWARE='$(MK_DIS_FIRMWARE)'
 CFLAGS += -DDFU_APP_DATA_RESERVED=7*4096
 
 CFLAGS += -DUF2_VERSION='"$(GIT_VERSION) $(GIT_SUBMODULE_VERSIONS) $(SD_NAME) $(SD_VERSION)"'
-CFLAGS += -DBOARD_$(shell echo $(BOARD) | tr '[:lower:]' '[:upper:]')
-CFLAGS += -DBOARD_HEADER_FILE='"$(BOARD).h"'
+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))'
 
 ifneq ($(IS_52832),)
 CFLAGS += -DNRF52
@@ -302,9 +285,7 @@ LDFLAGS += --specs=nano.specs -lc -lnosys
 #******************************************************************************
 ASMFLAGS += -x assembler-with-cpp
 ASMFLAGS += -D__HEAP_SIZE=0
-ASMFLAGS += -DCONFIG_GPIO_AS_PINRESET
 ASMFLAGS += -DBLE_STACK_SUPPORT_REQD
-ASMFLAGS += -DBSP_DEFINES_ONLY
 ASMFLAGS += -DSWI_DISABLE0
 ASMFLAGS += -DSOFTDEVICE_PRESENT
 ASMFLAGS += -DFLOAT_ABI_HARD
@@ -348,29 +329,6 @@ endif
 # default target to build
 all: $(BUILD)/$(OUTPUT_FILENAME)-nosd.out size
 
-# Rule using BOARD_LIST, nl is newline
-define nl
-
-
-endef
-
-_make_board = $(MAKE) -s -f $(MAKEFILE_LIST) -e BOARD=$1 $2 $(nl)
-_make_all_board = $(foreach b,$(BOARD_LIST), $(call _make_board,$b,$1))
-
-# build all the boards
-all-board:
-	$(call _make_all_board,clean all)
-
-help:
-	@echo To compile and build the current code for a board
-	@echo $$ make BOARD=feather_nrf52840_express all
-	@echo
-	@echo To flash current code using Jlink
-	@echo $$ make BOARD=feather_nrf52840_express flash
-	@echo
-	@echo To flash current code using existing bootloader dfu
-	@echo $$ make BOARD=feather_nrf52840_express SERIAL=/dev/ttyACM0 dfu-flash
-
 #******************* Flash target *******************
 
 check_defined = \

README.md

@@ -4,13 +4,14 @@ This is a CDC/DFU/UF2 bootloader for nRF52 boards.
 
 - [Adafruit Feather nRF52832](https://www.adafruit.com/product/3406)
 - [Adafruit Feather nRF52840 Express](https://www.adafruit.com/product/4062)
-- Nordic nRF52840DK PCA10056
-- Nordic nRF52840DK PCA10059 ("Dongle")
+- Adafruit Metro nRF52840 Express
+- [Electronut Labs Papyr](https://docs.electronut.in/papyr/)
+- MakerDiary MDK nRF52840 USB Dongle
+- [Nordic nRF52840DK PCA10056](https://www.nordicsemi.com/Software-and-Tools/Development-Kits/nRF52840-DK)
+- [Nordic nRF52840DK PCA10059 ("Dongle")](https://www.nordicsemi.com/Software-and-Tools/Development-Kits/nRF52840-Dongle)
 - Particle Argon
 - 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.

lib/sdk11/components/libraries/bootloader_dfu/dfu_transport_ble.c

@@ -994,20 +994,9 @@ static void services_init(void)
     ble_dis_init_t dis_init;
     memset(&dis_init, 0, sizeof(dis_init));
 
-    ascii_to_utf8(&dis_init.manufact_name_str, DIS_MANUFACTURER);
-    ascii_to_utf8(&dis_init.model_num_str, DIS_MODEL);
-
-    uint32_t const sd_id      = SD_ID_GET(MBR_SIZE);
-    uint32_t const sd_version = SD_VERSION_GET(MBR_SIZE);
-
-    uint32_t const ver1 = sd_version / 1000000;
-    uint32_t const ver2 = (sd_version % 1000000)/1000;
-    uint32_t const ver3 = sd_version % 1000;
-
-    char fw_str[30+1];
-    sprintf(fw_str, "s%ld %ld.%ld.%ld r%ld", sd_id, ver1, ver2, ver3, MK_BOOTLOADER_VERSION & 0xFFUL);
-
-    ascii_to_utf8(&dis_init.fw_rev_str, fw_str);
+    ascii_to_utf8(&dis_init.manufact_name_str, BLEDIS_MANUFACTURER);
+    ascii_to_utf8(&dis_init.model_num_str, BLEDIS_MODEL);
+    ascii_to_utf8(&dis_init.fw_rev_str, BLEDIS_FW_VERSION);
 
     BLE_GAP_CONN_SEC_MODE_SET_OPEN(&dis_init.dis_attr_md.read_perm);
     BLE_GAP_CONN_SEC_MODE_SET_NO_ACCESS(&dis_init.dis_attr_md.write_perm);

src/boards.c

@@ -1,38 +1,26 @@
-/**************************************************************************/
-/*!
-    @file     boards.c
-    @author   hathach (tinyusb.org)
-
-    @section LICENSE
-
-    Software License Agreement (BSD License)
-
-    Copyright (c) 2018, 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.
-*/
-/**************************************************************************/
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2018 Ha Thach 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.
+ */
 
 #include "boards.h"
 #include "nrf_pwm.h"
@@ -50,6 +38,16 @@
 #endif
 
 //------------- IMPLEMENTATION -------------//
+void button_init(uint32_t pin)
+{
+  nrf_gpio_cfg_sense_input(pin, BUTTON_PULL, NRF_GPIO_PIN_SENSE_LOW);
+}
+
+bool button_pressed(uint32_t pin)
+{
+  return (nrf_gpio_pin_read(pin) == 0) ? true : false;
+}
+
 void board_init(void)
 {
   // stop LF clock just in case we jump from application without reset

src/boards.h

@@ -1,14 +1,27 @@
-/* Copyright (c) 2014 Nordic Semiconductor. All Rights Reserved.
+/*
+ * The MIT License (MIT)
  *
- * The information contained herein is property of Nordic Semiconductor ASA.
- * Terms and conditions of usage are described in detail in NORDIC
- * SEMICONDUCTOR STANDARD SOFTWARE LICENSE AGREEMENT.
+ * Copyright (c) 2018 Ha Thach for Adafruit Industries
  *
- * Licensees are granted free, non-transferable use of the information. NO
- * WARRANTY of ANY KIND is provided. This heading must NOT be removed from
- * the file.
+ * 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 BOARDS_H
 #define BOARDS_H
 
@@ -17,7 +30,7 @@
 #include <string.h>
 #include "nrf_gpio.h"
 
-#include BOARD_HEADER_FILE
+#include "board.h"
 
 #ifndef BUTTON_DFU
 #define BUTTON_DFU      BUTTON_1
@@ -55,8 +68,6 @@ void board_teardown(void);
 // LED
 //--------------------------------------------------------------------+
 
-#define bit(b) (1UL << (b))
-
 enum {
   STATE_BOOTLOADER_STARTED = 0,
   STATE_USB_MOUNTED,
@@ -84,15 +95,8 @@ void led_tick(void);
 #error "At least two buttons required in the BSP (see 'BUTTONS_NUMBER')"
 #endif
 
-static inline void button_init(uint32_t pin)
-{
-  nrf_gpio_cfg_sense_input(pin, BUTTON_PULL, NRF_GPIO_PIN_SENSE_LOW);
-}
-
-static inline bool button_pressed(uint32_t pin)
-{
-  return (nrf_gpio_pin_read(pin) == 0) ? true : false;
-}
+void button_init(uint32_t pin);
+bool button_pressed(uint32_t pin);
 
 bool is_ota(void);