summaryrefslogtreecommitdiffstats
path: root/doc/book-enea-linux-user-guide/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc/book-enea-linux-user-guide/doc')
-rw-r--r--doc/book-enea-linux-user-guide/doc/application_development.xml4
-rw-r--r--doc/book-enea-linux-user-guide/doc/eltf_params_updated.xml261
-rw-r--r--doc/book-enea-linux-user-guide/doc/getting_enea_linux.xml19
-rw-r--r--doc/book-enea-linux-user-guide/doc/preface.xml15
-rw-r--r--doc/book-enea-linux-user-guide/doc/prerequisites_and_requirements.xml4
-rw-r--r--doc/book-enea-linux-user-guide/doc/using_eclipse.xml24
-rw-r--r--doc/book-enea-linux-user-guide/doc/using_enea_linux.xml269
7 files changed, 392 insertions, 204 deletions
diff --git a/doc/book-enea-linux-user-guide/doc/application_development.xml b/doc/book-enea-linux-user-guide/doc/application_development.xml
index 3458d39..0e2edf4 100644
--- a/doc/book-enea-linux-user-guide/doc/application_development.xml
+++ b/doc/book-enea-linux-user-guide/doc/application_development.xml
@@ -146,7 +146,7 @@ MODULE_LICENSE("GPL");</programlisting>
146 environment. For this, see <xref linkend="install_el_sdk" />.</para> 146 environment. For this, see <xref linkend="install_el_sdk" />.</para>
147 147
148 <para>The following section, <ulink 148 <para>The following section, <ulink
149 url="http://www.yoctoproject.org/docs/2.3/sdk-manual/sdk-manual.html#sdk-use-devtool-to-add-an-application">Use 149 url="http://www.yoctoproject.org/docs/2.5/sdk-manual/sdk-manual.html#sdk-use-devtool-to-add-an-application">Use
150 devtool add to Add an Application</ulink>, in Yocto Project Software 150 devtool add to Add an Application</ulink>, in Yocto Project Software
151 Development Kit (SDK) Developer's Guide, explains how to use devtool to 151 Development Kit (SDK) Developer's Guide, explains how to use devtool to
152 generate recipes from existing application code, edit and build recipes, 152 generate recipes from existing application code, edit and build recipes,
@@ -279,4 +279,4 @@ NOTE: Your packages are in &lt;SDK_dir&gt;/tmp/deploy/deb</programlisting>
279 </listitem> 279 </listitem>
280 </orderedlist> 280 </orderedlist>
281 </section> 281 </section>
282</chapter> \ No newline at end of file 282</chapter>
diff --git a/doc/book-enea-linux-user-guide/doc/eltf_params_updated.xml b/doc/book-enea-linux-user-guide/doc/eltf_params_updated.xml
index 0543f86..0efa6af 100644
--- a/doc/book-enea-linux-user-guide/doc/eltf_params_updated.xml
+++ b/doc/book-enea-linux-user-guide/doc/eltf_params_updated.xml
@@ -42,17 +42,17 @@ export PATH=~/bin:$PATH</programlisting></para>
42 correct also compared to the "previous" REL VER in pardoc-distro.xml 42 correct also compared to the "previous" REL VER in pardoc-distro.xml
43 "prev_baseline".</bridgehead> 43 "prev_baseline".</bridgehead>
44 44
45 <para id="EneaLinux_REL_VER"><phrase>7</phrase></para> 45 <para id="EneaLinux_REL_VER"><phrase>8</phrase></para>
46 46
47 <para id="Yocto_VER"><phrase>2.3</phrase></para> 47 <para id="Yocto_VER"><phrase>2.5</phrase></para>
48 48
49 <para id="Yocto_NAME"><phrase>pyro</phrase></para> 49 <para id="Yocto_NAME"><phrase>sumo</phrase></para>
50 50
51 <para id="ULINK_YOCTO_PROJECT_DOWNLOAD"><ulink 51 <para id="ULINK_YOCTO_PROJECT_DOWNLOAD"><ulink
52 url="http://www.yoctoproject.org/downloads/core/pyro23">http://www.yoctoproject.org/downloads/core/pyro23</ulink></para> 52 url="http://www.yoctoproject.org/downloads/core/pyro23">http://www.yoctoproject.org/downloads</ulink></para>
53 53
54 <para id="ULINK_ENEA_LINUX_URL"><ulink 54 <para id="ULINK_ENEA_LINUX_URL"><ulink
55 url="http://linux.enea.com/EneaLinux7.0">http://linux.enea.com/EneaLinux7.0</ulink></para> 55 url="http://linux.enea.com/EneaLinux8.0">http://linux.enea.com/EneaLinux8.0</ulink></para>
56 56
57 <bridgehead>A programlisting, ID "eltf-repo-cloning-enea-linux". Use 57 <bridgehead>A programlisting, ID "eltf-repo-cloning-enea-linux". Use
58 $MACHINE/default.xml as parameter, where MACHINE is one of the target 58 $MACHINE/default.xml as parameter, where MACHINE is one of the target
@@ -61,7 +61,7 @@ export PATH=~/bin:$PATH</programlisting></para>
61 <para id="eltf-repo-cloning-enea-linux"><programlisting>mkdir enea-linux 61 <para id="eltf-repo-cloning-enea-linux"><programlisting>mkdir enea-linux
62cd enea-linux 62cd enea-linux
63repo init -u git@git.enea.com:linux/manifests/el_manifests-standard.git \ 63repo init -u git@git.enea.com:linux/manifests/el_manifests-standard.git \
64 -b refs/tags/Enea_Linux_7.0_RC4 -m $MACHINE/default.xml 64 -b refs/tags/Enea_Linux_8.0 -m intel-corei7-64/default.xml
65repo sync</programlisting></para> 65repo sync</programlisting></para>
66 66
67 <bridgehead>A table with ONE row, only the row with ID 67 <bridgehead>A table with ONE row, only the row with ID
@@ -87,78 +87,227 @@ repo sync</programlisting></para>
87 target parameters in each target subsection table.</bridgehead> 87 target parameters in each target subsection table.</bridgehead>
88 </section> 88 </section>
89 89
90 <section id="eltf-target-tables-section"> 90 <section id="eltf-machine-tables-section">
91 <title>Supported Targets with Parameters</title> 91 <title>Supported Targets with Parameters</title>
92 92
93 <para>The section(s) below describe the target(s) supported in this Enea 93 <para>The section(s) below describe the target(s) supported in this Enea
94 Linux release.</para> 94 Linux release.</para>
95 95
96 <section id="eltf-target-table-rpi"> 96 <section id="eltf-target-tables-section">
97 <title>MACHINE raspberry pi 3 - Information</title> 97 <title>MACHINE Information</title>
98 98
99 <para><informaltable> 99 <para>The table(s) below describes the target(s) supported in this Enea
100 <tgroup cols="2"> 100 Linux release.</para>
101 <colspec colwidth="6*" />
102 101
103 <colspec colwidth="9*" /> 102 <table>
103 <title>MACHINE Information Intel Xeon D</title>
104 104
105 <tbody> 105 <tgroup cols="2">
106 <row> 106 <colspec align="center" />
107 <entry>Target official name</entry>
108 107
109 <entry>Raspberry Pi 3</entry> 108 <thead>
110 </row> 109 <row>
110 <entry align="center">Component</entry>
111 111
112 <row> 112 <entry align="center">Description</entry>
113 <entry>Architecture and Description</entry> 113 </row>
114 </thead>
114 115
115 <entry>ARM Cortex-A53 (ARMv8)</entry> 116 <tbody>
116 </row> 117 <row>
118 <entry align="left">Target official name</entry>
117 119
118 <row> 120 <entry>Intel Xeon D</entry>
119 <entry>Link to target datasheet</entry> 121 </row>
120 122
121 <entry>See <ulink 123 <row>
122 url="https://www.raspberrypi.org/documentation/hardware/raspberrypi/bcm2837/README.md">link 124 <entry align="left">Architecture and Description</entry>
123 to Raspberry Pi's datasheet</ulink></entry>
124 </row>
125 125
126 <row> 126 <entry>x86-64</entry>
127 <entry>Poky version</entry> 127 </row>
128 128
129 <entry>Git-commit-id: 129 <row>
130 2021e95bcd986e5bcfe457da5c3e16d60241d050</entry> 130 <entry align="left">Link to target datasheet</entry>
131 </row>
132 131
133 <row> 132 <entry><ulink
134 <entry>GCC version</entry> 133 url="https://www.intel.com/content/www/us/en/processors/xeon/xeon-d-1500-datasheet-vol-1.html">Intel
134 Xeon D datasheet</ulink></entry>
135 </row>
135 136
136 <entry>6.3</entry> 137 <row>
137 </row> 138 <entry align="left">Poky version</entry>
138 139
139 <row> 140 <entry>Git-commit-id: TBD</entry>
140 <entry>Linux Kernel Version</entry> 141 </row>
141 142
142 <entry>4.9</entry> 143 <row>
143 </row> 144 <entry align="left">GCC version</entry>
144 145
145 <row> 146 <entry>7.3</entry>
146 <entry>Supported Drivers</entry> 147 </row>
147 148
148 <entry>Ethernet, I2C, SPI, PCM/I2S, UART, USB, 149 <row>
149 SD/SDHC/SDXC</entry> 150 <entry align="left">Linux Kernel Version</entry>
150 </row>
151 151
152 <row> 152 <entry>4.14</entry>
153 <entry>Enea deb folder for downloading DEB packages for this 153 </row>
154 target</entry>
155 154
156 <entry><ulink 155 <row condition="hidden">
157 url="http://linux.enea.com/EneaLinux7.0/deb">http://linux.enea.com/EneaLinux7.0/deb</ulink></entry> 156 <entry align="left">Supported Drivers</entry>
158 </row> 157
159 </tbody> 158 <entry>Ethernet, RTC, UART</entry>
160 </tgroup> 159 </row>
161 </informaltable></para> 160
161 <row>
162 <entry>Enea deb folder for downloading DEB packages for this
163 target</entry>
164
165 <entry><ulink
166 url="http://linux.enea.com/EneaLinux8.0/deb">http://linux.enea.com/EneaLinux8.0/deb</ulink></entry>
167 </row>
168 </tbody>
169 </tgroup>
170 </table>
171
172 <table>
173 <title>MACHINE Information Intel Atom C3000</title>
174
175 <tgroup cols="2">
176 <colspec align="center" />
177
178 <thead>
179 <row>
180 <entry align="center">Component</entry>
181
182 <entry align="center">Description</entry>
183 </row>
184 </thead>
185
186 <tbody>
187 <row>
188 <entry align="left">Target official name</entry>
189
190 <entry>Intel Atom C3000</entry>
191 </row>
192
193 <row>
194 <entry align="left">Architecture and Description</entry>
195
196 <entry>x86-64</entry>
197 </row>
198
199 <row>
200 <entry align="left">Link to target datasheet</entry>
201
202 <entry><ulink
203 url="https://www.intel.com/content/www/us/en/products/docs/processors/atom/c-series/c3000-family-datasheet.html">Intel
204 Atom datasheet</ulink></entry>
205 </row>
206
207 <row>
208 <entry align="left">Poky version</entry>
209
210 <entry>Git-commit-id: TBD</entry>
211 </row>
212
213 <row>
214 <entry align="left">GCC version</entry>
215
216 <entry>7.3</entry>
217 </row>
218
219 <row>
220 <entry align="left">Linux Kernel Version</entry>
221
222 <entry>4.14</entry>
223 </row>
224
225 <row condition="hidden">
226 <entry align="left">Supported Drivers</entry>
227
228 <entry>Ethernet, RTC, UART</entry>
229 </row>
230
231 <row>
232 <entry>Enea deb folder for downloading DEB packages for this
233 target</entry>
234
235 <entry><ulink
236 url="http://linux.enea.com/EneaLinux8.0/deb">http://linux.enea.com/EneaLinux8.0/deb</ulink></entry>
237 </row>
238 </tbody>
239 </tgroup>
240 </table>
241
242 <table>
243 <title>MACHINE Information Intel NUC Kaby Lake</title>
244
245 <tgroup cols="2">
246 <colspec align="center" />
247
248 <thead>
249 <row>
250 <entry align="center">Component</entry>
251
252 <entry align="center">Description</entry>
253 </row>
254 </thead>
255
256 <tbody>
257 <row>
258 <entry align="left">Target official name</entry>
259
260 <entry>Intel NUC Kaby Lake</entry>
261 </row>
262
263 <row>
264 <entry align="left">Architecture and Description</entry>
265
266 <entry>x86-64</entry>
267 </row>
268
269 <row>
270 <entry align="left">Link to target datasheet</entry>
271
272 <entry><ulink
273 url="https://www.intel.com/content/dam/www/public/us/en/documents/product-briefs/nuc-kit-nuc7i5bnh-nuc7i5bnk-brief.pdf">Intel
274 NUC Kaby Lake datasheet</ulink></entry>
275 </row>
276
277 <row>
278 <entry align="left">Poky version</entry>
279
280 <entry>Git-commit-id: TBD</entry>
281 </row>
282
283 <row>
284 <entry align="left">GCC version</entry>
285
286 <entry>7.3</entry>
287 </row>
288
289 <row>
290 <entry align="left">Linux Kernel Version</entry>
291
292 <entry>4.14</entry>
293 </row>
294
295 <row condition="hidden">
296 <entry align="left">Supported Drivers</entry>
297
298 <entry>Ethernet, RTC, UART</entry>
299 </row>
300
301 <row>
302 <entry>Enea deb folder for downloading DEB packages for this
303 target</entry>
304
305 <entry><ulink
306 url="http://linux.enea.com/EneaLinux8.0/deb">http://linux.enea.com/EneaLinux8.0/deb</ulink></entry>
307 </row>
308 </tbody>
309 </tgroup>
310 </table>
162 </section> 311 </section>
163 </section> 312 </section>
164</section> \ No newline at end of file 313</section>
diff --git a/doc/book-enea-linux-user-guide/doc/getting_enea_linux.xml b/doc/book-enea-linux-user-guide/doc/getting_enea_linux.xml
index 350c966..21d0cb9 100644
--- a/doc/book-enea-linux-user-guide/doc/getting_enea_linux.xml
+++ b/doc/book-enea-linux-user-guide/doc/getting_enea_linux.xml
@@ -12,7 +12,7 @@
12 <title>Getting Pre-Built Binaries</title> 12 <title>Getting Pre-Built Binaries</title>
13 13
14 <para>Enea Linux pre-built binaries are available for download on <ulink 14 <para>Enea Linux pre-built binaries are available for download on <ulink
15 url="https://portal.enea.com/login/?redirect_to=https%3A%2F%2Fportal.enea.com%2F">Enea 15 url="https://portal.enea.com/login">Enea
16 Download Portal</ulink>. Log in using the credentials provided. Using the 16 Download Portal</ulink>. Log in using the credentials provided. Using the
17 menu, browse to the <emphasis role="bold">Linux</emphasis> section. You 17 menu, browse to the <emphasis role="bold">Linux</emphasis> section. You
18 will now have access to the <emphasis role="bold">Files</emphasis> section 18 will now have access to the <emphasis role="bold">Files</emphasis> section
@@ -34,8 +34,8 @@
34 </listitem> 34 </listitem>
35 35
36 <listitem> 36 <listitem>
37 <para><emphasis>sdk</emphasis> directory - this directory includes the 37 <para><emphasis>esdk</emphasis> directory - this directory includes the
38 installer for the SDK.</para> 38 installer for the Extensible SDK.</para>
39 </listitem> 39 </listitem>
40 40
41 <listitem> 41 <listitem>
@@ -118,17 +118,6 @@ id_rsa.pub</programlisting>
118 </listitem> 118 </listitem>
119 119
120 <listitem> 120 <listitem>
121 <para>Define the <filename>MACHINE</filename> from one of the
122 targets listed here:<remark>Below is the "machine_list"
123 programlisting in machine_list_generated.xml created by the make
124 system by extracting from the manifest</remark><itemizedlist>
125 <listitem>
126 <para>raspberrypi3-64</para>
127 </listitem>
128 </itemizedlist></para>
129 </listitem>
130
131 <listitem>
132 <para>Then use the repo command below:</para> 121 <para>Then use the repo command below:</para>
133 122
134 <xi:include href="../../book-enea-linux-release-info/doc/eltf_params_updated.xml" 123 <xi:include href="../../book-enea-linux-release-info/doc/eltf_params_updated.xml"
@@ -153,4 +142,4 @@ id_rsa.pub</programlisting>
153 etc. When this is done a reference from here should be added.</remark> 142 etc. When this is done a reference from here should be added.</remark>
154 </section> 143 </section>
155 </section> 144 </section>
156</chapter> \ No newline at end of file 145</chapter>
diff --git a/doc/book-enea-linux-user-guide/doc/preface.xml b/doc/book-enea-linux-user-guide/doc/preface.xml
index b1de43c..ff06753 100644
--- a/doc/book-enea-linux-user-guide/doc/preface.xml
+++ b/doc/book-enea-linux-user-guide/doc/preface.xml
@@ -3,7 +3,7 @@
3 <title>Preface</title> 3 <title>Preface</title>
4 4
5 <section id="guide_purpose"> 5 <section id="guide_purpose">
6 <title>The Purpose of This Guide</title> 6 <title>The Purpose of this Guide</title>
7 7
8 <para>This guide is intended for all Enea Linux developers who want to 8 <para>This guide is intended for all Enea Linux developers who want to
9 configure and build customized Linux kernel images for embedded system 9 configure and build customized Linux kernel images for embedded system
@@ -103,6 +103,17 @@
103 <entry>The release specific document listing the CVEs affecting 103 <entry>The release specific document listing the CVEs affecting
104 this distribuition.</entry> 104 this distribuition.</entry>
105 </row> 105 </row>
106
107 <row>
108 <entry><ulink type=""
109 url="https://linux.enea.com/4.0/documentation/html/book-enea-linux-realtime-guide/">Enea
110 Linux Real Time documentation</ulink> and <ulink
111 url="https://rt.wiki.kernel.org/index.php/Main_Page">Real-Time
112 Linux Wiki</ulink></entry>
113
114 <entry>Enea Linux Real-Time Guide and Real-Time Linux Wiki
115 page.</entry>
116 </row>
106 </tbody> 117 </tbody>
107 </tgroup> 118 </tgroup>
108 </table> 119 </table>
@@ -154,4 +165,4 @@
154 </listitem> 165 </listitem>
155 </itemizedlist> 166 </itemizedlist>
156 </section> 167 </section>
157</chapter> \ No newline at end of file 168</chapter>
diff --git a/doc/book-enea-linux-user-guide/doc/prerequisites_and_requirements.xml b/doc/book-enea-linux-user-guide/doc/prerequisites_and_requirements.xml
index 9642722..2215ba8 100644
--- a/doc/book-enea-linux-user-guide/doc/prerequisites_and_requirements.xml
+++ b/doc/book-enea-linux-user-guide/doc/prerequisites_and_requirements.xml
@@ -63,7 +63,7 @@ $ git config --global user.email johndoe@example.com</programlisting>
63 <para>Building Enea Linux requires a set of packages to be installed on 63 <para>Building Enea Linux requires a set of packages to be installed on
64 your Linux development host. The list of required packages is described 64 your Linux development host. The list of required packages is described
65 in the <ulink 65 in the <ulink
66 url="https://www.yoctoproject.org/docs/2.3/ref-manual/ref-manual.html#required-packages-for-the-host-development-system">Yocto 66 url="https://www.yoctoproject.org/docs/2.5/ref-manual/ref-manual.html#required-packages-for-the-host-development-system">Yocto
67 Project reference manual</ulink>.</para> 67 Project reference manual</ulink>.</para>
68 </section> 68 </section>
69 </section> 69 </section>
@@ -98,4 +98,4 @@ Use dash as the default system shell (/bin/sh)? No</programlisting>
98 </listitem> 98 </listitem>
99 </itemizedlist> 99 </itemizedlist>
100 </section> 100 </section>
101</chapter> \ No newline at end of file 101</chapter>
diff --git a/doc/book-enea-linux-user-guide/doc/using_eclipse.xml b/doc/book-enea-linux-user-guide/doc/using_eclipse.xml
index 9918ca2..8e560f5 100644
--- a/doc/book-enea-linux-user-guide/doc/using_eclipse.xml
+++ b/doc/book-enea-linux-user-guide/doc/using_eclipse.xml
@@ -7,7 +7,7 @@
7 7
8 <para>For instructions on how to install Eclipse Oxygen, please refer to 8 <para>For instructions on how to install Eclipse Oxygen, please refer to
9 the <ulink 9 the <ulink
10 url="http://www.yoctoproject.org/docs/2.3.2/sdk-manual/sdk-manual.html#adt-eclipse">Yocto 10 url="http://www.yoctoproject.org/docs/2.5/sdk-manual/sdk-manual.html#adt-eclipse">Yocto
11 Project Software Development Kit (SDK) Developer's Guide</ulink>, chapter 11 Project Software Development Kit (SDK) Developer's Guide</ulink>, chapter
12 4.3.2.1. Although the instructions listed there currently, refer to the 12 4.3.2.1. Although the instructions listed there currently, refer to the
13 Neon release of Eclipse, the same steps still apply to the Oxygen release, 13 Neon release of Eclipse, the same steps still apply to the Oxygen release,
@@ -47,7 +47,7 @@
47 47
48 <para>To install the Yocto Plugins in Eclipse, follow the instructions in 48 <para>To install the Yocto Plugins in Eclipse, follow the instructions in
49 <ulink 49 <ulink
50 url="http://www.yoctoproject.org/docs/2.3.2/sdk-manual/sdk-manual.html#adt-eclipse">chapter 50 url="http://www.yoctoproject.org/docs/2.5/sdk-manual/sdk-manual.html#adt-eclipse">chapter
51 4.3.2.1.3.2</ulink>. of the Yocto Manual, starting with <emphasis 51 4.3.2.1.3.2</ulink>. of the Yocto Manual, starting with <emphasis
52 role="bold">step 8</emphasis>. In <emphasis role="bold">step 12</emphasis> 52 role="bold">step 8</emphasis>. In <emphasis role="bold">step 12</emphasis>
53 use the local archive that you downloaded previously.</para> 53 use the local archive that you downloaded previously.</para>
@@ -60,10 +60,14 @@
60 Installed?</emphasis> link, as seen below.</para> 60 Installed?</emphasis> link, as seen below.</para>
61 61
62 <mediaobject> 62 <mediaobject>
63 <imageobject> 63 <imageobject role="fo">
64 <imagedata align="center" contentwidth="650" 64 <imagedata align="center" contentwidth="600"
65 fileref="images/install_new_sw.svg" /> 65 fileref="images/install_new_sw.svg" />
66 </imageobject> 66 </imageobject>
67
68 <imageobject role="html">
69 <imagedata align="center" fileref="images/install_new_sw.png" />
70 </imageobject>
67 </mediaobject> 71 </mediaobject>
68 </section> 72 </section>
69 73
@@ -193,7 +197,7 @@ root 329 0.0 0.2 1864824 2600 ? Ssl 12:47 0:08 /usr/sbin/tcf-agent -d -L- -l0</p
193 <para>For the <emphasis role="bold">Sysroot Location</emphasis> 197 <para>For the <emphasis role="bold">Sysroot Location</emphasis>
194 option, specify the path to the target sysroot directory inside the 198 option, specify the path to the target sysroot directory inside the
195 toolchain root location e.g. 199 toolchain root location e.g.
196 <literal>&lt;extsdkdir&gt;/tmp/sysroots/aarch64-enea-linux/raspberrypi3-64</literal></para> 200 <literal>&lt;extsdkdir&gt;/tmp/sysroots/corei7-64-enea-linux/</literal></para>
197 </listitem> 201 </listitem>
198 202
199 <listitem> 203 <listitem>
@@ -217,9 +221,9 @@ root 329 0.0 0.2 1864824 2600 ? Ssl 12:47 0:08 /usr/sbin/tcf-agent -d -L- -l0</p
217 <tip> 221 <tip>
218 <para>More details on how to configure the cross-compiler can be found 222 <para>More details on how to configure the cross-compiler can be found
219 in the <ulink 223 in the <ulink
220 url="http://www.yoctoproject.org/docs/2.3/sdk-manual/sdk-manual.html"><emphasis>Yocto 224 url="http://www.yoctoproject.org/docs/2.5/sdk-manual/sdk-manual.html"><emphasis>Yocto
221 Project Software Development Kit (SDK) Developer's Guide 225 Project Software Development Kit (SDK) Developer's Guide
222 2.3</emphasis></ulink>. Change the Yocto version in the link if 226 2.5</emphasis></ulink>. Change the Yocto version in the link if
223 needed.</para> 227 needed.</para>
224 228
225 <para>There is also a good cheat sheet available in Eclipse, under 229 <para>There is also a good cheat sheet available in Eclipse, under
@@ -873,7 +877,7 @@ root 329 0.0 0.2 1864824 2600 ? Ssl 12:47 0:08 /usr/sbin/tcf-agent -d -L- -l0</p
873 <para>Under the <emphasis role="bold">Debugger</emphasis> tab, 877 <para>Under the <emphasis role="bold">Debugger</emphasis> tab,
874 fill in the <literal>GDB Debugger</literal> field with the 878 fill in the <literal>GDB Debugger</literal> field with the
875 path to the GDB binary from the SDK. Example path: 879 path to the GDB binary from the SDK. Example path:
876 <filename>&lt;extsdkdir&gt;/tmp/sysroots/x86_64-linux/usr/bin/&lt;arch&gt;-enea-linux/&lt;arch&gt;-enea-linux-gdb</filename></para> 880 <filename>&lt;extsdkdir&gt;/tmp/sysroots/x86_64/usr/bin/&lt;arch&gt;-enea-linux/&lt;arch&gt;-enea-linux-gdb</filename></para>
877 </listitem> 881 </listitem>
878 882
879 <listitem> 883 <listitem>
@@ -896,7 +900,7 @@ root 329 0.0 0.2 1864824 2600 ? Ssl 12:47 0:08 /usr/sbin/tcf-agent -d -L- -l0</p
896 <para>In this section you learn to set up Eclipse for KGDB<indexterm> 900 <para>In this section you learn to set up Eclipse for KGDB<indexterm>
897 <primary>KGDB</primary> 901 <primary>KGDB</primary>
898 </indexterm> kernel debugging over the serial port, with examples for 902 </indexterm> kernel debugging over the serial port, with examples for
899 the <literal>raspberrypi3</literal> target. This is only given as an 903 the <literal>intel-corei7-64</literal> target. This is only given as an
900 example, your Enea Linux distribution may contain other targets. The 904 example, your Enea Linux distribution may contain other targets. The
901 corresponding instruction for debugging outside Eclipse is available in 905 corresponding instruction for debugging outside Eclipse is available in
902 Debugging the Linux Kernel (KGDB) from Command Line.<remark>LATER: Merge 906 Debugging the Linux Kernel (KGDB) from Command Line.<remark>LATER: Merge
@@ -930,7 +934,7 @@ root 329 0.0 0.2 1864824 2600 ? Ssl 12:47 0:08 /usr/sbin/tcf-agent -d -L- -l0</p
930 you can find it in the rootfs under the <literal>/boot</literal> 934 you can find it in the rootfs under the <literal>/boot</literal>
931 folder. If you build your own kernel using bitbake, it should be 935 folder. If you build your own kernel using bitbake, it should be
932 available in your build folder. Located in, for example: 936 available in your build folder. Located in, for example:
933 <filename><filename>tmp/work/raspberrypi3_64-enea-linux/linux-raspberrypi/1_4.9.59+gitAUTOINC+meta_machine-r0/image/boot/vmlinux-4.9.59</filename></filename></para> 937 <filename><filename>tmp/work/corei7-64-intel-common-enea-linux/linux-intel/4.14.66+gitAUTOINC+d64aec9793_dd6a8b48d4-r0/linux-corei7-64-intel-common-standard-build/vmlinux</filename></filename></para>
934 </listitem> 938 </listitem>
935 939
936 <listitem> 940 <listitem>
diff --git a/doc/book-enea-linux-user-guide/doc/using_enea_linux.xml b/doc/book-enea-linux-user-guide/doc/using_enea_linux.xml
index 3997038..a68f7da 100644
--- a/doc/book-enea-linux-user-guide/doc/using_enea_linux.xml
+++ b/doc/book-enea-linux-user-guide/doc/using_enea_linux.xml
@@ -5,9 +5,9 @@
5 <section id="build_enealinux"> 5 <section id="build_enealinux">
6 <title>Building Enea Linux</title> 6 <title>Building Enea Linux</title>
7 7
8 <para>Enea Linux is made available as sources as well. This allows 8 <para>Enea Linux is made available as sources, this allows for of building
9 building various Enea Linux artifacts and this is detailed in the 9 various Enea Linux artifacts and is detailed in the following
10 following sections:</para> 10 sections:</para>
11 11
12 <section id="build_images"> 12 <section id="build_images">
13 <title>Building the images</title> 13 <title>Building the images</title>
@@ -16,15 +16,18 @@
16 16
17 <procedure> 17 <procedure>
18 <step> 18 <step>
19 <para>Set the $MACHINE/&lt;machine&gt; variable to the target you
20 need, e.g. <literal>intel-corei7-64</literal>.</para>
21 </step>
22
23 <step>
19 <para>Clone Enea Linux sources using Repo tool. Please refer to 24 <para>Clone Enea Linux sources using Repo tool. Please refer to
20 chapter 3.2 in the current documebt for more details on how to do 25 <xref linkend="getting_sources" /> for more details.</para>
21 this.</para>
22 26
23 <programlisting>$ mkdir enea-linux 27 <programlisting>$ mkdir enea-linux
24$ cd enea-linux 28$ cd enea-linux
25$ export MACHINE=&lt;machine&gt;
26$ repo init -u git@git.enea.com:linux/manifests/el_manifests-standard.git \ 29$ repo init -u git@git.enea.com:linux/manifests/el_manifests-standard.git \
27 -b refs/tags/Enea_Linux_7.0 -m $MACHINE/default.xml 30 -b refs/tags/Enea_Linux_8.0 -m $MACHINE/default.xml
28$ repo sync</programlisting> 31$ repo sync</programlisting>
29 </step> 32 </step>
30 33
@@ -35,13 +38,10 @@ $ repo sync</programlisting>
35$ TEMPLATECONF=meta-el-standard/conf/template.&lt;machine&gt; \ 38$ TEMPLATECONF=meta-el-standard/conf/template.&lt;machine&gt; \
36. ./oe-init-build-env &lt;build_dir&gt;</programlisting> 39. ./oe-init-build-env &lt;build_dir&gt;</programlisting>
37 40
38 <note> 41 <para>Sourcing the build environment is needed everytime a new shell
39 <para>Sourcing the build environment is needed everytime a new 42 is used. However, sourcing using the <literal>TEMPLATECONF</literal>
40 shell is used. However, sourcing using the 43 is only needed the first time around. After the first time, it is
41 <literal>TEMPLATECONF</literal> is only needed the first time 44 enough to source the build directory created before.</para>
42 around. Afterwards it is enough to source the build directory
43 created before.</para>
44 </note>
45 45
46 <note> 46 <note>
47 <para>The build directory may reside on an NFS mount, but the 47 <para>The build directory may reside on an NFS mount, but the
@@ -105,9 +105,8 @@ $ cd &lt;build_dir&gt;/tmp/deploy/images/&lt;target&gt;/ # Here are the build b
105 105
106 <programlisting>$ mkdir enea-linux 106 <programlisting>$ mkdir enea-linux
107$ cd enea-linux 107$ cd enea-linux
108$ export MACHINE=&lt;machine&gt;
109$ repo init -u git@git.enea.com:linux/manifests/el_manifests-standard.git \ 108$ repo init -u git@git.enea.com:linux/manifests/el_manifests-standard.git \
110 -b refs/tags/Enea_Linux_7.0 -m $MACHINE/default.xml 109 -b refs/tags/Enea_Linux_8.0 -m $MACHINE/default.xml
111$ repo sync</programlisting> 110$ repo sync</programlisting>
112 </step> 111 </step>
113 112
@@ -118,13 +117,10 @@ $ repo sync</programlisting>
118$ TEMPLATECONF=meta-el-standard/conf/template.&lt;machine&gt; \ 117$ TEMPLATECONF=meta-el-standard/conf/template.&lt;machine&gt; \
119. ./oe-init-build-env &lt;build_dir&gt;</programlisting> 118. ./oe-init-build-env &lt;build_dir&gt;</programlisting>
120 119
121 <note> 120 <para>Sourcing the build environment is needed everytime a new shell
122 <para>Sourcing the build environment is needed everytime a new 121 is used. However, sourcing using the <literal>TEMPLATECONF</literal>
123 shell is used. However, sourcing using the 122 is only needed the first time around. Afterwards it is enough to
124 <literal>TEMPLATECONF</literal> is only needed the first time 123 source the build directory created before.</para>
125 around. Afterwards it is enough to source the build directory
126 created before.</para>
127 </note>
128 124
129 <note> 125 <note>
130 <para>The build directory may reside on an NFS mount, but the 126 <para>The build directory may reside on an NFS mount, but the
@@ -177,109 +173,140 @@ $ cd &lt;build_dir&gt;/tmp/deploy/sdk/ # Here is the SDK installer script</prog
177 <para>Enea Linux supports multiple booting methods so those will be 173 <para>Enea Linux supports multiple booting methods so those will be
178 described in the following sections.</para> 174 described in the following sections.</para>
179 175
180 <section id="boot_from_arm"> 176 <section id="enea-linux-x86-pxe">
181 <title>Boot from RAM</title> 177 <title>Booting via PXE</title>
182
183 <para>This example requires that a TFTP server is set up at IP address
184 <literal>&lt;tftp_server_ip&gt;</literal>, and that the server stores
185 the Enea Linux image files, kernel image, device tree blob and root
186 filesystem, in <literal>/tftpboot/&lt;download_directory&gt;.</literal>
187 Please refer to <xref linkend="prebuiltprereq" /> for more details on
188 how to install and configure the TFTP server.</para>
189 178
190 <para>Once you have that in place, run the following commands on the 179 <para>Below you find an example of how to boot Enea Linux in a target
191 target:</para> 180 supporting PXE. The PXE boot is handled by the target BIOS.</para>
192 181
193 <programlisting>## set tftp server IP 182 <para>This requires the setup of DHCP, TFTP and NFS servers on the host.
194U-Boot&gt; setenv serverip &lt;tftp_server_ip&gt; 183 The DHCP server contains a configuration for the target, found via the
184 target MAC address, and refers to the TFTP server for the boot image and
185 to the NFS server for the root file system.</para>
195 186
196## tftp the image files on the target machine 187 <para>For the DHCP server, in addition to the general configuration, the
197U-Boot&gt; tftpboot 0x01000000 Image 188 DHCPD configuration should contain an entry for the target with the
198U-Boot&gt; tftpboot 0x02000000 Image-bcm2837-rpi-3-b.dtb 189 following information:</para>
199U-Boot&gt; tftpboot 0x03000000 enea-image-standard-raspberrypi3-64.ext2.gz.u-boot
200 190
201## add any other bootargs values if necessary 191 <itemizedlist spacing="compact">
202U-Boot&gt; setenv bootargs "8250.nr_uarts=1 root=/dev/ram rw ramdisk_size=500000 ip=dhcp \ 192 <listitem>
203console=ttyS0,115200" 193 <para>Host name</para>
194 </listitem>
204 195
205## Start boot sequence 196 <listitem>
206U-Boot&gt; booti 0x01000000 0x03000000 0x02000000</programlisting> 197 <para>MAC hardware ethernet address (also available in the TFTP
207 </section> 198 configuration)</para>
199 </listitem>
208 200
209 <section id="boot_from_sd"> 201 <listitem>
210 <title>Boot from SD card</title> 202 <para>IP address, (assuming a fixed IP address is used)</para>
203 </listitem>
211 204
212 <para>Copy the 205 <listitem>
213 <filename>enea-image-standard-raspberrypi3-64.rpi-sdimg</filename> image 206 <para>The TFTP server shall be defined as
214 to the SD card using the Linux dd tool or Win32DiskImager in Windows, 207 <literal>next-server</literal></para>
215 and insert it into the RPi. The Raspberry Pi will not start without a 208 </listitem>
216 properly formatted SD Card, containing the bootloader, kernel image and
217 rootfs.</para>
218 209
219 <para>Below you can find two methods of how to format an SD Card:</para> 210 <listitem>
211 <para>The relative path in the TFTP server to the PXE file
212 <filename><literal>pxelinux.0</literal></filename></para>
213 </listitem>
220 214
221 <itemizedlist>
222 <listitem> 215 <listitem>
223 <para><emphasis role="bold">Format and copy images to the SD card 216 <para>The NFS server IP address and the path to the rootfs on the
224 using the Linux dd command line</emphasis></para> 217 NFS server, defined as <literal>option root-path</literal></para>
218 </listitem>
219 </itemizedlist>
225 220
226 <para>The <command>dd</command> command copies a file, converting 221 <para>Example of a DHCP server configuration:</para>
227 the format of the data in the process, according to the operands
228 specified:</para>
229 222
230 <programlisting>sudo dd bs=4M if=enea-image-standard-sdk-raspberrypi3-64.rpi-sdimg of=/dev/sdg</programlisting> 223 <programlisting>host intel-corei7-64_host {
224 hardware ethernet 01:00:25:90:c8:c5:98;
225 fixed-address 192.168.1.38;
226 next-server 192.168.2.10;
227 filename "intel-corei7-64_tftp/pxelinux.0";
228 option root-path "192.168.2.20:/export/intel-corei7-64_rootfs";
229}</programlisting>
231 230
232 <note> 231 <para>For the TFTP server, the TFTP path to the target's pxelinux.0 file
233 <para>Use <command>dd</command> cautiously - improper usage or 232 is given in the DHCP Configuration. Examples of files included in the
234 entering the wrong values could inadvertently wipe, destroy, or 233 TFTP subdirectory indicated by the DHCP configuration are:</para>
235 overwrite the data on your hard drive.</para>
236 </note>
237 </listitem>
238 234
239 <listitem> 235 <programlisting>pxelinux.0
240 <para><emphasis role="bold">Format the SD card using the 236vesamenu.c32
241 Win32DiskImager program</emphasis></para> 237boot/device01/bzImage (bootable image file)
238pxelinux.cfg/01-00-25-90-c8-c5-98 (Configuration file)</programlisting>
242 239
243 <orderedlist> 240 <para>One configuration file has the same name as the target's MAC
244 <listitem> 241 address (but with hyphens instead of a colon). This configuration file
245 <para>Download and unzip <ulink 242 contains a pointer to the bootable image and also a list of command line
246 url="https://sourceforge.net/projects/win32diskimager/">Win32DiskImager</ulink></para> 243 arguments to append when the image is started. The same NFS path to the
247 </listitem> 244 root file system is both in the DHCP and the TFTP configuration.</para>
248 245
249 <listitem> 246 <para>Example of a configuration file:</para>
250 <para>Run <filename>Win32DiskImager.exe</filename></para>
251 </listitem>
252 247
253 <listitem> 248 <programlisting>default vesamenu.c32
254 <para>Select the drive of your SD card</para> 249prompt 0
255 </listitem> 250timeout 100
256 251
257 <listitem> 252label device01
258 <para>Select the image 253 menu label ^EneaLinuxNFS
259 <filename><filename>enea-image-standard-raspberrypi3-64.rpi-sdimg</filename></filename></para> 254 menu default
260 </listitem> 255 kernel boot/device01/bzImage
256 <emphasis role="bold">append</emphasis> root=/dev/nfs nfsmount=192.168.2.20:/export/intel-corei7-64_rootfs ip=dhcp
257 console=ttyS0,115200</programlisting>
261 258
262 <listitem> 259 <para><emphasis role="bold">NFS server</emphasis>: The NFS server shall
263 <para>Click "Write" and wait for the write to complete</para> 260 contain an unpacked root file system in the path indicated both in the
264 </listitem> 261 DHCP and in the TFTP configuration.</para>
265 262
266 <listitem> 263 <para>After configuring the servers, copy files from the build directory
267 <para>Exit the imager and eject the SD Card</para> 264 into the correctly configured paths:</para>
268 </listitem>
269 265
270 <listitem> 266 <orderedlist spacing="compact">
271 <para>Plug the card into your Raspberry Pi</para> 267 <listitem>
272 </listitem> 268 <para>Ensure the target is not already running an OS, otherwise the
273 </orderedlist> 269 target might attempt to change files on the root file system while
270 it is populated with new files.</para>
271 </listitem>
274 272
275 <note> 273 <listitem>
276 <para>Be careful to select the correct drive. If you choose the 274 <para>Copy <filename>pxelinux.0</filename> and
277 wrong one you may destroy your HDD data. If you are using an SD 275 <filename>vesamenu.c32</filename> from the build directory, e.g.
278 Card slot and can't see the drive in the Win32DiskImager window, 276 from
279 try using an affordable external adapter in a USB slot.</para> 277 <filename>&lt;build_dir&gt;tmp/work/corei7-64-enea-linux/syslinux/6.03-r0/image/usr/share/syslinux/</filename>.</para>
280 </note>
281 </listitem> 278 </listitem>
282 </itemizedlist> 279
280 <listitem>
281 <para>Copy <filename>bzImage</filename> from
282 <filename>&lt;build_dir&gt;/tmp/deploy/images/&lt;target&gt;/</filename>.</para>
283 </listitem>
284
285 <listitem>
286 <para>Populate the root file system in the NFS directory by
287 unpacking
288 <filename>enea-image-standard-intel-corei7-64.tar.gz</filename>
289 found at
290 <filename>&lt;build_dir&gt;/tmp/deploy/images/&lt;target&gt;/</filename>.</para>
291 </listitem>
292 </orderedlist>
293
294 <para>Boot the target by:</para>
295
296 <orderedlist>
297 <listitem>
298 <para>Use the BIOS or boot setup to select PXE boot, if not already
299 selected.</para>
300 </listitem>
301
302 <listitem>
303 <para>Reboot the target.</para>
304 </listitem>
305 </orderedlist>
306
307 <para>The boot setup menu is usually launched by pressing F12 or ESC
308 during BIOS power up tests. Look up the manufacturer's documentation for
309 your board model to find the appropriate key.</para>
283 </section> 310 </section>
284 </section> 311 </section>
285 312
@@ -342,8 +369,7 @@ BBLAYERS ?= " \
342 /path/to/poky/meta-el-common \ 369 /path/to/poky/meta-el-common \
343 /path/to/poky/meta-el-standard \ 370 /path/to/poky/meta-el-standard \
344 /path/to/poky/meta-enea-bsp-common \ 371 /path/to/poky/meta-enea-bsp-common \
345 /path/to/poky/meta-enea-bsp-&lt;arch&gt; \ 372 /path/to/poky/meta-enea-bsp-x86 \
346 /path/to/poky/meta-fsl-&lt;arch&gt; \
347 /path/to/poky/meta-openembedded/meta-oe \ 373 /path/to/poky/meta-openembedded/meta-oe \
348 /path/to/poky/meta-openembedded/meta-networking \ 374 /path/to/poky/meta-openembedded/meta-networking \
349 /path/to/poky/meta-openembedded/meta-filesystems \ 375 /path/to/poky/meta-openembedded/meta-filesystems \
@@ -386,8 +412,8 @@ BBLAYERS ?= " \
386 <para>As a result, <filename>BBLAYERS</filename> shall be extended with 412 <para>As a result, <filename>BBLAYERS</filename> shall be extended with
387 the bsp-layer/s layer for your target and any other additional layer/s. 413 the bsp-layer/s layer for your target and any other additional layer/s.
388 For details on how to do this, see the <ulink 414 For details on how to do this, see the <ulink
389 url="http://www.yoctoproject.org/docs/2.3/dev-manual/dev-manual.html#understanding-and-creating-layers">Yocto 415 url="http://www.yoctoproject.org/docs/2.5/dev-manual/dev-manual.html#understanding-and-creating-layers">Yocto
390 2.3 Dev Manual, section "Understanding and Creating Layers"</ulink> . If 416 2.5 Dev Manual, section "Understanding and Creating Layers".</ulink> If
391 needed replace the Yocto version.</para> 417 needed replace the Yocto version.</para>
392 418
393 <para>Layers can be added when you initialize the build environment. The 419 <para>Layers can be added when you initialize the build environment. The
@@ -414,11 +440,10 @@ BBLAYERS ?= " \
414 <title>Adding a Recipe</title> 440 <title>Adding a Recipe</title>
415 441
416 <para>Study the <ulink 442 <para>Study the <ulink
417 url="https://www.yoctoproject.org/docs/2.3/dev-manual/dev-manual.html#new-recipe-single-c-file-package-hello-world"><ulink 443 url="https://www.yoctoproject.org/docs/2.5/dev-manual/dev-manual.html#new-recipe-single-c-file-package-hello-world">Hello
418 url="https://www.yoctoproject.org/docs/2.3/dev-manual/dev-manual.html#new-recipe-single-c-file-package-hello-world">Hello 444 World recipe</ulink> in the Yocto Project Development Manual. If needed
419 World recipe</ulink></ulink> in the Yocto Project Development Manual. If 445 replace the example version (2.5) with the Yocto version in your Enea
420 needed replace the example version (2.3) with the Yocto version in your 446 Linux distribution.</para>
421 Enea Linux distribution.</para>
422 </section> 447 </section>
423 448
424 <section id="config_pkg_recipes"> 449 <section id="config_pkg_recipes">
@@ -650,7 +675,7 @@ $ ./enea-*-toolchain-&lt;version&gt;.sh</programlisting>
650 675
651 <para>Example:</para> 676 <para>Example:</para>
652 677
653 <programlisting>$ . /opt/enea/environment-setup-aarch64-enea-linux</programlisting> 678 <programlisting>$ . /opt/enea/environment-setup-corei7-64-enea-linux</programlisting>
654 </listitem> 679 </listitem>
655 </orderedlist> 680 </orderedlist>
656 681
@@ -658,6 +683,16 @@ $ ./enea-*-toolchain-&lt;version&gt;.sh</programlisting>
658 set up, you can proceed with Cross-Compiling Applications from Command 683 set up, you can proceed with Cross-Compiling Applications from Command
659 Line (4.1) or, if Eclipse is installed, Cross-Compiling from Eclipse 684 Line (4.1) or, if Eclipse is installed, Cross-Compiling from Eclipse
660 (5.4.1).</para> 685 (5.4.1).</para>
686
687 <section id="boot_qemux86">
688 <title>Building and booting Enea Linux on QEMU x86</title>
689
690 <para>Build an Enea Linux image from the SDK to run on QEMU x86:</para>
691
692 <programlisting>$ cd &lt;sdkdir&gt;/workspace
693$ devtool build-image enea-image-standard
694$ devtool runqemu kvm enea-image-standard nographic slirp </programlisting>
695 </section>
661 </section> 696 </section>
662 697
663 <section id="pkg_mg"> 698 <section id="pkg_mg">
@@ -667,8 +702,8 @@ $ ./enea-*-toolchain-&lt;version&gt;.sh</programlisting>
667 image in a consistent way, e.g. to install, upgrade, or delete packages 702 image in a consistent way, e.g. to install, upgrade, or delete packages
668 considering the dependencies. The package management systems supported by 703 considering the dependencies. The package management systems supported by
669 Enea Linux are described in this section. More information about PMS can 704 Enea Linux are described in this section. More information about PMS can
670 be found in the Yocto 2.3 document <ulink 705 be found in the Yocto 2.5 document <ulink
671 url="http://www.yoctoproject.org/docs/2.3/mega-manual/mega-manual.html">Yocto 706 url="http://www.yoctoproject.org/docs/2.5/mega-manual/mega-manual.html">Yocto
672 Project Mega Manual</ulink>. If needed replace the Yocto version in the 707 Project Mega Manual</ulink>. If needed replace the Yocto version in the
673 link.</para> 708 link.</para>
674 709
@@ -676,7 +711,7 @@ $ ./enea-*-toolchain-&lt;version&gt;.sh</programlisting>
676 <title>APT Package Management (DEB Packages)</title> 711 <title>APT Package Management (DEB Packages)</title>
677 712
678 <para>Enea Linux provides DEB packages on <ulink 713 <para>Enea Linux provides DEB packages on <ulink
679 url="http://linux.enea.com/EneaLinux7.0/">linux.enea.com</ulink> site, 714 url="http://linux.enea.com/EneaLinux8.0/">linux.enea.com</ulink> site,
680 in directory 715 in directory
681 <literal><literal>&lt;release&gt;/&lt;target&gt;/deb</literal>/</literal>.</para> 716 <literal><literal>&lt;release&gt;/&lt;target&gt;/deb</literal>/</literal>.</para>
682 717
@@ -777,4 +812,4 @@ ptest-runner-dev - A C program to run all installed ptests - Development files</
777 </section> 812 </section>
778 </section> 813 </section>
779 </section> 814 </section>
780</chapter> \ No newline at end of file 815</chapter>