Difference between revisions of "Nvidia Jetson TX1 and TX2"
(→Simple application) |
|||
(17 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
== Introduction == | == Introduction == | ||
− | The ERIKA3 RTOS can be run as a guest OS of the [https://github.com/siemens/jailhouse Jailhouse hypervisor] on the [http://www.nvidia.com/object/jetson-tx1-dev-kit.html Nvidia Tegra Jetson TX1 | + | The ERIKA3 RTOS can be run as a guest OS of the [https://github.com/siemens/jailhouse Jailhouse hypervisor] on the [http://www.nvidia.com/object/jetson-tx1-dev-kit.html Nvidia Tegra Jetson] TX1 and TX2 boards.<br> |
Such support has been developed in the context of the [http://hercules2020.eu HERCULES European project]. | Such support has been developed in the context of the [http://hercules2020.eu HERCULES European project]. | ||
It has been also shown through a [https://www.youtube.com/watch?v=skIcAkXfNWQ&t=3s YouTube video]. | It has been also shown through a [https://www.youtube.com/watch?v=skIcAkXfNWQ&t=3s YouTube video]. | ||
− | This section explains how to build and install Jailhouse on the | + | This section explains how to build and install Jailhouse on the Jetson target and how to create an ERIKA3 guest (AKA Jailhouse inmate) running a simple application. |
The Eclipse-based RT-Druid tool (for generating the RTOS configuration) requires an x86 platform with a fair amount of resources (in terms of both processing and memory). This requirement, therefore, implies a cross-compilation of ERIKA3. | The Eclipse-based RT-Druid tool (for generating the RTOS configuration) requires an x86 platform with a fair amount of resources (in terms of both processing and memory). This requirement, therefore, implies a cross-compilation of ERIKA3. | ||
Additionally, since the build process of ERIKA3 needs a compiled copy of Jailhouse which, in turn, needs a compiled copy of the Linux kernel, we suggest proceeding by '''cross-compiling all software components (i.e., Linux kernel, Jailhouse and ERIKA3 RTOS) on a host x86 machine'''. | Additionally, since the build process of ERIKA3 needs a compiled copy of Jailhouse which, in turn, needs a compiled copy of the Linux kernel, we suggest proceeding by '''cross-compiling all software components (i.e., Linux kernel, Jailhouse and ERIKA3 RTOS) on a host x86 machine'''. | ||
− | == | + | == Jetson platform setup == |
− | Use [https://developer.nvidia.com/embedded/jetpack Nvidia Jetpack] to flash the Linux distribution by Nvidia onto the | + | Use [https://developer.nvidia.com/embedded/jetpack Nvidia Jetpack] to flash the Linux distribution by Nvidia onto the Jetson platform. |
− | JetPack is a tool that runs on an Ubuntu host machine and installs Linux on the | + | JetPack is a tool that runs on an Ubuntu host machine and installs Linux on the Jetson platform. |
Note that the host machine and the platform must be connected through an OTG USB cable during flashing. | Note that the host machine and the platform must be connected through an OTG USB cable during flashing. | ||
Line 33: | Line 33: | ||
== RT-Druid set-up == | == RT-Druid set-up == | ||
− | Once Jailhouse has been successfully built, transferred and installed onto the | + | Once Jailhouse has been successfully built, transferred and installed onto the Jetson platform, you have to set-up the RT-Druid development environment to compile the ERIKA3 RTOS.<br> |
Follow the next instructions for installing RT-Druid on the host platform used for cross-compiling: | Follow the next instructions for installing RT-Druid on the host platform used for cross-compiling: | ||
Line 50: | Line 50: | ||
Then, select Generator properties, enable project specific settings (as shown in the next figure), and set the desired values. | Then, select Generator properties, enable project specific settings (as shown in the next figure), and set the desired values. | ||
[[File:Generator_properties.jpg|thumb|center|Figure 2: Generator properties.]] | [[File:Generator_properties.jpg|thumb|center|Figure 2: Generator properties.]] | ||
− | <li> | + | <li> Finally, using the same shell where the environment variables have been set, enter the directory containing the extracted archive and run <pre>./eclipse</pre> |
</ol> | </ol> | ||
Line 66: | Line 66: | ||
<li> Eclipse will then show the new project, and RT-Druid will generate the configuration files, as shown in the next Figure: | <li> Eclipse will then show the new project, and RT-Druid will generate the configuration files, as shown in the next Figure: | ||
[[File:Eclipse_new_project4.jpg|thumb|center|Figure 6: New Helloworld project created.]] | [[File:Eclipse_new_project4.jpg|thumb|center|Figure 6: New Helloworld project created.]] | ||
− | <li> | + | <li> In the the <code>conf.oil</code> file, set: |
+ | <ul> | ||
+ | <li> <code>SOC_DATA=NVIDIA_TEGRA_X1</code> for TX1 | ||
+ | <li> <code>SOC_DATA=NVIDIA_TEGRA_X2</code> for TX2 | ||
+ | </ul> | ||
<li> Click with the right mouse key on the project and select <code>Build project</code> as shown in the next Figure: | <li> Click with the right mouse key on the project and select <code>Build project</code> as shown in the next Figure: | ||
[[File:Eclipse_new_project5.jpg|thumb|center|Figure 7: Building the Helloworld project.]] | [[File:Eclipse_new_project5.jpg|thumb|center|Figure 7: Building the Helloworld project.]] | ||
− | <li> Open a shell, enter the workspace and transfer the <code>erika_inmate.bin</code> binary to the | + | <li> Open a shell, enter the workspace and transfer the <code>erika_inmate.bin</code> binary to the Jetson platform (e.g. using <code>scp</code>) |
− | <li> Then, on the | + | <li> Then, on the Jetson platform: |
<ol> | <ol> | ||
− | <li> Install the Jailhouse driver: | + | <li> Install the Jailhouse driver: <code>sudo modprobe jailhouse</code> |
− | < | ||
− | sudo modprobe jailhouse | ||
− | </ | ||
<li> Enable Jailhouse: | <li> Enable Jailhouse: | ||
− | < | + | <ul> |
− | sudo jailhouse enable jetson-tx1.cell | + | <li> For TX1: <code>sudo jailhouse enable jetson-tx1.cell</code> |
− | </ | + | <li> For TX2: <code>sudo jailhouse enable jetson-tx2.cell</code> |
+ | </ul> | ||
<li> Create the cell for ERIKA3: | <li> Create the cell for ERIKA3: | ||
− | < | + | <ul> |
− | sudo jailhouse cell create jetson-tx1-demo.cell | + | <li> For TX1: <code>sudo jailhouse cell create jetson-tx1-demo.cell</code> |
− | </ | + | <li> For TX2: <code>sudo jailhouse cell create jetson-tx2-demo.cell</code> |
+ | </ul> | ||
<li> Load the ERIKA3 application: | <li> Load the ERIKA3 application: | ||
− | < | + | <ul> |
− | sudo jailhouse cell load jetson-tx1-demo | + | <li> For TX1: <code>sudo jailhouse cell load jetson-tx1-demo erika_inmate.bin</code> |
− | </ | + | <li> For TX2: <code>sudo jailhouse cell load jetson-tx2-demo erika_inmate.bin</code> |
+ | </ul> | ||
<li> Start the ERIKA3 application: | <li> Start the ERIKA3 application: | ||
− | < | + | <ul> |
− | sudo jailhouse cell start jetson-tx1-demo | + | <li> For TX1: <code>sudo jailhouse cell start jetson-tx1-demo</code> |
− | </ | + | <li> For TX2: <code>sudo jailhouse cell start jetson-tx2-demo</code> |
+ | </ul> | ||
</ol> | </ol> | ||
− | <li> Then, on the | + | <li> Then, on the Jetson platform, you will see the two tasks printing alternatively on the serial interface, as shown in the next figure: |
[[File:Helloworld_output.jpg|thumb|center|Figure 8: Output of the helloworld example.]] | [[File:Helloworld_output.jpg|thumb|center|Figure 8: Output of the helloworld example.]] | ||
</ol> | </ol> | ||
+ | |||
+ | == Libc support == | ||
+ | |||
+ | If the application on ERIKA needs to use services provided by the libc library (e.g. <code>memcpy()</code>) | ||
+ | please refer to [https://github.com/evidence/linux-jailhouse-jetson/blob/master/README.md#toolchain-selection the "Toolchain selection" section on the GitHub tree] | ||
+ | for building the Jailhouse inmate library (and also ERIKA) using a bare-metal toolchain. | ||
+ | |||
+ | Additionally, to link the ERIKA application agains the libc library, you will need to set the following variables in the OIL file: | ||
+ | <ul> | ||
+ | <li><code>LIBS = "-lc";</code> | ||
+ | <li><code>LDFLAGS = "-L /path/containing/libc/";</code> | ||
+ | <li><code>CFLAGS = "-mstrict-align";</code> for accessing fields in data structures. | ||
+ | </ul> | ||
+ | |||
+ | == Virtual machine == | ||
+ | |||
+ | A VirtualBox virtual machine containing the development environment (i.e. toolchain, ERIKA RTOS and RT-Druid) already installed for the TX1 and TX2 boards is available on the [http://www.erika-enterprise.com/index.php/download/virtual-machines.html ERIKA website]. | ||
[[Category:Boards]] | [[Category:Boards]] | ||
+ | [[Category:Tutorial]] |
Latest revision as of 14:22, 25 June 2018
Contents
Introduction
The ERIKA3 RTOS can be run as a guest OS of the Jailhouse hypervisor on the Nvidia Tegra Jetson TX1 and TX2 boards.
Such support has been developed in the context of the HERCULES European project.
It has been also shown through a YouTube video.
This section explains how to build and install Jailhouse on the Jetson target and how to create an ERIKA3 guest (AKA Jailhouse inmate) running a simple application.
The Eclipse-based RT-Druid tool (for generating the RTOS configuration) requires an x86 platform with a fair amount of resources (in terms of both processing and memory). This requirement, therefore, implies a cross-compilation of ERIKA3. Additionally, since the build process of ERIKA3 needs a compiled copy of Jailhouse which, in turn, needs a compiled copy of the Linux kernel, we suggest proceeding by cross-compiling all software components (i.e., Linux kernel, Jailhouse and ERIKA3 RTOS) on a host x86 machine.
Jetson platform setup
Use Nvidia Jetpack to flash the Linux distribution by Nvidia onto the Jetson platform. JetPack is a tool that runs on an Ubuntu host machine and installs Linux on the Jetson platform. Note that the host machine and the platform must be connected through an OTG USB cable during flashing.
Once the Linux distribution has been correctly flashed on the device, it is important to configure Linux to reserve the memory to the hypervisor, and to not use the serial interface (that will be used by the ERIKA3 guest). The instructions for this set-up can be found on the README file of our Jailhouse tree on GitHub. The README also explains how to set a static IP address (strongly encouraged).
x86 host platform setup
A cross-compiler for aarch64 is needed. On Ubuntu (tested on version 16.04), this can be installed by typing
sudo apt install gcc-aarch64-linux-gnu
Jailhouse cross-compiling
The README available on the Jailhouse tree on our GitHub explains how to cross-compile and install Jailhouse. Note that the information is provided for the default Linux kernel by Nvidia (not Vanilla). You can refer to the original Jailhouse page in case you run a Vanilla Linux kernel.
RT-Druid set-up
Once Jailhouse has been successfully built, transferred and installed onto the Jetson platform, you have to set-up the RT-Druid development environment to compile the ERIKA3 RTOS.
Follow the next instructions for installing RT-Druid on the host platform used for cross-compiling:
- Download the RT-Druid package from the download section of the ERIKA3 website
- Extract the downloaded archive
- Open a shell and type
export JAILHOUSE_VERSION=0.8 export JAILHOUSE_DIR=/path/to/compiled/jailhouse export JAILHOUSE_AARCH64_GCCPREFIX=aarch64-linux-gnu-
Note that RT-Druid allows to set these variables also from within Eclipse. Just press the right mouse button on the Eclipse project and select Properties as shown in the following figure.
Then, select Generator properties, enable project specific settings (as shown in the next figure), and set the desired values.
- Finally, using the same shell where the environment variables have been set, enter the directory containing the extracted archive and run
./eclipse
Simple application
We now show a simple "helloworld" application consisting of two tasks printing on the serial interface.
- Run the RT-Druid tool as explained above
- Create a new project by clicking on
New
→RT-Druid v3 Oil and C/C++ Project
as shown in the next Figure: - Name the new project (e.g.,
mytest
) and select the Cross-GCC as shown in the next Figure: - Check the box for using an existing template and select
aarch64
→Jailhouse
→Helloworld OSEK demo on Jailhouse
as shown in the next Figure: - Eclipse will then show the new project, and RT-Druid will generate the configuration files, as shown in the next Figure:
- In the the
conf.oil
file, set:-
SOC_DATA=NVIDIA_TEGRA_X1
for TX1 -
SOC_DATA=NVIDIA_TEGRA_X2
for TX2
-
- Click with the right mouse key on the project and select
Build project
as shown in the next Figure: - Open a shell, enter the workspace and transfer the
erika_inmate.bin
binary to the Jetson platform (e.g. usingscp
) - Then, on the Jetson platform:
- Install the Jailhouse driver:
sudo modprobe jailhouse
- Enable Jailhouse:
- For TX1:
sudo jailhouse enable jetson-tx1.cell
- For TX2:
sudo jailhouse enable jetson-tx2.cell
- For TX1:
- Create the cell for ERIKA3:
- For TX1:
sudo jailhouse cell create jetson-tx1-demo.cell
- For TX2:
sudo jailhouse cell create jetson-tx2-demo.cell
- For TX1:
- Load the ERIKA3 application:
- For TX1:
sudo jailhouse cell load jetson-tx1-demo erika_inmate.bin
- For TX2:
sudo jailhouse cell load jetson-tx2-demo erika_inmate.bin
- For TX1:
- Start the ERIKA3 application:
- For TX1:
sudo jailhouse cell start jetson-tx1-demo
- For TX2:
sudo jailhouse cell start jetson-tx2-demo
- For TX1:
- Install the Jailhouse driver:
- Then, on the Jetson platform, you will see the two tasks printing alternatively on the serial interface, as shown in the next figure:
Libc support
If the application on ERIKA needs to use services provided by the libc library (e.g. memcpy()
)
please refer to the "Toolchain selection" section on the GitHub tree
for building the Jailhouse inmate library (and also ERIKA) using a bare-metal toolchain.
Additionally, to link the ERIKA application agains the libc library, you will need to set the following variables in the OIL file:
LIBS = "-lc";
LDFLAGS = "-L /path/containing/libc/";
CFLAGS = "-mstrict-align";
for accessing fields in data structures.
Virtual machine
A VirtualBox virtual machine containing the development environment (i.e. toolchain, ERIKA RTOS and RT-Druid) already installed for the TX1 and TX2 boards is available on the ERIKA website.