Code cleaned.

Required comments added.
Documentation updated.

Signed-off-by: fpr <[email protected]>

Author: fpr

cores/arduino/stm32/ethernet.h

@@ -1,10 +1,10 @@
 /**
   ******************************************************************************
-  * @file    digital_io.h
+  * @file    ethernet.h
   * @author  WI6LABS
   * @version V1.0.0
-  * @date    01-August-2016
-  * @brief   Header for digital_io module
+  * @date    14-June-2017
+  * @brief   Header for ethernet background task for LwIP stack.
   ******************************************************************************
   * @attention
   *
@@ -49,6 +49,8 @@
 /* Exported macro ------------------------------------------------------------*/
 /* Exported functions ------------------------------------------------------- */
 
+/* This function is defined by the NativeEthernet library and it is used as
+background task inside the main loop. */
 __weak void stm32_eth_scheduler(void)
 {
   /* NOTE : This function should not be modified. It is defined in the Ethernet

libraries/NativeEthernet/README.adoc

@@ -13,8 +13,11 @@ http://git.savannah.gnu.org/cgit/lwip.git
 EthernetClass::maintain() in no more required to renew IP address from DHCP.
 It is done automatically by the LwIP stack in a background task.
 
-An Idle task is required to handle timer and data reception. Be careful to not
-lock the system in a loop where LwIP could never be updated.
+An Idle task is required by the LwIP stack to handle timer and data reception.
+This idle task is called inside the main loop in background by the function
+stm32_eth_scheduler(). Be careful to not lock the system inside the function
+loop() where LwIP could never be updated. Call EthernetUDP::parsePacket() or
+EthernetClient::available() performs an update of the LwIP stack.
 
 == License ==
 

libraries/NativeEthernet/src/EthernetClient.cpp

@@ -192,6 +192,9 @@ bool EthernetClient::operator==(const EthernetClient& rhs) {
   return _tcp_client == rhs._tcp_client && _tcp_client->pcb == rhs._tcp_client->pcb;
 }
 
+/* This function is not a function defined by Arduino. This is a function
+specific to the W5100 architecture. To keep the compatibility we leave it and
+returns always 0. */
 uint8_t EthernetClient::getSocketNumber() {
   return 0;
 }

libraries/NativeEthernet/src/NativeEthernet.cpp

@@ -45,6 +45,8 @@ void EthernetClass::begin(uint8_t *mac_address, IPAddress local_ip, IPAddress dn
 void EthernetClass::begin(uint8_t *mac, IPAddress local_ip, IPAddress dns_server, IPAddress gateway, IPAddress subnet)
 {
   stm32_eth_init(mac, local_ip.raw_address(), gateway.raw_address(), subnet.raw_address());
+  /* If there is a local DHCP informs it of our manual IP configuration to
+  prevent IP conflict */
   stm32_DHCP_manual_config();
   _dnsServerAddress = dns_server;
 }

libraries/NativeEthernet/src/utility/stm32_eth.c

@@ -593,8 +593,7 @@ struct pbuf *stm32_new_data(struct pbuf *p, const uint8_t *buffer, size_t size)
 
     if(q != NULL) {
       if(ERR_OK == pbuf_copy(q, p)) {
-        err_t err = pbuf_take_at(q, (uint8_t *)buffer, size, p->tot_len);
-        if(ERR_OK == /*pbuf_take_at(q, (uint8_t *)buffer, size, p->tot_len)*/err) {
+        if(ERR_OK == pbuf_take_at(q, (uint8_t *)buffer, size, p->tot_len)) {
           pbuf_free(p);
           p = q;
           return p;
@@ -742,9 +741,6 @@ err_t tcp_connected_callback(void *arg, struct tcp_pcb *tpcb, err_t err)
       /* initialize LwIP tcp_sent callback function */
       tcp_sent(tpcb, tcp_sent_callback);
 
-      /* initialize LwIP tcp_poll callback function */
-      // tcp_poll(tpcb, tcp_poll_callback, 1);
-
       /* initialize LwIP tcp_err callback function */
       tcp_err(tpcb, tcp_err_callback);
 
@@ -814,9 +810,6 @@ err_t tcp_accept_callback(void *arg, struct tcp_pcb *newpcb, err_t err)
         /* initialize LwIP tcp_sent callback function */
         tcp_sent(newpcb, tcp_sent_callback);
 
-        /* initialize lwip tcp_poll callback function for newpcb */
-        // tcp_poll(newpcb, tcp_echoserver_poll, 0);
-
         ret_err = ERR_OK;
       } else {
         /*  close tcp connection */