...

1. Run a generic erase/write/read/compare test:

   Code Block
   uart:~$ flash test gd25wb256e3ir@1 0 0x4000 1 Erase OK. Write OK. Verified OK. Erase-Write-Verify test done.

2. Run read and write measurements:

   Code Block
   uart:~$ flash erase gd25wb256e3ir@1 0 0x4000 Erase success. uart:~$ flash write_test gd25wb256e3ir@1 0 0x4000 1 Loop #1 done in 53 ticks. Total: 53ms, Per loop: ~53ms, Speed: ~301.9KiBps uart:~$ flash read_test gd25wb256e3ir@1 0 0x4000 1 Loop #1 done in 16ms. Total: 16ms, Per loop: ~16ms, Speed: ~1000.0KiBps

3.5. Configuring for a Different SPI Flash Device

This chapter explains how to configure a different Flash device in the Zephyr BSP. Specifically, the GD25WB256E Flash device installed on the Thingy-9151-Lite platform is used as an example.

3.5.1.

...

Obtaining JEDEC

...

Info

First step when setting a new SPI Flash is to obtain information about it. To do so, we need to create a minimally required description of the Flash. Let’s start with the following overlay:

&arduino_spi {

        newspi: newdevice@1 {
                compatible = "jedec,spi-nor";
                status = "ok";
                reg = <1>;
                spi-max-frequency = <8000000>;
                jedec-id = [c8 65 19];
                size = <0x400000>;
        };
};

/ {
        aliases {
                spi-flash0 = &newspi;
        };
};

We’re adding In the above, we are adding a new device newdevice@1 at address 1 (match matching the CS used for the chip) and create creating a label to refer to it as newspi. The compatibleand status fields select the driver and mark the device as present. The reg field specifies the CS for our SPI device. spi-max-frequency, jedec-id and size (in bits!) can easily need to be obtained from the SPI flash datasheetFlash data sheet. spi-max-frequency may be lower than the maximum value specified in datasheet and the data sheet. size does not have to be correct at this point, just to be correctly aligned, so the driver does not refuse the configuration.

Now As a next step, go to zephyr/samples/drivers/jesd216, put the fragment above into boards/nrf9161dk_nrf9161.overlay and build the sample using west:

$ cd zephyr/samples/drivers/jesd216
$ cat >boards/nrf9161dk_nrf9161.overlay <<EOF
&arduino_spi {

        newspi: newdevice@1 {
                compatible = "jedec,spi-nor";
                status = "ok";
                reg = <1>;
                spi-max-frequency = <8000000>;
                jedec-id = [c8 65 19];
                size = <0x400000>;
        };
};

/ {
        aliases {
                spi-flash0 = &newspi;
        };
};
EOF
$ west build -b nrf9161dk_nrf9161 -d build_an -p

If the build finish finishes successfully, there will be a build_an/zephyr/zephyr.hex file that can be installed and run on the target. Here’s Here is some example output after when running this demo:

*** Booting nRF Connect SDK v2.5.1-7-g76a2a1188200 ***
newdevice@1: SFDP v 1.6 AP ff with 3 PH
PH0: ff00 rev 1.6: 16 DW @ 30
Summary of BFP content:
DTR Clocking not supported
Addressing: 3- or 4-Byte
4-KiBy erase: uniform
Support QSPI XIP
Support 1-1-1
Support 1-1-2: instr 3Bh, 0 mode clocks, 8 waits
Support 1-1-4: instr 6Bh, 0 mode clocks, 8 waits
Support 1-2-2: instr BBh, 2 mode clocks, 2 waits
Support 1-4-4: instr EBh, 2 mode clocks, 4 waits
Flash density: 33554432 bytes
ET1: instr 20h for 4096 By; typ 80 ms, max 800 ms
ET2: instr 52h for 32768 By; typ 256 ms, max 2560 ms
ET3: instr D8h for 65536 By; typ 304 ms, max 3040 ms
Chip erase: typ 60928 ms, max 487424 ms
Byte program: type 80 + 5 * B us, max 640 + 40 * B us
Page program: typ 512 us, max 4096 us
Page size: 256 By
Suspend: 75h ; Resume: 7Ah
DPD: Enter B9h, exit ABh ; delay 40000 ns ; poll 0x01
HOLD or RESET Disable: unsupported
QER: 7
0-4-4 Mode methods: entry 0x4 ; exit 0x01
4-4-4 Mode sequences: enable 0x00 ; disable 0x0
4-byte addressing support: enter 0x01, exit 0x001
Soft Reset and Rescue Sequence support: 0x10
Status Register 1 support: 0x08
size = <268435456>;
sfdp-bfp = [
	e5 20 f3 ff  ff ff ff 0f  44 eb 08 6b  08 3b 42 bb
	ee ff ff ff  ff ff 00 ff  ff ff 00 ff  0c 20 0f 52
	10 d8 00 ff  44 7a c9 fe  83 67 26 62  ec 82 18 44
	7a 75 7a 75  04 c4 d5 5c  00 06 74 00  08 50 00 01
	];
