Skip to content

Commit 73a8129

Browse files
author
Amanda Butler
authored
Copy edit QuadSPI.md
Copy edit file for active voice and inclusion of articles.
1 parent 9fa88b8 commit 73a8129

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

docs/reference/contributing/target/QuadSPI.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,27 @@
11
<h3 id="quadspi-port">QuadSPI</h3>
22

3-
QSPI HAL defines API for targets that contain QSPI capable peripheral. The QSPI interface is often used for data storage.
3+
The QSPI HAL defines API for targets that contain QSPI capable peripheral. Developers often use the QSPI interface for data storage.
4+
5+
<span class="warnings">**Warning:** We are changing the QSPI HAL API in an upcoming release of Mbed OS. You can find details on how it may affect you in the [Implementing the QSPI API](#implementing-the-qspi-api) section.
46

57
#### Assumptions
68

79
##### Defined behavior
810

9-
- a target implementaion should cover the most of QSPI frame format (some targets might not provide the flexibility for setting all frame parameters)
10-
- command transfer - a target might provide additional API for sending device specific commands. In case it does not, it can be implemented via read/write functions (this is target/driver dependent)
11+
- A target implementaion covers most of the QSPI frame format (some targets might not provide the flexibility for setting all frame parameters).
12+
- Command transfer - A target might provide additional API for sending device-specific commands. If it does not, you can implement it using read and write functions. (This is target or driver dependent.)
1113

1214
##### Undefined behavior
1315

14-
- Calling any function other than `qspi_init` before the initialization of the QSPI
16+
- Calling any function other than `qspi_init` before the initialization of the QSPI.
1517

1618
#### Dependency
1719

1820
QSPI peripheral
1921

2022
#### Implementing QuadSPI
2123

22-
The target needs to define `qspi_s` structure - target specific QSPI object.
24+
The target needs to define the `qspi_s` structure - target specific QSPI object.
2325

2426
Functions to implement:
2527

@@ -33,9 +35,9 @@ qspi_status_t qspi_read(qspi_t *obj, const qspi_command_t *command, void *data,
3335
3436
```
3537

36-
`qspi_write` and `qspi_read` are used for data transfers. For communicating with a device, `qspi_command_transfer` should be used.
38+
Use `qspi_write` and `qspi_read` for data transfers. For communicating with a device, use `qspi_command_transfer`.
3739

38-
To enable QSPI HAL, define `QSPI` in targets.json file inside `device_has`:
40+
To enable the QSPI HAL, define `QSPI` in the targets.json file inside `device_has`:
3941

4042
```
4143
"TARGET_NAME": {

0 commit comments

Comments
 (0)