From ddccea54b0fc621d293098e83a44202c90cf8a26 Mon Sep 17 00:00:00 2001 From: Sona Sarmadi Date: Mon, 16 Jul 2018 08:27:31 +0200 Subject: Updated User Guide for EL8 Change-Id: If6c77ae013eef18b8988d0e984b8ef0d471a2050 Signed-off-by: Sona Sarmadi --- .../doc/application_development.xml | 4 +- .../doc/eltf_params_updated.xml | 261 ++++++++++++++++----- .../doc/getting_enea_linux.xml | 13 +- .../doc/prerequisites_and_requirements.xml | 4 +- .../doc/using_eclipse.xml | 12 +- .../doc/using_enea_linux.xml | 228 ++++++++++-------- 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"); environment. For this, see . The following section, Use + url="http://www.yoctoproject.org/docs/2.5/sdk-manual/sdk-manual.html#sdk-use-devtool-to-add-an-application">Use devtool add to Add an Application, in Yocto Project Software Development Kit (SDK) Developer's Guide, explains how to use devtool to generate recipes from existing application code, edit and build recipes, @@ -279,4 +279,4 @@ NOTE: Your packages are in <SDK_dir>/tmp/deploy/deb - \ No newline at end of file + 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 correct also compared to the "previous" REL VER in pardoc-distro.xml "prev_baseline". - 7 + 8 - 2.3 + 2.5 - pyro + sumo http://www.yoctoproject.org/downloads/core/pyro23 + url="http://www.yoctoproject.org/downloads/core/pyro23">http://www.yoctoproject.org/downloads http://linux.enea.com/EneaLinux7.0 + url="http://linux.enea.com/EneaLinux8.0">http://linux.enea.com/EneaLinux8.0 A programlisting, ID "eltf-repo-cloning-enea-linux". Use $MACHINE/default.xml as parameter, where MACHINE is one of the target @@ -61,7 +61,7 @@ export PATH=~/bin:$PATH mkdir enea-linux cd enea-linux repo init -u git@git.enea.com:linux/manifests/el_manifests-standard.git \ - -b refs/tags/Enea_Linux_7.0_RC4 -m $MACHINE/default.xml + -b refs/tags/Enea_Linux_8.0 -m intel-corei7-64/default.xml repo sync A table with ONE row, only the row with ID @@ -87,78 +87,227 @@ repo sync target parameters in each target subsection table. -
+
Supported Targets with Parameters The section(s) below describe the target(s) supported in this Enea Linux release. -
- MACHINE raspberry pi 3 - Information +
+ MACHINE Information - - - + The table(s) below describes the target(s) supported in this Enea + Linux release. - + + MACHINE Information Intel Xeon D - - - Target official name + + - Raspberry Pi 3 - + + + Component - - Architecture and Description + Description + + - ARM Cortex-A53 (ARMv8) - + + + Target official name - - Link to target datasheet + Intel Xeon D + - See link - to Raspberry Pi's datasheet - + + Architecture and Description - - Poky version + x86-64 + - Git-commit-id: - 2021e95bcd986e5bcfe457da5c3e16d60241d050 - + + Link to target datasheet - - GCC version + Intel + Xeon D datasheet + - 6.3 - + + Poky version - - Linux Kernel Version + Git-commit-id: TBD + - 4.9 - + + GCC version - - Supported Drivers + 7.3 + - Ethernet, I2C, SPI, PCM/I2S, UART, USB, - SD/SDHC/SDXC - + + Linux Kernel Version - - Enea deb folder for downloading DEB packages for this - target + 4.14 + - http://linux.enea.com/EneaLinux7.0/deb - - - - + + Supported Drivers + + Ethernet, RTC, UART + + + + Enea deb folder for downloading DEB packages for this + target + + http://linux.enea.com/EneaLinux8.0/deb + + + +
+ + + MACHINE Information Intel Atom C3000 + + + + + + + Component + + Description + + + + + + Target official name + + Intel Atom C3000 + + + + Architecture and Description + + x86-64 + + + + Link to target datasheet + + Intel + Atom datasheet + + + + Poky version + + Git-commit-id: TBD + + + + GCC version + + 7.3 + + + + Linux Kernel Version + + 4.14 + + + + Supported Drivers + + Ethernet, RTC, UART + + + + Enea deb folder for downloading DEB packages for this + target + + http://linux.enea.com/EneaLinux8.0/deb + + + +
+ + + MACHINE Information Intel NUC Kaby Lake + + + + + + + Component + + Description + + + + + + Target official name + + Intel NUC Kaby Lake + + + + Architecture and Description + + x86-64 + + + + Link to target datasheet + + Intel + NUC Kaby Lake datasheet + + + + Poky version + + Git-commit-id: TBD + + + + GCC version + + 7.3 + + + + Linux Kernel Version + + 4.14 + + + + Supported Drivers + + Ethernet, RTC, UART + + + + Enea deb folder for downloading DEB packages for this + target + + http://linux.enea.com/EneaLinux8.0/deb + + + +
-
\ No newline at end of file +
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 @@ -117,17 +117,6 @@ id_rsa.pub xpointer="element(eltf-getting-repo-install-command/1)" /> - - Define the MACHINE from one of the - targets listed here:Below is the "machine_list" - programlisting in machine_list_generated.xml created by the make - system by extracting from the manifest - - raspberrypi3-64 - - - - Then use the repo command below: @@ -153,4 +142,4 @@ id_rsa.pub etc. When this is done a reference from here should be added. - \ No newline at end of file + 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 Building Enea Linux requires a set of packages to be installed on your Linux development host. The list of required packages is described in the Yocto + url="https://www.yoctoproject.org/docs/2.5/ref-manual/ref-manual.html#required-packages-for-the-host-development-system">Yocto Project reference manual. @@ -98,4 +98,4 @@ Use dash as the default system shell (/bin/sh)? No - \ No newline at end of file + 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 @@ For instructions on how to install Eclipse Oxygen, please refer to the Yocto + url="http://www.yoctoproject.org/docs/2.5/sdk-manual/sdk-manual.html#adt-eclipse">Yocto Project Software Development Kit (SDK) Developer's Guide, chapter 4.3.2.1. Although the instructions listed there currently, refer to the Neon release of Eclipse, the same steps still apply to the Oxygen release, @@ -47,7 +47,7 @@ To install the Yocto Plugins in Eclipse, follow the instructions in chapter + url="http://www.yoctoproject.org/docs/2.5/sdk-manual/sdk-manual.html#adt-eclipse">chapter 4.3.2.1.3.2. of the Yocto Manual, starting with step 8. In step 12 use the local archive that you downloaded previously. @@ -197,7 +197,7 @@ root 329 0.0 0.2 1864824 2600 ? Ssl 12:47 0:08 /usr/sbin/tcf-agent -d -L- -l0

