doc: update GSG to include scp instructions

Make the GSG more consistent with the sample app doc and show how to use
scp to transfer files between the dev and target machines.

Also add a mention of the sample app guide at the end of the GSG.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
This commit is contained in:
David B. Kinder 2022-08-23 13:50:07 -07:00 committed by David Kinder
parent 68a7854052
commit 2addfe9ca1

View File

@ -244,6 +244,22 @@ To install Ubuntu 20.04:
sudo apt update sudo apt update
sudo apt upgrade -y sudo apt upgrade -y
#. It's convenient to use the network to transfer files between the development
and target system, so we recommend installing the openssh-server package on
the target system::
sudo apt install -y openssh-server
This command will install and start the ssh-server service on the target
system. We'll need to know the target system's IP address to make a
connection from the development system, so find it now with this command::
hostname -I | cut -d ' ' -f 1
#. Make a working directory on the target system that we'll use later::
mkdir -p ~/acrn-work
Configure Target BIOS Settings Configure Target BIOS Settings
=============================== ===============================
@ -262,8 +278,8 @@ Configure Target BIOS Settings
provides additional support for managing I/O virtualization). provides additional support for managing I/O virtualization).
* Disable **Secure Boot**. This setting simplifies the steps for this example. * Disable **Secure Boot**. This setting simplifies the steps for this example.
The names and locations of the BIOS settings differ depending on the target The names and locations of the BIOS settings depend on the target
hardware and BIOS version. hardware and BIOS vendor and version.
Generate a Board Configuration File Generate a Board Configuration File
========================================= =========================================
@ -288,8 +304,16 @@ Generate a Board Configuration File
directory. directory.
#. Copy the Board Inspector Debian package from the development computer to the #. Copy the Board Inspector Debian package from the development computer to the
target system via USB disk as follows: target system.
Option 1: Use ``scp``
Use the ``scp`` command to copy the Debian package from your development
computer to the ``~/acrn-work`` working directory we created on the target
system. Replace ``10.0.0.200`` with the target system's IP address you found earlier::
scp ~/acrn-work/acrn-hypervisor/build/acrn-board-inspector*.deb acrn@10.0.0.200:~/acrn-work
Option 2: Use a USB disk
a. On the development computer, insert the USB disk that you intend to use to a. On the development computer, insert the USB disk that you intend to use to
copy files. copy files.
@ -321,14 +345,14 @@ Generate a Board Configuration File
disk="/media/$USER/"$(ls /media/$USER) disk="/media/$USER/"$(ls /media/$USER)
cp -r "$disk"/acrn-board-inspector*.deb ~/acrn-work cp -r "$disk"/acrn-board-inspector*.deb ~/acrn-work
#. Install the Board Inspector Debian package on the target system: #. Now that we've got the Board Inspector Debian package on the target system, install it there:
.. code-block:: bash .. code-block:: bash
cd ~/acrn-work cd ~/acrn-work
sudo apt install -y ./acrn-board-inspector*.deb sudo apt install -y ./acrn-board-inspector*.deb
#. Reboot the system: #. Reboot the target system:
.. code-block:: bash .. code-block:: bash
@ -356,9 +380,18 @@ Generate a Board Configuration File
ls ./my_board.xml ls ./my_board.xml
#. Copy ``my_board.xml`` from the target to the development computer via USB #. Copy ``my_board.xml`` from the target to the development computer. Again we
disk as follows: have two options:
Option 1: Use ``scp``
From your development computer, use the ``scp`` command to copy the Debian
package from your target system back to the ``~/acrn-work`` directory on
your development computer.
Replace ``10.0.0.200`` with the target system's IP address you found earlier::
scp acrn@10.0.0.200:~/acrn-work/my_board.xml ~/acrn-work/
Option 2: Use a USB disk
a. Make sure the USB disk is connected to the target. a. Make sure the USB disk is connected to the target.
#. Copy ``my_board.xml`` to the USB disk: #. Copy ``my_board.xml`` to the USB disk:
@ -615,8 +648,28 @@ Build ACRN
linux-libc-dev_5.10.115-acrn-service-vm-1_amd64.deb linux-libc-dev_5.10.115-acrn-service-vm-1_amd64.deb
#. Copy all the necessary files generated on the development computer to the #. Copy all the necessary files generated on the development computer to the
target system by USB disk as follows: target system, using one of these two options:
Option 1: Use ``scp``
Use the ``scp`` command to copy files from your development system to
to the target system.
Replace ``10.0.0.200`` with the target system's IP address you found earlier::
scp ~/acrn-work/acrn-hypervisor/build/acrn-my_board-MyConfiguration*.deb \
~/acrn-work/*acrn-service-vm*.deb \
~/acrn-work/MyConfiguration/launch_user_vm_id1.sh \
~/acrn-work/acpica-unix-20210105/generate/unix/bin/iasl
acrn@10.0.0.200:~/acrn-work
Then, go to the target system and put the ``iasl`` tool in its proper
place::
cd ~/acrn-work
sudo cp iasl /usr/sbin/
sudo chmod a+x /usr/sbin/iasl
Option 2: by USB disk
a. Insert the USB disk into the development computer and run these commands: a. Insert the USB disk into the development computer and run these commands:
.. code-block:: bash .. code-block:: bash
@ -648,7 +701,7 @@ Build ACRN
Install ACRN Install ACRN
************ ************
#. Install the ACRN Debian package and ACRN kernel Debian packages using these #. On the target system, install the ACRN Debian package and ACRN kernel Debian packages using these
commands: commands:
.. code-block:: bash .. code-block:: bash
@ -664,7 +717,7 @@ Install ACRN
reboot reboot
#. Confirm that you see the GRUB menu with the "ACRN multiboot2" entry. Select #. Confirm that you see the GRUB menu with the "ACRN multiboot2" entry. Select
it and proceed to booting ACRN. (It may be autoselected, in which case it it and proceed to booting ACRN. (It may be auto-selected, in which case it
will boot with this option automatically in 5 seconds.) will boot with this option automatically in 5 seconds.)
.. code-block:: console .. code-block:: console
@ -811,6 +864,9 @@ Launch the User VM
Next Steps Next Steps
************** **************
:ref:`overview_dev` describes the ACRN configuration process, with links to * :ref:`overview_dev` describes the ACRN configuration process, with links to
additional details. additional details.
* A follow-on :ref:`GSG_sample_app` tutorial shows how to
configure, build, and run a more real-world sample application with a Real-time
VM communicating with an HMI VM via inter-VM shared memory (IVSHMEM).