NetDev_Init()

The first function within the Ethernet API is the device driver initialization/Init() function. This function is called by NetIF_Add() exactly once for each specific network device added by the application. If multiple instances of the same network device are present on the development board, then this function is called for each instance of the device. However, applications should not try to add the same specific device more than once. If a network device fails to initialize, we recommend debugging to find and correct the cause of failure.

Note: This function relies heavily on the implementation of several network device board support package (BSP) functions. See Chapter 6, “Network Board Support Package” and Device Driver BSP Functions for more information on network device BSP functions.

Files

Every device driver’s net_dev.c

Prototype

          static void NetDev_Init (NET_IF  *pif,
                                   NET_ERR *perr);

Note that since every device driver’s Init() function is accessed only by function pointer via the device driver’s API structure, it doesn’t need to be globally available and should therefore be declared as ‘static’.

Arguments

pif

Pointer to the interface to initialize a network device.

perr

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

Returned Value

None.

Required Configuration

None.

Notes / Warnings

The Init() function generally performs the following operations, however, depending on the device being initialized, functionality may need to be added or removed:

1. Configure clock gating to the MAC device, if applicable. This is generally performed via the network device’s BSP function pointer, CfgClk(), implemented in net_bsp.c (see NetDev_CfgClk).
2. Configure all necessary I/O pins for both an internal or external MAC and PHY, if present. This is generally performed via the network device’s BSP function pointer, CfgGPIO(), implemented in net_bsp.c (see NetDev_CfgGPIO).

   Configure the host interrupt controller for receive and transmit complete interrupts. Additional interrupt services may be initialized depending on the device and driver requirements. This is generally performed via the network device’s BSP function pointer, CfgIntCtrl(), implemented in net_bsp.c (see NetDev_CfgIntCtrl).

3. For DMA devices: Allocate memory for all necessary descriptors. This is performed via calls to µC/LIB’s memory module.
4. For DMA devices: Initialize all descriptors to their ready states. This may be performed via calls to locally-declared, ‘static’ functions.
5. Initialize the (R)MII bus interface, if applicable. This generally entails configuring the (R)MII bus frequency which is dependent on the system clock. Static values for clock frequencies should never be used when determining clock dividers. Instead, the driver should reference the associated clock function(s) for getting the system clock or peripheral bus frequencies, and use these values to compute the correct (R)MII bus clock divider(s). This is generally performed via the network device’s BSP function pointer, ClkFreqGet(), implemented in net_bsp.c (see NetDev_ClkGetFreq).
6. Disable the transmitted and receiver (should already be disabled).
7. Disable and clear pending interrupts (should already be cleared).
8. Set perr to NET_DEV_ERR_NONE if initialization proceeded as expected. Otherwise, set perr to an appropriate network device error code.