IPC@CHIP® RTOS-PPC – API Documentation

Header image

Main page


CHIP.INI [IP]


[IP]
ADDRESSx=IP address of the Ethernet interface

Defines the IPv4 addresses of the internal Ethernet interface, of the IPC@CHIP®. A maximum of five IP addresses may be listed with tags ADDRESS and ADDRESS1 up to ADDRESS4. The entry tag search is terminated at the first non-existant tag in this sequence.

Note: The tag ADDRESS0 is not recognized, instead the tag ADDRESS must be used.

Only numerical IP addresses are allowed here.
Default:
No default.
Example:
 [IP]
 ADDRESS=192.168.200.1
 ADDRESS1=172.30.10.12
Since:
SC2x3 V1.00
Changes:
SC2x3 V1.07 - ADDRESS1 to ADDRESS4 can be used to specify additional fixes IP addresses.


[IP]
NETMASKx=IP address mask of the Ethernet interface

Defines the IPv4 subnet mask of the internal Ethernet interface of IPC@CHIP®. A maximum of five IP address masks may be listed with tags NETMASK and NETMASK1 up to NETMASK4. The entry tag search is terminated at the first non-existant tag in this sequence.

Note: The entry NETMASK0 is not recognized, instead the tag NETMASK must be used.

Default:
If no subnet mask entry was found, the subnet mask will be set to 255.255.255.0.
Example:
 [IP]
 NETMASK=255.255.255.224
 NETMASK1=255.255.240.0
Since:
SC2x3 V1.00
Changes:
SC2x3 V1.07 - NETMASK1 to NETMASK4 can be used to specify additional IP net masks.


[IP]
GATEWAY=Gateway IP address

Defines the default IPv4 gateway.

The TCP/IP stack of the IPC@CHIP® supports only one valid default gateway for all device interfaces (Ethernet, PPP etc).
Default:
No default.
Example:
 [IP]
 GATEWAY=192.168.0.1
Note:
As a valid chip.ini gateway entry at this section [IP], the TCP/IP stack accepts only a gateway IP address, which matches to the net address of the internal Ethernet device IP configuration. If the user adds an own device driver interface with a new gateway setting, he has to set this gateway inside of his application by calling AddDefaultGatewayEx.
Since:
SC2x3 V1.00


[IP]
DHCP=0/1

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.

Any settings for IP address, subnet mask and gateway are ignored if DHCP is used.
Default:
Use DHCP.
Example:
 [IP]
 DHCP=1
Since:
SC2x3 V1.00


[IP]
DHCP_TRIALS=Number of DHCP configuration trials

Specify the number of DHCP configuration trials.

The IPC@CHIP® will try to obtain an IP configuration via DHCP several times. The number of trials can be configured with this option. Valid values are between 3 and 128. If you specify a value of 0, the configuration via DHCP will be retried endlessly. Note that the configuration via AUTOIP will be implicitely disabled in this case.

There are time intervals between each DHCP configuration attempt. At the first three DHCP trials, the DHCP client works with fixed time intervals. The first three time intervals are 3, 3 and 3 seconds. After 3 DHCP configuration trials, the time interval is calculated by the term
1 << (trialNumber - 1)
E.g. Trial number 4 has a time interval of 8 seconds. Time intervals are generally limited to 32 seconds.
Default:
Default are 3 trails.
Example:
 [IP]
 DHCP_TRIALS=0
Since:
SC2x3 V1.00


[IP]
HOSTNAME_OPT=0/1

Insert device name at DHCP requests as option 12. If set to 1, the IPC@CHIP® insert at its DHCP request its hostname as option 12. This is the name defined at Device name. If the additional entry CLIENT_ID is not defined, the device name string is also inserted at the DHCP request as client identifier option 61.
Default:
By default this feature is disabled.
Example:
 [IP]
 HOSTNAME_OPT=1
Since:
SC2x3 V1.00


[IP]
AUTOIP=0/1

If AUTOIP is set to 1 and DHCP= 1, the Ethernet interface will be configured by the AutoIP algorithm in case that the IP configuration by DHCP fails.
The AutoIP procedure configures the Ethernet interface with a random IP address between 169.254.1.0 and 169.254.254.255. After selecting a random IP, it executes an address collision detection by sending ARP probes. The procedure repeats with new random IP addresses, until no collision can be detected. It is also possible to call the AutoIP procedure "by Hand" with the command IPETH with parameter "A".

Note that if the DHCP_TRIALS parameter is set to 0, DHCP configuration will never reach the failed state and thus the configuration via AutoIP will not be started.
Default:
AutoIP is enabled by default.
Example:
 [IP]
 AUTOIP=0
Since:
SC2x3 V1.00


[IP]
CLIENT_ID=string

Insert client identifier string at DHCP requests as option 61. Maximum name size: 20 characters.

