Skip to content

Commit f7303e6

Browse files
tannewttannewt
authored
Merge pull request #2754 from maholli/non-standard-nvm
Add non-standard nvm to QSPI for external flash support
2 parents a1091bb + e6df8e0 commit f7303e6

File tree

11 files changed

+288
-32
lines changed

11 files changed

+288
-32
lines changed

‎.github/workflows/build.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -222,6 +222,7 @@ jobs:
222222
- "pybadge_airlift"
223223
- "pyboard_v11"
224224
- "pycubed"
225+
- "pycubed_mram"
225226
- "pygamer"
226227
- "pygamer_advance"
227228
- "pyportal"

‎ports/atmel-samd/boards/pycubed/mpconfigboard.h

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
#define MICROPY_HW_MCU_NAME "samd51j19"
44
#define CIRCUITPY_MCU_FAMILY samd51
55

6+
#define MICROPY_HW_LED_STATUS (&pin_PA16)
67
#define MICROPY_HW_NEOPIXEL (&pin_PA21)
78

89
#define MICROPY_PORT_A (PORT_PA08 | PORT_PA09 | PORT_PA10 | PORT_PA11)
@@ -16,6 +17,7 @@
1617

1718
#define BOARD_FLASH_SIZE (FLASH_SIZE - 0x4000 - CIRCUITPY_INTERNAL_NVM_SIZE)
1819

20+
// External flash W25Q80DV
1921
#define EXTERNAL_FLASH_QSPI_DUAL
2022

2123
#define BOARD_HAS_CRYSTAL 1

‎ports/atmel-samd/boards/pycubed/mpconfigboard.mk

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
LD_FILE = boards/samd51x19-bootloader-external-flash.ld
21
USB_VID = 0x04D8
32
USB_PID = 0xEC44
43
USB_PRODUCT = "PyCubed"
@@ -12,6 +11,8 @@ EXTERNAL_FLASH_DEVICE_COUNT = 1
1211
EXTERNAL_FLASH_DEVICES = W25Q80DV
1312
LONGINT_IMPL = MPZ
1413

14+
CIRCUITPY_DRIVE_LABEL = "PYCUBED"
15+
1516
# Not needed.
1617
CIRCUITPY_AUDIOBUSIO = 0
1718
CIRCUITPY_DISPLAYIO = 0

‎ports/atmel-samd/boards/pycubed_mram/board.c

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
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+
28+
#include <string.h>
29+
30+
#include "boards/board.h"
31+
#include "py/mpconfig.h"
32+
#include "shared-bindings/nvm/ByteArray.h"
33+
#include "common-hal/microcontroller/Pin.h"
34+
#include "hal/include/hal_gpio.h"
35+
#include "shared-bindings/pulseio/PWMOut.h"
36+
37+
nvm_bytearray_obj_t bootcnt = {
38+
.base = {
39+
.type = &nvm_bytearray_type
40+
},
41+
.len = ( uint32_t) 8192,
42+
.start_address = (uint8_t*) (0x00080000 - 8192)
43+
};
44+
45+
46+
void board_init(void) {
47+
pulseio_pwmout_obj_t pwm;
48+
common_hal_pulseio_pwmout_construct(&pwm, &pin_PA23, 4096, 2, false);
49+
common_hal_pulseio_pwmout_never_reset(&pwm);
50+
}
51+
52+
bool board_requests_safe_mode(void) {
53+
return false;
54+
}
55+
56+
void reset_board(void) {
57+
uint8_t value_out = 0;
58+
common_hal_nvm_bytearray_get_bytes(&bootcnt,0,1,&value_out);
59+
++value_out;
60+
common_hal_nvm_bytearray_set_bytes(&bootcnt,0,&value_out,1);
61+
}

