summaryrefslogtreecommitdiff
path: root/ecos/packages/redboot/current/doc/redboot_cmds.sgml
blob: 11fc2de7ee360036b35932cff3f67c9ba17f2f5c (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
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
<!-- {{{ Banner                         -->

<!-- =============================================================== -->
<!--                                                                 -->
<!--     redboot_cmds.sgml                                           -->
<!--                                                                 -->
<!--     Documentation for RedBoot Commands                          -->
<!--                                                                 -->
<!-- =============================================================== -->
<!-- ####COPYRIGHTBEGIN####                                          -->
<!--                                                                 -->
<!-- =============================================================== -->
<!-- Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004 Red Hat, Inc.  -->
<!-- This material may be distributed only subject to the terms      -->
<!-- and conditions set forth in the Open Publication License, v1.0  -->
<!-- or later (the latest version is presently available at          -->
<!-- http://www.opencontent.org/openpub/)                            -->
<!-- Distribution of the work or derivative of the work in any       -->
<!-- standard (paper) book form is prohibited unless prior           -->
<!-- permission obtained from the copyright holder                   -->
<!-- =============================================================== -->
<!--                                                                 -->      
<!-- ####COPYRIGHTEND####                                            -->
<!-- =============================================================== -->
<!-- #####DESCRIPTIONBEGIN####                                       -->
<!--                                                                 -->
<!-- ####DESCRIPTIONEND####                                          -->
<!-- =============================================================== -->

<!-- }}} -->

<chapter id="RedBoot-Commands-and-Examples">
<title>RedBoot Commands and Examples</title>
<sect1>
<title>Introduction</title>
<para><indexterm><primary>RedBoot</primary><secondary>commands and examples
</secondary></indexterm><indexterm><primary>commands and examples</primary>
</indexterm>RedBoot provides three basic classes of commands:    <itemizedlist>
<listitem><para>Program loading and execution</para>
</listitem>
<listitem><para>Flash image and configuration management</para>
</listitem>
<listitem><para>Miscellaneous commands</para>
</listitem>
</itemizedlist>Given the extensible and configurable nature of eCos and RedBoot,
there may be extended or enhanced sets of commands available.</para>
<para>The basic format for commands is:    <programlisting>RedBoot> COMMAND [-S]... [-s val]... operand
</programlisting>
</para>
<para>
Commands may require additional information beyond the basic
command name. In most cases this additional information is optional, with
suitable default values provided if they are not present. 

      <informaltable frame="all">
	<tgroup cols="3" colsep="1" rowsep="1" align="left">
	  <colspec colname="c1">
	  <colspec colname="c2">
	  <colspec colname="c3">
	  <thead>
	    <row>
	      <entry>Format</entry>
	      <entry>Description</entry>
	      <entry>Example</entry>
	    </row>
	  </thead>
	  <tbody>
	    <row>
	      <entry>-S</entry>	     
	      <entry>A boolean switch; the behavior of the command will differ, depending
on the presence of the switch.  In this example, the <userinput>-f</userinput> switch
indicates that a complete initialization of the FIS data should be performed.
There may be many such switches available for any given command and any or all of
them may be present, in any order.</entry>
	      <entry>
                <computeroutput> RedBoot> <userinput>fis init -f</userinput></computeroutput>
              </entry>	     
	    </row>
	    <row>
	      <entry>-s<replaceable> val</replaceable></entry>	     
	      <entry>A qualified value; the letter "s" introduces the value, qualifying it's meaning.  In the
example, <userinput>-b 0x100000</userinput> specifies where the memory dump should begin.
There may be many such switches available for any given command and any or all of
them may be present, in any order.
</entry>
	      <entry>
                <computeroutput> RedBoot> <userinput>dump -b 0x100000 -l 0x20</userinput></computeroutput>
              </entry>	     
	    </row>
	    <row>
	      <entry><replaceable> operand</replaceable></entry>	     
	      <entry>A simple value; some commands require a single parameter for which an additional
<userinput>-X</userinput> switch would be redundant.  In the example, <userinput>JFFS2</userinput>
is the name of a flash image.  The image name is always required, thus is no need to qualify it with 
a switch.
Note that any un-qualified operand must always appear at the end of the command.</entry>
	      <entry>
                <computeroutput> RedBoot> <userinput>fis delete JFFS2</userinput></computeroutput>
              </entry>	     
	    </row>
	  </tbody>
	</tgroup>
      </informaltable>

</para>
<para>The list of available commands, and their syntax, can be obtained by
typing <command>help</command> at the command line:    
<screen>
RedBoot> <userinput>help</userinput>
Manage aliases kept in FLASH memory
      alias name [value]
Set/Query the system console baud rate
      baudrate [-b &lt;rate>]
Manage machine caches
      cache [ON | OFF]
Display/switch console channel
      channel [-1|&lt;channel number>]
Display disk partitions
      disks
Display (hex dump) a range of memory
      dump -b &lt;location> [-l &lt;length>] [-s]
Manage flash images
      fis {cmds}
Manage configuration kept in FLASH memory
      fconfig [-i] [-l] [-n] [-f] [-d] | [-d] nickname [value]
Execute code at a location
      go [-w &lt;timeout>] [-c] [-n] [entry]
Help about help?
      help [&lt;topic>]
Set/change IP addresses
      ip_address [-l &lt;local_ip_address>[/&lt;mask_length>]] [-h &lt;server_address>]
Load a file
      load [-r] [-v] [-d] [-c &lt;channel>] [-h &lt;host>] [-m {TFTP | HTTP | {x|y}MODEM | disk}]
      [-b &lt;base_address>] &lt;file_name>
Network connectivity test
      ping [-v] [-n &lt;count>] [-t &lt;timeout>] [-i &lt;IP_addr]
      -h &lt;host>
Reset the system
      reset
Display RedBoot version information
      version
Display (hex dump) a range of memory
      x -b &lt;location> [-l &lt;length>] [-s]
</screen>
</para>
<para>
Commands can be abbreviated to their shortest
unique string. Thus in the list above, <command>d,du,dum</command>
and dump are all valid for the <command>dump</command> command. The <command>fconfig</command>
command can be abbreviated <command>fc</command>, but 
<command>f</command> would be ambiguous with <command>fis</command>.
</para>
<para>There is one additional, special command. When RedBoot detects '$' or '+'
(unless escaped via '\') in a command, it switches to GDB protocol mode. At this
point, the eCos GDB stubs take over, allowing connections from a GDB host.
The only way to get back to RedBoot from GDB mode is to restart the platform.
</para>
<note><title>NOTE</title>
<para>
Multiple commands may be entered on a single line, separated by the semi-colon &ldquo;;&rdquo; character.
</para>
</note>
<para>The standard RedBoot command set is structured around the bootstrap
environment. These commands are designed to be simple to use and remember,
while still providing sufficient power and flexibility to be useful. No attempt
has been made to render RedBoot as the end-all product. As such, things such
as the debug environment are left to other modules, such as GDB stubs, which
are typically included in RedBoot. </para>
<para>The command set may be also be extended on a platform basis. </para>
</sect1>

<sect1 id="common-commands">
<title>Common Commands</title>
<para>
  <indexterm><primary>commands</primary><secondary>common</secondary>
  </indexterm>
</para>

<!-- ******** alias *************************************************** -->
  <refentry id="alias-command">
    <refnamediv>
      <refname>alias</refname>
      <refpurpose>Manipulate command line aliases</refpurpose>
    </refnamediv>
    <refsynopsisdiv>
      <cmdsynopsis>
	<command>alias</command>
	<arg choice="req"><replaceable> name</replaceable></arg>
	<arg><replaceable> value</replaceable></arg>
      </cmdsynopsis>
    </refsynopsisdiv>
    <refsect1>
      <title>Arguments</title>
      <informaltable frame="all">
	<tgroup cols="4" colsep="1" rowsep="1" align="left">
	  <colspec colname="c1">
	  <colspec colname="c2">
	  <colspec colname="c3">
	  <colspec colname="c4">
	  <thead>
	    <row>
	      <entry>Name</entry>
	      <entry>Type</entry>
	      <entry>Description</entry>
	      <entry>Default</entry>
	    </row>
	  </thead>
	  <tbody>
	    <row>
	      <entry><replaceable>name</replaceable></entry>	     
	      <entry>Name</entry>
	      <entry>The name for this alias.</entry>	     
	      <entry><emphasis>none</emphasis></entry>	     
	    </row>
	    <row>
	      <entry><replaceable>value</replaceable></entry>	     
	      <entry>String</entry>
	      <entry>Replacement value for the alias.</entry>	     
	      <entry><emphasis>none</emphasis></entry>	     
	    </row>
	  </tbody>
	</tgroup>
      </informaltable>
    </refsect1>
    <refsect1>
      <title>Description</title>
      <para>The <command>alias</command> command is used to maintain simple command
line aliases.  These aliases are shorthand for longer expressions.
When the pattern %{name} appears in a command line, including in a script,
the corresponding value will be substituted.  Aliases may be nested.
      </para>
      <para>
If no value is provided, then the current value of the alias is displayed.
      </para>
      <para>
If the system supports non-volatile configuration data via the 
<command>fconfig</command> command (see <xref linkend="Persistent-State-Flash">),
then the value will be saved and used when the system is reset.
      </para>
    </refsect1>
    <refsect1>
      <title>Examples</title>
      <para>
Set an alias.
<screen> 
RedBoot> <userinput>alias joe "This is Joe"</userinput>
Update RedBoot non-volatile configuration - continue (y/n)? n
</screen> 
</para>
<para>
Display an alias.
<screen> 
RedBoot> <userinput>alias joe</userinput>
'joe' = 'This is Joe'
</screen> 
</para>
<para>
Use an alias.  Note: the <command>"="</command> command simply echoes the command to to console.
<screen> 
RedBoot> <userinput>= %{joe}</userinput>
This is Joe
</screen>
</para>
<para>
Aliases can be nested.
<screen>
RedBoot> <userinput>alias frank "Who are you? %{joe}"</userinput>
Update RedBoot non-volatile configuration - continue (y/n)? n
RedBoot> <userinput>= %{frank}</userinput>
Who are you? This is Joe
</screen>
</para>
<para>
Notice how the value of %{frank} changes when %{joe} is changed since
the value of %{joe} is not evaluated until %{frank} is evaluated.
<screen>
RedBoot> <userinput>alias joe "This is now Josephine"</userinput>
Update RedBoot non-volatile configuration - continue (y/n)? n
RedBoot> <userinput>= %{frank}</userinput>
Who are you? This is now Josephine
</screen>
      </para>
    </refsect1>
  </refentry>

<!-- ******** baudrate *************************************************** -->
  <refentry id="baudrate-command">
    <refnamediv>
      <refname>baudrate</refname>
      <refpurpose>Set the baud rate for the system serial console</refpurpose>
    </refnamediv>
    <refsynopsisdiv>
      <cmdsynopsis>
	<command>baudrate</command>
	<arg>-b<replaceable> rate</replaceable></arg>
      </cmdsynopsis>
    </refsynopsisdiv>
    <refsect1>
      <title>Arguments</title>
      <informaltable frame="all">
	<tgroup cols="4" colsep="1" rowsep="1" align="left">
	  <colspec colname="c1">
	  <colspec colname="c2">
	  <colspec colname="c3">
	  <colspec colname="c4">
	  <thead>
	    <row>
	      <entry>Name</entry>
	      <entry>Type</entry>
	      <entry>Description</entry>
	      <entry>Default</entry>
	    </row>
	  </thead>
	  <tbody>
	    <row>
	      <entry>-b <replaceable>rate</replaceable></entry>	     
	      <entry>Number</entry>
	      <entry>The baud rate to use for the serial console.</entry>	     
	      <entry><emphasis>none</emphasis></entry>	     
	    </row>
	  </tbody>
	</tgroup>
      </informaltable>
    </refsect1>
    <refsect1>
      <title>Description</title>
      <para>The <command>baudrate</command> command sets the baud rate for the system serial console.
      </para>
      <para>
If no value is provided, then the current value of the console baud rate is displayed.
      </para>
      <para>
If the system supports non-volatile configuration data via the 
<command>fconfig</command> command (see <xref linkend="Persistent-State-Flash">),
then the value will be saved and used when the system is reset.
      </para>
    </refsect1>
    <refsect1>
      <title>Examples</title>
      <para>
Show the current baud rate.
<screen> 
RedBoot> <userinput>baudrate</userinput>
Baud rate = 38400
</screen> 
</para>
<para>
Change the console baud rate.  In order to make this operation safer,
there will be a slight pause after the
first message to give you time to change to the new baud rate.
If it doesn't work, or a less than affirmative answer is given to the 
"continue" prompt, then the baud rate will revert to the current value.
Only after the baud rate has been firmly established will <emphasis>RedBoot</emphasis>
give you an opportunity to save the value in persistent storage.
<screen> 
RedBoot> <userinput>baudrate -b 57600</userinput>
Baud rate will be changed to 57600 - update your settings
<emphasis>Device baud rate changed at this point</emphasis>
Baud rate changed to 57600 - continue (y/n)? y
Update RedBoot non-volatile configuration - continue (y/n)? n
</screen> 
      </para>
    </refsect1>
  </refentry>

<!-- ******** cache *************************************************** -->
  <refentry id="cache-command">
    <refnamediv>
      <refname>cache</refname>
      <refpurpose>Control hardware caches</refpurpose>
    </refnamediv>
    <refsynopsisdiv>
      <cmdsynopsis>
	<command>cache</command>
	<group>
	  <arg>on</arg>
	  <arg>off</arg>
	</group>
      </cmdsynopsis>
    </refsynopsisdiv>
    <refsect1>
      <title>Arguments</title>
      <informaltable frame="all">
	<tgroup cols="4" colsep="1" rowsep="1" align="left">
	  <colspec colname="c1">
	  <colspec colname="c2">
	  <colspec colname="c3">
	  <colspec colname="c4">
	  <thead>
	    <row>
	      <entry>Name</entry>
	      <entry>Type</entry>
	      <entry>Description</entry>
	      <entry>Default</entry>
	    </row>
	  </thead>
	  <tbody>
	    <row>
	      <entry>on</entry>	     
	      <entry></entry>
	      <entry>Turn the caches on</entry>	     
	      <entry><emphasis>none</emphasis></entry>	     
	    </row>
	    <row>
	      <entry>off</entry>	     
	      <entry></entry>
	      <entry>Turn the caches off</entry>	     
	      <entry><emphasis>none</emphasis></entry>	     
	    </row>
	  </tbody>
	</tgroup>
      </informaltable>
    </refsect1>
    <refsect1>
      <title>Description</title>
      <para>The <command>cache</command> command is used to manipulate the caches on the processor. </para>
      <para>With no options, this command specifies the state of the system caches.</para>
      <para>When an option is given, the caches are turned off or on appropriately.</para>
    </refsect1>
    <refsect1>
      <title>Examples</title>
      <para>
Show the current cache state.
<screen> 
RedBoot> <userinput>cache</userinput>
Data cache: On, Instruction cache: On
</screen> 
</para>
<para>
Disable the caches.
<screen> 
RedBoot> <userinput>cache off</userinput>
RedBoot> <userinput>cache</userinput>
Data cache: Off, Instruction cache: Off
</screen> 
</para>
<para>
Enable the caches.
<screen> 
RedBoot> <userinput>cache on</userinput>
RedBoot> <userinput>cache</userinput>
Data cache: On, Instruction cache: On
</screen> 
      </para>
    </refsect1>
  </refentry>

<!-- ******** channel *************************************************** -->
  <refentry id="channel-command">
    <refnamediv>
      <refname>channel</refname>
      <refpurpose>Select the system console channel</refpurpose>
    </refnamediv>
    <refsynopsisdiv>
      <cmdsynopsis>
	<command>channel</command>
	<group>
	  <arg>-1</arg>
	  <arg><replaceable>channel_number</replaceable></arg>
	</group>
      </cmdsynopsis>
    </refsynopsisdiv>
    <refsect1>
      <title>Arguments</title>
      <informaltable frame="all">
	<tgroup cols="4" colsep="1" rowsep="1" align="left">
	  <colspec colname="c1">
	  <colspec colname="c2">
	  <colspec colname="c3">
	  <colspec colname="c4">
	  <thead>
	    <row>
	      <entry>Name</entry>
	      <entry>Type</entry>
	      <entry>Description</entry>
	      <entry>Default</entry>
	    </row>
	  </thead>
	  <tbody>
	    <row>
	      <entry>-1</entry>	     
	      <entry></entry>
	      <entry>Reset the console channel</entry>	     
	      <entry><emphasis>none</emphasis></entry>	     
	    </row>
	    <row>
	      <entry>channel_number</entry>	     
	      <entry>Number</entry>
	      <entry>Select a channel</entry>	     
	      <entry><emphasis>none</emphasis></entry>	     
	    </row>
	  </tbody>
	</tgroup>
      </informaltable>
    </refsect1>
    <refsect1>
      <title>Description</title>
      <para>
With no arguments, the <command>channel</command> command displays the current console channel number.
</para><para>
When passed an argument of 0 upward, this command switches the console
channel to that channel number. The mapping between channel numbers and
physical channels is platform specific but will typically be something like
channel 0 is the first serial port, channel 1 is the second, etc.
</para><para>
When passed an argument of -1, this command reverts RedBoot to responding
to whatever channel receives input first, as happens when RedBoot initially
starts execution.
</para>
    </refsect1>
    <refsect1>
      <title>Examples</title>
      <para>
Show the current channel.
<screen> 
RedBoot> <userinput>channel</userinput>
Current console channel id: 0
</screen> 
</para>
<para>
Change to an invalid channel.
<screen> 
RedBoot> <userinput>channel 99</userinput>
**Error: bad channel number '99'
</screen> 
</para>
<para>
Revert to the default channel setting (any console mode).
<screen> 
RedBoot> <userinput>channel -1</userinput>
</screen> 
      </para>
    </refsect1>
  </refentry>

<!-- ******** cksum *************************************************** -->
  <refentry id="cksum-command">
    <refnamediv>
      <refname>cksum</refname>
      <refpurpose>Compute POSIX checksums</refpurpose>
    </refnamediv>
    <refsynopsisdiv>
      <cmdsynopsis>
	<command>cksum</command>
	    <arg choice="req">-b <replaceable>location</replaceable></arg>
	    <arg choice="req">-l <replaceable>length</replaceable></arg>
      </cmdsynopsis>
    </refsynopsisdiv>
    <refsect1>
      <title>Arguments</title>
      <informaltable frame="all">
	<tgroup cols="4" colsep="1" rowsep="1" align="left">
	  <colspec colname="c1">
	  <colspec colname="c2">
	  <colspec colname="c3">
	  <colspec colname="c4">
	  <thead>
	    <row>
	      <entry>Name</entry>
	      <entry>Type</entry>
	      <entry>Description</entry>
	      <entry>Default</entry>
	    </row>
	  </thead>
	  <tbody>
	    <row>
	      <entry>-b <replaceable>location</replaceable></entry>	     
	      <entry>Memory address</entry>
	      <entry>Location in memory for stat of data.</entry>	     
	      <entry><emphasis>none</emphasis></entry>	     
	    </row>
	    <row>
	      <entry>-l <replaceable>length</replaceable></entry>	     
	      <entry>Number</entry>
	      <entry>Length of data</entry>	     
	      <entry><emphasis>none</emphasis></entry>	     
	    </row>
	  </tbody>
	</tgroup>
      </informaltable>
    </refsect1>
    <refsect1>
      <title>Description</title>
	  <para>Computes the POSIX checksum on a range of memory (either RAM or FLASH).
The values printed (decimal cksum, decimal length, hexadecimal cksum,
	  hexadecimal length) can be compared with the output from the Linux program 'cksum'.
</para>
    </refsect1>
    <refsect1>
      <title>Examples</title>
      <para>
Checksum a buffer.
<screen> 
RedBoot> <userinput>cksum -b 0x100000 -l 0x100</userinput>
POSIX cksum = 3286483632 256 (0xc3e3c2b0 0x00000100)
</screen> 
      </para>
      <para>
Checksum an area of memory after loading a file. Note that the base
address and length parameters are provided by the preceding
load command.
<screen> 
RedBoot> <userinput>load -r -b %{FREEMEMLO} redboot.bin</userinput>
Raw file loaded 0x06012800-0x0602f0a8
RedBoot> <userinput>cksum</userinput>
Computing cksum for area 0x06012800-0x0602f0a8
POSIX cksum = 2092197813 116904 (0x7cb467b5 0x0001c8a8)
</screen> 
      </para>
    </refsect1>
  </refentry>

<!-- ******** disks *************************************************** -->
  <refentry id="disks-command">
    <refnamediv>
      <refname>disks</refname>
      <refpurpose>List available disk partitions.</refpurpose>
    </refnamediv>
    <refsynopsisdiv>
      <cmdsynopsis>
	<command>disks</command>
      </cmdsynopsis>
    </refsynopsisdiv>
    <refsect1>
      <title>Arguments</title>
<para>None.</para>
    </refsect1>
    <refsect1>
      <title>Description</title>
	<para>The <command>disks</command> command is used to list disk partitions recognized by RedBoot.</para>
    </refsect1>
    <refsect1>
      <title>Examples</title>
      <para>
Show what disk partitions are available.
<screen> 
RedBoot> <userinput>disks</userinput>
hda1     Linux Swap
hda2     Linux
00100000: 00 3E 00 06 00 06 00 06  00 00 00 00 00 00 00 00  |.>..............|
00100010: 00 00 00 78 00 70 00 60  00 60 00 60 00 60 00 60  |...x.p.`.`.`.`.`|
</screen> 
      </para>
    </refsect1>
  </refentry>

<!-- ******** dump *************************************************** -->
  <refentry id="dump-command">
    <refnamediv>
      <refname>dump</refname>
      <refpurpose>Display memory.</refpurpose>
    </refnamediv>
    <refsynopsisdiv>
      <cmdsynopsis>
	<command>dump</command>
	    <arg choice="req">-b <replaceable>location</replaceable></arg>
	    <arg>-l <replaceable>length</replaceable></arg>
	    <arg>-s</arg>
	  <group>
	    <arg>-1</arg>
	    <arg>-2</arg>
	    <arg>-4</arg>
	  </group>
      </cmdsynopsis>
    </refsynopsisdiv>
    <refsect1>
      <title>Arguments</title>
      <informaltable frame="all">
	<tgroup cols="4" colsep="1" rowsep="1" align="left">
	  <colspec colname="c1">
	  <colspec colname="c2">
	  <colspec colname="c3">
	  <colspec colname="c4">
	  <thead>
	    <row>
	      <entry>Name</entry>
	      <entry>Type</entry>
	      <entry>Description</entry>
	      <entry>Default</entry>
	    </row>
	  </thead>
	  <tbody>
	    <row>
	      <entry>-b <replaceable>location</replaceable></entry>	     
	      <entry>Memory address</entry>
	      <entry>Location in memory for start of data.</entry>	     
	      <entry><emphasis>none</emphasis></entry>	     
	    </row>
	    <row>
	      <entry>-l <replaceable>length</replaceable></entry>	     
	      <entry>Number</entry>
	      <entry>Length of data</entry>	     
	      <entry>32</entry>	     
	    </row>
	    <row>
	      <entry>-s</entry>	     
	      <entry>Boolean</entry>
	      <entry>Format data using Motorola S-records.</entry>	     
	      <entry></entry>	     
	    </row>
	    <row>
	      <entry>-1</entry>	     
	      <entry></entry>
	      <entry>Access one byte (8 bits) at a time.  
Only the least significant 8 bits of the pattern will be used.</entry>	     
	      <entry>-1</entry>	     
	    </row>
	    <row>
	      <entry>-2</entry>	     
	      <entry></entry>
	      <entry>Access two bytes (16 bits) at a time.  
Only the least significant 16 bits of the pattern will be used.</entry>	     
	      <entry>-1</entry>	     
	    </row>
	    <row>
	      <entry>-4</entry>	     
	      <entry></entry>
	      <entry>Access one word (32 bits) at a time.</entry>	     
	      <entry>-1</entry>	     
	    </row>
	  </tbody>
	</tgroup>
      </informaltable>
    </refsect1>
    <refsect1>
      <title>Description</title>
	<para>Display a range of memory on the system console.</para>
	<para>The <command>x</command> is a synonym for <command>dump</command>.</para>
        <para>Note that this command could
be detrimental if used on memory mapped hardware registers. </para>
        <para>The memory is displayed at most sixteen bytes per line, first as the
raw hex value, followed by an ASCII interpretation of the data. </para>
    </refsect1>
    <refsect1>
      <title>Examples</title>
      <para>
Display a buffer, one byte at a time.
<screen> 
RedBoot> <userinput>mfill -b 0x100000 -l 0x20 -p 0xDEADFACE</userinput>
RedBoot> <userinput>x -b 0x100000</userinput>
00100000: CE FA AD DE CE FA AD DE  CE FA AD DE CE FA AD DE  |................|
00100010: CE FA AD DE CE FA AD DE  CE FA AD DE CE FA AD DE  |................|
</screen> 
</para>
<para>
Display a buffer, one short (16 bit) word at a time.  Note in this case that
the ASCII interpretation is suppressed.
<screen> 
RedBoot> <userinput>dump -b 0x100000 -2</userinput>
00100000: FACE DEAD FACE DEAD  FACE DEAD FACE DEAD 
00100010: FACE DEAD FACE DEAD  FACE DEAD FACE DEAD 
</screen> 
</para>
<para>
Display a buffer, one word (32 bit) word at a time.  Note in this case that
the ASCII interpretation is suppressed.
<screen> 
RedBoot> <userinput>dump -b 0x100000 -4</userinput>
00100000: DEADFACE DEADFACE DEADFACE DEADFACE 
00100010: DEADFACE DEADFACE DEADFACE DEADFACE 
</screen> 
</para>
<para>
Display the same buffer, using Motorola S-record format.
<screen> 
RedBoot> <userinput>dump -b 0x100000 -s</userinput>
S31500100000CEFAADDECEFAADDECEFAADDECEFAADDE8E
S31500100010CEFAADDECEFAADDECEFAADDECEFAADDE7E
</screen> 
</para>
<para>
Display a buffer, with visible ASCII strings.
<screen> 
RedBoot> <userinput>d -b 0xfe00b000 -l 0x80</userinput>
0xFE00B000: 20 25 70 0A 00 00 00 00  41 74 74 65 6D 70 74 20 | %p.....Attempt |
0xFE00B010: 74 6F 20 6C 6F 61 64 20  53 2D 72 65 63 6F 72 64 |to load S-record|
0xFE00B020: 20 64 61 74 61 20 74 6F  20 61 64 64 72 65 73 73 | data to address|
0xFE00B030: 3A 20 25 70 20 5B 6E 6F  74 20 69 6E 20 52 41 4D |: %p [not in RAM|
0xFE00B040: 5D 0A 00 00 2A 2A 2A 20  57 61 72 6E 69 6E 67 21 |]...*** Warning!|
0xFE00B050: 20 43 68 65 63 6B 73 75  6D 20 66 61 69 6C 75 72 | Checksum failur|
0xFE00B060: 65 20 2D 20 41 64 64 72  3A 20 25 6C 78 2C 20 25 |e - Addr: %lx, %|
0xFE00B070: 30 32 6C 58 20 3C 3E 20  25 30 32 6C 58 0A 00 00 |02lX &lt;> %02lX...|
0xFE00B080: 45 6E 74 72 79 20 70 6F  69 6E 74 3A 20 25 70 2C |Entry point: %p,|
</screen> 
      </para>
    </refsect1>
  </refentry>

<!-- ******** help *************************************************** -->
  <refentry id="help-command">
    <refnamediv>
      <refname>help</refname>
      <refpurpose>Display help on available commands</refpurpose>
    </refnamediv>
    <refsynopsisdiv>
      <cmdsynopsis>
	<command>help</command>
	<arg><replaceable> topic</replaceable></arg>
      </cmdsynopsis>
    </refsynopsisdiv>
    <refsect1>
      <title>Arguments</title>
      <informaltable frame="all">
	<tgroup cols="4" colsep="1" rowsep="1" align="left">
	  <colspec colname="c1">
	  <colspec colname="c2">
	  <colspec colname="c3">
	  <colspec colname="c4">
	  <thead>
	    <row>
	      <entry>Name</entry>
	      <entry>Type</entry>
	      <entry>Description</entry>
	      <entry>Default</entry>
	    </row>
	  </thead>
	  <tbody>
	    <row>
	      <entry><replaceable>topic</replaceable></entry>	     
	      <entry>String</entry>
	      <entry>Which command to provide help for.</entry>	     
	      <entry>All commands</entry>	     
	    </row>
	  </tbody>
	</tgroup>
      </informaltable>
    </refsect1>
    <refsect1>
      <title>Description</title>
      <para>
The <command>help</command> command displays information about the available
RedBoot commands.  If a <emphasis>topic</emphasis> is given, then the display
is restricted to information about that specific command.
      </para>
      <para>
If the command has sub-commands, e.g. <command>fis</command>, then the topic
specific display will print additional information about the available sub-commands.
special (ICMP) packets to a specific host. These packets should be automatically
returned by that host. The command will indicate how many of these round-trips
were successfully completed. 
      </para>
    </refsect1>
    <refsect1>
      <title>Examples</title>
      <para>
Show generic help.  Note that the contents of this display will depend on the various configuration
options for RedBoot when it was built.
<screen>
RedBoot> <userinput>help</userinput>
Manage aliases kept in FLASH memory
   alias name [value]
Manage machine caches
   cache [ON | OFF]
Display/switch console channel
   channel [-1|&lt;channel number&gt;]
Compute a 32bit checksum [POSIX algorithm] for a range of memory
   cksum -b &lt;location&gt; -l &lt;length&gt;
Display (hex dump) a range of memory
   dump -b &lt;location&gt; [-l &lt;length&gt;] [-s] [-1|-2|-4]
Manage FLASH images
   fis {cmds}
Manage configuration kept in FLASH memory
   fconfig [-i] [-l] [-n] [-f] [-d] | [-d] nickname [value]
Execute code at a location
   go [-w &lt;timeout&gt;] [entry]
Uncompress GZIP compressed data
   gunzip -s &lt;location&gt; -d &lt;location&gt;
Help about help?
   help [&lt;topic&gt;]
Read I/O location
   iopeek [-b &lt;location&gt;] [-1|2|4]
Write I/O location
   iopoke [-b &lt;location&gt;] [-1|2|4] -v &lt;value&gt;
Set/change IP addresses
   ip_address [-l &lt;local_ip_address&gt;[/&lt;mask_length&gt;]] [-h &lt;server_address&gt;]
Load a file
   load [-r] [-v] [-d] [-h &lt;host&gt;] [-m {TFTP | HTTP | {x|y}MODEM -c &lt;channel_number&gt;}]
        [-b &lt;base_address&gt;] &lt;file_name&gt;
Compare two blocks of memory
   mcmp -s &lt;location&gt; -d &lt;location&gt; -l &lt;length&gt; [-1|-2|-4]
Fill a block of memory with a pattern
   mfill -b &lt;location&gt; -l &lt;length&gt; -p &lt;pattern&gt;
  [-1|-2|-4]
Network connectivity test
   ping [-v] [-n &lt;count&gt;] [-l &lt;length&gt;] [-t &lt;timeout&gt;] [-r &lt;rate&gt;]
        [-i &lt;IP_addr&gt;] -h &lt;IP_addr&gt;
Reset the system
   reset 
Display RedBoot version information
   version 
Display (hex dump) a range of memory
   x -b &lt;location&gt; [-l &lt;length&gt;] [-s] [-1|-2|-4]
</screen> 
      </para>
      <para>
Help about a command with sub-commands.
<screen>
RedBoot> <userinput>help fis</userinput>
Manage FLASH images
   fis {cmds}
Create an image
  fis create -b &lt;mem_base&gt; -l &lt;image_length&gt; [-s &lt;data_length&gt;]
      [-f &lt;flash_addr&gt;] [-e &lt;entry_point&gt;] [-r &lt;ram_addr&gt;] [-n] &lt;name&gt;
Display an image from FLASH Image System [FIS]
  fis delete name
Erase FLASH contents
  fis erase -f &lt;flash_addr&gt; -l &lt;length&gt;
Display free [available] locations within FLASH Image System [FIS]
  fis free 
Initialize FLASH Image System [FIS]
  fis init [-f]
Display contents of FLASH Image System [FIS]
  fis list [-c] [-d]
Load image from FLASH Image System [FIS] into RAM
  fis load [-d] [-b &lt;memory_load_address&gt;] [-c] name
Write raw data directly to FLASH
  fis write -f &lt;flash_addr&gt; -b &lt;mem_base&gt; -l &lt;image_length&gt;
</screen> 
      </para>
    </refsect1>
  </refentry>

<!-- ******** iopeek *************************************************** -->
  <refentry id="iopeek-command">
  <refnamediv>
    <refname>iopeek</refname>
    <refpurpose>Read I/O location</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <cmdsynopsis>
      <command>iopeek</command>
      <arg>-b <replaceable> location</replaceable></arg>
      <group>
        <arg>-1</arg>
        <arg>-2</arg>
        <arg>-4</arg>
      </group>
    </cmdsynopsis>
  </refsynopsisdiv>      
  <refsect1>
    <title>Arguments</title>
    <informaltable frame="all">
      <tgroup cols="4" colsep="1" rowsep="1" align="left">
        <colspec colname="c1">
        <colspec colname="c2">
        <colspec colname="c3">
        <colspec colname="c4">
        <thead>
          <row>
            <entry>Name</entry>
            <entry>Type</entry>
            <entry>Description</entry>
            <entry>Default</entry>
          </row>
        </thead>
        <tbody>
          <row>
            <entry>-b <replaceable>location</replaceable></entry>             
            <entry>I/O address</entry>
            <entry>I/O Location.</entry>             
            <entry><emphasis>none</emphasis></entry>             
          </row>
          <row>
            <entry>-1</entry>             
            <entry></entry>
            <entry>Access a one byte (8 bit) I/O location.</entry>             
            <entry>-1</entry>             
          </row>
          <row>
            <entry>-2</entry>             
            <entry></entry>
            <entry>Access a two byte (16 bit) I/O location.</entry>             
            <entry>-1</entry>             
          </row>
          <row>
            <entry>-4</entry>             
            <entry></entry>
            <entry>Access a one word (32 bit) I/O location.</entry>             
            <entry>-1</entry>             
          </row>
        </tbody>
      </tgroup>
    </informaltable>
  </refsect1>
  <refsect1>
    <title>Description</title>
      <para>Reads a value from the I/O address space.</para>
  </refsect1>
  <refsect1>
    <title>Examples</title>
    <para>
Examine 8 bit value at I/O location 0x3F8.
<screen> 
RedBoot> <userinput>iopeek -b 0x3f8</userinput>
0x03f8 = 0x30
</screen> 
</para>
     <para>
Examine 32 bit value at I/O location 0x3f8.
<screen> 
RedBoot> <userinput>iopeek -b 0x3f8 -4</userinput>
0x03f8 = 0x03c10065
</screen>
</para>
    </refsect1>
  </refentry>

<!-- ******** iopoke *************************************************** -->
  <refentry id="iopoke-command">
  <refnamediv>
    <refname>iopoke</refname>
    <refpurpose>Write I/O location</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <cmdsynopsis>
      <command>iopoke</command>
      <arg>-b <replaceable> location</replaceable></arg>
      <group>
        <arg>-1</arg>
        <arg>-2</arg>
        <arg>-4</arg>
      </group>
      <arg>-v <replaceable> value</replaceable></arg>
    </cmdsynopsis>
  </refsynopsisdiv>      
  <refsect1>
    <title>Arguments</title>
    <informaltable frame="all">
      <tgroup cols="4" colsep="1" rowsep="1" align="left">
        <colspec colname="c1">
        <colspec colname="c2">
        <colspec colname="c3">
        <colspec colname="c4">
        <thead>
          <row>
            <entry>Name</entry>
            <entry>Type</entry>
            <entry>Description</entry>
            <entry>Default</entry>
          </row>
        </thead>
        <tbody>
          <row>
            <entry>-b <replaceable>location</replaceable></entry>             
            <entry>I/O address</entry>
            <entry>I/O Location.</entry>             
            <entry><emphasis>none</emphasis></entry>             
          </row>
          <row>
            <entry>-1</entry>             
            <entry></entry>
            <entry>Access a one byte (8 bit) I/O location. 
Only the 8 least significant bits of value will be used</entry>             
            <entry>-1</entry>             
          </row>
          <row>
            <entry>-2</entry>             
            <entry></entry>
            <entry>Access a two byte (16 bit) I/O location.
Only the 16 least significant bits of value will be used</entry>             
            <entry>-1</entry>             
          </row>
          <row>
            <entry>-4</entry>             
            <entry></entry>
            <entry>Access a one word (32 bit) I/O location.</entry>             
            <entry>-1</entry>             
          </row>
        </tbody>
      </tgroup>
    </informaltable>
  </refsect1>
  <refsect1>
    <title>Description</title>
      <para>Writes a value to the I/O address space.</para>
  </refsect1>
  <refsect1>
    <title>Examples</title>
    <para>
Write 0x0123 to 16 bit I/O location 0x200.
<screen> 
RedBoot> <userinput>iopoke -b 0x200 -v 0x123 -2</userinput>
</screen> 
</para>
    </refsect1>
  </refentry>

<!-- ******** gunzip *************************************************** -->
  <refentry id="gunzip-command">
  <refnamediv>
    <refname>gunzip</refname>
    <refpurpose>Uncompress GZIP compressed data</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <cmdsynopsis>
      <command>gunzip</command>
      <arg choice="req">-s <replaceable>source</replaceable></arg>
	  <arg choice="req">-d <replaceable>destination</replaceable></arg>
    </cmdsynopsis>
  </refsynopsisdiv>      
  <refsect1>
    <title>Arguments</title>
    <informaltable frame="all">
      <tgroup cols="4" colsep="1" rowsep="1" align="left">
        <colspec colname="c1">
        <colspec colname="c2">
        <colspec colname="c3">
        <colspec colname="c4">
        <thead>
          <row>
            <entry>Name</entry>
            <entry>Type</entry>
            <entry>Description</entry>
            <entry>Default</entry>
          </row>
        </thead>
        <tbody>
	      <row>
	        <entry>-s <replaceable>location1</replaceable></entry>	     
	        <entry>Memory address</entry>
	        <entry>Location of GZIP compressed data to uncompress.</entry>
	        <entry>Value set by last <command>load</command> or <command>fis load</command> command.</entry>	     
	      </row>
	      <row>
	        <entry>-d <replaceable>location2</replaceable></entry>
	        <entry>Memory address</entry>
	        <entry>Destination to write uncompressed data to.</entry>	     
	        <entry><emphasis>none</emphasis></entry>	     
	      </row>
        </tbody>
      </tgroup>
    </informaltable>
  </refsect1>
  <refsect1>
    <title>Description</title>
      <para>Uncompress GZIP compressed data.</para>
  </refsect1>
  <refsect1>
    <title>Examples</title>
    <para>
Uncompress data at location 0x100000 to 0x200000.
<screen> 
RedBoot> <userinput>gunzip -s 0x100000 -d 0x200000</userinput>
Decompressed 38804 bytes
</screen> 
</para>
    </refsect1>
  </refentry>

<!-- ******** ip_address *************************************************** -->
  <refentry id="ip-address-command">
    <refnamediv>
      <refname>ip_address</refname>
      <refpurpose>Set IP addresses</refpurpose>
    </refnamediv>
    <refsynopsisdiv>
      <cmdsynopsis>
	<command>ip_address</command>
        <arg>-b</arg>
	<arg>-l <replaceable> local_IP_address</replaceable>
	<arg choice=opt>/<replaceable>netmask_length</replaceable></arg> </arg>
	<arg>-h <replaceable> server_IP_address</replaceable></arg>
	<arg>-d <replaceable>
DNS_server_IP_address</replaceable></arg>
      </cmdsynopsis>
    </refsynopsisdiv>
    <refsect1>
      <title>Arguments</title>
      <informaltable frame="all">
	<tgroup cols="4" colsep="1" rowsep="1" align="left">
	  <colspec colname="c1">
	  <colspec colname="c2">
	  <colspec colname="c3">
	  <colspec colname="c4">
	  <thead>
	    <row>
	      <entry>Name</entry>
	      <entry>Type</entry>
	      <entry>Description</entry>
	      <entry>Default</entry>
	    </row>
	  </thead>
	  <tbody>
            <row>
              <entry>-b</entry>
              <entry>Boolean</entry>
              <entry>Obtain an IP address using BOOTP or DHCP.</entry>
              <entry>don't use BOOTP/DHCP</entry>
            </row>
	    <row>
	      <entry>-l <replaceable>
local_IP_address</replaceable><option>[<replaceable>/netmask_length</replaceable>]</option></entry>	     
	      <entry>Numeric IP or DNS name</entry>
	      <entry>The IP address RedBoot should use, optionally
with the network mask length.</entry>	     
	      <entry><emphasis>none</emphasis></entry>	     
	    </row>
	    <row>
	      <entry>-h <replaceable>
server_IP_address</replaceable></entry>	     
	      <entry>Numeric IP or DNS name</entry>
	      <entry>The IP address of the default server. Use of this
address is implied by other commands, such as
<command>load</command>.</entry>	     
	      <entry><emphasis>none</emphasis></entry>	     
	    </row>
	    <row>
	      <entry>-d <replaceable>
DNS_server_IP_address</replaceable></entry>	     
	      <entry>Numeric IP or DNS name</entry>
	      <entry>The IP address of the DNS server.</entry>	     
	      <entry><emphasis>none</emphasis></entry>	     
	    </row>
	  </tbody>
	</tgroup>
      </informaltable>
    </refsect1>
    <refsect1>
      <title>Description</title>
      <para>The <command>ip_address</command> command is used to show and/or change the basic IP
addresses used by RedBoot. IP addresses may be given as numeric
values, e.g. 192.168.1.67, or as symbolic names such as www.redhat.com
if DNS support is enabled.
      </para>
      <para>
The <option>-b</option> option is used to cause the target to perform a bootp or dhcp negotiation to get an IP address.
      </para>
      <para>
The <option>-l</option> option is used to set the IP address used by
the target device. The network mask length can also be specified
      </para>
      <para>
The <option>-h</option> option is used to set the default server
address, such as is used by the <command>load</command> command.
      </para>
      <para>
The <option>-d</option> option is used to set the default DNS server
address which is used for resolving symbolic network addresses. Note
that an address of 0.0.0.0 will disable DNS lookups.
      </para>
    </refsect1>
    <refsect1>
      <title>Examples</title>
      <para>
Display the current network settings. 
<screen> 
RedBoot> <userinput>ip_address</userinput> 
IP: 192.168.1.31, Default server: 192.168.1.101, DNS server IP: 0.0.0.0 
</screen> 
</para>
<para>
Change the DNS server address. 
<screen> 
RedBoot> <userinput>ip_address -d 192.168.1.101</userinput> 
IP: 192.168.1.31, Default server: 192.168.1.101, DNS server IP: 192.168.1.101 
</screen> 
</para>
<para>
Change the default server address. 
<screen> 
RedBoot> <userinput>ip_address -h 192.168.1.104</userinput> 
IP: 192.168.1.31, Default server: 192.168.1.104, DNS server IP: 192.168.1.101
</screen>
</para>
<para>
Set the IP address to something new, with a 255.255.255.0 netmask
<screen> 
RedBoot> <userinput>ip_address -l 192.168.1.32/24</userinput> 
IP: 192.168.1.32, Default server: 192.168.1.104, DNS server IP: 192.168.1.101
</screen>
      </para>
    </refsect1>
  </refentry>

<!-- ******** load *************************************************** -->
  <refentry id="download-command">
    <refnamediv>
      <refname>load</refname>
      <refpurpose>Download programs or data to the RedBoot platform</refpurpose>
    </refnamediv>
    <refsynopsisdiv>
      <cmdsynopsis>
	<command>load</command>
	<arg>-v </arg>
	<arg>-d </arg>
	<arg>-r </arg>
	<arg>-m
          <group>
            <arg choice="req"><group>
              <arg>xmodem</arg>
              <arg>ymodem</arg>
            </group></arg>
            <arg>tftp</arg>
            <arg>disk</arg>
	  </group>
        </arg>  
	<arg>-h <replaceable> server_IP_address</replaceable></arg>
	<arg>-b <replaceable> location</replaceable></arg>
	<arg>-c <replaceable> channel</replaceable></arg>
        <arg><replaceable>file_name</replaceable></arg>
      </cmdsynopsis>
    </refsynopsisdiv>
    <refsect1>
      <title>Arguments</title>
      <informaltable frame="all">
	<tgroup cols="4" colsep="1" rowsep="1" align="left">
	  <colspec colname="c1">
	  <colspec colname="c2">
	  <colspec colname="c3">
	  <colspec colname="c4">
	  <thead>
	    <row>
	      <entry>Name</entry>
	      <entry>Type</entry>
	      <entry>Description</entry>
	      <entry>Default</entry>
	    </row>
	  </thead>
	  <tbody>
	    <row>
	      <entry>-v</entry>	     
	      <entry>Boolean</entry>
	      <entry>Display a small spinner (indicator)
while the download is in  progress. This is just for feedback, especially
during long loads. Note that the option has no effect when using a
serial download method since it would interfere with the protocol.</entry>	     
	      <entry><emphasis>quiet</emphasis></entry>	     
	    </row>
	    <row>
	      <entry>-d</entry>	     
	      <entry>Boolean</entry>
	      <entry>Decompress data stream (gzip data)</entry>	     
	      <entry><emphasis>non-compressed data</emphasis></entry>	     
	    </row>
	    <row>
	      <entry>-r</entry>	     
	      <entry>Boolean</entry>
	      <entry>Raw (or binary) data</entry>	     
	      <entry><emphasis>formatted (S-records, ELF image, etc)</emphasis></entry>	     
	    </row>
	    <row>
	      <entry>-m tftp</entry>	     
	      <entry></entry>
	      <entry>Transfer data via the network using <acronym>TFTP</acronym> protocol.</entry>	     
	      <entry><acronym>TFTP</acronym></entry>	     
	    </row>
	    <row>
	      <entry>-m http</entry>	     
	      <entry></entry>
	      <entry>Transfer data via the network using <acronym>HTTP</acronym> protocol.</entry>	     
	      <entry><acronym>TFTP</acronym></entry>	     
	    </row>
	    <row>
	      <entry>-m xmodem</entry>	     
	      <entry></entry>
	      <entry>Transfer data using <emphasis>X-modem</emphasis> protocol.</entry>	     
	      <entry><acronym>TFTP</acronym></entry>	     
	    </row>
	    <row>
	      <entry>-m ymodem</entry>	     
	      <entry></entry>
	      <entry>Transfer data using <emphasis>Y-modem</emphasis> protocol.</entry>	     
	      <entry><acronym>TFTP</acronym></entry>	     
	    </row>
	    <row>
	      <entry>-m disk</entry>	     
	      <entry></entry>
	      <entry>Transfer data from a local disk.</entry>	     
	      <entry><acronym>TFTP</acronym></entry>	     
	    </row>
	    <row>
	      <entry>-h <replaceable>server_IP_address</replaceable></entry>	     
	      <entry>Numeric IP or DNS name</entry>
	      <entry>The IP address of the <acronym>TFTP</acronym> or <acronym>HTTP</acronym> server.</entry>	     
	      <entry>Value set by <command>ip_address</command></entry>	     
	    </row>
	    <row>
	      <entry>-b <replaceable>location</replaceable></entry>	     
	      <entry>Number</entry>
	      <entry>Address in memory to load the data.  Formatted data streams will have
an implied load address which this option may override.</entry>	     
	      <entry><emphasis>Depends on data format</emphasis></entry>	     
	    </row>
	    <row>
	      <entry>-c <replaceable>channel</replaceable></entry>	     
	      <entry>Number</entry>
	      <entry>Specify which I/O channel to
use for download.  This option is only supported when using either
xmodem or ymodem protocol.</entry>	     
	      <entry><emphasis>Depends on data format</emphasis></entry>	     
	    </row>
	    <row>
	      <entry><replaceable>file_name</replaceable></entry>	     
	      <entry>String</entry>
	      <entry>The name of the file on the <acronym>TFTP</acronym> or <acronym>HTTP</acronym>
server or the local disk. Details of how this is specified for <acronym>TFTP</acronym> are
host-specific. For local disk files, the name must be in <emphasis>disk</emphasis>:
<emphasis>filename</emphasis> format. The disk portion must match one of the disk
names listed by the <command>disks</command> command.</entry>	     
	      <entry><emphasis>None</emphasis></entry>	     
	    </row>
	  </tbody>
	</tgroup>
      </informaltable>
    </refsect1>
    <refsect1>
      <title>Description</title>
      <para>
The <command>load</command> command is used to download
data into the target system. Data can be loaded via a network connection,
using either the <acronym>TFTP</acronym> or <acronym>HTTP</acronym> protocols, or the console serial connection using the
X/Y modem protocol. Files may also be loaded directly from local filesystems
on disk. Files to be downloaded may either be executable images in 
ELF executable program format,
Motorola S-record (SREC)
format or raw data.
      </para>
    </refsect1>
    <refsect1>
      <title>Examples</title>
      <para>
Download a Motorola S-record (or ELF) image, using <acronym>TFTP</acronym>, specifying the 
base memory address.
<screen>
RedBoot> <userinput>load redboot.ROM -b 0x8c400000</userinput>
Address offset = 0x0c400000
Entry point: 0x80000000, address range: 0x80000000-0x8000fe80
</screen> 
      </para>
      <para>
Download a Motorola S-record (or ELF) image, using <acronym>HTTP</acronym>, specifying the
host [server] address.
<screen>
RedBoot> <userinput>load /redboot.ROM -m HTTP -h 192.168.1.104</userinput>
Address offset = 0x0c400000
Entry point: 0x80000000, address range: 0x80000000-0x8000fe80
</screen> 
      </para>
      <para>
Load an ELF file from /dev/hda1 which should be an EXT2 partition:
<screen>
RedBoot> <userinput>load -mode disk hda1:hello.elf</userinput>
Entry point: 0x00020000, address range: 0x00020000-0x0002fd70
</screen>
      </para>
    </refsect1>
  </refentry>

<!-- ******** mcmp *************************************************** -->
  <refentry id="mcmp-command">
    <refnamediv>
      <refname>mcmp</refname>
      <refpurpose>Compare two segments of memory</refpurpose>
    </refnamediv>
    <refsynopsisdiv>
      <cmdsynopsis>
	<command>mcmp</command>
	    <arg choice="req">-s <replaceable>location1</replaceable></arg>
	    <arg choice="req">-d <replaceable>location1</replaceable></arg>
	    <arg choice="req">-l <replaceable>length</replaceable></arg>
	  <group>
	    <arg>-1</arg>
	    <arg>-2</arg>
	    <arg>-4</arg>
	  </group>
      </cmdsynopsis>
    </refsynopsisdiv>
    <refsect1>
      <title>Arguments</title>
      <informaltable frame="all">
	<tgroup cols="4" colsep="1" rowsep="1" align="left">
	  <colspec colname="c1">
	  <colspec colname="c2">
	  <colspec colname="c3">
	  <colspec colname="c4">
	  <thead>
	    <row>
	      <entry>Name</entry>
	      <entry>Type</entry>
	      <entry>Description</entry>
	      <entry>Default</entry>
	    </row>
	  </thead>
	  <tbody>
	    <row>
	      <entry>-s <replaceable>location1</replaceable></entry>	     
	      <entry>Memory address</entry>
	      <entry>Location for start of data.</entry>	     
	      <entry><emphasis>none</emphasis></entry>	     
	    </row>
	    <row>
	      <entry>-d <replaceable>location2</replaceable></entry>	     
	      <entry>Memory address</entry>
	      <entry>Location for start of data.</entry>	     
	      <entry><emphasis>none</emphasis></entry>	     
	    </row>
	    <row>
	      <entry>-l <replaceable>length</replaceable></entry>	     
	      <entry>Number</entry>
	      <entry>Length of data</entry>	     
	      <entry><emphasis>none</emphasis></entry>	     
	    </row>
	    <row>
	      <entry>-1</entry>	     
	      <entry></entry>
	      <entry>Access one byte (8 bits) at a time.  
Only the least significant 8 bits of the pattern will be used.</entry>	     
	      <entry>-4</entry>	     
	    </row>
	    <row>
	      <entry>-2</entry>	     
	      <entry></entry>
	      <entry>Access two bytes (16 bits) at a time.  
Only the least significant 16 bits of the pattern will be used.</entry>	     
	      <entry>-4</entry>	     
	    </row>
	    <row>
	      <entry>-4</entry>	     
	      <entry></entry>
	      <entry>Access one word (32 bits) at a time.</entry>	     
	      <entry>-4</entry>	     
	    </row>
	  </tbody>
	</tgroup>
      </informaltable>
    </refsect1>
    <refsect1>
      <title>Description</title>
	<para>Compares the contents of two ranges of memory (RAM, ROM, FLASH, etc).</para>
    </refsect1>
    <refsect1>
      <title>Examples</title>
      <para>
Compare two buffers which match (result is <emphasis>quiet</emphasis>).
<screen> 
RedBoot> <userinput>mfill -b 0x100000 -l 0x20 -p 0xDEADFACE</userinput>
RedBoot> <userinput>mfill -b 0x200000 -l 0x20 -p 0xDEADFACE</userinput>
RedBoot> <userinput>mcmp -s 0x100000 -d 0x200000 -l 0x20</userinput>
</screen> 
</para>
<para>
Compare two buffers which don't match.  
Only the first non-matching element is displayed.
<screen> 
RedBoot> <userinput>mcmp -s 0x100000 -d 0x200000 -l 0x30 -2</userinput>
Buffers don't match - 0x00100020=0x6000, 0x00200020=0x0000
</screen> 
      </para>
    </refsect1>
  </refentry>

<!-- ******** mcopy *************************************************** -->
  <refentry id="mcopy-command">
    <refnamediv>
      <refname>mcopy</refname>
      <refpurpose>Copy memory</refpurpose>
    </refnamediv>
    <refsynopsisdiv>
      <cmdsynopsis>
	<command>mcopy</command>
	    <arg choice="req">-s <replaceable>source</replaceable></arg>
	    <arg choice="req">-d <replaceable>destination</replaceable></arg>
	    <arg choice="req">-l <replaceable>length</replaceable></arg>
	  <group>
	    <arg>-1</arg>
	    <arg>-2</arg>
	    <arg>-4</arg>
	  </group>
      </cmdsynopsis>
    </refsynopsisdiv>
    <refsect1>
      <title>Arguments</title>
      <informaltable frame="all">
	<tgroup cols="4" colsep="1" rowsep="1" align="left">
	  <colspec colname="c1">
	  <colspec colname="c2">
	  <colspec colname="c3">
	  <colspec colname="c4">
	  <thead>
	    <row>
	      <entry>Name</entry>
	      <entry>Type</entry>
	      <entry>Description</entry>
	      <entry>Default</entry>
	    </row>
	  </thead>
	  <tbody>
	    <row>
	      <entry>-s <replaceable>location1</replaceable></entry>	     
	      <entry>Memory address</entry>
	      <entry>Location of data to copy.</entry>	     
	      <entry><emphasis>none</emphasis></entry>	     
	    </row>
	    <row>
	      <entry>-d <replaceable>location2</replaceable></entry>	     
	      <entry>Memory address</entry>
	      <entry>Destination for copied data.</entry>	     
	      <entry><emphasis>none</emphasis></entry>	     
	    </row>
	    <row>
	      <entry>-l <replaceable>length</replaceable></entry>	     
	      <entry>Number</entry>
	      <entry>Length of data</entry>	     
	      <entry><emphasis>none</emphasis></entry>	     
	    </row>
	    <row>
	      <entry>-1</entry>	     
	      <entry></entry>
	      <entry>Copy one byte (8 bits) at a time.</entry>
	      <entry>-4</entry>	     
	    </row>
	    <row>
	      <entry>-2</entry>	     
	      <entry></entry>
	      <entry>Copy two bytes (16 bits) at a time.</entry>
	      <entry>-4</entry>	     
	    </row>
	    <row>
	      <entry>-4</entry>	     
	      <entry></entry>
	      <entry>Copy one word (32 bits) at a time.</entry>	     
	      <entry>-4</entry>	     
	    </row>
	  </tbody>
	</tgroup>
      </informaltable>
    </refsect1>
    <refsect1>
      <title>Description</title>
	<para>Copies memory (RAM, ROM, FLASH, etc) from one area to another.</para>
    </refsect1>
    <refsect1>
      <title>Examples</title>
      <para>
Copy 16 bits at a time.
<screen> 
RedBoot> <userinput>mfill -b 0x100000 -l 0x20 -2 -p 0xDEAD</userinput>
RedBoot> <userinput>mfill -b 0x200000 -l 0x20 -2 -p 0x0</userinput>
RedBoot> <userinput>dump  -b 0x200000 -l 0x20 -2</userinput>
00200000: 0000 0000 0000 0000  0000 0000 0000 0000
00200010: 0000 0000 0000 0000  0000 0000 0000 0000
RedBoot> <userinput>mcopy -s 0x100000 -d 0x200000 -2 -l 0x20</userinput>
RedBoot> <userinput>dump  -b 0x200000 -l 0x20 -2</userinput>
00200000: DEAD DEAD DEAD DEAD  DEAD DEAD DEAD DEAD
00200010: DEAD DEAD DEAD DEAD  DEAD DEAD DEAD DEAD
</screen> 
</para>
    </refsect1>
  </refentry>

<!-- ******** mfill *************************************************** -->
  <refentry id="mfill-command">
    <refnamediv>
      <refname>mfill</refname>
      <refpurpose>Fill RAM with a specified pattern</refpurpose>
    </refnamediv>
    <refsynopsisdiv>
      <cmdsynopsis>
	<command>mfill</command>
	    <arg choice="req">-b <replaceable>location</replaceable></arg>
	    <arg choice="req">-l <replaceable>length</replaceable></arg>
	    <arg choice="req">-p <replaceable>value</replaceable></arg>
	  <group>
	    <arg>-1</arg>
	    <arg>-2</arg>
	    <arg>-4</arg>
	  </group>
      </cmdsynopsis>
    </refsynopsisdiv>
    <refsect1>
      <title>Arguments</title>
      <informaltable frame="all">
	<tgroup cols="4" colsep="1" rowsep="1" align="left">
	  <colspec colname="c1">
	  <colspec colname="c2">
	  <colspec colname="c3">
	  <colspec colname="c4">
	  <thead>
	    <row>
	      <entry>Name</entry>
	      <entry>Type</entry>
	      <entry>Description</entry>
	      <entry>Default</entry>
	    </row>
	  </thead>
	  <tbody>
	    <row>
	      <entry>-b <replaceable>location</replaceable></entry>	     
	      <entry>Memory address</entry>
	      <entry>Location in memory for start of data.</entry>	     
	      <entry><emphasis>none</emphasis></entry>	     
	    </row>
	    <row>
	      <entry>-l <replaceable>length</replaceable></entry>	     
	      <entry>Number</entry>
	      <entry>Length of data</entry>	     
	      <entry><emphasis>none</emphasis></entry>	     
	    </row>
	    <row>
	      <entry>-p <replaceable>pattern</replaceable></entry>	     
	      <entry>Number</entry>
	      <entry>Data value to fill with</entry>	     
	      <entry>0</entry>	     
	    </row>
	    <row>
	      <entry>-1</entry>	     
	      <entry></entry>
	      <entry>Access one byte (8 bits) at a time.  
Only the least significant 8 bits of the pattern will be used.</entry>	     
	      <entry>-4</entry>	     
	    </row>
	    <row>
	      <entry>-2</entry>	     
	      <entry></entry>
	      <entry>Access two bytes (16 bits) at a time.  
Only the least significant 16 bits of the pattern will be used.</entry>	     
	      <entry>-4</entry>	     
	    </row>
	    <row>
	      <entry>-4</entry>	     
	      <entry></entry>
	      <entry>Access one word (32 bits) at a time.</entry>	     
	      <entry>-4</entry>	     
	    </row>
	  </tbody>
	</tgroup>
      </informaltable>
    </refsect1>
    <refsect1>
      <title>Description</title>
	<para>Fills a range of memory with the given pattern.</para>
    </refsect1>
    <refsect1>
      <title>Examples</title>
      <para>
Fill a buffer with zeros.
<screen> 
RedBoot> <userinput>x -b 0x100000 -l 0x20</userinput>
00100000: 00 3E 00 06 00 06 00 06  00 00 00 00 00 00 00 00  |.>..............|
00100010: 00 00 00 78 00 70 00 60  00 60 00 60 00 60 00 60  |...x.p.`.`.`.`.`|
RedBoot> <userinput>mfill -b 0x100000 -l 0x20</userinput>
RedBoot> <userinput>x -b 0x100000 -l 0x20</userinput>
00100000: 00 00 00 00 00 00 00 00  00 00 00 00 00 00 00 00  |................|
00100010: 00 00 00 00 00 00 00 00  00 00 00 00 00 00 00 00  |................|
</screen> 
</para>
<para>
Fill a buffer with a pattern.
<screen> 
RedBoot> <userinput>mfill -b 0x100000 -l 0x20 -p 0xDEADFACE</userinput>
RedBoot> <userinput>x -b 0x100000 -l 0x20</userinput>
00100000: CE FA AD DE CE FA AD DE  CE FA AD DE CE FA AD DE  |................|
00100010: CE FA AD DE CE FA AD DE  CE FA AD DE CE FA AD DE  |................|
</screen> 
      </para>
    </refsect1>
  </refentry>

<!-- ******** ping *************************************************** -->
  <refentry id="ping-command">
    <refnamediv>
      <refname>ping</refname>
      <refpurpose>Verify network connectivity</refpurpose>
    </refnamediv>
    <refsynopsisdiv>
      <cmdsynopsis>
	<command>ping</command>
	<arg>-v </arg>
	<arg>-i <replaceable> local_IP_address</replaceable></arg>
	<arg>-l <replaceable> length</replaceable></arg>
	<arg>-n <replaceable> count</replaceable></arg>
	<arg>-t <replaceable> timeout</replaceable></arg>
	<arg>-r <replaceable> rate</replaceable></arg>
	<arg choice="req">-h <replaceable> server_IP_address</replaceable></arg>
      </cmdsynopsis>
    </refsynopsisdiv>
    <refsect1>
      <title>Arguments</title>
      <informaltable frame="all">
	<tgroup cols="4" colsep="1" rowsep="1" align="left">
	  <colspec colname="c1">
	  <colspec colname="c2">
	  <colspec colname="c3">
	  <colspec colname="c4">
	  <thead>
	    <row>
	      <entry>Name</entry>
	      <entry>Type</entry>
	      <entry>Description</entry>
	      <entry>Default</entry>
	    </row>
	  </thead>
	  <tbody>
	    <row>
	      <entry>-v</entry>	     
	      <entry>Boolean</entry>
	      <entry>Be verbose, displaying information about each packet sent.</entry>	     
	      <entry><emphasis>quiet</emphasis></entry>	     
	    </row>
	    <row>
	      <entry>-n <replaceable>local_IP_address</replaceable></entry>	     
	      <entry>Number</entry>
	      <entry>Controls the number of packets to be sent.</entry>	     
	      <entry>10</entry>	     
	    </row>
	    <row>
	      <entry>-i <replaceable>local_IP_address</replaceable></entry>	     
	      <entry>Numeric IP or DNS name</entry>
	      <entry>The IP address RedBoot should use.</entry>	     
	      <entry>Value set by <command>ip_address</command></entry>	     
	    </row>
	    <row>
	      <entry>-h <replaceable>server_IP_address</replaceable></entry>	     
	      <entry>Numeric IP or DNS name</entry>
	      <entry>The IP address of the host to contact.</entry>
	      <entry><emphasis>none</emphasis></entry>	     
	    </row>
	    <row>
	      <entry>-l <replaceable>length</replaceable></entry>	     
	      <entry>Number</entry>
	      <entry>The length of the ICMP data payload.</entry>	     
	      <entry>64</entry>	     
	    </row>
	    <row>
	      <entry>-r <replaceable>length</replaceable></entry>	     
	      <entry>Number</entry>
	      <entry>How fast to deliver packets, i.e. time between successive sends.
A value of 0 sends packets as quickly as possible.</entry>	     
	      <entry>1000ms (1 second)</entry>	     
	    </row>
	    <row>
	      <entry>-t <replaceable>length</replaceable></entry>	     
	      <entry>Number</entry>
	      <entry>How long to wait for the round-trip to complete, specified in milliseconds.</entry>	     
	      <entry>1000ms (1 second)</entry>	     
	    </row>
	  </tbody>
	</tgroup>
      </informaltable>
    </refsect1>
    <refsect1>
      <title>Description</title>
      <para>
The <command>ping</command> command checks the connectivity of the local network by sending
special (ICMP) packets to a specific host. These packets should be automatically
returned by that host. The command will indicate how many of these round-trips
were successfully completed. 
      </para>
    </refsect1>
    <refsect1>
      <title>Examples</title>
      <para>
Test connectivity to host 192.168.1.101.
<screen>
RedBoot> <userinput>ping -h 192.168.1.101</userinput>
Network PING - from 192.168.1.31 to 192.168.1.101
PING - received 10 of 10 expected
</screen> 
</para>
<para>
Test connectivity to host 192.168.1.101, with verbose reporting.
<screen>
RedBoot> <userinput>ping -h 192.168.1.101 -v -n 4</userinput>
Network PING - from 192.168.1.31 to 192.168.1.101
 seq: 1, time: 1 (ticks)
 seq: 2, time: 1 (ticks)
 seq: 3, time: 1 (ticks)
 seq: 4, time: 1 (ticks)
PING - received 10 of 10 expected
</screen> 
</para>
<para>
<screen>
Test connectivity to a non-existent host (192.168.1.109).
RedBoot> <userinput>ping -h 192.168.1.109 -v -n 4</userinput>
PING: Cannot reach server '192.168.1.109' (192.168.1.109)
</screen> 
      </para>
    </refsect1>
  </refentry>

<!-- ******** reset *************************************************** -->
  <refentry id="reset-command">
    <refnamediv>
      <refname>reset</refname>
      <refpurpose>Reset the device</refpurpose>
    </refnamediv>
    <refsynopsisdiv>
      <cmdsynopsis>
	<command>reset</command>
      </cmdsynopsis>
    </refsynopsisdiv>
    <refsect1>
      <title>Arguments</title>
<para><emphasis>None</emphasis></para>
    </refsect1>
    <refsect1>
      <title>Description</title>
      <para>
The <command>reset</command> command causes the target platform to be reset.
Where possible (hardware support permitting), this will be
equivalent to a power-on reset condition.
      </para>
    </refsect1>
    <refsect1>
      <title>Examples</title>
      <para>
Reset the platform.
<screen>
RedBoot> <userinput>reset</userinput>
... Resetting.+... Waiting for network card: .
Socket Communications, Inc: Low Power Ethernet CF Revision C 5V/3.3V 08/27/98
Ethernet eth0: MAC address 00:c0:1b:00:ba:28
IP: 192.168.1.29, Default server: 192.168.1.101

RedBoot(tm) bootstrap and debug environment [ROM]
Non-certified release, version UNKNOWN - built 10:41:41, May 14 2002

Platform: Compaq iPAQ Pocket PC (StrongARM 1110) 
Copyright (C) 2000, 2001, 2002, Red Hat, Inc.

RAM: 0x00000000-0x01fc0000, 0x00014748-0x01f71000 available
FLASH: 0x50000000 - 0x51000000, 64 blocks of 0x00040000 bytes each.
RedBoot> 
</screen> 
      </para>
    </refsect1>
  </refentry>


<!-- ******** version *************************************************** -->
  <refentry id="version-command">
    <refnamediv>
      <refname>version</refname>
      <refpurpose>Display RedBoot version information</refpurpose>
    </refnamediv>
    <refsynopsisdiv>
      <cmdsynopsis>
	<command>version</command>
      </cmdsynopsis>
    </refsynopsisdiv>
    <refsect1>
      <title>Arguments</title>
      <para><emphasis>None</emphasis></para>
    </refsect1>
    <refsect1>
      <title>Description</title>
      <para>The <command>version</command> command simply displays version information about RedBoot.
      </para>
    </refsect1>
    <refsect1>
      <title>Examples</title>
      <para>
Display RedBoot's version.
<screen>
RedBoot> <userinput>version</userinput>
RedBoot(tm) debug environment - built 09:12:03, Feb 12 2001
Platform: XYZ (PowerPC 860)
Copyright (C) 2000, 2001, Red Hat, Inc.
RAM: 0x00000000-0x00400000
</screen> 
      </para>
    </refsect1>
  </refentry>

</sect1>
 
<sect1 id="Flash-Image-System">
<title>Flash Image System (FIS)</title>
<para><indexterm><primary>commands</primary><secondary>flash image system
</secondary></indexterm><indexterm><primary>flash image system commands</primary>
</indexterm><indexterm><primary>commands</primary><secondary>fis</secondary>
</indexterm><indexterm><primary>fis commands</primary></indexterm>If the platform
has flash memory, RedBoot can use this for image storage. Executable images,
as well as data, can be stored in flash in a simple file store. The <command>
fis</command> command (fis is short for Flash Image System) is used to
manipulate and maintain flash images.
</para>

<!-- ******** fis init ************************************************ -->

  <refentry id="fis-init-command">
    <refnamediv>
      <refname>fis init</refname>
      <refpurpose>Initialize Flash Image System (FIS)</refpurpose>
    </refnamediv>
    <refsynopsisdiv>
      <cmdsynopsis>
	<command>fis init</command>
	<arg><replaceable>-f</replaceable></arg>
      </cmdsynopsis>
    </refsynopsisdiv>
    <refsect1>
      <title>Arguments</title>
      <informaltable frame="all">
	<tgroup cols="4" colsep="1" rowsep="1" align="left">
	  <colspec colname="c1">
	  <colspec colname="c2">
	  <colspec colname="c3">
	  <colspec colname="c4">
	  <thead>
	    <row>
	      <entry>Name</entry>
	      <entry>Type</entry>
	      <entry>Description</entry>
	      <entry>Default</entry>
	    </row>
	  </thead>
	  <tbody>
	    <row>
	      <entry>-f</entry>	     
	      <entry></entry>
	      <entry>All blocks of flash memory (except for the boot
	      blocks) will be erased as part of the initialization
	      procedure.</entry>
	      <entry></entry>	     
	    </row>
	  </tbody>
	</tgroup>
      </informaltable>
    </refsect1>
    <refsect1>
      <title>Description</title>

       <para>This command is used to initialize the Flash Image System
       (FIS). It should normally only be executed once, when RedBoot
       is first installed on the hardware. If the reserved images or
       their sizes in the FIS change, due to a different configuration
       of RedBoot being used, it may be necessary to issue the command
       again though.

        <note><para>Subsequent executions will cause loss of
       previously stored information in the FIS.</para></note>
     </para>
    </refsect1>
    <refsect1>
      <title>Examples</title>
      <para>
Initialize the FIS directory.
<screen> 
RedBoot> <userinput>fis init</userinput>
About to initialize [format] flash image system - continue (y/n)? <userinput>y</userinput>
*** Initialize FLASH Image System
    Warning: device contents not erased, some blocks may not be usable
... Erase from 0x00070000-0x00080000: .
... Program from 0x0606f000-0x0607f000 at 0x00070000: .
</screen> 
</para>

      <para>
Initialize the FIS directory and all of flash memory, except for first
blocks of the flash where the boot monitor resides.
<screen> 
RedBoot> <userinput>fis init -f</userinput>
About to initialize [format] flash image system - continue (y/n)? <userinput>y</userinput>
*** Initialize FLASH Image System                                               
... Erase from 0x00020000-0x00070000: .....                                     
... Erase from 0x00080000-0x00080000:                                           
... Erase from 0x00070000-0x00080000: .                                         
... Program from 0x0606f000-0x0607f000 at 0x00070000: .                         
</screen> 
</para>
</refsect1>
</refentry>

<!-- ******** fis list ************************************************ -->
  <refentry id="fis-list-command">
    <refnamediv>
      <refname>fis list</refname>
      <refpurpose>List Flash Image System directory</refpurpose>
    </refnamediv>
    <refsynopsisdiv>
      <cmdsynopsis>
	<command>fis list</command>
	<arg><replaceable>-f</replaceable></arg>
      </cmdsynopsis>
    </refsynopsisdiv>
    <refsect1>
      <title>Arguments</title>
      <informaltable frame="all">
	<tgroup cols="4" colsep="1" rowsep="1" align="left">
	  <colspec colname="c1">
	  <colspec colname="c2">
	  <colspec colname="c3">
	  <colspec colname="c4">
	  <thead>
	    <row>
	      <entry>Name</entry>
	      <entry>Type</entry>
	      <entry>Description</entry>
	      <entry>Default</entry>
	    </row>
	  </thead>
	  <tbody>
	    <row>
	      <entry>-c</entry>
	      <entry></entry>
	      <entry>Show image checksum instead of memory address
	      (column <computeroutput>Mem addr</computeroutput> is
	      replaced by
	      <computeroutput>Checksum</computeroutput>).</entry>
	      <entry></entry>
	    </row>
	    <row>
	      <entry>-d</entry>
	      <entry></entry>
	      <entry>Show image data length instead of amount of flash
	      occupied by image (column
	      <computeroutput>Length</computeroutput> is replaced by
	      <computeroutput>Datalen</computeroutput>).</entry>
	      <entry></entry>
	    </row>
	  </tbody>
	</tgroup>
      </informaltable>
    </refsect1>
    <refsect1>
      <title>Description</title>
<para>This command lists the images currently available in the FIS. Certain
images used by RedBoot have fixed names and have reserved slots in the
FIS (these can be seen after using the <command>fis init</command>
command). Other images can be manipulated by the user.</para>
<note><para>The images are listed in the order they appear in the FIS
directory, not by name or creation time.</para></note>
    </refsect1>

    <refsect1>
      <title>Examples</title>
      <para>
List the FIS directory.
<screen> 
RedBoot> <userinput>fis list</userinput>
Name              FLASH addr  Mem addr    Length      Entry point               
RedBoot           0x00000000  0x00000000  0x00020000  0x00000000                
RedBoot config    0x0007F000  0x0007F000  0x00001000  0x00000000                
FIS directory     0x00070000  0x00070000  0x0000F000  0x00000000                
</screen> 
</para>

      <para>
List the FIS directory, with image checksums substituted for
memory addresses.
<screen> 
RedBoot> <userinput>fis list -c</userinput>
Name              FLASH addr  Checksum    Length      Entry point               
RedBoot           0x00000000  0x00000000  0x00020000  0x00000000                
RedBoot config    0x0007F000  0x00000000  0x00001000  0x00000000                
FIS directory     0x00070000  0x00000000  0x0000F000  0x00000000                
</screen> 
</para>

      <para>
List the FIS directory with image data lengths substituted for flash
block reservation lengths.
<screen> 
RedBoot> <userinput>fis list -d</userinput>
Name              FLASH addr  Mem addr    Datalen     Entry point               
RedBoot           0x00000000  0x00000000  0x00000000  0x00000000                
RedBoot config    0x0007F000  0x0007F000  0x00000000  0x00000000                
FIS directory     0x00070000  0x00070000  0x00000000  0x00000000                
</screen> 
</para>
</refsect1>
</refentry>

<!-- ******** fis free ************************************************ -->

  <refentry id="fis-free-command">
    <refnamediv>
      <refname>fis free</refname>
      <refpurpose>Free flash image</refpurpose>
    </refnamediv>
    <refsynopsisdiv>
      <cmdsynopsis>
	<command>fis free</command>
      </cmdsynopsis>
    </refsynopsisdiv>
    <refsect1>
      <title>Description</title>


<para>This command shows which areas of the flash memory are currently
not in use. When a block contains non-erased contents it is considered
in use. Since it is possible to force an image to be loaded at a
particular flash location, this command can be used to check whether
that location is in use by any other image.</para>

<note><para>There is currently no cross-checking between actual flash
contents and the FIS directory, which mans that there could be a
segment of flash which is not erased that does not correspond to a
named image, or vice-versa.</para></note>
    </refsect1>

    <refsect1>
      <title>Examples</title>
      <para>
Show free flash areas.
<screen>
RedBoot> <userinput>fis free</userinput>
        0xA0040000 .. 0xA07C0000
        0xA0840000 .. 0xA0FC0000
</screen></para>
</refsect1>
</refentry>

<!-- ******** fis create ************************************************ -->

  <refentry id="fis-create-command">
    <refnamediv>
      <refname>fis create</refname>
      <refpurpose>Create flash image</refpurpose>
    </refnamediv>
    <refsynopsisdiv>
      <cmdsynopsis>
	<command>fis create</command>
	<arg choice="req">-b <replaceable> data address</replaceable></arg>
	<arg choice="req">-l <replaceable> length</replaceable></arg>
	<arg>-f <replaceable> flash address</replaceable></arg>
	<arg>-e <replaceable> entry</replaceable></arg>
	<arg>-r <replaceable> relocation address</replaceable></arg>
	<arg>-s <replaceable> data length</replaceable></arg>
	<arg>-n </arg>
	<arg><replaceable>name</replaceable></arg>
      </cmdsynopsis>
    </refsynopsisdiv>
    <refsect1>
      <title>Arguments</title>
      <informaltable frame="all">
	<tgroup cols="4" colsep="1" rowsep="1" align="left">
	  <colspec colname="c1">
	  <colspec colname="c2">
	  <colspec colname="c3">
	  <colspec colname="c4">
	  <thead>
	    <row>
	      <entry>Name</entry>
	      <entry>Type</entry>
	      <entry>Description</entry>
	      <entry>Default</entry>
	    </row>
	  </thead>
	  <tbody>
	    <row>
	      <entry>-b</entry>
	      <entry>Number</entry>
	      <entry>Address of data to be written to the flash.</entry>
	      <entry>Address of last loaded file. If not set in a load
	      operation, it must be specified.</entry>
	    </row>
	    <row>
	      <entry>-l</entry>
	      <entry>Number</entry>
	      <entry>Length of flash area to occopy. If specified, and
	      the named image already exists, the length must match
	      the value in the FIS directory.</entry>
	      <entry>Length of area reserved in FIS directory if the
	      image already exists, or the length of the last loaded
	      file. If neither are set, it must be specified.</entry>
	    </row>
	    <row>
	      <entry>-f</entry>
	      <entry>Number</entry>
	      <entry>Address of flash area to occopy.</entry>
	      <entry>The address of an area reserved in the FIS
	      directory for extant images. Otherwise the first free block
	      which is large enough will be used.</entry>
	    </row>
	    <row>
	      <entry>-e</entry>
	      <entry>Number</entry>
	      <entry>Entry address for an executable image, used by
	      the <command>fis load</command> command.</entry>
	      <entry>The entry address of last loaded file.</entry>
	    </row>
	    <row>
	      <entry>-r</entry>
	      <entry>Number</entry>
	      <entry>Address where the image should be relocated to by
	      the <command>fis load</command> command. This is only
	      relevant for images that will be loaded with the
	      <command>fis load</command> command.</entry>
	      <entry>The load address of the last loaded file.</entry>
	    </row>
            <row>
	      <entry>-s</entry>
	      <entry>Number</entry>
	      <entry>Actual length of data written to image. This is
	      used to control the range over which the checksum is
	      made.</entry>
	      <entry>It defaults to the length of the last loaded
	      file.</entry>
	    </row>
	    <row>
	      <entry>-n</entry>
	      <entry></entry>
	      <entry>When set, no image data will be written to the
	      flash. Only the FIS directory will be updated.</entry>
	      <entry></entry>
	    </row>
	    <row>
	      <entry><replaceable>name</replaceable></entry>
	      <entry>String</entry>
	      <entry>Name of flash image.</entry>
	      <entry></entry>
	    </row>
	  </tbody>
	</tgroup>
      </informaltable>
    </refsect1>
    <refsect1>
      <title>Description</title>
<para>This command creates an image in the FIS directory. The data for the
image must exist in RAM memory before the copy. Typically, you would use the
RedBoot <command>load</command> command to load file into
RAM and then the <command>fis create</command> command to write
it to a flash image.</para>
</refsect1>

    <refsect1>
      <title>Examples</title>
      <para>Trying to create an extant image, will require the action
      to be verified.
<screen>
RedBoot> <userinput>fis create RedBoot -f 0xa0000000 -b 0x8c400000 -l 0x20000</userinput>
An image named &lsquo;RedBoot&rsquo; exists - continue (y/n)? <userinput>n</userinput>
</screen>
</para>

<para>Create a new test image, let the command find a suitable place.
<screen>
RedBoot> <userinput>fis create junk -b 0x8c400000 -l 0x20000</userinput>
... Erase from 0xa0040000-0xa0060000: .
... Program from 0x8c400000-0x8c420000 at 0xa0040000: .
... Erase from 0xa0fe0000-0xa1000000: .
... Program from 0x8c7d0000-0x8c7f0000 at 0xa0fe0000: .
</screen>
</para>

<para>Update the RedBoot[RAM] image.
<screen>
RedBoot> <userinput>load redboot_RAM.img</userinput>
Entry point: 0x060213c0, address range: 0x06020000-0x06036cc0                   
RedBoot> <userinput>fis create RedBoot[RAM]</userinput>
No memory address set.
An image named 'RedBoot[RAM]' exists - continue (y/n)? <userinput>y</userinput>
* CAUTION * about to program 'RedBoot[RAM]'
            at 0x00020000..0x00036cbf from 0x06020000 - continue (y/n)? <userinput>y</userinput>
... Erase from 0x00020000-0x00040000: ..
... Program from 0x06020000-0x06036cc0 at 0x00020000: ..
... Erase from 0x00070000-0x00080000: .
... Program from 0x0606f000-0x0607f000 at 0x00070000: .
</screen>
</para>
</refsect1>
</refentry>

<!-- ******** fis load ************************************************ -->

  <refentry id="fis-load-command">
    <refnamediv>
      <refname>fis load</refname>
      <refpurpose>Load flash image</refpurpose>
    </refnamediv>
    <refsynopsisdiv>
      <cmdsynopsis>
	<command>fis load</command>
	<arg>-b <replaceable> load address</replaceable></arg>
	<arg>-c </arg>
	<arg>-d </arg>
	<arg><replaceable>name</replaceable></arg>
      </cmdsynopsis>
    </refsynopsisdiv>
    <refsect1>
      <title>Arguments</title>
      <informaltable frame="all">
	<tgroup cols="4" colsep="1" rowsep="1" align="left">
	  <colspec colname="c1">
	  <colspec colname="c2">
	  <colspec colname="c3">
	  <colspec colname="c4">
	  <thead>
	    <row>
	      <entry>Name</entry>
	      <entry>Type</entry>
	      <entry>Description</entry>
	      <entry>Default</entry>
	    </row>
	  </thead>
	  <tbody>
	    <row>
	      <entry>-b</entry>
	      <entry>Number</entry>
	      <entry>Address the image should be loaded to. Executable
	      images normally load at the location to which the file
	      was linked. This option allows the image to be loaded to
	      a specific memory location, possibly overriding any
	      assumed location.</entry>
	      <entry>If not specified, the address associated with the
	      image in the FIS directory will be used.</entry>
	    </row>
	    <row>
	      <entry>-c</entry>
	      <entry></entry>
	      <entry>Compute and print the checksum of the image data
	      after it has been loaded into memory.</entry>
	    </row>
	    <row>
	      <entry>-d</entry>
	      <entry></entry>
	      <entry>Decompress gzipped image while copying it from
	      flash to RAM.</entry>
	    </row>
	    <row>
	      <entry><replaceable>name</replaceable></entry>
	      <entry>String</entry>
	      <entry>The name of the file, as shown in the FIS
	      directory.</entry>
	    </row>
	  </tbody>
	</tgroup>
      </informaltable>
    </refsect1>
    <refsect1>
      <title>Description</title>
<para>This command is used to transfer an image from flash memory to RAM.
</para>
<para>Once the image has been loaded, it may be executed using the
<command>go</command> command.</para>
</refsect1>

    <refsect1>
      <title>Examples</title>
<para>Load and run RedBoot[RAM] image.
<screen>
RedBoot> <userinput>fis load RedBoot[RAM]</userinput>
RedBoot> <userinput>go</userinput>
</screen>
</para>
</refsect1>
</refentry>

<!-- ******** fis delete ************************************************ -->

  <refentry id="fis-delete-command">
    <refnamediv>
      <refname>fis delete</refname>
      <refpurpose>Delete flash image</refpurpose>
    </refnamediv>
    <refsynopsisdiv>
      <cmdsynopsis>
	<command>fis delete</command>
	<arg choice="req"><replaceable>name</replaceable></arg>
      </cmdsynopsis>
    </refsynopsisdiv>
    <refsect1>
      <title>Arguments</title>
      <informaltable frame="all">
	<tgroup cols="4" colsep="1" rowsep="1" align="left">
	  <colspec colname="c1">
	  <colspec colname="c2">
	  <colspec colname="c3">
	  <colspec colname="c4">
	  <thead>
	    <row>
	      <entry>Name</entry>
	      <entry>Type</entry>
	      <entry>Description</entry>
	      <entry>Default</entry>
	    </row>
	  </thead>
	  <tbody>
	    <row>
	      <entry><replaceable>name</replaceable></entry>
	      <entry>Number</entry>
	      <entry>Name of image that should be deleted.</entry>
	      <entry></entry>
	    </row>
	  </tbody>
	</tgroup>
      </informaltable>
    </refsect1>
    <refsect1>
      <title>Description</title>
<para>This command removes an image from the FIS. The flash memory will be
erased as part of the execution of this command, as well as removal of the
name from the FIS directory.</para>

<note><para>Certain images are reserved by RedBoot and cannot be deleted.
RedBoot will issue a warning if this is attempted.</para></note>
</refsect1>
    <refsect1>
      <title>Examples</title>
<para>
<screen>
RedBoot> <userinput>fis list</userinput>
Name              flash addr   Mem addr    Length    Entry point
RedBoot          0xA0000000   0xA0000000  0x020000  0x80000000
RedBoot config   0xA0FC0000   0xA0FC0000  0x020000  0x00000000
FIS directory    0xA0FE0000   0xA0FE0000  0x020000  0x00000000
junk             0xA0040000   0x8C400000  0x020000  0x80000000
RedBoot> <userinput>fis delete junk</userinput>
Delete image &lsquo;junk&rsquo; - continue (y/n)? <userinput>y</userinput>
... Erase from 0xa0040000-0xa0060000: .
... Erase from 0xa0fe0000-0xa1000000: .
... Program from 0x8c7d0000-0x8c7f0000 at 0xa0fe0000: .
</screen>
</para>
</refsect1>
</refentry>

<!-- ******** fis lock ************************************************ -->

  <refentry id="fis-lock-command">
    <refnamediv>
      <refname>fis lock</refname>
      <refpurpose>Lock flash area</refpurpose>
    </refnamediv>
    <refsynopsisdiv>
      <cmdsynopsis>
	<command>fis lock</command>
	<arg choice="req">-f <replaceable>flash_address</replaceable></arg>
	<arg choice="req">-l <replaceable>length</replaceable></arg>
      </cmdsynopsis>
    </refsynopsisdiv>
    <refsect1>
      <title>Arguments</title>
      <informaltable frame="all">
	<tgroup cols="4" colsep="1" rowsep="1" align="left">
	  <colspec colname="c1">
	  <colspec colname="c2">
	  <colspec colname="c3">
	  <colspec colname="c4">
	  <thead>
	    <row>
	      <entry>Name</entry>
	      <entry>Type</entry>
	      <entry>Description</entry>
	      <entry>Default</entry>
	    </row>
	  </thead>
	  <tbody>
	    <row>
	      <entry><replaceable>flash_address</replaceable></entry>
	      <entry>Number</entry>
	      <entry>Address of area to be locked.</entry>
	      <entry></entry>
	    </row>
	    <row>
	      <entry><replaceable>length</replaceable></entry>
	      <entry>Number</entry>
	      <entry>Length of area to be locked.</entry>
	      <entry></entry>
	    </row>
	  </tbody>
	</tgroup>
      </informaltable>
    </refsect1>
    <refsect1>
      <title>Description</title>
<para>This command is used to write-protect (lock) a portion of flash memory,
to prevent accidental overwriting of images. In order to make make any modifications
to the flash, a matching <command>fis unlock</command> command must be
issued. This command is optional and will only be provided on hardware
which can support write-protection of the flash space.</para>
<note>
<para>Depending on the system, attempting to write to write-protected flash
may generate errors or warnings, or be benignly quiet.  </para>
</note>
</refsect1>

    <refsect1>
      <title>Examples</title>
<para>Lock an area of the flash
<screen>
RedBoot> <userinput>fis lock -f 0xa0040000 -l 0x20000</userinput>
... Lock from 0xa0040000-0xa0060000: .
</screen>
</para>
</refsect1>
</refentry>

<!-- ******** fis unlock ************************************************ -->

  <refentry id="fis-unlock-command">
    <refnamediv>
      <refname>fis unlock</refname>
      <refpurpose>Unlock flash area</refpurpose>
    </refnamediv>
    <refsynopsisdiv>
      <cmdsynopsis>
	<command>fis unlock</command>
	<arg choice="req">-f <replaceable>flash_address</replaceable></arg>
	<arg choice="req">-l <replaceable>length</replaceable></arg>
      </cmdsynopsis>
    </refsynopsisdiv>
    <refsect1>
      <title>Arguments</title>
      <informaltable frame="all">
	<tgroup cols="4" colsep="1" rowsep="1" align="left">
	  <colspec colname="c1">
	  <colspec colname="c2">
	  <colspec colname="c3">
	  <colspec colname="c4">
	  <thead>
	    <row>
	      <entry>Name</entry>
	      <entry>Type</entry>
	      <entry>Description</entry>
	      <entry>Default</entry>
	    </row>
	  </thead>
	  <tbody>
	    <row>
	      <entry><replaceable>flash_address</replaceable></entry>
	      <entry>Number</entry>
	      <entry>Address of area to be unlocked.</entry>
	      <entry></entry>
	    </row>
	    <row>
	      <entry><replaceable>length</replaceable></entry>
	      <entry>Number</entry>
	      <entry>Length of area to be unlocked.</entry>
	      <entry></entry>
	    </row>
	  </tbody>
	</tgroup>
      </informaltable>
    </refsect1>
    <refsect1>
      <title>Description</title>
<para>This command is used to unlock a portion of flash memory forcibly, allowing
it to be updated. It must be issued for regions which have been locked before
the FIS can reuse those portions of flash.</para>
<note>
<para>Some flash devices power up in locked state and always need to
be manually unlocked before they can be written to.</para></note>
</refsect1>

    <refsect1>
      <title>Examples</title>
<para>Unlock an area of the flash
<screen>
RedBoot> <userinput>fis unlock -f 0xa0040000 -l 0x20000</userinput>
... Unlock from 0xa0040000-0xa0060000: .
</screen>
</para>
</refsect1>
</refentry>

<!-- ******** fis erase ************************************************ -->

  <refentry id="fis-erase-command">
    <refnamediv>
      <refname>fis erase</refname>
      <refpurpose>Erase flash area</refpurpose>
    </refnamediv>
    <refsynopsisdiv>
      <cmdsynopsis>
	<command>fis erase</command>
	<arg choice="req">-f <replaceable>flash_address</replaceable></arg>
	<arg choice="req">-l <replaceable>length</replaceable></arg>
      </cmdsynopsis>
    </refsynopsisdiv>
    <refsect1>
      <title>Arguments</title>
      <informaltable frame="all">
	<tgroup cols="4" colsep="1" rowsep="1" align="left">
	  <colspec colname="c1">
	  <colspec colname="c2">
	  <colspec colname="c3">
	  <colspec colname="c4">
	  <thead>
	    <row>
	      <entry>Name</entry>
	      <entry>Type</entry>
	      <entry>Description</entry>
	      <entry>Default</entry>
	    </row>
	  </thead>
	  <tbody>
	    <row>
	      <entry><replaceable>flash_address</replaceable></entry>
	      <entry>Number</entry>
	      <entry>Address of area to be erased.</entry>
	      <entry></entry>
	    </row>
	    <row>
	      <entry><replaceable>length</replaceable></entry>
	      <entry>Number</entry>
	      <entry>Length of area to be erased.</entry>
	      <entry></entry>
	    </row>
	  </tbody>
	</tgroup>
      </informaltable>
    </refsect1>
    <refsect1>
      <title>Description</title>
<para>This command is used to erase a portion of flash memory forcibly. There
is no cross-checking to ensure that the area being erased does not correspond
to an existing image.</para>
</refsect1>

    <refsect1>
      <title>Examples</title>
<para>Erase an area of the flash
<screen>
RedBoot> <userinput>fis erase -f 0xa0040000 -l 0x20000</userinput>
... Erase from 0xa0040000-0xa0060000: .
</screen>
</para>
</refsect1>
</refentry>

<!-- ******** fis write ************************************************ -->

  <refentry id="fis-write-command">
    <refnamediv>
      <refname>fis write</refname>
      <refpurpose>Write flash area</refpurpose>
    </refnamediv>
    <refsynopsisdiv>
      <cmdsynopsis>
	<command>fis write</command>
	<arg choice="req">-b <replaceable>mem_address</replaceable></arg>
	<arg choice="req">-l <replaceable>length</replaceable></arg>
	<arg choice="req">-f <replaceable>flash_address</replaceable></arg>
      </cmdsynopsis>
    </refsynopsisdiv>
    <refsect1>
      <title>Arguments</title>
      <informaltable frame="all">
	<tgroup cols="4" colsep="1" rowsep="1" align="left">
	  <colspec colname="c1">
	  <colspec colname="c2">
	  <colspec colname="c3">
	  <colspec colname="c4">
	  <thead>
	    <row>
	      <entry>Name</entry>
	      <entry>Type</entry>
	      <entry>Description</entry>
	      <entry>Default</entry>
	    </row>
	  </thead>
	  <tbody>
	    <row>
	      <entry><replaceable>mem_address</replaceable></entry>
	      <entry>Number</entry>
	      <entry>Address of data to be written to flash.</entry>
	      <entry></entry>
	    </row>
	    <row>
	      <entry><replaceable>length</replaceable></entry>
	      <entry>Number</entry>
	      <entry>Length of data to be writtem.</entry>
	      <entry></entry>
	    </row>
	    <row>
	      <entry><replaceable>flash_address</replaceable></entry>
	      <entry>Number</entry>
	      <entry>Address of flash to write to.</entry>
	      <entry></entry>
	    </row>
	  </tbody>
	</tgroup>
      </informaltable>
    </refsect1>
    <refsect1>
      <title>Description</title>
<para>This command is used to write data from memory to flash. There
is no cross-checking to ensure that the area being written to does not
correspond to an existing image.</para>
</refsect1>

    <refsect1>
      <title>Examples</title>
<para>Write an area of data to the flash
<screen>
RedBoot> <userinput>fis write -b 0x0606f000 -l 0x1000 -f 0x00020000</userinput>
* CAUTION * about to program FLASH
            at 0x00020000..0x0002ffff from 0x0606f000 - continue (y/n)? <userinput>y</userinput>
... Erase from 0x00020000-0x00030000: .
... Program from 0x0606f000-0x0607f000 at 0x00020000: .
</screen>
</para>
</refsect1>
</refentry>

</sect1>
<sect1 id="Persistent-State-Flash">
<title>Persistent State Flash-based Configuration and Control</title>
<para><indexterm><primary>persistent state flash-based configuration and control
</primary></indexterm><indexterm><primary>flash-based configuration and control
</primary></indexterm><indexterm><primary>configuration and control</primary>
<secondary>flash-based</secondary></indexterm></para>
<para>RedBoot provides flash management support for storage in the flash memory
of multiple executable images and of non-volatile information such as IP addresses
and other network information.</para>
<para>RedBoot on platforms that support flash based configuration information
will report the following message the first time that RedBoot is booted on
the target:</para>
<screen>flash configuration checksum error or invalid key</screen>
<para>This error can be ignored if no flash based configuration is desired,
or can be silenced by running the <command>fconfig</command>
command as described below. At this point you may also wish to run the <command>
fis init</command> command. See other fis commands in <xref linkend="Flash-Image-System">.
</para>
<para>Certain control and configuration information used by RedBoot can be
stored in flash. </para>
<para>The details of what information is maintained in flash differ, based
on the platform and the configuration. However, the basic operation used to
maintain this information is the same. Using the <command>fconfig -l
</command> command, the information may be displayed and/or changed.
</para>
<para>If the optional flag <computeroutput>-i</computeroutput> is specified,
then the configuration database will be reset to its default
state. This is also needed the first time RedBoot is installed on the
target, or when updating to a newer RedBoot with different
configuration keys.
</para>
<para>If the optional flag <computeroutput>-l</computeroutput> is specified,
the configuration data is simply listed. Otherwise, each configuration parameter
will be displayed and you are given a chance to change it. The entire value
must be typed - typing just carriage return will leave a value unchanged.
Boolean values may be entered using the first letter (<computeroutput>t</computeroutput>
for true, <computeroutput>f</computeroutput> for false). At any time the editing
process may be stopped simply by entering a period (.) on the line. Entering
the caret (^) moves the editing back to the previous item. See &ldquo;RedBoot
Editing Commands&rdquo;, <xref linkend="RedBoot-Editing-Commands">. </para>
<para>If any changes are made in the configuration, then the updated data
will be written back to flash after getting acknowledgment from the user.
</para>
<para>
If the optional flag <computeroutput>-n</computeroutput> is specified
(with or without <computeroutput>-l</computeroutput>) then &ldquo;nicknames&rdquo;
of the entries are used.  These are shorter and less descriptive than
&ldquo;full&rdquo; names.  The full name may also be displayed by adding the
<computeroutput>-f</computeroutput> flag.</para>
<para>The reason for telling you nicknames is that a quick way to set a single
entry is provided, using the format
<screen>
  RedBoot> <userinput>fconfig <replaceable>nickname</replaceable> <replaceable>value
</replaceable></userinput></screen>
If no
value is supplied, the command will list and prompt for only that entry.
If a value is supplied, then the entry will be set to that value.  You will
be prompted whether to write the new information into flash if any change
was made.  For example
<screen>
  RedBoot> <userinput>fconfig -l -n</userinput>
  boot_script: false
  bootp: false
  bootp_my_ip: 10.16.19.176
  bootp_server_ip: 10.16.19.66
  dns_ip: 10.16.19.1
  gdb_port: 9000
  net_debug: false
  RedBoot> <userinput>fconfig bootp_my_ip 10.16.19.177</userinput>
  bootp_my_ip: 10.16.19.176 Setting to 10.16.19.177
  Update RedBoot non-volatile configuration - continue (y/n)? <userinput>y</userinput>
  ... Unlock from 0x507c0000-0x507e0000: .
  ... Erase from 0x507c0000-0x507e0000: .
  ... Program from 0x0000a8d0-0x0000acd0 at 0x507c0000: .
  ... Lock from 0x507c0000-0x507e0000: .
  RedBoot>
</screen>
</para><para>
Additionally, nicknames can be used like aliases via the format %{nickname}.
This allows the values stored by <userinput>fconfig</userinput> to be used
directly by scripts and commands.
</para>
<para>Depending on how your terminal program is connected and its
capabilities, you might find that you are unable to use line-editing to
delete the &lsquo;old&rsquo; value when using the default behaviour of
<command>fconfig <replaceable>nickname</replaceable></command> or just
plain <command>fconfig</command>, as shown in this example:
<screen>
RedBoot> <userinput>fco bootp</userinput>
bootp: false&lowbar;
</screen>
The user deletes the word &ldquo;false;&rdquo and enters &ldquo;true&rdquo;
so the display looks like this:
<screen>
RedBoot> <userinput>fco bootp</userinput>
bootp: <userinput>true</userinput>
Update RedBoot non-volatile configuration - continue (y/n)? y
... Unlock from ...
RedBoot> &lowbar;
</screen>
</para>
<para>To edit when you cannot backspace, use the optional flag
<computeroutput>-d</computeroutput> (for &ldquo;dumb terminal&rdquo;)
to provide a simpler interface thus:
<screen>
RedBoot> <userinput>fco -d bootp</userinput>
bootp: false ? &lowbar;
</screen>
and you enter the value in the obvious manner thus:
<screen>
RedBoot> <userinput>fco -d bootp</userinput>
bootp: false ? <userinput>true</userinput>
Update RedBoot non-volatile configuration - continue (y/n)? y
... Unlock from ...
RedBoot> &lowbar;
</screen>
</para>
<para>One item which is always present in the configuration data is the ability
to execute a script at boot time. A sequence of RedBoot commands can be entered
which will be executed when the system starts up. Optionally, a time-out period
can be provided which allows the user to abort the startup script and proceed
with normal command processing from the console.     </para>
<para><screen>
RedBoot> <userinput>fconfig -l</userinput>
Run script at boot: false
Use BOOTP for network configuration: false
Local IP address: 192.168.1.29
Default server IP address: 192.168.1.101
DNS server IP address: 192.168.1.1
GDB connection port: 9000
Network debug at boot time: false
</screen></para>
<para>The following example sets a boot script and then shows it running.
    </para>
<para>
<screen>
RedBoot> <userinput>fconfig</userinput>
Run script at boot: false <userinput>t</userinput>
      Boot script:
Enter script, terminate with empty line
>> <userinput>fi li</userinput>
    Boot script timeout: 0 <userinput>10</userinput>
Use BOOTP for network configuration: false .
Update RedBoot non-volatile configuration - continue (y/n)? <userinput>y</userinput>
... Erase from 0xa0fc0000-0xa0fe0000: .
... Program from 0x8c021f60-0x8c022360 at 0xa0fc0000: .
RedBoot>
RedBoot(tm) debug environment - built 08:22:24, Aug 23 2000
Copyright (C) 2000, Red Hat, Inc.


RAM: 0x8c000000-0x8c800000
flash: 0xa0000000 - 0xa1000000, 128 blocks of 0x00020000 bytes ea.
Socket Communications, Inc: Low Power Ethernet CF Revision C \
5V/3.3V 08/27/98 IP: 192.168.1.29, Default server: 192.168.1.101 \
== Executing boot script in 10 seconds - enter ^C to abort
RedBoot> <userinput>fi li</userinput>
Name              flash addr   Mem addr    Length    Entry point
RedBoot          0xA0000000   0xA0000000  0x020000  0x80000000
RedBoot config   0xA0FC0000   0xA0FC0000  0x020000  0x00000000
FIS directory    0xA0FE0000   0xA0FE0000  0x020000  0x00000000
RedBoot>
</screen>
</para>
<note><title>NOTE</title>
<para>The bold characters above indicate where something was entered on the
console. As you can see, the <command>fi li</command> command
at the end came from the script,
not the console. Once the script is executed, command processing reverts to
the console. </para>
</note>
<para>
<note><title>NOTE</title>
<para>
RedBoot supports the notion of a boot script timeout, i.e. a period of
time that RedBoot waits before executing the boot time script.  This period
is primarily to allow the possibility of canceling the script.  Since
a timeout value of zero (0) seconds would never allow the script to
be aborted or canceled, this value is not allowed.  If the timeout
value is zero, then RedBoot will abort the script execution immediately.
</para>
</note>
On many targets, RedBoot may be configured to run from ROM or it may be
configured to run from RAM. Other configurations are also possible. All
RedBoot configurations will execute the boot script, but in certain cases
it may be desirable to limit the execution of certain script commands to
one RedBoot configuration or the other. This can be accomplished by
prepending <computeroutput>{&lt;startup type>}</computeroutput> to the
commands which should be executed only by the RedBoot configured for the
specified startup type. The following boot script illustrates this concept
by having the ROM based RedBoot load and run the RAM based RedBoot. The RAM
based RedBoot will then list flash images.</para>
<para><screen>
RedBoot> <userinput>fco</userinput>
Run script at boot: false <userinput>t</userinput>
Boot script:
Enter script, terminate with empty line
>> <userinput>{ROM}fis load RedBoot[RAM]</userinput>
>> <userinput>{ROM}go</userinput>
>> <userinput>{RAM}fis li</userinput>
>>
Boot script timeout (1000ms resolution): <userinput>2</userinput>
Use BOOTP for network configuration: <userinput>false</userinput>
 ...
Update RedBoot non-volatile configuration - continue (y/n)? <userinput>y</userinput>
... Unlock from 0x007c0000-0x007e0000: .
... Erase from 0x007c0000-0x007e0000: .
... Program from 0xa0015030-0xa0016030 at 0x007df000: .
... Lock from 0x007c0000-0x007e0000: .
RedBoot> <userinput>reset</userinput>
... Resetting.
+Ethernet eth0: MAC address 00:80:4d:46:01:05
IP: 192.168.1.153, Default server: 192.168.1.10

RedBoot(tm) bootstrap and debug environment [ROM]
Red Hat certified release, version R1.xx - built 17:37:36, Aug 14 2001

Platform: IQ80310 (XScale)
Copyright (C) 2000, 2001, Red Hat, Inc.

RAM: 0xa0000000-0xa2000000, 0xa001b088-0xa1fdf000 available
FLASH: 0x00000000 - 0x00800000, 64 blocks of 0x00020000 bytes each.
== Executing boot script in 2.000 seconds - enter ^C to abort
RedBoot> <userinput>fis load RedBoot[RAM]</userinput>
RedBoot> <userinput>go</userinput>
+Ethernet eth0: MAC address 00:80:4d:46:01:05
IP: 192.168.1.153, Default server: 192.168.1.10

RedBoot(tm) bootstrap and debug environment [RAM]
Red Hat certified release, version R1.xx - built 13:03:47, Aug 14 2001

Platform: IQ80310 (XScale)
Copyright (C) 2000, 2001, Red Hat, Inc.

RAM: 0xa0000000-0xa2000000, 0xa0057fe8-0xa1fdf000 available
FLASH: 0x00000000 - 0x00800000, 64 blocks of 0x00020000 bytes each.
== Executing boot script in 2.000 seconds - enter ^C to abort
RedBoot> <userinput>fis li</userinput>
Name              FLASH addr  Mem addr    Length      Entry point
RedBoot           0x00000000  0x00000000  0x00040000  0x00002000
RedBoot config    0x007DF000  0x007DF000  0x00001000  0x00000000
FIS directory     0x007E0000  0x007E0000  0x00020000  0x00000000
RedBoot>
</screen></para>
</sect1>
<sect1 id="executing-programs">
<title>Executing Programs from RedBoot</title>
<para><indexterm><primary>executing programs</primary></indexterm><indexterm>
<primary>RedBoot</primary><secondary>executing programs</secondary></indexterm>Once
an image has been loaded into memory, either via the <command>load
</command> command or the <command>fis load</command>
command, execution may be transfered to that image.</para>
<para>  <note><title>NOTE</title>
<para>The image is assumed to be a stand-alone entity, as RedBoot gives the
entire platform over to it. Typical examples would be an eCos application
or a Linux kernel.</para>
</note></para>


<!-- ******** go *************************************************** -->
  <refentry id="go-command">
    <refnamediv>
      <refname>go</refname>
      <refpurpose>Execute a program</refpurpose>
    </refnamediv>
    <refsynopsisdiv>
      <cmdsynopsis>
	<command>go</command>
	<arg>-w <replaceable> timeout</replaceable></arg>
	<arg>-c</arg>
	<arg>-n</arg>
	<arg><replaceable> start_address</replaceable></arg>
      </cmdsynopsis>
    </refsynopsisdiv>
    <refsect1>
      <title>Arguments</title>
      <informaltable frame="all">
	<tgroup cols="4" colsep="1" rowsep="1" align="left">
	  <colspec colname="c1">
	  <colspec colname="c2">
	  <colspec colname="c3">
	  <colspec colname="c4">
	  <thead>
	    <row>
	      <entry>Name</entry>
	      <entry>Type</entry>
	      <entry>Description</entry>
	      <entry>Default</entry>
	    </row>
	  </thead>
	  <tbody>
	    <row>
	      <entry>-w <replaceable>timeout</replaceable></entry>	     
	      <entry>Number</entry>
	      <entry>How long to wait before starting execution.</entry>	     
	      <entry>0</entry>	     
	    </row>
	    <row>
	      <entry>-c</entry>	     
	      <entry>Boolean</entry>
	      <entry>Go with caches enabled.</entry>	     
	      <entry>caches off</entry>	     
	    </row>
	    <row>
	      <entry>-n</entry>	     
	      <entry>Boolean</entry>
	      <entry>Go with network interface stopped.</entry>	     
	      <entry>network enabled</entry>	     
	    </row>
	    <row>
	      <entry><replaceable>start_address</replaceable></entry>	     
	      <entry>Number</entry>
	      <entry>Address in memory to begin execution.</entry>	     
	      <entry>Value set by last <command>load</command> or <command>fis load</command> command.</entry>	     
	    </row>
	  </tbody>
	</tgroup>
      </informaltable>
    </refsect1>
    <refsect1>
      <title>Description</title>
      <para>
The <command>go</command> command causes RedBoot to give control of the target platform to
another program.  This program must execute stand alone, e.g. an eCos
application or a Linux kernel.
      </para>
      <para>
If the -w option is used, RedBoot will print a message and then
wait for a period of time before starting the execution.  This is
most useful in a script, giving the user a chance to abort executing
a program and move on in the script.
      </para>
    </refsect1>
    <refsect1>
      <title>Examples</title>
      <para>
Execute a program - <emphasis>no explicit output from RedBoot</emphasis>.
<screen>
RedBoot> <userinput>go 0x40040</userinput>
</screen> 
      </para>
      <para>
Execute a program with a timeout.
<screen>
RedBoot> <userinput>go -w 10</userinput>
About to start execution at 0x00000000 - abort with ^C within 10 seconds
^C
RedBoot>
</screen> 
Note that the starting address was implied (0x00000000 in this example).
The user is prompted that execution will commence in 10 seconds.  At
anytime within that 10 seconds the user may type  <guibutton>Ctrl+C</guibutton>
on the console and RedBoot will abort execution and return for the next
command, either from a script or the console.
      </para>
    </refsect1>
  </refentry>

<!-- ******** exec *************************************************** -->
  <refentry id="exec-command">
    <refnamediv>
      <refname>exec</refname>
      <refpurpose>Execute a Linux kernel</refpurpose>
    </refnamediv>
    <refsynopsisdiv>
      <cmdsynopsis>
	<command>exec</command>
	<arg>-w <replaceable> timeout</replaceable></arg>
	<arg>-r <replaceable> ramdisk_address</replaceable></arg>
	<arg>-s <replaceable> ramdisk_length</replaceable></arg>
	<arg>-b <replaceable> load_address</replaceable>
   	   <arg choice="req">-l <replaceable> load_length</replaceable></arg>
        </arg>
	<arg>-c <replaceable> kernel_command_line</replaceable></arg>
	<arg><replaceable> entry_point</replaceable></arg>
      </cmdsynopsis>
    </refsynopsisdiv>
    <refsect1>
      <title>Arguments</title>
      <informaltable frame="all">
	<tgroup cols="4" colsep="1" rowsep="1" align="left">
	  <colspec colname="c1">
	  <colspec colname="c2">
	  <colspec colname="c3">
	  <colspec colname="c4">
	  <thead>
	    <row>
	      <entry>Name</entry>
	      <entry>Type</entry>
	      <entry>Description</entry>
	      <entry>Default</entry>
	    </row>
	  </thead>
	  <tbody>
	    <row>
	      <entry>-w <replaceable>timeout</replaceable></entry>	     
	      <entry>Number</entry>
	      <entry>Time to wait before starting execution.</entry>	     
	      <entry>0</entry>	     
	    </row>
	    <row>
	      <entry>-r <replaceable>ramdisk_address</replaceable></entry>	     
	      <entry>Number</entry>
	      <entry>Address in memory of "initrd"-style ramdisk - passed to Linux kernel.</entry>	     
	      <entry><emphasis>None</emphasis></entry>	     
	    </row>
	    <row>
	      <entry>-s <replaceable>ramdisk_length</replaceable></entry>	     
	      <entry>Number</entry>
	      <entry>Length of ramdisk image - passed to Linux kernel.</entry>	     
	      <entry><emphasis>None</emphasis></entry>	     
	    </row>
	    <row>
	      <entry>-b <replaceable>load_address</replaceable></entry>	     
	      <entry>Number</entry>
	      <entry>Address in memory of the Linux kernel image.</entry>	     
	      <entry>Value set by <command>load</command> or <command>fis load</command></entry>	     
	    </row>
	    <row>
	      <entry>-l <replaceable>load_length</replaceable></entry>	     
	      <entry>Number</entry>
	      <entry>Length of Linux kernel image.</entry>
	      <entry><emphasis>none</emphasis></entry>	     
	    </row>
	    <row>
	      <entry>-c <replaceable>kernel_command_line</replaceable></entry>	     
	      <entry>String</entry>
	      <entry>Command line to pass to the Linux kernel.</entry>	     
	      <entry><emphasis>None</emphasis></entry>	     
	    </row>
            <row>
	      <entry>-x</entry>      
	      <entry></entry>
	      <entry>Boot kernel with endianess opposite of RedBoot endianess.</entry>       
	      <entry>Boot kernel with same endianess as RedBoot</entry>      
	      </row>
	    <row>
	      <entry><replaceable>entry_address</replaceable></entry>	     
	      <entry>Number</entry>
	      <entry>Starting address for Linux kernel execution</entry>	     
	      <entry>Implied by architecture</entry>	     
	    </row>
	  </tbody>
	</tgroup>
      </informaltable>
    </refsect1>
    <refsect1>
      <title>Description</title>
      <para>
The <command>exec</command> command is used to execute a non-eCos application, typically a
Linux kernel. Additional information may be passed to the kernel at startup
time. This command is quite special (and unique from the <command>go</command> command) in
that the program being executed may expect certain environmental setups, for
example that the MMU is turned off, etc. </para>
<para>The Linux kernel expects to have been loaded to a particular memory
location which is architecture dependent(0xC0008000 in the case of the SA1110). 
Since this memory is  used
by RedBoot internally, it is not possible to load the kernel to that location
directly. Thus the requirement for the "-b" option which tells the command
where the kernel has been loaded. When the <command>exec</command> command runs, the image will
be relocated to the appropriate location before being started. The "-r" and
"-s" options are used to pass information to the kernel about where a statically
loaded ramdisk (initrd) is located.</para>
<para>The "-c" option can be used to pass textual "command line" information
to the kernel.  If the command line data contains any punctuation (spaces,
etc), then it must be quoted using the double-quote character '"'. If the
quote character is required, it should be written as '\"'.
      </para>
<para>The "-x" option is optionally available on some bi-endian platforms. It is used to boot
a kernel built with an endianess opposite of RedBoot.</para>
    </refsect1>
    <refsect1>
      <title>Examples</title>
      <para>
Execute a Linux kernel, passing a command line, which needs relocation.
The result from RedBoot is normally quiet, with the target platform being
passed over to Linux immediately.
<screen>
RedBoot> <userinput>exec -b 0x100000 -l 0x80000 -c "noinitrd root=/dev/mtdblock3 console=ttySA0"</userinput>
</screen> 
      </para>
      <para>
Execute a Linux kernel, default entry address and no relocation required, with a timeout.  
The <emphasis> emphasized lines</emphasis> are output from the loaded kernel.
<screen> 
RedBoot> exec <userinput>-c "console=ttyS0,38400 ip=dhcp nfsroot=/export/elfs-sh" -w 5</userinput>
Now booting linux kernel:
Base address 0x8c001000 Entry 0x8c210000
Cmdline : console=ttyS0,38400 ip=dhcp nfsroot=/export/elfs-sh
About to start execution at 0x8x210000 - abort with ^C within 5 seconds
<emphasis>
Linux version 2.4.10-pre6 (...) (gcc version 3.1-stdsh-010931) #3 Thu Sep 27 11:04:23 BST 2001
</emphasis>
</screen> 
      </para>
    </refsect1>
  </refentry>

</sect1>
</chapter>