/* LWIP implementation of NetworkInterfaceAPI * Copyright (c) 2015 ARM Limited * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ #ifndef ETHERNET_INTERFACE_H #define ETHERNET_INTERFACE_H #define IPADDR_STRLEN_MAX 16 #define MAX_SOCKET_COUNT 100 #include "nsapi.h" // Forward declaration class NetworkStack; struct simulated_socket { int id; nsapi_protocol_t proto; bool connected; SocketAddress addr; }; /** EthernetInterface class * Implementation of the NetworkStack for LWIP */ class EthernetInterface : public NetworkInterface, public NetworkStack { public: /** EthernetInterface lifetime */ EthernetInterface(); /** Set a static IP address * * Configures this network interface to use a static IP address. * Implicitly disables DHCP, which can be enabled in set_dhcp. * Requires that the network is disconnected. * * @param address Null-terminated representation of the local IP address * @param netmask Null-terminated representation of the local network mask * @param gateway Null-terminated representation of the local gateway * @return 0 on success, negative error code on failure */ virtual nsapi_error_t set_network( const char *ip_address, const char *netmask, const char *gateway); /** Enable or disable DHCP on the network * * Requires that the network is disconnected * * @param dhcp False to disable dhcp (defaults to enabled) * @return 0 on success, negative error code on failure */ virtual nsapi_error_t set_dhcp(bool dhcp); /** Start the interface * @return 0 on success, negative on failure */ virtual nsapi_error_t connect(); /** Stop the interface * @return 0 on success, negative on failure */ virtual nsapi_error_t disconnect(); /** Get the local MAC address * * Provided MAC address is intended for info or debug purposes and * may not be provided if the underlying network interface does not * provide a MAC address * * @return Null-terminated representation of the local MAC address * or null if no MAC address is available */ virtual const char *get_mac_address(); /** Get the local IP address * * @return Null-terminated representation of the local IP address * or null if no IP address has been recieved */ virtual const char *get_ip_address(); /** Get the local network mask * * @return Null-terminated representation of the local network mask * or null if no network mask has been recieved */ virtual const char *get_netmask(); /** Get the local gateways * * @return Null-terminated representation of the local gateway * or null if no network mask has been recieved */ virtual const char *get_gateway(); /** Translates a hostname to an IP address with specific version * * The hostname may be either a domain name or an IP address. If the * hostname is an IP address, no network transactions will be performed. * * If no stack-specific DNS resolution is provided, the hostname * will be resolve using a UDP socket on the stack. * * @param address Destination for the host SocketAddress * @param host Hostname to resolve * @param version IP version of address to resolve, NSAPI_UNSPEC indicates * version is chosen by the stack (defaults to NSAPI_UNSPEC) * @return 0 on success, negative error code on failure */ using NetworkInterface::gethostbyname; protected: /** Open a socket * @param handle Handle in which to store new socket * @param proto Type of socket to open, NSAPI_TCP or NSAPI_UDP * @return 0 on success, negative on failure */ virtual int socket_open(void **handle, nsapi_protocol_t proto); /** Close the socket * @param handle Socket handle * @return 0 on success, negative on failure * @note On failure, any memory associated with the socket must still * be cleaned up */ virtual int socket_close(void *handle); /** Bind a server socket to a specific port * @param handle Socket handle * @param address Local address to listen for incoming connections on * @return 0 on success, negative on failure. */ virtual int socket_bind(void *handle, const SocketAddress &address); /** Start listening for incoming connections * @param handle Socket handle * @param backlog Number of pending connections that can be queued up at any * one time [Default: 1] * @return 0 on success, negative on failure */ virtual int socket_listen(void *handle, int backlog); /** Connects this TCP socket to the server * @param handle Socket handle * @param address SocketAddress to connect to * @return 0 on success, negative on failure */ virtual int socket_connect(void *handle, const SocketAddress &address); /** Accept a new connection. * @param handle Handle in which to store new socket * @param server Socket handle to server to accept from * @return 0 on success, negative on failure * @note This call is not-blocking, if this call would block, must * immediately return NSAPI_ERROR_WOULD_WAIT */ virtual int socket_accept(void *handle, void **socket, SocketAddress *address); /** Send data to the remote host * @param handle Socket handle * @param data The buffer to send to the host * @param size The length of the buffer to send * @return Number of written bytes on success, negative on failure * @note This call is not-blocking, if this call would block, must * immediately return NSAPI_ERROR_WOULD_WAIT */ virtual int socket_send(void *handle, const void *data, unsigned size); /** Receive data from the remote host * @param handle Socket handle * @param data The buffer in which to store the data received from the host * @param size The maximum length of the buffer * @return Number of received bytes on success, negative on failure * @note This call is not-blocking, if this call would block, must * immediately return NSAPI_ERROR_WOULD_WAIT */ virtual int socket_recv(void *handle, void *data, unsigned size); /** Send a packet to a remote endpoint * @param handle Socket handle * @param address The remote SocketAddress * @param data The packet to be sent * @param size The length of the packet to be sent * @return The number of written bytes on success, negative on failure * @note This call is not-blocking, if this call would block, must * immediately return NSAPI_ERROR_WOULD_WAIT */ virtual int socket_sendto(void *handle, const SocketAddress &address, const void *data, unsigned size); /** Receive a packet from a remote endpoint * @param handle Socket handle * @param address Destination for the remote SocketAddress or null * @param buffer The buffer for storing the incoming packet data * If a packet is too long to fit in the supplied buffer, * excess bytes are discarded * @param size The length of the buffer * @return The number of received bytes on success, negative on failure * @note This call is not-blocking, if this call would block, must * immediately return NSAPI_ERROR_WOULD_WAIT */ virtual int socket_recvfrom(void *handle, SocketAddress *address, void *buffer, unsigned size); /** Register a callback on state change of the socket * @param handle Socket handle * @param callback Function to call on state change * @param data Argument to pass to callback * @note Callback may be called in an interrupt context. */ virtual void socket_attach(void *handle, void (*callback)(void *), void *data); protected: /** Provide access to the underlying stack * * @return The underlying network stack */ virtual NetworkStack *get_stack() { return this; } bool _dhcp; char _ip_address[IPADDR_STRLEN_MAX]; char _netmask[NSAPI_IPv4_SIZE]; char _gateway[NSAPI_IPv4_SIZE]; struct { void (*callback)(void *); void *data; } _cbs[MAX_SOCKET_COUNT]; }; #endif