Fnet_netif

Media Access Control (MAC) address type.

Definition at line 51 of file fnet_eth.h.

Event handler callback function prototype, that is called when there is an IP address conflict with another system on the network.

Parameters:

netif

Network interface descriptor that has duplicated IP address.

See also:

fnet_socket_rx_handler_init()

Definition at line 612 of file fnet_netif.h.

Network interface descriptor.

Definition at line 71 of file fnet_netif.h.

Interface IPv6 address information structure.

See also:

fnet_netif_get_ip6_addr()

Interface IPv6 Neighbor Cache structure.

See also:

fnet_netif_get_ip6_neighbor_cache()

Interface IPv6 Prefix structure.

See also:

fnet_netif_get_ip6_prefix()

Link-layer address. For example, Ethernet interafce uses the address with size set to 6.

Definition at line 78 of file fnet_netif.h.

Possible IPv6 address states.

See also:

fnet_netif_get_ip6_addr(), fnet_netif_ip6_addr_info

Enumerator:

FNET_NETIF_IP6_ADDR_STATE_NOT_USED	Not used.
FNET_NETIF_IP6_ADDR_STATE_TENTATIVE	Tentative address - (RFC4862) an address whose uniqueness on a link is being verified, prior to its assignment to an interface. A tentative address is not considered assigned to an interface in the usual sense. An interface discards received packets addressed to a tentative address, but accepts Neighbor Discovery packets related to Duplicate Address Detection for the tentative address.
FNET_NETIF_IP6_ADDR_STATE_PREFERRED	Preferred address - (RFC4862) an address assigned to an interface whose use by upper-layer protocols is unrestricted. Preferred addresses may be used as the source (or destination) address of packets sent from (or to) the interface.

Definition at line 96 of file fnet_netif.h.

Possible IPv6 address types.

See also:

fnet_netif_get_ip6_addr(), fnet_netif_ip6_addr_info

Enumerator:

FNET_NETIF_IP_ADDR_TYPE_MANUAL	The address is set manually.
FNET_NETIF_IP_ADDR_TYPE_AUTOCONFIGURABLE	The address is set using "Auto-IP" link-local autoconfiguration.
FNET_NETIF_IP_ADDR_TYPE_DHCP	The address is set using DHCP.

Definition at line 117 of file fnet_netif.h.

Network interface types.

Enumerator:

FNET_NETIF_TYPE_OTHER	Unspecified interface.
FNET_NETIF_TYPE_ETHERNET	Ethernet interface.
FNET_NETIF_TYPE_LOOPBACK	Loopback interface.

Definition at line 47 of file fnet_netif.h.

Converts a 6 byte MAC address into a null terminated string.

Parameters:

[in]	addr	MAC address.
[out]	str_mac	Pointer to a character buffer will contain the resulting text address in standard ":" notation. The str_mac buffer must be at least 18 bytes long (FNET_MAC_ADDR_STR_SIZE).

Returns:

This function always returns the str_mac.

See also:

fnet_str_to_mac()

This function takes an MAC-48 address, specified by the addr parameter, and returns a null-terminated ASCII string, represented by six groups of two hexadecimal digits, separated by colons (:), in transmission order (e.g. 01:23:45:67:89:ab ), into buffer pointed to by the str_mac.

Binds the IPv6 address to the specified network interface.

Parameters:

netif_desc	Network interface descriptor.
addr	The IPv6 address for the network interface.
addr_type	The IPv6 address type that defines the way the IPv6 address to be assigned to the interface.

Returns:

This function returns:

• FNET_OK if no error occurs.
• FNET_ERR in case of error.

See also:

fnet_netif_unbind_ip6_addr()

This function binds the IPv6 address to the netif interface.
The addr_type parameter defines the way the IPv6 address is assigned to the interface:

• FNET_NETIF_IP_ADDR_TYPE_AUTOCONFIGURABLE: value of the addr parameter defines the first 64bits of the bind IPv6 address. The last 64bits of the IPv6 address are overwritten with the Interface Identifier. In case of Ethernet interface, the Interface Identifier is formed from 48-bit MAC address, according to [RFC2464].
• !FNET_NETIF_IP_ADDR_TYPE_AUTOCONFIGURABLE: value of the addr parameter defines the whole IPv6 address to be bind to the interface.

Clears IPv4 address conflict flag.

Parameters:

netif_desc

Network interface descriptor.

See also:

