Skip to content

ports/nrf: Add Particle Xenon board (NRF52840) #5041

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 3 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 38 additions & 5 deletions ports/nrf/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ LDFLAGS += -Wl,--gc-sections
endif


CFLAGS += $(CFLAGS_MCU_$(MCU_SERIES))
CFLAGS += $(CFLAGS_MCU_$(MCU_SERIES))
CFLAGS += $(INC) -Wall -Werror -g -ansi -std=c11 -nostdlib $(COPT) $(NRF_DEFINES) $(CFLAGS_MOD)
CFLAGS += -fno-strict-aliasing
CFLAGS += -Iboards/$(BOARD)
Expand Down Expand Up @@ -254,7 +254,7 @@ OBJ += $(BUILD)/pins_gen.o
$(BUILD)/$(FATFS_DIR)/ff.o: COPT += -Os
$(filter $(PY_BUILD)/../extmod/vfs_fat_%.o, $(PY_O)): COPT += -Os

.PHONY: all flash sd binary hex
.PHONY: all flash deploy sd binary hex

all: binary hex

Expand All @@ -276,7 +276,7 @@ FLASHER ?=

ifeq ($(FLASHER),)

flash: $(BUILD)/$(OUTPUT_FILENAME).hex
deploy: $(BUILD)/$(OUTPUT_FILENAME).hex
nrfjprog --program $< --sectorerase -f $(MCU_VARIANT)
nrfjprog --reset -f $(MCU_VARIANT)

Expand All @@ -288,7 +288,7 @@ sd: $(BUILD)/$(OUTPUT_FILENAME).hex

else ifeq ($(FLASHER), pyocd)

flash: $(BUILD)/$(OUTPUT_FILENAME).hex
deploy: $(BUILD)/$(OUTPUT_FILENAME).hex
pyocd-flashtool -t $(MCU_VARIANT) $<

sd: $(BUILD)/$(OUTPUT_FILENAME).hex
Expand All @@ -298,14 +298,47 @@ sd: $(BUILD)/$(OUTPUT_FILENAME).hex

else ifeq ($(FLASHER), idap)

flash: $(BUILD)/$(OUTPUT_FILENAME).hex
deploy: $(BUILD)/$(OUTPUT_FILENAME).hex
IDAPnRFPRog $<

sd: $(BUILD)/$(OUTPUT_FILENAME).hex
IDAPnRFPRog $(SOFTDEV_HEX) $<

else ifeq ($(FLASHER), bmp)

BMP_PORT ?= /dev/ttyACM0

deploy: $(BUILD)/$(OUTPUT_FILENAME).elf
$(Q)$(GDB) \
-ex 'target extended-remote $(BMP_PORT)' \
-ex 'monitor tpwr enable' \
-ex 'monitor swdp_scan' \
-ex 'attach 1' \
-ex 'set mem inaccessible-by-default off' \
-ex 'load' \
-ex 'kill' \
-ex 'quit' \
$<

sd: $(BUILD)/$(OUTPUT_FILENAME).elf
$(Q)$(GDB) \
-ex 'target extended-remote $(BMP_PORT)' \
-ex 'monitor tpwr enable' \
-ex 'monitor swdp_scan' \
-ex 'attach 1' \
-ex 'set mem inaccessible-by-default off' \
-ex 'monitor erase_mass' \
-ex 'load' \
-ex 'file $(SOFTDEV_HEX)' \
-ex 'load' \
-ex 'kill' \
-ex 'quit' \
$<

endif

flash: deploy

