Michael Spencer / Mbed 2 deprecated LaOS

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependencies:   mbed

NetServices/if/eth/EthernetNetIf.h@1:f5ac63519541, 2014-03-05 (annotated)

Committer:
Michael J. Spencer
Date:
Wed Mar 05 06:14:02 2014 -0800
Revision:
1:f5ac63519541
Initial commit.

Who changed what in which revision?

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