fnet_netif_set_callback_on_ip4_addr_conflict(), fnet_netif_is_ip4_addr_conflict()

This function clears the netif interface IPv4 address conflict flag.
The address conflict is detected by ARP protocol.
The conflict flag is also cleared on changing of the interface IPv4 address, using fnet_netif_set_ip4_addr().

Looks for a network interface according to the specified IPv4 address.

Parameters:

addr	The IPv4 address of a network interface.

Returns:

This function returns:

• Network interface descriptor that matches the addr parameter.
• FNET_NULL if there is no match.

See also:

fnet_netif_get_by_name()

This function scans the global network interface list looking for a network interface matching the addr parameter.

Looks for a network interface according to the specified name.

Parameters:

name	The name string of a network interface. Maximum length of the interface name is defined by the FNET_NETIF_NAMELEN.

Returns:

This function returns:

• Network interface descriptor that matches the name parameter.
• FNET_NULL if there is no match.

See also:

fnet_netif_get_by_ip4_addr()

This function scans the global network interface list looking for a network interface matching the name parameter (for example "eth0", "loop").

Looks for a network interface according to its number.

Parameters:

n	Number of a network interface (from zero).

Returns:

This function returns:

• Network interface descriptor that matches the n-th interface.
• FNET_NULL if n-th interface is not available..

See also:

fnet_netif_get_by_name()

This function scans the global network interface list looking for a network interface matching the n parameter.

Looks for a network interface according to the specified Scope ID.

Parameters:

scope_id

The Scope ID of a network interface.

Returns:

This function returns:

• Network interface descriptor that matches the scope_id parameter.
• FNET_NULL if there is no match.

See also:

fnet_netif_get_scope_id()

This function scans the global network interface list looking for a network interface matching the specified Scope ID.

Looks for a network interface according to the specified socket address.

Parameters:

addr	The socket address of a network interface.

Returns:

This function returns:

• Network interface descriptor that matches the addr parameter.
• FNET_NULL if there is no match.

See also:

fnet_netif_get_by_scope_id()

This function scans the global network interface list looking for a network interface matching the specified socket address.

Retrieves the default network interface.

Returns:

This function returns the descriptor of the default network interface.

See also:

fnet_netif_set_default(), FNET_CFG_DEFAULT_IF

This function returns the descriptor of the default network interface.

By default, during the FNET stack initialization, the default network interface is assigned to the Ethernet.

Retrieves a hardware address of the specified network interface.

Parameters:

netif_desc	Network interface descriptor.
hw_addr	Buffer that receives a hardware address (for FNET_NETIF_TYPE_ETHERNET interface type, it will contain the MAC address).
hw_addr_size	Size of the hardware address in the hw_addr (for the FNET_NETIF_TYPE_ETHERNET interface type, it equals 6).

Returns:

This function returns:

• FNET_OK if no error occurs.
• FNET_ERR if an error occurs.

See also:

fnet_netif_set_hw_addr()

This function reads the hardware address of the netif interface and puts it into the hw_addr buffer.
For the FNET_NETIF_TYPE_ETHERNET interface type, this hardware address is the MAC address.

Retrieves an IPv4 address of the specified network interface.

Parameters:

netif_desc

Network interface descriptor.

Returns:

This function returns the IPv4 address of the netif interface.

See also:

fnet_netif_set_ip4_addr()

This function returns the IPv4 address of the netif interface.

Definition at line 55 of file ns_fnet_port.c.

Determines the way IPv4 address parameters were obtained.

Parameters:

netif_desc

Network interface descriptor.

Returns:

This function returns type of IPv4 address parameters bound to the interface.

See also:

fnet_netif_set_ip4_addr_type

This function determines if the IPv4 parameters of the netif interface were set manually, or obtained by the DHCP client or set during link-local autoconfiguartion (AutoIP - TBD)

Retrieves the DNS server IP address of the specified network interface.

Parameters:

netif_desc

Network interface descriptor.

Returns:

This function returns the DNS server IP address of the netif interface.

See also:

fnet_netif_set_ip4_dns(), FNET_CFG_DNS

This function is used to retrieve all DNS IPv4 addresses registered with the given interface.
It is present only if FNET_CFG_DNS is set to 1.

Retrieves a gateway IP address of the specified network interface.

Parameters:

netif_desc

Network interface descriptor.

Returns:

This function returns the gateway IP address of the netif interface.

See also:

fnet_netif_set_ip4_gateway()

