diff options
Diffstat (limited to 'documentation/dev-manual/bmaptool.rst')
-rw-r--r-- | documentation/dev-manual/bmaptool.rst | 59 |
1 files changed, 59 insertions, 0 deletions
diff --git a/documentation/dev-manual/bmaptool.rst b/documentation/dev-manual/bmaptool.rst new file mode 100644 index 0000000000..4ee6f5e48b --- /dev/null +++ b/documentation/dev-manual/bmaptool.rst | |||
@@ -0,0 +1,59 @@ | |||
1 | .. SPDX-License-Identifier: CC-BY-SA-2.0-UK | ||
2 | |||
3 | Flashing Images Using ``bmaptool`` | ||
4 | ********************************** | ||
5 | |||
6 | A fast and easy way to flash an image to a bootable device is to use | ||
7 | Bmaptool, which is integrated into the OpenEmbedded build system. | ||
8 | Bmaptool is a generic tool that creates a file's block map (bmap) and | ||
9 | then uses that map to copy the file. As compared to traditional tools | ||
10 | such as dd or cp, Bmaptool can copy (or flash) large files like raw | ||
11 | system image files much faster. | ||
12 | |||
13 | .. note:: | ||
14 | |||
15 | - If you are using Ubuntu or Debian distributions, you can install | ||
16 | the ``bmap-tools`` package using the following command and then | ||
17 | use the tool without specifying ``PATH`` even from the root | ||
18 | account:: | ||
19 | |||
20 | $ sudo apt install bmap-tools | ||
21 | |||
22 | - If you are unable to install the ``bmap-tools`` package, you will | ||
23 | need to build Bmaptool before using it. Use the following command:: | ||
24 | |||
25 | $ bitbake bmap-tools-native | ||
26 | |||
27 | Following, is an example that shows how to flash a Wic image. Realize | ||
28 | that while this example uses a Wic image, you can use Bmaptool to flash | ||
29 | any type of image. Use these steps to flash an image using Bmaptool: | ||
30 | |||
31 | 1. *Update your local.conf File:* You need to have the following set | ||
32 | in your ``local.conf`` file before building your image:: | ||
33 | |||
34 | IMAGE_FSTYPES += "wic wic.bmap" | ||
35 | |||
36 | 2. *Get Your Image:* Either have your image ready (pre-built with the | ||
37 | :term:`IMAGE_FSTYPES` | ||
38 | setting previously mentioned) or take the step to build the image:: | ||
39 | |||
40 | $ bitbake image | ||
41 | |||
42 | 3. *Flash the Device:* Flash the device with the image by using Bmaptool | ||
43 | depending on your particular setup. The following commands assume the | ||
44 | image resides in the :term:`Build Directory`'s ``deploy/images/`` area: | ||
45 | |||
46 | - If you have write access to the media, use this command form:: | ||
47 | |||
48 | $ oe-run-native bmap-tools-native bmaptool copy build-directory/tmp/deploy/images/machine/image.wic /dev/sdX | ||
49 | |||
50 | - If you do not have write access to the media, set your permissions | ||
51 | first and then use the same command form:: | ||
52 | |||
53 | $ sudo chmod 666 /dev/sdX | ||
54 | $ oe-run-native bmap-tools-native bmaptool copy build-directory/tmp/deploy/images/machine/image.wic /dev/sdX | ||
55 | |||
56 | For help on the ``bmaptool`` command, use the following command:: | ||
57 | |||
58 | $ bmaptool --help | ||
59 | |||