EthernetInterface.h

00001 /* EthernetInterface.h */
00002 /* Copyright (C) 2012 mbed.org, MIT License
00003  *
00004  * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
00005  * and associated documentation files (the "Software"), to deal in the Software without restriction,
00006  * including without limitation the rights to use, copy, modify, merge, publish, distribute,
00007  * sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
00008  * furnished to do so, subject to the following conditions:
00009  *
00010  * The above copyright notice and this permission notice shall be included in all copies or
00011  * substantial portions of the Software.
00012  *
00013  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
00014  * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
00015  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
00016  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
00017  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
00018  */
00019  
00020 #ifndef ETHERNETINTERFACE_H_
00021 #define ETHERNETINTERFACE_H_
00022 
00023 #if !defined(TARGET_LPC1768) && !defined(TARGET_LPC4088) && !defined(TARGET_LPC4088_DM) && !defined(TARGET_K64F) && !defined(TARGET_RZ_A1H) && !defined(TARGET_VK_RZ_A1H) && !defined(TARGET_STM32F4)
00024 #error The Ethernet Interface library is not supported on this target
00025 #endif
00026 
00027 #include "rtos.h"
00028 #include "lwip/netif.h"
00029 
00030 #define DP8_VALID_LINK     (1 << 0)   /**< 1=Link active */
00031 
00032  /** Interface using Ethernet to connect to an IP-based network
00033  *
00034  */
00035 class EthernetInterface {
00036 public:
00037   /** Initialize the interface with DHCP.
00038   * Initialize the interface and configure it to use DHCP (no connection at this point).
00039   * \return 0 on success, a negative number on failure
00040   */
00041   static int init(); //With DHCP
00042 
00043   /** Initialize the interface with a static IP address.
00044   * Initialize the interface and configure it with the following static configuration (no connection at this point).
00045   * \param ip the IP address to use
00046   * \param mask the IP address mask
00047   * \param gateway the gateway to use
00048   * \return 0 on success, a negative number on failure
00049   */
00050   static int init(const char* ip, const char* mask, const char* gateway);
00051 
00052   /** Connect
00053   * Bring the interface up, start DHCP if needed.
00054   * \param   timeout_ms  timeout in ms (default: (15)s).
00055   * \return 0 on success, a negative number on failure
00056   */
00057   static int connect(unsigned int timeout_ms=15000);
00058   
00059   /** Disconnect
00060   * Bring the interface down
00061   * \return 0 on success, a negative number on failure
00062   */
00063   static int disconnect();
00064   
00065   /** is_connected
00066   *
00067   * Determine if the interface is up and connected.
00068   * 
00069   * \example
00070   *      if (eth.is_connected())
00071   *         ethLED = 1;
00072   *      else
00073   *         ethLED = 0;
00074   *
00075   * \return true if connected, false if not connected.
00076   */
00077   static bool is_connected(void);
00078   
00079   /** Get the MAC address of your Ethernet interface
00080    * \return a pointer to a string containing the MAC address
00081    */
00082   static char* getMACAddress();
00083   
00084   /** Get the IP address of your Ethernet interface
00085    * \return a pointer to a string containing the IP address
00086    */
00087   static char* getIPAddress();
00088 
00089   /** Get the Gateway address of your Ethernet interface
00090    * \return a pointer to a string containing the Gateway address
00091    */
00092   static char* getGateway();
00093 
00094   /** Get the Network mask of your Ethernet interface
00095    * \return a pointer to a string containing the Network mask
00096    */
00097   static char* getNetworkMask();
00098   
00099     /** setName 
00100   *
00101   * Set the network name for this device. Apply this before
00102   * calling 'connect'.
00103   *
00104   * \param myname is the name to assign for this node. 
00105   *        Only the first 32 characters will be used if the 
00106   *        name is longer.
00107   *        Only '0'-'9', 'A'-'Z', 'a'-'z' are accepted,
00108   *        any others are converted to '-'.
00109   * \return 0 on success, a negative number on failure.
00110   */
00111   static int setName(const char * myname);
00112   
00113   uint32_t mii_read_data(void);
00114 
00115   char* getName();
00116 
00117 };
00118 
00119 #include "TCPSocketConnection.h"
00120 #include "TCPSocketServer.h"
00121 
00122 #include "Endpoint.h"
00123 #include "UDPSocket.h"
00124 
00125 #endif /* ETHERNETINTERFACE_H_ */