Skip to content

Commit 3789c7b

Browse files
author
Amanda Butler
authored
Copy edit QuadSPI.md
Make minor formatting changes.
1 parent 27140aa commit 3789c7b

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

docs/reference/contributing/target/QuadSPI.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,11 @@ To make sure your platform is ready for the upcoming changes, you need to implem
2828
The target needs to define the `qspi_s` structure - target specific QSPI object.
2929

3030
The target needs to define the QSPI interface pin names:
31+
3132
- `QSPI_FLASHn_XXX` for pins connected to onboard flash memory.
3233
- `QSPIn_XXX` for pins routed out to external connector.
3334

34-
`n` - is interface index, typically `1` if single QSPI interface available
35+
`n` is the interface index, typically `1` if single QSPI interface available.
3536

3637
```
3738
QSPIn_IO0
@@ -61,7 +62,7 @@ qspi_status_t qspi_read(qspi_t *obj, const qspi_command_t *command, void *data,
6162
6263
```
6364

64-
Use `qspi_write` and `qspi_read` for data transfers. For communicating with a device, use `qspi_command_transfer`.
65+
Use `qspi_write` and `qspi_read` for data transfers. To communicate with a device, use `qspi_command_transfer`.
6566

6667
To enable the QSPI HAL, define `QSPI` in the targets.json file inside `device_has`:
6768

@@ -73,7 +74,11 @@ To enable the QSPI HAL, define `QSPI` in the targets.json file inside `device_ha
7374

7475
### Testing
7576

76-
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:
77+
The Mbed OS HAL provides a set of conformance tests for the QSPI interface.
78+
79+
<span class="notes">**Note:** QSPI HAL tests require onboard QSPI flash memory.</span>
80+
81+
You can use these tests to validate the correctness of your implementation. To run the QSPI HAL tests, use the following command:
7782

7883
```
7984
mbed test -t <toolchain> -m <target> -n tests-mbed_hal-qspi

0 commit comments

Comments
 (0)