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