EthernetNetIf.h

00001 
00002 /*
00003 Copyright (c) 2010 Donatien Garnier (donatiengar [at] gmail [dot] com)
00004  
00005 Permission is hereby granted, free of charge, to any person obtaining a copy
00006 of this software and associated documentation files (the "Software"), to deal
00007 in the Software without restriction, including without limitation the rights
00008 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
00009 copies of the Software, and to permit persons to whom the Software is
00010 furnished to do so, subject to the following conditions:
00011  
00012 The above copyright notice and this permission notice shall be included in
00013 all copies or substantial portions of the Software.
00014  
00015 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
00016 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
00017 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
00018 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
00019 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
00020 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
00021 THE SOFTWARE.
00022 */
00023 
00024 /** \file
00025 Ethernet network interface header file
00026 */
00027 
00028 #ifndef ETHERNETNETIF_H
00029 #define ETHERNETNETIF_H
00030 
00031 struct netif;
00032 
00033 #include "mbed.h"
00034 
00035 #include "if/lwip/LwipNetIf.h"
00036 
00037 ///Ethernet network interface return codes
00038 enum EthernetErr
00039 {
00040   __ETH_MIN = -0xFFFF,
00041   ETH_TIMEOUT, ///<Timeout during setup
00042   ETH_OK = 0 ///<Success
00043 };
00044 
00045 ///Ethernet network interface
00046 /**
00047 This class provides Ethernet connectivity to the stack
00048 */
00049 class EthernetNetIf : public LwipNetIf
00050 {
00051 public:
00052   ///Instantiates the Interface and register it against the stack, DHCP will be used
00053   /**
00054   * An optional hostname can be specified which will be passed to the DHCP server.
00055   * Examples without and with hostname specified:
00056   *
00057   * @code
00058   * EthernetNetIf eth();
00059   * @endcode
00060   * @code
00061   * EthernetNetIf eth("mbedSE");
00062   * @endcode
00063   */
00064   EthernetNetIf(const char* hostname = NULL); //W/ DHCP
00065 
00066   ///Instantiates the Interface and register it against the stack, DHCP will not be used
00067   /**
00068   IpAddr is a container class that can be constructed with either 4 bytes or no parameters for a null IP address.
00069   */
00070   EthernetNetIf(IpAddr ip, IpAddr netmask, IpAddr gateway, IpAddr dns); //W/o DHCP
00071   virtual ~EthernetNetIf();
00072   
00073   ///Brings the interface up
00074   /**
00075   Uses DHCP if necessary
00076   @param timeout_ms : You can set the timeout parameter in milliseconds, if not it defaults to 15s
00077   @return : ETH_OK on success or ETH_TIMEOUT on timeout
00078   */
00079   EthernetErr setup(int timeout_ms = 15000);
00080 
00081   virtual void poll();
00082 
00083 private:
00084   Timer m_ethArpTimer;
00085   Timer m_dhcpCoarseTimer;
00086   Timer m_dhcpFineTimer;
00087   Timer m_igmpTimer;
00088     
00089   bool m_useDhcp;
00090 
00091   netif* m_pNetIf;
00092   
00093   IpAddr m_netmask;
00094   IpAddr m_gateway;
00095   
00096   const char* m_hostname;
00097   
00098 };
00099 
00100 #endif
00101