NetIPv4_CfgAddrAddDynamic

Owned by Former user (Deleted)
Last updated: Dec 08, 2020 by WES Admin
2 min read

Add a dynamically-configured IPv4 host address, subnet mask, and default gateway to an interface.

Files

net_ipv4.h/net_ipv4.c

Prototype

          CPU_BOOLEAN NetIPv4_CfgAddrAddDynamic(NET_IF_NBR     if_nbr,
                                                NET_IPv4_ADDR  addr_host,
                                                NET_IPv4_ADDR  addr_subnet_mask,
                                                NET_IPv4_ADDR  addr_dflt_gateway,
                                                NET_ERR       *p_err);

Arguments

if_nbr

Interface number to configure.

addr_host

Desired IPv4 address to add to this interface.

addr_subnet_mask

Desired IPv4 address subnet mask.

addr_dflt_gateway

Desired IPv4 default gateway address.

p_err

Pointer to variable that will receive the return error code from this function:

NET_IPv4_ERR_NONE
NET_IPv4_ERR_INVALID_ADDR_HOST
NET_IPv4_ERR_INVALID_ADDR_GATEWAY
NET_IPv4_ERR_ADDR_CFG_STATE
NET_IPv4_ERR_ADDR_CFG_IN_USE
NET_IF_ERR_INVALID_IF
NET_ERR_INIT_INCOMPLETE
NET_ERR_FAULT_LOCK_ACQUIRE

Returned Value

DEF_OK,

if valid IPv4 address, subnet mask, and default gateway dynamically configured;

DEF_FAIL,

otherwise.

Required Configuration

None.

Notes / Warnings

IPv4 addresses must be configured in host-order.

An interface may be configured with either:

  • One or more statically- configured IPv4 addresses (see function NetIPv4_CfgAddrAdd) or
  • Exactly one dynamically-configured IPv4 address.

This function should only be called by appropriate network application function(s) [e.g., DHCP initialization functions]. However, if the application attempts to dynamically configure IPv4 address(es), it must call NetIPv4_CfgAddrAddDynamicStart() before calling NetIPv4_CfgAddrAddDynamic(). Note that on the default interface, the first IPv4 address added will be the default address used for all default communication. See also function NetIF_Add.

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 IPv4 address (i.e., the network portion of the configured IPv4 address and the configured gateway addresses must be identical).