From a6d4e68bf121a3d0e1e626f4d288ad2b594947e2 Mon Sep 17 00:00:00 2001 From: Sona Sarmadi Date: Tue, 28 Aug 2018 07:11:55 +0200 Subject: First draft of doc copied from standard profile -updated rel-info -updated UG -added new chapterdoc for RT: Real-Time in Enea Linux Change-Id: If8cec0e29d1d6aa4a09507881d815af13dd68ee2 Signed-off-by: Sona Sarmadi --- .../doc/about_release.xml | 235 +++++++++++++ doc/book-enea-linux-release-info/doc/book.xml | 22 ++ .../doc/build_boot_template.xml | 34 ++ .../doc/eltf_params_template.xml | 151 +++++++++ .../doc/eltf_params_updated.xml | 282 +++++++++++++++ .../eltf_params_updated_template_how_to_use.txt | 320 +++++++++++++++++ .../doc/getting_enea_linux.xml | 185 ++++++++++ .../doc/jiraissues_override.xml | 32 ++ .../doc/known_bugs_and_limitations.xml | 377 +++++++++++++++++++++ .../doc/main_changes.xml | 54 +++ .../doc/prerequisites.xml | 34 ++ .../doc/system_requirements.xml | 159 +++++++++ doc/book-enea-linux-release-info/swcomp.mk | 10 + 13 files changed, 1895 insertions(+) create mode 100644 doc/book-enea-linux-release-info/doc/about_release.xml create mode 100644 doc/book-enea-linux-release-info/doc/book.xml create mode 100644 doc/book-enea-linux-release-info/doc/build_boot_template.xml create mode 100644 doc/book-enea-linux-release-info/doc/eltf_params_template.xml create mode 100644 doc/book-enea-linux-release-info/doc/eltf_params_updated.xml create mode 100644 doc/book-enea-linux-release-info/doc/eltf_params_updated_template_how_to_use.txt create mode 100644 doc/book-enea-linux-release-info/doc/getting_enea_linux.xml create mode 100644 doc/book-enea-linux-release-info/doc/jiraissues_override.xml create mode 100644 doc/book-enea-linux-release-info/doc/known_bugs_and_limitations.xml create mode 100644 doc/book-enea-linux-release-info/doc/main_changes.xml create mode 100644 doc/book-enea-linux-release-info/doc/prerequisites.xml create mode 100644 doc/book-enea-linux-release-info/doc/system_requirements.xml create mode 100644 doc/book-enea-linux-release-info/swcomp.mk (limited to 'doc/book-enea-linux-release-info') diff --git a/doc/book-enea-linux-release-info/doc/about_release.xml b/doc/book-enea-linux-release-info/doc/about_release.xml new file mode 100644 index 0000000..cb75bc1 --- /dev/null +++ b/doc/book-enea-linux-release-info/doc/about_release.xml @@ -0,0 +1,235 @@ + + + + About This Release + + This release of Enea Linux provides a publicly available + Enea Linux distribution for a selected set of targets. This release is + generated from the Yocto Project distribution using the branch .INFO eltf_params_updated.xml contains many parameters in + the book, also in the open source books, and MUST be created FROM eltf_params_template.xml. + + The parameters are automatically used in the books, via + xi:include statements, similar to how parameters from pardoc-distro.xml are + included in the book. Read the file eltf_params_updated_template_how_to_use.txt for + important details about formats and how to do! The idea is that ELTF will + auto-create/update it. + +
+ Provided Contents + + The current release contains documentation, prebuilt kernels and + images, a bootloader and an SDK. The directories structure is detailed + below: + + -- Documentation/ + /* Enea Linux 8 documentation */ + -- intel-corei7-64/ + /* artifacts for the reference machine */ + -- deb/ + /* deb packages */ + -- images/ + -- enea-image-rt + /* precompiled artifacts for the platform release image */ + -- various artifacts (rootfs, kernel, config, dtb etc.) + -- enea-image-rt-sdk + /* precompiled artifacts for the development process. The image + contains userspace tools and kernel configurations necessary + for developing, debugging and profiling applications and \ + kernel modules */ + -- various artifacts + -- sdk + /* SDK related artifacts including SDK installer and manifests */ + /* self-extracting archive installing cross-compilation + toolchain for the platform */ + -- x86_64-buildtools-nativesdk-standalone-8.0.sh + /* self-extracting archive installing additional tools + for the host machine */ + + The following set of artifacts is available: + + -- Image + /* kernel image */ +-- Image-target.bin + /* kernel image, same as above */ +-- Image-target.dtb + /* the device tree blob */ +-- config-target.config + /* kernel configuration file */ +-- image-name-target.ext3 + /* compressed EXT3 image of the rootfs */ +-- image-name-target.tar.bz2 + /* tar archive of the image */ +-- modules-<target>.tgz + /* external kernel modules */ +
+ +
+ Supported Host Environment + + The following environments have been validated as host environments + for this release of Enea Linux: Ubuntu 16.04 LTS, + 64-bit. + + INFO Below is a complete section with ID + "eltf-target-tables-section" included from elft_params_updated.xml. It + contains a variable number of target tables and the section title should + be "Supported Targets with Parameters". It has have a short sentence about + what it is in the beginning. The subtitles shall have the directory name + of the target in the manifest. +
+ + + +
+ Provided Packages + + + + + + + + + + Type of Packages + + Reference + + + + + + Packages in Enea Linux + + See the Enea Linux Open Source + Report + + + + +
+ +
+ Provided Toolchains (SDK) + + The SDK contains toolchains supporting cross-compilation of + applications for the targets on an aarch64 host. For information on how to + build and install a toolchain, see the chapter Using Enea Linux, in the . +
+ +
+ Provided Documentation + + The following Enea Linux manuals are available: + + + + Enea Linux Release + Information (this document) + + + + Enea Linux User's Guide + + + + Enea Linux Open Source + Report + + + + Enea Linux Test + Report + + + + Enea Linux Security + Report + + + + Enea Linux Real-Time Guide + + +
+ +
+ Other Provided Functionality + + The functionality in a distribution depends on included packages in + the default image. In addition to the supported features, the following + functionality is also available, among other:INFO: This section + might be hidden by setting condition hidden on the section, MANUALLY in + this file + + + + APT Package Management + + + + Eclipse ADT (excl. QEMU) and plug-ins for application + development: LTTng, Perf, LatencyTOP, PowerTOP, SystemTap + + +
+ +
+ Security Fixes + + See the List of + CVEs addressed in Enea Linux for details. +
+ +
+ Intentional Limitations + + The following functionality supported in other Enea Linux releases + has been excluded in this release:INFO: This section might be + hidden by setting condition hidden on the section, MANUALLY in this + file. + + Eclipse plug-ins for image creation (HOB) + + + + Networking features: DPDK vSwitch, DPDK + + + + Real-time features: Fully Preemptible Kernel (FPK) from the + PREEMPT_RT patch + + + + Memory features: NUMA + + +
+ diff --git a/doc/book-enea-linux-release-info/doc/book.xml b/doc/book-enea-linux-release-info/doc/book.xml new file mode 100644 index 0000000..13aff10 --- /dev/null +++ b/doc/book-enea-linux-release-info/doc/book.xml @@ -0,0 +1,22 @@ + + +]> + + <trademark class="registered">Enea</trademark> Linux Release Information + Release Version + + + + + + + + + diff --git a/doc/book-enea-linux-release-info/doc/build_boot_template.xml b/doc/book-enea-linux-release-info/doc/build_boot_template.xml new file mode 100644 index 0000000..e39dd81 --- /dev/null +++ b/doc/book-enea-linux-release-info/doc/build_boot_template.xml @@ -0,0 +1,34 @@ + + + + Target Specific Instructions + + If the source has been fetched (), there will be a target specific README + file containing the build and boot instructions. To make it easier for the + reader, the contents of this file(s) have been extracted into the following + sections. + + + The build process duration may vary and be longer than expected in + some cases, depending on the individual build resources and parameters of + each target/machine supported in this release. + + + NOTE: Only EDIT THE TEMPLATE build_boot_template.xml file here + and also only edit the manifest template ".README" (name starting by a dot)! + A new build_boot_generated.xml file is created from the template and + sections are added below automatically from the README files for each target + when building the book! Only in the template file you see a line below with + SCRIPT_...._HERE and the text telling that this is a template + file. + + SCRIPT_INCLUDES_BUILD_BOOT_SECTIONS_HERE + + This is a template file which you can edit. When + the book is built, a new XML chapter file is created where the above part of + this file is copied to the new XML file and all from the line above is + replaced automatically by build and boot sections from the README + files! + \ No newline at end of file diff --git a/doc/book-enea-linux-release-info/doc/eltf_params_template.xml b/doc/book-enea-linux-release-info/doc/eltf_params_template.xml new file mode 100644 index 0000000..278ad71 --- /dev/null +++ b/doc/book-enea-linux-release-info/doc/eltf_params_template.xml @@ -0,0 +1,151 @@ + + +
+ File with Parameters in the Book Auto-updated by ELFT + + + See the eltf_params_updated_template_howto_use.txt text + file for description of how to create the final eltf_params_updated.xml from this template and for + all REQUIREMENTS. Use the command + "make eltf" to extract a full list of all + ELTF variables, which always begins with ELTF_ and don't only rely on the + howto text file list! The plan is that ELTF will auto-update this when + needed. + + +
+ Common Parameters + + A programlisting, ID + "eltf-prereq-apt-get-commands-host" + + ELTF_PL_HOST_PREREQ + + A programlisting, ID + "eltf-getting-repo-install-command" + + ELTF_PL_GET_REPO + + Several phrase elements, various IDs. Ensure EL_REL_VER is + correct also compared to the "previous" REL VER in pardoc-distro.xml + "prev_baseline". + + ELTF_EL_REL_VER + + ELTF_YOCTO_VER + + ELTF_YOCTO_NAME + + ELTF_YOCTO_PROJ_DOWNLOAD_TXTURL + + ELTF_EL_DOWNLOAD_TXTURL + + A programlisting, ID "eltf-repo-cloning-enea-linux". Use + $MACHINE/default.xml as parameter, where MACHINE is one of the target + directory names in the manifest. + + ELTF_PL_CLONE_W_REPO + + A table with ONE row, only the row with ID + "eltf-eclipse-version-row" is included in the book. MANUALLY BOTH in the + template.xml and in the updated.xml, set condition hidden on the + <row>, if eclipse is not in the release. + + + + + + Eclipse version ELTF_ECLIPSE_VERSION plus command line + development tools are included in this Enea Linux release. + + + + + + Below is one big section with title "Supported Targets with + Parameters". The entire section is included completely in the book via ID + "eltf-target-tables-section" and shall be LAST in the template. The + template contains ONE target subsection. COPY/APPEND it, if multiple + targets exist in the release and optionally add rows with additional + target parameters in each target subsection table. +
+ +
+ Supported Targets with Parameters + + The tables below describes the target(s) supported in this Enea + Linux release. + +
+ MACHINE ELTF_T_MANIFEST_DIR - Information + + + + + + + + + + Target official name + + ELTF_T_NAME + + + + Architecture and Description + + ELTF_T_ARC_DESC + + + + Link to target datasheet + + See ELTF_T_DS_TXTURL + + + + Poky version + + ELTF_T_POKY_VER + + + + GCC version + + ELTF_T_GCC_VER + + + + Linux Kernel Version + + ELTF_T_KERN_VER + + + + Supported Drivers + + ELTF_T_DRIVERS + + + + Enea rpm folder for downloading RPM packages for this + target + + ELTF_T_EL_RPM_TXTURL + + + + +
+ + +
+
\ No newline at end of file diff --git a/doc/book-enea-linux-release-info/doc/eltf_params_updated.xml b/doc/book-enea-linux-release-info/doc/eltf_params_updated.xml new file mode 100644 index 0000000..dfcee4a --- /dev/null +++ b/doc/book-enea-linux-release-info/doc/eltf_params_updated.xml @@ -0,0 +1,282 @@ + + +
+ File with Parameters in the Book Auto-updated by ELFT + + + See the eltf_params_updated_template_howto_use.txt text + file for description of how to create the final eltf_params_updated.xml from this template and for + all REQUIREMENTS. Use the command + "make eltf" to extract a full list of all + ELTF variables, which always begins with ELTF_ and don't only rely on the + howto text file list! The plan is that ELTF will auto-update this when + needed. + + +
+ Common Parameters + + A programlisting, ID + "eltf-prereq-apt-get-commands-host" + + # Host Ubuntu 16.04.2 LTS 64bit +sudo apt-get -y update +sudo apt-get -y install sed wget subversion git-core coreutils unzip texi2html \ + texinfo libsdl1.2-dev docbook-utils fop gawk python-pysqlite2 diffstat \ + make gcc build-essential xsltproc g++ desktop-file-utils chrpath \ + libgl1-mesa-dev libglu1-mesa-dev autoconf automake groff libtool xterm \ + libxml-parser-perl + + A programlisting, ID + "eltf-getting-repo-install-command" + + mkdir -p ~/bin +curl https://storage.googleapis.com/git-repo-downloads/repo > ~/bin/repo +chmod a+x ~/bin/repo +export PATH=~/bin:$PATH + + Several phrase elements, various IDs. Ensure EL_REL_VER is + correct also compared to the "previous" REL VER in pardoc-distro.xml + "prev_baseline". + + 8 + + 2.5 + + sumo + + http://www.yoctoproject.org/downloads + + 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 + directory names in the manifest. + + mkdir enea-linux +cd enea-linux +repo init -u git@git.enea.com:linux/manifests/el_manifests-rt.git \ + -b refs/tags/Enea_Linux_8.0 -m $MACHINE/default.xml +repo sync + + A table with ONE row, only the row with ID + "eltf-eclipse-version-row" is included in the book. MANUALLY in book, set + condition hidden if eclipse is not in the release. + + + + + + Eclipse version 4.7 (Oxygen) plus command line development + tools are included in this Enea Linux release. + + + + + + Below is one big section with title "Supported Targets with + Parameters". The entire section is included completely in the book via ID + "eltf-target-tables-section" and shall be LAST in the template. The + template contains ONE target subsection. COPY/APPEND it, if multiple + targets exist in the release and optionally add rows with additional + target parameters in each target subsection table. +
+ +
+ Supported Reference Boards with Parameters + + The table(s) below describes the target(s) supported in this Enea + Linux release. + + + MACHINE Information Intel Xeon D + + + + + + + Component + + Description + + + + + + Target official name + + Intel Xeon D + + + + Architecture and Description + + x86-64 + + + + Link to target datasheet + + Intel + Xeon D datasheet + + + + Poky version + + Git-commit-id: TBD + + + + GCC version + + 7.3 + + + + Linux Kernel Version + + 4.14 + + + + Supported Drivers + + Ethernet, RTC, UART + + + +
+ + + 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 + + + +
+ + + 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 + + + +
+
+
diff --git a/doc/book-enea-linux-release-info/doc/eltf_params_updated_template_how_to_use.txt b/doc/book-enea-linux-release-info/doc/eltf_params_updated_template_how_to_use.txt new file mode 100644 index 0000000..6e1358f --- /dev/null +++ b/doc/book-enea-linux-release-info/doc/eltf_params_updated_template_how_to_use.txt @@ -0,0 +1,320 @@ +eltf_params_template_updated_howto_use.txt + +This is a way to collect all parameters for an Enea Linux release +in one parameter file, easy to automatically update by ELTF regularly. + +NOTE: Both the release info AND the open source books use parameters from + here, but the XML file is inside the release info book directory. + +NOTE: The manifest_conf.mk, or overridden by the environment variable + MANIFESTHASH, contains the full tag (or hashvalue) for downloading + the manifest when the books are built. The list of target + directories are fetched from the manifest into the book. + The eltf_params_updates.xml can all the time contain + the final next complete tag e.g. refs/tags/EL6 or similar + in the ELTF_PL_CLONE_W_REPO parameter command lines. + +The ordinary book XML files use xi:include statements to include elements +from this parameter file. The book XML files can thus be manually edited. +Before editing, you must run "make init". +Any other text in the template or updated.xml file, outside the parts that +are included in the book, are not used but still all must be correct +DocBook XML files. + +ELTF work: + template => ELTF replaces ALL ELTF_xxx variables => updated XML file + => push to git only if changed + + +eltf_params_template.xml (in git) + File used by ELTF to autocreate/update the real parameter + file eltf_params_updated.xml. + +eltf_params_updated.xml (in git) + Real parameter file where ELTF has replaced all ELTF_xx variables with + strings, in several cases with multiline strings. + No spaces or linefeed allowed in beginning or end of the variable values! + + +xi:include: Each parameter is xi:include'ed in various book files, using + the IDs existing in the parameter files. + In most cases the 1:st element inside an element with an ID is included + using a format like eltf-prereq-apt-get-commands-host/1. + In very few cases the element with the ID is included in the book, one + example is the target section which has an ID, but which contains + multiple subsections, one per target. + All IDs in a book must be unique. + +DocBook XML: All XML files must be correct DocBook XML files. + +Do NOT edit/save the real *updated.xml file with XMLmind to avoid changes + not done by ELTF. But it is OK to open the real file in XMLmind to + check that the format is correct. + +ELTF should autocreate a temporary "real" file but only replace + and push the eltf_params_updated.xml if it is changed. + + +make eltf + This lists all ELTF_xxx variables and some rules how to treat them + +DocBook Format: All elements - rules: + Several strict generic XML rules apply for all strings: + 1. No TABs allowed or any other control chr than "linefeed" + 2. Only 7-bit ASCII + 3. Any < > & must be converted to < > and & + Similar for any other non-7-bit-ASCII but avoid those! + 4. No leading spaces or linefeeds when replacing the ELTF_* variable + 5. No trailing spaces or linefeeds when replacing the ELTF_* variable + 6. Note: Keep existing spaces before/efter ELTF_* in a few cases. + +DocBook Format: - rules: ELTF*PL* variables + Several strict rules apply for the multiline string in programlisting + in addition to the general XML rules above: + 7. Max line length < 80 char + 8. Use backslash (\) to break longer lines + 9. Use spaces (e.g. 4) to indent continuation lines in programlistings + 10. No trailing spaces on any line + 11. No spaces or linefeed immediately after leading + 12. No spaces or linefeed before trailing + +DocBook Format: - rules: ELTF_*URL* variables + 13. ELTF_*URL and corresponding ELTF_*TXTURL shall be identical strings + 14. Only if the URL is extremely long, the TXTURL can be a separate string + +Each target has one section with target parameters: +
+ MACHINE ELTF_T_MANIFEST_DIR - Information + ..... with many ELTF_ variables .... +
+ + 15. If there is only one target. ELTF just replaces ELTF parameters + + 16. It there are multiple targets. ELTF copies the section and appends the + section the required number of times. + Each section ID will become unique: eltf-target-table-ELTF_T_MANIFEST_DIR + Each section title will become unique + +Tables with target parameters in each target section: + 17. It is possible for ELTF to append more rows with one parameter each + to these tables, because the entire tables are included in the book + +Special - NOT YET READY DEFINED how to handle the optionally included + Eclipse and its version, but this is a first suggestion: + 18. Just now ELTF can define ELFT_ECLIPSE_VERSION as a full string + with both version number and name, + 19. MANUALLY if Eclipse is NOT included in the release, + the release manager should manually set condition="hidden" on + the entire section in the book XML about Eclipse + + + +BELOW WE TRY TO EXPLAIN EACH ELTF_* variable, but always check with make eltf +if there are more new variables, missing in this description file. + +_____________________________________________________________________________ +ELTF_PL_HOST_PREREQ Multiline list of host prerequisites, e.g. commands + like sudo apt-get install xxxx or similar. + First line = comment with the complete host name! + It is possible to include multiple hosts by just + adding an empty line, comment with host name, etc. + xi:include eltf-prereq-apt-get-commands-host/1 + This is a ... + Example: +# Host Ubuntu 14.04.5 LTS 64bit +sudo apt-get update +sudo apt-get install sed wget subversion git-core coreutils unzip texi2html \ + texinfo libsdl1.2-dev docbook-utils fop gawk python-pysqlite2 diffstat \ + make gcc build-essential xsltproc g++ desktop-file-utils chrpath \ + libgl1-mesa-dev libglu1-mesa-dev autoconf automake groff libtool xterm \ + libxml-parser-perl + +_____________________________________________________________________________ +ELTF_PL_GET_REPO Multiline commands to download the repo tool + xi:include eltf-getting-repo-install-command/1 + This is a ... + Example: +mkdir -p ~/bin +curl https://storage.googleapis.com/git-repo-downloads/repo > ~/bin/repo +chmod a+x ~/bin/repo +export PATH=~/bin:$PATH + +_____________________________________________________________________________ +ELTF_EL_REL_VER General parameter string: The version of this Enea + Linux release. Major version and optional .Minor + Typically created from MAJOR and MINOR in enea.conf + MINOR in enea.conf is empty or contains a dot+minor + xi_include EneaLinux_REL_VER/1 + This is a X.x used in many places. + Examples: +6 + or +6.1 + +_____________________________________________________________________________ +ELTF_YOCTO_VER General parameter string: Yocto version, created + from DISTRO in poky.ent + xi:include Yocto_VER/1 + This is a X.x used in many places. + Example: +2.5 + +_____________________________________________________________________________ +ELTF_YOCTO_NAME General parameter string: Yocto name (branch), created + from DISTRO_NAME_NO_CAP in poky.ent + xi:include Yocto_NAME/1 + This is a X.x used in many places. + Example: +sumo + +_____________________________________________________________________________ +ELTF_YOCTO_PROJ_DOWNLOAD_TXTURL General parameters. These two are IDENTICAL +ELTF_YOCTO_PROJ_DOWNLOAD_URL strings with correct Yocto version string + at the end, typically without "dot". + xi:include ULINK_YOCTO_PROJECT_DOWNLOAD/1 + This is an ... + Example: +http://www.yoctoproject.org/downloads + +_____________________________________________________________________________ +ELTF_EL_DOWNLOAD_TXTURL General parameters. These two are IDENTICAL strings +ELTF_EL_DOWNLOAD_URL and shall be the http:/..... address where + Enea Linux can be downloaded + Often containing same version as in ELTF_EL_REL_VER + xi:include ULINK_ENEA_LINUX_URL/1 + This is an ... + Example: +http://linux.enea.com/8 + +_____________________________________________________________________________ +ELTF_PL_CLONE_W_REPO Multiline commands to run repo to clone everything. + Use the variable $MACHINE/default.xml (the text in + the book will list the avaiable values of MACHINE, + taken from the manifest repository) + xi:include eltf-repo-cloning-enea-linux/1 + This is a ... + Example: +mkdir enea-linux +cd enea-linux +repo init -u git@git.enea.com:linux/manifests/el_manifests-rt.git \ + -b refs/tags/EL8 -m $MACHINE/default.xml +repo sync + +_____________________________________________________________________________ +ELTF_ECLIPSE_VERSION Optional general parameter string. + NOT YET READY DEFINED + Just now a release manage must manually set + condition="hidden" on the Eclipse section, + if Eclipse is not included in the release. + ELTF just replaces ELTF_ECLIPSE_VERSION with a full + string with "X.Y (name)" + It includes the ID and can only be ONCE in the book. + xi:include eltf-eclipse-version-row + Example. +4.5 (Mars) + + +_____________________________________________________________________________ +ELTF_T_* All these are in each target (MACHINE) and ELTF + must separately replace them with strings for + each target + NOTE: All (except the MANIFEST_DIR) are in rows + in a table and ELTF can select to append + more parameters by adding more rows + +_____________________________________________________________________________ +ELTF_T_MANIFEST_DIR This happens to be in two places. Must be exactly +ELTF_T_MANIFEST_DIR the directory name in the manifest, e.g. same + as the MACHINE names in $MACHINE/default.xml. + In book: a) Part of section ID + b) Part of section title + Examples: +p2041rgb + or +ls1021aiot + or +qemuarm + +_____________________________________________________________________________ +ELTF_T_NAME Target specific: "Target Official Name" + NOT same as the target directory name in most cases. + In book: An element in a row + Examples: +P2041RGB + or +LS1021a-IoT + or +qemuarm + +_____________________________________________________________________________ +ELTF_T_ARC_DESC Target specific: "Architecture and Description" + It can be a short identification string or + it can be a longer descriptive sentence. + In book: An element in a row + Examples: +Power, e500mc + or +ARM Cortex-A7 + +_____________________________________________________________________________ +ELTF_T_DS_TXTURL Target specific: "Link to target datasheet. These +ELTF_T_DS_URL two usually are IDENTICAL strings with correct + hyperlink to the target's official datasheet. + In book: an ... + Only if the link is VERY LONG, the text part shall + instead be a descriptive string (see 2:nd example). + NOTE: Also here no spaces or line-feeds! + Examples: +url="http://wiki.qemu.org">http://wiki.qemu.org +or +url="http://www.nxp.com/products/microcontrollers-and-processors/arm-processors/qoriq-arm-processors/qoriq-ls1021a-iot-gateway-reference-design:LS1021A-IoT">link to NXP's datasheet + +_____________________________________________________________________________ +ELTF_T_POKY_VER Target specific: "Poky version" created either + from POKYVERSION in poky.ent + or using a hashvalue with a leading string, in + which case it may be different per target. + In book: An in a row + Examples: +15.0.0 +or +Git commit id: 75ca53211488a3e268037a44ee2a7ac5c7181bd2 + +_____________________________________________________________________________ +ELTF_T_GCC_VER Target specific: "GCC Version". Should be in poky + but not easy to find among various parameters. + ELTF would extract it from build logs building SDK + and it is possibly different per target. + In book: An in a row + Example: +5.3 + +_____________________________________________________________________________ +ELTF_T_KERN_VER Target specific: "Linux Kernel Version". Often + different per target. + In book: An in a row + Example: +3.12 + +_____________________________________________________________________________ +ELTF_T_DRIVERS Target specific: "Supported Drivers". This is a + comma-separated list of driver names. + ELTF should create the list in same order for each + target, e.g. alphabetic migth be OK. + In book: An in a row + Example: +Ethernet, I2C, SPI, PCI, USB, SD/SDHC/SDXC + + +_____________________________________________________________________________ +ELTF_T_EL_RPM_TXTURL Target specific: "Enea rpm folder for downloading +ELTF_T_EL_RPM_URL RPM packages for this target". These two are + INDENTICAL strings with hyperlink to the web site + at Enea where the customer can download RPMs + Note: Often the ELFT_EL_REL_VER value and + the ELTF_T_MANIFEST_DIR are used in the link. + In book: an ... + Example: +url="https://linux.enea.com/6/ls1021aiot/rpm">https://linux.enea.com/6/ls1021aiot/rpm + +_____________________________________________________________________________ diff --git a/doc/book-enea-linux-release-info/doc/getting_enea_linux.xml b/doc/book-enea-linux-release-info/doc/getting_enea_linux.xml new file mode 100644 index 0000000..76487ef --- /dev/null +++ b/doc/book-enea-linux-release-info/doc/getting_enea_linux.xml @@ -0,0 +1,185 @@ + + + + Getting Enea Linux + + Enea Linux is available as both pre-built binary images and source + code. Both serve a specific purpose and each have their advantages. However, + using the pre-built binary images allows for getting up and running faster. + Please refer to the sections below for details on how to get Enea Linux as + pre-built binary images or source code. + +
+ Getting Pre-built Binaries + + Enea Linux pre-built binaries are available for download on portal.enea.com. + Log in using the credentials provided by Enea for your user account. Using + the menu, browse to the Linux section where you will now have access to + the Files and Online Documentation sections. + + The Files section lists each Enea Linux distribution, one for each + version and profile, as a separate download package. Clicking on the name + of the distribution will open a new page, which presents further details + about the content of the release and a list of downloadable archives, one + for each hardware target included in the release. Each archive provides + the following content: + + + + images directory – this directory + includes the binary image files needed to boot the target with Enea + Linux. This includes the kernel, the root file system, device tree, + etc. + + + + sdk directory – this directory + includes the installer for the SDK. + + + + deb directory – this directory + contains all the packages included in the distribution in deb format, + which can be installed using the package manager. + + + + For faster downloads, each archive is mirrored in several places, + geographically. Choose the archive in the region closest to you. + + The Documentation section lists all the documents delivered with the + release: + + + + Enea Linux User’s Guide - + intended for Enea Linux platform developers, who want to configure and + build customized Linux kernel images for embedded system targets, + using the Yocto configuration and build system. + + + + Enea Linux Open Source Report - + contains the open source and license information pertaining to + packages provided with this release of Enea Linux. + + + + Enea Linux Release Info - + provides information about the current released distribution for a + selected set of targets, along with installation requirements and + procedures. + + +
+ +
+ Getting the Sources + + Enea Linux sources are available for cloning from a set of Git + repositories on git.enea.com. + Since Enea Linux requires multiple repositories, Google Repo tool is used + in order to manage configurations and make the cloning step simpler. The + Google Repo tool uses files, known as manifests, which store a list of + tuples (repository URL, version). The Repo tool is then used to traverse + the list of tuples in the manifest file and clone the specified versions + of each repository. See Google Code Archive for + git-repo, for more info. + +
+ Get access to git.enea.com + + In order to get access to git.enea.com, a ssh key is required for + Git authentication. If you don't already have such a key, follow the + steps below to generate one: + + + + Generate the ssh key pair: + + $ ssh-keygen -t rsa + + When asked for a password, just press + Enter. This will create two files in the + .ssh directory in your home directory. + + id_rsa +id_rsa.pub + + + + Copy the public key into an authorized_keys file: + + $ cat id_rsa.pub >> authorized_keys + + + + Once these steps are done and you have a valid ssh key pair, send + the public key, + id_rsa.pub, + via email to mailto:git_support@list.enea.se in order to + get access to git.enea.com. +
+ +
+ Get Sources + + To use the Repo tool to download the sources for Enea Linux, do + the following: + + + + Make sure that the repo tool is installed. If not, do the + following: Below is include of ID + "eltf-getting-repo-install-command" from + eltf_params_updated.xml + + + + + + Define the MACHINE to the following target listed + here:Below is the "machine_list" programlisting in + machine_list_generated.xml created by the make system by extracting + from the manifest + + + + + + Then use the repo command below: + + + + + + Once the source code is downloaded, the current directory will + contain a README file with instructions on how to build the distro and + boot the raspberry pi machine. For ease of use, these instructions are + also copied into this document, see . + + It is not necessary to explicitly clone the manifest repository + since that is done automatically by the repo tool. To see the current + manifest, use the following command: + + $ repo manifest + + The UG should be updated with instructions on how to add + customizations. That section should also contain more info about the + manifest: the manifest templates, using a branch instead of the tag EL6, + 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-release-info/doc/jiraissues_override.xml b/doc/book-enea-linux-release-info/doc/jiraissues_override.xml new file mode 100644 index 0000000..331a5ae --- /dev/null +++ b/doc/book-enea-linux-release-info/doc/jiraissues_override.xml @@ -0,0 +1,32 @@ + + +
+ Extracted from Jira + + In the table below are the issue(s) that currently affect this specific release. Use the ticket reference provided for each issue, to look up further information if needed. + + + + + + + + + + Summary + + Enea Ref + + + + + + + + + + + + +
\ No newline at end of file diff --git a/doc/book-enea-linux-release-info/doc/known_bugs_and_limitations.xml b/doc/book-enea-linux-release-info/doc/known_bugs_and_limitations.xml new file mode 100644 index 0000000..6fafb8d --- /dev/null +++ b/doc/book-enea-linux-release-info/doc/known_bugs_and_limitations.xml @@ -0,0 +1,377 @@ + + + + Known Problems in this Release + + Open source projects are continuously working on correcting reported + problems. Fixes and workarounds to bugs detected by Enea are submitted + upstream, and included in Enea Linux regardless of when they will be + included by the open source project. Issues that still affect the current + release are listed below.INFO: The Release-Specific Problems section further down is + generated from JIRA with gen_known_issues.py, but that script is HARDCODED + with affectedversion "Enea Linux 6" and needs to be adapted when a release + info for another EL version changes. + +
+ Yocto Project + + The Yocto Project community uses a Bugzilla database to track + information on reported bugs and other issues. +
+ +
+ Toolchain / SDK + + + + Building the kernel might fail if GNU Make of version 3.82 has + been installed on the host. The mandatory recovery action is to revert + to version 3.81.INFO It is possible to hide this entire + subsection by setting condition hidden on the section + element + + + + Installing a second toolchain in the same directory as a + previous one will break the $PATH variable of the first + one.LXCR-3624 + + +
+ +
+ Eclipse Tools + + The Eclipse tools provided together with Enea Linux are part of the + Yocto Project Application Development Toolkit (ADT) and are maintained by + different open source projects. The list below outlines current problems + with the plug-ins as such, as well as kernel limitations when using a tool + towards the mentioned target:INFO It is possible to hide this + setting condition hidden on the section element + + + + HOB is currently not supported + on Red Hat.LXCR-2994, LXCR-3222 + + + + SystemTap is currently not + supported on Red Hat.LXCR-3274 + + + + When running SystemTap for the + first time on a target, you may need to manually ssh into the target + beforehand, in order to add the RSA key of the host to the file + known_hosts. Failing to do so will result in Eclipse freezing with the + progress window displayed, and a terminal message The + authenticity of host <target_ip> can't be + established. + + + + SystemTap scripts sometimes + result crosstap error messages about inaccessible variables. This is + not an issue with the tool itself, but stems from the compiler + optimizing away some of the variables. See workaround in the User's + Guide.LXCR-2204 + + + + Currently BitBake Commander + projects can only be created for a local connection. Due to an + upstream bug, selecting a remote connection causes the Eclipse GUI to + freeze such that it must be killed.LXCR-2801 + + + + A limitation currently makes Eclipse non-responding when running a streaming + script, i.e. a script that runs continuously. + + + + The LatencyTop plug-in for the + P2041 target reports some errors due to the permissions configuration + on the target, but it works correctly if the + latencytop command is issued from the Eclipse + console.LXCR-6303 + + + + Currently LatencyTOP is not + available for ARM kernels built with SMP support due to an ARM + specific limitation in the Linux kernel. + + + + PowerTOP sometimes freezes + Eclipse after displaying a progress bar with message + Gathering powertop data file + remotely.LXCR-3143 + + + + When running powertop from the + Eclipse terminal towards p2020rdb targets it is necessary to specify + the full path in order to find the + command.LXCR-2265 + + + + When running powertop from the + Eclipse terminal towards zynq ZC702 targets it is necessary to specify + the full path in order to find the + command.LXCR-2265 + + + + The PowerTOP console in Eclipse + might display messages like Cannot load + /var/cache/powertop/<filename>. As a workaround, run + powertop --calibrate for a while to + generate the missing files. See Bugzilla + #698020.LXCR-3575 + + + + ssh-only is currently the only + supported connection type when running Eclipse tools towards a + target.LXCR-2799 + + + + Hyphen character '-' in the name of the Yocto Project ADT AutoTools project can cause + configuration errors.LXCR-2290 + + + + The LTTng tool does not work on + ARM targets, neither from within + Eclipse nor when run directly on target, due to a problem with + lttng-modules and gcc-4.8.x. See Bugzilla + #6015.LXCR-2653, LXCR-3053 + + + + When running LTTng from + Eclipse, it sometimes happens that a new session created in the + Control View does not immediately appear under Sessions for that + target. However, the session is created and will appear after + right-clicking "Sessions" and selecting "Refresh". + + + + The yocto-bsp properties page + has some problems in the graphical user interface. Occasionally it is + not possible to resize and scroll which makes it impossible to see the + lower part of the properties window.LXCR-3128 + + + + When connecting an Eclipse project configured for KGDB (GDB Hardware Debugging) to a 64-bit + PowerPC target, GDB fails to connect unless the architecture is + specified in .gdbinit. See Bugzilla + #457697.LXCR-3984 + + +
+ +
+ Target-Side Tools + + The target-side tools can be run stand-alone on target or from + Eclipse on host. The issues below are only observed when running the tools + directly on target:INFO It is possible to hide this setting + condition hidden on the section element + + + + The perf report command hangs + or crashes due to segmentation fault on ARM + targets.LXCR-2708 + + + + The perf report does not show + any output for the PandaBoard target.LXCR-2710 + + + + perf top displays for a few + seconds the error message Failed to open + /tmp/perf-388.map. Any attempt to exit the subsequent window + causes the system to hang.LXCR-3113 + + + + When running the perf top command on the i.MX + 6Quad SABRE Lite target, the console text may become red after running + for some time (~ 1 minute).LXCR-3631 + + + + The LTTng tool does not work on + ARM targets, neither from within + Eclipse nor when run directly on target, due to a problem with + lttng-modules and gcc-4.8.x. See Bugzilla + #6015.LXCR-2653, LXCR-3053 + + + + The powertop --calibrate + command does not work on the Keystone k2hk-evm + target.LXCR-2660 + + + + The powertop command run with + --calibrate or --time arguments may show some warnings on + PowerPC targets. + + + + When running powertop on + ARM targets, the following + warning/error is repeated: clk_set_rate: failed to set + i2c0_aper rate . Then powertop stops and the statistics are + no longer updated. What probably happens here is that the cpufreq + governor tries to scale the CPU frequency, but since the I2C clock is + derived from the CPU frequency, the I2C driver implements some policy + to stay within legal frequency limits and rejects the frequency + changes, ending up with the warning message. A fix + has been merged in the linux-xlnx kernel but is not yet propagated + into meta-xilinx.LXCR-3205, LXCR-3106, + LXCR-2660 + + + + If you get an error message like Cannot load from file + /var/cache/powertop/saved_results.powertop when running + powertop, there is most likely not + enough measurement data collected yet. All you have to do is to keep + powertop running for a certain time.LXCR-2176, LXCR-2660, + LXCR-3106 + + + + The message Model-specific registers (MSR) not found + (try enabling CONFIG_X86_MSR) appears when you run powertop on non-x86 targets. powertop is mainly an x86n + tool, so it expects X*^_MSR config to be enabled in the kernel. For + non-x86 targets this config is not available in the kernel, hence, + powertop warns about it, but the message can be ignored on those + targets. LXCR-2176, LXCR-2660, LXCR-3106 + + + + powertop issues a message + sh: /usr/bin/xset: No such file or directory when + it tries to use xset to configure X display preferences but cannot + find the binary since the image by default contains no X system. The + message can simply be ignored.LXCR-2176 + + +
+ +
+ Virtualization + + + + virtualization: CONFIG_BRIDGE + is not included in the default p2020rdb + kernel.LXVTCR-273 + + + + lxc: + + + + User namespace is not available on PowerPC targets as it is + an experimental feature in the 3.8 kernel. + + + + If multiple Linux containers are started from the same + process and share resources, destroying the containers might + result in a race condition with error message "Error in + `./lxc-test-concurrent': double free or corruption (fasttop)" + followed by an application + crash."LXVTCR-365 + + + + + + libvirt: Default network does + not start.LXVTCR-240 + + +
+ +
+ Documentation + + + + PDF navigation: When using + links to open other PDFs, or jump to another place in the same PDF, + jumping back sometimes fails. This has been observed when opening a + PDF in Adobe Reader, inside a browser with PDF add-on, as well as when + the browser is configured to open PDF files in an external PDF reader. + As a workaround, open the HTML version of the + document.LXCR-3283 + + + + Internet Explorer (IE) cannot display some + web pages: It is recommended to use Firefox or another + non-IE browser for opening external links. If you prefer reading the + documentation in PDF format in Adobe Reader (not in an Adobe plug-in + in a browser), remember to configure a non-IE browser as default + browser to be able to follow all links from within Adobe Reader. + Example of a link that does not work in IE: https://rt.wiki.kernel.org/. + LXCR-3281 + + +
+ +
+ Miscellaneous + + + + Running QEMU from an exported + rootfs requires sudo privileges on the host. + + + + menuconfig requires Ncurses. If the terminal that pops up + immediately closes instead of showing the menuconfig interface, check + that the Ncurses development library is installed. + + +
+ + + + + \ No newline at end of file diff --git a/doc/book-enea-linux-release-info/doc/main_changes.xml b/doc/book-enea-linux-release-info/doc/main_changes.xml new file mode 100644 index 0000000..c2279ee --- /dev/null +++ b/doc/book-enea-linux-release-info/doc/main_changes.xml @@ -0,0 +1,54 @@ + + + + Main Changes + + This chapter describes the major changes and additions made to this + release of Enea Linux.INFO Just now Hardcoded previous release + string in this paragraph.The list of changed packages + further down is created from the open source book licenses.xml by the script + gen_pkgdiff.py by comparing with an older open source licenses.xml, + depending on the parameter "prev_baseline" in pardoc-distro.xml, e.g. a tag + like "EL5". This parameter needs to be changed to a new TAG when a release + info for another EL version is created. It must correspond to the release + string above. + +
+ New Functionality/Enhancements + + + + New Yocto + Project version ()INFO Yocto_VER and + ULINK_YOCTO_PROJECT_DOWNLOAD in + eltf_params_updated.xml + + + + New targets: Intel Xeon D, Intel Atom C3000 and Intel NUC Kaby + Lake. + + +
+ +
+ Problems Fixed in this Release + + TBD FIXME or set condition hidden on the section + element +
+ +
+ Added Drivers + + TBD FIXME or set condition hidden on the section + element +
+ + + diff --git a/doc/book-enea-linux-release-info/doc/prerequisites.xml b/doc/book-enea-linux-release-info/doc/prerequisites.xml new file mode 100644 index 0000000..324bb57 --- /dev/null +++ b/doc/book-enea-linux-release-info/doc/prerequisites.xml @@ -0,0 +1,34 @@ + + + + Prerequisites + + Building Enea Linux or compiling applications requires that your git + environment be setup properly and for certain packages to be installed on + your Linux development host. + + Please refer to Getting + Started - First-Time Git Setup, for more details on how to set up + your git environment correctly, including how to set your identity using the + following commands: + + $ git config --global user.name "John Doe" +$ git config --global user.email johndoe@example.com + + First ensure the system is up-to-date, then for the supported + distribution(s), you need the following packages:INFO: The + programlisting below is a parameters in eltf_params_updated.xml with ID: + "eltf-prereq-apt-get-command-host". If multiple hosts are supported, store + the commands for each host in the same programlisting with empty lines + between each - the comment with the FULL HOST name and version is + essential. + + + + + \ No newline at end of file diff --git a/doc/book-enea-linux-release-info/doc/system_requirements.xml b/doc/book-enea-linux-release-info/doc/system_requirements.xml new file mode 100644 index 0000000..cc1248e --- /dev/null +++ b/doc/book-enea-linux-release-info/doc/system_requirements.xml @@ -0,0 +1,159 @@ + + +
+ System Requirements + + The host requirements listed below are extensive to allow for the + building of Linux images via the Yocto system, and not just + applications. + + Please also see the system requirements in the Yocto 2.3 documents: + Yocto + Project Start and the Yocto + Project Reference Manual. If needed, replace the Yocto version in + the links provided with a more recent version. + + + + + + + + + + + + Build host + requirements + system requirements + + + + + Linux distribution + + The downloaded code shall be built on a Linux host to + generate images for your target or for emulation in QEMU. For + information about the supported hosts and targets, see the Enea Linux Release Information in your Enea + Linux distribution. + + + + Internet access + + Internet access must be available when building an image, + since bitbake downloads source files from various servers during the + build. + + + + Packages + + Depending on the Linux distribution and version on host, some + packages may be required, by bitbake for example. You will install + any required packages while following the installation + instructions. + + + + Targets + + Images can be built or downloaded for any of the targets + supported in this release. + + + + Disk space + + Your system should have at least 50 GB of free disk + space when bitbaking the basic enea-image-name kernel image. + For larger images and to allow for future package extensions + and variations in the build process, a minimum of 100 GB free disk + space is recommended. + + + + Recommended RAM + + Your system must have at least 4 GB available + RAM. It is recommended to have 8 GB RAM available for + parallel build jobs. + + + + Java + + Java + java + is required to run Eclipse. Currently, Eclipse + generally recommends at least Java 6 JRE/JDK. More information + regarding operating environments for Eclipse is provided in the + Eclipse + Project Release Notes for the Eclipse version used in this + release. See the Enea Linux Release + Information for the Eclipse Version. + + + + + + The build time depends on the capacity of the processor and other + hardware, available resources, speed of internet connection, load situation, + etc. E.g: on a fast 16 core machine with 16 GB RAM and SSD disks, a complete + build from source could take about two hours. + + + + + + + + + + + + Target + Requirements + + + + External memory + + To boot a CGL + CGL + image, you need at least 16 GB on a hard-disk + drive + HDD + on an eSATA, USB drive, or SD card.INFO: + (packed rootfs 4.5 GB + unpacked rootfs 1.5 GB + good + margins)INFO: NFS does not support SELinux. In + order to have a security-enhanced Linux, one must take off from an + NFS-booted system and proceed with boot from external + memory. + + + + + +
+ System Shell Configuration + + Before installing Enea Linux, ensure that bash is the default + shell. + + If your system runs Ubuntu, you can use ls -l to ensure + /usr/bin is a symbolic link to bash. In case the link + points to dash, which is default in some Ubuntu versions, change it to + bash by running sudo dpkg-reconfigure + dash and answer No to the + question "Use dash as the default system shell (/bin/sh)?": + + # ls -l /bin/sh + lrwxrwxrwx 1 root root 4 2012-03-02 11:53 /bin/sh -> bash +
+
\ No newline at end of file diff --git a/doc/book-enea-linux-release-info/swcomp.mk b/doc/book-enea-linux-release-info/swcomp.mk new file mode 100644 index 0000000..c274604 --- /dev/null +++ b/doc/book-enea-linux-release-info/swcomp.mk @@ -0,0 +1,10 @@ +# Component build specification + +# Version of THIS book +BOOK_VER ?= $(REL_VER)-dev + +DOCBOOK_SRC := $(COMP)/swcomp.mk $(COMP)/doc/book.xml $(shell find $(COMP)/doc -type f \( -name "*.xml" -o -name "*.svg" -o -name "*.png" \) ! -name "book.xml" -print) + +BOOKPACKAGES := book-enea-linux-release-info-rt +BOOKDESC_$(BOOKPACKAGES) := "Enea Linux $(PROD_VER) Release Information" +BOOKDEFAULTCONDITION := $(DEFAULTCONDITIONS) -- cgit v1.2.3-54-g00ecf