Skip to content

Commit c1d1b12

Browse files
finikorgjhedberg
authored andcommitted
doc: x86: Add generic efi_boot.rst documentation
Add generic x86 common/efi_boot.rst documentation to be included from boards documentation. Signed-off-by: Andrei Emeltchenko <andrei.emeltchenko@intel.com>
1 parent 3f27651 commit c1d1b12

File tree

1 file changed

+62
-0
lines changed

1 file changed

+62
-0
lines changed

boards/x86/common/efi_boot.rst

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
Preparing the Boot Device
2+
-------------------------
3+
4+
Prepare a USB flash drive to boot the Zephyr application image on
5+
a board.
6+
7+
#. Format the USB flash drive as FAT32.
8+
9+
On Windows, open ``File Explorer``, and right-click on the USB flash drive.
10+
Select ``Format...``. Make sure in ``File System``, ``FAT32`` is selected.
11+
Click on the ``Format`` button and wait for it to finish.
12+
13+
On Linux, graphical utilities such as ``gparted`` can be used to format
14+
the USB flash drive as FAT32. Alternatively, under terminal, find out
15+
the corresponding device node for the USB flash drive (for example,
16+
``/dev/sdd``). Execute the following command:
17+
18+
.. code-block:: console
19+
20+
$ mkfs.vfat -F 32 <device-node>
21+
22+
.. important::
23+
Make sure the device node is the actual device node for
24+
the USB flash drive. Or else you may erase other storage devices
25+
on your system, and will render the system unusable afterwards.
26+
27+
#. Copy the Zephyr EFI image file :file:`zephyr/zephyr.efi` to the USB drive.
28+
29+
Booting Zephyr on a board
30+
-------------------------
31+
32+
Boot the board to the EFI shell with USB flash drive connected.
33+
34+
#. Insert the prepared boot device (USB flash drive) into the board.
35+
36+
#. Connect the board to the host system using the serial cable and
37+
configure your host system to watch for serial data. See board's
38+
website for more information.
39+
40+
.. note::
41+
On Windows, PuTTY has an option to set up configuration for
42+
serial data. Use a baud rate of 115200.
43+
44+
#. Power on the board.
45+
46+
#. When the following output appears, press :kbd:`F7`:
47+
48+
.. code-block:: console
49+
50+
Press <DEL> or <ESC> to enter setup.
51+
52+
#. From the menu that appears, select the menu entry that describes
53+
that particular EFI shell.
54+
55+
#. From the EFI shell select Zephyr EFI image to boot.
56+
57+
.. code-block:: console
58+
59+
Shell> fs0:zephyr.efi
60+
61+
#. When the boot process completes, you have finished booting the
62+
Zephyr application image.

0 commit comments

Comments
 (0)