Diff: LPC1768/if/eth/EthernetNetIf.h

Revision:

5:bc7df6da7589

Parent:

1:ba68cceb2917

Child:

6:5ff4a18d103e

diff -r 9cec8b1dcf09 -r bc7df6da7589 LPC1768/if/eth/EthernetNetIf.h
--- a/LPC1768/if/eth/EthernetNetIf.h	Fri Jul 09 14:34:26 2010 +0000
+++ b/LPC1768/if/eth/EthernetNetIf.h	Thu Aug 05 15:09:22 2010 +0000
@@ -21,6 +21,10 @@
 THE SOFTWARE.
 */
 
+/** \file
+Ethernet network interface header file
+*/
+
 #ifndef ETHERNETNETIF_H
 #define ETHERNETNETIF_H
 
@@ -28,23 +32,39 @@
 
 #include "mbed.h"
 
-#include "if/net/net.h"
 #include "if/lwip/LwipNetIf.h"
 
+///Ethernet network interface return codes
 enum EthernetErr
 {
   __ETH_MIN = -0xFFFF,
-  ETH_TIMEOUT, //Timeout during setup
-  ETH_OK = 0
+  ETH_TIMEOUT, ///<Timeout during setup
+  ETH_OK = 0 ///<Success
 };
 
+///Ethernet network interface
+/**
+This class provides Ethernet connectivity to the stack
+*/
 class EthernetNetIf : public LwipNetIf
 {
 public:
+  ///Instantiates the Interface and register it against the stack, DHCP will be used
   EthernetNetIf(); //W/ DHCP
+
+  ///Instantiates the Interface and register it against the stack, DHCP will not be used
+  /**
+  IpAddr is a container class that can be constructed with either 4 bytes or no parameters for a null IP address.
+  */
   EthernetNetIf(IpAddr ip, IpAddr netmask, IpAddr gateway, IpAddr dns); //W/o DHCP
   virtual ~EthernetNetIf();
   
+  ///Brings the interface up
+  /**
+  Uses DHCP if necessary
+  @param timeout_ms : You can set the timeout parameter in milliseconds, if not it defaults to 15s
+  @return : ETH_OK on success or ETH_TIMEOUT on timeout
+  */
   EthernetErr setup(int timeout_ms = 15000);
 
   virtual void poll();
@@ -53,6 +73,7 @@
   Timer m_ethArpTimer;
   Timer m_dhcpCoarseTimer;
   Timer m_dhcpFineTimer;
+  Timer m_igmpTimer;
     
   bool m_useDhcp;