]> git.kernelconcepts.de Git - karo-tx-redboot.git/blobdiff - doc/html/ref/persistent-state-flash.html
Cleanup CVS ipmorted branch
[karo-tx-redboot.git] / doc / html / ref / persistent-state-flash.html
diff --git a/doc/html/ref/persistent-state-flash.html b/doc/html/ref/persistent-state-flash.html
deleted file mode 100644 (file)
index 44c8a5c..0000000
+++ /dev/null
@@ -1,730 +0,0 @@
-<!-- Copyright (C) 2003 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 is obtained from the copyright holder.               -->
-<HTML
-><HEAD
-><TITLE
->Persistent State Flash-based Configuration and Control</TITLE
-><meta name="MSSmartTagsPreventParsing" content="TRUE">
-<META
-NAME="GENERATOR"
-CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
-"><LINK
-REL="HOME"
-TITLE="eCos Reference Manual"
-HREF="ecos-ref.html"><LINK
-REL="UP"
-TITLE="RedBoot Commands and Examples"
-HREF="redboot-commands-and-examples.html"><LINK
-REL="PREVIOUS"
-TITLE="fis write"
-HREF="fis-write-command.html"><LINK
-REL="NEXT"
-TITLE="Executing Programs from RedBoot"
-HREF="executing-programs.html"></HEAD
-><BODY
-CLASS="SECT1"
-BGCOLOR="#FFFFFF"
-TEXT="#000000"
-LINK="#0000FF"
-VLINK="#840084"
-ALINK="#0000FF"
-><DIV
-CLASS="NAVHEADER"
-><TABLE
-SUMMARY="Header navigation table"
-WIDTH="100%"
-BORDER="0"
-CELLPADDING="0"
-CELLSPACING="0"
-><TR
-><TH
-COLSPAN="3"
-ALIGN="center"
->eCos Reference Manual</TH
-></TR
-><TR
-><TD
-WIDTH="10%"
-ALIGN="left"
-VALIGN="bottom"
-><A
-HREF="fis-write-command.html"
-ACCESSKEY="P"
->Prev</A
-></TD
-><TD
-WIDTH="80%"
-ALIGN="center"
-VALIGN="bottom"
->Chapter 2. RedBoot Commands and Examples</TD
-><TD
-WIDTH="10%"
-ALIGN="right"
-VALIGN="bottom"
-><A
-HREF="executing-programs.html"
-ACCESSKEY="N"
->Next</A
-></TD
-></TR
-></TABLE
-><HR
-ALIGN="LEFT"
-WIDTH="100%"></DIV
-><DIV
-CLASS="SECT1"
-><H1
-CLASS="SECT1"
-><A
-NAME="PERSISTENT-STATE-FLASH">Persistent State Flash-based Configuration and Control</H1
-><P
-></P
-><P
->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.</P
-><P
->RedBoot on platforms that support flash based configuration information
-will report the following message the first time that RedBoot is booted on
-the target:</P
-><TABLE
-BORDER="5"
-BGCOLOR="#E0E0F0"
-WIDTH="70%"
-><TR
-><TD
-><PRE
-CLASS="SCREEN"
->flash configuration checksum error or invalid key</PRE
-></TD
-></TR
-></TABLE
-><P
->This error can be ignored if no flash based configuration is desired,
-or can be silenced by running the <B
-CLASS="COMMAND"
->fconfig</B
->
-command as described below. At this point you may also wish to run the <B
-CLASS="COMMAND"
->fis init</B
-> command. See other fis commands in <A
-HREF="flash-image-system.html"
->the Section called <I
->Flash Image System (FIS)</I
-></A
->.</P
-><P
->Certain control and configuration information used by RedBoot can be
-stored in flash. </P
-><P
->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 <B
-CLASS="COMMAND"
->fconfig -l</B
-> command, the information may be displayed and/or changed.</P
-><P
->If the optional flag <TT
-CLASS="COMPUTEROUTPUT"
->-i</TT
-> 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.</P
-><P
->If the optional flag <TT
-CLASS="COMPUTEROUTPUT"
->-l</TT
-> 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 (<TT
-CLASS="COMPUTEROUTPUT"
->t</TT
->
-for true, <TT
-CLASS="COMPUTEROUTPUT"
->f</TT
-> 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 &#8220;RedBoot
-Editing Commands&#8221;, <A
-HREF="redboot-editing-commands.html"
->the Section called <I
->RedBoot Editing Commands</I
-> in Chapter 1</A
->. </P
-><P
->If any changes are made in the configuration, then the updated data
-will be written back to flash after getting acknowledgment from the user.</P
-><P
->If the optional flag <TT
-CLASS="COMPUTEROUTPUT"
->-n</TT
-> is specified
-(with or without <TT
-CLASS="COMPUTEROUTPUT"
->-l</TT
->) then &#8220;nicknames&#8221;
-of the entries are used.  These are shorter and less descriptive than
-&#8220;full&#8221; names.  The full name may also be displayed by adding the
-<TT
-CLASS="COMPUTEROUTPUT"
->-f</TT
-> flag.</P
-><P
->The reason for telling you nicknames is that a quick way to set a single
-entry is provided, using the format
-<TABLE
-BORDER="5"
-BGCOLOR="#E0E0F0"
-WIDTH="70%"
-><TR
-><TD
-><PRE
-CLASS="SCREEN"
->  RedBoot&#62; <TT
-CLASS="USERINPUT"
-><B
->fconfig <TT
-CLASS="REPLACEABLE"
-><I
->nickname</I
-></TT
-> <TT
-CLASS="REPLACEABLE"
-><I
->value</I
-></TT
-></B
-></TT
-></PRE
-></TD
-></TR
-></TABLE
->
-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
-<TABLE
-BORDER="5"
-BGCOLOR="#E0E0F0"
-WIDTH="70%"
-><TR
-><TD
-><PRE
-CLASS="SCREEN"
->  RedBoot&#62; <TT
-CLASS="USERINPUT"
-><B
->fconfig -l -n</B
-></TT
->
-  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&#62; <TT
-CLASS="USERINPUT"
-><B
->fconfig bootp_my_ip 10.16.19.177</B
-></TT
->
-  bootp_my_ip: 10.16.19.176 Setting to 10.16.19.177
-  Update RedBoot non-volatile configuration - continue (y/n)? <TT
-CLASS="USERINPUT"
-><B
->y</B
-></TT
->
-  ... Unlock from 0x507c0000-0x507e0000: .
-  ... Erase from 0x507c0000-0x507e0000: .
-  ... Program from 0x0000a8d0-0x0000acd0 at 0x507c0000: .
-  ... Lock from 0x507c0000-0x507e0000: .
-  RedBoot&#62;</PRE
-></TD
-></TR
-></TABLE
-></P
-><P
->Additionally, nicknames can be used like aliases via the format %{nickname}.
-This allows the values stored by <TT
-CLASS="USERINPUT"
-><B
->fconfig</B
-></TT
-> to be used
-directly by scripts and commands.</P
-><P
->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 &#8216;old&#8217; value when using the default behaviour of
-<B
-CLASS="COMMAND"
->fconfig <TT
-CLASS="REPLACEABLE"
-><I
->nickname</I
-></TT
-></B
-> or just
-plain <B
-CLASS="COMMAND"
->fconfig</B
->, as shown in this example:
-<TABLE
-BORDER="5"
-BGCOLOR="#E0E0F0"
-WIDTH="70%"
-><TR
-><TD
-><PRE
-CLASS="SCREEN"
->RedBoot&#62; <TT
-CLASS="USERINPUT"
-><B
->fco bootp</B
-></TT
->
-bootp: false&#0095;</PRE
-></TD
-></TR
-></TABLE
->
-The user deletes the word &#8220;false;&#8221; and enters &#8220;true&#8221;
-so the display looks like this:
-<TABLE
-BORDER="5"
-BGCOLOR="#E0E0F0"
-WIDTH="70%"
-><TR
-><TD
-><PRE
-CLASS="SCREEN"
->RedBoot&#62; <TT
-CLASS="USERINPUT"
-><B
->fco bootp</B
-></TT
->
-bootp: <TT
-CLASS="USERINPUT"
-><B
->true</B
-></TT
->
-Update RedBoot non-volatile configuration - continue (y/n)? y
-... Unlock from ...
-RedBoot&#62; &#0095;</PRE
-></TD
-></TR
-></TABLE
-></P
-><P
->To edit when you cannot backspace, use the optional flag
-<TT
-CLASS="COMPUTEROUTPUT"
->-d</TT
-> (for &#8220;dumb terminal&#8221;)
-to provide a simpler interface thus:
-<TABLE
-BORDER="5"
-BGCOLOR="#E0E0F0"
-WIDTH="70%"
-><TR
-><TD
-><PRE
-CLASS="SCREEN"
->RedBoot&#62; <TT
-CLASS="USERINPUT"
-><B
->fco -d bootp</B
-></TT
->
-bootp: false ? &#0095;</PRE
-></TD
-></TR
-></TABLE
->
-and you enter the value in the obvious manner thus:
-<TABLE
-BORDER="5"
-BGCOLOR="#E0E0F0"
-WIDTH="70%"
-><TR
-><TD
-><PRE
-CLASS="SCREEN"
->RedBoot&#62; <TT
-CLASS="USERINPUT"
-><B
->fco -d bootp</B
-></TT
->
-bootp: false ? <TT
-CLASS="USERINPUT"
-><B
->true</B
-></TT
->
-Update RedBoot non-volatile configuration - continue (y/n)? y
-... Unlock from ...
-RedBoot&#62; &#0095;</PRE
-></TD
-></TR
-></TABLE
-></P
-><P
->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.     </P
-><P
-><TABLE
-BORDER="5"
-BGCOLOR="#E0E0F0"
-WIDTH="70%"
-><TR
-><TD
-><PRE
-CLASS="SCREEN"
->RedBoot&#62; <TT
-CLASS="USERINPUT"
-><B
->fconfig -l</B
-></TT
->
-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</PRE
-></TD
-></TR
-></TABLE
-></P
-><P
->The following example sets a boot script and then shows it running.
-    </P
-><P
-><TABLE
-BORDER="5"
-BGCOLOR="#E0E0F0"
-WIDTH="70%"
-><TR
-><TD
-><PRE
-CLASS="SCREEN"
->RedBoot&#62; <TT
-CLASS="USERINPUT"
-><B
->fconfig</B
-></TT
->
-Run script at boot: false <TT
-CLASS="USERINPUT"
-><B
->t</B
-></TT
->
-      Boot script:
-Enter script, terminate with empty line
-&#62;&#62; <TT
-CLASS="USERINPUT"
-><B
->fi li</B
-></TT
->
-    Boot script timeout: 0 <TT
-CLASS="USERINPUT"
-><B
->10</B
-></TT
->
-Use BOOTP for network configuration: false .
-Update RedBoot non-volatile configuration - continue (y/n)? <TT
-CLASS="USERINPUT"
-><B
->y</B
-></TT
->
-... Erase from 0xa0fc0000-0xa0fe0000: .
-... Program from 0x8c021f60-0x8c022360 at 0xa0fc0000: .
-RedBoot&#62;
-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&#62; <TT
-CLASS="USERINPUT"
-><B
->fi li</B
-></TT
->
-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&#62;</PRE
-></TD
-></TR
-></TABLE
-></P
-><DIV
-CLASS="NOTE"
-><BLOCKQUOTE
-CLASS="NOTE"
-><P
-><B
->NOTE: </B
->The bold characters above indicate where something was entered on the
-console. As you can see, the <B
-CLASS="COMMAND"
->fi li</B
-> command
-at the end came from the script,
-not the console. Once the script is executed, command processing reverts to
-the console. </P
-></BLOCKQUOTE
-></DIV
-><P
-><DIV
-CLASS="NOTE"
-><BLOCKQUOTE
-CLASS="NOTE"
-><P
-><B
->NOTE: </B
->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.</P
-></BLOCKQUOTE
-></DIV
->
-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 <TT
-CLASS="COMPUTEROUTPUT"
->{&lt;startup type&#62;}</TT
-> 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.</P
-><P
-><TABLE
-BORDER="5"
-BGCOLOR="#E0E0F0"
-WIDTH="70%"
-><TR
-><TD
-><PRE
-CLASS="SCREEN"
->RedBoot&#62; <TT
-CLASS="USERINPUT"
-><B
->fco</B
-></TT
->
-Run script at boot: false <TT
-CLASS="USERINPUT"
-><B
->t</B
-></TT
->
-Boot script:
-Enter script, terminate with empty line
-&#62;&#62; <TT
-CLASS="USERINPUT"
-><B
->{ROM}fis load RedBoot[RAM]</B
-></TT
->
-&#62;&#62; <TT
-CLASS="USERINPUT"
-><B
->{ROM}go</B
-></TT
->
-&#62;&#62; <TT
-CLASS="USERINPUT"
-><B
->{RAM}fis li</B
-></TT
->
-&#62;&#62;
-Boot script timeout (1000ms resolution): <TT
-CLASS="USERINPUT"
-><B
->2</B
-></TT
->
-Use BOOTP for network configuration: <TT
-CLASS="USERINPUT"
-><B
->false</B
-></TT
->
- ...
-Update RedBoot non-volatile configuration - continue (y/n)? <TT
-CLASS="USERINPUT"
-><B
->y</B
-></TT
->
-... Unlock from 0x007c0000-0x007e0000: .
-... Erase from 0x007c0000-0x007e0000: .
-... Program from 0xa0015030-0xa0016030 at 0x007df000: .
-... Lock from 0x007c0000-0x007e0000: .
-RedBoot&#62; <TT
-CLASS="USERINPUT"
-><B
->reset</B
-></TT
->
-... 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&#62; <TT
-CLASS="USERINPUT"
-><B
->fis load RedBoot[RAM]</B
-></TT
->
-RedBoot&#62; <TT
-CLASS="USERINPUT"
-><B
->go</B
-></TT
->
-+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&#62; <TT
-CLASS="USERINPUT"
-><B
->fis li</B
-></TT
->
-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&#62;</PRE
-></TD
-></TR
-></TABLE
-></P
-></DIV
-><DIV
-CLASS="NAVFOOTER"
-><HR
-ALIGN="LEFT"
-WIDTH="100%"><TABLE
-SUMMARY="Footer navigation table"
-WIDTH="100%"
-BORDER="0"
-CELLPADDING="0"
-CELLSPACING="0"
-><TR
-><TD
-WIDTH="33%"
-ALIGN="left"
-VALIGN="top"
-><A
-HREF="fis-write-command.html"
-ACCESSKEY="P"
->Prev</A
-></TD
-><TD
-WIDTH="34%"
-ALIGN="center"
-VALIGN="top"
-><A
-HREF="ecos-ref.html"
-ACCESSKEY="H"
->Home</A
-></TD
-><TD
-WIDTH="33%"
-ALIGN="right"
-VALIGN="top"
-><A
-HREF="executing-programs.html"
-ACCESSKEY="N"
->Next</A
-></TD
-></TR
-><TR
-><TD
-WIDTH="33%"
-ALIGN="left"
-VALIGN="top"
->fis write</TD
-><TD
-WIDTH="34%"
-ALIGN="center"
-VALIGN="top"
-><A
-HREF="redboot-commands-and-examples.html"
-ACCESSKEY="U"
->Up</A
-></TD
-><TD
-WIDTH="33%"
-ALIGN="right"
-VALIGN="top"
->Executing Programs from RedBoot</TD
-></TR
-></TABLE
-></DIV
-></BODY
-></HTML
->
\ No newline at end of file