be15be3ab5
This adds docs for the `mimxrt` module and the `mimxrt.Flash` class, the
implementation for which was first added in
dfd4324eb1
The docs are simple, following the conventions used for similar classes in
the rp2 and stm32 ports.
Signed-off-by: Andrew Leech <andrew.leech@planetinnovation.com.au>
40 lines
1.2 KiB
ReStructuredText
40 lines
1.2 KiB
ReStructuredText
.. currentmodule:: mimxrt
|
|
.. _mimxrt.Flash:
|
|
|
|
class Flash -- access to built-in flash storage
|
|
===============================================
|
|
|
|
This class gives access to the SPI flash memory.
|
|
|
|
In most cases, to store persistent data on the device, you'll want to use a
|
|
higher-level abstraction, for example the filesystem via Python's standard file
|
|
API, but this interface is useful to :ref:`customise the filesystem
|
|
configuration <filesystem>` or implement a low-level storage system for your
|
|
application.
|
|
|
|
|
|
Constructors
|
|
------------
|
|
|
|
.. class:: Flash()
|
|
|
|
Gets the singleton object for accessing the SPI flash memory.
|
|
|
|
|
|
Methods
|
|
-------
|
|
|
|
.. method:: Flash.readblocks(block_num, buf)
|
|
Flash.readblocks(block_num, buf, offset)
|
|
.. method:: Flash.writeblocks(block_num, buf)
|
|
Flash.writeblocks(block_num, buf, offset)
|
|
.. method:: Flash.ioctl(cmd, arg)
|
|
|
|
These methods implement the simple and extended
|
|
:ref:`block protocol <block-device-interface>` defined by
|
|
:class:`vfs.AbstractBlockDev`.
|
|
|
|
The block size can be queried by calling ``ioctl(5, 0)``. Block numbers
|
|
are relative to the start of the user flash storage area, not the physical
|
|
start of flash memory.
|