Simon Ford / NetServices

Version of http://mbed.org/cookbook/NetServicesTribute with setting set the same for LPC2368

Dependents:   UDPSocketExample 24LCxx_I2CApp WeatherPlatform_pachube HvZServerLib ... more

if/eth/EthernetNetIf.h@0:350011bf8be7, 2010-11-23 (annotated)

Committer:
simon
Date:
Tue Nov 23 14:15:36 2010 +0000
Revision:
0:350011bf8be7
Experimental version for testing UDP

Who changed what in which revision?

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