Skip to content

Commit a90f94b

Browse files
committed
update flash_config in examples
1 parent 1272318 commit a90f94b

File tree

2 files changed

+58
-48
lines changed

2 files changed

+58
-48
lines changed
Lines changed: 29 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
/*
1+
/*
22
* The MIT License (MIT)
33
*
44
* Copyright (c) 2022 Ha Thach (tinyusb.org) for Adafruit Industries
@@ -30,38 +30,43 @@
3030
// #define CUSTOM_SPI SPI
3131

3232
#if defined(CUSTOM_CS) && defined(CUSTOM_SPI)
33-
Adafruit_FlashTransport_SPI flashTransport(CUSTOM_CS, CUSTOM_SPI);
33+
Adafruit_FlashTransport_SPI flashTransport(CUSTOM_CS, CUSTOM_SPI);
3434

3535
#elif defined(ARDUINO_ARCH_ESP32)
36-
// ESP32 use same flash device that store code.
37-
// Therefore there is no need to specify the SPI and SS
38-
Adafruit_FlashTransport_ESP32 flashTransport;
36+
// ESP32 use same flash device that store code for file system.
37+
// SPIFlash will parse partition.cvs to detect FATFS partition to use
38+
Adafruit_FlashTransport_ESP32 flashTransport;
3939

4040
#elif defined(ARDUINO_ARCH_RP2040)
41-
// RP2040 use same flash device that store code.
42-
// Therefore there is no need to specify the SPI and SS
43-
// Use default (no-args) constructor to be compatible with CircuitPython partition scheme
44-
Adafruit_FlashTransport_RP2040 flashTransport;
41+
// RP2040 use same flash device that store code for file system. Therefore we
42+
// only need to specify start address and size (no need SPI or SS)
43+
// Adafruit_FlashTransport_RP2040(start_address, size)
44+
// If start = 0, size = 0 (default), values that match file system setting in
45+
// 'Tools->Flash Size' menu selection will be used.
46+
Adafruit_FlashTransport_RP2040 flashTransport;
4547

46-
// For generic usage: Adafruit_FlashTransport_RP2040(start_address, size)
47-
// If start_address and size are both 0, value that match filesystem setting in
48-
// 'Tools->Flash Size' menu selection will be used
48+
// To be compatible with CircuitPython partition scheme (start_address = 1 MB,
49+
// size = total flash - 1 MB) use const value (CPY_START_ADDR, CPY_SIZE).
50+
// Un-comment following line:
51+
// Adafruit_FlashTransport_RP2040
52+
// flashTransport(Adafruit_FlashTransport_RP2040::CPY_START_ADDR,
53+
// Adafruit_FlashTransport_RP2040::CPY_SIZE);
4954

5055
#else
51-
// On-board external flash (QSPI or SPI) macros should already
52-
// defined in your board variant if supported
53-
// - EXTERNAL_FLASH_USE_QSPI
54-
// - EXTERNAL_FLASH_USE_CS/EXTERNAL_FLASH_USE_SPI
55-
#if defined(EXTERNAL_FLASH_USE_QSPI)
56-
Adafruit_FlashTransport_QSPI flashTransport;
56+
// On-board external flash (QSPI or SPI) macros should already
57+
// defined in your board variant if supported
58+
// - EXTERNAL_FLASH_USE_QSPI
59+
// - EXTERNAL_FLASH_USE_CS/EXTERNAL_FLASH_USE_SPI
60+
#if defined(EXTERNAL_FLASH_USE_QSPI)
61+
Adafruit_FlashTransport_QSPI flashTransport;
5762

58-
#elif defined(EXTERNAL_FLASH_USE_SPI)
59-
Adafruit_FlashTransport_SPI flashTransport(EXTERNAL_FLASH_USE_CS, EXTERNAL_FLASH_USE_SPI);
63+
#elif defined(EXTERNAL_FLASH_USE_SPI)
64+
Adafruit_FlashTransport_SPI flashTransport(EXTERNAL_FLASH_USE_CS,
65+
EXTERNAL_FLASH_USE_SPI);
6066

61-
#else
62-
#error No (Q)SPI flash are defined for your board !
63-
#endif
67+
#else
68+
#error No (Q)SPI flash are defined for your board !
69+
#endif
6470
#endif
65-
6671

6772
#endif
Lines changed: 29 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
/*
1+
/*
22
* The MIT License (MIT)
33
*
44
* Copyright (c) 2022 Ha Thach (tinyusb.org) for Adafruit Industries
@@ -30,38 +30,43 @@
3030
// #define CUSTOM_SPI SPI
3131

3232
#if defined(CUSTOM_CS) && defined(CUSTOM_SPI)
33-
Adafruit_FlashTransport_SPI flashTransport(CUSTOM_CS, CUSTOM_SPI);
33+
Adafruit_FlashTransport_SPI flashTransport(CUSTOM_CS, CUSTOM_SPI);
3434

3535
#elif defined(ARDUINO_ARCH_ESP32)
36-
// ESP32 use same flash device that store code.
37-
// Therefore there is no need to specify the SPI and SS
38-
Adafruit_FlashTransport_ESP32 flashTransport;
36+
// ESP32 use same flash device that store code for file system.
37+
// SPIFlash will parse partition.cvs to detect FATFS partition to use
38+
Adafruit_FlashTransport_ESP32 flashTransport;
3939

4040
#elif defined(ARDUINO_ARCH_RP2040)
41-
// RP2040 use same flash device that store code.
42-
// Therefore there is no need to specify the SPI and SS
43-
// Use default (no-args) constructor to be compatible with CircuitPython partition scheme
44-
Adafruit_FlashTransport_RP2040 flashTransport;
41+
// RP2040 use same flash device that store code for file system. Therefore we
42+
// only need to specify start address and size (no need SPI or SS)
43+
// Adafruit_FlashTransport_RP2040(start_address, size)
44+
// If start = 0, size = 0 (default), values that match file system setting in
45+
// 'Tools->Flash Size' menu selection will be used.
46+
Adafruit_FlashTransport_RP2040 flashTransport;
4547

46-
// For generic usage: Adafruit_FlashTransport_RP2040(start_address, size)
47-
// If start_address and size are both 0, value that match filesystem setting in
48-
// 'Tools->Flash Size' menu selection will be used
48+
// To be compatible with CircuitPython partition scheme (start_address = 1 MB,
49+
// size = total flash - 1 MB) use const value (CPY_START_ADDR, CPY_SIZE).
50+
// Un-comment following line:
51+
// Adafruit_FlashTransport_RP2040
52+
// flashTransport(Adafruit_FlashTransport_RP2040::CPY_START_ADDR,
53+
// Adafruit_FlashTransport_RP2040::CPY_SIZE);
4954

5055
#else
51-
// On-board external flash (QSPI or SPI) macros should already
52-
// defined in your board variant if supported
53-
// - EXTERNAL_FLASH_USE_QSPI
54-
// - EXTERNAL_FLASH_USE_CS/EXTERNAL_FLASH_USE_SPI
55-
#if defined(EXTERNAL_FLASH_USE_QSPI)
56-
Adafruit_FlashTransport_QSPI flashTransport;
56+
// On-board external flash (QSPI or SPI) macros should already
57+
// defined in your board variant if supported
58+
// - EXTERNAL_FLASH_USE_QSPI
59+
// - EXTERNAL_FLASH_USE_CS/EXTERNAL_FLASH_USE_SPI
60+
#if defined(EXTERNAL_FLASH_USE_QSPI)
61+
Adafruit_FlashTransport_QSPI flashTransport;
5762

58-
#elif defined(EXTERNAL_FLASH_USE_SPI)
59-
Adafruit_FlashTransport_SPI flashTransport(EXTERNAL_FLASH_USE_CS, EXTERNAL_FLASH_USE_SPI);
63+
#elif defined(EXTERNAL_FLASH_USE_SPI)
64+
Adafruit_FlashTransport_SPI flashTransport(EXTERNAL_FLASH_USE_CS,
65+
EXTERNAL_FLASH_USE_SPI);
6066

61-
#else
62-
#error No (Q)SPI flash are defined for your board !
63-
#endif
67+
#else
68+
#error No (Q)SPI flash are defined for your board !
69+
#endif
6470
#endif
65-
6671

6772
#endif

0 commit comments

Comments
 (0)