CHIP.INI Documentation - SC12 @CHIP-RTOS V1.10
IPC@CHIP Documentation Index
Configuration News
CONFIG
The IPC@CHIP system configuration is controlled via the CHIP.INI file.
At startup, the system reads the file A:\chip.ini and uses the settings
found here to initialize the system.
CONFIG
News
STDIO
[STDIO] STDIN=Define standard input device
- Define your device for standard input.
Valid devices are COM, EXT and TELNET. You can define several devices simultaneously.
Comments
- The following example defines both COM and TELNET for stdin:
[STDIO]
STDIN=COM TELNET
By default, both COM and TELNET are used.
Top of list Index page
STDIO
[STDIO] STDOUT=Define standard output device
- Define your device for standard output.
Valid devices are COM, EXT and TELNET. You can define several devices simultaneously.
Comments
- The following example defines both COM and TELNET for stdout:
[STDIO]
STDOUT=COM TELNET
By default, both COM and TELNET are used.
Top of list Index page
STDIO
[STDIO] FOCUS=Command shell and/or user executables
- Set the stdio focus to the command shell and/or to the
user executables.
Valid entries are USER or SHELL .
If only USER is defined, stdio in the command shell is suppressed.
If only SHELL is defined, stdout and stdin in the user's DOS executables
are disabled.
Comments
- The following example enables stdio for both USER and SHELL:
[STDIO]
FOCUS=SHELL USER
By default, stdin and stdout for both SHELL and USER are enabled.
Important
: If stdio is enabled for both, there is a rivalry
between USER and SHELL.
At runtime, pressing of the focus key (default is Ctrl-F) toggles
between these three modes and shows the current mode.
Related Topics
-
- FOCUS KEY configuration
Top of list Index page
STDIO
[STDIO] FOCUSKEY=Key
- Defines the key that switches the stdio focus.
Comments
- The following example sets Ctrl-F (ASCII 6) as the current stdio focus key:
[STDIO]
FOCUSKEY=6
By default, the focus key is set to CTRL-F (ASCII 6)
At runtime pressing Ctrl-F keys on the console will then cycle the
stdio between the three modes:
Stdio: User
Stdio: Shell
Stdio: Both
The new mode is shown on the console.
Key Range: 0..254
If the key is set to zero, defines no focus key and the switching of stdio is disabled.
The focus key is not usable by the command shell or DOS executable.
Note:
The focus key code is filtered out by the system, and will not be visible to either
the command shell or a DOS executable.
Related Topics
-
- Initial FOCUS configuration
Top of list Index page
STDIO
[STDIO] CTRL_C=0/1
- Disable/enable termination of the autoexec.bat execution via ctrl-c key.
The following example disables the ctrl-c control.
[STDIO]
CTRL_C=0
By default, CTRL_C is enabled.
Top of list Index page
IP
[IP] ADDRESS=IP Address of the Ethernet interface
- Defines the IP address of the internal Ethernet interface, if no DHCP is used.
Comments
- Only numerical IP addresses are allowed here.
Example: ADDRESS=192.168.200.1
If no address entry was found, the IP address will be set to 1.1.1.1.
Related Topics
-
- IP command line
-
- Set IP Address API function
Top of list Index page
IP
[IP] NETMASK=IP Address mask of the Ethernet interface
- Defines the subnet mask of the internal Ethernet interface of IPC@CHIP, if no DHCP is used.
Comments
- Example: NETMASK=255.255.255.224
If no subnet mask entry was found, the subnet mask will be set to 255.255.255.0.
Related Topics
-
- NETMASK command line
-
- Set IP subnet mask API function
Top of list Index page
IP
[IP] GATEWAY=Gateway IP Address
- Setting the default gateway.
Comments
- Example: GATEWAY=195.243.140.65
The TCP/IP stack of the IPC@CHIP supports only one valid default gateway for all device interfaces:
Ethernet and PPP Interface.
So see also PPP Server GATEWAY if
you are using PPP.
We provide some additional API functions for modifying the default gateway:
Related Topics
-
- CHIP.INI entry PPPSERVER GATEWAY
-
- GATEWAY command line
-
- Set IP gateway API function
-
- ADD_DEFAULT_GATEWAY API function
Top of list Index page
IP
[IP] DHCP=0/1 Ethernet interface
- Set to 1 if DHCP client should be used to get the IP configuration for the internal Ethernet interface from a DHCP server.
If defined as 0, a static network configuration is used.
Comments
- Any settings for IP Address, subnet mask and gateway are ignored if DHCP is used.
Related Topics
-
- DHCP command line
Top of list Index page
IP
[IP] HOSTNAME_OPT=0/1 DHCP hostname option
- Set to 1 if DHCP client of the IPC@CHIP should append the device name
at the DHCP request option field with DHCP option number 0x0C.
If set to 0 (default), the device name will not be appended to the DHCP request.
Comments
- This name feature can be used for the configuration
of a DHCP server, e.g. to give a fixed IP to an IPC@CHIP which is configured with a device name.
Top of list Index page
IP
[IP] TCPIPMEM=Size
- Set the size of the TCP/IP memory block in kBytes. This block is allocated at the start
of the TCP/IP stack.
Valid Range: Between 30 kBytes and 160 kBytes (An out of range value for TCPIPMEM
will be set to closest of these limit values.)
Default value: 90 kBytes when @CHIP-RTOS configured without PPP capability (server or client)
98 kBytes when @CHIP-RTOS configured with PPP capability
Example: TCPIPMEM=60
Comments
- The TCP/IP API function 0x78, GET_MEMORY_INFO,
reports the current used memory of the TCP/IP stack
Since @CHIP-RTOS version 1.02B we allow configuring a maximum value of 160kBytes,
because some application programmers may require more then the old limit of 132 kByte.
Top of list Index page
UDPCFG
[UDPCFG] LEVEL=mask
- Defines the supported functions of the configuration server.
Set LEVEL as a bit mask to define the functions that the configuration server should listen to.
The bit assignments are as follows:
BIT0: Allow detection on the network.
BIT1: Allow change of IP configuration.
BIT4: Allow programming of flash.
If defined as 0, the configuration server task will not start.
Example: LEVEL=0x03
This would allow detection on the network and changing the IP configuration, but
no @CHIP-RTOS update.
Comments
- By default, all options are enabled (==0x13).
Related Topics
-
- Run-time adjustments to LEVEL
Top of list Index page
PPPCLIENT
[PPPCLIENT] ENABLE=0/1
- Disable/enable PPP client task
[PPPCLIENT]
ENABLE=1
By default, PPP client is enabled.
Top of list Index page
PPPSERVER
[PPPSERVER] ENABLE=0/1
- Disable/enable PPP server
[PPPSERVER]
ENABLE=1
By default, PPP server is enabled.
Related Topics
-
- PPP server configuration instructions
Top of list Index page
PPPSERVER
[PPPSERVER] MODEMTRACE=0/1
- Disable/enable the trace of the control communication between IPC@CHIP and a connected modem.
The modem strings (AT commands and answers) defined in chip.ini will be printed on STDOUT, if MODEM_TRACE=1.
This can be useful for testing the modem configuration and debugging the PPP dial procedures.
[PPPSERVER]
MODEMTRACE=1
By default, tracing is disabled.
Comments
- Received characters with an ASCII value smaller than 0x20 are printed as numbers.
Top of list Index page
PPPSERVER
[PPPSERVER] COMPORT=Define serial device for the PPP server
- Define your serial device for the PPP server.
Valid devices are COM or EXT.
Comments
- The following example defines EXT as device for the PPP server:
[PPPSERVER]
COMPORT=EXT
By default, no serial port is enabled.
Related Topics
-
- PPP server configuration instructions
Top of list Index page
PPPSERVER
[PPPSERVER] ADDRESS=IP Address of the PPP server interface
- Defines the IP address for the PPP server.
Comments
- Only numerical IP addresses are allowed here.
Example: ADDRESS=192.168.205.1
If no address entry was found, the address will be set to 1.1.2.1.
Related Topics
-
- PPP server configuration instructions
Top of list Index page
PPPSERVER
[PPPSERVER] REMOTEADDRESS=IP Address for the remote PPP client
- Defines the IP address for the remote PPP client.
Comments
- Only numerical IP addresses are allowed here.
Example: REMOTEADDRESS=192.168.205.2
If no address entry was found, the remote address will be set to 1.1.2.2.
Related Topics
-
- PPP server configuration instructions
Top of list Index page
PPPSERVER
[PPPSERVER] NETMASK=IP Address subnet mask of the PPP server
- Defines the IP address subnet mask of the PPP server.
Comments
- Example: NETMASK=255.255.255.0
If no subnet mask entry was found, the subnet mask will be set to 255.255.255.0.
Related Topics
-
- PPP server configuration instructions
Top of list Index page
PPPSERVER
[PPPSERVER] GATEWAY=IP Address of gateway
- Defines the IP address of the gateway if PPP Connection is established.
Comments
- Example: GATEWAY=195.243.140.65
If no gateway entry was found, the gateway will be untouched.
The TCP/IP stack of the IPC@CHIP supports only one valid default gateway for all device interfaces:
Ethernet, PPP Interface.
If you define a gateway in the PPPSERVER section of the chip.ini,
it becomes the default gateway for all interfaces when a PPP link to the server
is established. The default gateway must be the same IP Address as the remote peer.
It does not make sense to define a different IP, because the remote Peer is
the only peer, which is reachable. If a different IP than the remote IP is defined,
the remote IP will used for the gateway entry automatically.
During a PPP server connection the command ipcfg indicates this default gateway.
After the PPP session, the old gateway (if any was defined) will be restored.
Also we provide some functions for modifying the default gateway:
Related Topics
-
- CHIP.INI entry IP (Ethernet) GATEWAY
-
- PPP server configuration instructions
Top of list Index page
PPPSERVER
[PPPSERVER] AUTH=0/1/2
- Set PPP authentication mode for the remote PPP client
0: No authentication
1: PAP authentication
2: CHAP authentication
Comments
- The following example selects PAP authentication mode:
[PPPSERVER]
AUTH=1
By default, authentication is disabled.
If AUTH!=0 you must define two
user name /
password pairs used to
authenticate the PPP client. The client must use one of these pairs
to get connected to the IPC@CHIP PPP server.
Related Topics
-
- PPP server configuration instructions
Top of list Index page
PPPSERVER
[PPPSERVER] IDLETIME=Seconds
- Sets the idle time, after which the PPP server closes the connection.
[PPPSERVER]
IDLETIME=500
By default, PPP server idle time is 120 seconds. A value of 0 means no idle timeout.
Related Topics
-
- PPP server configuration instructions
Top of list Index page
PPPSERVER
[PPPSERVER] FLOWCTRL=0/1/2
- Set flow control mode of the PPP server's serial device:
0: none
1: XON/XOFF
(See caution below!)
2: RTS/CTS
Example: Here XON/XOFF flow control is enabled
[PPPSERVER]
FLOWCTRL=1
By default, FLOWCTRL=2
(RTS/CTS)
Comments
- Caution:
If you use the default DMA mode for the selected COM port, it is not recommended
to choose XON/XOFF flow control mode
(see Fossil API Xon/XOff usage (Chap.3)).
Related Topics
-
- PPP server configuration instructions
Top of list Index page
PPPSERVER
[PPPSERVER] MODEM=0/1
- Disable/enable usage of a modem
[PPPSERVER]
MODEM=1
By default, the usage of a modem is disabled.
Related Topics
-
- PPP server configuration instructions
Top of list Index page
PPPSERVER
[PPPSERVER] USERx=user
- Define the user name for PPP server, using PAP authentication
Comments
- You can define a USER0 and a USER1.
Default user is 'ppps' , password is 'ppps' for both USER0 and USER1.
You must specify both the user name and password.
Neither user name nor password are case sensitive.
The entries are only valid if AUTH=1 is specified.
Maximum name size: 49 characters
- Important notice: To avoid security leaks you must define both user names and passwords.
Related Topics
-
- PPP server configuration instructions
Top of list Index page
PPPSERVER
[PPPSERVER] PASSWORDx=password
- Define the password for a PPP server user, using PAP authentication.
Comments
- You can define a PASSWORD0 for USER0 and a PASSWORD1 for USER1
Default user is 'ppps' , password is 'ppps'.
Neither user name nor password are case sensitive.
The entries are only valid if AUTH=1 is specified.
Maximum password size: 49 characters
Related Topics
-
- PPP server configuration instructions
Top of list Index page
PPPSERVER
[PPPSERVER] BAUD=BAUD Rate
- Sets the BAUD rate of the PPP server serial port.
Comments
- The following example sets the PPP server serial port to 19,200 BAUD.
[PPPSERVER]
BAUD=19200
By default, PPP server BAUD rate is 38400 (with 8 data bits,
no parity, 1 stop bit).
Related Topics
-
- PPP server configuration instructions
Top of list Index page
PPPSERVER
[PPPSERVER] INITCMDx=modem command
- Defines modem commands to initialize your modem connected to the IPC@CHIP
at the start of the IPC@CHIP PPP server and after a modem hang-up following a PPP session.
Comments
- You can define a maximum of 3 modem commands e.g. INITCMD0=ATZ
.
The entries are only valid if
MODEM=1 is specified.
The maximum length for each command string is 25 characters.
Related Topics
-
- PPP server configuration instructions
Top of list Index page
PPPSERVER
[PPPSERVER] INITANSWERx=modems answer of init command x
- Defines the expected modem answer x for the initialize command x.
Comments
- You can define a maximum of 3 modem answers e.g. INITANSWER0=OK
.
The entries are only valid, if MODEM=1 is specified.
The maximum length for each answer string is 80 characters.
Default for all answer strings: OK
Related Topics
-
- PPP server configuration instructions
Top of list Index page
PPPSERVER
[PPPSERVER] INITTIMEOUTx=timeout in seconds for wait an the modem's answer
- Define the timeout value in seconds for waiting on an answer from the modem.
A value of 0 means wait forever for the modem answer.
Comments
- Example: INITTIMEOUT0=2
The entries are only valid if MODEM=1 is specified.
Default value: 3 seconds
Related Topics
-
- PPP server configuration instructions
Top of list Index page
PPPSERVER
[PPPSERVER] INITRETRIESx=Retries, if the modem init answer failed
- Define the number of retries used when the modem initial answer fails.
Comments
- Example: INITRETRIES0=2
This entry is only valid if MODEM=1 is specified.
Default value: 1
Related Topics
-
- PPP server configuration instructions
Top of list Index page
PPPSERVER
[PPPSERVER] MODEMCTRL=0/1
- Allow modem online control by PPP server.
[PPPSERVER]
MODEMCTRL=1
By default, the usage of a modem online control is disabled.
Related Topics
-
- PPP server configuration instructions
Top of list Index page
PPPSERVER
[PPPSERVER] CTRLTIME=Seconds
- Sets the idle interval time, at which the PPP server executes the
configured control commands (see
CTRLCMDx).
[PPPSERVER]
CTRLTIME=120
By default, PPP server idle control time is 60 seconds.
If the PPP server doesn't receive regular PPP data during this interval,
it executes the control commands . If execution of one
of the control commands fails, the PPP server then closes the connection.
The CTRLTIME must be a smaller value than the
IDLETIME of the PPP server.
Related Topics
-
- PPP server configuration instructions
Top of list Index page
PPPSERVER
[PPPSERVER] CTRLCMDx=modem online control command
- Defines modem command to control if modem is online or not at the start
of the IPC@CHIP PPP server and after a modem hang-up following a PPP session.
Comments
- You can define a maximum of 3 modem commands e.g. CTRLCMD0=+++
.
The maximum length for each control command string is 25 characters.
The entries are only valid, if MODEMCTRL=1 is specified.
Related Topics
-
- PPP server configuration instructions
Top of list Index page
PPPSERVER
[PPPSERVER] CTRLANSWERx=modems answer of ctrl command x
- Defines the expected modem answer x for the online control command x.
Comments
- You can define a maximum of 3 modem answers e.g. INITANSWER0=OK
.
The entries are only valid, if MODEMCTRL=1 is specified.
The maximum length for each answer string is 80 characters.
Related Topics
-
- PPP server configuration instructions
Top of list Index page
PPPSERVER
[PPPSERVER] CTRLTIMEOUTx=timeout in seconds for wait on the modem's answer
- Defines the timeout value in seconds for waiting on an answer from the modem.
A value of 0 means wait forever for the modem answer.
Comments
- Example: CTRLTIMEOUT0=2
The entries are only valid if MODEMCTRL=1 is specified.
Default value: 3 seconds
Related Topics
-
- PPP server configuration instructions
Top of list Index page
PPPSERVER
[PPPSERVER] CTRLRETRIESx=Retries, if the modem online control answer failed
- Defines the number of retries used when the modem control answer fails.
Comments
- Example: CTRLRETRIES0=2
This entry is only valid if MODEMCTRL=1 is specified.
Default value: 1
Related Topics
-
- PPP server configuration instructions
Top of list Index page
PPPSERVER
[PPPSERVER] CMDMODE=switch to modem command mode
- Defines the string which switches the modem into the command mode.
Comments
- The entries are only valid if MODEM=1 is specified.
Default string for CMDMODE:+++
Related Topics
-
- PPP server configuration instructions
Top of list Index page
PPPSERVER
[PPPSERVER] HANGUPDELAY=Time in seconds for switching modem into command mode
- Defines the time in seconds for switching modem into command mode for hang-up commands.
Comments
- The entries are only valid if MODEM=1 is specified.
Default time: 2 seconds
Related Topics
-
- PPP server configuration instructions
Top of list Index page
PPPSERVER
[PPPSERVER] HANGUPCMDx=modem command
- Defines modem commands to hang-up the modem connected to the IPC@CHIP.
Comments
- You can define a maximum of 3 modem hang-up commands e.g. HANGUPCMD0=ATH
,
which will be executed if the PPP connection is closed.
The maximum length for each command string is 25 characters.
Related Topics
-
- PPP server configuration instructions
Top of list Index page
PPPSERVER
[PPPSERVER] HANGUPANSWERx=modems answer for hang-up command x
- Defines the expected modem answer x for the hang-up command x
Comments
- You can define a maximum of 3 modem answers e.g. HANGUPANSWER0=OK
.
The maximum length for each answer message is 80 characters.
Default for all answer strings: OK
Related Topics
-
- PPP server configuration instructions
Top of list Index page
PPPSERVER
[PPPSERVER] HANGUPTIMEOUTx=timeout in seconds for wait on answer from modem
- Defines the timeout value in seconds used when waiting on the modem's answer.
A value of 0 means wait forever.
Comments
- Example: HANGUPTIMEOUT0=2
Default value: 3 seconds
Related Topics
-
- PPP server configuration instructions
Top of list Index page
PPPSERVER
[PPPSERVER] HANGUPRETRIESx=Retries, if the modem hang-up answer failed
- Defines the number of retries used if the modem hang-up answer fails.
Comments
- Example: HANGUPRETRIES0=2
Default value: 1 try
Related Topics
-
- PPP server configuration instructions
Top of list Index page
PPPSERVER
[PPPSERVER] CONNECTMSGx=modem message
- Defines the expected modem message to get connected to a peer modem
Comments
- You can define a maximum of three modem messages e.g. CONNECTMSG0=RING
.
The maximum length for each connect message is 25 characters.
Defaults:
CONNECTMSG0=RING
CONNECTMSG1=CONNECT
Related Topics
-
- PPP server configuration instructions
Top of list Index page
PPPSERVER
[PPPSERVER] CONNECTANSWERx=modem command for incoming connect message x
- Defines the expected modem answer x for the incoming connect message x
Comments
- You can define a maximum of three modem answers e.g. CONNECTANSWER0=ATA
.
The maximum length for each answer string is 80 characters.
Defaults: CONNECTANSWER0=ATA
Related Topics
-
- PPP server configuration instructions
Top of list Index page
PPPSERVER
[PPPSERVER] CONNECTTIMEOUTx=timeout seconds for wait on the modem's connect message x
- Defines the timeout value in seconds used when waiting on the modem connect message.
A value of 0 means wait forever.
Comments
- Example: CONNECTTIMEOUT0=0
Default values:
CONNECTTIMEOUT0=0
CONNECTTIMEOUT1=60
Related Topics
-
- PPP server configuration instructions
Top of list Index page
RAMDRIVE
[RAMDRIVE] SIZE=size
- Set the size in KByte of the RAM drive C:.
If defined as 0, no RAM drive is configured.
Maximum size is 256 Kbyte
Comments
- Default size: 0 (no RAM drive C:)
Top of list Index page
TIMER
[TIMER] 1C=ms
- Sets the interval in milliseconds for timer interrupt 0x1C.
Range: 1 to 32767, Default value=55 ms.
Related Topics
-
- BIOS Ints API Set timer interrupt 0x1C's interval
Top of list Index page
TIMER
[TIMER] AF=ms
- Sets the interval in milliseconds for timer interrupt 0xAF.
Range: 1 to 32767, Default value=4 ms.
Related Topics
-
- BIOS Ints API Set timer interrupt 0xAF's interval
Top of list Index page
FTP
[FTP] ENABLE=0/1
- Define if the FTP server should be activated.
Comments
- Use 0 to disable, 1 to enable.
By default, the FTP server is enabled.
Related Topics
-
- FTP enable/disable command
-
- BIOS Ints API Call Suspend/Resume system servers
Top of list Index page
FTP
[FTP] CMDPORT=port
- Set the command port number of the FTP server.
Default FTP command port: 21
Example:
[FTP]
CMDPORT=5000
Top of list Index page
FTP
[FTP] LOGINDELAY=0/1
- Define if the delayed login of the FTP server should be (de)activated.
Comments
- Use 0 to deactivate, 1 to activate.
By default, the delayed login is enabled. The delay time starts with 400 milliseconds.
After each following failed login, the delay time will be doubled until it reaches 20 seconds.
After a successful login the delay time will be set back to 400 milliseconds.
Top of list Index page
FTP
[FTP] TIMEOUT=sec
- Defines the inactivity timeout for the FTP server in seconds.
The minimum value for the timeout is 20 seconds and maximum is 65535 seconds.
Comments
- Default FTP timeout is 300 seconds.
RFC 1123 states that the minimum idle timeout should be 5 minutes.
Top of list Index page
FTP
[FTP] USERx=user
- Defines the user name for FTP.
Comments
- You can define a USER0 and a USER1.
Default users are: 'anonymous' (no password) and 'ftp' (password is 'ftp').
You must specify both the user name and their password.
Neither user name nor password are case sensitive.
Maximum name size: 19 characters
- Important notice: To avoid security leaks you must define both user names and passwords.
Related Topics
-
- FTP user write protection
Top of list Index page
FTP
[FTP] PASSWORDx=password
- Define the password for a FTP user
Comments
- You can define a PASSWORD0 for USER0 and a PASSWORD1 for USER1
Default users are anonymous (no password) and ftp (password is 'ftp').
Neither user name nor password are case sensitive.
Maximum password size: 19 characters
Top of list Index page
FTP
[FTP] ACCESSRIGHTx=Access rights for defined Users
- This CHIP.INI entry allows you to deny write access to FTP USER0
or USER1.
0 - write and read access enabled
1 - write access denied, read access enabled
Example which disables FTP write access for USER0:
[FTP]
USER0=otto
PASSWORD0=otto53pass
ACCESSRIGHT0=1
Comments
- You can only forbid write access if you have defined the
respective user with the FTP USERx
and PASSWORDx entries.
By default write access is enabled for both FTP users.
Top of list Index page
FTP
[FTP] DRIVEx=Set user's FTP drive
- Set user's FTP drive.
Comments
- Entries DRIVE0 or DRIVE1 can be made to specify a
particular drive for use by FTP USER0 and USER1
respectively. The drive numbers are coded as follows:
0: Drive A (Default)
1: Drive B
2: Drive C
If the drive does not exist, the default drive A will be set.
The following example defines the root drive for USER0
to be on B: drive.
[FTP]
DRIVE0=1
Related Topics
-
- FTP user's root directory
Top of list Index page
FTP
[FTP] ROOTDIRx=Name of the user's FTP server root directory
- Defines the name of user's FTP server root directory.
Comments
- The following example defines both root directory for USER1
[FTP]
ROOTDIR1=USERDIR
The default FTP root directory is the drive root directory, "\".
If the specified FTP directory doesn't exist, the FTP server
closes the connection.
If ROOTDIRx is set you must also specify the FTP
DRIVEx entry.
Maximum ROOTDIRx path string length: 64 characters
Important notice:
To avoid security leaks you should define one "normal" user
with a directory below the "\" root directory.
The other user ROOTDIR should not be defined, allowing that "superuser"
or "admin" to access all files on the drive.
Related Topics
-
- FTP user's DRIVE
Top of list Index page
WEB
[WEB] ENABLE=0/1
- Define if the Web server should be activated.
Comments
- Use 0 to disable, 1 to enable.
By default, the Web server is enabled.
Related Topics
-
- BIOS Ints API Call Suspend/Resume system servers
Top of list Index page
WEB
[WEB] MAINPAGE=Name of the main page
- Defines the name of Web server's main page. The Web server
opens this page if a browser request like
http://192.168.200.4/
is received.
Typical names are "main.htm" (default) or "index.htm".
The console command
webstat
shows the current main page.
Related Topics
-
- Set Web Server Main Page API Function
Top of list Index page
WEB
[WEB] TEMPPATH=Name of a temporary Web server path
- Defines a temporary path for finding files.
If the Web server cannot find the file in its default directory, it will try to find it in
this temporary path. Pathname should include the drive specification.
Comments
- This function allows the Web server to locate HTML files produced on
the IPC@CHIP RAMDISK by application programs.
The maximum string length is 32.
Example:
[WEB]
TEMPPATH=C:\web
The webstat
command shows the current temporary path.
Top of list Index page
WEB
[WEB] DRIVE=Set Web server's disk drive
- Set Web server's disk drive.
0: Drive A
1: Drive B
2: Drive C
If the drive does not exist, the default drive A will be set.
The console command
webstat
shows the current Web server drive.
Top of list Index page
WEB
[WEB] ROOTDIR=Name of the root directory
- Defines the name of Web server's root directory.
If the directory does not exist, the Web server
sets "\" as the default root directory.
The console command
webstat
shows the current root directory.
Comments
- Important notice: To avoid security leaks you should define a directory below the
"\" directory. If you use "\" as web root directory, everybody can read all your files.
Related Topics
-
- Set Web Server Root Directory API Function
Top of list Index page
WEB
[WEB] MAXCGIENTRIES=Maximum number of available CGI entries
- Set the maximum number of entries for the Web server (Default: 10)
Range: 2 to 128
The console command
cgistat
shows the current number.
Top of list Index page
WEB
[WEB] WEBSERVERSTACK=Stack size
- Sets the stack size (bytes) for the Web server task.
The default and minimal stack size is 2048 Bytes.
Programmers of CGI functions who are using Microsoft C-Compilers with C-Library
functions such as sprintf, which require a lot of stack space,
should increase the stack size to 6144 (6 KBytes).
The maximum value is 10240 bytes.
Top of list Index page
WEB
[WEB] HTTPPORT=port
- Sets the port number of the web server.
Default HTTP port: 80
Example:
[WEB]
HTTPPORT=81
The console command
webstat
shows the current HTTP port number.
Top of list Index page
WEB
[WEB] USER0=User name for Web Server PUT method
- Defines a user name for transferring files to the Web server's root
directory using the HTTP Put method.
The standard user name is 'WEB'.
The console command
webstat
shows the user name and password.
Comments
- Important notice: To avoid security leaks you should define
a user name and password.
Top of list Index page
WEB
[WEB] PASSWORD0=Password for Web Server PUT method
- Defines the password used to transfer files to the Web server's root
directory using the HTTP Put method.
The standard password is 'WEB'.
The console command
webstat
shows the Password and Username.
Comments
- Important notice: To avoid security leaks you should define
a user name and password.
Top of list Index page
WEB
[WEB] SECURE=Activated the Web security feature for the Web Server
- Defines whether the security feature for the Web Server is active
or not.
0 = security feature deactivated (default)
1 = security feature activated
Comments
- The Web Server security feature allows up to two
paths to be protected
with user name
and password.
When this security feature is activated, users must then
authenticate themselves to get Web access to these paths.
Top of list Index page
WEB
[WEB] SEC_URLx=Define a path for the security feature
- Defines a specified URL for the Web security feature. The user can
define SEC_URL0 and SEC_URL1.
All sub URLs of SEC_URLx are then protected by user name and password.
The SEC_URL0 path is protected by
SEC_USER0 user name and
SEC_PASSWORD0 password,
and SEC_URL1 by
SEC_USER1 user name and
SEC_PASSWORD1 password.
The maximum length for the paths is 63 characters.
Comments
- If the security feature
is activated, the user should define a path,
user name and
password.
In the example below all sub URLs of "[IP]/sec" are protected (e.g. "192.168.200.4/sec/page.htm").
Example:
[WEB]
SEC_USER0=otto
SEC_PASSWORD0=web
SEC_URL0=/sec
Top of list Index page
WEB
[WEB] SEC_USERx=Define a user name for the security feature
- Defines a user name for the Web security feature.
The user can
define SEC_USER0 and SEC_USER1.
The max length of the user name is 19 characters.
Comments
- If the security
feature is activated, the user should define a
path, user name and
password.
Top of list Index page
WEB
[WEB] SEC_PASSWORDx=Define a password for the security feature
- Defines a password for the Web security feature.
The user can
define SEC_PASSWORD0 and SEC_PASSWORD1.
The max length of the password is 19 characters.
Comments
- If the security
feature is activated, the user should define a
path,
user name and password.
Top of list Index page
TFTP
[TFTP] TFTPPORT=port
- Sets the port number of the TFTP server.
Default TFTP port: 69
Example:
[TFTP]
TFTPPORT=4000
Top of list Index page
TELNET
[TELNET] TELNETPORT=port
- Sets the port number of the Telnet server.
Default Telnet port: 23
Example:
[TELNET]
TELNETPORT=5000
Top of list Index page
TELNET
[TELNET] TIMEOUT=Telnet timeout minutes
- Telnet session will automatically close after TIMEOUT minutes without any
characters received from the client. A TIMEOUT setting of zero means no timeout.
Default Value: TIMEOUT=0
(no timeout)
Top of list Index page
TELNET
[TELNET] LOGINDELAY=0/1
- Define if the delayed login of the Telnet server should be activated.
Comments
- Use 0 to deactivate, 1 to activate.
By default, the delayed login is enabled. The delay time starts with 400 milliseconds.
After each following failed login the delay time will be doubled until it reached 20 seconds.
After successful login the delay time will be set back to 400 milliseconds.
Top of list Index page
TELNET
[TELNET] LOGINRETRIES=number of login retries
- Defines the number of login retries until Telnet session will be closed.
Example:
[TELNET]
LOGINRETRIES=3
Comments
- The default value is 5.
Top of list Index page
TELNET
[TELNET] USERx=user
- Defines a user name for Telnet.
Comments
- You can define a USER0 and a USER1.
Default user is 'tel', password is 'tel'.
You must specify both the user name and their password.
Neither user name nor password are case sensitive.
Maximum user name size: 19 characters
- Important notice: To avoid security leaks you must define both user names and passwords.
Top of list Index page
TELNET
[TELNET] PASSWORDx=password
- Define the password for a Telnet user
Comments
- You can define a PASSWORD0 for USER0 and a PASSWORD1 for USER1.
Default user is 'tel', password is 'tel'.
Neither user name nor password are case sensitive.
Maximum password size: 19 characters
Top of list Index page
TELNET
[TELNET] ENABLE=0/1
- Define if the Telnet server should be activated.
Comments
- Use 0 to disable, 1 to enable.
By default, the Telnet server is enabled.
Related Topics
-
- BIOS Ints API Call Suspend/Resume system servers
Top of list Index page
DEVICE
[DEVICE] FILESHARING=0/1
- Disable/Enable the file sharing. See also BIOS Interrupt service
0x37.
Comments
- 0=disable (default), 1=enable
Top of list Index page
DEVICE
[DEVICE] NAME=name
- Define the name of this device.
Comments
- This name will show up with the 'Chiptool' software when the network is scanned.
Maximum name size: 20 characters
Top of list Index page
TRACE
[TRACE] FLASHWRITE=0/1
- Trace the activity of flash writes for debug purposes.
Comments
- Set to 1 to enable the debug output.
On STDOUT a message is printed at every call to the low-level physical flash write routine.
By default the debug output is disabled.
Top of list Index page
TRACE
[TRACE] INTNOTSUPP=0/1
- Trace the activity of calls to not supported interrupts or functions.
Comments
- Set to 0 to disable the debug output.
On STDOUT a message is printed at every call to a not supported interrupt vector or not supported function.
By default the debug output is enabled.
Top of list Index page
SERIAL
[SERIAL] EXT_DMA=0/1
- Disable/enable DMA receive mode (DMA0 / INT5) on the EXT port. If DMA
receive mode is disabled, the EXT port works with the standard serial interrupt.
The recommended mode is the DMA receive mode. It is only necessary to disable the
DMA receive mode for the EXT port if DMA0 is needed by an external device
(in the future). In the IRQ receive mode, you may loose characters if the system
gets lots of interrupts (e.g. network) or if you are writing to the flash disk (file system calls).
See documentation of the
Hardware API.
Example which disables DMA receive mode on the EXT port.
[SERIAL]
EXT_DMA=0
By default, DMA receive mode is enabled.
Top of list Index page
SERIAL
[SERIAL] COM_DMA=0/1
- Disable/enable DMA receive mode (DMA1 / INT6) on the COM port. If DMA
transfer is disabled, the COM port works with the standard serial interrupt.
The recommended mode is the DMA receive mode. It is only necessary to disable the
DMA receive mode for the COM port if DMA1 will be needed by an external device
(in the future). In the IRQ receive mode, you may loose characters if the system
gets lots of interrupts (e.g. network) or if you are writing to the flash disk (file system calls).
See documentation of the
Hardware API.
Example which disables DMA receive mode on the COM port.
[SERIAL]
COM_DMA=0
By default, DMA receive mode is enabled.
Top of list Index page
SERIAL
[SERIAL] SEND_DMA=0/1
- Selects the DMA send mode for a serial port.
Comments
- Use 0 to enable the DMA send mode for the EXT port.
Use 1 to enable the DMA send mode for the COM port.
Example which enables the DMA send mode on the COM port.
[SERIAL]
SEND_DMA=1
By default, DMA send is disabled.
Important:
The IPC@CHIP has only two DMA channels. By default both are used for receiving characters
from the COM and EXT ports. If you want to use the DMA send mode for one serial port (e.g. the EXT port),
the second port (e.g. the COM port) automatically switches over to using
the serial port's receiver interrupt.
Note that RS485 is not available with serial send DMA.
Top of list Index page
SERIAL
[SERIAL] EXT_RECVQUEUE=size
- Sets the receive queue size of the EXT port. Minimum size is 1024.
Maximum size is 10240 byte.
Comments
- Example:
[SERIAL]
EXT_RECVQUEUE=2048
By default, the receive queue size is 1024 byte.
If it is planned to use PPP server or PPP client the size should set to 4096.
Top of list Index page
SERIAL
[SERIAL] EXT_SENDQUEUE=size
- Sets the send queue size of the EXT port. Minimum size is 1024.
Maximum size is 10240 byte.
Comments
- Example:
[SERIAL]
EXT_SENDQUEUE=2048
By default, the send queue size is 1024 byte.
If it is planned to use PPP server or PPP client the size should set to 4096.
Top of list Index page
SERIAL
[SERIAL] COM_RECVQUEUE=size
- Sets the receive queue size of the COM port. Minimum size is 1024.
Maximum size is 10240 byte.
Comments
- Example:
[SERIAL]
COM_RECVQUEUE=2048
By default, the receive queue size is 1024 byte.
If it is planned to use PPP server or PPP client the size should be set to 4096.
Top of list Index page
SERIAL
[SERIAL] COM_SENDQUEUE=size
- Sets the send queue size of the COM port. Minimum size is 1024.
Maximum size is 10240 byte.
Comments
- Example:
[SERIAL]
COM_SENDQUEUE=2048
By default, the send queue size is 1024 byte.
If it is planned to use PPP server or PPP client the size should be set to 4096.
Top of list Index page
SERIAL
[SERIAL] COM_BAUD=BAUD Rate
- Sets the BAUD rate of the COM port.
Comments
- Example:
[SERIAL]
COM_BAUD=9600
By default, the BAUD rate of the COM port is 19200 (with 8 data bits,
no parity, 1 stop bit).
Top of list Index page
SERIAL
[SERIAL] EXT_BAUD=BAUD Rate
- Sets the BAUD rate of the EXT port.
Comments
- Example:
[SERIAL]
EXT_BAUD=9600
By default, the BAUD rate of the EXT port is 19200 (with 8 data bits,
no parity, 1 stop bit).
Top of list Index page
DOSLOADER
[DOSLOADER] MEMGAP=Paragraphs
- Sets a memory gap between the loaded DOS programs as a memory reserve.
Comments
- Some programs compiled with Borland C 5.02 (other compilers??) try to increase
their program memory block at runtime. This can occur, for example, when
opening a file with Borland C-library function fopen, where
some additional memory is required.
The Borland C-library fopen function calls int 21h
0x4A, which is not
directly visible to the application programmer.
This memory resize call fails if another program is loaded after the previous
one, because now there is no memory space left for increasing the memory size
of the previously executed program. The program then returns from
fopen with an error.
In this case, the global program variable errno is set to value 8
(not enough memory).
To prevent this error, the @CHIP-RTOS allows a memory gap of a defined size
between loaded programs. This memory gap size is specified as a
number of paragraphs (where 1 paragraph == 16 Bytes).
This strategy can fail when programs are terminated and restart again.
Example:
[DOSLOADER]
MEMGAP=128
By default, MEMGAP is set to 0. The maximum value is 2048 paragraphs,
where any value larger than this is truncated to 2048
Related Topics
-
- Set memory gap API function
Developer Notes It is not necessary to set this entry if the application
doesn't show the described error.
Only if a C-library function call sets errno to 8, should this
value be defined. We recommend in that
case a value of 128 paragraphs (2048 Bytes). The described
problem was noticed when the Borland C-library function
fopen was used. The same can happen with usage of
C-library function malloc using memory model Large.
The malloc returns a NULL pointer in this case.
Top of list Index page
BATCH
[BATCH] BATCHMODE=0/1
- Sets the batch file execution mode of DOS programs.
BATCHMODE=0
: (Default mode)
The programs listed in the batch file will be executed concurrently
, starting one after
another, without waiting for completion (or going resident) of the predecessor program.
The only exceptions are the WAIT and
REBOOT commands.
BATCHMODE=1
:
The listed programs will be executed sequentially
, one at time (similar to DOS).
The execution of the successor program will be delayed until the current program either
finishes, terminates resident by calling DOS Interrupt
21h Service 0x31
or makes
the @CHIP-RTOS Interrupt 0xA0 Service 0x15
batch file wakeup call.
The maximum delay time for execution of the next listed program in the batch file is 15 seconds,
unless this limit has been deactivated with the
EXECTIMEOUT=0
configuration control.
Important:
If BATCHMODE=1
take care that every program in your batch file which has a successor
program either exits
(int21h 0x4C)
or terminates resident with int21h 0x31.
A program which runs forever should call from the main function @CHIP-RTOS Interrupt
0xA0 Service 0x15, which
immediately enables the further batch file sequencing.
Related Topics
-
- BATCHMODE command
-
- Run-time batch mode selection API
Top of list Index page
BATCH
[BATCH] EXECTIMEOUT=0/1
- Disable (=0) / enable (=1) the batch file DOS program execution delay
time limit for BATCHMODE=1.
EXECTIMEOUT=0
:
The successor program in a batch file waits forever if the
predecessor program neither finishes nor calls
0xA0 Service 0x15.
EXECTIMEOUT=1
: (Default mode)
The maximum delay time for execution of the
next listed program in a batch file is 15 seconds.
Comments
- This Boolean control applies only to BATCHMODE=1.
Example:
[BATCH]
EXECTIMEOUT=0
Related Topics
-
- BATCHMODE Configuration
Top of list Index page
End of document
|