You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/reference/contributing/target/QuadSPI.md
+9-7Lines changed: 9 additions & 7 deletions
Original file line number
Diff line number
Diff line change
@@ -1,25 +1,27 @@
1
1
<h3id="quadspi-port">QuadSPI</h3>
2
2
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
+
<spanclass="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.
4
6
5
7
#### Assumptions
6
8
7
9
##### Defined behavior
8
10
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 devicespecific 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.)
11
13
12
14
##### Undefined behavior
13
15
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.
15
17
16
18
#### Dependency
17
19
18
20
QSPI peripheral
19
21
20
22
#### Implementing QuadSPI
21
23
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.
0 commit comments