IP Functions
NetIP_CfgAddrAdd()
Add a static IP host address, subnet mask, and default gateway to an interface.
Files
net_ip.h/net_ip.c
Prototype
CPU_BOOLEAN NetIP_CfgAddrAdd(NET_IF_NBR if_nbr, NET_IP_ADDR addr_host, NET_IP_ADDR addr_subnet_mask, NET_IP_ADDR addr_dflt_gateway, NET_ERR *perr); |
Arguments
if_nbr
Interface number to configure.
addr_host
Desired IP address to add to this interface.
addr_subnet_mask
Desired IP address subnet mask.
addr_dflt_gateway
Desired IP default gateway address.
perr
Pointer to variable that will receive the error code from this function:
NET_IP_ERR_NONE
NET_IP_ERR_INVALID_ADDR_HOST
NET_IP_ERR_INVALID_ADDR_GATEWAY
NET_IP_ERR_ADDR_CFG_STATE
NET_IP_ERR_ADDR_TBL_FULL
NET_IP_ERR_ADDR_CFG_IN_USE
NET_IF_ERR_INVALID_IF
NET_OS_ERR_LOCK
Returned Value
DEF_OK,
if valid IP address, subnet mask, and default gateway statically-configured;
DEF_FAIL,
otherwise.
Required Configuration
None.
Notes / Warnings
IP addresses must be configured in host-order.
An interface may be configured with either:
One or more statically- configured IP addresses (default configuration) or
Exactly one dynamically-configured IP address (see section C-12-2 on page 544).
If an interface’s address(es) are dynamically-configured, no statically-configured address(es) may be added until all dynamically-configured address(es) are removed.
The maximum number of IP address(es) configured on any interface is limited to NET_IP_CFG_IF_MAX_NBR_ADDR (see section D-9-1 on page 752).
Note that on the default interface, the first IP address added will be the default address used for all default communication. See also section C-9-1 on page 498.
A host may be configured without a gateway address to allow communication only with other hosts on its local network. However, any configured gateway address must be on the same network as the configured host IP address (i.e., the network portion of the configured IP address and the configured gateway addresses must be identical).