diff options
author | Sona Sarmadi <sona.sarmadi@enea.com> | 2018-07-16 08:27:31 +0200 |
---|---|---|
committer | Sona Sarmadi <sona.sarmadi@enea.com> | 2018-07-21 11:33:57 +0200 |
commit | ddccea54b0fc621d293098e83a44202c90cf8a26 (patch) | |
tree | e54eb9f79a7bd47a5c47722979414fd1dffff911 | |
parent | 4bc19d7a7a378e9950d6230f9be4c47a5ee425e1 (diff) | |
download | el_releases-standard-ddccea54b0fc621d293098e83a44202c90cf8a26.tar.gz |
Updated User Guide for EL8
Change-Id: If6c77ae013eef18b8988d0e984b8ef0d471a2050
Signed-off-by: Sona Sarmadi <sona.sarmadi@enea.com>
6 files changed, 345 insertions, 177 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 <SDK_dir>/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 |
62 | cd enea-linux | 62 | cd enea-linux |
63 | repo init -u git@git.enea.com:linux/manifests/el_manifests-standard.git \ | 63 | repo 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 |
65 | repo sync</programlisting></para> | 65 | repo 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..e58726e 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 | |||
@@ -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/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 12cf149..f6c7759 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> |
@@ -197,7 +197,7 @@ root 329 0.0 0.2 1864824 2600 ? Ssl 12:47 0:08 /usr/sbin/tcf-agent -d -L- -l0</p | |||
197 | <para>For the <emphasis role="bold">Sysroot Location</emphasis> | 197 | <para>For the <emphasis role="bold">Sysroot Location</emphasis> |
198 | option, specify the path to the target sysroot directory inside the | 198 | option, specify the path to the target sysroot directory inside the |
199 | toolchain root location e.g. | 199 | toolchain root location e.g. |
200 | <literal><extsdkdir>/tmp/sysroots/aarch64-enea-linux/raspberrypi3-64</literal></para> | 200 | <literal><extsdkdir>/tmp/sysroots/corei7-64-enea-linux/</literal></para> |
201 | </listitem> | 201 | </listitem> |
202 | 202 | ||
203 | <listitem> | 203 | <listitem> |
@@ -221,9 +221,9 @@ root 329 0.0 0.2 1864824 2600 ? Ssl 12:47 0:08 /usr/sbin/tcf-agent -d -L- -l0</p | |||
221 | <tip> | 221 | <tip> |
222 | <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 |
223 | in the <ulink | 223 | in the <ulink |
224 | 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 |
225 | Project Software Development Kit (SDK) Developer's Guide | 225 | Project Software Development Kit (SDK) Developer's Guide |
226 | 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 |
227 | needed.</para> | 227 | needed.</para> |
228 | 228 | ||
229 | <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 |
@@ -1222,4 +1222,4 @@ root 329 0.0 0.2 1864824 2600 ? Ssl 12:47 0:08 /usr/sbin/tcf-agent -d -L- -l0</p | |||
1222 | </itemizedlist> | 1222 | </itemizedlist> |
1223 | </section> | 1223 | </section> |
1224 | </section> | 1224 | </section> |
1225 | </chapter> \ No newline at end of file | 1225 | </chapter> |
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 a0b7d2c..ea801b2 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 | |||
@@ -21,9 +21,8 @@ | |||
21 | 21 | ||
22 | <programlisting>$ mkdir enea-linux | 22 | <programlisting>$ mkdir enea-linux |
23 | $ cd enea-linux | 23 | $ cd enea-linux |
24 | $ export MACHINE=<machine> | ||
25 | $ repo init -u git@git.enea.com:linux/manifests/el_manifests-standard.git \ | 24 | $ repo init -u git@git.enea.com:linux/manifests/el_manifests-standard.git \ |
26 | -b refs/tags/Enea_Linux_7.0 -m $MACHINE/default.xml | 25 | -b refs/tags/Enea_Linux_8.0 -m $MACHINE/default.xml |
27 | $ repo sync</programlisting> | 26 | $ repo sync</programlisting> |
28 | </step> | 27 | </step> |
29 | 28 | ||
@@ -101,9 +100,8 @@ $ cd <build_dir>/tmp/deploy/images/<target>/ # Here are the build b | |||
101 | 100 | ||
102 | <programlisting>$ mkdir enea-linux | 101 | <programlisting>$ mkdir enea-linux |
103 | $ cd enea-linux | 102 | $ cd enea-linux |
104 | $ export MACHINE=<machine> | ||
105 | $ repo init -u git@git.enea.com:linux/manifests/el_manifests-standard.git \ | 103 | $ repo init -u git@git.enea.com:linux/manifests/el_manifests-standard.git \ |
106 | -b refs/tags/Enea_Linux_7.0 -m $MACHINE/default.xml | 104 | -b refs/tags/Enea_Linux_8.0 -m $MACHINE/default.xml |
107 | $ repo sync</programlisting> | 105 | $ repo sync</programlisting> |
108 | </step> | 106 | </step> |
109 | 107 | ||
@@ -173,109 +171,142 @@ $ cd <build_dir>/tmp/deploy/sdk/ # Here is the SDK installer script</prog | |||
173 | <para>Enea Linux supports multiple booting methods so those will be | 171 | <para>Enea Linux supports multiple booting methods so those will be |
174 | described in the following sections.</para> | 172 | described in the following sections.</para> |
175 | 173 | ||
176 | <section id="boot_from_arm"> | 174 | <section id="enea-linux-x86-pxe"> |
177 | <title>Boot from RAM</title> | 175 | <title>Boot via PXE using DHCP, TFTP, and NFS servers</title> |
178 | 176 | ||
179 | <para>This example requires that a TFTP server is set up at IP address | 177 | <para>Below you find an example of how to boot Enea Linux in a target |
180 | <literal><tftp_server_ip></literal>, and that the server stores | 178 | supporting PXE. The PXE boot is handled by the target BIOS.</para> |
181 | the Enea Linux image files, kernel image, device tree blob and root | ||
182 | filesystem, in <literal>/tftpboot/<download_directory>.</literal> | ||
183 | Please refer to <xref linkend="prebuiltprereq" /> for more details on | ||
184 | how to install and configure the TFTP server.</para> | ||
185 | 179 | ||
186 | <para>Once you have that in place, run the following commands on the | 180 | <para>This requires the setup of DHCP, TFTP and NFS servers on the host. |
187 | target:</para> | 181 | The DHCP server contains a configuration for the target, found via the |
188 | 182 | target MAC address, and refers to the TFTP server for the boot image and | |
189 | <programlisting>## set tftp server IP | 183 | to the NFS server for the root file system.</para> |
190 | U-Boot> setenv serverip <tftp_server_ip> | ||
191 | |||
192 | ## tftp the image files on the target machine | ||
193 | U-Boot> tftpboot 0x01000000 Image | ||
194 | U-Boot> tftpboot 0x02000000 Image-bcm2837-rpi-3-b.dtb | ||
195 | U-Boot> tftpboot 0x03000000 enea-image-standard-raspberrypi3-64.ext2.gz.u-boot | ||
196 | |||
197 | ## add any other bootargs values if necessary | ||
198 | U-Boot> setenv bootargs "8250.nr_uarts=1 root=/dev/ram rw ramdisk_size=500000 ip=dhcp \ | ||
199 | console=ttyS0,115200" | ||
200 | |||
201 | ## Start boot sequence | ||
202 | U-Boot> booti 0x01000000 0x03000000 0x02000000</programlisting> | ||
203 | </section> | ||
204 | |||
205 | <section id="boot_from_sd"> | ||
206 | <title>Boot from SD card</title> | ||
207 | 184 | ||
208 | <para>Copy the | 185 | <para><emphasis role="bold">DHCP server</emphasis>: In addition to |
209 | <filename>enea-image-standard-raspberrypi3-64.rpi-sdimg</filename> image | 186 | general DHCPD configuration, the DHCPD configuration should contain an |
210 | to the SD card using the Linux dd tool or Win32DiskImager in Windows, | 187 | entry for the target with the following information about the |
211 | and insert it into the RPi. The Raspberry Pi will not start without a | 188 | target:</para> |
212 | properly formatted SD Card, containing the bootloader, kernel image and | ||
213 | rootfs.</para> | ||
214 | |||
215 | <para>Below you can find two methods of how to format an SD Card:</para> | ||
216 | 189 | ||
217 | <itemizedlist> | 190 | <itemizedlist spacing="compact"> |
218 | <listitem> | 191 | <listitem> |
219 | <para><emphasis role="bold">Format and copy images to the SD card | 192 | <para>Host name</para> |
220 | using the Linux dd command line</emphasis></para> | 193 | </listitem> |
221 | 194 | ||
222 | <para>The <command>dd</command> command copies a file, converting | 195 | <listitem> |
223 | the format of the data in the process, according to the operands | 196 | <para>MAC hardware ethernet address (also available in the TFTP |
224 | specified:</para> | 197 | configuration)</para> |
198 | </listitem> | ||
225 | 199 | ||
226 | <programlisting>sudo dd bs=4M if=enea-image-standard-sdk-raspberrypi3-64.rpi-sdimg of=/dev/sdg</programlisting> | 200 | <listitem> |
201 | <para>IP address, (assuming a fixed IP address is used)</para> | ||
202 | </listitem> | ||
227 | 203 | ||
228 | <note> | 204 | <listitem> |
229 | <para>Use <command>dd</command> cautiously - improper usage or | 205 | <para>The TFTP server shall be defined as |
230 | entering the wrong values could inadvertently wipe, destroy, or | 206 | "<literal>next-server</literal>"</para> |
231 | overwrite the data on your hard drive.</para> | ||
232 | </note> | ||
233 | </listitem> | 207 | </listitem> |
234 | 208 | ||
235 | <listitem> | 209 | <listitem> |
236 | <para><emphasis role="bold">Format the SD card using the | 210 | <para>The relative path in the TFTP server to the PXE file |
237 | Win32DiskImager program</emphasis></para> | 211 | <filename><literal>pxelinux.0</literal></filename></para> |
212 | </listitem> | ||
238 | 213 | ||
239 | <orderedlist> | 214 | <listitem> |
240 | <listitem> | 215 | <para>The NFS server IP address and the path to the rootfs on the |
241 | <para>Download and unzip <ulink | 216 | NFS server, defined as "<literal>option root-path</literal>"</para> |
242 | url="https://sourceforge.net/projects/win32diskimager/">Win32DiskImager</ulink></para> | 217 | </listitem> |
243 | </listitem> | 218 | </itemizedlist> |
244 | 219 | ||
245 | <listitem> | 220 | <para>Example of a DHCP server configuration:</para> |
246 | <para>Run <filename>Win32DiskImager.exe</filename></para> | 221 | |
247 | </listitem> | 222 | <programlisting>host intel-corei7-64_host { |
223 | hardware ethernet 01:00:25:90:c8:c5:98; | ||
224 | fixed-address 192.168.1.38; | ||
225 | next-server 192.168.2.10; | ||
226 | filename "intel-corei7-64_tftp/pxelinux.0"; | ||
227 | option root-path "192.168.2.20:/export/intel-corei7-64_rootfs"; | ||
228 | }</programlisting> | ||
229 | |||
230 | <para><emphasis role="bold">TFTP server</emphasis>: The TFTP path to the | ||
231 | target's <literal>pxelinux.0</literal> is given in the DHCP | ||
232 | configuration. Example of files in the TFTP subdirectory indicated by | ||
233 | the DHCP configuration:</para> | ||
234 | |||
235 | <programlisting>pxelinux.0 | ||
236 | vesamenu.c32 | ||
237 | boot/device01/bzImage (bootable image file) | ||
238 | pxelinux.cfg/01-00-25-90-c8-c5-98 (Configuration file)</programlisting> | ||
239 | |||
240 | <para>One configuration file has the same name as the target's MAC | ||
241 | address (but with hyphens instead of a colon). This configuration file | ||
242 | contains a pointer to the bootable image and also a list of command line | ||
243 | arguments to append when the image is started. The same NFS path to the | ||
244 | root file system is both in the DHCP and the TFTP configuration.</para> | ||
245 | |||
246 | <para>Example of a configuration file:</para> | ||
247 | |||
248 | <programlisting>default vesamenu.c32 | ||
249 | prompt 0 | ||
250 | timeout 100 | ||
251 | |||
252 | label device01 | ||
253 | menu label ^EneaLinuxNFS | ||
254 | menu default | ||
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> | ||
258 | |||
259 | <para><emphasis role="bold">NFS server</emphasis>: The NFS server shall | ||
260 | contain an unpacked root file system in the path indicated both in the | ||
261 | DHCP and in the TFTP configuration.</para> | ||
262 | |||
263 | <para>After configuring the servers, copy files from the build directory | ||
264 | into the correct configured paths:</para> | ||
265 | |||
266 | <orderedlist spacing="compact"> | ||
267 | <listitem> | ||
268 | <para>Ensure the target is not already running an OS, otherwise the | ||
269 | target might attempt to change files on the root file system while | ||
270 | it is populated with new files.</para> | ||
271 | </listitem> | ||
248 | 272 | ||
249 | <listitem> | 273 | <listitem> |
250 | <para>Select the drive of your SD card</para> | 274 | <para>Copy <filename>pxelinux.0</filename> and |
251 | </listitem> | 275 | <filename>vesamenu.c32</filename> from the build directory, e.g. |
276 | from | ||
277 | <filename><build_dir>tmp/work/corei7-64-enea-linux/syslinux/6.03-r0/image/usr/share/syslinux/</filename>.</para> | ||
278 | </listitem> | ||
252 | 279 | ||
253 | <listitem> | 280 | <listitem> |
254 | <para>Select the image | 281 | <para>Copy <filename>bzImage</filename> from |
255 | <filename><filename>enea-image-standard-raspberrypi3-64.rpi-sdimg</filename></filename></para> | 282 | <filename><build_dir>/tmp/deploy/images/<target>/</filename>.</para> |
256 | </listitem> | 283 | </listitem> |
257 | 284 | ||
258 | <listitem> | 285 | <listitem> |
259 | <para>Click "Write" and wait for the write to complete</para> | 286 | <para>Populate the root file system in the NFS directory by |
260 | </listitem> | 287 | unpacking |
288 | <filename>enea-image-standard-intel-corei7-64.tar.gz</filename> | ||
289 | found at | ||
290 | <filename><build_dir>/tmp/deploy/images/<target>/</filename>.</para> | ||
291 | </listitem> | ||
292 | </orderedlist> | ||
261 | 293 | ||
262 | <listitem> | 294 | <para>Boot the target by:</para> |
263 | <para>Exit the imager and eject the SD Card</para> | ||
264 | </listitem> | ||
265 | 295 | ||
266 | <listitem> | 296 | <orderedlist> |
267 | <para>Plug the card into your Raspberry Pi</para> | 297 | <listitem> |
268 | </listitem> | 298 | <para>Use the BIOS or boot setup to select PXE boot, if not already |
269 | </orderedlist> | 299 | selected.</para> |
300 | </listitem> | ||
270 | 301 | ||
271 | <note> | 302 | <listitem> |
272 | <para>Be careful to select the correct drive. If you choose the | 303 | <para>Reboot the target.</para> |
273 | wrong one you may destroy your HDD data. If you are using an SD | ||
274 | Card slot and can't see the drive in the Win32DiskImager window, | ||
275 | try using an affordable external adapter in a USB slot.</para> | ||
276 | </note> | ||
277 | </listitem> | 304 | </listitem> |
278 | </itemizedlist> | 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> | ||
279 | </section> | 310 | </section> |
280 | </section> | 311 | </section> |
281 | 312 | ||
@@ -338,8 +369,7 @@ BBLAYERS ?= " \ | |||
338 | /path/to/poky/meta-el-common \ | 369 | /path/to/poky/meta-el-common \ |
339 | /path/to/poky/meta-el-standard \ | 370 | /path/to/poky/meta-el-standard \ |
340 | /path/to/poky/meta-enea-bsp-common \ | 371 | /path/to/poky/meta-enea-bsp-common \ |
341 | /path/to/poky/meta-enea-bsp-<arch> \ | 372 | /path/to/poky/meta-enea-bsp-x86 \ |
342 | /path/to/poky/meta-fsl-<arch> \ | ||
343 | /path/to/poky/meta-openembedded/meta-oe \ | 373 | /path/to/poky/meta-openembedded/meta-oe \ |
344 | /path/to/poky/meta-openembedded/meta-networking \ | 374 | /path/to/poky/meta-openembedded/meta-networking \ |
345 | /path/to/poky/meta-openembedded/meta-filesystems \ | 375 | /path/to/poky/meta-openembedded/meta-filesystems \ |
@@ -382,8 +412,8 @@ BBLAYERS ?= " \ | |||
382 | <para>As a result, <filename>BBLAYERS</filename> shall be extended with | 412 | <para>As a result, <filename>BBLAYERS</filename> shall be extended with |
383 | 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. |
384 | For details on how to do this, see the <ulink | 414 | For details on how to do this, see the <ulink |
385 | 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 |
386 | 2.3 Dev Manual, section "Understanding and Creating Layers"</ulink> . If | 416 | 2.5 Dev Manual, section "Understanding and Creating Layers".</ulink> If |
387 | needed replace the Yocto version.</para> | 417 | needed replace the Yocto version.</para> |
388 | 418 | ||
389 | <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 |
@@ -410,10 +440,10 @@ BBLAYERS ?= " \ | |||
410 | <title>Adding a Recipe</title> | 440 | <title>Adding a Recipe</title> |
411 | 441 | ||
412 | <para>Study the <ulink | 442 | <para>Study the <ulink |
413 | 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"><ulink |
414 | url="https://www.yoctoproject.org/docs/2.3/dev-manual/dev-manual.html#new-recipe-single-c-file-package-hello-world">Hello | 444 | url="https://www.yoctoproject.org/docs/2.5/dev-manual/dev-manual.html#new-recipe-single-c-file-package-hello-world">Hello |
415 | World recipe</ulink></ulink> in the Yocto Project Development Manual. If | 445 | World recipe</ulink></ulink> in the Yocto Project Development Manual. If |
416 | needed replace the example version (2.3) with the Yocto version in your | 446 | needed replace the example version (2.5) with the Yocto version in your |
417 | Enea Linux distribution.</para> | 447 | Enea Linux distribution.</para> |
418 | </section> | 448 | </section> |
419 | 449 | ||
@@ -646,7 +676,7 @@ $ ./enea-*-toolchain-<version>.sh</programlisting> | |||
646 | 676 | ||
647 | <para>Example:</para> | 677 | <para>Example:</para> |
648 | 678 | ||
649 | <programlisting>$ . /opt/enea/environment-setup-aarch64-enea-linux</programlisting> | 679 | <programlisting>$ . /opt/enea/environment-setup-corei7-64-enea-linux</programlisting> |
650 | </listitem> | 680 | </listitem> |
651 | </orderedlist> | 681 | </orderedlist> |
652 | 682 | ||
@@ -663,8 +693,8 @@ $ ./enea-*-toolchain-<version>.sh</programlisting> | |||
663 | image in a consistent way, e.g. to install, upgrade, or delete packages | 693 | image in a consistent way, e.g. to install, upgrade, or delete packages |
664 | considering the dependencies. The package management systems supported by | 694 | considering the dependencies. The package management systems supported by |
665 | Enea Linux are described in this section. More information about PMS can | 695 | Enea Linux are described in this section. More information about PMS can |
666 | be found in the Yocto 2.3 document <ulink | 696 | be found in the Yocto 2.5 document <ulink |
667 | url="http://www.yoctoproject.org/docs/2.3/mega-manual/mega-manual.html">Yocto | 697 | url="http://www.yoctoproject.org/docs/2.5/mega-manual/mega-manual.html">Yocto |
668 | Project Mega Manual</ulink>. If needed replace the Yocto version in the | 698 | Project Mega Manual</ulink>. If needed replace the Yocto version in the |
669 | link.</para> | 699 | link.</para> |
670 | 700 | ||
@@ -672,7 +702,7 @@ $ ./enea-*-toolchain-<version>.sh</programlisting> | |||
672 | <title>APT Package Management (DEB Packages)</title> | 702 | <title>APT Package Management (DEB Packages)</title> |
673 | 703 | ||
674 | <para>Enea Linux provides DEB packages on <ulink | 704 | <para>Enea Linux provides DEB packages on <ulink |
675 | url="http://linux.enea.com/EneaLinux7.0/">linux.enea.com</ulink> site, | 705 | url="http://linux.enea.com/EneaLinux8.0/">linux.enea.com</ulink> site, |
676 | in directory | 706 | in directory |
677 | <literal><literal><release>/<target>/deb</literal>/</literal>.</para> | 707 | <literal><literal><release>/<target>/deb</literal>/</literal>.</para> |
678 | 708 | ||
@@ -773,4 +803,4 @@ ptest-runner-dev - A C program to run all installed ptests - Development files</ | |||
773 | </section> | 803 | </section> |
774 | </section> | 804 | </section> |
775 | </section> | 805 | </section> |
776 | </chapter> \ No newline at end of file | 806 | </chapter> |