Bongjun Hur / W5500Interface

W5500 driver for mbed OS 5

Dependents:   http-webserver-example mbed-os-example-sockets

Fork of W5500Interface by Sergei G

W5500Interface.h@9:351e20cf7d05, 2018-08-10 (annotated)

Committer:
Bongjun
Date:
Fri Aug 10 08:51:31 2018 +0000
Revision:
9:351e20cf7d05
Parent:
8:c71c66d43703
Child:
10:925201b1603f
add comment on DHCPClient files

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Bongjun 6:e2ab76b2be07 1 /**
Bongjun 6:e2ab76b2be07 2 ******************************************************************************
Bongjun 6:e2ab76b2be07 3 * @file W5500Interface.h
Bongjun 6:e2ab76b2be07 4 * @author Bongjun Hur (modified version from Sergei G (https://os.mbed.com/users/sgnezdov/))
Bongjun 6:e2ab76b2be07 5 * @brief Header file of the NetworkStack for the W5500 Device
Bongjun 6:e2ab76b2be07 6 ******************************************************************************
Bongjun 6:e2ab76b2be07 7 * @attention
Bongjun 6:e2ab76b2be07 8 *
Bongjun 6:e2ab76b2be07 9 * THE PRESENT FIRMWARE WHICH IS FOR GUIDANCE ONLY AIMS AT PROVIDING CUSTOMERS
Bongjun 6:e2ab76b2be07 10 * WITH CODING INFORMATION REGARDING THEIR PRODUCTS IN ORDER FOR THEM TO SAVE
Bongjun 6:e2ab76b2be07 11 * TIME. AS A RESULT, WIZnet SHALL NOT BE HELD LIABLE FOR ANY
Bongjun 6:e2ab76b2be07 12 * DIRECT, INDIRECT OR CONSEQUENTIAL DAMAGES WITH RESPECT TO ANY CLAIMS ARISING
Bongjun 6:e2ab76b2be07 13 * FROM THE CONTENT OF SUCH FIRMWARE AND/OR THE USE MADE BY CUSTOMERS OF THE
Bongjun 6:e2ab76b2be07 14 * CODING INFORMATION CONTAINED HEREIN IN CONNECTION WITH THEIR PRODUCTS.
Bongjun 6:e2ab76b2be07 15 *
Bongjun 6:e2ab76b2be07 16 * <h2><center>&copy; COPYRIGHT 2017,2018 WIZnet Co.,Ltd.</center></h2>
Bongjun 6:e2ab76b2be07 17 ******************************************************************************
Bongjun 6:e2ab76b2be07 18 */
Bongjun 6:e2ab76b2be07 19
Bongjun 6:e2ab76b2be07 20 #ifndef W5500_INTERFACE_H
Bongjun 6:e2ab76b2be07 21 #define W5500_INTERFACE_H
Bongjun 6:e2ab76b2be07 22
Bongjun 6:e2ab76b2be07 23 #include "mbed.h"
Bongjun 6:e2ab76b2be07 24 #include "W5500.h"
Bongjun 6:e2ab76b2be07 25 //#include "rtos.h"
Bongjun 8:c71c66d43703 26 #include "PinNames.h"
Bongjun 8:c71c66d43703 27
Bongjun 8:c71c66d43703 28 // Arduino pin defaults for convenience
Bongjun 8:c71c66d43703 29 #if !defined(W5500_SPI_MOSI)
Bongjun 8:c71c66d43703 30 #define W5500_SPI_MOSI D11
Bongjun 8:c71c66d43703 31 #endif
Bongjun 8:c71c66d43703 32 #if !defined(W5500_SPI_MISO)
Bongjun 8:c71c66d43703 33 #define W5500_SPI_MISO D12
Bongjun 8:c71c66d43703 34 #endif
Bongjun 8:c71c66d43703 35 #if !defined(W5500_SPI_SCLK)
Bongjun 8:c71c66d43703 36 #define W5500_SPI_SCLK D13
Bongjun 8:c71c66d43703 37 #endif
Bongjun 8:c71c66d43703 38 #if !defined(W5500_SPI_CS)
Bongjun 8:c71c66d43703 39 #define W5500_SPI_CS D10
Bongjun 8:c71c66d43703 40 #endif
Bongjun 8:c71c66d43703 41 #if !defined(W5500_SPI_RST)
Bongjun 8:c71c66d43703 42 #define W5500_SPI_RST NC
Bongjun 8:c71c66d43703 43 #endif
Bongjun 8:c71c66d43703 44
Bongjun 6:e2ab76b2be07 45
Bongjun 6:e2ab76b2be07 46 /** w5500_socket struct
Bongjun 6:e2ab76b2be07 47 * W5500 socket
Bongjun 6:e2ab76b2be07 48 */
Bongjun 6:e2ab76b2be07 49
Bongjun 6:e2ab76b2be07 50 struct w5500_socket {
Bongjun 6:e2ab76b2be07 51 int fd;
Bongjun 6:e2ab76b2be07 52 nsapi_protocol_t proto;
Bongjun 6:e2ab76b2be07 53 bool connected;
Bongjun 6:e2ab76b2be07 54 void (*callback)(void *);
Bongjun 6:e2ab76b2be07 55 void *callback_data;
Bongjun 6:e2ab76b2be07 56 };
Bongjun 6:e2ab76b2be07 57
Bongjun 6:e2ab76b2be07 58 /** W5500Interface class
Bongjun 6:e2ab76b2be07 59 * Implementation of the NetworkStack for the W5500
Bongjun 6:e2ab76b2be07 60 */
Bongjun 6:e2ab76b2be07 61
Bongjun 6:e2ab76b2be07 62 class W5500Interface : public NetworkStack, public EthInterface
Bongjun 6:e2ab76b2be07 63 {
Bongjun 6:e2ab76b2be07 64 public:
Bongjun 8:c71c66d43703 65 //W5500Interface(SPI* spi, PinName cs, PinName reset);
Bongjun 6:e2ab76b2be07 66 W5500Interface(PinName mosi, PinName miso, PinName sclk, PinName cs, PinName reset);
Bongjun 6:e2ab76b2be07 67
Bongjun 6:e2ab76b2be07 68 int init();
Bongjun 6:e2ab76b2be07 69 int init(uint8_t * mac);
Bongjun 6:e2ab76b2be07 70 int init(const char* ip, const char* mask, const char* gateway);
Bongjun 6:e2ab76b2be07 71 int init(uint8_t * mac, const char* ip, const char* mask, const char* gateway);
Bongjun 6:e2ab76b2be07 72
Bongjun 6:e2ab76b2be07 73 /** Start the interface
Bongjun 6:e2ab76b2be07 74 * @return 0 on success, negative on failure
Bongjun 6:e2ab76b2be07 75 */
Bongjun 6:e2ab76b2be07 76 virtual int connect();
Bongjun 6:e2ab76b2be07 77
Bongjun 6:e2ab76b2be07 78 /** Stop the interface
Bongjun 6:e2ab76b2be07 79 * @return 0 on success, negative on failure
Bongjun 6:e2ab76b2be07 80 */
Bongjun 6:e2ab76b2be07 81 virtual int disconnect();
Bongjun 6:e2ab76b2be07 82
Bongjun 6:e2ab76b2be07 83 /** Get the internally stored IP address
Bongjun 6:e2ab76b2be07 84 * @return IP address of the interface or null if not yet connected
Bongjun 6:e2ab76b2be07 85 */
Bongjun 6:e2ab76b2be07 86 virtual const char *get_ip_address();
Bongjun 6:e2ab76b2be07 87
Bongjun 6:e2ab76b2be07 88 /** Get MAC address and fill mac with it.
Bongjun 6:e2ab76b2be07 89 */
Bongjun 6:e2ab76b2be07 90 void get_mac(uint8_t mac[6]) ;
Bongjun 6:e2ab76b2be07 91
Bongjun 6:e2ab76b2be07 92 /** Get the internally stored MAC address
Bongjun 6:e2ab76b2be07 93 * @return MAC address of the interface
Bongjun 6:e2ab76b2be07 94 */
Bongjun 6:e2ab76b2be07 95 virtual const char *get_mac_address();
Bongjun 6:e2ab76b2be07 96
Bongjun 6:e2ab76b2be07 97 protected:
Bongjun 6:e2ab76b2be07 98 /** Opens a socket
Bongjun 6:e2ab76b2be07 99 *
Bongjun 6:e2ab76b2be07 100 * Creates a network socket and stores it in the specified handle.
Bongjun 6:e2ab76b2be07 101 * The handle must be passed to following calls on the socket.
Bongjun 6:e2ab76b2be07 102 *
Bongjun 6:e2ab76b2be07 103 * A stack may have a finite number of sockets, in this case
Bongjun 6:e2ab76b2be07 104 * NSAPI_ERROR_NO_SOCKET is returned if no socket is available.
Bongjun 6:e2ab76b2be07 105 *
Bongjun 6:e2ab76b2be07 106 * @param handle Destination for the handle to a newly created socket
Bongjun 6:e2ab76b2be07 107 * @param proto Protocol of socket to open, NSAPI_TCP or NSAPI_UDP
Bongjun 6:e2ab76b2be07 108 * @return 0 on success, negative error code on failure
Bongjun 6:e2ab76b2be07 109 */
Bongjun 6:e2ab76b2be07 110 virtual nsapi_error_t socket_open(nsapi_socket_t *handle, nsapi_protocol_t proto);
Bongjun 6:e2ab76b2be07 111 // virtual int socket_open(void **handle, nsapi_protocol_t proto);
Bongjun 6:e2ab76b2be07 112
Bongjun 6:e2ab76b2be07 113 /** Close the socket
Bongjun 6:e2ab76b2be07 114 *
Bongjun 6:e2ab76b2be07 115 * Closes any open connection and deallocates any memory associated
Bongjun 6:e2ab76b2be07 116 * with the socket.
Bongjun 6:e2ab76b2be07 117 *
Bongjun 6:e2ab76b2be07 118 * @param handle Socket handle
Bongjun 6:e2ab76b2be07 119 * @return 0 on success, negative error code on failure
Bongjun 6:e2ab76b2be07 120 */
Bongjun 6:e2ab76b2be07 121 virtual nsapi_error_t socket_close(nsapi_socket_t handle);
Bongjun 6:e2ab76b2be07 122
Bongjun 6:e2ab76b2be07 123 /** Bind a specific address to a socket
Bongjun 6:e2ab76b2be07 124 *
Bongjun 6:e2ab76b2be07 125 * Binding a socket specifies the address and port on which to recieve
Bongjun 6:e2ab76b2be07 126 * data. If the IP address is zeroed, only the port is bound.
Bongjun 6:e2ab76b2be07 127 *
Bongjun 6:e2ab76b2be07 128 * @param handle Socket handle
Bongjun 6:e2ab76b2be07 129 * @param address Local address to bind
Bongjun 6:e2ab76b2be07 130 * @return 0 on success, negative error code on failure.
Bongjun 6:e2ab76b2be07 131 */
Bongjun 6:e2ab76b2be07 132 virtual nsapi_error_t socket_bind(nsapi_socket_t handle, const SocketAddress &address);
Bongjun 6:e2ab76b2be07 133
Bongjun 6:e2ab76b2be07 134 /** Listen for connections on a TCP socket
Bongjun 6:e2ab76b2be07 135 *
Bongjun 6:e2ab76b2be07 136 * Marks the socket as a passive socket that can be used to accept
Bongjun 6:e2ab76b2be07 137 * incoming connections.
Bongjun 6:e2ab76b2be07 138 *
Bongjun 6:e2ab76b2be07 139 * @param handle Socket handle
Bongjun 6:e2ab76b2be07 140 * @param backlog Number of pending connections that can be queued
Bongjun 6:e2ab76b2be07 141 * simultaneously
Bongjun 6:e2ab76b2be07 142 * @return 0 on success, negative error code on failure
Bongjun 6:e2ab76b2be07 143 */
Bongjun 6:e2ab76b2be07 144 virtual nsapi_error_t socket_listen(nsapi_socket_t handle, int backlog);
Bongjun 6:e2ab76b2be07 145
Bongjun 6:e2ab76b2be07 146 /** Connects TCP socket to a remote host
Bongjun 6:e2ab76b2be07 147 *
Bongjun 6:e2ab76b2be07 148 * Initiates a connection to a remote server specified by the
Bongjun 6:e2ab76b2be07 149 * indicated address.
Bongjun 6:e2ab76b2be07 150 *
Bongjun 6:e2ab76b2be07 151 * @param handle Socket handle
Bongjun 6:e2ab76b2be07 152 * @param address The SocketAddress of the remote host
Bongjun 6:e2ab76b2be07 153 * @return 0 on success, negative error code on failure
Bongjun 6:e2ab76b2be07 154 */
Bongjun 6:e2ab76b2be07 155 virtual nsapi_error_t socket_connect(nsapi_socket_t handle, const SocketAddress &address);
Bongjun 6:e2ab76b2be07 156
Bongjun 6:e2ab76b2be07 157 /** Accepts a connection on a TCP socket
Bongjun 6:e2ab76b2be07 158 *
Bongjun 6:e2ab76b2be07 159 * The server socket must be bound and set to listen for connections.
Bongjun 6:e2ab76b2be07 160 * On a new connection, creates a network socket and stores it in the
Bongjun 6:e2ab76b2be07 161 * specified handle. The handle must be passed to following calls on
Bongjun 6:e2ab76b2be07 162 * the socket.
Bongjun 6:e2ab76b2be07 163 *
Bongjun 6:e2ab76b2be07 164 * A stack may have a finite number of sockets, in this case
Bongjun 6:e2ab76b2be07 165 * NSAPI_ERROR_NO_SOCKET is returned if no socket is available.
Bongjun 6:e2ab76b2be07 166 *
Bongjun 6:e2ab76b2be07 167 * This call is non-blocking. If accept would block,
Bongjun 6:e2ab76b2be07 168 * NSAPI_ERROR_WOULD_BLOCK is returned immediately.
Bongjun 6:e2ab76b2be07 169 *
Bongjun 6:e2ab76b2be07 170 * @param server Socket handle to server to accept from
Bongjun 6:e2ab76b2be07 171 * @param handle Destination for a handle to the newly created socket
Bongjun 6:e2ab76b2be07 172 * @param address Destination for the remote address or NULL
Bongjun 6:e2ab76b2be07 173 * @return 0 on success, negative error code on failure
Bongjun 6:e2ab76b2be07 174 */
Bongjun 6:e2ab76b2be07 175 virtual nsapi_error_t socket_accept(nsapi_socket_t server,
Bongjun 6:e2ab76b2be07 176 nsapi_socket_t *handle, SocketAddress *address=0);
Bongjun 6:e2ab76b2be07 177
Bongjun 6:e2ab76b2be07 178 /** Send data over a TCP socket
Bongjun 6:e2ab76b2be07 179 *
Bongjun 6:e2ab76b2be07 180 * The socket must be connected to a remote host. Returns the number of
Bongjun 6:e2ab76b2be07 181 * bytes sent from the buffer.
Bongjun 6:e2ab76b2be07 182 *
Bongjun 6:e2ab76b2be07 183 * This call is non-blocking. If send would block,
Bongjun 6:e2ab76b2be07 184 * NSAPI_ERROR_WOULD_BLOCK is returned immediately.
Bongjun 6:e2ab76b2be07 185 *
Bongjun 6:e2ab76b2be07 186 * @param handle Socket handle
Bongjun 6:e2ab76b2be07 187 * @param data Buffer of data to send to the host
Bongjun 6:e2ab76b2be07 188 * @param size Size of the buffer in bytes
Bongjun 6:e2ab76b2be07 189 * @return Number of sent bytes on success, negative error
Bongjun 6:e2ab76b2be07 190 * code on failure
Bongjun 6:e2ab76b2be07 191 */
Bongjun 6:e2ab76b2be07 192 virtual nsapi_size_or_error_t socket_send(nsapi_socket_t handle,
Bongjun 6:e2ab76b2be07 193 const void *data, nsapi_size_t size);
Bongjun 6:e2ab76b2be07 194
Bongjun 6:e2ab76b2be07 195 /** Receive data over a TCP socket
Bongjun 6:e2ab76b2be07 196 *
Bongjun 6:e2ab76b2be07 197 * The socket must be connected to a remote host. Returns the number of
Bongjun 6:e2ab76b2be07 198 * bytes received into the buffer.
Bongjun 6:e2ab76b2be07 199 *
Bongjun 6:e2ab76b2be07 200 * This call is non-blocking. If recv would block,
Bongjun 6:e2ab76b2be07 201 * NSAPI_ERROR_WOULD_BLOCK is returned immediately.
Bongjun 6:e2ab76b2be07 202 *
Bongjun 6:e2ab76b2be07 203 * @param handle Socket handle
Bongjun 6:e2ab76b2be07 204 * @param data Destination buffer for data received from the host
Bongjun 6:e2ab76b2be07 205 * @param size Size of the buffer in bytes
Bongjun 6:e2ab76b2be07 206 * @return Number of received bytes on success, negative error
Bongjun 6:e2ab76b2be07 207 * code on failure
Bongjun 6:e2ab76b2be07 208 */
Bongjun 6:e2ab76b2be07 209 virtual nsapi_size_or_error_t socket_recv(nsapi_socket_t handle,
Bongjun 6:e2ab76b2be07 210 void *data, nsapi_size_t size);
Bongjun 6:e2ab76b2be07 211
Bongjun 6:e2ab76b2be07 212 /** Send a packet over a UDP socket
Bongjun 6:e2ab76b2be07 213 *
Bongjun 6:e2ab76b2be07 214 * Sends data to the specified address. Returns the number of bytes
Bongjun 6:e2ab76b2be07 215 * sent from the buffer.
Bongjun 6:e2ab76b2be07 216 *
Bongjun 6:e2ab76b2be07 217 * This call is non-blocking. If sendto would block,
Bongjun 6:e2ab76b2be07 218 * NSAPI_ERROR_WOULD_BLOCK is returned immediately.
Bongjun 6:e2ab76b2be07 219 *
Bongjun 6:e2ab76b2be07 220 * @param handle Socket handle
Bongjun 6:e2ab76b2be07 221 * @param address The SocketAddress of the remote host
Bongjun 6:e2ab76b2be07 222 * @param data Buffer of data to send to the host
Bongjun 6:e2ab76b2be07 223 * @param size Size of the buffer in bytes
Bongjun 6:e2ab76b2be07 224 * @return Number of sent bytes on success, negative error
Bongjun 6:e2ab76b2be07 225 * code on failure
Bongjun 6:e2ab76b2be07 226 */
Bongjun 6:e2ab76b2be07 227 virtual nsapi_size_or_error_t socket_sendto(nsapi_socket_t handle, const SocketAddress &address,
Bongjun 6:e2ab76b2be07 228 const void *data, nsapi_size_t size);
Bongjun 6:e2ab76b2be07 229
Bongjun 6:e2ab76b2be07 230 /** Receive a packet over a UDP socket
Bongjun 6:e2ab76b2be07 231 *
Bongjun 6:e2ab76b2be07 232 * Receives data and stores the source address in address if address
Bongjun 6:e2ab76b2be07 233 * is not NULL. Returns the number of bytes received into the buffer.
Bongjun 6:e2ab76b2be07 234 *
Bongjun 6:e2ab76b2be07 235 * This call is non-blocking. If recvfrom would block,
Bongjun 6:e2ab76b2be07 236 * NSAPI_ERROR_WOULD_BLOCK is returned immediately.
Bongjun 6:e2ab76b2be07 237 *
Bongjun 6:e2ab76b2be07 238 * @param handle Socket handle
Bongjun 6:e2ab76b2be07 239 * @param address Destination for the source address or NULL
Bongjun 6:e2ab76b2be07 240 * @param data Destination buffer for data received from the host
Bongjun 6:e2ab76b2be07 241 * @param size Size of the buffer in bytes
Bongjun 6:e2ab76b2be07 242 * @return Number of received bytes on success, negative error
Bongjun 6:e2ab76b2be07 243 * code on failure
Bongjun 6:e2ab76b2be07 244 */
Bongjun 6:e2ab76b2be07 245 virtual nsapi_size_or_error_t socket_recvfrom(nsapi_socket_t handle, SocketAddress *address,
Bongjun 6:e2ab76b2be07 246 void *buffer, nsapi_size_t size);
Bongjun 6:e2ab76b2be07 247
Bongjun 6:e2ab76b2be07 248 /** Register a callback on state change of the socket
Bongjun 6:e2ab76b2be07 249 *
Bongjun 6:e2ab76b2be07 250 * The specified callback will be called on state changes such as when
Bongjun 6:e2ab76b2be07 251 * the socket can recv/send/accept successfully and on when an error
Bongjun 6:e2ab76b2be07 252 * occurs. The callback may also be called spuriously without reason.
Bongjun 6:e2ab76b2be07 253 *
Bongjun 6:e2ab76b2be07 254 * The callback may be called in an interrupt context and should not
Bongjun 6:e2ab76b2be07 255 * perform expensive operations such as recv/send calls.
Bongjun 6:e2ab76b2be07 256 *
Bongjun 6:e2ab76b2be07 257 * @param handle Socket handle
Bongjun 6:e2ab76b2be07 258 * @param callback Function to call on state change
Bongjun 6:e2ab76b2be07 259 * @param data Argument to pass to callback
Bongjun 6:e2ab76b2be07 260 */
Bongjun 6:e2ab76b2be07 261 virtual void socket_attach(nsapi_socket_t handle, void (*callback)(void *), void *data);
Bongjun 6:e2ab76b2be07 262
Bongjun 6:e2ab76b2be07 263 virtual NetworkStack* get_stack() {return this;}
Bongjun 6:e2ab76b2be07 264
Bongjun 6:e2ab76b2be07 265 private:
Bongjun 6:e2ab76b2be07 266 WIZnet_Chip _w5500;
Bongjun 6:e2ab76b2be07 267
Bongjun 6:e2ab76b2be07 268 char ip_string[20];
Bongjun 6:e2ab76b2be07 269 char mask_string[20];
Bongjun 6:e2ab76b2be07 270 char gw_string[20];
Bongjun 6:e2ab76b2be07 271 char mac_string[20];
Bongjun 6:e2ab76b2be07 272 bool ip_set;
Bongjun 6:e2ab76b2be07 273
Bongjun 6:e2ab76b2be07 274 int listen_port;
Bongjun 6:e2ab76b2be07 275
Bongjun 6:e2ab76b2be07 276 //void signal_event(nsapi_socket_t handle);
Bongjun 6:e2ab76b2be07 277 //void event();
Bongjun 6:e2ab76b2be07 278
Bongjun 6:e2ab76b2be07 279 //w5500 socket management
Bongjun 6:e2ab76b2be07 280 struct w5500_socket w5500_sockets[MAX_SOCK_NUM];
Bongjun 6:e2ab76b2be07 281 w5500_socket* get_sock(int fd);
Bongjun 6:e2ab76b2be07 282 void init_socks();
Bongjun 6:e2ab76b2be07 283 /*
Bongjun 6:e2ab76b2be07 284 Thread *_daemon;
Bongjun 6:e2ab76b2be07 285 void daemon();
Bongjun 6:e2ab76b2be07 286 */
Bongjun 6:e2ab76b2be07 287
Bongjun 6:e2ab76b2be07 288 };
Bongjun 6:e2ab76b2be07 289
Bongjun 6:e2ab76b2be07 290 #endif