For the Sysroot Location option, specify the path to the target sysroot directory inside the toolchain root location e.g. - <extsdkdir>/tmp/sysroots/aarch64-enea-linux/raspberrypi3-64 + <extsdkdir>/tmp/sysroots/corei7-64-enea-linux/ @@ -221,9 +221,9 @@ root 329 0.0 0.2 1864824 2600 ? Ssl 12:47 0:08 /usr/sbin/tcf-agent -d -L- -l0

More details on how to configure the cross-compiler can be found in the Yocto + url="http://www.yoctoproject.org/docs/2.5/sdk-manual/sdk-manual.html">Yocto Project Software Development Kit (SDK) Developer's Guide - 2.3. Change the Yocto version in the link if + 2.5. Change the Yocto version in the link if needed. 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

- \ No newline at end of file + 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 @@ $ mkdir enea-linux $ cd enea-linux -$ export MACHINE=<machine> $ repo init -u git@git.enea.com:linux/manifests/el_manifests-standard.git \ - -b refs/tags/Enea_Linux_7.0 -m $MACHINE/default.xml + -b refs/tags/Enea_Linux_8.0 -m $MACHINE/default.xml $ repo sync @@ -101,9 +100,8 @@ $ cd <build_dir>/tmp/deploy/images/<target>/ # Here are the build b $ mkdir enea-linux $ cd enea-linux -$ export MACHINE=<machine> $ repo init -u git@git.enea.com:linux/manifests/el_manifests-standard.git \ - -b refs/tags/Enea_Linux_7.0 -m $MACHINE/default.xml + -b refs/tags/Enea_Linux_8.0 -m $MACHINE/default.xml $ repo sync @@ -173,109 +171,142 @@ $ cd <build_dir>/tmp/deploy/sdk/ # Here is the SDK installer scriptEnea Linux supports multiple booting methods so those will be described in the following sections. -
- Boot from RAM +
+ Boot via PXE using DHCP, TFTP, and NFS servers - This example requires that a TFTP server is set up at IP address - <tftp_server_ip>, and that the server stores - the Enea Linux image files, kernel image, device tree blob and root - filesystem, in /tftpboot/<download_directory>. - Please refer to for more details on - how to install and configure the TFTP server. + Below you find an example of how to boot Enea Linux in a target + supporting PXE. The PXE boot is handled by the target BIOS. - Once you have that in place, run the following commands on the - target: - - ## set tftp server IP -U-Boot> setenv serverip <tftp_server_ip> - -## tftp the image files on the target machine -U-Boot> tftpboot 0x01000000 Image -U-Boot> tftpboot 0x02000000 Image-bcm2837-rpi-3-b.dtb -U-Boot> tftpboot 0x03000000 enea-image-standard-raspberrypi3-64.ext2.gz.u-boot - -## add any other bootargs values if necessary -U-Boot> setenv bootargs "8250.nr_uarts=1 root=/dev/ram rw ramdisk_size=500000 ip=dhcp \ -console=ttyS0,115200" - -## Start boot sequence -U-Boot> booti 0x01000000 0x03000000 0x02000000 -
- -
- Boot from SD card + This requires the setup of DHCP, TFTP and NFS servers on the host. + The DHCP server contains a configuration for the target, found via the + target MAC address, and refers to the TFTP server for the boot image and + to the NFS server for the root file system. - Copy the - enea-image-standard-raspberrypi3-64.rpi-sdimg image - to the SD card using the Linux dd tool or Win32DiskImager in Windows, - and insert it into the RPi. The Raspberry Pi will not start without a - properly formatted SD Card, containing the bootloader, kernel image and - rootfs. - - Below you can find two methods of how to format an SD Card: + DHCP server: In addition to + general DHCPD configuration, the DHCPD configuration should contain an + entry for the target with the following information about the + target: - + - Format and copy images to the SD card - using the Linux dd command line + Host name + - The dd command copies a file, converting - the format of the data in the process, according to the operands - specified: + + MAC hardware ethernet address (also available in the TFTP + configuration) + - sudo dd bs=4M if=enea-image-standard-sdk-raspberrypi3-64.rpi-sdimg of=/dev/sdg + + IP address, (assuming a fixed IP address is used) + - - Use dd cautiously - improper usage or - entering the wrong values could inadvertently wipe, destroy, or - overwrite the data on your hard drive. - + + The TFTP server shall be defined as + "next-server" - Format the SD card using the - Win32DiskImager program + The relative path in the TFTP server to the PXE file + pxelinux.0 + - - - Download and unzip Win32DiskImager - + + The NFS server IP address and the path to the rootfs on the + NFS server, defined as "option root-path" + + - - Run Win32DiskImager.exe - + Example of a DHCP server configuration: + + host intel-corei7-64_host { + hardware ethernet 01:00:25:90:c8:c5:98; + fixed-address 192.168.1.38; + next-server 192.168.2.10; + filename "intel-corei7-64_tftp/pxelinux.0"; + option root-path "192.168.2.20:/export/intel-corei7-64_rootfs"; +} + + TFTP server: The TFTP path to the + target's pxelinux.0 is given in the DHCP + configuration. Example of files in the TFTP subdirectory indicated by + the DHCP configuration: + + pxelinux.0 +vesamenu.c32 +boot/device01/bzImage (bootable image file) +pxelinux.cfg/01-00-25-90-c8-c5-98 (Configuration file) + + One configuration file has the same name as the target's MAC + address (but with hyphens instead of a colon). This configuration file + contains a pointer to the bootable image and also a list of command line + arguments to append when the image is started. The same NFS path to the + root file system is both in the DHCP and the TFTP configuration. + + Example of a configuration file: + + default vesamenu.c32 +prompt 0 +timeout 100 + +label device01 + menu label ^EneaLinuxNFS + menu default + kernel boot/device01/bzImage + append root=/dev/nfs nfsmount=192.168.2.20:/export/intel-corei7-64_rootfs ip=dhcp + console=ttyS0,115200 + + NFS server: The NFS server shall + contain an unpacked root file system in the path indicated both in the + DHCP and in the TFTP configuration. + + After configuring the servers, copy files from the build directory + into the correct configured paths: + + + + Ensure the target is not already running an OS, otherwise the + target might attempt to change files on the root file system while + it is populated with new files. + - - Select the drive of your SD card - + + Copy pxelinux.0 and + vesamenu.c32 from the build directory, e.g. + from + <build_dir>tmp/work/corei7-64-enea-linux/syslinux/6.03-r0/image/usr/share/syslinux/. + - - Select the image - enea-image-standard-raspberrypi3-64.rpi-sdimg - + + Copy bzImage from + <build_dir>/tmp/deploy/images/<target>/. + - - Click "Write" and wait for the write to complete - + + Populate the root file system in the NFS directory by + unpacking + enea-image-standard-intel-corei7-64.tar.gz + found at + <build_dir>/tmp/deploy/images/<target>/. + + - - Exit the imager and eject the SD Card - + Boot the target by: - - Plug the card into your Raspberry Pi - - + + + Use the BIOS or boot setup to select PXE boot, if not already + selected. + - - Be careful to select the correct drive. If you choose the - wrong one you may destroy your HDD data. If you are using an SD - Card slot and can't see the drive in the Win32DiskImager window, - try using an affordable external adapter in a USB slot. - + + Reboot the target. - + + + The boot setup menu is usually launched by pressing F12 or ESC + during BIOS power up tests. Look up the manufacturer's documentation for + your board model to find the appropriate key.
@@ -338,8 +369,7 @@ BBLAYERS ?= " \ /path/to/poky/meta-el-common \ /path/to/poky/meta-el-standard \ /path/to/poky/meta-enea-bsp-common \ - /path/to/poky/meta-enea-bsp-<arch> \ - /path/to/poky/meta-fsl-<arch> \ + /path/to/poky/meta-enea-bsp-x86 \ /path/to/poky/meta-openembedded/meta-oe \ /path/to/poky/meta-openembedded/meta-networking \ /path/to/poky/meta-openembedded/meta-filesystems \ @@ -382,8 +412,8 @@ BBLAYERS ?= " \ As a result, BBLAYERS shall be extended with the bsp-layer/s layer for your target and any other additional layer/s. For details on how to do this, see the Yocto - 2.3 Dev Manual, section "Understanding and Creating Layers" . If + url="http://www.yoctoproject.org/docs/2.5/dev-manual/dev-manual.html#understanding-and-creating-layers">Yocto + 2.5 Dev Manual, section "Understanding and Creating Layers". If needed replace the Yocto version. Layers can be added when you initialize the build environment. The @@ -410,10 +440,10 @@ BBLAYERS ?= " \ Adding a Recipe Study the Hello + url="https://www.yoctoproject.org/docs/2.5/dev-manual/dev-manual.html#new-recipe-single-c-file-package-hello-world">Hello World recipe in the Yocto Project Development Manual. If - needed replace the example version (2.3) with the Yocto version in your + needed replace the example version (2.5) with the Yocto version in your Enea Linux distribution. @@ -646,7 +676,7 @@ $ ./enea-*-toolchain-<version>.sh Example: - $ . /opt/enea/environment-setup-aarch64-enea-linux + $ . /opt/enea/environment-setup-corei7-64-enea-linux @@ -663,8 +693,8 @@ $ ./enea-*-toolchain-<version>.sh image in a consistent way, e.g. to install, upgrade, or delete packages considering the dependencies. The package management systems supported by Enea Linux are described in this section. More information about PMS can - be found in the Yocto 2.3 document Yocto + be found in the Yocto 2.5 document Yocto Project Mega Manual. If needed replace the Yocto version in the link. @@ -672,7 +702,7 @@ $ ./enea-*-toolchain-<version>.sh APT Package Management (DEB Packages) Enea Linux provides DEB packages on linux.enea.com site, + url="http://linux.enea.com/EneaLinux8.0/">linux.enea.com site, in directory <release>/<target>/deb/. @@ -773,4 +803,4 @@ ptest-runner-dev - A C program to run all installed ptests - Development files - \ No newline at end of file + -- cgit v1.2.3-54-g00ecf