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