This function returns the gateway IP address of the netif interface.

Retrieves a subnet mask of the specified network interface.

Parameters:

netif_desc

Network interface descriptor.

Returns:

This function returns the subnet mask of the netif interface.

See also:

fnet_netif_set_ip4_subnet_mask()

This function returns the subnet mask of the netif interface.

Retrieves an IPv6 address of the specified network interface.

Parameters:

netif_desc	Network interface descriptor.
n	Sequence number of IPv6 address to retrieve (from 0).
addr_info	Pointer to address information structure will contain the result.

Returns:

This function returns:

• FNET_TRUE if no error occurs and data structure is filled.
• FNET_FALSE in case of error or n-th address is not available.

This function is used to retrieve all IPv6 addresses registered with the given interface.

Definition at line 61 of file ns_fnet_port.c.

Retrieves the n-th DNS IPv6 address of the specified network interface.

Parameters:

netif_desc	Network interface descriptor.
n	Sequence number of DNS IPv6 address to retrieve (from 0).
addr_dns	Pointer to DNS IPv6 address that will contain the result.

Returns:

This function returns:

• FNET_TRUE if no error occurs and addr_dns is filled.
• FNET_FALSE in case of error or n-th DNS address is not available.

See also:

FNET_CFG_ND6_RDNSS, FNET_CFG_DNS

This function is used to retrieve all DNS IPv6 addresses registered with the given interface.
It is present only if FNET_CFG_DNS is set to 1.

Retrieves the n-th IPv6 neighbor cache entry of the specified network interface.

Parameters:

netif_desc	Network interface descriptor.
n	Sequence number of IPv6 neighbor cache entry to retrieve (from 0).
ip6_neighbor_cache	Pointer to neighbor cache entry that will contain the result.

Returns:

This function returns:

• FNET_TRUE if no error occurs and ip6_neighbor_cache is filled.
• FNET_FALSE in case of error or n-th neighbor cache entry is not available.

See also:

fnet_netif_ip6_neighbor_cache_t

This function is used to retrieve the Ipv6 neighbor cache for the given interface.

Retrieves the n-th IPv6 prefix of the specified network interface.

Parameters:

netif_desc	Network interface descriptor.
n	Sequence number of IPv6 prefix to retrieve (from 0).
ip6_prefix	Pointer to prefix entry structure that will contain the result.

Returns:

This function returns:

• FNET_TRUE if no error occurs and ip6_prefix is filled.
• FNET_FALSE in case of error or n-th prefix is not available.

See also:

Ffnet_netif_ip6_prefix_t

This function is used to retrieve the IPv6 prefix list for the given interface.

Retrieves a Maximum Transmission Unit (MTU) of the specified network interface.

Parameters:

netif_desc

Network interface descriptor.

Returns:

This function returns:

• MTU value.

This function is used to retrieve Maximum Transmission Unit (MTU) of the given interface.

Retrieves a name of the specified network interface.

Parameters:

netif_desc	Network interface descriptor.
name	String buffer that receives a name of the interface netif_desc.
name_size	Size of the name buffer. Maximum length of the interface name is defined by the FNET_NETIF_NAMELEN.

See also:

fnet_netif_get_by_name()

This function retrieves the name of the specified network interface netif_desc and stores it in the name (for example "eth0", "loop").

Retrieves an Scope ID of the specified network interface.

Parameters:

netif_desc

Network interface descriptor.

Returns:

This function returns:

• Scope ID value.
• 0 if no Scope ID was assigned to the interface.

This function is used to retrieve Scope ID assigned to the given interface.

Definition at line 48 of file ns_fnet_port.c.

Retrieves the network interface statistics.

Parameters:

netif_desc	Network interface descriptor.
statistics	Structure that receives the network interface statistics defined by the fnet_netif_statistics structure.

Returns:

This function returns:

• FNET_OK if no error occurs.
• FNET_ERR if an error occurs or the network interface driver does not support this statistics.

This function retrieves the network statistics of the netif interface and puts it into the statistics defined by the fnet_netif_statistics structure.

Retrieves the type of the specified network interface.

Parameters:

netif_desc

Network interface descriptor.

Returns:

This function returns the type of the netif interface.
The type is defined by the fnet_netif_type_t.

This function returns the type of the netif interface that is defined by the fnet_netif_type_t.

Initializes network interface and adds it to FNET stack.

Parameters:

