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