redboot_cmds.sgml

eCos/RedBoot for勤研ARM AnywhereII(4510) 含全部源代码

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