File tree Expand file tree Collapse file tree 3 files changed +64
-0
lines changed Expand file tree Collapse file tree 3 files changed +64
-0
lines changed Original file line number Diff line number Diff line change @@ -172,6 +172,16 @@ The following libraries are specific to the ESP8266 and ESP32.
172172 espnow.rst
173173
174174
175+ Libraries specific to NXP i.MXRT
176+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
177+
178+ The following libraries are specific to the NXP i.MXRT family of microcontrollers.
179+
180+ .. toctree ::
181+ :maxdepth: 2
182+
183+ mimxrt.rst
184+
175185Libraries specific to the RP2040
176186~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
177187
Original file line number Diff line number Diff line change 1+ .. currentmodule :: mimxrt
2+ .. _mimxrt.Flash :
3+
4+ class Flash -- access to built-in flash storage
5+ ===============================================
6+
7+ This class gives access to the SPI flash memory.
8+
9+ In most cases, to store persistent data on the device, you'll want to use a
10+ higher-level abstraction, for example the filesystem via Python's standard file
11+ API, but this interface is useful to :ref: `customise the filesystem
12+ configuration <filesystem>` or implement a low-level storage system for your
13+ application.
14+
15+
16+ Constructors
17+ ------------
18+
19+ .. class :: Flash()
20+
21+ Gets the singleton object for accessing the SPI flash memory.
22+
23+
24+ Methods
25+ -------
26+
27+ .. method :: Flash.readblocks(block_num, buf)
28+ Flash.readblocks(block_num, buf, offset)
29+ .. method :: Flash.writeblocks(block_num, buf)
30+ Flash.writeblocks(block_num, buf, offset)
31+ .. method :: Flash.ioctl(cmd, arg)
32+
33+ These methods implement the simple and extended
34+ :ref: `block protocol <block-device-interface >` defined by
35+ :class: `vfs.AbstractBlockDev `.
Original file line number Diff line number Diff line change 1+ .. currentmodule :: mimxrt
2+
3+ :mod: `mimxrt ` --- functionality specific to NXP i.MXRT
4+ ======================================================
5+
6+ .. module :: mimxrt
7+ :synopsis: functionality specific to NXP i.MXRT
8+
9+ The ``mimxrt `` module contains functions and classes specific to the NXP i.MXRT
10+ family of microcontrollers.
11+
12+
13+ Classes
14+ -------
15+
16+ .. toctree ::
17+ :maxdepth: 1
18+
19+ mimxrt.Flash.rst
You can’t perform that action at this time.
0 commit comments