Subversion Repositories or1k

RedBootcommands and examples

commands and examples

RedBoot provides three basic classes of commands:    

Program loading and execution

Flash image and configuration management

Miscellaneous commands

Given the extensible and configurable nature of eCos and RedBoot,

there may be extended or enhanced sets of commands available.

The basic format for commands is:    RedBoot> COMMAND [-S]... [-s val]... operand

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.

              -S

              A boolean switch; the behavior of the command will differ, depending

on the presence of the switch.  In this example, the -f 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.

                 RedBoot> fis init -f

              -s val

              A qualified value; the letter "s" introduces the value, qualifying it's meaning.  In the

example, -b 0x100000 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.

                 RedBoot> dump -b 0x100000 -l 0x20

               operand

              A simple value; some commands require a single parameter for which an additional

-X switch would be redundant.  In the example, JFFS2

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.

                 RedBoot> fis delete JFFS2

The list of available commands, and their syntax, can be obtained by

typing help at the command line:

RedBoot> help

Manage aliases kept in FLASH memory

      alias name [value]

Set/Query the system console baud rate

      baudrate [-b <rate>]

Manage machine caches

      cache [ON | OFF]

Display/switch console channel

      channel [-1|<channel number>]

Display disk partitions

      disks

Display (hex dump) a range of memory

      dump -b <location> [-l <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 <timeout>] [entry]

Help about help?

      help [<topic>]

Set/change IP addresses

      ip_address [-l <local_ip_address>] [-h <server_address>]

Load a file

      load [-r] [-v] [-d] [-c <channel>] [-h <host>] [-m {TFTP | HTTP | {x|y}MODEM | disk}]

      [-b <base_address>] <file_name>

Network connectivity test

      ping [-v] [-n <count>] [-t <timeout>] [-i <IP_addr]

      -h <host>

Reset the system

      reset

Display RedBoot version information

      version

Display (hex dump) a range of memory

      x -b <location> [-l <length>] [-s]

Commands can be abbreviated to their shortest

unique string. Thus in the list above, d,du,dum

and dump are all valid for the dump command. The fconfig

command can be abbreviated fc, but

f would be ambiguous with fis.

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.

Multiple commands may be entered on a single line, separated by the semi-colon “;” character.

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. 

The command set may be also be extended on a platform basis. 

  commandscommon

      alias

      Manipulate command line aliases

        alias

         name

         value

              name

              Name

              The name for this alias.

              none

              value

              String

              Replacement value for the alias.

              none

      The alias 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.

If no value is provided, then the current value of the alias is displayed.

If the system supports non-volatile configuration data via the

fconfig command (see ),

then the value will be saved and used when the system is reset.

Set an alias.

RedBoot> alias joe "This is Joe"

Update RedBoot non-volatile configuration - continue (y/n)? n

Display an alias.

RedBoot> alias joe

'joe' = 'This is Joe'

Use an alias.  Note: the "=" command simply echoes the command to to console.

RedBoot> = %{joe}

This is Joe

Aliases can be nested.

RedBoot> alias frank "Who are you? %{joe}"

Update RedBoot non-volatile configuration - continue (y/n)? n

RedBoot> = %{frank}

Who are you? This is Joe

Notice how the value of %{frank} changes when %{joe} is changed since

the value of %{joe} is not evaluated until %{frank} is evaluated.

RedBoot> alias joe "This is now Josephine"

Update RedBoot non-volatile configuration - continue (y/n)? n

RedBoot> = %{frank}

Who are you? This is now Josephine

      baudrate

      Set the baud rate for the system serial console

        baudrate

        -b rate

              -b rate

              Number

              The baud rate to use for the serial console.

              none

      The baudrate command sets the baud rate for the system serial console.

If no value is provided, then the current value of the console baud rate is displayed.

If the system supports non-volatile configuration data via the

fconfig command (see ),

then the value will be saved and used when the system is reset.

Show the current baud rate.

RedBoot> baudrate

Baud rate = 38400

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 RedBoot

give you an opportunity to save the value in persistent storage.

RedBoot> baudrate -b 57600

Baud rate will be changed to 57600 - update your settings

Device baud rate changed at this point

Baud rate changed to 57600 - continue (y/n)? y

Update RedBoot non-volatile configuration - continue (y/n)? n

      cache

      Control hardware caches

        cache

          on

          off

              on

              Turn the caches on

              none

              off

              Turn the caches off

              none

      The cache command is used to manipulate the caches on the processor. 

      With no options, this command specifies the state of the system caches.

      When an option is given, the caches are turned off or on appropriately.

Show the current cache state.

RedBoot> cache