‎ports/atmel-samd/boards/pycubed_mram/mpconfigboard.h

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
#define MICROPY_HW_BOARD_NAME "PyCubedv04-MRAM"
2+
#define MICROPY_HW_MCU_NAME "samd51j19"
3+
#define CIRCUITPY_MCU_FAMILY samd51
4+
5+
#define MICROPY_HW_LED_STATUS (&pin_PA16)
6+
#define MICROPY_HW_NEOPIXEL (&pin_PA21)
7+
8+
#define MICROPY_PORT_A (PORT_PA08 | PORT_PA09 | PORT_PA10 | PORT_PA11)
9+
#define MICROPY_PORT_B (PORT_PA21 | PORT_PB10 | PORT_PB11)
10+
#define MICROPY_PORT_C (0)
11+
#define MICROPY_PORT_D (0)
12+
13+
#define SPI_FLASH_WP_PIN &pin_PA10
14+
#define SPI_FLASH_HOLD_PIN &pin_PA11
15+
16+
// External flash MR2xH40 MRAM
17+
#define EXTERNAL_FLASH_QSPI_SINGLE
18+
#define EXTERNAL_FLASH_NO_JEDEC
19+
20+
#define AUTORESET_DELAY_MS 500
21+
22+
#define CIRCUITPY_INTERNAL_NVM_SIZE 8192
23+
24+
#define BOARD_FLASH_SIZE (FLASH_SIZE - 0x4000 - CIRCUITPY_INTERNAL_NVM_SIZE)
25+
26+
#define BOARD_HAS_CRYSTAL 1
27+
28+
#define DEFAULT_I2C_BUS_SCL (&pin_PB13)
29+
#define DEFAULT_I2C_BUS_SDA (&pin_PB12)
30+
31+
#define DEFAULT_SPI_BUS_SCK (&pin_PA13)
32+
#define DEFAULT_SPI_BUS_MOSI (&pin_PA12)
33+
#define DEFAULT_SPI_BUS_MISO (&pin_PA14)
34+
35+
#define DEFAULT_UART_BUS_TX (&pin_PB02)
36+
#define DEFAULT_UART_BUS_RX (&pin_PB03)
37+
38+
#define IGNORE_PIN_PA24 1
39+
#define IGNORE_PIN_PA25 1

‎ports/atmel-samd/boards/pycubed_mram/mpconfigboard.mk

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
USB_VID = 0x04D8
2+
USB_PID = 0xEC44
3+
USB_PRODUCT = "PyCubed"
4+
USB_MANUFACTURER = "maholli"
5+
6+
CHIP_VARIANT = SAMD51J19A
7+
CHIP_FAMILY = samd51
8+
9+
QSPI_FLASH_FILESYSTEM = 1
10+
EXTERNAL_FLASH_DEVICE_COUNT = 1
11+
EXTERNAL_FLASH_DEVICES = MR2xH40
12+
LONGINT_IMPL = MPZ
13+
14+
CIRCUITPY_DRIVE_LABEL = "PYCUBED"
15+
16+
# Not needed.
17+
CIRCUITPY_AUDIOBUSIO = 0
18+
CIRCUITPY_DISPLAYIO = 0
19+
CIRCUITPY_FRAMEBUFFERIO = 0
20+
CIRCUITPY_GAMEPAD = 0
21+
CIRCUITPY_RGBMATRIX = 0
22+
CIRCUITPY_PS2IO = 0
23+
24+
FROZEN_MPY_DIRS += $(TOP)/frozen/Adafruit_CircuitPython_BusDevice
25+
FROZEN_MPY_DIRS += $(TOP)/frozen/Adafruit_CircuitPython_NeoPixel
26+
FROZEN_MPY_DIRS += $(TOP)/frozen/Adafruit_CircuitPython_Register
27+
FROZEN_MPY_DIRS += $(TOP)/frozen/Adafruit_CircuitPython_SD

