djsundog
/
circuitpython
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs/library/uos.rst: Improve block devices section, and ioctl ret vals.

This commit is contained in:
Peter Hinch 2020-01-12 09:20:36 +00:00 committed by Damien George
parent 5c5f93c1b8
commit 59746ac14a
1 changed files with 22 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
docs/library/uos.rst
View File

@ -218,11 +218,19 @@ represented by VFS classes.
Block devices Block devices
------------- -------------
A block device is an object which implements the block protocol, which is a set A block device is an object which implements the block protocol. This enables a
of methods described below by the :class:`AbstractBlockDev` class. A concrete device to support MicroPython filesystems. The physical hardware is represented
implementation of this class will usually allow access to the memory-like by a user defined class. The :class:`AbstractBlockDev` class is a template for
functionality a piece of hardware (like flash memory). A block device can be the design of such a class: MicroPython does not actually provide that class,
used by a particular filesystem driver to store the data for its filesystem. but an actual block device class must implement the methods described below.
A concrete implementation of this class will usually allow access to the
memory-like functionality of a piece of hardware (like flash memory). A block
device can be formatted to any supported filesystem and mounted using ``uos``
methods.
See :ref:`filesystem` for example implementations of block devices using the
two variants of the block protocol described below.
.. _block-device-interface: .. _block-device-interface:
@ -294,5 +302,12 @@ that the block device supports the extended interface.
(*arg* is unused) (*arg* is unused)
- 6 -- erase a block, *arg* is the block number to erase - 6 -- erase a block, *arg* is the block number to erase
See :ref:`filesystem` for example implementations of block devices using both As a minimum ``ioctl(4, ...)`` must be intercepted; for littlefs
protocols. ``ioctl(6, ...)`` must also be intercepted. The need for others is
hardware dependent.
Unless otherwise stated ``ioctl(op, arg)`` can return ``None``.
Consequently an implementation can ignore unused values of ``op``. Where
``op`` is intercepted, the return value for operations 4 and 5 are as
detailed above. Other operations should return 0 on success and non-zero
for failure, with the value returned being an ``OSError`` errno code.