OpenCores
URL https://opencores.org/ocsvn/openrisc/openrisc/trunk

Subversion Repositories openrisc

[/] [openrisc/] [trunk/] [rtos/] [ecos-2.0/] [doc/] [html/] [ref/] [redboot-commands-and-examples.html] - Blame information for rev 579

Go to most recent revision | Details | Compare with Previous | View Log

Line No. Rev Author Line
1 28 unneback
<!-- Copyright (C) 2003 Red Hat, Inc.                                -->
2
<!-- This material may be distributed only subject to the terms      -->
3
<!-- and conditions set forth in the Open Publication License, v1.0  -->
4
<!-- or later (the latest version is presently available at          -->
5
<!-- http://www.opencontent.org/openpub/).                           -->
6
<!-- Distribution of the work or derivative of the work in any       -->
7
<!-- standard (paper) book form is prohibited unless prior           -->
8
<!-- permission is obtained from the copyright holder.               -->
9
<HTML
10
><HEAD
11
><TITLE
12
>RedBoot Commands and Examples</TITLE
13
><meta name="MSSmartTagsPreventParsing" content="TRUE">
14
<META
15
NAME="GENERATOR"
16
CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
17
"><LINK
18
REL="HOME"
19
TITLE="eCos Reference Manual"
20
HREF="ecos-ref.html"><LINK
21
REL="UP"
22
TITLE="RedBoot&#8482; User's Guide"
23
HREF="redboot.html"><LINK
24
REL="PREVIOUS"
25
TITLE="Configuring the RedBoot Environment"
26
HREF="configuring-the-redboot-environment.html"><LINK
27
REL="NEXT"
28
TITLE="Common Commands"
29
HREF="common-commands.html"></HEAD
30
><BODY
31
CLASS="CHAPTER"
32
BGCOLOR="#FFFFFF"
33
TEXT="#000000"
34
LINK="#0000FF"
35
VLINK="#840084"
36
ALINK="#0000FF"
37
><DIV
38
CLASS="NAVHEADER"
39
><TABLE
40
SUMMARY="Header navigation table"
41
WIDTH="100%"
42
BORDER="0"
43
CELLPADDING="0"
44
CELLSPACING="0"
45
><TR
46
><TH
47
COLSPAN="3"
48
ALIGN="center"
49
>eCos Reference Manual</TH
50
></TR
51
><TR
52
><TD
53
WIDTH="10%"
54
ALIGN="left"
55
VALIGN="bottom"
56
><A
57
HREF="configuring-the-redboot-environment.html"
58
ACCESSKEY="P"
59
>Prev</A
60
></TD
61
><TD
62
WIDTH="80%"
63
ALIGN="center"
64
VALIGN="bottom"
65
></TD
66
><TD
67
WIDTH="10%"
68
ALIGN="right"
69
VALIGN="bottom"
70
><A
71
HREF="common-commands.html"
72
ACCESSKEY="N"
73
>Next</A
74
></TD
75
></TR
76
></TABLE
77
><HR
78
ALIGN="LEFT"
79
WIDTH="100%"></DIV
80
><DIV
81
CLASS="CHAPTER"
82
><H1
83
><A
84
NAME="REDBOOT-COMMANDS-AND-EXAMPLES">Chapter 2. RedBoot Commands and Examples</H1
85
><DIV
86
CLASS="TOC"
87
><DL
88
><DT
89
><B
90
>Table of Contents</B
91
></DT
92
><DT
93
><A
94
HREF="redboot-commands-and-examples.html#AEN2850"
95
>Introduction</A
96
></DT
97
><DT
98
><A
99
HREF="common-commands.html"
100
>Common Commands</A
101
></DT
102
><DT
103
><A
104
HREF="flash-image-system.html"
105
>Flash Image System (FIS)</A
106
></DT
107
><DT
108
><A
109
HREF="persistent-state-flash.html"
110
>Persistent State Flash-based Configuration and Control</A
111
></DT
112
><DT
113
><A
114
HREF="executing-programs.html"
115
>Executing Programs from RedBoot</A
116
></DT
117
></DL
118
></DIV
119
><DIV
120
CLASS="SECT1"
121
><H1
122
CLASS="SECT1"
123
><A
124
NAME="AEN2850">Introduction</H1
125
><P
126
>RedBoot provides three basic classes of commands:    <P
127
></P
128
><UL
129
><LI
130
><P
131
>Program loading and execution</P
132
></LI
133
><LI
134
><P
135
>Flash image and configuration management</P
136
></LI
137
><LI
138
><P
139
>Miscellaneous commands</P
140
></LI
141
></UL
142
>Given the extensible and configurable nature of eCos and RedBoot,
143
there may be extended or enhanced sets of commands available.</P
144
><P
145
>The basic format for commands is:    <TABLE
146
BORDER="5"
147
BGCOLOR="#E0E0F0"
148
WIDTH="70%"
149
><TR
150
><TD
151
><PRE
152
CLASS="PROGRAMLISTING"
153
>RedBoot&#62; COMMAND [-S]... [-s val]... operand</PRE
154
></TD
155
></TR
156
></TABLE
157
></P
158
><P
159
>Commands may require additional information beyond the basic
160
command name. In most cases this additional information is optional, with
161
suitable default values provided if they are not present.
162
 
163
      <DIV
164
CLASS="INFORMALTABLE"
165
><A
166
NAME="AEN2868"><P
167
></P
168
><TABLE
169
BORDER="1"
170
CLASS="CALSTABLE"
171
><THEAD
172
><TR
173
><TH
174
WIDTH="33%"
175
ALIGN="LEFT"
176
VALIGN="TOP"
177
>Format</TH
178
><TH
179
WIDTH="33%"
180
ALIGN="LEFT"
181
VALIGN="TOP"
182
>Description</TH
183
><TH
184
WIDTH="33%"
185
ALIGN="LEFT"
186
VALIGN="TOP"
187
>Example</TH
188
></TR
189
></THEAD
190
><TBODY
191
><TR
192
><TD
193
WIDTH="33%"
194
ALIGN="LEFT"
195
VALIGN="TOP"
196
>-S</TD
197
><TD
198
WIDTH="33%"
199
ALIGN="LEFT"
200
VALIGN="TOP"
201
>A boolean switch; the behavior of the command will differ, depending
202
on the presence of the switch.  In this example, the <TT
203
CLASS="USERINPUT"
204
><B
205
>-f</B
206
></TT
207
> switch
208
indicates that a complete initialization of the FIS data should be performed.
209
There may be many such switches available for any given command and any or all of
210
them may be present, in any order.</TD
211
><TD
212
WIDTH="33%"
213
ALIGN="LEFT"
214
VALIGN="TOP"
215
>                <TT
216
CLASS="COMPUTEROUTPUT"
217
> RedBoot&#62; <TT
218
CLASS="USERINPUT"
219
><B
220
>fis init -f</B
221
></TT
222
></TT
223
>
224
              </TD
225
></TR
226
><TR
227
><TD
228
WIDTH="33%"
229
ALIGN="LEFT"
230
VALIGN="TOP"
231
>-s<TT
232
CLASS="REPLACEABLE"
233
><I
234
> val</I
235
></TT
236
></TD
237
><TD
238
WIDTH="33%"
239
ALIGN="LEFT"
240
VALIGN="TOP"
241
>A qualified value; the letter "s" introduces the value, qualifying it's meaning.  In the
242
example, <TT
243
CLASS="USERINPUT"
244
><B
245
>-b 0x100000</B
246
></TT
247
> specifies where the memory dump should begin.
248
There may be many such switches available for any given command and any or all of
249
them may be present, in any order.</TD
250
><TD
251
WIDTH="33%"
252
ALIGN="LEFT"
253
VALIGN="TOP"
254
>                <TT
255
CLASS="COMPUTEROUTPUT"
256
> RedBoot&#62; <TT
257
CLASS="USERINPUT"
258
><B
259
>dump -b 0x100000 -l 0x20</B
260
></TT
261
></TT
262
>
263
              </TD
264
></TR
265
><TR
266
><TD
267
WIDTH="33%"
268
ALIGN="LEFT"
269
VALIGN="TOP"
270
><TT
271
CLASS="REPLACEABLE"
272
><I
273
> operand</I
274
></TT
275
></TD
276
><TD
277
WIDTH="33%"
278
ALIGN="LEFT"
279
VALIGN="TOP"
280
>A simple value; some commands require a single parameter for which an additional
281
<TT
282
CLASS="USERINPUT"
283
><B
284
>-X</B
285
></TT
286
> switch would be redundant.  In the example, <TT
287
CLASS="USERINPUT"
288
><B
289
>JFFS2</B
290
></TT
291
>
292
is the name of a flash image.  The image name is always required, thus is no need to qualify it with
293
a switch.
294
Note that any un-qualified operand must always appear at the end of the command.</TD
295
><TD
296
WIDTH="33%"
297
ALIGN="LEFT"
298
VALIGN="TOP"
299
>                <TT
300
CLASS="COMPUTEROUTPUT"
301
> RedBoot&#62; <TT
302
CLASS="USERINPUT"
303
><B
304
>fis delete JFFS2</B
305
></TT
306
></TT
307
>
308
              </TD
309
></TR
310
></TBODY
311
></TABLE
312
><P
313
></P
314
></DIV
315
>&#13;</P
316
><P
317
>The list of available commands, and their syntax, can be obtained by
318
typing <B
319
CLASS="COMMAND"
320
>help</B
321
> at the command line:
322
<TABLE
323
BORDER="5"
324
BGCOLOR="#E0E0F0"
325
WIDTH="70%"
326
><TR
327
><TD
328
><PRE
329
CLASS="SCREEN"
330
>RedBoot&#62; <TT
331
CLASS="USERINPUT"
332
><B
333
>help</B
334
></TT
335
>
336
Manage aliases kept in FLASH memory
337
      alias name [value]
338
Set/Query the system console baud rate
339
      baudrate [-b &lt;rate&#62;]
340
Manage machine caches
341
      cache [ON | OFF]
342
Display/switch console channel
343
      channel [-1|&lt;channel number&#62;]
344
Display disk partitions
345
      disks
346
Display (hex dump) a range of memory
347
      dump -b &lt;location&#62; [-l &lt;length&#62;] [-s]
348
Manage flash images
349
      fis {cmds}
350
Manage configuration kept in FLASH memory
351
      fconfig [-i] [-l] [-n] [-f] [-d] | [-d] nickname [value]
352
Execute code at a location
353
      go [-w &lt;timeout&#62;] [entry]
354
Help about help?
355
      help [&lt;topic&#62;]
356
Set/change IP addresses
357
      ip_address [-l &lt;local_ip_address&#62;] [-h &lt;server_address&#62;]
358
Load a file
359
      load [-r] [-v] [-d] [-c &lt;channel&#62;] [-h &lt;host&#62;] [-m {TFTP | HTTP | {x|y}MODEM | disk}]
360
      [-b &lt;base_address&#62;] &lt;file_name&#62;
361
Network connectivity test
362
      ping [-v] [-n &lt;count&#62;] [-t &lt;timeout&#62;] [-i &lt;IP_addr]
363
      -h &lt;host&#62;
364
Reset the system
365
      reset
366
Display RedBoot version information
367
      version
368
Display (hex dump) a range of memory
369
      x -b &lt;location&#62; [-l &lt;length&#62;] [-s]</PRE
370
></TD
371
></TR
372
></TABLE
373
></P
374
><P
375
>Commands can be abbreviated to their shortest
376
unique string. Thus in the list above, <B
377
CLASS="COMMAND"
378
>d,du,dum</B
379
>
380
and dump are all valid for the <B
381
CLASS="COMMAND"
382
>dump</B
383
> command. The <B
384
CLASS="COMMAND"
385
>fconfig</B
386
>
387
command can be abbreviated <B
388
CLASS="COMMAND"
389
>fc</B
390
>, but
391
<B
392
CLASS="COMMAND"
393
>f</B
394
> would be ambiguous with <B
395
CLASS="COMMAND"
396
>fis</B
397
>.</P
398
><P
399
>There is one additional, special command. When RedBoot detects '$' or '+'
400
(unless escaped via '\') in a command, it switches to GDB protocol mode. At this
401
point, the eCos GDB stubs take over, allowing connections from a GDB host.
402
The only way to get back to RedBoot from GDB mode is to restart the platform.</P
403
><DIV
404
CLASS="NOTE"
405
><BLOCKQUOTE
406
CLASS="NOTE"
407
><P
408
><B
409
>NOTE: </B
410
>Multiple commands may be entered on a single line, separated by the semi-colon &#8220;;&#8221; character.</P
411
></BLOCKQUOTE
412
></DIV
413
><P
414
>The standard RedBoot command set is structured around the bootstrap
415
environment. These commands are designed to be simple to use and remember,
416
while still providing sufficient power and flexibility to be useful. No attempt
417
has been made to render RedBoot as the end-all product. As such, things such
418
as the debug environment are left to other modules, such as GDB stubs, which
419
are typically included in RedBoot. </P
420
><P
421
>The command set may be also be extended on a platform basis. </P
422
></DIV
423
></DIV
424
><DIV
425
CLASS="NAVFOOTER"
426
><HR
427
ALIGN="LEFT"
428
WIDTH="100%"><TABLE
429
SUMMARY="Footer navigation table"
430
WIDTH="100%"
431
BORDER="0"
432
CELLPADDING="0"
433
CELLSPACING="0"
434
><TR
435
><TD
436
WIDTH="33%"
437
ALIGN="left"
438
VALIGN="top"
439
><A
440
HREF="configuring-the-redboot-environment.html"
441
ACCESSKEY="P"
442
>Prev</A
443
></TD
444
><TD
445
WIDTH="34%"
446
ALIGN="center"
447
VALIGN="top"
448
><A
449
HREF="ecos-ref.html"
450
ACCESSKEY="H"
451
>Home</A
452
></TD
453
><TD
454
WIDTH="33%"
455
ALIGN="right"
456
VALIGN="top"
457
><A
458
HREF="common-commands.html"
459
ACCESSKEY="N"
460
>Next</A
461
></TD
462
></TR
463
><TR
464
><TD
465
WIDTH="33%"
466
ALIGN="left"
467
VALIGN="top"
468
>Configuring the RedBoot Environment</TD
469
><TD
470
WIDTH="34%"
471
ALIGN="center"
472
VALIGN="top"
473
><A
474
HREF="redboot.html"
475
ACCESSKEY="U"
476
>Up</A
477
></TD
478
><TD
479
WIDTH="33%"
480
ALIGN="right"
481
VALIGN="top"
482
>Common Commands</TD
483
></TR
484
></TABLE
485
></DIV
486
></BODY
487
></HTML
488
>

powered by: WebSVN 2.1.0

© copyright 1999-2024 OpenCores.org, equivalent to Oliscience, all rights reserved. OpenCores®, registered trademark.