PH1: ffc8 rev 1.0: 3 DW @ 90
sfdp-ffc8 = [
	00 36 50 16  9d f9 77 64  fc cb ff ff
	];
PH2: ff84 rev 1.0: 2 DW @ c0
sfdp-ff84 = [
	ff 0e f0 ff  21 5c dc ff
	];
jedec-id = [c8 65 19];

Now, we can replace the size line in our flash Flash descriptor in the overlay with the value obtained from the SFDP by this sample. We can also copy the sfdp-bfp value from the output: it may be needed if SPI_NOR_SFDP_DEVICETREE is used in the configuration. As the line starting with DPD: indicates, the hardware supports DPD using the B9h and ABh commands and the time to wake up is 40000 ns. Unfortunately The time to enter DPD can only be obtained from datasheet the data sheet (usually t_DP, it is referred to as tDP). Add has-dpd, t-enter-dpd and t-exit-dpd. Now, we can finalize flash finalise the Flash description in the overlay:

/* Deactivate predefined flash node for SPI flash installed on DK */
&gd25wb256 {
        status = "disable";
};

&arduino_spi {
/* Insert node for new device */
        newspi: newdevice@1 {
                compatible = "jedec,spi-nor";
                status = "ok";
                reg = <1>;
                spi-max-frequency = <8000000>;
                jedec-id = [c8 65 19];
                size = <268435456>;
                has-dpd;
                t-enter-dpd = <3000>;
                t-exit-dpd = <40000>;
                sfdp-bfp = [ 
                        e5 20 f3 ff  ff ff ff 0f  44 eb 08 6b  08 3b 42 bb
                        ee ff ff ff  ff ff 00 ff  ff ff 00 ff  0c 20 0f 52
                        10 d8 00 ff  44 7a c9 fe  83 67 26 62  ec 82 18 44
                        7a 75 7a 75  04 c4 d5 5c  00 06 74 00  08 50 00 01
                        ]; 
        };
};

/* Use new device in choosen and aliases */
/ {
       chosen {
                nordic,pm-ext-flash = &newspi;
       };

       aliases {
                spi-flash0 = &newspi;
                ext-flash = &newspi;
       };
};

3.5.2. Configuring for

...

Different SPI

...

Flash Device with QSPI support on nRF5340

...

The nRF5340 MCU includes a QSPI controller that allows to use faster flash Flash devices in dual and quad SPI mode.

Following the similar procedure to for an SPI flash Flash discussed above, jedec216 provides the following output:

...

spi-max-frequency, jedec-id, sfdp-bfp, size, has-dpd, t-enter-dpd and t-exit-dpd are determined similarly to the SPI case. However nordic,qspi-nor requires additional parameters to enable the quad mode:

• quad-enable-requirements defines a method to enable the quad mode and can be determined from the line starting with QER: in the output

QER:	quad-enable-requirements
0	'NONE'
1	'S2B1v1'
2	'S1B6'
3	'S2B7'
4	'S2B1v4'
5	'S2B1v5'
6	'S2B1v6'

• readoc and writeoc define the command and the mode used during for the quad access:

Mode	Write instruction	Read Instruction	writeoc	readoc
1-1-1	0x02	0x0B	'pp'	'fastread'
1-1-2	0xA2	0x3B	'pp2o'	'read2o'
1-2-2		0xBB		'read2io'
1-1-4	0x32	0x6B	'pp4o'	'read4o'
1-4-4	0x38	0xEB	'pp4io'	'read4io'

For the both parameters above, the yellow lines indicate the values not supported by nordic,qspi-nor.

For the device used in this test, both the 1-1-4 and 1-4-4 modes are available, but with 1-4-4 is being slightly faster, so it will be selected. Final The final device tree entry is as follows:

Code Block

mx25r64: mx25r6435f@0 { compatible = "nordic,qspi-nor"; reg = < 0x0 >; writeoc = "pp4io"; readoc = "read4io"; quad-enable-requirements = "S1B6"; sck-frequency = < 8000000 >; jedec-id = [ C2 28 17 ]; sfdp-bfp = [ E5 20 F1 FF FF FF FF 03 44 EB 08 6B 08 3B 04 BB EE FF FF FF FF FF 00 FF FF FF 00 FF 0C 20 0F 52 10 D8 00 FF 23 72 F5 00 82 ED 04 CC 44 83 68 44 30 B0 30 B0 F7 C4 D5 5C 00 BE 29 FF F0 D0 FF FF ]; size = < 0x4000000 >; has-dpd; t-enter-dpd = < 10000 >; t-exit-dpd = < 35000 >; };

...