u-boot/doc/usage/cmd/write.rst
Heinrich Schuchardt 3cb97f9293 doc: separate read and write command documentation
* Avoid two step navigation to get to the description of the write command.
* Add missing index entries
* Correct formatting of the examples.
* Describe configuration and return value.

Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
2025-10-26 10:15:21 +00:00

47 lines
1.1 KiB
ReStructuredText

.. SPDX-License-Identifier: GPL-2.0-or-later
.. index::
single: write (command)
write command
=============
Synopsis
--------
::
write <interface> <dev[:part|#partname]> <addr> <blk#> <cnt>
Description
-----------
The write command can be used for raw writing data to a block device
(or partition therein), i.e. without going through a file system.
The block device is specified using the <interface> (e.g. "mmc") and
<dev> parameters. If the block device has a partition table, one can
optionally specify a partition number (using the :part syntax) or
partition name (using the #partname syntax). The command then reads
the <cnt> blocks of data starting at block number <blk#> of the given
device/partition to the memory address <addr>.
Examples
--------
.. code-block:: bash
# Write to the third sector of the partition named 'bootdata' of mmc device 0
write mmc 0#bootdata $loadaddr 2 1
Configuration
-------------
The write command is only available if CONFIG_CMD_WRITE=y.
Return value
------------
The command sets the return value $? to 0 (true) on success and to 1 (false) in
case of an error.