Skip to content

Commit 80e0ff7

Browse files
committed
QuadSPI API documentation
1 parent 82e0a36 commit 80e0ff7

File tree

2 files changed

+12
-3
lines changed

2 files changed

+12
-3
lines changed

docs/images/quadspi.png

22.7 KB
Loading

docs/reference/api/drivers/QuadSPI.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,20 @@
11
## QuadSPI
22

3-
[Add description here.]
3+
The QuadSPI driver in mbed-os provides functionality to configure and access QuadSPI devices connected over a QuadSPI interface.
4+
The QuadSPI protocol provides a serial communication interface on four data lines between host and 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. The QuadSPI interface can also be configured to work in Single-SPI(traditional SPI) mode or Dual-SPI mode.
5+
The default configuration for the QuadSPI interface are 1 MHz, Single-SPI, Mode 0.
6+
7+
<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 QuadSPI interface.</span> For more information, please review the related content.
48

59
### QuadSPI class reference
610

7-
[Add class reference here.]
11+
[![View code](https://www.mbed.com/embed/?type=library)](https://os.mbed.com/docs/v5.6/mbed-os-api-doxy/classmbed_1_1QSPI.html)
812

913
### QuadSPI example
1014

11-
[Add brief description followed by example here.]
15+
[![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/)
16+
17+
### Related content
18+
<a href="www.st.com/resource/en/application_note/dm00227538.pdf">STMicroelectronics Quad-SPI documentation</a>
19+
<a href="http://www.macronix.com/Lists/Datasheet/Attachments/6270/MX25R6435F,%20Wide%20Range,%2064Mb,%20v1.4.pdf">Macronix MX25R6435F flash memory with Quad-SPI</a>
20+
<a href="http://infocenter.nordicsemi.com/pdf/nRF52840_OPS_v0.5.pdf">Nordic Quad-SPI support in NRF52840</a>

0 commit comments

Comments
 (0)