Initializing Interfaces

Initialize an Interface

Adding an Interface

Interfaces may be added to the stack by calling NetIF_Add(). Each new interface requires additional BSP. The order of addition is critical to ensure that the interface number assigned to the new interface matches the code defined within net_bsp.c. See section Network Interface Configuration for more information on configuring interfaces.

Starting an Interface

Interfaces may be started by calling NetIF_Start(). See section Starting and Stopping Network Interfaces for more information on starting interfaces.

Initialize an Ethernet Interface

Once µC/TCP-IP is initialized, each network interface must be added to the stack via NetIF_Add() function. NetIF_Add() validates the network interface arguments, initializes the interface, and adds it to the interface list of the TCP/IP stack. µC/TCP-IP uses a structure that contains pointers to API functions which are used to access the interface layer, and configuration structures are used to initialize resources needed by the network interface. You must pass the following arguments to the NetIF_Add() function:

NET_IF_NBR  NetIF_Add (void     *if_api,                               (1)
                       void     *dev_api,                              (2)
                       void     *dev_bsp,                              (3)
                       void     *dev_cfg,                              (4)
                       void     *ext_api,                              (5)
                       void     *ext_cfg,                              (6)
                       NET_ERR  *perr)                                 (7)

Note: If an error occurs during the call to NetIF_Add(), the application may attempt to call NetIF_Add() a second time for the same interface but unless a temporary hardware fault occured, the application developer should observe the error code, determine and resolve the cause of the error, rebuild the application and try again. If a hardware failure occurred, the application may attempt to add an interface as many times as necessary, but a common problem to watch for is a µC/LIB Memory Manager heap out-of-memory condition. This may occur when adding network interfaces if there is insufficient memory to complete the operation. If this error occurs, the configured size of the µC/LIB heap within lib_cfg.h must be increased.

Once an interface is added successfully, the next step is to configure the interface with one or more network layer protocol addresses.

For a thorough description of the µC/TCP-IP files and directory structure, see section Directories and Files.

When the network interface is added without error, it must be started via the NetIF_Start() function to be available and be used by the µC/TCP-IP. The following code example shows how to initialize µC/TCP-IP, add an interface, configure the IP address and start it:

#include  <Source/net.h>
#include  <net_dev_dev1.h>
#include  <net_bsp.h>
#include  <net_phy.h>


CPU_BOOLEAN  App_InitTCPIP (void)
{
    NET_IF_NBR     if_nbr;
    NET_ERR        err;
 
    err = Net_Init(p_rx_task_cfg,                               
                   p_tx_task_cfg,
                   p_tmr_task_cfg);
    if (err != NET_ERR_NONE) {
        return (DEF_FAIL);
    }
    if_nbr  = NetIF_Add((void    *)&NetIF_API_Ether
                        (void    *)&NetDev_API_Etherxxx,
                        (void    *)&NetDev_BSP_API,
                        (void    *)&NetDev_Cfg_Ether_0,
                        (void    *)&NetPhy_API_Generic,
                        (void    *)&NetPhy_Cfg_0,
                        (NET_ERR *)&err);
    if (err != NET_IF_ERR_NONE) {
        return (DEF_FAIL);
    }

    NetIF_Start(if_nbr, &err);
    if (err != NET_IF_ERR_NONE) {
        return (DEF_FAIL);
    }
 
	return (DEF_OK);
}

Initialize an Wireless Interface

Once µC/TCP-IP is initialized each network interface must be added to the stack via the NetIF_Add() function which validates the network interface arguments, initializes the interface and adds it to the interface list. µC/TCP-IP uses a structure that contains pointers to API functions which are used to access the interface layer and configuration structures are used to initialize resources needed by the network interface. You must pass the following arguments to the NetIF_Add() function:

NET_IF_NBR  NetIF_Add (void     *if_api,                               (1)
                       void     *dev_api,                              (2)
                       void     *dev_bsp,                              (3)
                       void     *dev_cfg,                              (4)
                       void     *ext_api,                              (5)
                       void     *ext_cfg,                              (6)
                       NET_ERR  *perr)                                 (7)

Note: If an error occurs during the call to NetIF_Add(), the application may attempt to call NetIF_Add() a second time for the same interface but unless a temporary hardware fault occurred, the application developer should observe the error code, determine and resolve the cause of the error, rebuild the application and try again. If a hardware failure occurred, the application may attempt to add an interface as many times as necessary, but a common problem to watch for is a µC/LIB Memory Manager heap out-of-memory condition. This may occur when adding network interfaces if there is insufficient memory to complete the operation. If this error occurs, the configured size of the µC/LIB heap within app_cfg.h must be increased.

Once an interface is added successfully, the next step is to configure the interface with one or more network layer protocol addresses.

For a thorough description of the µC/TCP-IP files and directory structure, see Directories and Files.

Once a network interface is added without error, it must be started via the NetIF_Start() function to be seen as available and to be used by µC/TCP-IP. The following code example shows how to initialize µC/TCP-IP, add an interface, add an IP address and start the interface:

#include  <net.h>
#include  <net_dev_rs9110n2x.h>
#include  <net_bsp.h>
#include  <net_phy.h>


CPU_BOOLEAN  App_InitTCPIP (void)
{
    NET_IF_NBR   if_nbr;
    NET_ERR      err;
 
    err = Net_Init();
    if (err != NET_ERR_NONE) {
        return (DEF_FAIL);
    }
    if_nbr  = NetIF_Add((void    *)&NetIF_API_WiFi
                        (void    *)&NetDev_API_RS9110N2x,
                        (void    *)&NetDev_BSP_SPI_API,
                        (void    *)&NetDev_Cfg_WiFi_0,
                        (void    *)&NetWiFiMgr_API_Generic,
                        (void    *) 0,
                        (NET_ERR *)&err);
    if (err != NET_IF_ERR_NONE) {
        return (DEF_FAIL);
    }

    NetIF_Start(if_nbr, &err);
    if (err != NET_IF_ERR_NONE) {
        return (DEF_FAIL);
    }
	
	return (DEF_OK);
}