netif_desc	Network interface descriptor to be initialized (FNET_CPU_ETH0_IF,FNET_CPU_ETH1_IF).
hw_addr	Buffer containing the hardware address (for the Ethernet interface, it contains the MAC address).
hw_addr_size	Size of the hardware address in the hw_addr (for the Ethernet interface, it equals 6).

Returns:

This function returns:

• FNET_OK if successful.
• FNET_ERR if failed.

See also:

fnet_init(), fnet_netif_release()

This function initializes network interface defined by netif_desc and adds it to the FNET stack.
FNET declares descriptors for Ethernet interfaces (FNET_CPU_ETH0_IF, FNET_CPU_ETH1_IF).

Note:

Loop-back interface (if set FNET_CFG_LOOPBACK) is initialized automatically during stack initialization.

Determines the link status of the network interface.

Parameters:

netif_desc

Network interface descriptor.

Returns:

This function returns:

• FNET_FALSE if the network link is unconnected.
• FNET_TRUE if the network link is connected.

This function determines if the netif interface is marked as connected to a network or not. The Ethernet network interface gets this status from the PHY.

Determines if the network interface is initialized.

Parameters:

netif_desc

Network interface descriptor.

Returns:

This function returns:

• FNET_FALSE if the network link is released or not initialized.
• FNET_TRUE if the network link is initialized.

This function determines if the netif interface is initialized and added to the FNET stack using ref fnet_netif_init().

Determines if there is IPv4 address conflict.

Parameters:

netif_desc

Network interface descriptor.

Returns:

This function returns:

• FNET_FALSE if the IPv4 address conflict is not detected.
• FNET_TRUE if the IPv4 address conflict is detected.

See also:

fnet_netif_set_callback_on_ip4_addr_conflict(), fnet_netif_clear_ip4_addr_conflict()

This function determines if there is the netif interface IPv4 address conflict with another system on the network.
The address conflict is detected by ARP protocol.
The conflict flag is cleared on changing of the interface IPv4 address, using fnet_netif_set_ip4_addr() or calling fnet_netif_clear_ip4_addr_conflict().

Joins the specified network interface to IPv4 multicast group.

Parameters:

netif_desc	Network interface descriptor.
multicast_addr	Multicast-group address to be joined by the interface.

See also:

fnet_netif_leave_ip4_multicast()

This function configures the HW interface to receive particular multicast address. When the network interface picks up a packet which has a destination that matches any of the joined-multicast addresses, it will pass it to the upper layers for further processing.

Note:

User application should not call this function.
This function is available only if FNET_CFG_MULTICAST and FNET_CFG_IP4 are set to 1.

Joins the specified network interface to IPv6 multicast group.

Parameters:

netif_desc	Network interface descriptor.
multicast_addr	Multicast-group address to be joined by the interface.

See also:

fnet_netif_leave_ip6_multicast()

This function configures the HW interface to receive particular multicast address. When the network interface picks up a packet which has a destination that matches any of the joined-multicast addresses, it will pass it to the upper layers for further processing.

Note:

User application should not call this function.
This function is available only if FNET_CFG_IP6 is set to 1.

Leaves the specified network interface from IPv4 multicast group.

Parameters:

netif_desc	Network interface descriptor.
multicast_addr	Multicast-group address to be leaved by the interface.

See also:

fnet_netif_join_ip4_multicast()

This function configures the HW interface to ignore particular multicast address.

Note:

User application should not call this function.
This function is available only if FNET_CFG_MULTICAST and FNET_CFG_IP4 are set to 1.

Leaves the specified network interface from IPv6 multicast group.

Parameters:

netif_desc	Network interface descriptor.
multicast_addr	Multicast-group address to be leaved by the interface.

See also:

fnet_netif_join_ip6_multicast()

This function configures the HW interface to ignore particular multicast address.

Note:

User application should not call this function.
This function is available only if FNET_CFG_IP6 is set to 1.

Releases network interface and removes it from FNET stack.

Parameters:

netif_desc

Network interface descriptor to be released (FNET_CPU_ETH0_IF,FNET_CPU_ETH1_IF).

See also:

fnet_init(), fnet_netif_init()

This function releases network interface defined by netif_desc and removes it from the FNET stack.
FNET declares descriptors for Ethernet interfaces (FNET_CPU_ETH0_IF, FNET_CPU_ETH1_IF).

Note:

fnet_release() automatically releases all initialized interfaces.

