1
0
mirror of https://git.yoctoproject.org/poky synced 2026-05-30 00:20:08 +00:00

dev-manual: Added section on bmap-tool to flash images

Fixes [YOCTO #10621]

bmaptool is integrated into the OpenEmbedded build system but is
not documented.  I added a new section describing how to flash an
image to media using the tool.  Also, updated a small section in the
Wic part of the manual that used "dd" to flash an example.  I added
a bmaptool counterpart here and referenced the reader back to the
main new section.

(From yocto-docs rev: 83a9a3aa5f20c7f389306eea9213eabea997aba1)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Scott Rifenbark
2017-01-03 14:15:31 -08:00
committed by Richard Purdie
parent 50074dfafa
commit a8e9faac40
2 changed files with 118 additions and 4 deletions
@@ -328,6 +328,99 @@
</para>
</section>
<section id='flashing-images-using-bmap-tool'>
<title>Flashing Images Using <filename>bmap-tool</filename></title>
<para>
An easy way to flash an image to a bootable device is to use
<filename>bmap-tool</filename>, which is integrated into the
OpenEmbedded build system.
</para>
<para>
Following, is an example that shows how to flash a Wic image.
<note>
You can use <filename>bmap-tool</filename> to flash any
type of image.
</note>
Use these steps to flash an image using
<filename>bmap-tool</filename>:
<orderedlist>
<listitem><para>
Add the following to your <filename>local.conf</filename>
file:
<literallayout class='monospaced'>
IMAGE_FSTYPES += "WIC WIC.BMAP"
</literallayout>
</para></listitem>
<listitem><para>
Either have your image ready (pre-built) or take the step
build the image:
<literallayout class='monospaced'>
$ bitbake <replaceable>image</replaceable>
</literallayout>
</para></listitem>
<listitem><para>
Flash the image to the media by using the
<filename>bmap-tool</filename> depending on your particular
setup:
<itemizedlist>
<listitem><para>
If you have write access, use this command form:
<literallayout class='monospaced'>
$ oe-run-native bmap-tool copy ./tmp/deploy/images/qemux86-64/core-image-minimal-<replaceable>machine</replaceable>.wic /dev/sd<replaceable>X</replaceable>
</literallayout>
</para></listitem>
<listitem><para>
If you do not have write access, use the following
commands:
<literallayout class='monospaced'>
$ sudo bash
$ PATH=tmp/sysroots/x86_64-linux/usr/bin/ bmaptool copy ./tmp/deploy/images/qemux86-64/core-image-minimal-<replaceable>machine</replaceable>.wic /dev/sd<replaceable>X</replaceable>
</literallayout>
<note>
If you are using Ubuntu 16.10 or Debian,
you can install
<filename>bmaptool</filename> using the
following command and then use the tool
without specifying
<filename>PATH</filename> even from the
root account:
<literallayout class='monospaced'>
$ sudo apt-get install bmap-tool
</literallayout>
</note>
</para></listitem>
</itemizedlist>
</para></listitem>
</orderedlist>
</para>
<para>
For help on the <filename>bmaptool</filename> command, use
<filename>bmaptool --help</filename>:
<literallayout class='monospaced'>
$ bmaptool --help
usage: bmaptool [-h] [--version] [-q] [-d] {create,copy} ...
Create block map (bmap) and copy files using bmap. The documentation can be
found here: source.tizen.org/documentation/reference/bmaptool
optional arguments:
-h, --help show this help message and exit
--version show program's version number and exit
-q, --quiet be quiet
-d, --debug print debugging information
subcommands:
{create,copy}
create generate bmap for an image file (which should be a sparse
file)
copy write an image to a block device using bmap
</literallayout>
</para>
</section>
<section id='using-pre-built-binaries-and-qemu'>
<title>Using Pre-Built Binaries and QEMU</title>