X-Git-Url: https://git.kernelconcepts.de/?p=karo-tx-redboot.git;a=blobdiff_plain;f=packages%2Fredboot%2Fv2_0%2Fdoc%2Fredboot_cmds.sgml;h=054c4b760ba46137efcea86193c6ed1fee6635fd;hp=11fc2de7ee360036b35932cff3f67c9ba17f2f5c;hb=7a4ea0a4d67744fd3f6b5f207d857005fc707b46;hpb=f0c1bd5d9f8457be4a43912a28ca2df207a7f5a4 diff --git a/packages/redboot/v2_0/doc/redboot_cmds.sgml b/packages/redboot/v2_0/doc/redboot_cmds.sgml index 11fc2de7..054c4b76 100644 --- a/packages/redboot/v2_0/doc/redboot_cmds.sgml +++ b/packages/redboot/v2_0/doc/redboot_cmds.sgml @@ -875,7 +875,7 @@ Set/change IP addresses ip_address [-l <local_ip_address>[/<mask_length>]] [-h <server_address>] Load a file load [-r] [-v] [-d] [-h <host>] [-m {TFTP | HTTP | {x|y}MODEM -c <channel_number>}] - [-b <base_address>] <file_name> + [-f <flash_address>] [-b <base_address>] <file_name> Compare two blocks of memory mcmp -s <location> -d <location> -l <length> [-1|-2|-4] Fill a block of memory with a pattern @@ -1245,28 +1245,35 @@ that an address of 0.0.0.0 will disable DNS lookups. Display the current network settings. RedBoot> ip_address -IP: 192.168.1.31, Default server: 192.168.1.101, DNS server IP: 0.0.0.0 +IP: 192.168.1.31, Default server: 192.168.1.101, DNS server IP: 0.0.0.0, DNS domain name: Change the DNS server address. RedBoot> ip_address -d 192.168.1.101 -IP: 192.168.1.31, Default server: 192.168.1.101, DNS server IP: 192.168.1.101 +IP: 192.168.1.31, Default server: 192.168.1.101, DNS server IP: 192.168.1.101, DNS domain name: + + + +Change the DNS domain name. + +RedBoot> ip_address -D example.com +IP: 192.168.1.31, Default server: 192.168.1.101, DNS server IP: 192.168.1.101, DNS domain name: example.com Change the default server address. RedBoot> ip_address -h 192.168.1.104 -IP: 192.168.1.31, Default server: 192.168.1.104, DNS server IP: 192.168.1.101 +IP: 192.168.1.31, Default server: 192.168.1.104, DNS server IP: 192.168.1.101, DNS domain name: Set the IP address to something new, with a 255.255.255.0 netmask RedBoot> ip_address -l 192.168.1.32/24 -IP: 192.168.1.32, Default server: 192.168.1.104, DNS server IP: 192.168.1.101 +IP: 192.168.1.32, Default server: 192.168.1.104, DNS server IP: 192.168.1.101, DNS domain name: @@ -1289,12 +1296,14 @@ IP: 192.168.1.32, Default server: 192.168.1.104, DNS server IP: 192.168.1.101 xmodem ymodem - - tftp - disk + tftp + disk + file + -h server_IP_address + -f location -b location -c channel file_name @@ -1335,7 +1344,7 @@ serial download method since it would interfere with the protocol. -r Boolean - Raw (or binary) data + Raw (or binary) data. -b or -f must be used formatted (S-records, ELF image, etc) @@ -1368,6 +1377,13 @@ serial download method since it would interfere with the protocol. Transfer data from a local disk. TFTP + + -m file + + Transfer data from a local filesystem such as + JFFS2 or FAT. + TFTP + -h server_IP_address Numeric IP or DNS name @@ -1378,6 +1394,13 @@ serial download method since it would interfere with the protocol. -b location Number Address in memory to load the data. Formatted data streams will have +an implied load address which this option may override. + Depends on data format + + + -f location + Number + Address in flash to load the data. Formatted data streams will have an implied load address which this option may override. Depends on data format @@ -1441,6 +1464,14 @@ Load an ELF file from /dev/hda1 which should be an EXT2 partition: RedBoot> load -mode disk hda1:hello.elf Entry point: 0x00020000, address range: 0x00020000-0x0002fd70 + + + +Load an ELF file from /jffs2/applications which should be a directory +in a JFFS2 filesystem: + +RedBoot> load -mode file /jffs2/applications/hello.elf +Entry point: 0x00020000, address range: 0x00020000-0x0002fd70 @@ -2072,7 +2103,8 @@ About to initialize [format] flash image system - continue (y/n)? y fis list - -f + -c + -d @@ -2250,7 +2282,7 @@ RedBoot> fis free -l Number - Length of flash area to occopy. If specified, and + Length of flash area to occupy. If specified, and the named image already exists, the length must match the value in the FIS directory. Length of area reserved in FIS directory if the @@ -2558,7 +2590,7 @@ Delete image ‘junk’ - continue (y/n)? y Description This command is used to write-protect (lock) a portion of flash memory, -to prevent accidental overwriting of images. In order to make make any modifications +to prevent accidental overwriting of images. In order to make any modifications to the flash, a matching fis unlock command must be issued. This command is optional and will only be provided on hardware which can support write-protection of the flash space. @@ -2786,8 +2818,766 @@ RedBoot> fis write -b 0x0606f000 -l 0x1000 -f 0x00020000 + + + +Filesystem Interface + + +commandsfilesystem access +filesystem commands +commandsfs +fs commands + +If the platform has access to secondary storage, then RedBoot may be +able to access a filesystem stored on this device. RedBoot can access +FAT filesystems stored on IDE disks or CompactFlash devices and can +use JFFS2 filesystems stored in FLASH memory. The +fs command is used to manipulate files on +filesystems. Applications may be loaded into memory using the +file mode of the load command. + + + + + + + fs info + Print filesystem information + + + + fs info + + + + Arguments + + The command takes no arguments. + + + + Description +This command prints information about the filesystems that are +available. Three lists are produced. The first is a list of the +filsystem implementations available in RedBoot; names from this list +may be used in the -t option to the fs +mount command. The second list describes the block devices +that are available for mounting a filesystem; names from this list may +be used in the -d option to the fs +mount command. The last list describes the filesystems that +are already mounted. + + + + + Examples + + +RedBoot> fs info +Filesystems available: +ramfs +jffs2 + +Devices available: +/dev/flash1 + +Mounted filesystems: + Device Filesystem Mounted on + <undefined> ramfs / + /dev/flash1 jffs2 /flash +RedBoot> + + + + + + + + + fs mount + Mount a filesystem + + + + fs mount + -d device + -t fstype + mountpoint + + + + Arguments + + + + + + + + + Name + Type + Description + Default + + + + + device + Number + Device containing filsystem to mount. + undefined + + + fstype + Number + Filesystem type. + + + + mountpoint + String + Pathname for filesystem root. + / + + + + + + + Description +This command is used make a filesystem available for access with +the filesystem access commands. Three things need to be defined to do +this. First, the name of the device on which the filesystem is stored +needs to be given to the -d option. Secondly, +the type of filesystem it is needs to be given to the +-t option. Finally, the pathname by which the +new filesystem will be accessed needs to be supplied. Following a +successful mount, the root of the filesystem will be accessible +at the mountpoint. + + + + + Examples +Mount a JFF2 partititon: + +RedBoot> fs info +Filesystems available: +ramfs +jffs2 + +Devices available: +/dev/flash1 + +Mounted filesystems: + Device Filesystem Mounted on + <undefined> ramfs / +RedBoot> fs mount -d /dev/flash1 -t jffs2 /flash +RedBoot> fs info +Filesystems available: +ramfs +jffs2 + +Devices available: +/dev/flash1 + +Mounted filesystems: + Device Filesystem Mounted on + <undefined> ramfs / + /dev/flash1 jffs2 /flash +RedBoot> + + + + + + + + + + fs umount + Unmount filesystem + + + + fs umount + mountpoint + + + + Arguments + + + + + + + + + Name + Type + Description + Default + + + + + mountpoint + String + Mountpoint of filesystem to unmount. + + + + + + + + Description +This command removes a filesystem from being accessible using +the filesystem commands. The single argument needs to be the +mountpoint that was used when mounting the filesystem. This command +will fail if the current directory is currently within the filesystem +to be unmounted. + + + + + Examples +Unmount a JFF2 partititon: + +RedBoot> fs info +Filesystems available: +ramfs +jffs2 + +Devices available: +/dev/flash1 + +Mounted filesystems: + Device Filesystem Mounted on + <undefined> ramfs / + /dev/flash1 jffs2 /flash +RedBoot> fs umount /flash +RedBoot> fs info +Filesystems available: +ramfs +jffs2 + +Devices available: +/dev/flash1 + +Mounted filesystems: + Device Filesystem Mounted on + <undefined> ramfs / +RedBoot> + + + + + + + + + + fs cd + Change filesystem directory + + + + fs cd + directory + + + + Arguments + + + + + + + + + Name + Type + Description + Default + + + + + directory + String + Pathname to directory to change to. + Root directory + + + + + + + Description +This command changes the current filesystem +directory. Subsequent filesystem commands will be executed in the new +directory. If no argument is given, then the current directory is set +back to the root of the filesystem name space. + + + + + Examples + Change current directory: + +RedBoot> fs list +212416 d--------- 3 size 128 . +212416 d--------- 3 size 128 .. +211392 d--------- 2 size 96 tests +210368 ---------- 1 size 4096 image +RedBoot> fs cd tests +RedBoot> fs list +211392 d--------- 2 size 96 . +212416 d--------- 3 size 128 .. +205760 ---------- 1 size 16384 test1 +RedBoot> + + + + + + + + + + fs mkdir + Create filesystem directory + + + + fs mkdir + directory + + + + Arguments + + + + + + + + + Name + Type + Description + Default + + + + + directory + String + Pathname to directory to delete. + + + + + + + + Description +This command creates (makes) a directory in the filesystem. + + + + + Examples + Create directory: + +RedBoot> fs list +212416 d--------- 2 size 128 . +212416 d--------- 2 size 128 .. +210368 ---------- 1 size 4096 image +RedBoot> fs mkdir tests +RedBoot> fs list +212416 d--------- 3 size 128 . +212416 d--------- 3 size 128 .. +211392 d--------- 2 size 64 tests +210368 ---------- 1 size 4096 image +RedBoot> + + + + + + + + + + fs deldir + Delete filesystem directory + + + + fs deldir + directory + + + + Arguments + + + + + + + + + Name + Type + Description + Default + + + + + directory + String + Pathname to directory to delete. + + + + + + + + Description +This command deletes a directory from the filesystem. If the +directory contains files or other directories then this command will +fail. + + + + + Examples + Delete directory: + +RedBoot> fs list +212416 d--------- 3 size 128 . +212416 d--------- 3 size 128 .. +211392 d--------- 2 size 96 tests +210368 ---------- 1 size 4096 image +RedBoot> fs deldir tests +RedBoot> fs list +212416 d--------- 2 size 128 . +212416 d--------- 2 size 128 .. +210368 ---------- 1 size 4096 image +RedBoot> + + + + + + + + + + fs del + Delete file + + + + fs del + file + + + + Arguments + + + + + + + + + Name + Type + Description + Default + + + + + file + String + Pathname of file to delete. + + + + + + + + Description +This command deletes a file from the filesystem. + + + + + Examples + Change current directory: + +RedBoot> fs list tests +211392 d--------- 2 size 96 . +212416 d--------- 3 size 128 .. +205760 ---------- 1 size 16384 test1 +RedBoot> fs del tests/test1 +RedBoot> fs list tests +211392 d--------- 2 size 96 . +212416 d--------- 3 size 128 .. +RedBoot> + + + + + + + + + + fs move + Move file + + + + fs move + source + dest + + + + Arguments + + + + + + + + + Name + Type + Description + Default + + + + + source + String + Pathname of file to move. + + + + dest + String + Pathname to new file location. + + + + + + + + Description +This command moves a file within a filesystem. This command will +fail if the destination file already exists, or is in a different +filesystem. + + + + + Examples + Rename a file: + +RedBoot> fs list tests +211392 d--------- 2 size 96 . +212416 d--------- 3 size 128 .. +205760 ---------- 1 size 12288 test1 +RedBoot> fs move tests/test1 tests/test2 +RedBoot> fs list tests +211392 d--------- 2 size 128 . +212416 d--------- 3 size 128 .. +205760 ---------- 1 size 12288 test2 +RedBoot> + + + + + + + + + + fs list + List filesystem directory + + + + fs list + directory + + + + Arguments + + + + + + + + + Name + Type + Description + Default + + + + + directory + String + Pathname to directory to list. + Current directory + + + + + + + Description +This command prints a list of the contents of the named +directory. Each line of the listing starts with the file's inode +number, which is its address in the filesystem. Following is a set of +UNIX-like access flags, the first character of this will be a +”d“ if this entry is a directory. The third item indicates +the number of links to the file. Following this is the size of the +file in bytes and the last item is its name. + + + + + Examples + List the current directory: + +RedBoot> fs list +212416 d--------- 3 size 128 . +212416 d--------- 3 size 128 .. +211392 ---------- 1 size 4096 image +206784 d--------- 2 size 96 tests +RedBoot> + + + +List a subdirectory: + +RedBoot> fs list tests +206784 d--------- 2 size 96 . +212416 d--------- 3 size 128 .. +205760 ---------- 1 size 16384 test1 +RedBoot> + + + + + + + + + + fs write + Write to filesystem + + + + fs write + -b mem_address + -l length + name + + + + Arguments + + + + + + + + + Name + Type + Description + Default + + + + + mem_address + Number + Address of data to be written to flash. + Address of last loaded file. If not set by a load + operation it must be specified. + + + length + Number + Length of data to be written. + Length of last loaded file. + + + name + String + Name of file to create. + + + + + + + + Description +This command is used to write data from memory to a file. If the +file does not exist it will be created. If it does exist, then it will +be overwritten with the new contents. + + + + Examples +Write an area of data to a file + +RedBoot> fs write -b 0x0606f000 -l 0x1000 image +RedBoot> fs list +212416 d--------- 3 size 128 . +212416 d--------- 3 size 128 .. +211392 ---------- 1 size 4096 image +206784 d--------- 2 size 96 tests +RedBoot> + + + + + + + + Persistent State Flash-based Configuration and Control persistent state flash-based configuration and control @@ -2917,6 +3707,7 @@ 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 +DNS domain name: example.com GDB connection port: 9000 Network debug at boot time: false