$(BUILD)/$(OUTPUT_FILENAME).elf: $(OBJ)
$(ECHO) "LINK $@"
$(Q)$(CC) $(LDFLAGS) -o $@ $(OBJ) $(LIBS)
Expand Down
12 changes: 10 additions & 2 deletions ports/nrf/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,14 +30,15 @@ This is a port of MicroPython to the Nordic Semiconductor nRF series of chips.
* PCA10031 (dongle)
* [WT51822-S4AT](http://www.wireless-tag.com/wireless_module/BLE/WT51822-S4AT.html)
* nRF52832
* [PCA10040](http://infocenter.nordicsemi.com/index.jsp?topic=%2Fcom.nordic.infocenter.nrf52%2Fdita%2Fnrf52%2Fdevelopment%2Fnrf52_dev_kit.html)
* [PCA10040](http://infocenter.nordicsemi.com/index.jsp?topic=%2Fcom.nordic.infocenter.nrf52%2Fdita%2Fnrf52%2Fdevelopment%2Fnrf52_dev_kit.html)
* [Adafruit Feather nRF52](https://www.adafruit.com/product/3406)
* [Thingy:52](http://www.nordicsemi.com/eng/Products/Nordic-Thingy-52)
* [Arduino Primo](http://www.arduino.org/products/boards/arduino-primo)
* [IBK-BLYST-NANO breakout board](https://www.crowdsupply.com/i-syst/blyst-nano)
* [BLUEIO-TAG-EVIM BLYST Nano Sensor board](https://www.crowdsupply.com/i-syst/blyst-nano)
* nRF52840
* [PCA10056](http://www.nordicsemi.com/eng/Products/nRF52840-Preview-DK)
* [Particle Xenon](https://docs.particle.io/xenon/)

## Compile and Flash

Expand Down Expand Up @@ -71,7 +72,7 @@ the compilation:
GNU ARM Embedded Toolchain 7.2.1/4Q17. It's recommended to use a toolchain after
this release, for example 7.3.1/2Q18 or 8.2.1/4Q18. The alternative would be to
build the target using the LTO=0 as described above.

## Compile and Flash with Bluetooth Stack

First prepare the bluetooth folder by downloading Bluetooth LE stacks and headers:
Expand Down Expand Up @@ -126,6 +127,7 @@ ibk_blyst_nano | s132 | Peripheral and Central | [IDAP]
idk_blyst_nano | s132 | Peripheral and Central | [IDAP](#idap-midap-link-targets)
blueio_tag_evim | s132 | Peripheral and Central | [IDAP](#idap-midap-link-targets)
pca10056 | s140 | Peripheral and Central | [Segger](#segger-targets)
particle_xenon | s140 | Peripheral and Central | [Black Magic Probe](#black-magic-probe-targets)

## IDAP-M/IDAP-Link Targets

Expand Down Expand Up @@ -153,6 +155,12 @@ Install the necessary tools to flash and debug using OpenOCD:
sudo apt-get install openocd
sudo pip install pyOCD

## Black Magic Probe Targets

This requires no further dependencies other than `arm-none-eabi-gdb`.

`make deploy` will use gdb to load and run new firmware. See [this guide](https://github.com/blacksphere/blackmagic/wiki/Useful-GDB-commands) for more tips about using the BMP with GDB.

## Bluetooth LE REPL

The port also implements a BLE REPL driver. This feature is disabled by default, as it will deactivate the UART REPL when activated. As some of the nRF devices only have one UART, using the BLE REPL free's the UART instance such that it can be used as a general UART peripheral not bound to REPL.
Expand Down
18 changes: 13 additions & 5 deletions ports/nrf/boards/make-pins.py
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,7 @@ def __init__(self, pin):
self.adc_num = 0
self.adc_channel = 0
self.board_pin = False
self.board_index = None

def cpu_pin_name(self):
return '{:s}{:d}'.format("P", self.pin)
Expand All @@ -103,6 +104,9 @@ def is_board_pin(self):
def set_is_board_pin(self):
self.board_pin = True

def set_board_index(self, index):
self.board_index = index

def parse_adc(self, adc_str):
if (adc_str[:3] != 'ADC'):
return
Expand Down Expand Up @@ -233,20 +237,24 @@ def parse_board_file(self, filename):

def print_named(self, label, named_pins):
print('STATIC const mp_rom_map_elem_t pin_{:s}_pins_locals_dict_table[] = {{'.format(label))
index = 0
for named_pin in named_pins:
pin = named_pin.pin()
if pin.is_board_pin():
print(' {{ MP_ROM_QSTR(MP_QSTR_{:s}), MP_ROM_PTR(&machine_pin_obj[{:d}]) }},'.format(named_pin.name(), index))
index += 1
print(' {{ MP_ROM_QSTR(MP_QSTR_{:s}), MP_ROM_PTR(&machine_board_pin_obj[{:d}]) }},'.format(named_pin.name(), pin.board_index))
print('};')
print('MP_DEFINE_CONST_DICT(pin_{:s}_pins_locals_dict, pin_{:s}_pins_locals_dict_table);'.format(label, label));

def print_const_table(self):
num_board_pins = 0
for named_pin in self.cpu_pins:
pin = named_pin.pin()
if pin.is_board_pin():
pin.set_board_index(num_board_pins)
num_board_pins += 1
print('')
print('const uint8_t machine_pin_num_of_pins = {:d};'.format(len(self.board_pins)))
print('const uint8_t machine_pin_num_of_board_pins = {:d};'.format(num_board_pins))
print('')
print('const pin_obj_t machine_pin_obj[{:d}] = {{'.format(len(self.board_pins)))
print('const pin_obj_t machine_board_pin_obj[{:d}] = {{'.format(num_board_pins))
for named_pin in self.cpu_pins:
pin = named_pin.pin()
if pin.is_board_pin():
Expand Down
70 changes: 70 additions & 0 deletions ports/nrf/boards/particle_xenon/mpconfigboard.h
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
/*
* This file is part of the MicroPython project, http://micropython.org/
*
* The MIT License (MIT)
*
* Copyright (c) 2019 Jim Mussared
*
* 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.
*/

#define MICROPY_HW_BOARD_NAME "XENON"
#define MICROPY_HW_MCU_NAME "NRF52840"
#define MICROPY_PY_SYS_PLATFORM "PARTICLE-XENON"

#define MICROPY_PY_MACHINE_UART (1)
#define MICROPY_PY_MACHINE_HW_PWM (1)
#define MICROPY_PY_MACHINE_HW_SPI (1)
#define MICROPY_PY_MACHINE_TIMER (1)
#define MICROPY_PY_MACHINE_RTCOUNTER (1)
#define MICROPY_PY_MACHINE_I2C (1)
#define MICROPY_PY_MACHINE_ADC (1)
#define MICROPY_PY_MACHINE_TEMP (1)
#define MICROPY_PY_RANDOM_HW_RNG (1)

#define MICROPY_HW_HAS_LED (1)
#define MICROPY_HW_LED_TRICOLOR (1)
#define MICROPY_HW_LED_PULLUP (1)

#define MICROPY_HW_LED_RED (13) // LED1
#define MICROPY_HW_LED_GREEN (14) // LED2
#define MICROPY_HW_LED_BLUE (15) // LED3

// UART config
#define MICROPY_HW_UART1_RX (8)
#define MICROPY_HW_UART1_TX (6)
#define MICROPY_HW_UART1_CTS (32+2)
#define MICROPY_HW_UART1_RTS (32+1)
#define MICROPY_HW_UART1_HWFC (0)

// SPI0 config
#define MICROPY_HW_SPI0_NAME "SPI0"

#define MICROPY_HW_SPI0_SCK (32+15)
#define MICROPY_HW_SPI0_MOSI (32+13)
#define MICROPY_HW_SPI0_MISO (32+14)

#define MICROPY_HW_PWM0_NAME "PWM0"
#define MICROPY_HW_PWM1_NAME "PWM1"
#define MICROPY_HW_PWM2_NAME "PWM2"
#if 0
#define MICROPY_HW_PWM3_NAME "PWM3"
#endif

#define HELP_TEXT_BOARD_LED "1,2,3"
7 changes: 7 additions & 0 deletions ports/nrf/boards/particle_xenon/mpconfigboard.mk
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
MCU_SERIES = m4
MCU_VARIANT = nrf52
MCU_SUB_VARIANT = nrf52840
SOFTDEV_VERSION = 6.1.1
LD_FILES += boards/nrf52840_1M_256k.ld

NRF_DEFINES += -DNRF52840_XXAA
38 changes: 38 additions & 0 deletions ports/nrf/boards/particle_xenon/pins.csv
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
LED1,P13
LED2,P14
LED3,P15
A0,P3,ADC0_IN1
A1,P4,ADC0_IN2
A2,P28,ADC0_IN4
A3,P29,ADC0_IN5
A4,P30,ADC0_IN6
A5,P31,ADC0_IN7
SPI_SS,P31
SPI_SCK,P47
SPI_MOSI,P45
SPI_MISO,P46
SPI1_SCK,P33
SPI1_MOSI,P34
SPI1_MISO,P40
UART1_RX,P8
UART1_TX,P6
UART2_RX,P42
UART2_TX,P40
SDA,P26
SCL,P27
SDA1,P33
SCL1,P34
D0,P26
D1,P27
D2,P33
D3,P34
D4,P40
D5,P42
D6,P43
D7,P44
D8,P35
D9,P6
D10,P8
D11,P46
D12,P45
D13,P47
10 changes: 5 additions & 5 deletions ports/nrf/modules/machine/pin.c
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,8 @@
#include "nrf_gpio.h"
#include "nrfx_gpiote.h"

extern const pin_obj_t machine_pin_obj[];
extern const uint8_t machine_pin_num_of_pins;
extern const pin_obj_t machine_board_pin_obj[];
extern const uint8_t machine_pin_num_of_board_pins;

/// \moduleref machine
/// \class Pin - control I/O pins
Expand Down Expand Up @@ -128,9 +128,9 @@ const pin_obj_t *pin_find(mp_obj_t user_obj) {
// If pin is SMALL_INT
if (mp_obj_is_small_int(user_obj)) {
uint8_t value = MP_OBJ_SMALL_INT_VALUE(user_obj);
for (uint8_t i = 0; i < machine_pin_num_of_pins; i++) {
if (machine_pin_obj[i].pin == value) {
return &machine_pin_obj[i];
for (uint8_t i = 0; i < machine_pin_num_of_board_pins; i++) {
if (machine_board_pin_obj[i].pin == value) {
return &machine_board_pin_obj[i];
}
}
}
Expand Down
1 change: 1 addition & 0 deletions py/mkenv.mk
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,7 @@ OBJCOPY = $(CROSS_COMPILE)objcopy
SIZE = $(CROSS_COMPILE)size
STRIP = $(CROSS_COMPILE)strip
AR = $(CROSS_COMPILE)ar
GDB = $(CROSS_COMPILE)gdb
ifeq ($(MICROPY_FORCE_32BIT),1)
CC += -m32
CXX += -m32
Expand Down