poky/documentation/dev-manual/bmaptool.rst
Michael Opdenacker 991b68a00c dev-manual/bmaptool.rst: simplify and fix instructions
- Remove duplicate instructions

- Detail how to run bmaptool directly if you installed it on your host
  instead of building it through the ``bmaptool-native`` recipe,
  as running "oe-run-native bmaptool-native bmaptool ..." won't work
  in this case.

- Use "chmod a+w" instead of "chmod 666", better advice,
  and only run "chmod" in the option that runs "oe-run-native"

(From yocto-docs rev: 4afa71ef6e5bf1db126c80e6d987f588d0b5a086)

Signed-off-by: Michael Opdenacker <michael.opdenacker@rootcommit.com>
Reviewed-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-12-20 12:47:59 +00:00

59 lines
2.3 KiB
ReStructuredText

.. SPDX-License-Identifier: CC-BY-SA-2.0-UK
Flashing Images Using `bmaptool`
********************************
A fast and easy way to flash an image to a bootable device is to use
`bmaptool`, which is integrated into the OpenEmbedded build system.
`bmaptool` is a generic tool that creates a file's block map (bmap) and
then uses that map to copy the file. As compared to traditional tools
such as `dd` or `cp`, `bmaptool` can copy (or flash) large files like raw
system image files much faster.
.. note::
- If you are using Ubuntu or Debian distributions, you can install
the ``bmap-tools`` package using the following command and then
use the tool without specifying ``PATH`` even from the root
account::
$ sudo apt install bmap-tools
- If you are unable to install the ``bmap-tools`` package, you will
need to build `bmaptool` before using it. Use the following command::
$ bitbake bmaptool-native -caddto_recipe_sysroot
Following, is an example that shows how to flash a Wic image. Realize
that while this example uses a Wic image, you can use `bmaptool` to flash
any type of image. Use these steps to flash an image using `bmaptool`:
#. *Update your local.conf File:* You need to have the following set
in your ``local.conf`` file before building your image::
IMAGE_FSTYPES += "wic wic.bmap"
#. *Get Your Image:* Either have your image ready (pre-built with the
:term:`IMAGE_FSTYPES`
setting previously mentioned) or take the step to build the image::
$ bitbake image
#. *Flash the Device:* Flash the device with the image by using `bmaptool`
depending on your particular setup. The following commands assume the
image resides in the :term:`Build Directory`'s ``deploy/images/`` area:
- If you installed the package for `bmaptool`, you can directly run::
$ sudo bmaptool copy build-directory/tmp/deploy/images/machine/image.wic /dev/sdX
- Otherwise, if you built `bmaptool` with BitBake, run::
$ sudo chmod a+w /dev/sdX # get write access to the media, needed only once after booting
$ oe-run-native bmaptool-native bmaptool copy build-directory/tmp/deploy/images/machine/image.wic /dev/sdX
For help on the ``bmaptool`` command, use the following command::
$ bmaptool --help