Skip to content

Commit 7822d01

Browse files
tannewttannewt
authored
Merge pull request adafruit#1798 from ntavish/papyr
Add support for Electronut Labs Papyr.
2 parents 4826994 + 32a0855 commit 7822d01

File tree

6 files changed

+215
-0
lines changed

6 files changed

+215
-0
lines changed

‎ports/nrf/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,7 @@ pca10056 | s140 | Peripheral and Scanner | [S
7878
feather_nrf52840_express | s140 | Peripheral and Scanner | UF2 bootloader
7979
makerdiary_nrf52840_mdk | s140 | Peripheral and Scanner | pyocd or ARM mbed DAPLink
8080
makerdiary_nrf52840_mdk_usb_dongle | s140 | Peripheral and Scanner | DFU bootloader & nrfutil
81+
electronut_labs_papyr | s140 | Peripheral and Scanner | UF2 bootloader
8182

8283
## Segger Targets
8384

‎ports/nrf/boards/electronut_labs_papyr/README.md

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
# Setup
2+
3+
The `Electronut Labs Papyr` board is based on the `nRF52840` SoC from
4+
Nordic Semiconductors. It has an e-ink display on it, along with a CR2477
5+
battery holder.
6+
7+
Papyr can be programmed with the [`Adafruit nRF52 bootloader`](https://github.com/adafruit/Adafruit_nRF52_Bootloader) to
8+
9+
Schematic, datasheet default pin mapping etc. can be found over [here](https://docs.electronut.in/papyr/). The default pin mapping can be found in the board directory.
10+
11+
## Installing CircuitPython submodules
12+
13+
Before you can build, you will need to run the following commands once, which
14+
will install the submodules that are part of the CircuitPython ecosystem, and
15+
build the `mpy-cross` tool:
16+
17+
```
18+
$ cd circuitpython
19+
$ git submodule update --init
20+
$ make -C mpy-cross
21+
```
22+
23+
## Installing the Bootloader
24+
25+
If the `Adafruit nRF52 bootloader` is installed on the board, then the
26+
bootloader allows you to update the core CircuitPython firmware and internal
27+
file system contents using serial, or USB CDC, or USB mass storage.
28+
29+
On empty devices, the bootloader will need to be flashed once using a
30+
HW debugger such as a Segger J-Link, or Blackmagicprobe
31+
(or [Electronut labs Bumpy](https://docs.electronut.in/bumpy/)).
32+
33+
34+
## Building and Flashing CircuitPython
35+
36+
No special notes for this, follow `ports/nrf` generic `README.md`.
37+
38+
### Flashing CircuitPython with MSC UF2
39+
40+
`uf2` file is generated last by `all` target.
41+
42+
```
43+
$ cd ports/nrf
44+
$ make V=1 SD=s140 SERIAL=/dev/ttyACM0 BOARD=electronut_labs_papyr all
45+
...
46+
...
47+
python3 ../../tools/uf2/utils/uf2conv.py -f 0xADA52840 -c -o "build-electronut_labs_papyr-s140/firmware.uf2" build-electronut_labs_papyr-s140/firmware.hex
48+
Converting to uf2, output size: 536576, start address: 0x26000
49+
Wrote 536576 bytes to build-electronut_labs_papyr-s140/firmware.uf2
50+
```
51+
52+
Simply drag and drop firmware.uf2 to the MSC, the nrf52840 will blink fast and reset after done.
53+
54+
### Other tips
55+
56+
Once circuitpython is running on your board, it will come up as a mass storage
57+
device named `CIRCUITPY`, where you can drop in your python code. The file names
58+
it looks for are `main.py`, `main.txt`, `code.py` or `code.txt`.

‎ports/nrf/boards/electronut_labs_papyr/board.c

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
/*
2+
* This file is part of the MicroPython project, http://micropython.org/
3+
*
4+
* The MIT License (MIT)
5+
*
6+
* Copyright (c) 2017 Scott Shawcroft for Adafruit Industries
7+
*
8+
* Permission is hereby granted, free of charge, to any person obtaining a copy
9+
* of this software and associated documentation files (the "Software"), to deal
10+
* in the Software without restriction, including without limitation the rights
11+
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
12+
* copies of the Software, and to permit persons to whom the Software is
13+
* furnished to do so, subject to the following conditions:
14+
*
15+
* The above copyright notice and this permission notice shall be included in
16+
* all copies or substantial portions of the Software.
17+
*
18+
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19+
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20+
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21+
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22+
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23+
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
24+
* THE SOFTWARE.
25+
*/
26+
27+
#include "boards/board.h"
28+
29+
void board_init(void) {
30+
}
31+
32+
bool board_requests_safe_mode(void) {
33+
return false;
34+
}
35+
36+
void reset_board(void) {
37+
38+
}

‎ports/nrf/boards/electronut_labs_papyr/mpconfigboard.h

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
/*
2+
* This file is part of the MicroPython project, http://micropython.org/
3+
*
4+
* The MIT License (MIT)
5+
*
6+
* Copyright (c) 2016 Glenn Ruben Bakke
7+
* Copyright (c) 2018 Dan Halbert for Adafruit Industries
8+
*
9+
* Permission is hereby granted, free of charge, to any person obtaining a copy
10+
* of this software and associated documentation files (the "Software"), to deal
11+
* in the Software without restriction, including without limitation the rights
12+
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13+
* copies of the Software, and to permit persons to whom the Software is
14+
* furnished to do so, subject to the following conditions:
15+
*
16+
* The above copyright notice and this permission notice shall be included in
17+
* all copies or substantial portions of the Software.
18+
*
19+
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20+
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21+
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22+
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23+
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24+
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
25+
* THE SOFTWARE.
26+
*/
27+
28+
#include "nrfx/hal/nrf_gpio.h"
29+
30+
#define ELECTRONUT_LABS_PAPYR
31+
32+
#define MICROPY_HW_BOARD_NAME "Electronut Labs Papyr"
33+
#define MICROPY_HW_MCU_NAME "nRF52840"
34+
#define MICROPY_PY_SYS_PLATFORM "ElectronutLabsPapyr"
35+
36+
#define CIRCUITPY_AUTORELOAD_DELAY_MS 500
37+
38+
// TODO #define CIRCUITPY_INTERNAL_NVM_SIZE 8192
39+
40+
#define BOARD_FLASH_SIZE (FLASH_SIZE - 0x4000 - CIRCUITPY_INTERNAL_NVM_SIZE)
41+
42+
#define BOARD_HAS_CRYSTAL 1
43+
44+
#define DEFAULT_I2C_BUS_SCL (&pin_P0_06)
45+
#define DEFAULT_I2C_BUS_SDA (&pin_P0_05)
46+
47+
#define DEFAULT_SPI_BUS_SCK (&pin_P0_31)
48+
#define DEFAULT_SPI_BUS_MOSI (&pin_P0_29)
49+
#define DEFAULT_SPI_BUS_MISO (&pin_P1_01)
50+
51+
#define DEFAULT_UART_BUS_RX (&pin_P0_07)
52+
#define DEFAULT_UART_BUS_TX (&pin_P0_08)

‎ports/nrf/boards/electronut_labs_papyr/mpconfigboard.mk

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
USB_VID = 0x239A
2+
USB_PID = 0x803C
3+
USB_PRODUCT = "Papyr"
4+
USB_MANUFACTURER = "Electronut Labs"
5+
6+
MCU_SERIES = m4
7+
MCU_VARIANT = nrf52
8+
MCU_SUB_VARIANT = nrf52840
9+
MCU_CHIP = nrf52840
10+
SD ?= s140
11+
SOFTDEV_VERSION ?= 6.1.0
12+
13+
BOOT_SETTING_ADDR = 0xFF000
14+
15+
ifeq ($(SD),)
16+
LD_FILE = boards/nrf52840_1M_256k.ld
17+
else
18+
LD_FILE = boards/adafruit_$(MCU_SUB_VARIANT)_$(SD_LOWER)_v$(firstword $(subst ., ,$(SOFTDEV_VERSION))).ld
19+
CIRCUITPY_BLEIO = 1
20+
endif
21+
22+
NRF_DEFINES += -DNRF52840_XXAA -DNRF52840

‎ports/nrf/boards/electronut_labs_papyr/pins.c

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
#include "shared-bindings/board/__init__.h"
2+
3+
STATIC const mp_rom_map_elem_t board_module_globals_table[] = {
4+
{ MP_ROM_QSTR(MP_QSTR_A5), MP_ROM_PTR(&pin_P0_05) },
5+
{ MP_ROM_QSTR(MP_QSTR_A6), MP_ROM_PTR(&pin_P0_06) },
6+
7+
{ MP_ROM_QSTR(MP_QSTR_NFC1), MP_ROM_PTR(&pin_P0_09) },
8+
{ MP_ROM_QSTR(MP_QSTR_NFC2), MP_ROM_PTR(&pin_P0_10) },
9+
10+
{ MP_ROM_QSTR(MP_QSTR_D5), MP_ROM_PTR(&pin_P0_05) },
11+
{ MP_ROM_QSTR(MP_QSTR_D6), MP_ROM_PTR(&pin_P0_06) },
12+
{ MP_ROM_QSTR(MP_QSTR_D7), MP_ROM_PTR(&pin_P0_07) },
13+
{ MP_ROM_QSTR(MP_QSTR_D8), MP_ROM_PTR(&pin_P0_08) },
14+
{ MP_ROM_QSTR(MP_QSTR_D13), MP_ROM_PTR(&pin_P0_13) },
15+
{ MP_ROM_QSTR(MP_QSTR_D14), MP_ROM_PTR(&pin_P0_14) },
16+
{ MP_ROM_QSTR(MP_QSTR_D15), MP_ROM_PTR(&pin_P0_15) },
17+
18+
{ MP_ROM_QSTR(MP_QSTR_SCK), MP_ROM_PTR(&pin_P0_31) },
19+
{ MP_ROM_QSTR(MP_QSTR_MOSI), MP_ROM_PTR(&pin_P0_29) },
20+
{ MP_ROM_QSTR(MP_QSTR_MISO), MP_ROM_PTR(&pin_P1_01) },
21+
{ MP_ROM_QSTR(MP_QSTR_CS), MP_ROM_PTR(&pin_P0_30) },
22+
{ MP_ROM_QSTR(MP_QSTR_BUSY), MP_ROM_PTR(&pin_P0_03) },
23+
{ MP_ROM_QSTR(MP_QSTR_DC), MP_ROM_PTR(&pin_P0_28) },
24+
{ MP_ROM_QSTR(MP_QSTR_RES), MP_ROM_PTR(&pin_P0_02) },
25+
{ MP_ROM_QSTR(MP_QSTR_EINK_EN), MP_ROM_PTR(&pin_P0_11) },
26+
27+
{ MP_ROM_QSTR(MP_QSTR_TX), MP_ROM_PTR(&pin_P0_08) },
28+
{ MP_ROM_QSTR(MP_QSTR_RX), MP_ROM_PTR(&pin_P0_07) },
29+
30+
{ MP_ROM_QSTR(MP_QSTR_SCL), MP_ROM_PTR(&pin_P0_06) },
31+
{ MP_ROM_QSTR(MP_QSTR_SDA), MP_ROM_PTR(&pin_P0_05) },
32+
33+
{ MP_ROM_QSTR(MP_QSTR_L), MP_ROM_PTR(&pin_P0_14) },
34+
{ MP_ROM_QSTR(MP_QSTR_RED_LED), MP_ROM_PTR(&pin_P0_14) },
35+
36+
{ MP_ROM_QSTR(MP_QSTR_BLUE_LED), MP_ROM_PTR(&pin_P0_15) },
37+
{ MP_ROM_QSTR(MP_QSTR_GREEN_LED), MP_ROM_PTR(&pin_P0_13) },
38+
39+
{ MP_ROM_QSTR(MP_QSTR_UART), MP_ROM_PTR(&board_uart_obj) },
40+
{ MP_ROM_QSTR(MP_QSTR_SPI), MP_ROM_PTR(&board_spi_obj) },
41+
{ MP_ROM_QSTR(MP_QSTR_I2C), MP_ROM_PTR(&board_i2c_obj) },
42+
};
43+
44+
MP_DEFINE_CONST_DICT(board_module_globals, board_module_globals_table);

0 commit comments

Comments
 (0)