‎ports/atmel-samd/boards/pycubed_mram/pins.c

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
#include "shared-bindings/board/__init__.h"
2+
#include "boards/board.h"
3+
4+
STATIC const mp_rom_map_elem_t board_global_dict_table[] = {
5+
{ MP_ROM_QSTR(MP_QSTR_SCK), MP_ROM_PTR(&pin_PA13) },
6+
{ MP_ROM_QSTR(MP_QSTR_MOSI), MP_ROM_PTR(&pin_PA12) },
7+
{ MP_ROM_QSTR(MP_QSTR_MISO), MP_ROM_PTR(&pin_PA14) },
8+
{ MP_ROM_QSTR(MP_QSTR_xSDCS), MP_ROM_PTR(&pin_PA27) },
9+
10+
{ MP_ROM_QSTR(MP_QSTR_RELAY_A), MP_ROM_PTR(&pin_PB15) },
11+
{ MP_ROM_QSTR(MP_QSTR_BURN1), MP_ROM_PTR(&pin_PB31) },
12+
{ MP_ROM_QSTR(MP_QSTR_BURN2), MP_ROM_PTR(&pin_PA15) },
13+
14+
{ MP_ROM_QSTR(MP_QSTR_BATTERY), MP_ROM_PTR(&pin_PA06) },
15+
{ MP_ROM_QSTR(MP_QSTR_L1PROG), MP_ROM_PTR(&pin_PA07) },
16+
{ MP_ROM_QSTR(MP_QSTR_AIN4), MP_ROM_PTR(&pin_PA04) },
17+
{ MP_ROM_QSTR(MP_QSTR_AIN5), MP_ROM_PTR(&pin_PA05) },
18+
{ MP_ROM_QSTR(MP_QSTR_CHRG), MP_ROM_PTR(&pin_PB08) },
19+
{ MP_ROM_QSTR(MP_QSTR_DAC0), MP_ROM_PTR(&pin_PA02) },
20+
{ MP_ROM_QSTR(MP_QSTR_PA17), MP_ROM_PTR(&pin_PA17) },
21+
{ MP_ROM_QSTR(MP_QSTR_PA18), MP_ROM_PTR(&pin_PA18) },
22+
{ MP_ROM_QSTR(MP_QSTR_PA19), MP_ROM_PTR(&pin_PA19) },
23+
{ MP_ROM_QSTR(MP_QSTR_PA20), MP_ROM_PTR(&pin_PA20) },
24+
{ MP_ROM_QSTR(MP_QSTR_PA22), MP_ROM_PTR(&pin_PA22) },
25+
{ MP_ROM_QSTR(MP_QSTR_PB16), MP_ROM_PTR(&pin_PB16) },
26+
{ MP_ROM_QSTR(MP_QSTR_PB17), MP_ROM_PTR(&pin_PB17) },
27+
{ MP_ROM_QSTR(MP_QSTR_PB22), MP_ROM_PTR(&pin_PB22) },
28+
{ MP_ROM_QSTR(MP_QSTR_PB23), MP_ROM_PTR(&pin_PB23) },
29+
30+
{ MP_ROM_QSTR(MP_QSTR_RF1_RST), MP_ROM_PTR(&pin_PB00) },
31+
{ MP_ROM_QSTR(MP_QSTR_RF1_CS), MP_ROM_PTR(&pin_PB30) },
32+
{ MP_ROM_QSTR(MP_QSTR_RF1_IO0), MP_ROM_PTR(&pin_PB05) },
33+
{ MP_ROM_QSTR(MP_QSTR_RF1_IO4), MP_ROM_PTR(&pin_PB04) },
34+
35+
{ MP_ROM_QSTR(MP_QSTR_RF2_RST), MP_ROM_PTR(&pin_PB14) },
36+
{ MP_ROM_QSTR(MP_QSTR_RF2_CS), MP_ROM_PTR(&pin_PB09) },
37+
{ MP_ROM_QSTR(MP_QSTR_RF2_IO1), MP_ROM_PTR(&pin_PB06) },
38+
{ MP_ROM_QSTR(MP_QSTR_RF2_BSY), MP_ROM_PTR(&pin_PB07) },
39+
40+
{ MP_ROM_QSTR(MP_QSTR_EN_GPS), MP_ROM_PTR(&pin_PB01) },
41+
{ MP_ROM_QSTR(MP_QSTR_TX), MP_ROM_PTR(&pin_PB02) },
42+
{ MP_ROM_QSTR(MP_QSTR_RX), MP_ROM_PTR(&pin_PB03) },
43+
44+
{ MP_ROM_QSTR(MP_QSTR_SDA), MP_ROM_PTR(&pin_PB12) },
45+
{ MP_ROM_QSTR(MP_QSTR_SCL), MP_ROM_PTR(&pin_PB13) },
46+
47+
{ MP_ROM_QSTR(MP_QSTR_WDT_WDI), MP_ROM_PTR(&pin_PA23) },
48+
{ MP_ROM_QSTR(MP_QSTR_NEOPIXEL), MP_ROM_PTR(&pin_PA21) },
49+
50+
{ MP_ROM_QSTR(MP_QSTR_UART), MP_ROM_PTR(&board_uart_obj) },
51+
{ MP_ROM_QSTR(MP_QSTR_I2C), MP_ROM_PTR(&board_i2c_obj) },
52+
{ MP_ROM_QSTR(MP_QSTR_SPI), MP_ROM_PTR(&board_spi_obj) },
53+
54+
};
55+
MP_DEFINE_CONST_DICT(board_module_globals, board_global_dict_table);

