Nino Der Kinderen / Mbed 2 deprecated InetTest

Embedded C project:18/12/2014

Dependencies:   DS1307 TextLCD mbed

NetServices/if/eth/EthernetNetIf.h@0:8d87bc453349, 2014-12-18 (annotated)

Committer:
ninoderkinderen
Date:
Thu Dec 18 09:35:49 2014 +0000
Revision:
0:8d87bc453349
Programma embedded C

Who changed what in which revision?

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