Data cache: On, Instruction cache: On

Disable the caches.

RedBoot> cache off

RedBoot> cache

Data cache: Off, Instruction cache: Off

Enable the caches.

RedBoot> cache on

RedBoot> cache

Data cache: On, Instruction cache: On

      channel

      Select the system console channel

        channel

          -1

          channel_number

              -1

              Reset the console channel

              none

              channel_number

              Number

              Select a channel

              none

With no arguments, the channel command displays the current console channel number.

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.

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.

Show the current channel.

RedBoot> channel

Current console channel id: 0

Change to an invalid channel.

RedBoot> channel 99

**Error: bad channel number '99'

Revert to the default channel setting (any console mode).

RedBoot> channel -1

      cksum

      Compute POSIX checksums

        cksum

            -b location

            -l length

              -b location

              Memory address

              Location in memory for stat of data.

              none

              -l length

              Number

              Length of data

              none

          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'.

Checksum a buffer.

RedBoot> cksum -b 0x100000 -l 0x100

POSIX cksum = 3286483632 256 (0xc3e3c2b0 0x00000100)

Checksum an area of memory after loading a file. Note that the base

address and length parameters are provided by the preceding

load command.

RedBoot> load -r -b %{FREEMEMLO} redboot.bin

Raw file loaded 0x06012800-0x0602f0a8

RedBoot> cksum

Computing cksum for area 0x06012800-0x0602f0a8

POSIX cksum = 2092197813 116904 (0x7cb467b5 0x0001c8a8)

      disks

      List available disk partitions.

        disks

None.

        The disks command is used to list disk partitions recognized by RedBoot.

Show what disk partitions are available.

RedBoot> disks

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.`.`.`.`.`|

      dump

      Display memory.

        dump

            -b location

            -l length

            -s

            -1

            -2

            -4

              -b location

              Memory address

              Location in memory for start of data.

              none

              -l length

              Number

              Length of data

              32

              -s

              Boolean

              Format data using Motorola S-records.

              -1

              Access one byte (8 bits) at a time.

Only the least significant 8 bits of the pattern will be used.

              -1

              -2

              Access two bytes (16 bits) at a time.

Only the least significant 16 bits of the pattern will be used.

              -1

              -4

              Access one word (32 bits) at a time.

              -1

        Display a range of memory on the system console.

        The x is a synonym for dump.

        Note that this command could

be detrimental if used on memory mapped hardware registers. 

        The memory is displayed at most sixteen bytes per line, first as the

raw hex value, followed by an ASCII interpretation of the data. 

Display a buffer, one byte at a time.

RedBoot> mfill -b 0x100000 -l 0x20 -p 0xDEADFACE

RedBoot> x -b 0x100000

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  |................|

Display a buffer, one short (16 bit) word at a time.  Note in this case that

the ASCII interpretation is suppressed.

RedBoot> dump -b 0x100000 -2

00100000: FACE DEAD FACE DEAD  FACE DEAD FACE DEAD

00100010: FACE DEAD FACE DEAD  FACE DEAD FACE DEAD

Display a buffer, one word (32 bit) word at a time.  Note in this case that

the ASCII interpretation is suppressed.

RedBoot> dump -b 0x100000 -4

00100000: DEADFACE DEADFACE DEADFACE DEADFACE

00100010: DEADFACE DEADFACE DEADFACE DEADFACE

Display the same buffer, using Motorola S-record format.

RedBoot> dump -b 0x100000 -s

S31500100000CEFAADDECEFAADDECEFAADDECEFAADDE8E

S31500100010CEFAADDECEFAADDECEFAADDECEFAADDE7E

Display a buffer, with visible ASCII strings.

RedBoot> d -b 0xfe00b000 -l 0x80

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 <> %02lX...|

0xFE00B080: 45 6E 74 72 79 20 70 6F  69 6E 74 3A 20 25 70 2C |Entry point: %p,|

      help

      Display help on available commands

        help

         topic

              topic

              String

              Which command to provide help for.

              All commands

The help command displays information about the available

RedBoot commands.  If a topic is given, then the display

is restricted to information about that specific command.

If the command has sub-commands, e.g. fis, 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.

Show generic help.  Note that the contents of this display will depend on the various configuration

options for RedBoot when it was built.

RedBoot> help

Manage aliases kept in FLASH memory

   alias name [value]

Manage machine caches

   cache [ON | OFF]

Display/switch console channel

   channel [-1|<channel number>]

Compute a 32bit checksum [POSIX algorithm] for a range of memory

   cksum -b <location> -l <length>

Display (hex dump) a range of memory

   dump -b <location> [-l <length>] [-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