Dependencies:   mbed

Committer:
slowness
Date:
Tue Sep 06 18:10:36 2011 +0000
Revision:
0:cd4c47744fa1

        

Who changed what in which revision?

UserRevisionLine numberNew contents of line
slowness 0:cd4c47744fa1 1
slowness 0:cd4c47744fa1 2 /*
slowness 0:cd4c47744fa1 3 Copyright (c) 2010 Donatien Garnier (donatiengar [at] gmail [dot] com)
slowness 0:cd4c47744fa1 4
slowness 0:cd4c47744fa1 5 Permission is hereby granted, free of charge, to any person obtaining a copy
slowness 0:cd4c47744fa1 6 of this software and associated documentation files (the "Software"), to deal
slowness 0:cd4c47744fa1 7 in the Software without restriction, including without limitation the rights
slowness 0:cd4c47744fa1 8 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
slowness 0:cd4c47744fa1 9 copies of the Software, and to permit persons to whom the Software is
slowness 0:cd4c47744fa1 10 furnished to do so, subject to the following conditions:
slowness 0:cd4c47744fa1 11
slowness 0:cd4c47744fa1 12 The above copyright notice and this permission notice shall be included in
slowness 0:cd4c47744fa1 13 all copies or substantial portions of the Software.
slowness 0:cd4c47744fa1 14
slowness 0:cd4c47744fa1 15 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
slowness 0:cd4c47744fa1 16 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
slowness 0:cd4c47744fa1 17 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
slowness 0:cd4c47744fa1 18 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
slowness 0:cd4c47744fa1 19 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
slowness 0:cd4c47744fa1 20 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
slowness 0:cd4c47744fa1 21 THE SOFTWARE.
slowness 0:cd4c47744fa1 22 */
slowness 0:cd4c47744fa1 23
slowness 0:cd4c47744fa1 24 /** \file
slowness 0:cd4c47744fa1 25 Ethernet network interface header file
slowness 0:cd4c47744fa1 26 */
slowness 0:cd4c47744fa1 27
slowness 0:cd4c47744fa1 28 #ifndef ETHERNETNETIF_H
slowness 0:cd4c47744fa1 29 #define ETHERNETNETIF_H
slowness 0:cd4c47744fa1 30
slowness 0:cd4c47744fa1 31 struct netif;
slowness 0:cd4c47744fa1 32
slowness 0:cd4c47744fa1 33 #include "mbed.h"
slowness 0:cd4c47744fa1 34
slowness 0:cd4c47744fa1 35 #include "if/lwip/LwipNetIf.h"
slowness 0:cd4c47744fa1 36
slowness 0:cd4c47744fa1 37 ///Ethernet network interface return codes
slowness 0:cd4c47744fa1 38 enum EthernetErr
slowness 0:cd4c47744fa1 39 {
slowness 0:cd4c47744fa1 40 __ETH_MIN = -0xFFFF,
slowness 0:cd4c47744fa1 41 ETH_TIMEOUT, ///<Timeout during setup
slowness 0:cd4c47744fa1 42 ETH_OK = 0 ///<Success
slowness 0:cd4c47744fa1 43 };
slowness 0:cd4c47744fa1 44
slowness 0:cd4c47744fa1 45 ///Ethernet network interface
slowness 0:cd4c47744fa1 46 /**
slowness 0:cd4c47744fa1 47 This class provides Ethernet connectivity to the stack
slowness 0:cd4c47744fa1 48 */
slowness 0:cd4c47744fa1 49 class EthernetNetIf : public LwipNetIf
slowness 0:cd4c47744fa1 50 {
slowness 0:cd4c47744fa1 51 public:
slowness 0:cd4c47744fa1 52 ///Instantiates the Interface and register it against the stack, DHCP will be used
slowness 0:cd4c47744fa1 53 EthernetNetIf(); //W/ DHCP
slowness 0:cd4c47744fa1 54
slowness 0:cd4c47744fa1 55 ///Instantiates the Interface and register it against the stack, DHCP will not be used
slowness 0:cd4c47744fa1 56 /**
slowness 0:cd4c47744fa1 57 IpAddr is a container class that can be constructed with either 4 bytes or no parameters for a null IP address.
slowness 0:cd4c47744fa1 58 */
slowness 0:cd4c47744fa1 59 EthernetNetIf(IpAddr ip, IpAddr netmask, IpAddr gateway, IpAddr dns); //W/o DHCP
slowness 0:cd4c47744fa1 60 virtual ~EthernetNetIf();
slowness 0:cd4c47744fa1 61
slowness 0:cd4c47744fa1 62 ///Brings the interface up
slowness 0:cd4c47744fa1 63 /**
slowness 0:cd4c47744fa1 64 Uses DHCP if necessary
slowness 0:cd4c47744fa1 65 @param timeout_ms : You can set the timeout parameter in milliseconds, if not it defaults to 15s
slowness 0:cd4c47744fa1 66 @return : ETH_OK on success or ETH_TIMEOUT on timeout
slowness 0:cd4c47744fa1 67 */
slowness 0:cd4c47744fa1 68 EthernetErr setup(int timeout_ms = 15000);
slowness 0:cd4c47744fa1 69
slowness 0:cd4c47744fa1 70 virtual void poll();
slowness 0:cd4c47744fa1 71
slowness 0:cd4c47744fa1 72 private:
slowness 0:cd4c47744fa1 73 Timer m_ethArpTimer;
slowness 0:cd4c47744fa1 74 Timer m_dhcpCoarseTimer;
slowness 0:cd4c47744fa1 75 Timer m_dhcpFineTimer;
slowness 0:cd4c47744fa1 76 Timer m_igmpTimer;
slowness 0:cd4c47744fa1 77
slowness 0:cd4c47744fa1 78 bool m_useDhcp;
slowness 0:cd4c47744fa1 79
slowness 0:cd4c47744fa1 80 netif* m_pNetIf;
slowness 0:cd4c47744fa1 81
slowness 0:cd4c47744fa1 82 IpAddr m_netmask;
slowness 0:cd4c47744fa1 83 IpAddr m_gateway;
slowness 0:cd4c47744fa1 84
slowness 0:cd4c47744fa1 85 const char* m_hostname;
slowness 0:cd4c47744fa1 86
slowness 0:cd4c47744fa1 87 };
slowness 0:cd4c47744fa1 88
slowness 0:cd4c47744fa1 89 #endif
slowness 0:cd4c47744fa1 90