summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorSona Sarmadi <sona.sarmadi@enea.com>2018-09-20 10:58:16 +0200
committerSona Sarmadi <sona.sarmadi@enea.com>2018-09-20 14:26:45 +0200
commit18eeab5960104a3b4d9757574e67d7d454bc9609 (patch)
tree4ff63623532d33ec9e8a601ef91ebd9506e50e34 /doc
parent812dce0333cad8256e089a5d8ec45dad077245f7 (diff)
downloadel_releases-rt-18eeab5960104a3b4d9757574e67d7d454bc9609.tar.gz
Fixed review comments
Fixed Adrian, Martin and Miruna's remaining review comments. Change-Id: Ifa38428304722fd6a6cf947b2f74c3fdd902e27a Signed-off-by: Sona Sarmadi <sona.sarmadi@enea.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/book-enea-linux-user-guide/doc/real_time_in_enea_linux.xml262
-rw-r--r--doc/book-enea-linux-user-guide/doc/using_enea_linux.xml2
2 files changed, 155 insertions, 109 deletions
diff --git a/doc/book-enea-linux-user-guide/doc/real_time_in_enea_linux.xml b/doc/book-enea-linux-user-guide/doc/real_time_in_enea_linux.xml
index afc3d33..8d7b8d4 100644
--- a/doc/book-enea-linux-user-guide/doc/real_time_in_enea_linux.xml
+++ b/doc/book-enea-linux-user-guide/doc/real_time_in_enea_linux.xml
@@ -2,77 +2,89 @@
2<chapter id="real_time"> 2<chapter id="real_time">
3 <title>Real-Time in Enea Linux</title> 3 <title>Real-Time in Enea Linux</title>
4 4
5 <para>The Enea Linux Standard and Real-Time Profiles are based 5 <para>The Enea Linux Standard and Real-Time Profiles are based on the same
6 on the same Yocto (poky) version but differ in kernel needs. The RT Profile uses the <ulink 6 Yocto (poky) version but differ in kernel needs. The RT Profile uses the
7 url="https://github.com/intel/linux-intel-lts/wiki">Intel 4.14/preempt-rt kernel</ulink>.</para> 7 <ulink url="https://github.com/intel/linux-intel-lts/wiki">Intel
8 4.14/preempt-rt kernel</ulink>.</para>
8 9
9 <table> 10 <table>
10 <title>Addtional packages provided in the RT profile</title> 11 <title>Addtional packages provided in the RT profile</title>
11 12
12 <tgroup cols="3"> 13 <tgroup cols="3">
13 <colspec align="center" /> 14 <colspec align="center" />
14 15
15 <thead> 16 <thead>
16 <row> 17 <row>
17 <entry align="center">Package</entry> 18 <entry align="center">Package</entry>
18 <entry align="center">Version</entry>
19 <entry align="center">Description</entry>
20 </row>
21 </thead>
22 19
23 <tbody> 20 <entry align="center">Version</entry>
24 <row>
25 <entry>bitcalc</entry>
26 <entry>1.0-r0.0</entry>
27 <entry>Tool for understanding bit calculations and
28 visualizing to binary, hex and decimal.</entry>
29 </row>
30 21
31 <row> 22 <entry align="center">Description</entry>
32 <entry>count-ticks</entry> 23 </row>
33 <entry>1.1-r1.0</entry> 24 </thead>
34 <entry>Counts the number of kernel ticks during command execution.</entry>
35 </row>
36
37 <row>
38 <entry>partrt</entry>
39 <entry>1.1-r0.0</entry>
40 <entry>Tool for dividing a SMP Linux system into a real
41 time domain and a non-real time domain.</entry>
42 </row>
43 25
44 <row> 26 <tbody>
45 <entry>cyclictest</entry> 27 <row>
46 <entry></entry> 28 <entry>bitcalc</entry>
47 <entry>A testing tool for evaluating relative performance of RT systems.</entry>
48 </row>
49 29
50 <row> 30 <entry>1.0-r0.0</entry>
51 <entry>stress</entry> 31
52 <entry></entry> 32 <entry>Tool for understanding bit calculations and visualizing to
53 <entry>A simple workload generator for POSIX systems.</entry> 33 binary, hex and decimal.</entry>
54 </row> 34 </row>
55 </tbody> 35
56 </tgroup> 36 <row>
57 </table> 37 <entry>count-ticks</entry>
38
39 <entry>1.1-r1.0</entry>
40
41 <entry>Counts the number of kernel ticks during command
42 execution.</entry>
43 </row>
44
45 <row>
46 <entry>partrt</entry>
47
48 <entry>1.1-r0.0</entry>
49
50 <entry>Tool for dividing a SMP Linux system into a real time domain
51 and a non-real time domain.</entry>
52 </row>
53
54 <row>
55 <entry>rt-tests</entry>
56
57 <entry>1.1</entry>
58
59 <entry>Programs that test various rt-linux features.</entry>
60 </row>
61 </tbody>
62 </tgroup>
63 </table>
58 64
59 <para>For the detailed list of packages provided in both Standard and RT 65 <para>For the detailed list of packages provided in both Standard and RT
60 profiles along with package versions, please refer to the manifest files located in 66 profiles along with package versions, please refer to the Open Source
61 <literal>&lt;build_dir&gt;/tmp/deploy/images/&lt;target&gt;</literal>.</para> 67 Reports.</para>
62 68
63 <section id="benchmark"> 69 <section id="benchmark">
64 <title>Benchmark</title> 70 <title>Benchmark</title>
65 71
66 <para>The worst case latency benchmark uses a combination of tools: <ulink 72 <para>The worst case latency benchmark uses a combination of tools: <ulink
67 url="https://wiki.linuxfoundation.org/realtime/documentation/howto/tools/cyclictest/start">cyclictest</ulink>, and <ulink 73 url="https://wiki.linuxfoundation.org/realtime/documentation/howto/tools/cyclictest/start">cyclictest</ulink>,
68 url="http://people.seas.harvard.edu/~apw/stress">stress</ulink>. The values of buffer sizes configured for use in the latter tool are chosen 74 and <ulink
69 both to generate a stessful load on a network via NFS traffic in the hdd test, and in an attempt to resemble a real life embedded application.</para> 75 url="http://people.seas.harvard.edu/~apw/stress">stress</ulink>. The
76 values of buffer sizes configured for use in the latter tool are chosen
77 both to generate a stressful load on a network via NFS traffic in the hdd
78 test, and in an attempt to resemble a real life embedded
79 application.</para>
70 80
71 <section id="benchmark_details"> 81 <section id="benchmark_details">
72 <title>Benchmark Details</title> 82 <title>Benchmark Details</title>
73 83
74 <para>The combination of <emphasis role="bold">cyclictest</emphasis> and <emphasis role="bold">stress</emphasis> has been used for the 84 <para>The combination of <emphasis role="bold">cyclictest</emphasis> and
75 benchmarking presented in this document. Details are given in the tables presented below.</para> 85 <emphasis role="bold">stress</emphasis> has been used for the
86 benchmarking presented in this document. Details are given in the tables
87 presented below.</para>
76 88
77 <table> 89 <table>
78 <title>Stress scenarios</title> 90 <title>Stress scenarios</title>
@@ -157,9 +169,12 @@
157 <para>Below you will find several testcases for an RT image.</para> 169 <para>Below you will find several testcases for an RT image.</para>
158 170
159 <example id="testcase_one"> 171 <example id="testcase_one">
160 <title><emphasis role="bold">Test 1 (RT image)</emphasis></title> 172 <title>
173 <emphasis role="bold">Test 1 (RT image)</emphasis>
174 </title>
161 175
162 <para><programlisting># Test case (1/6): rt_bmark.intlat.no_stress 176 <para>
177 <programlisting># Test case (1/6): rt_bmark.intlat.no_stress
163# .............................................................................. 178# ..............................................................................
164# No stress requested 179# No stress requested
165# Starting cyclictest 180# Starting cyclictest
@@ -172,12 +187,17 @@
172# Max list: [5, 6, 7, 9, 10, 15] 187# Max list: [5, 6, 7, 9, 10, 15]
173# PASS 188# PASS
174 189
175 </programlisting></para></example> 190 </programlisting>
191 </para>
192 </example>
176 193
177 <example id="testcase_two"> 194 <example id="testcase_two">
178 <title><emphasis role="bold">Test 2 (RT image)</emphasis></title> 195 <title>
196 <emphasis role="bold">Test 2 (RT image)</emphasis>
197 </title>
179 198
180 <para><programlisting># Test case (2/6): rt_bmark.intlat.cpu 199 <para>
200 <programlisting># Test case (2/6): rt_bmark.intlat.cpu
181# .............................................................................. 201# ..............................................................................
182# Starting stress(cpu) 202# Starting stress(cpu)
183# Command: 'stress -c 8' 203# Command: 'stress -c 8'
@@ -190,11 +210,17 @@
190# Max: 11 us 210# Max: 11 us
191# Max list: [4, 5, 6, 9, 10, 11] 211# Max list: [4, 5, 6, 9, 10, 11]
192# PASS 212# PASS
193</programlisting></para></example> 213</programlisting>
214 </para>
215 </example>
194 216
195 <example id="testcase_three"> 217 <example id="testcase_three">
196 <title><emphasis role="bold">Test 3 (RT image)</emphasis></title> 218 <title>
197 <para><programlisting># Test case (3/6): rt_bmark.intlat.hdd 219 <emphasis role="bold">Test 3 (RT image)</emphasis>
220 </title>
221
222 <para>
223 <programlisting># Test case (3/6): rt_bmark.intlat.hdd
198# .............................................................................. 224# ..............................................................................
199# Starting stress(hdd) 225# Starting stress(hdd)
200# Command: 'stress -d 8 --hdd-bytes 20M' 226# Command: 'stress -d 8 --hdd-bytes 20M'
@@ -207,11 +233,17 @@
207# Max: 14 us 233# Max: 14 us
208# Max list: [9, 10, 11, 12, 14, 14] 234# Max list: [9, 10, 11, 12, 14, 14]
209# PASS 235# PASS
210</programlisting></para></example> 236</programlisting>
237 </para>
238 </example>
211 239
212 <example id="testcase_four"> 240 <example id="testcase_four">
213 <title><emphasis role="bold">Test 4 (RT image)</emphasis></title> 241 <title>
214 <para><programlisting># Test case (4/6): rt_bmark.intlat.io 242 <emphasis role="bold">Test 4 (RT image)</emphasis>
243 </title>
244
245 <para>
246 <programlisting># Test case (4/6): rt_bmark.intlat.io
215# .............................................................................. 247# ..............................................................................
216# Starting stress(io) 248# Starting stress(io)
217# Command: 'stress -i 8' 249# Command: 'stress -i 8'
@@ -224,11 +256,17 @@
224# Max: 15 us 256# Max: 15 us
225# Max list: [8, 9, 10, 12, 12, 15] 257# Max list: [8, 9, 10, 12, 12, 15]
226# PASS 258# PASS
227 </programlisting></para></example> 259 </programlisting>
260 </para>
261 </example>
228 262
229 <example id="testcase_five"> 263 <example id="testcase_five">
230 <title><emphasis role="bold">Test 5 (RT image)</emphasis></title> 264 <title>
231 <para><programlisting># Test case (5/6): rt_bmark.intlat.vm 265 <emphasis role="bold">Test 5 (RT image)</emphasis>
266 </title>
267
268 <para>
269 <programlisting># Test case (5/6): rt_bmark.intlat.vm
232# .............................................................................. 270# ..............................................................................
233# Starting stress(vm) 271# Starting stress(vm)
234# Command: 'stress -m 8 --vm-bytes 10M' 272# Command: 'stress -m 8 --vm-bytes 10M'
@@ -240,11 +278,17 @@
240# Avg: 4.2 us 278# Avg: 4.2 us
241# Max: 15 us 279# Max: 15 us
242# Max list: [10, 12, 12, 13, 13, 15] 280# Max list: [10, 12, 12, 13, 13, 15]
243 # PASS</programlisting></para></example> 281 # PASS</programlisting>
282 </para>
283 </example>
244 284
245 <example id="testcase_six"> 285 <example id="testcase_six">
246 <title><emphasis role="bold">Test 6 (RT image)</emphasis></title> 286 <title>
247 <para><programlisting># Test case (6/6): rt_bmark.intlat.full 287 <emphasis role="bold">Test 6 (RT image)</emphasis>
288 </title>
289
290 <para>
291 <programlisting># Test case (6/6): rt_bmark.intlat.full
248# .............................................................................. 292# ..............................................................................
249# Starting stress(io+cpu+hdd+vm) 293# Starting stress(io+cpu+hdd+vm)
250# Command: 'stress -i 8 -c 8 -d 8 --hdd-bytes 20M -m 8 --vm-bytes 10M' 294# Command: 'stress -i 8 -c 8 -d 8 --hdd-bytes 20M -m 8 --vm-bytes 10M'
@@ -257,7 +301,9 @@
257# Max: 19 us 301# Max: 19 us
258# Max list: [12, 14, 15, 16, 18, 19] 302# Max list: [12, 14, 15, 16, 18, 19]
259# PASS 303# PASS
260 </programlisting></para></example> 304 </programlisting>
305 </para>
306 </example>
261 </section> 307 </section>
262 308
263 <para>Repeat these tests for the Standard image and compare the results 309 <para>Repeat these tests for the Standard image and compare the results
@@ -284,7 +330,7 @@
284 <thead> 330 <thead>
285 <row> 331 <row>
286 <entry morerows="1" valign="middle"> 332 <entry morerows="1" valign="middle">
287 <para>Latency [ยตs]</para> 333 <para>Latency [us]</para>
288 </entry> 334 </entry>
289 335
290 <entry nameend="7" namest="2"> 336 <entry nameend="7" namest="2">
@@ -326,27 +372,27 @@
326 </entry> 372 </entry>
327 373
328 <entry> 374 <entry>
329 <para>2 us</para> 375 <para>2 </para>
330 </entry> 376 </entry>
331 377
332 <entry> 378 <entry>
333 <para>2 us</para> 379 <para>2 </para>
334 </entry> 380 </entry>
335 381
336 <entry> 382 <entry>
337 <para>1 us</para> 383 <para>1 </para>
338 </entry> 384 </entry>
339 385
340 <entry> 386 <entry>
341 <para>2 us</para> 387 <para>2 </para>
342 </entry> 388 </entry>
343 389
344 <entry> 390 <entry>
345 <para>1 us</para> 391 <para>1 </para>
346 </entry> 392 </entry>
347 393
348 <entry> 394 <entry>
349 <para>2 us</para> 395 <para>2 </para>
350 </entry> 396 </entry>
351 </row> 397 </row>
352 398
@@ -356,27 +402,27 @@
356 </entry> 402 </entry>
357 403
358 <entry> 404 <entry>
359 <para>2.9 us</para> 405 <para>2.9 </para>
360 </entry> 406 </entry>
361 407
362 <entry> 408 <entry>
363 <para>2.0 us</para> 409 <para>2.0 </para>
364 </entry> 410 </entry>
365 411
366 <entry> 412 <entry>
367 <para>2.7 us</para> 413 <para>2.7 </para>
368 </entry> 414 </entry>
369 415
370 <entry> 416 <entry>
371 <para>4.2 us</para> 417 <para>4.2 </para>
372 </entry> 418 </entry>
373 419
374 <entry> 420 <entry>
375 <para>3.0 us</para> 421 <para>3.0 </para>
376 </entry> 422 </entry>
377 423
378 <entry> 424 <entry>
379 <para>4.5 us</para> 425 <para>4.5 </para>
380 </entry> 426 </entry>
381 </row> 427 </row>
382 428
@@ -386,27 +432,27 @@
386 </entry> 432 </entry>
387 433
388 <entry> 434 <entry>
389 <para>262 us</para> 435 <para>262 </para>
390 </entry> 436 </entry>
391 437
392 <entry> 438 <entry>
393 <para>82 us</para> 439 <para>82 </para>
394 </entry> 440 </entry>
395 441
396 <entry> 442 <entry>
397 <para>101 us</para> 443 <para>101</para>
398 </entry> 444 </entry>
399 445
400 <entry> 446 <entry>
401 <para>776 us</para> 447 <para>776 </para>
402 </entry> 448 </entry>
403 449
404 <entry> 450 <entry>
405 <para>122 us</para> 451 <para>122 </para>
406 </entry> 452 </entry>
407 453
408 <entry> 454 <entry>
409 <para>1428 us</para> 455 <para>1428</para>
410 </entry> 456 </entry>
411 </row> 457 </row>
412 </tbody> 458 </tbody>
@@ -434,7 +480,7 @@
434 <thead> 480 <thead>
435 <row> 481 <row>
436 <entry morerows="1" valign="middle"> 482 <entry morerows="1" valign="middle">
437 <para>Latency [ยตs]</para> 483 <para>Latency [us]</para>
438 </entry> 484 </entry>
439 485
440 <entry nameend="7" namest="2"> 486 <entry nameend="7" namest="2">
@@ -476,27 +522,27 @@
476 </entry> 522 </entry>
477 523
478 <entry> 524 <entry>
479 <para>2 us</para> 525 <para>2 </para>
480 </entry> 526 </entry>
481 527
482 <entry> 528 <entry>
483 <para>2 us</para> 529 <para>2 </para>
484 </entry> 530 </entry>
485 531
486 <entry> 532 <entry>
487 <para>2 us</para> 533 <para>2 </para>
488 </entry> 534 </entry>
489 535
490 <entry> 536 <entry>
491 <para>2 us</para> 537 <para>2 </para>
492 </entry> 538 </entry>
493 539
494 <entry> 540 <entry>
495 <para>2 us</para> 541 <para>2 </para>
496 </entry> 542 </entry>
497 543
498 <entry> 544 <entry>
499 <para>2 us</para> 545 <para>2 </para>
500 </entry> 546 </entry>
501 </row> 547 </row>
502 548
@@ -506,27 +552,27 @@
506 </entry> 552 </entry>
507 553
508 <entry> 554 <entry>
509 <para>3.0 us</para> 555 <para>3.0 </para>
510 </entry> 556 </entry>
511 557
512 <entry> 558 <entry>
513 <para>2.0 us</para> 559 <para>2.0 </para>
514 </entry> 560 </entry>
515 561
516 <entry> 562 <entry>
517 <para>3.0 us</para> 563 <para>3.0 </para>
518 </entry> 564 </entry>
519 565
520 <entry> 566 <entry>
521 <para>4.3 us</para> 567 <para>4.3 </para>
522 </entry> 568 </entry>
523 569
524 <entry> 570 <entry>
525 <para>2.7 us</para> 571 <para>2.7 </para>
526 </entry> 572 </entry>
527 573
528 <entry> 574 <entry>
529 <para>3.5 us</para> 575 <para>3.5 </para>
530 </entry> 576 </entry>
531 </row> 577 </row>
532 578
@@ -536,27 +582,27 @@
536 </entry> 582 </entry>
537 583
538 <entry> 584 <entry>
539 <para>15 us</para> 585 <para>15 </para>
540 </entry> 586 </entry>
541 587
542 <entry> 588 <entry>
543 <para>13 us</para> 589 <para>13 </para>
544 </entry> 590 </entry>
545 591
546 <entry> 592 <entry>
547 <para>42 us</para> 593 <para>42 </para>
548 </entry> 594 </entry>
549 595
550 <entry> 596 <entry>
551 <para>20 us</para> 597 <para>20 </para>
552 </entry> 598 </entry>
553 599
554 <entry> 600 <entry>
555 <para>16 us</para> 601 <para>16 </para>
556 </entry> 602 </entry>
557 603
558 <entry> 604 <entry>
559 <para>32 us</para> 605 <para>32 </para>
560 </entry> 606 </entry>
561 </row> 607 </row>
562 </tbody> 608 </tbody>
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 0704dbf..19ec877 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
@@ -56,7 +56,7 @@ $ TEMPLATECONF=meta-el-rt/conf/template.&lt;machine&gt; \
56 </step> 56 </step>
57 57
58 <step> 58 <step>
59 <para>Build Enea Linux RT image</para> 59 <para>Build an Enea Linux RT image</para>
60 60
61 <programlisting># You have already initiated the build environment and are in the &lt;build_dir&gt; 61 <programlisting># You have already initiated the build environment and are in the &lt;build_dir&gt;
62$ bitbake &lt;enea-image-name&gt; 62$ bitbake &lt;enea-image-name&gt;