summaryrefslogtreecommitdiffstats
path: root/doc/book-enea-linux-release-info/doc/about_release.xml
blob: 017f7b2b44a871eef81fbe07bd4b319079946387 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
<?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 <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>

  <para>Provided contents:<itemizedlist spacing="compact">
      <listitem>
        <para>Source code, recipes, scripts, and documentation for building
        your own Linux kernel, root file system, and cross-compilation
        toolchains (SDKs)</para>
      </listitem>

      <listitem>
        <para>Default configurations for basic Yocto functionality</para>
      </listitem>

      <listitem>
        <para>Feature-specific configurations to optionally add more
        capabilities to the Linux kernel</para>
      </listitem>

      <listitem>
        <para>Pre-built images (kernels, rootfs, dtb) and other binaries
        available for download</para>
      </listitem>

      <listitem>
        <para>Eclipse executable plus development tools for command line and
        Eclipse</para>
      </listitem>
    </itemizedlist></para>

  <para>Supported targets:</para>

  <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 includ here with description text for each target
  etc..</remark></para>

  <para><itemizedlist spacing="compact">
      <listitem>
        <para>Freescale P2041RDB, Power architecture, No DSPs, Quad-core QorIQ
        P2041 processor, e500mc cores.</para>
      </listitem>


    </itemizedlist></para>

  <para>Kernel configuration:</para>

  <itemizedlist>
    <listitem>
      <para>P2041RDB: One kernel flavor (release)<remark>FIXME Why are these
      listed three times? Why only "one kernel"??</remark></para>
    </listitem>

    <listitem>
      <para>P3041DS: One kernel flavor (release)<remark>FIXME Why are these
      listed three times?</remark></para>
    </listitem>

    <listitem>
      <para>Low-Latency Desktop (LLD)</para>
    </listitem>
  </itemizedlist>

  <para>Supported host environment:<itemizedlist>
      <listitem>
        <para>64-bit Ubuntu 14.04 LTS<remark>was
        EneaLinux_HOST_VER</remark></para>
      </listitem>
    </itemizedlist></para>

  <para>Supported versions:<itemizedlist spacing="compact">
      <listitem>
        <para>Yocto version <xi:include
        href="../../s_docsrc_common/pardoc-distro.xml"
        xmlns:xi="http://www.w3.org/2001/XInclude"
        xpointer="element(Yocto_VER/1)" /><remark>INFO: Auto-fetched from
        poky.ent via pardoc-distro.xml</remark></para>
      </listitem>

      <listitem>
        <para>poky source version <xi:include
        href="../../s_docsrc_common/pardoc-distro.xml"
        xmlns:xi="http://www.w3.org/2001/XInclude"
        xpointer="element(Poky_VER/1)" /><remark>INFO: Auto-fetched from
        poky.ent via pardoc-distro.xml</remark></para>
      </listitem>

      <listitem>
        <para>gcc version: 4.9<remark>was EneaLinux_GCC_VER Not in
        poky.en</remark></para>
      </listitem>

      <listitem>
        <para>Linux kernel version for all targets: 3.12<remark>was
        EneaLinux_KERNEL_VER Not in poky.ent</remark></para>
      </listitem>

      <listitem>
        <para>Eclipse version 4.5 Mars<remark>was Eclipse_VER and was
        Eclipse_NAME Not in poky.ent</remark></para>
      </listitem>

      <listitem>
        <para>Package versions: See <xref linkend="relinfo-packages" /></para>
      </listitem>
    </itemizedlist></para>

  <para>Distribution channel:<itemizedlist spacing="compact">
      <listitem>
        <para>All deliverables can be downloaded from <xi:include
        href="../../s_docsrc_common/pardoc-distro.xml"
        xmlns:xi="http://www.w3.org/2001/XInclude"
        xpointer="element(ULINK_ENEA_LINUX_URL/1)" /> <remark>QUEST REMOVE????
        This is still in pardoc-distro.xml</remark></para>
      </listitem>
    </itemizedlist></para>

  <para>Supported features: See <xref
  linkend="relinfo-supported-features" />.</para>

  <?hard-pagebreak ?>

  <xi:include href="supported_architectures.xml"
              xmlns:xi="http://www.w3.org/2001/XInclude" />

  <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 and Provider</entry>

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

          <tbody>
            <row>
              <entry>Packages in Enea Linux images</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>

            <row>
              <entry>Tools in the Eclipse tarball provided with Enea
              Linux</entry>

              <entry><para>See the <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></entry>
            </row>

            <row>
              <entry>Packages provided by Yocto</entry>

              <entry><para>See the Yocto "Release Notes" <xi:include
              href="../../s_docsrc_common/pardoc-distro.xml"
              xmlns:xi="http://www.w3.org/2001/XInclude"
              xpointer="element(ULINK_YOCTO_RELEASE_NOTES/1)" /></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_users_guide"
    targetptr="book_enea_linux_users_guide"><trademark
    class="registered">Enea</trademark> Linux User's Guide</olink> for
    information on how to build and install a toolchain.<remark>FIXME LATER
    MAYBE: Sorry but 5.0-ppc does not support cross-compilation of 32-bit
    applications for the T4240RDB 64bit target due to bugs in
    Yocto.</remark></para>
  </section>

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

    <para>No information of supported drivers is provided in this version of
    the Release Information.</para>
  </section>

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

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

    <itemizedlist spacing="compact">
      <listitem>
        <para>README.htm - top page of the documentation<remark>FIXME Needs to
        be fixed to easily find also online doc</remark></para>
      </listitem>

      <listitem>
        <para>README - text files describing various details like build- and
        boot-commands</para>
      </listitem>

      <listitem>
        <para><trademark class="registered">Enea</trademark> Linux Release
        Information (this document)</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>
    </itemizedlist>

    <para>User's Guides are available online, not inside the
    distribution.</para>

    <itemizedlist spacing="compact">
      <listitem>
        <para><ulink
        url="https://portal.enea.com/wp-content/uploads/_mediavault/book-enea-linux-application-dev-guide.pdf">Enea
        Linux Application User's Guide</ulink>
        (https://portal.enea.com/wp-content/uploads/_mediavault/book-enea-linux-applications-dev-guide.pdf)</para>
      </listitem>

      <listitem>
        <para><ulink
        url="https://portal.enea.com/wp-content/uploads/_mediavault/book-enea-linux-platforms-dev-guide.pdf">Enea
        Linux Platforms User's Guide</ulink>
        (https://portal.enea.com/wp-content/uploads/_mediavault/book-enea-linux-platforms-dev-guide.pdf)</para>
      </listitem>
    </itemizedlist>

    <para>How to use Eclipse is described inside the Enea Linux user's guides.
    Eclipse's own documentation is available in directory
    <filename>eclipse/readme</filename>.</para>

    <para>The Enea Linux Eclipse tarball and Eclipse Open Source Report is
    inherited from Enea Linux 4.0. How to use Eclipse is described inside the
    <olink targetdoc="book_enea_linux_users_guide"
    targetptr="book_enea_linux_users_guide"><trademark
    class="registered">Enea</trademark> Linux User's Guide</olink>.</para>

    <para>Eclipse's own documentation is available in tarball
    Enea-Linux-Eclipse_4.0.tar<remark>Was a parameter before - Probably wrong
    in EL6 where a newer Eclipse is used</remark>, directory
    <filename>eclipse/readme</filename>.</para>
  </section>

  <?hard-pagebreak ?>

  <xi:include href="supported_features.xml"
              xmlns:xi="http://www.w3.org/2001/XInclude" />

  <section 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>

      <listitem>
        <para>Eclipse ADT (excl. QEMU) and plug-ins for application
        development: LTTng, Perf, LatencyTOP, PowerTOP, SystemTap</para>
      </listitem>
    </itemizedlist>
  </section>

  <xi:include href="security_fixes.xml"
              xmlns:xi="http://www.w3.org/2001/XInclude" />

  <section 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>Eclipse plug-ins for image creation (HOB)</para>
        </listitem>

        <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>