@CHIP-RTOS - Command Processor

COMMAND

File system commands

Hardware commands

TCP/IP commands

RTOS commands

Other commands

CD directory
Change the current working directory.

Changes the current working directory.

Example

cd temp

Supported since or modified in @CHIP-RTOS version

SC12	SC13	SC11	SC1x3	SC2x
V1.00	V1.00	V1.00	V0.90	V1.00

COPY filename1 filename2
Copy a file.

Copy a file.   The two file specifiers must be complete file names.
Wildcards such as * or ? are not allowed.

Comments

This command will fail if the resulting overall full path length of the new file exceeds a maximum (see below).   This full path includes the drive letter and back slashes in the count, e.g.:

A:\TEMP\MY_FILE.TXT

Each of the string length specifications here do not include in the count the required final string terminating NIL character.

SC1x Comments

The over all maximum path length is 147 characters.   The names in each of the path segments must be 8.3 maximum, DOS fashion.

SC1x3/SC2x Comments

The over all maximum path length is 259 characters.   The names in each segment of the full path are limited to 255 characters maximum. The BIOS_ExecuteExt() API may be used to obtain status feedback during the COPY execution.

Supported since or modified in @CHIP-RTOS version

SC12	SC13	SC11	SC1x3	SC2x
V1.20	V1.20	V1.20	V0.91	V1.00

CHKDSK drive [/F]
Check disk integrity

This command checks a specified disk and displays a status report.

Comments

The command line option /F can be used to repair certain types of faults detected on the drive.   Go here for more detailed information about this command.

When no drive is specified, as done in the first example below, the CHKDSK operation is done on the current working directory's drive.

Example

CHKDSK
CHKDSK B:
CHKDSK A: /F

Related Topics

FORMAT command

Supported since or modified in @CHIP-RTOS version

SC12	SC13	SC11	SC1x3	SC2x
n/a	n/a	n/a	V1.30	V1.30

DEL filename
Delete a file

Delete a file or all files that match the wildcard.

Comments

Files which have the Read-only attribute set cannot be deleted.

Example

del *.dat

Related Topics

DIR command

DOS file attributes API

Supported since or modified in @CHIP-RTOS version

SC12	SC13	SC11	SC1x3	SC2x
V1.00	V1.00	V1.00	V0.90	V1.00

DIR filename
List a directory.

List the directory entry or all entries that match the wildcard.

Comments

If no argument is given, *.* is assumed.

The file's attributes are shown with three letter designations.   The letter is replaced by a dash, '-', when the respective attribute is not set.   These three attributes are, from left to right:

A - Archive flag
R - Read-only file
S - System file

The user is free to use the A and S flags as they please.   These flags play no role inside the @Chip-RTOS file system operation.

The read-only attribute will prevent files from being deleted so long as this flag is set.

There also is a Hidden file attribute flag.   The DIR command does not list files that have the hidden attribute flag set.

Note that C language applications can control these attribute flags with the _dos_setfileattr() standard C-library function.

Example

dir *.exe

Related Topics

DEL command

DOS file attributes API

SC1x3/SC2x Comments

Following the long file names, the short 8.3 DOS alias name will be shown in paranthesis where applicable. Note that for very large directories with over 4000 files, this system will not generate any further short 8.3 DOS name aliases when files are created in order to avoid an excessively long file creation time.

Supported since or modified in @CHIP-RTOS version

SC12	SC13	SC11	SC1x3	SC2x
V1.00	V1.00	V1.00	V0.90	V1.00

FORMAT drive [/C:n] [/E] [/R:n] [/Q]
Format a disk drive.

Format a drive.

All information on the drive will be lost !

Comments

Make sure that other tasks do not access the drive when formatting.

The cluster size parameter /C: is optional.   This parameter cannot be applied to the C: RAM drive, which automatically selects its own cluster size appropriate for the FAT12 file allocation table which is used.   For the other drives, the specified cluster size must be one of following legal values:

1, 2, 4, 8, 16, 32, 64

