Diff: WIZ820ioNetIf.h

Revision:

2:a8df39b4f3aa

Parent:

1:803123933c5a

--- a/WIZ820ioNetIf.h	Tue Apr 17 12:13:15 2012 +0000
+++ b/WIZ820ioNetIf.h	Thu Apr 19 11:14:43 2012 +0000
@@ -1,25 +1,24 @@
-// WIZ820ioNetIf.h 2012/4/15
-/*
+// WIZ820ioNetIf.h 2012/4/19
 
-WIZ820io       mbed
-J2P1 GND ----- p1 GND
-J1P3 MOSI ---- p11 SPI(mosi)
-J2P6 MISO ---- p12 SPI(miso)
-J1P4 SCK ----- p13 SPI(sck)
-J1P5 nSS ----- p14
-J2P5 nRESET -- p15
-J2P3 3V3D ---- p40 VOUT
-J2P4 PWDN ---- GND
-
+/** \file
+WIZ820io network interface header file
 */
 #ifndef WIZ820IO_NETIF_H
 #define WIZ820IO_NETIF_H
-#include "w5200NetIf.h"
-class WIZ820ioNetIf : public w5200NetIf {
+#include "W5200NetIf.h"
+
+///WIZ820io network interface
+class WIZ820ioNetIf : public W5200NetIf {
 public:
     void spi(PinName mosi,PinName miso, PinName sclk);
     void cs(PinName _cs);
     void reset(PinName _reset);
+    ///Brings the interface up
+    /**
+    Uses DHCP if necessary
+    @param timeout_ms : You can set the timeout parameter in milliseconds, if not it defaults to 15s
+    @return : 0 on success or -1 on timeout
+    */    
     int setup(int timeout_ms = 15000);
 };
 #endif //WIZ820IO_NETIF_H