1 <!-- 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. -->
12 >RedBoot Commands and Examples</TITLE
13 ><meta name="MSSmartTagsPreventParsing" content="TRUE">
16 CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
19 TITLE="eCos Reference Manual"
20 HREF="ecos-ref.html"><LINK
22 TITLE="RedBoot™ User's Guide"
23 HREF="redboot.html"><LINK
25 TITLE="Configuring the RedBoot Environment"
26 HREF="configuring-the-redboot-environment.html"><LINK
28 TITLE="Common Commands"
29 HREF="common-commands.html"></HEAD
40 SUMMARY="Header navigation table"
49 >eCos Reference Manual</TH
57 HREF="configuring-the-redboot-environment.html"
71 HREF="common-commands.html"
84 NAME="REDBOOT-COMMANDS-AND-EXAMPLES">Chapter 2. RedBoot Commands and Examples</H1
94 HREF="redboot-commands-and-examples.html#AEN2850"
99 HREF="common-commands.html"
104 HREF="flash-image-system.html"
105 >Flash Image System (FIS)</A
109 HREF="persistent-state-flash.html"
110 >Persistent State Flash-based Configuration and Control</A
114 HREF="executing-programs.html"
115 >Executing Programs from RedBoot</A
124 NAME="AEN2850">Introduction</H1
126 >RedBoot provides three basic classes of commands: <P
131 >Program loading and execution</P
135 >Flash image and configuration management</P
139 >Miscellaneous commands</P
142 >Given the extensible and configurable nature of eCos and RedBoot,
143 there may be extended or enhanced sets of commands available.</P
145 >The basic format for commands is: <TABLE
152 CLASS="PROGRAMLISTING"
153 >RedBoot> COMMAND [-S]... [-s val]... operand</PRE
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.
164 CLASS="INFORMALTABLE"
201 >A boolean switch; the behavior of the command will differ, depending
202 on the presence of the switch. In this example, the <TT
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
216 CLASS="COMPUTEROUTPUT"
241 >A qualified value; the letter "s" introduces the value, qualifying it's meaning. In the
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
255 CLASS="COMPUTEROUTPUT"
259 >dump -b 0x100000 -l 0x20</B
280 >A simple value; some commands require a single parameter for which an additional
286 > switch would be redundant. In the example, <TT
292 is the name of a flash image. The image name is always required, thus is no need to qualify it with
294 Note that any un-qualified operand must always appear at the end of the command.</TD
300 CLASS="COMPUTEROUTPUT"
317 >The list of available commands, and their syntax, can be obtained by
321 > at the command line:
336 Manage aliases kept in FLASH memory
338 Set/Query the system console baud rate
339 baudrate [-b <rate>]
340 Manage machine caches
342 Display/switch console channel
343 channel [-1|<channel number>]
344 Display disk partitions
346 Display (hex dump) a range of memory
347 dump -b <location> [-l <length>] [-s]
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 <timeout>] [entry]
355 help [<topic>]
356 Set/change IP addresses
357 ip_address [-l <local_ip_address>] [-h <server_address>]
359 load [-r] [-v] [-d] [-c <channel>] [-h <host>] [-m {TFTP | HTTP | {x|y}MODEM | disk}]
360 [-b <base_address>] <file_name>
361 Network connectivity test
362 ping [-v] [-n <count>] [-t <timeout>] [-i <IP_addr]
366 Display RedBoot version information
368 Display (hex dump) a range of memory
369 x -b <location> [-l <length>] [-s]</PRE
375 >Commands can be abbreviated to their shortest
376 unique string. Thus in the list above, <B
380 and dump are all valid for the <B
387 command can be abbreviated <B
394 > would be ambiguous with <B
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
410 >Multiple commands may be entered on a single line, separated by the semi-colon “;” character.</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
421 >The command set may be also be extended on a platform basis. </P
429 SUMMARY="Footer navigation table"
440 HREF="configuring-the-redboot-environment.html"
458 HREF="common-commands.html"
468 >Configuring the RedBoot Environment</TD
projects / karo-tx-redboot.git / blob