Skip to content

Commit b24fb01

Browse files
committed
QSPI: add contributing guide
1 parent 84e830c commit b24fb01

File tree

1 file changed

+10
-7
lines changed

1 file changed

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

3-
[Include a brief description here.]
3+
QSPI HAL defines API for targets that contain QSPI capable peripheral. The QSPI interface is often used for data storage.
44

55
### Assumptions
66

77
#### Defined behavior
88

9-
[Include any defined behavior in bullet format here.]
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
1011

1112
#### Undefined behavior
1213

13-
[Include any undefined behavior in bullet format here.]
14+
- Calling any function other than `qspi_init` before the initialization of the QSPI
1415

15-
#### Potential bugs
16+
#### Dependency
1617

17-
[Include any potential bugs in bullet format here.]
18+
QSPI peripheral
1819

1920
### Implementing QuadSPI
2021

21-
[Include implementation information here.]
22+
The target needs to define `qspi_s` structure - target specific QSPI object, enable QSPI in targets.json file `device_has` and implement QSPI HAL functions defined in `hal/qspi_api.h` header file.
23+
24+
`qspi_write` and `qspi_read` are used for data transfers. For communicating with device, `qspi_command_transfer` should be used.
2225

2326
### Testing
2427

25-
[Include testing information here.]
28+
To be implemented

0 commit comments

Comments
 (0)