ethernetif.h File Reference

#include "lwip/err.h"
#include "lwip/netif.h"
#include "cmsis_os.h"

Go to the source code of this file.

Functions
err_t	ethernetif_init (struct netif *netif)
void	ethernetif_input (void const *argument)
void	ethernetif_update_config (struct netif *netif)
void	ethernetif_notify_conn_changed (struct netif *netif)
u32_t	sys_jiffies (void)
	Returns the current time in milliseconds when LWIP_TIMERS == 1 and NO_SYS == 1. More...
u32_t	sys_now (void)
	Returns the current time in milliseconds when LWIP_TIMERS == 1 and NO_SYS == 1. More...

Function Documentation

ethernetif_init()

err_t ethernetif_init

(

struct netif *

netif

)

File Name : ethernetif.h Description : This file provides initialization code for LWIP middleWare.

This notice applies to any and all portions of this file that are not between comment pairs USER CODE BEGIN and USER CODE END. Other portions of this file, whether inserted by the user or by software development tools are owned by their respective copyright owners.

Copyright (c) 2019 STMicroelectronics International N.V. All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted, provided that the following conditions are met:

1. Redistribution of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
3. Neither the name of STMicroelectronics nor the names of other contributors to this software may be used to endorse or promote products derived from this software without specific written permission.
4. This software, including modifications and/or derivative works of this software, must execute solely and exclusively on microcontroller or microprocessor devices manufactured by or for STMicroelectronics.
5. Redistribution and use of this software other than as permitted under this license is void and will automatically terminate your rights under this license.

THIS SOFTWARE IS PROVIDED BY STMICROELECTRONICS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS, IMPLIED OR STATUTORY WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT OF THIRD PARTY INTELLECTUAL PROPERTY RIGHTS ARE DISCLAIMED TO THE FULLEST EXTENT PERMITTED BY LAW. IN NO EVENT SHALL STMICROELECTRONICS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Should be called at the beginning of the program to set up the network interface. It calls the function low_level_init() to do the actual setup of the hardware.

This function should be passed as a parameter to netif_add().

Parameters

netif

the lwip network interface structure for this ethernetif

Returns

ERR_OK if the loopif is initialized ERR_MEM if private data couldn't be allocated any other err_t on error

                                           {
    LWIP_ASSERT("netif != NULL", (netif != NULL));
 
#if LWIP_NETIF_HOSTNAME
    /* Initialize interface hostname */
    netif->hostname = "lwip";
#endif /* LWIP_NETIF_HOSTNAME */
 
    netif->name[0] = IFNAME0;
    netif->name[1] = IFNAME1;
    /* We directly use etharp_output() here to save a function call.
   * You can instead declare your own function an call etharp_output()
   * from it if you have to do some checks before sending (e.g. if link
   * is available...) */
 
#if LWIP_IPV4
    #if LWIP_ARP || LWIP_ETHERNET
        #if LWIP_ARP
    netif->output = etharp_output;
        #else
    /* The user should write ist own code in low_level_output_arp_off function */
    netif->output = low_level_output_arp_off;
        #endif /* LWIP_ARP */
    #endif /* LWIP_ARP || LWIP_ETHERNET */
#endif /* LWIP_IPV4 */
 
#if LWIP_IPV6
    netif->output_ip6 = ethip6_output;
#endif /* LWIP_IPV6 */
 
    netif->linkoutput = low_level_output;
 
    /* initialize the hardware */
    low_level_init(netif);
 
    return ERR_OK;

Here is the call graph for this function:

Here is the caller graph for this function:

ethernetif_input()

void ethernetif_input

(

void const *

argument

)

This function should be called when a packet is ready to be read from the interface. It uses the function low_level_input() that should handle the actual reception of bytes from the network interface. Then the type of the received packet is determined and the appropriate input function is called.

Parameters

netif

the lwip network interface structure for this ethernetif

                                            {
    struct pbuf *p;
    struct netif *netif = (struct netif *)argument;
 
    for (;;) {
        if (osSemaphoreWait(s_xSemaphore, TIME_WAITING_FOR_INPUT) == osOK) {
            do {
                p = low_level_input(netif);
                if (p != NULL) {
                    if (netif->input(p, netif) != ERR_OK) {
                        pbuf_free(p);
                    }
                }
            } while (p != NULL);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

ethernetif_update_config()

void ethernetif_update_config

(

struct netif *

netif

)

Here is the caller graph for this function:

ethernetif_notify_conn_changed()

void ethernetif_notify_conn_changed

(

struct netif *

netif

)

sys_jiffies()

u32_t sys_jiffies

(

void

)

Returns the current time in milliseconds when LWIP_TIMERS == 1 and NO_SYS == 1.

Parameters

None

Return values

Time

                        {
    return HAL_GetTick();

sys_now()

u32_t sys_now

(

void

)

Returns the current time in milliseconds when LWIP_TIMERS == 1 and NO_SYS == 1.

Parameters

None

Return values

Time

                    {
    return HAL_GetTick();