The default cluster size for the internal A: drive is 2 sectors per cluster.   (The file system's sector size is 512 bytes.)   The default cluster size for external B: and RAM C: drives vary depending on the volume size.

If the /E parameter is specified, the data area will be filled with null-data.   This option is not supported on the RAM C: drive or external drives B:/D:.

With parameter /R you can specify the number of root directory entries.   Note that the actual number of root entries must be a multiple of 16, so your specified number of root entries will be rounded up if necessary to the nearest multiple of 16.

If the quiet mode parameter /Q is specified, the confirmation check is skipped. Specify this if you want to call this command with the BIOS_Execute() or BIOS_executeExt() API.

Important : If you use retentive operators, format A: flash disk only with default cluster size!!

Example

FORMAT A: /C:2 /E
FORMAT B: /C:4
FORMAT B: /R:256

SC12 Comments

On drive A: flash disk, there may result 16 more root directory entries than requested due to internal cluster alignment requirements.

SC1x Comments

When /C: option is used to specify the sectors per cluster for the external B: drive, care must be taken that the resulting number of clusters does not exceed the FAT16 limit of 65524 data clusters.   Otherwise the formatting attempt will fail.

The default numbers of root directory entries are:

32 entries on A: flash drive
512 entries on B: external drive
16 entries on C: RAM drive
B: drive volumes over 2 Gbyte will be truncated to 2 Gbyte so that they can be managed with a FAT16 format file allocation table.

SC1x3/SC2x Comments

The SC1x3/SC2x @Chip-RTOS file system supports FAT32, allowing large B: or D: drive volumes to be used.

The default numbers of root directory entries are:

64 entries on A: flash drive
512 entries on B:/D: external drives
32 entries on C: RAM drive
64 entries on Z: read-only drive

Note that long file names eat up additional directory entries according to name length as:

number_of_extra_directory_entries = (strlen(filename) + 12) / 13 ;

The 8.3 DOS style file names require no additional directory entries provided that the file name is all upper case.

The /E option is not necessary on the A: drive.   All A: drive disk sectors are erased by default when ever this flash memory drive is formatted.

The /R option for root directory entry count has no meaning for FAT32 volumes and will be ignored.   (The FAT32 root directory has no particular limit on number of entries.)

An additional command line option for the external B:/D: drive can be used to explicitly specify either FAT32 with

FORMAT B: /F:32

or FAT16 format with

FORMAT B: /F:16

Depending on a disk's sector count, either of these options may fail if an appropriate sectors per cluster count cannot be found, or if a sectors per cluster count specified with the /C: option does not suite the specified FAT16/FAT32 format.   The /F: option is valid only for B: and D: drive.

The BIOS_executeExt() API can be used to obtain progress feedback during the FORMAT command execution.

Supported since or modified in @CHIP-RTOS version

SC12	SC13	SC11	SC1x3	SC2x
V1.23	V1.23	V1.23	V1.15	V1.00

FTLSTAT
Display state of flash translation layer.

Displays the state of the flash translation layer an drive A:, like free, dirty and valid sectors.

Comments

The flash translation layer provides the logic for the file system to access small virtual sectors (512 Byte) from larger physical flash sectors (64 kB). This is necessary, because only complete physical sectors can be erased.   This layer also assures a wear leveling, so that data gets spread across the media.

The FTLSTAT command shows the state of the managed small virtual sectors.   Valid sectors are sectors that have valid content.   Free sectors are sectors that have all bits in the erased state.   Dirty sectors are sectors that have been discarded or replaced.   Dirty sectors are automatically reclaimed, if the free sector count reachs a low number. Reclamation means that all valid sectors in a physical block that has dirty sectors are copied to another physical block, before the whole physical block is erased to recover the dirty sectors.

Supported since or modified in @CHIP-RTOS version

SC12	SC13	SC11	SC1x3	SC2x
n/a	n/a	n/a	V0.90	V1.00

FTLRECL
Reclaim sectors in flash translation layer.

Reclaims all dirty sectors in the flash translation layer on drive A:.

Comments

The filesystem does an auto reclaim, if the free sectors reach a specific number. A manual operated reclaim is not necessary.

Supported since or modified in @CHIP-RTOS version

SC12	SC13	SC11	SC1x3	SC2x
n/a	n/a	n/a	V0.90	V1.00

MD directory
Creates a directory.

Creates a directory.

Comments

This command will fail if the resulting overall full path length exceeds a maximum (see below).   This full path includes the drive letter and back slashes in the count, e.g.:

A:\TEMP\

Each of the string length specifications here do not include in the count the required final string terminating NIL character.

Example

md temp

SC1x Comments

The over all maximum path length is 147 characters.   The names in each of the path segments must be 8.3 maximum, DOS fashion.

SC1x3/SC2x Comments

The over all maximum path length is 259 characters.   The names in each segment of the full path are limited to 255 characters maximum.

Supported since or modified in @CHIP-RTOS version

SC12	SC13	SC11	SC1x3	SC2x
V1.20	V1.20	V1.20	V0.91	V1.00

TYPE filename
Type a file.

Show contents of a file on the console.

Supported since or modified in @CHIP-RTOS version

SC12	SC13	SC11	SC1x3	SC2x
V1.00	V1.00	V1.00	V0.90	V1.00

RD directory
Removes a directory.

Removes a directory.   This command cannot be executed on directories containing data.

Example

rd temp

Supported since or modified in @CHIP-RTOS version

SC12	SC13	SC11	SC1x3	SC2x
V1.00	V1.00	V1.00	V0.90	V1.00

REN filename1 filename2
Rename a file.

Rename a file or directory.

Comments

The two file specifiers must be complete file names.   Wildcards such as * or ? are not allowed.

Both files must reside in the same directory.

Files or directories which are in use by a task or program cannot be renamed.

Supported since or modified in @CHIP-RTOS version

SC12	SC13	SC11	SC1x3	SC2x
V1.23	V1.23	V1.23	V1.16	V1.00

ADR addressline
Enable non-multiplexed address bus pins.

SC1x:

Enables the non-multiplexed address bus pins (A0/A1/A2).
The command expects only one parameter: 0=enable A0 / 1=enable A1 / 2=enable A2

SC1x3:

Enables the non-multiplexed address bus pins (A23).
The command expects only one parameter: 23=enable A23

Example

ADR 0

Supported since or modified in @CHIP-RTOS version

SC12	SC13	SC11	SC1x3	SC2x
V1.00	V1.00	V1.00	V0.90	n/a

ALE 0/1
Enable/disable ALE pin.

Enables the address latch enable (ALE) pin.
The command expects only one parameter: 1 enable / 0 disable.

Example

ALE 1

Supported since or modified in @CHIP-RTOS version

SC12	SC13	SC11	SC1x3	SC2x
V1.00	V1.00	V1.00	n/a	n/a

IW address
Input word.

Perform a 16 bit input from a given I/O address.
The address and the result are hexadecimal.

Example

IW 600

Supported since or modified in @CHIP-RTOS version

SC12	SC13	SC11	SC1x3	SC2x
V1.00	V1.00	V1.00	V0.90	V1.00

IB address
Input byte.

Perform an 8 bit input from a given I/O address.
The address and the result are hexadecimal.

Example

IB 600

Supported since or modified in @CHIP-RTOS version

SC12	SC13	SC11	SC1x3	SC2x
V1.01	V1.00	V1.00	V0.90	V1.00

OW address value
Output word.

Perform a 16 bit output on a given I/O address with given data.
The address and the data are hexadecimal.   The address is the first
parameter followed by data.

Example

OW 600 F

Supported since or modified in @CHIP-RTOS version

SC12	SC13	SC11	SC1x3	SC2x
V1.00	V1.00	V1.00	V0.90	V1.00

OB address value
Output byte.

Perform an 8 bit output on a given I/O address with given data.
The address and the data are hexadecimal.   The address is the first
parameter followed by data.

Example

OB 600 F

Supported since or modified in @CHIP-RTOS version

SC12	SC13	SC11	SC1x3	SC2x
V1.00	V1.00	V1.00	V0.90	V1.00

RW segment:offset
Read word from memory.

Perform a 16 bit read from a given segment:offset memory address.
The address and the result are hexadecimal.

Example

RW 8000:100

Supported since or modified in @CHIP-RTOS version

SC12	SC13	SC11	SC1x3	SC2x
n/a	n/a	n/a	V1.05	n/a

RB segment:offset
Read byte from memory.

Perform an 8 bit read from a given segment:offset memory address.
The address and the result are hexadecimal.

Example

RB 8000:100

Supported since or modified in @CHIP-RTOS version

SC12	SC13	SC11	SC1x3	SC2x
n/a	n/a	n/a	V1.05	n/a

WW segment:offset value
Write word to memory.

Perform a 16 bit write on a given segment:offset memory address with given data.
The address and the data are hexadecimal.   The address is the first
parameter followed by data.

Example

WW 8000:100 1A2B

Supported since or modified in @CHIP-RTOS version

SC12	SC13	SC11	SC1x3	SC2x
n/a	n/a	n/a	V1.05	n/a

WB segment:offset value
Write byte to memory.

Perform an 8 bit write on a given segment:offset memory address with given data.
The address and the data are hexadecimal.   The address is the first
parameter followed by data.

Example

WB 8000:1000 1A

Supported since or modified in @CHIP-RTOS version

SC12	SC13	SC11	SC1x3	SC2x
n/a	n/a	n/a	V1.05	n/a

MEMDMP segment:offset size
Dump memory area.

Dump a memory area on the console from a given segment:offset memory address.
The address is hexadecimal. The size is decimal. The results are show in hexadecimal and ascii.

Example

MEMDMP 8000:100 256

Supported since or modified in @CHIP-RTOS version

SC12	SC13	SC11	SC1x3	SC2x
n/a	n/a	n/a	V1.05	n/a

PCS chipselect
Enable chip select.

Enables a chip select line.
The command expects only one parameter: the chip select line.

SC1x:

Valid arguments are 0, 1, 2, 3, 5 or 6.

SC1x3:

Valid arguments are 0, 1, 2, 3, 4, 5, 6, 7.

Example

PCS 6

Supported since or modified in @CHIP-RTOS version

SC12	SC13	SC11	SC1x3	SC2x
V1.00	V1.00	V1.00	V0.90	n/a

PIO [pionumber mode]
Enable and show PIO pins.

SC1x:

Enables the programmable PIO pins (PIO0-13).
The command expects two parameters: PIO MODE

PIO: PIO number (0-13)
MODE: PIO mode
    1 = Input without pullup/pulldown
    2 = Input with pullup (not PIO13)
    3 = Input with pulldown (only for PIO3 and PIO13)
    4 = Output value = High
    5 = Output value = Low

SC1x3:

Enables the programmable PIO pins (PIO0-24, 26-31).
The command expects two parameters: PIO MODE

PIO: PIO number (0-24, 26-31)
MODE: PIO mode
    1,2 = Input with pullup
    4 = Output value = High
    5 = Output value = Low

SC2x:

Enables the programmable PIO pins (PIO0-2, 9-13, 18-23, 27-28, 31).
The command expects two parameters: PIO MODE

PIO: PIO number (0-2, 9-13, 18-23, 27-28, 31)
MODE: PIO mode
    1,2 = Input with pullup/down (PIO1/PIO2=pulldown, all other=pullup)
    4 = Output value = High
    5 = Output value = Low

When no command line argument is given, the PIO state is shown.

Example

PIO 3 5  = PIO3 Output low
PIO      = Shows PIO states

Supported since or modified in @CHIP-RTOS version

SC12	SC13	SC11	SC1x3	SC2x
V1.01	V1.00	V1.00	V0.90	V1.00

IP address
Sets the IPv4 address of the Ethernet interface.

Sets the IPv4 address of the internal Ethernet interface.

Comments

This command modifies the information stored in A:\chip.ini.

The DHCP option is also switched off.

The new address is not used until after a IPETH command or a restart of the system.

Use the IPCFG command to verify your entry before restarting the system.

Example

IP 195.243.140.85

Related Topics

IPv4 address initial value

Set an IPv6 address

IPCFG - IPv4 configuration display command

Set_IPConfig() - Set IPv4 configuration API

PPP server initial IP address

Initial DHCP setting

Supported since or modified in @CHIP-RTOS version

SC12	SC13	SC11	SC1x3	SC2x
V1.00	V1.00	n/a	V0.90	V1.00

NETMASK mask
Set the network mask for IPv4 addressing of the Ethernet interface.

Sets the subnet mask for IPv4 addressing of the internal Ethernet interface.

Comments

This command modifies the information stored in A:\chip.ini.

The DHCP option is also switched off.

The new subnet mask is not used until after a IPETH command or a restart of the system.

Use the IPCFG command to verify your entry before restarting the system.

Example

NETMASK 255.255.255.192

Related Topics

IP subnet mask initial value

Set IPv6 address

Initial DHCP setting

Set_IPConfig() - Set IPv4 configuration API

Supported since or modified in @CHIP-RTOS version

SC12	SC13	SC11	SC1x3	SC2x
V1.00	V1.00	n/a	V0.90	V1.00

GATEWAY address
Define the IP address of the gateway

Sets the IPv4 address of the default gateway to use.

Comments

This command modifies the information stored in A:\chip.ini.

The DHCP option is also switched off.

The new gateway address is not used until after a IPETH command or a restart of the system.

Use the IPCFG command to verify your entry before restarting the system.

Example

GATEWAY 195.243.140.1

Related Topics

IP GATEWAY initial value

Set_IPConfig() - Set IPv4 configuration API

AddDefaultGatewayEx() API function

Initial DHCP setting

Supported since or modified in @CHIP-RTOS version

SC12	SC13	SC11	SC1x3	SC2x
V1.00	V1.00	n/a	V0.90	V1.00

IPCFG
Display current IPv4 configuration

This command display current IPv4 configuration of all installed TCP/IP device interfaces.   The fields shown for each installed TCP/IP device interface are:

Device:  Interface name
Type:   ETH(Ethernet), LPK(Internal loopback), PPP or Unknown
Idx:   Internal index number of the device interface
IP address
Network mask
MAC address:   (If Ethernet type)
Gateway: Default gateway, if one is set

The current link state and operating mode of the Ethernet controller are displayed with the IPv4 address configuration of the default Ethernet device.

Example

IPCFG

Related Topics

IPV6CFG - IPv6 configuration

IP - Set IPv4 address command

Supported since or modified in @CHIP-RTOS version

SC12	SC13	SC11	SC1x3	SC2x
V1.00	V1.00	V1.00	V0.90	V1.00

IPV6 index address
Set an IPv6 address of the Ethernet interface.

Set an IPv6 address entry for the internal Ethernet interface.

Comments

Command syntax: IPV6 AddressIndex Address (see examples below)

It is possible to configure up to 5 IPv6 addresses (index 0 through 4).   This command modifies the information stored in A:\chip.ini.

The new address is not used until after a IPETH command or a restart of the system.

The prefix length is always required (e.g. the "/64" in examples below).

The IPV6CFG command can be used to verify your entry before restarting the system.

Example

IPv6 0 3ffe:ffff:0:f101::1/64
IPv6 1 4ffe:ffff:0:f101::1/64
IPv6 4 2ffe:ffff:0:f101::1/64

Related Topics

IPV6CFG - IPv6 configuration display command

IPV6 address initial value

IPV6 Stateless autoconfiguration

Set IPv4 address command

Supported since or modified in @CHIP-RTOS version

SC12	SC13	SC11	SC1x3	SC2x
n/a	n/a	n/a	V0.90	V1.00

IPV6CFG
Display current IPv6 address configuration

This command display the current IPv6 address configuration of all installed TCP/IP device interfaces.   The fields shown for each installed TCP/IP device interface are:

Device: Interface name
Type: ETH(Ethernet), LPK(Internal loopback), PPP or Unknown
Idx: Internal index number of the device interface
IPv6 addresses
MAC address (if Ethernet type)

Fixed configured addresses are listed with index numbers 0-4.   Addresses configured by "Stateless auto configuration" are listed with index number 5 - 9.   The current link state and operating mode of the Ethernet controller are displayed with the IPv6 address configuration of the default Ethernet device.

Example

IPV6CFG

Related Topics

Set an IPv6 address

IPV6 address initial value

IPV6 Stateless autoconfiguration

IPCFG - IPv4 configuration

Overview IPv4/v6 - Dual layer stack

Supported since or modified in @CHIP-RTOS version

SC12	SC13	SC11	SC1x3	SC2x
n/a	n/a	n/a	V0.90	V1.00

SNIFF DirPath / 0
Enable/disable network tracing

This command starts and stops internal network tracing.   Due to the CAP file format used to store the data, the trace files are readable by network analyzer tools such as Wireshark.

If network tracing is enabled, all network traffic will be written into trace files at the specified path (e.g. B:\Sniff, C:, ...).    A trace file will be created for each network interface which sends or receives data.   The names of the trace files are derived from the device name with the .CAP extension appended, e.g. LANCE0.CAP or PPPSRV.CAP.   Any SNIFF files left over from a previous power up session for a particular device will be overwritten when that device starts to record network data.

Typing SNIFF 0 stops the tracing.   If trace is later re-enabled during the same power up period, the existing trace files will be appended.

Comments

Due to the limited write cycles of the internal flash device it is recommended to specify a path located on an external disk or on the internal RAM drive C:.

Please note that network tracing can place a significant load on the CPU and will slow down the speed of the network communication.

Example

Sniff B:\Sniff
Sniff C:
Sniff 0

Supported since or modified in @CHIP-RTOS version

SC12	SC13	SC11	SC1x3	SC2x
n/a	n/a	n/a	V1.35	V1.35

IPETH
Restart the Ethernet interface

Restart/Reconfigure the internal Ethernet interface, e.g. after changing the IP configuration,
without rebooting the system.
Opt. parameter 'N': Reconfigures the IP settings without physical init of the ethernet controller
Opt. parameter 'A': Reconfigure ethernet with an AutoIP address(available since SC1x RTOS V1.20 and SC1x3 RTOS V1.05).

Comments

If the restart command prints an error message, check your IP parameters.
In most cases an invalid gateway IP address is the reason why the restart failed.
The error code 237 signals that a Ethernet configuration was already in progress.

Please note: If the specified number of DHCP trials is larger than default 3, the command will not wait for completion of the DHCP process.
The AutoIP procedure is also usable by the chip.ini entry AUTOIP.

Example

ipeth    ; Reconfigures the IP settings and initializes the ethernet controller physically
ipeth N  ; Reconfigures the IP settings of the ethernet device
ipeth A  ; Reconfigures the IP settings of the ethernet device by using the AutoIP procedure

Supported since or modified in @CHIP-RTOS version

SC12	SC13	SC11	SC1x3	SC2x
V1.20	V1.20	n/a	V0.90	V1.00

IKE
Internet Key Exchange (IKE) status.

Lists IP Security and IKE status information to console.   A list of established Security Associations (SA) is provided.

Comments

START is an optional parameter to this command which can be used to start up the IKE task if this has not already been started.   Starting the IKE task enables use of the IP Security.

The error codes listed here are provided to help resolve problems with either IP security startup processing or IKE negotiation with a peer.

When IKE negotiations are failing in phase 2 (Quick mode), the Security Association (SA) parameters that we propose (initiator role) or can accept (responder role) from the respective peer are displayed for diagnostic purposes.   When we are the responder and the peer is the initiator, the peer's SA proposals will also be listed (this recording is limited to the first 6 transforms received).   Therefore more Quick mode diagnostic information is available here when the peer side initiates the IKE.

Example

IKE START

Related Topics

IPSEC ENABLE in CHIP.INI

IPsec_Start() API

Supported since or modified in @CHIP-RTOS version

SC12	SC13	SC11	SC1x3	SC2x
n/a	n/a	n/a	V1.15	V1.00

TCPIPMEM
Display TCP/IP memory usage

Displays TCP/IP memory usage.   This command shows the maximum reserved memory for the TCP/IP stack and the current TCP/IP stack memory used.

Supported since or modified in @CHIP-RTOS version

SC12	SC13	SC11	SC1x3	SC2x
V1.00	V1.00	V1.00	V0.90	V1.00

DHCP 0/1
Enable/Disable DHCP.

Enables or disables the use of DHCP for the internal Ethernet interface to obtain an IP configuration.

Comments

DHCP is an abbreviation for "Dynamic Host Configuration Protocol".
Using a DHCP Server, the network administrator can define the IP configuration of the network, without manually configuring each device on the network.
Network servers and some ISDN routers offer a DHCP server.

Example

dhcp 1

Related Topics

Initial DHCP setting

Supported since or modified in @CHIP-RTOS version

SC12	SC13	SC11	SC1x3	SC2x
V1.00	V1.00	n/a	V0.90	V1.00

FTP 0/1
Enable/Disable FTP.

Enables (1) or disables (0) the FTP server. Additionally a resp. entry is added to the chip.ini configuration file to preserve the FTP server's running status after a reboot.
Note that chip.ini is not changed if the command is issued from within a batch file.

Example

FTP 1

Related Topics

Initial FTP ENABLE setting

Supported since or modified in @CHIP-RTOS version

SC12	SC13	SC11	SC1x3	SC2x
V1.00	V1.00	V1.00	V0.90	V1.00

TFTP 0/1
Enable/Disable TFTP

Enables or disables file transfers via TFTP server.
0 disables the server, 1 enables TFTP file transfer.

Comments

By default the TFTP server is disabled to avoid security leaks.

Example

TFTP 1

Supported since or modified in @CHIP-RTOS version

SC12	SC13	SC11	SC1x3	SC2x
on request	on request	on request	V0.90	V1.00

PING address
The ICMP echo request (ping)

Test the network connection with the ICMP command ping.

This command sends 4 ICMP echo requests (64 Bytes) to the remote host,
with an interval of 1 second and shows the results.
DNS names are supported.

Comments

DNS queries consume a relative large part of the main task's relative small stack.

Example

PING 192.168.200.10
PING www.beck-ipc.com

Related Topics

Ping_Open() API function

Supported since or modified in @CHIP-RTOS version

SC12	SC13	SC11	SC1x3	SC2x
V1.00	V1.00	V1.00	V0.90	V1.00

CLOSETELNET
Close current telnet session.

This function will finish the current Telnet session.

Supported since or modified in @CHIP-RTOS version

SC12	SC13	SC11	SC1x3	SC2x
V1.00	V1.00	V1.00	V0.90	V1.00

CGISTAT
List Installed CGI handlers.

This function will list all installed CGI handlers.

Related Topics

CGI_INSTALL API function

Supported since or modified in @CHIP-RTOS version

SC12	SC13	SC11	SC1x3	SC2x
V1.00	V1.00	V1.00	V0.90	V1.00

WEBSTAT
Show the current settings of the Web server

This function will show the current settings of the Web server:
e.g. root directory, root drive,...., default start page.

See WEB config for the available chip.ini entries for the Web server.

Supported since or modified in @CHIP-RTOS version

SC12	SC13	SC11	SC1x3	SC2x
V1.00	V1.00	V1.00	V0.90	V1.00

MEM
Display memory map.

Displays a memory map, including the name of the task owning the memory.

The RTX and file system resource usage is also indicated here.

Comments

The size indicated is the actual usable size of the heap memory blocks.

SC1x Comments

One sector (16 bytes) is added for memory management.

SC1x3/SC2x Comments

One sector (256 bytes) is added for memory management.

Any global data entries found in the RTX_Publish() registry will also be listed.

Supported since or modified in @CHIP-RTOS version

SC12	SC13	SC11	SC1x3	SC2x
V1.00	V1.00	V1.00	V0.90	V1.00

TASKS
Display list of tasks.

Displays a lists of all tasks, including the CPU load caused by the task, the task status and the stack space usage.

Comments

At every one millisecond clock tick, the count for the active task is increased by one.   After 10 seconds, the counters are copied and reset to zero. At the first call of TASKS, the timer interrupt routine of the RTOS is exchanged by a version for the task monitor.   First after 10 seconds, a repeated TASKS command will return usable results.

The command shows no task stack size for DOS applications, since the DOS program at run time switches to its own internal stack, which is not visible to the Kernel.

A maximum of 35 tasks can by monitored.

Please be aware that using TASKS has a performance penalty.   Use UTASKS command to
shut off the task monitoring.

The listed task state is only a one moment snapshot.   The task state bit field is a 16 bit hexadecimal value defined as follows:

        Bit0        timer wait (used with other bits)
        Bit1        trigger wait (i.e. idle)
        Bit2        semaphore wait
        Bit3        event group wait
        Bit4        message exchange wait
        Bit5        message send wait
        Bit6        suspended (waiting for resume)
        Bit7        waiting for wake
        Bit8        Task has access to File System
        Bit9-15    internal use only


Current running system tasks (if not disabled in chip.ini)
    Very high priority:
    AMXK     prio= 00      Kernel task
    NMI      prio= 01      Powerfail task
    TCPT     prio= 04      TCP/IP timer task
    ETH0     prio= 05      Ethernet receiver task
    Normal:
    PPPS     prio= 06      PPP server
    PPPC     prio= 06      PPP client
    CFGS     prio= 07      UDP config server
    TELN     prio= 11      Telnet server
    SSHD     prio= 11      SSH server (daemon)
    SSHx     prio= 11      SSH server (session), x=0,1,2,...
    MTSK     prio= 12      Console task (command shell)
    Low priority:
    WEBS     prio= 41      Web server
    FTPS     prio= 41      FTP server
    SSLW     prio= 41      SSL web server

Example

Sample output:
ID 1094 cnt  3515  MTSK prio= 12  stack=3000 used=35% state=0000
ID 1606 cnt    81  ETH0 prio=  5  stack=2048 used=41% state=0004
ID  256 cnt  4568  AMXK prio=  0
ID 2374 cnt  1072  WEBS prio= 41  stack=2048 used=24% state=0081
ID 2886 cnt   100  DOS1 prio= 25  stack= n/a used=n/a state=0040
ID 3142 cnt   157  DOS2 prio= 25  stack= n/a used=n/a state=0081
ID 1862 cnt    24  CFGS prio=  7  stack=1400 used=28% state=0004

Supported since or modified in @CHIP-RTOS version

SC12	SC13	SC11	SC1x3	SC2x
V1.00	V1.00	V1.00	V0.90	V1.00

UTASKS
Disables the Task Monitor.

Disables the Task Monitor which was installed using TASKS command.

If you do not need the Task Monitor anymore, you should disable it using this command because the Task Monitor has a performance penalty.

Supported since or modified in @CHIP-RTOS version

SC12	SC13	SC11	SC1x3	SC2x
V1.00	V1.00	V1.00	V0.90	V1.00

ERRORS
Display list of all detected errors.

Displays a list of all detected errors.

Message                        Meaning

FATAL BIOS CHECKSUM ERROR      Corrupted RTOS code at flash memory detected
FLASH ERROR AT SECTOR          Flash write error has occurred
FATAL NETWORK ERROR,           Fatal error at the network controller detected
INVALID OPCODE ERROR AT TASK   CPU has generated an invalid opcode interrupt
REACHED TCP/IP MEMORY LIMIT    TCPIP memory pool is exhausted
TCP/IP MEMORY ALLOC ERROR      TCPIP memory allocation failed
TCP/IP INTERNAL FATAL ERROR    Fatal internal TCP/IP error
LOW MEMORY ERROR               An allocation from the CHIP-RTOS memory pool failed
CORRUPT MEMORY ERROR           The RTOS memory list is corrupted/invalid
BECK DRIVER ERROR              A Beck driver or library has asserted a fatal error
APPLICATION ERROR              A user application has asserted a fatal error

Related Topics

BIOS_Install_Error_Handler

BIOS_Set_Error

Supported since or modified in @CHIP-RTOS version

SC12	SC13	SC11	SC1x3	SC2x
V1.10	V1.00	V1.00	V0.90	V1.00

VER
@CHIP-RTOS Version.

Output the IPC@CHIP® serial number, @CHIP-RTOS version and build date.

Supported since or modified in @CHIP-RTOS version

SC12	SC13	SC11	SC1x3	SC2x
V1.00	V1.00	V1.00	V0.90	V1.00

BATCHMODE 0/1
Set batch file execution mode

Sets the batch file execution mode of DOS programs for either concurrent or sequential execution.
See BATCHMODE initialization documentation for details.

Example

BATCHMODE 1  ;  Selects sequential batch file processing mode

BATCHMODE 0  ;  Selects concurrent batch file processing mode

Related Topics

Initial BATCHMODE setting

BIOS_Set_Batch_Mode() - Run-time batch mode selection API

Supported since or modified in @CHIP-RTOS version

SC12	SC13	SC11	SC1x3	SC2x
V1.00	V1.00	V1.00	V0.90	V1.00

MEMOPT 0/1
Disable or enable memory optimize when loading exe file.

Use MEMOPT 1 to optimize memory usage when loading an exe file.

By default, the memory optimization is disabled.   An exe file will obtain almost all memory available at startup.   In the startup code, the program will then resize this memory.

When enabled, the program will obtain only the memory it defines as required in the header of the exe file.   This can leave more memory to other programs, but it can result in errors when allocating memory from the heap.

Users of Borland C/C++ will probably not need this command.   Only users of Borland Pascal might need it since programs written in Pascal usually do not resize their memory at startup.

Example

MEMOPT 0

SC12 Comments

With SC12 @CHIP-RTOS version 0.67, the default for MEMOPT is disabled.   Earlier versions had this feature enabled but this resulted in errors with malloc() .

Supported since or modified in @CHIP-RTOS version

SC12	SC13	SC11	SC1x3	SC2x
V1.00	V1.00	V1.00	V0.90	V1.00

CON device [device] ...
Direct console I/O.

Define what device is used as the console.   Possible devices are COM, EXT, TELNET, SSH (SC1x3/SC2x only) or USER.   Multiple devices are possible.

Comments

This setting is only valid until the next reboot.

Example

CON COM
CON EXT
CON USER
CON COM TELNET SSH

Related Topics

Default input device STDIN initial value

Default output device STDOUT initial value

Supported since or modified in @CHIP-RTOS version

SC12	SC13	SC11	SC1x3	SC2x
V1.00	V1.00	V1.00	V1.07	V1.00

WAIT secs
Suspends the command interpreter.

Suspends execution of the command interpreter for the specified interval.
The time interval is defined in seconds.

Example

wait 1

Supported since or modified in @CHIP-RTOS version

SC12	SC13	SC11	SC1x3	SC2x
V1.00	V1.00	V1.00	V0.90	V1.00

XTRANS port s/r filename
File transfer: Send/Receive file with Xmodem.

SC1x:

Send/Receive file with XMODEM/CRC protocol.   Possible devices are COM, EXT and USER.

SC1x3:

Send/Receive file with XMODEM/CRC protocol.   Possible devices are COM, EXT, SER2, SER3 and USER.

SC2x:

Send/Receive file with XMODEM/CRC protocol.   Possible devices are COM, SER2, SER3 and USER.

Example

XTRANS COM R chip.ini  ;Receive chip.ini file over COM
XTRANS EXT S test.txt  ;Send test.txt file over EXT

Supported since or modified in @CHIP-RTOS version

SC12	SC13	SC11	SC1x3	SC2x
V1.00	V1.00	V1.00	V0.90	V1.00

REBOOT
Restart the system

Restarts the system.
First, the file system is closed, then the watchdog is configured to issue a reset.
Please note that the tasks are not informed of this restart !

Example

reboot

Supported since or modified in @CHIP-RTOS version

SC12	SC13	SC11	SC1x3	SC2x
V1.00	V1.00	V1.00	V0.90	V1.00

HELP
Display list of all console commands.

Displays a list of all available console commands.

Supported since or modified in @CHIP-RTOS version

SC12	SC13	SC11	SC1x3	SC2x
V1.00	V1.00	V1.00	V0.90	V1.00

SERVPROG [exe_filename [password]]
Install Service Program.

SC1x3/SC2x:

This command installs a program into a hidden reserved area of system Flash memory outside the scope of the file system.   This program will then be automatically started at system start-up prior to AUTOEXEC.BAT file processing.

The maximum executable file size is 32742 bytes.   Compression with the UPX_Beck.exe tool (distributed with Beck Postmake and Debug@Chip) is recommended.

Note that this special Service Program interacts with the system in the same manner as any program launched from the AUTOEXEC.BAT.   When BATCH_MODE '1' is used, the system console thread will hang for the [BATCH] EXECTIMEOUT period unless the application Service Program calls the BIOS_Batch_Continue() API.

WARNING

Use of this feature is not generally advised by Beck!   To do so, you may reach a configuration under which the system cannot be started due to this program.   You then have no command prompt with which you can remove or change this program.   Note that the Ctrl-C use at system startup which can abort or bypass the AUTOEXEC.BAT does not prevent this Service Program from executing.   Only thoroughly tested DOS programs should be installed here!

Examples of this command follow.  The first command line parameter is the EXE file name.   An optional second parameter is the password.

To check if Service Program exists:

Enter command with no arguments to check if a Service Program is currently present in Flash memory.

SERVPROG

To load a Service Program:

Following command loads MyProg.EXE as the Service Program, provided that no password protection had been established.

SERVPROG MyProg.EXE

To load a Service Program with password:

Append a password to restrict further changes to the Service Program storage area.   Further use of the SERVPROG command will require this same password in order to perform modifications to this Service Program store.   This example will store MyProg.EXE as the Service Program provided that the current password is either non-existant or it matches the entered password.   Note: Passwords are handled in a case sensitive manner.

SERVPROG MyProg.EXE MySecretPassword

To remove Service Program:

Using **remove** as the file name is a special case.   When this string appears as the filename, any existing Service Program will be removed (provided that any required password protection is satisfied).   After program removal, any previously used password is no longer required on subsequent SERVPROG commands.   In this manner, by removing and installing the program again, the password can be changed.

This example assumes password protection has been established.   Otherwise no password would be required here.

SERVPROG **remove** MySecretPassword

Supported since or modified in @CHIP-RTOS version

SC12	SC13	SC11	SC1x3	SC2x
n/a	n/a	n/a	V1.11	V1.00

ZDISK [parameter [password/size]]
Create/manage read-only Z: drive

Create or manage the optional Z: drive.

Comments

The Z: drive is read-only disk which shares the system's flash memory with the A: drive.   When you first create this Z: drive, the A: drive will require reformatting.   Consequently the contents of the A: will be lost in the process.

A batch file Z:\AUTOEXEC.BAT can optionally be executed at startup.   This batch file, if present, will be executed prior to the A:\AUTOEXEC.BAT batch file.   Note that the default drive during execution of Z:\AUTOEXEC.BAT will be Z:.

The current Z: drive status will be reported when this shell command is entered with no arguments.   The optional parameters to this command are as follows.   Each of these first arguments is accepted in a case insensitive manner.   (Only the passwords here are handled in a case sensitive manner.)

• CREATE - This argument must be followed by a size parameter, specifying the minimum number of kilobytes disk space.   This size will be rounded up to the nearest legal size for the Z: drive.   The legal Z: drive sizes are in quantum steps of 64 kByte for systems with 2 MByte flash memory and 256 kByte steps for systems with 8 MByte flash memory.   If you specify a size larger than the maximum flash memory space that is available for a Z: drive, then this maximum value will be used.
  
  
  Example to create a 256 kByte Z: drive:
  
       ZDISK create 256
  
  
  The create action does nothing if a Z: drive is already present.   You must first remove an existing Z: drive prior to creating a new Z: drive, for example if you wanted to change the Z: drive's size.
  
  After a Z: drive has been created, both the new Z: drive and existing A: drive will be automatically formatted with default cluster sizes and default number of root directory entries.   All of the flash disk space is erased.   If you want a different cluster size or number of root directory entries than the FORMAT command's default values, you must follow up this ZDISK CREATE step with an explicit FORMAT for the respective drive.
  
  
• PASSWORD - This argument must be followed by the password that you want to set,
  
  Example to set the Z: drive password to "MySecret":
  
       ZDISK password MySecret
  
  
  The drive must be in the write enabled state in order for the new Z: drive password to be accepted.   Z: drive passwords are case sensitive.
  
  
• WRITE - This argument must be followed by the Z: drive password, if a password has been set on this drive.   By default the Z: drive powers up in read-only mode.   This WRITE enable action is required in order to modify the contents of the Z: drive in any way.
  Please note: The drive Z: does not use any flash translation layer to assure a wear leveling. Therefore writing to this drive should be the exceptional case.
  
  
  Example to enable write mode on drive Z:, which has a password "MySecret":
  
       ZDISK write MySecret
  
  
  The password in the above example is required only if the drive's password has been set.   Otherwise, just the write is sufficient.
  
  
  Example to enable write mode on drive without a password:
  
       ZDISK write
  
  
  
  
• PROTECT - The Z: drive will be switched back to read-only mode.
  
  
• REMOVE - This argument must be followed by the Z: drive password, if a password has been set on this drive.   This command will eliminate the Z: drive.   As a consequence, the A: flash drive will be reformatted, and all data on both drives will be lost!
  
  
  Example to remove Z: drive which has a password "MySecret":
  
       ZDISK remove MySecret
  
  
  The password in the above example is required only if the drive's password has been set.   Otherwise, just the remove is sufficient.
  
  When a Z: drive is removed, the A: drive will be automatically reformatted with default cluster size and number of root directory entries.   If you want a different cluster size or number of root directory entries on A: drive other than the FORMAT command's default values, you must follow up this ZDISK REMOVE step with an explicit A: drive FORMAT operation.
  

SC1x Comments

This command is not implemented on SC1x systems.

Supported since or modified in @CHIP-RTOS version

SC12	SC13	SC11	SC1x3	SC2x
n/a	n/a	n/a	V1.40	V1.40