Skip to content

Commit 19a71b9

Browse files
author
Amanda Butler
authored
Merge pull request #354 from SenRamakri/sen_QuadSPIDocs
QuadSPI API documentation
2 parents 34c6463 + 7896568 commit 19a71b9

File tree

2 files changed

+18
-4
lines changed

2 files changed

+18
-4
lines changed

docs/images/quadspi.png

22.7 KB
Loading

docs/reference/api/drivers/QuadSPI.md

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,25 @@
1-
## QuadSPI
1+
## QuadSPI (QSPI)
22

3-
[Add description here.]
3+
The QSPI driver in Mbed OS provides functionality to configure and access QSPI devices connected over a QuadSPI interface.
4+
5+
The QSPI protocol provides a serial communication interface on four data lines between the host and the device. It uses up to six lines in total: one line for chip select, one line for clock and four lines for data in/out. You can use this interface for communication with QSPI devices, such as Flash memory, display devices and other types of devices providing QuadSPI communication support. You can also configure the QSPI interface to work in Single-SPI (traditional SPI) mode or Dual-SPI mode.
6+
7+
The default configuration for the QSPI interface is 1 MHz, Single-SPI, Mode 0.
8+
9+
<span class="images">![](https://s3-us-west-2.amazonaws.com/mbed-os-docs-images/quadspi.png)<span><br>The above diagram shows an example hardware configuration of a Flash memory connected over a QSPI interface.</span>
10+
11+
For more information, please review the related content.
412

513
### QuadSPI class reference
614

7-
[Add class reference here.]
15+
[![View code](https://www.mbed.com/embed/?type=library)](http://os-doc-builder.test.mbed.com/docs/development/mbed-os-api-doxy/classmbed_1_1_q_s_p_i.html)
816

917
### QuadSPI example
1018

11-
[Add brief description followed by example here.]
19+
[![View Example](https://www.mbed.com/embed/?url=https://os.mbed.com/teams/mbed_example/code/mbed-os-example-qspi/)](https://os.mbed.com/teams/mbed_example/code/mbed-os-example-qspi)
20+
21+
### Related content
22+
23+
- [STMicroelectronics Quad-SPI documentation](www.st.com/resource/en/application_note/dm00227538.pdf).
24+
- [Macronix MX25R6435F flash memory with Quad-SPI](http://www.macronix.com/Lists/Datasheet/Attachments/6270/MX25R6435F,%20Wide%20Range,%2064Mb,%20v1.4.pdf).
25+
- [Nordic Quad-SPI support in NRF52840](http://infocenter.nordicsemi.com/pdf/nRF52840_OPS_v0.5.pdf).

0 commit comments

Comments
 (0)