Skip to content

Commit b57f104

Browse files
Add QSPI standard pin names
1 parent b82522a commit b57f104

File tree

1 file changed

+27
-1
lines changed

1 file changed

+27
-1
lines changed

docs/reference/contributing/target/QuadSPI.md

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,28 @@ To make sure your platform is ready for the upcoming changes, you need to implem
2929

3030
The target needs to define the `qspi_s` structure - target specific QSPI object.
3131

32+
The target needs to define the QSPI interface pin names:
33+
- `QSPI_FLASHn_XXX` for pins connected to onboard flash memory.
34+
- `QSPIn_XXX` for pins routed out to external connector.
35+
36+
`n` - is interface index, typically `1` if single QSPI interface available
37+
38+
```
39+
QSPIn_IO0
40+
QSPIn_IO1
41+
QSPIn_IO2
42+
QSPIn_IO3
43+
QSPIn_SCK
44+
QSPIn_CSN
45+
46+
QSPI_FLASHn_IO0
47+
QSPI_FLASHn_IO1
48+
QSPI_FLASHn_IO2
49+
QSPI_FLASHn_IO3
50+
QSPI_FLASHn_SCK
51+
QSPI_FLASHn_CSN
52+
```
53+
3254
Functions to implement:
3355

3456
```
@@ -53,4 +75,8 @@ To enable the QSPI HAL, define `QSPI` in the targets.json file inside `device_ha
5375

5476
### Testing
5577

56-
To be implemented
78+
The Mbed OS HAL provides a set of conformance tests for the QSPI interface (**Note: QSPI HAL tests require onboard QSPI flash memory**). You can use these tests to validate the correctness of your implementation. To run the QSPI HAL tests, use the following command:
79+
80+
```
81+
mbed test -t <toolchain> -m <target> -n tests-mbed_hal-qspi
82+
```

0 commit comments

Comments
 (0)