README.md 4.06 KB
Newer Older
1
# smarter-distro
2

3
4
Reference/demo distribution for SMARTER platforms
Based on meta-tegra [tegra-demo-distro](https://github.com/OE4T/tegra-demo-distro)
5

6
For more information on SMARTER look [here](https://getsmarter.io)
7

Matt Madison's avatar
Matt Madison committed
8
9
10
11
12
13
14
15
16
17
18
19
20
21
## Prerequisites

See the [Yocto Project Quick Build](https://www.yoctoproject.org/docs/3.1.2/brief-yoctoprojectqs/brief-yoctoprojectqs.html)
documentation for information on setting up your build host.
In addition to the packages mentioned in that documentation, you
will need gcc and g++ 8 (on Ubuntu, packages `gcc-8` and `g++-8`).

For burning SDcards (for the Jetson Nano or Jetson Xavier NX developer
kits), the `bmap-tools` package is recommended.

## Setting up

1. Clone this repository:

22
        $ git clone -b dunfell-l4t-r32.4.3 https://gitlab.com/arm-research/smarter/smarter-distro.git
Dan Walkes's avatar
Dan Walkes committed
23

24
2. Initialize the git submodules:
Matt Madison's avatar
Matt Madison committed
25

26
        $ cd smarter-distro
Matt Madison's avatar
Matt Madison committed
27
28
		$ git submodule update --init

29
3. Source the `setup-env` script to create a build directory,
Matt Madison's avatar
Matt Madison committed
30
31
32
33
34
35
36
37
38
39
40
41
   specifying the MACHINE you want to configure as the default
   for your builds. For example, to set up a build directory
   called `build` that is set up for the Jetson Xavier NX
   developer kit and the default `tegrademo` distro:

        $ . ./setup-env --machine jetson-xavier-nx-devkit

   You can get a complete list of available options, MACHINE
   names, and DISTRO names with

        $ . ./setup-env --help

42
4. Optional: Install pre-commit hook for commit autosigning using
43
        $ ./scripts-setup/setup-git-hooks
44

Dan Walkes's avatar
Dan Walkes committed
45
46
47
48
49
50
51
52
53
54
55
56
57
58
## Distributions

Use the `--distro` option with `setup-env` to specify a distribution for your build,
or customize the DISTRO setting in your `$BUILDDIR/conf/local.conf` to reference one
of the supported distributions.

Currently supported distributions are listed below:


| Distribution name | Description                                                   |
| ----------------- | ------------------------------------------------------------- |
| tegrademo         | Default distro used to demonstrate/test meta-tegra features   |
| tegrademo-mender  | Adds [mender](https://www.mender.io/) OTA support             |

59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
### tegrademo-mender

The tegrademo-mender distro demonstrates [mender](https://www.mender.io/) OTA update
support with customizations on the tegrademo distribution including:

1. Dual A/B rootfs support with read-only-rootfs.
2. Integration with cboot and [tegra-boot-tools](https://github.com/OE4T/tegra-boot-tools)
 to support persistent systemd machine-id settings on read only rootfs.
3. Boot slot and rootfs partition synchronization through boot tools and bootloader
integration.

The synchronization of boot slot and root filesystem partition is more complicated to
manage and test with via u-boot (see [this issue](https://github.com/BoulderAI/meta-mender-community/pull/1#issue-516955713)
for detail).  For this reason, the tegrademo-mender distribution defaults to use the
cboot bootloader on Jetson TX2, instead of the default u-boot bootloader used by
meta-tegra.  If you need to use a different bootloader you can customize the setting
of `PREFERRED_PROVIDER_virtual/bootloader_tegra186` in your distro layer.
Dan Walkes's avatar
Dan Walkes committed
76

Matt Madison's avatar
Matt Madison committed
77
78
79
80
81
82
83
84
85
86
87
88
89
90
## Images

The `tegrademo` distro includes the following image recipes, which
are dervied from the `core-image-XXX` recipes in OE-Core but configured
for Jetson platforms. They include some additional test tools and
demo applications.

| Recipe name       | Description                                                   |
| ----------------- | ------------------------------------------------------------- |
| demo-image-base   | Basic image with no graphics                                  |
| demo-image-egl    | Base with DRM/EGL graphics, no window manager                 |
| demo-image-sato   | X11 image with Sato UI                                        |
| demo-image-weston | Wayland with Weston compositor                                |
| demo-image-full   | Sato image plus nvidia-docker, openCV, multimedia API samples |
91
92
93
94
95
96

# Contributing

Please see the contributor wiki page at [this link](https://github.com/OE4T/meta-tegra/wiki/OE4T-Contributor-Guide).
Contributions are welcome!