roy roy / EthernetNetIf

a

Fork of EthernetNetIf by Donatien Garnier

LPC1768/if/eth/EthernetNetIf.h@6:13a3e24ed1a3, 2016-11-27 (annotated)

Committer:
anze777
Date:
Sun Nov 27 14:42:41 2016 +0000
Revision:
6:13a3e24ed1a3
Parent:
5:bc7df6da7589 
2016 11/27

Who changed what in which revision?

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