1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
|
---
title: Initializing Your Build Environment
---
Part of the downloaded AGL software is a setup script that you must
run to initialize the build environment.
## `aglsetup.sh` Script
You can find this script here:
```sh
$AGL_TOP/lamprey/meta-agl/scripts/aglsetup.sh
```
The script accepts many options that allow you to define build parameters such
as the target hardware (i.e. the machine), build directory, and so forth.
Use the following commands to see the available options and script syntax:
```sh
$ cd $AGL_TOP/lamprey
$ source meta-agl/scripts/aglsetup.sh -h
```
## AGL Machines (board support)
Your target platform will be selected with the `-m` flag.
The MACHINE can be selected from the templates in `meta-agl/templates/machine/*`.
Note: This is also the place where you can add new boards.
Following is a list of the available machines (level of support varies!):
```sh
Available machines:
[meta-agl]
bbe
beaglebone
cubox-i
dragonboard-410c
dragonboard-820c
ebisu
h3-salvator-x
h3ulcb
h3ulcb-kf
h3ulcb-nogfx
hsdk
imx6qdlsabreauto
imx8mqevk
imx8mqevk-viv
intel-corei7-64
j7-evm
m3-salvator-x
m3ulcb
m3ulcb-kf
m3ulcb-nogfx
nitrogen6x
qemuarm
qemuarm64
qemuriscv64
* qemux86-64
raspberrypi4
virtio-aarch64
```
## AGL Features
Before running the `aglsetup.sh`, you should understand what AGL features you
want to include as part of your image.
The script's help output lists available features and shows you the layers in
which they reside.
Following is a list of the available features:
```sh
Available features:
[meta-agl]
agl-all-features :( agl-demo agl-appfw-smack agl-hmi-framework agl-pipewire agl-netboot )
agl-appfw-smack
agl-archiver
agl-buildstats
agl-ci
agl-ci-change-features :( agl-demo agl-appfw-smack agl-hmi-framework agl-pipewire agl-devel agl-package-management agl-netboot agl-pipewire agl-cloudproxy agl-buildstats agl-ptest )
agl-ci-change-features-nogfx :( agl-demo agl-appfw-smack agl-hmi-framework agl-pipewire agl-devel agl-package-management agl-netboot agl-pipewire agl-cloudproxy agl-buildstats agl-ptest )
agl-ci-snapshot-features :( agl-demo agl-appfw-smack agl-hmi-framework agl-pipewire agl-devel agl-package-management agl-netboot agl-archiver agl-pipewire agl-buildstats agl-ptest )
agl-ci-snapshot-features-nogfx :( agl-demo agl-appfw-smack agl-hmi-framework agl-pipewire agl-devel agl-package-management agl-netboot agl-archiver agl-pipewire agl-buildstats agl-ptest )
agl-devel :( agl-package-management )
agl-fossdriver
agl-gplv2
agl-hmi-framework
agl-localdev
agl-netboot
agl-package-management
agl-pipewire
agl-ptest
agl-refhw-h3
agl-sign-wgts
agl-sota
agl-virt
agl-virt-guest-xen
agl-virt-xen :( agl-virt )
agl-weston-remoting :( agl-demo agl-appfw-smack agl-hmi-framework agl-pipewire )
agl-weston-waltham-remoting :( agl-demo agl-appfw-smack agl-hmi-framework agl-pipewire )
[meta-agl-demo]
agl-cloudproxy
agl-cluster-demo-support :( agl-weston-remoting agl-demo agl-appfw-smack agl-hmi-framework agl-pipewire )
agl-demo :( agl-appfw-smack agl-hmi-framework agl-pipewire )
agl-demo-preload
[meta-agl-devel]
agl-basesystem
agl-drm-lease
agl-jailhouse
agl-lxc :( agl-virt agl-drm-lease )
agl-voiceagent-alexa
agl-voiceagent-alexa-wakeword :( agl-voiceagent-alexa )
```
To find out exactly what a feature provides, check out the respective layer and its README.
An AGL feature is a configuration that accounts for specific settings
and dependencies needed for a particular build.
For example, specifying the "agl-demo" feature makes sure that the
`aglsetup.sh` script creates configuration files needed to build the
image for the AGL demo.
Following are brief descriptions of the AGL features you can specify on the
`aglsetup.sh` command line:
* **agl-all-features**: A set of AGL default features.
Do not think of this set of features as all the AGL features.
* **agl-appfw-smack**: Enables IoT.bzh Application Framework plus SMACK and
Cynara.
* **agl-archiver**: Enables the archiver class for releases.
* **agl-ci**: Flags used for Continuous Integration (CI).
Using this feature changes the value of the
[`IMAGE_FSTYPES`](https://yoctoproject.org/docs/3.1.4/ref-manual/ref-manual.html#var-IMAGE_FSTYPES)
variable.
* **agl-ci-change-features**: Enables features for CI builds for Gerrit changes.
* **agl-ci-change-features-nogfx**: Enables features for CI builds for Gerrit changes
for targets that use binary graphics drivers (i.e. builds without graphics).
* **agl-ci-snapshot-features**: Enables features for CI daily snapshot builds.
* **agl-ci-snapshot-features-nogfx**: Enables features for CI daily snapshot builds for
targets that use binary graphics drivers (i.e. builds without graphics).
* **agl-devel**: Activates development options such as an empty root password,
debuggers, strace, valgrind, and so forth.
* **agl-netboot**: Enables network boot support through Trivial File Transfer Protocol (TFTP) and Network Block Device (NBD) protocol.
Netboot is needed for CI and useful for development to avoid writing
sdcards. Needs additional setup.
<!--
* **agl-profile**: A group or set of Layers and a Package Group as used
by the Yocto Project.
This feature helps define dependency for various profiles and layers
used during the build.
For example, "agl-demo" depends on "agl-profile-graphical-qt", which
in turn depends on "agl-profile-graphical", which in turn depends
on "agl-profile-core".
agl-profile-graphical
agl-profile-graphical-html5
agl-profile-graphical-qt5
agl-profile-hud
agl-profile-telematics
**NOTE:** For information on Package Groups, see the
"[Customizing Images Using Custom Package Groups](https://www.yoctoproject.org/docs/3.1.4/dev-manual/dev-manual.html#usingpoky-extend-customimage-customtasks)"
section in the Yocto Project Development Tasks Manual.
You can also find general information about Layers in the
"[Layers](https://www.yoctoproject.org/docs/3.1.4/dev-manual/dev-manual.html#yocto-project-layers)"
section in that same manual.
-->
* **agl-ptest**: Enables
[Ptest](https://yoctoproject.org/docs/3.1.4/dev-manual/dev-manual.html#testing-packages-with-ptest)
as part of the build.
* **agl-demo**: Enables the layers meta-agl-demo and meta-qt5.
You need agl-demo if you are going to build the agl-demo-platform.
* **agl-pipewire**: Enables AGLs pipewire support.
* **agl-localdev**: Adds a local layer named "meta-localdev" in the
meta directory and a local.dev.inc configuration file when that file
is present.
This feature provides a shortcut for using the layer meta-localdev
in the top-level folder for easy modifications to your own recipes.
## Example
Following is an example that initializes the build environment, selects "beaglebone"
for the machine, and chooses the "agl-demo" feature, which also includes the
"agl-appfw-smack", "agl-devel", and "agl-hmi-framework" features:
```sh
$ source meta-agl/scripts/aglsetup.sh -m qemux86-64 -b qemux86-64 agl-demo agl-devel
aglsetup.sh: Starting
Generating configuration files:
Build dir: /home/scottrif/workspace_agl/build
Machine: qemux86-64
Features: agl-appfw-smack agl-demo agl-devel
Running /home/scottrif/workspace_agl/poky/oe-init-build-env
Templates dir: /home/scottrif/workspace_agl/meta-agl/templates/base
Config: /home/scottrif/workspace_agl/build/conf/bblayers.conf
Config: /home/scottrif/workspace_agl/build/conf/local.conf
Setup script: /home/scottrif/workspace_agl/build/conf/setup.sh
Executing setup script ... --- beginning of setup script
fragment /home/scottrif/workspace_agl/meta-agl/templates/base/01_setup_EULAfunc.sh
fragment /home/scottrif/workspace_agl/meta-agl/templates/base/99_setup_EULAconf.sh
end of setup script
OK
Generating setup file: /home/scottrif/workspace_agl/build/agl-init-build-env ... OK
aglsetup.sh: Done
Shell environment set up for builds.
You can now run 'bitbake target'
Common targets are:
- meta-agl: (core system)
agl-image-minimal
agl-image-minimal-qa
agl-image-ivi
agl-image-ivi-qa
agl-image-ivi-crosssdk
agl-image-weston
- meta-agl-demo: (demo with UI)
agl-demo-platform (* default demo target)
agl-demo-platform-qa
agl-demo-platform-crosssdk
agl-demo-platform-html5
```
Running the script creates the Build Directory if it does not already exist.
The default Build Directory is `$AGL_TOP/<release-branch-name>/build`, and the nomenclature to be used throughout this doc is going to be `$AGL_TOP/<release-branch-name>/<build-dir>`
For this example, the Build Directory is `$AGL_TOP/lamprey/qemux86-64`.
The script's output also indicates the machine and AGL features selected for the build.
The script creates two primary configuration files used for the build: `local.conf` and `bblayers.conf`.
Both these configuration files are located in the Build Directory in the `conf` folder.
If you were to examine these files, you would find standard Yocto Project
configurations along with AGL configuration fragments, which are driven by the
machine (i.e. beaglebone) and the AGL features specified as part of the
script's command line.
The end result is configuration files specific for your build in the AGL development environment.
Finally, part of the `aglsetup.sh` script makes sure that any End User License Agreements (EULA)
are considered.
You can see that processing in the script's output as well.
**NOTE:** Use of the `local.conf` and `bblayers.conf` configuration files is fundamental
in the Yocto Project build environment.
Consequently, it is fundamental in the AGL build environment.
You can find lots of information on configuring builds in the Yocto Project
documentation set.
Here are some references if you want to dig into configuration further:
* [Customizing Images Using local.conf](https://yoctoproject.org/docs/3.1.4/dev-manual/dev-manual.html#usingpoky-extend-customimage-localconf)
* [Local](https://yoctoproject.org/docs/3.1.4/ref-manual/ref-manual.html#ref-varlocality-config-local)
* [build/conf/local.conf](https://yoctoproject.org/docs/3.1.4/ref-manual/ref-manual.html#structure-build-conf-local.conf)
* [build/conf/bblayers.conf](https://yoctoproject.org/docs/3.1.4/ref-manual/ref-manual.html#structure-build-conf-bblayers.conf)
* [BBLAYERS](https://yoctoproject.org/docs/3.1.4/ref-manual/ref-manual.html#var-BBLAYERS)
* [User Configuration](https://yoctoproject.org/docs/3.1.4/ref-manual/ref-manual.html#user-configuration)
* [Enabling Your Layer](https://yoctoproject.org/docs/3.1.4/dev-manual/dev-manual.html#enabling-your-layer)
|
