path: root/doc/book-enea-linux-release-info/doc/about_release.xml

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<chapter id="relinfo-about-release">
  <title>About This Release</title>

  <para>This release of Enea Linux <xi:include
  href="../../s_docsrc_common/pardoc-distro.xml"
  xmlns:xi="http://www.w3.org/2001/XInclude"
  xpointer="element(EneaLinux_REL_VER/1)" /> provides a publicly available
  Enea Linux distribution for a selected set of targets. This release is
  generated from the yocto distribution using the branch <xi:include
  href="../../s_docsrc_common/pardoc-distro.xml"
  xmlns:xi="http://www.w3.org/2001/XInclude"
  xpointer="element(Yocto_NAME/1)" />.<remark>INFO Yocto distro autopicked
  from poky.ent as DISTRO_NAME_NO_CAP</remark></para>

  <section id="relinfo-provided-contents">
    <title>Provided Contents</title>

    <informaltable>
      <tgroup cols="1">
        <thead>
          <row>
            <entry>Item</entry>
          </row>
        </thead>

        <tbody>
          <row>
            <entry><para>Source code, recipes and scripts for building the
            distribution and SDKs. See <xref
            linkend="relinfo-getting-enea-linux" />.</para></entry>
          </row>

          <row>
            <entry><para>Documentation. See <xref
            linkend="relinfo-documentation" />.</para></entry>
          </row>

          <row>
            <entry>Pre-built binaries (kernel image, dtb &amp; rootfs)</entry>
          </row>

          <row>
            <entry>Pre-built packages (RPM)</entry>
          </row>
        </tbody>
      </tgroup>
    </informaltable>
  </section>

  <section id="relinfo-supported-targets">
    <title>Supported Targets</title>

    <informaltable>
      <tgroup cols="3">
        <colspec align="left" colname="c1" colwidth="1*" />

        <colspec align="left" colname="c2" colwidth="1*" />

        <colspec align="left" colname="c3" colwidth="1*" />

        <thead valign="bottom">
          <row>
            <entry>Target</entry>

            <entry>Architecture</entry>

            <entry>Specification</entry>
          </row>
        </thead>

        <tbody>
          <row>
            <entry>P2041RDB</entry>

            <entry><para>Power, e500mc</para></entry>

            <entry>See <ulink
            url="http://www.nxp.com/products/microcontrollers-and-processors/power-architecture-processors/qoriq-power-architecture-processors/p2041-qoriq-reference-design-board:RDP2041BOARD">link
            to NXP's datasheet</ulink></entry>
          </row>
        </tbody>
      </tgroup>
    </informaltable>

    <para><remark>FIXME should autocreate a list of targets, hopefully from
    the generated README file, by using MAKEFILE to update pardoc-distro
    AND/OR also auto-create an XML file to include here with description text
    for each target etc..</remark></para>
  </section>

  <section id="relinfo-supported-host-environment">
    <title>Supported Host Environment</title>

    <itemizedlist>
      <listitem>
        <para>Ubuntu 14.04 LTS, 64-bit<remark>was
        EneaLinux_HOST_VER</remark></para>
      </listitem>
    </itemizedlist>
  </section>

  <section id="relinfo-supported-versions">
    <title>Supported Versions</title>

    <informaltable>
      <tgroup cols="2">
        <thead valign="bottom">
          <row>
            <entry>Item</entry>

            <entry>Version</entry>
          </row>
        </thead>

        <tbody>
          <row>
            <entry><para>Yocto</para></entry>

            <entry><xi:include href="../../s_docsrc_common/pardoc-distro.xml"
            xmlns:xi="http://www.w3.org/2001/XInclude"
            xpointer="element(Yocto_VER/1)" /> (<xi:include
            href="../../s_docsrc_common/pardoc-distro.xml"
            xmlns:xi="http://www.w3.org/2001/XInclude"
            xpointer="element(Yocto_NAME/1)" />)<remark>INFO: Auto-fetched
            from poky.ent via pardoc-distro.xml</remark></entry>
          </row>

          <row>
            <entry>Poky</entry>

            <entry><para>Git commit id:</para>
            <para>75ca53211488a3e268037a44ee2a7ac5c7181bd2</para><remark>Problem:
            Unfortunately the poky version in poky.ent is not correct unless
            the EL release would be based on a Yocto release, so we can not
            use that here. This is a problem because we don't want to manually
            edit the git commit ID in this file? The poky version in poky.ent
            is just now <xi:include
            href="../../s_docsrc_common/pardoc-distro.xml"
            xmlns:xi="http://www.w3.org/2001/XInclude"
            xpointer="element(Poky_VER/1)" /></remark></entry>
          </row>

          <row>
            <entry>GCC</entry>

            <entry>5.3<remark>was EneaLinux_GCC_VER Not in poky.ent
            </remark></entry>
          </row>

          <row>
            <entry>Linux kernel<remark>was EneaLinux_KERNEL_VER Not in
            poky.ent</remark></entry>

            <entry><para>3.12</para></entry>
          </row>

          <row>
            <entry>Packages</entry>

            <entry>See <xref linkend="relinfo-packages" /></entry>
          </row>
        </tbody>
      </tgroup>
    </informaltable>
  </section>

  <section id="relinfo-packages">
    <title>Provided Packages</title>

    <para><informaltable>
        <tgroup cols="2">
          <colspec align="left" colname="c1" colwidth="3*" />

          <colspec align="left" colname="c2" colwidth="6*" />

          <thead valign="bottom">
            <row>
              <entry>Type of Packages</entry>

              <entry>Reference</entry>
            </row>
          </thead>

          <tbody>
            <row>
              <entry>Packages in Enea Linux</entry>

              <entry><para>See the <olink
              targetdoc="book_enea_linux_open_source"
              targetptr="book_enea_linux_open_source"><trademark
              class="registered">Enea</trademark> Linux Open Source
              Report</olink></para></entry>
            </row>
          </tbody>
        </tgroup>
      </informaltable></para>
  </section>

  <section id="relinfo-provided-sdk">
    <title>Provided Toolchain/s (SDK)</title>

    <para>The SDK contains toolchains supporting cross-compilation of
    applications for the targets on an x86_64 host. See the <olink
    targetdoc="book_enea_linux_app_dev_guide"
    targetptr="book_enea_linux_app_dev_guide"><trademark
    class="registered">Enea</trademark> Linux Application Development
    Guide</olink> for information on how to build and install a
    toolchain.</para>
  </section>

  <section id="relinfo-provided-drivers">
    <title>Supported Drivers</title>

    <informaltable>
      <tgroup cols="2">
        <colspec align="left" colwidth="3*" />

        <colspec align="center" colwidth="2*" />

        <thead>
          <row>
            <entry>Driver</entry>

            <entry>P2041RDB</entry>
          </row>
        </thead>

        <tbody>
          <row>
            <entry>Ethernet</entry>

            <entry>X</entry>
          </row>

          <row>
            <entry>I2C</entry>

            <entry>X</entry>
          </row>

          <row>
            <entry>SPI</entry>

            <entry>X</entry>
          </row>

          <row>
            <entry>PCI Express</entry>

            <entry>X</entry>
          </row>

          <row>
            <entry>USB</entry>

            <entry>X</entry>
          </row>

          <row>
            <entry>Flash</entry>

            <entry>X</entry>
          </row>

          <row>
            <entry>SD/SDHC/SDXC</entry>

            <entry>X</entry>
          </row>

          <row>
            <entry>RTC</entry>

            <entry>X</entry>
          </row>
        </tbody>
      </tgroup>
    </informaltable>
  </section>

  <section id="relinfo-documentation">
    <title>Provided Documentation</title>

    <para>The following Enea Linux manuals are available:</para>

    <itemizedlist spacing="compact">
      <listitem>
        <para><trademark class="registered">Enea</trademark> Linux Release
        Information (this document)</para>
      </listitem>

      <listitem>
        <para><olink targetdoc="book_enea_linux_platforms_dev_guide"
        targetptr="book_enea_linux_platforms_dev_guide"><trademark
        class="registered">Enea</trademark> Linux Platforms Development
        Guide</olink></para>
      </listitem>

      <listitem>
        <para><olink targetdoc="book_enea_linux_app_dev_guide"
        targetptr="book_enea_linux_app_dev_guide"><trademark
        class="registered">Enea</trademark> Linux Application Development
        Guide</olink></para>
      </listitem>

      <listitem>
        <para><trademark class="registered">Enea</trademark> Linux Networking
        Profile Guide</para>
      </listitem>

      <listitem>
        <para><olink targetdoc="book_enea_linux_open_source"
        targetptr="book_enea_linux_open_source"><trademark
        class="registered">Enea</trademark> Linux Open Source
        Report</olink></para>
      </listitem>

      <listitem>
        <para><olink targetdoc="book_enea_linux_eclipse_open_source"
        targetptr="book_enea_linux_eclipse_open_source"><trademark
        class="registered">Enea</trademark> Linux Eclipse Open Source
        Report</olink></para>
      </listitem>

      <listitem>
        <para><trademark class="registered">Enea</trademark> Linux 6 Test
        Report</para>
      </listitem>

      <listitem>
        <para><trademark class="registered">Enea</trademark> Linux Real-Time
        Guide can be read at <ulink
        url="http://linuxrealtime.org">http://linuxrealtime.org</ulink>.</para>
      </listitem>
    </itemizedlist>
  </section>

  <section condition="hidden" id="relinfo-provided-other">
    <title>Other Provided Functionality</title>

    <para>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:</para>

    <itemizedlist spacing="compact">
      <listitem>
        <para>On target T4240RDB:</para>

        <itemizedlist spacing="compact">
          <listitem>
            <para>SRIO support in user space (NWRITE, NREAD, msg,
            doorbell)</para>
          </listitem>

          <listitem>
            <para>USDPAA</para>
          </listitem>
        </itemizedlist>
      </listitem>

      <listitem>
        <para>Smart Package Management</para>
      </listitem>
    </itemizedlist>
  </section>

  <section id="relinfo-security-fixes">
    <title>Security Fixes</title>

    <para>See <ulink
    url="http://www.enea.com/solutions/Enea-Linux/Security/CVEs-list">List of
    CVEs addressed in Enea Linux</ulink> and <ulink
    url="http://www.enea.com/solutions/Enea-Linux/Security#how-to-get-security-updates">How
    to Get Security Updates</ulink>.</para>
  </section>

  <section condition="hidden" id="relinfo-excluded">
    <title>Intentional Limitations</title>

    <para>The following functionality supported in other Enea Linux releases
    has been excluded in this release:<itemizedlist spacing="compact">
        <listitem>
          <para>Networking features: DPDK vSwitch, DPDK</para>
        </listitem>

        <listitem>
          <para>Real-time features: Fully Preemptible Kernel (FPK) from the
          PREEMPT_RT patch</para>
        </listitem>

        <listitem>
          <para>Memory features: NUMA</para>
        </listitem>
      </itemizedlist></para>
  </section>
</chapter>