Registers the "IPv4 address conflict" event handler.

Parameters:

callback

Pointer to the event-handler callback function defined by fnet_netif_callback_ip4_addr_conflict_t.

See also:

fnet_netif_is_ip4_addr_conflict()

This function registers the handler callback function for the "IP4 address conflict" event. This event occurs when there is an IPv4 address conflict with another system on the network. It is detected by ARP protocol.
To stop the event handling, set callback parameter to zero value.

Assigns the default network interface.

Parameters:

netif_desc

Network interface descriptor to be assigned as default.

See also:

fnet_netif_get_default(), FNET_CFG_DEFAULT_IF

This function sets the netif as the default network interface.

By default, during the FNET stack initialization, the default network interface is assigned to the Ethernet.

Sets the hardware address of the specified network interface.

Parameters:

netif_desc	Network interface descriptor.
hw_addr	Buffer containing the hardware address (for the FNET_NETIF_TYPE_ETHERNET interface type, it contains the MAC address).
hw_addr_size	Size of the hardware address in the hw_addr (for the FNET_NETIF_TYPE_ETHERNET interface type, it equals 6).

Returns:

This function returns:

• FNET_OK if no error occurs.
• FNET_ERR if an error occurs.

See also:

fnet_netif_get_hw_addr()

This function sets the hardware address of the netif interface to the hw_addr value.
For the FNET_NETIF_TYPE_ETHERNET interface type, this hardware address is the MAC address.

Sets the IPv4 address of the specified network interface.

Parameters:

netif_desc	Network interface descriptor.
ipaddr	The IPv4 address of the network interface.
subnet_mask	The subnet mask of the network interface.

See also:

fnet_netif_get_ip4_addr(), fnet_netif_get_ip4_subnet_mask

This function sets the IPv4 address and the subnet mask of the netif interface.
If subnet_mask is INADDR_ANY, the function makes a recalculation of the subnet mask automatically.

Sets the way IPv4 address parameters were obtained.

Parameters:

netif_desc	Network interface descriptor.
ipaddr_type	Type of IPv4 address parameters.

See also:

fnet_netif_get_ip4_addr_type()

This function sets type of the interface IPv4 address parameters, if they were set manually, or obtained by the DHCP client or set during link-local autoconfiguartion (AutoIP).
fnet_netif_set_ip4_addr(), fnet_netif_set_ip4_gateway() and fnet_netif_set_ip4_dns() sets the type to FNET_NETIF_IP_ADDR_TYPE_MANUAL automatically.

Sets the DNS server IP address of the specified network interface.

Parameters:

netif_desc	Network interface descriptor.
dns	The DNS server IP address of the network interface.

See also:

fnet_netif_get_ip4_dns(), FNET_CFG_DNS

This function sets the DNS server IP address of the netif interface to the dns value.
It is present only if FNET_CFG_DNS is set to 1.

Sets the gateway IP address of the specified network interface.

Parameters:

netif_desc	Network interface descriptor.
gw	The gateway IP address of the network interface.

See also:

fnet_netif_get_ip4_gateway()

This function sets the gateway IP address of the netif interface to the gw value.

Sets the subnet mask of the specified network interface.

Parameters:

netif_desc	Network interface descriptor.
subnet_mask	The subnet mask of the network interface.

See also:

fnet_netif_get_ip4_subnet_mask()

This function sets the subnet mask of the netif interface to the netmask value.

Unbinds the IPv6 address from the specified network interface.

Parameters:

netif_desc	Network interface descriptor.
addr	The IPv6 address to unbind.

Returns:

This function returns:

• FNET_OK if successful.
• FNET_ERR if failed.

See also:

fnet_netif_bind_ip6_addr()

This function unbinds the IPv6 address from the netif interface.

Converts a null terminated string to a 6 byte MAC address.

Parameters:

[in]	str_mac	Null-terminated MAC address string as pairs of hexadecimal numbers separated by colons.
[out]	addr	Buffer will contain a suitable binary representation of the str_mac MAC address .

Returns:

This function returns:

• FNET_OK if no error occurs.
• FNET_ERR if the string in the str_mac parameter does not contain a legitimate MAC address.

See also:

fnet_mac_to_str()

This function interprets the character string specified by the str_mac parameter. This string represents a numeric MAC address expressed in six groups of two hexadecimal digits, separated by colons (:), in transmission order. The value returned, pointed to by the addr, is a number suitable for use as an MAC address.