‎ports/atmel-samd/supervisor/qspi_flash.c

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -166,21 +166,34 @@ bool spi_flash_write_data(uint32_t address, uint8_t* data, uint32_t length) {
166166
bool spi_flash_read_data(uint32_t address, uint8_t* data, uint32_t length) {
167167
samd_peripherals_disable_and_clear_cache();
168168

169-
#ifdef EXTERNAL_FLASH_QSPI_DUAL
169+
#ifdef EXTERNAL_FLASH_QSPI_SINGLE
170+
QSPI->INSTRCTRL.bit.INSTR = CMD_READ_DATA;
171+
uint32_t mode = QSPI_INSTRFRAME_WIDTH_SINGLE_BIT_SPI;
172+
#elif defined(EXTERNAL_FLASH_QSPI_DUAL)
170173
QSPI->INSTRCTRL.bit.INSTR = CMD_DUAL_READ;
171174
uint32_t mode = QSPI_INSTRFRAME_WIDTH_DUAL_OUTPUT;
172175
#else
173176
QSPI->INSTRCTRL.bit.INSTR = CMD_QUAD_READ;
174177
uint32_t mode = QSPI_INSTRFRAME_WIDTH_QUAD_OUTPUT;
175178
#endif
176179

180+
#ifdef EXTERNAL_FLASH_QSPI_SINGLE
181+
QSPI->INSTRFRAME.reg = mode |
182+
QSPI_INSTRFRAME_ADDRLEN_24BITS |
183+
QSPI_INSTRFRAME_TFRTYPE_READMEMORY |
184+
QSPI_INSTRFRAME_INSTREN |
185+
QSPI_INSTRFRAME_ADDREN |
186+
QSPI_INSTRFRAME_DATAEN |
187+
QSPI_INSTRFRAME_DUMMYLEN(0);
188+
#else
177189
QSPI->INSTRFRAME.reg = mode |
178190
QSPI_INSTRFRAME_ADDRLEN_24BITS |
179191
QSPI_INSTRFRAME_TFRTYPE_READMEMORY |
180192
QSPI_INSTRFRAME_INSTREN |
181193
QSPI_INSTRFRAME_ADDREN |
182194
QSPI_INSTRFRAME_DATAEN |
183195
QSPI_INSTRFRAME_DUMMYLEN(8);
196+
#endif
184197

185198
memcpy(data, ((uint8_t *) QSPI_AHB) + address, length);
186199
// TODO(tannewt): Fix DMA and enable it.

‎supervisor/shared/external_flash/common_commands.h

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,5 +43,6 @@
4343
#define CMD_QUAD_READ 0x6b
4444
#define CMD_ENABLE_RESET 0x66
4545
#define CMD_RESET 0x99
46+
#define CMD_WAKE 0xab
4647

4748
#endif // MICROPY_INCLUDED_ATMEL_SAMD_EXTERNAL_FLASH_COMMON_COMMANDS_H

‎supervisor/shared/external_flash/devices.h

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,15 @@ typedef struct {
6464
// True when the status register is a single byte. This implies the Quad Enable bit is in the
6565
// first byte and the Read Status Register 2 command (0x35) is unsupported.
6666
bool single_status_byte: 1;
67+
68+
// Does not support using a ready bit within the status register
69+
bool no_ready_bit: 1;
70+
71+
// Does not support the erase command (0x20)
72+
bool no_erase_cmd: 1;
73+
74+
// Device does not have a reset command
75+
bool no_reset_cmd: 1;
6776
} external_flash_device;
6877

6978
// Settings for the Adesto Tech AT25DF081A 1MiB SPI flash. It's on the SAMD21
@@ -426,6 +435,27 @@ typedef struct {
426435
.single_status_byte = false, \
427436
}
428437

438+
// Settings for the Everspin MR20H40 / MR25H40 magnetic non-volatile RAM
439+
// Datasheet: https://www.everspin.com/supportdocs/MR25H40CDFR
440+
#define MR2xH40 {\
441+
.total_size = (1 << 22), /* 4 MiB */ \
442+
.start_up_time_us = 10000, \
443+
.manufacturer_id = 0xef, /*no JDEC*/ \
444+
.memory_type = 0x40, /*no JDEC*/ \
445+
.capacity = 0x14, /*no JDEC*/ \
446+
.max_clock_speed_mhz = 10, \
447+
.quad_enable_bit_mask = 0x00, \
448+
.has_sector_protection = false, \
449+
.supports_fast_read = false, \
450+
.supports_qspi = false, \
451+
.supports_qspi_writes = false, \
452+
.write_status_register_split = false, \
453+
.single_status_byte = true, \
454+
.no_ready_bit = true, \
455+
.no_erase_cmd = true, \
456+
.no_reset_cmd = true, \
457+
}
458+
429459
// Settings for the Macronix MX25L1606 2MiB SPI flash.
430460
// Datasheet:
431461
#define MX25L1606 {\

0 commit comments

Comments
 (0)