Skip to content

Commit

Permalink
Update readme file
Browse files Browse the repository at this point in the history
Signed-off-by: fpr <fabien.perroquin@wi6labs.com>
  • Loading branch information
fpr committed Sep 21, 2017
1 parent 82e4a41 commit 73892c8
Showing 1 changed file with 35 additions and 0 deletions.
35 changes: 35 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,37 @@
# MX25R6435F
Arduino library to support the Quad-SPI NOR Flash memory MX25R6435F

## API

The library provides the following API:

* begin()
* end()
* write()
* read()
* mapped()
* erase()
* eraseChip()
* eraseSector()
* suspendErase()
* resumeErase()
* sleep()
* wakeup()
* status()
* info()
* length()

## Examples

3 sketches provide basic examples to show how to use the library API.
demo.ino uses basic read/write functions.
eraseChip.ino erases all data present in the memory.
memoryMappedMode.ino shows how to use the mapped mode.

## Documentation

You can find the source files at
https://github.com/stm32duino/MX25R6435F

The MX25R6435F datasheet is available at
http://www.mxic.com.tw/Lists/Datasheet/Attachments/6270/MX25R6435F,%20Wide%20Range,%2064Mb,%20v1.4.pdf

0 comments on commit 73892c8

Please sign in to comment.