If this entry is specified, the IPC@CHIP® insert at its DHCP request the specified string as DHCP option 61. If this entry is not specified but the entry HOSTNAME_OPT is yet defined, the IPC@CHIP® inserts here its Device name.

If CLIENT_ID is set to the reserved word "MAC_ADDR", the IPC@CHIP® builds a 7 Byte long client identifier option consisting of:
1 Byte Hardware type, with value 1 for Ethernet
6 Bytes physical Ethernet address.
Default:
By default this feature is disabled.
Example:
 [IP]
 CLIENT_ID=MAC_ADDR
Since:
SC2x3 V1.00


[IP]
FORWARDING=0/1

Enables/disables IP-forwarding.

If set to 1, the TCP/IP stack of the IPC@CHIP® forwards IP packets between all network interfaces. Using forwarding the IPC@CHIP® acts as router between two networks. By example if an IP packet arrives on eth0 and the destination network address is equal to that one of eth1 the packet will be forwarded to eth1. If defined as 0, IP forwarding is disabled for all interfaces.
This option is also settable by API function TCPIP_SetOption()
Default:
If safe mode is off, this option is enabled by default. If safe mode is on, this option is disabled by default.
Example:
 [IP]
 FORWARDING=0
Since:
SC2x3 V1.00


[IP]
TCP_PRIO=prio

Defines the task priority of the TCP timer task (TCPT). Allowed value are 2-127.
Default:
Default is 10.
Example:
 [IP]
 TCP_PRIO=10
Since:
SC2x3 V1.00


[IP]
TCPIPMEM=size in KB

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 is between 60 kBytes and 5000 kBytes (An out of range value for TCPIPMEM will be set to closest of these limit values.)
Default:
Default value: 300 KBytes.
Example:
 [IP]
 TCPIPMEM=600
Since:
SC2x3 V1.00


[IP]
ETH_PRIO=prio

Defines the task priority of the Ethernet receiver task (ETH0). Allowed value are 2-127.
Default:
Default is 14.
Example:
 [IP]
 ETH_PRIO=11
Since:
SC2x3 V1.00


[IP]
ETH_ENABLE=0/1

Defines whether the internal Ethernet controller of the IPC@CHIP® is started or not. If ETH_ENABLE=0 the Ethernet device is not started.
Default:
By default the Ethernet device is enabled.
Example:
 [IP]
 ETH_ENABLE=0
Since:
SC2x3 V1.00


[IP]
ETH_MODE=Ethernet operating mode

The ethernet controller is able to operate in different operating modes.
Select the following operating modes of the internal Ethernet device:
     0: Auto negotiation
     1: Fixed 010 MBit/s, Half duplex
     2: Fixed 010 MBit/s, Full duplex
     3: Fixed 100 MBit/s, Half duplex
     4: Fixed 100 MBit/s, Full duplex
Default:
Auto negotiation.
Example:
 [IP]
 ETH_MODE=1
Since:
SC2x3 V1.00


[IP]
ETH_PHYIRQ=Ethernet phy IRQ number

Specifiy the IRQ number of the connected ethernet PHY transceiver. If this entry doesn't exists, no phy interrupt is supported by the ethernet driver. Currently supported IRQ numbers: 0-3.
Default:
No phy interrupt is used.
Example:
 [IP]
 ETH_PHYIRQ=2
Since:
SC2x3 V1.00


[IP]
ETH_PHYADDR=Ethernet Phy address

Specifiy the 8-bit hardware address of the connected ethernet PHY transceiver.
Default:
If this entry doesn't exists at the CHIP.INI file, address 0 is assumed.
Example:
 [IP]
 ETH_PHYADDR=1
Since:
SC2x3 V1.00


[IP]
MTU=bytes

Sets the Maximum Transfer Unit of the internal ethernet interface. Min. value is 68, max. value is 1500.
Default:
By default, MTU is 1500.
Example:
 [IP]
 MTU=1300
Since:
SC2x3 V1.00


[IP]
ARPENTRIES=number of entries

Set the maximum number of possible entries at the internal ARP/Routing table of the TCP/IP stack. Valid ranges between 32 and 512.
This option is also settable by API function TCPIP_SetOption().
Default:
Default value: 64.
Example:
 [IP]
 ARPENTRIES=128
Since:
SC2x3 V1.00


[IP]
ARPSMART=0/1

Set to 1 if the TCP/IP stack should store all incoming ARP replies. Set to 0 if the TCP/IP stack should cache only incoming ARP replies, which are requested by itself.
This option is also settable by API function TCPIP_SetOption().
Default:
ARPSMART disabled.
Example:
 [IP]
 ARPSMART=1
Since:
SC2x3 V1.00





Top of page | Main page

Copyright © 2017 Beck IPC GmbH
Generated on Thu Jan 26 16:21:35 2017 by Doxygen 1.6.1