Kev Mann / mbed-dev-OS5_10_4

RTC auf true

features/lwipstack/LWIPStack.h@2:7aab896b1a3b, 2019-03-13 (annotated)

Committer:
kevman
Date:
Wed Mar 13 11:03:24 2019 +0000
Revision:
2:7aab896b1a3b
Parent:
0:38ceb79fef03 
2019-03-13

Who changed what in which revision?

UserRevisionLine numberNew contents of line
kevman 0:38ceb79fef03 1 /* mbed Microcontroller Library
kevman 0:38ceb79fef03 2 * Copyright (c) 2017 ARM Limited
kevman 0:38ceb79fef03 3 *
kevman 0:38ceb79fef03 4 * Licensed under the Apache License, Version 2.0 (the "License");
kevman 0:38ceb79fef03 5 * you may not use this file except in compliance with the License.
kevman 0:38ceb79fef03 6 * You may obtain a copy of the License at
kevman 0:38ceb79fef03 7 *
kevman 0:38ceb79fef03 8 * http://www.apache.org/licenses/LICENSE-2.0
kevman 0:38ceb79fef03 9 *
kevman 0:38ceb79fef03 10 * Unless required by applicable law or agreed to in writing, software
kevman 0:38ceb79fef03 11 * distributed under the License is distributed on an "AS IS" BASIS,
kevman 0:38ceb79fef03 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
kevman 0:38ceb79fef03 13 * See the License for the specific language governing permissions and
kevman 0:38ceb79fef03 14 * limitations under the License.
kevman 0:38ceb79fef03 15 */
kevman 0:38ceb79fef03 16
kevman 0:38ceb79fef03 17 #ifndef LWIPSTACK_H_
kevman 0:38ceb79fef03 18 #define LWIPSTACK_H_
kevman 0:38ceb79fef03 19
kevman 0:38ceb79fef03 20 #include "lwip/tcpip.h"
kevman 0:38ceb79fef03 21 #include "lwip/tcp.h"
kevman 0:38ceb79fef03 22 #include "lwip/ip.h"
kevman 0:38ceb79fef03 23 #include "lwip/api.h"
kevman 0:38ceb79fef03 24 #include "netif/etharp.h"
kevman 0:38ceb79fef03 25 #include "lwip/ethip6.h"
kevman 0:38ceb79fef03 26 #include "netsocket/nsapi_types.h"
kevman 0:38ceb79fef03 27 #include "netsocket/EMAC.h"
kevman 0:38ceb79fef03 28 #include "netsocket/OnboardNetworkStack.h"
kevman 0:38ceb79fef03 29 #include "LWIPMemoryManager.h"
kevman 0:38ceb79fef03 30
kevman 0:38ceb79fef03 31
kevman 0:38ceb79fef03 32 class LWIP : public OnboardNetworkStack, private mbed::NonCopyable<LWIP> {
kevman 0:38ceb79fef03 33 public:
kevman 0:38ceb79fef03 34
kevman 0:38ceb79fef03 35 static LWIP &get_instance();
kevman 0:38ceb79fef03 36
kevman 0:38ceb79fef03 37 class Interface : public OnboardNetworkStack::Interface {
kevman 0:38ceb79fef03 38 public:
kevman 0:38ceb79fef03 39 /** Connect the interface to the network
kevman 0:38ceb79fef03 40 *
kevman 0:38ceb79fef03 41 * Sets up a connection on specified network interface, using DHCP or provided network details. If the @a dhcp is set to
kevman 0:38ceb79fef03 42 * true all the remaining parameters are ignored.
kevman 0:38ceb79fef03 43 *
kevman 0:38ceb79fef03 44 * @param dhcp true if the network details should be acquired using DHCP
kevman 0:38ceb79fef03 45 * @param ip IP address to be used for the interface as "W:X:Y:Z" or NULL
kevman 0:38ceb79fef03 46 * @param netmask Net mask to be used for the interface as "W:X:Y:Z" or NULL
kevman 0:38ceb79fef03 47 * @param gw Gateway address to be used for the interface as "W:X:Y:Z" or NULL
kevman 0:38ceb79fef03 48 * @param stack Allow manual selection of IPv4 and/or IPv6.
kevman 0:38ceb79fef03 49 * @param blocking Specify whether bringup blocks for connection completion.
kevman 0:38ceb79fef03 50 * @return NSAPI_ERROR_OK on success, or error code
kevman 0:38ceb79fef03 51 */
kevman 0:38ceb79fef03 52 virtual nsapi_error_t bringup(bool dhcp, const char *ip,
kevman 0:38ceb79fef03 53 const char *netmask, const char *gw,
kevman 0:38ceb79fef03 54 nsapi_ip_stack_t stack = DEFAULT_STACK,
kevman 0:38ceb79fef03 55 bool blocking = true
kevman 0:38ceb79fef03 56 );
kevman 0:38ceb79fef03 57
kevman 0:38ceb79fef03 58 /** Disconnect interface from the network
kevman 0:38ceb79fef03 59 *
kevman 0:38ceb79fef03 60 * After this call the network interface is inactive, to use it again user needs to call @a mbed_ipstack_bringup again.
kevman 0:38ceb79fef03 61 *
kevman 0:38ceb79fef03 62 * @return NSAPI_ERROR_OK on success, or error code
kevman 0:38ceb79fef03 63 */
kevman 0:38ceb79fef03 64 virtual nsapi_error_t bringdown();
kevman 0:38ceb79fef03 65
kevman 0:38ceb79fef03 66 /** Register callback for status reporting
kevman 0:38ceb79fef03 67 *
kevman 0:38ceb79fef03 68 * The specified status callback function will be called on status changes
kevman 0:38ceb79fef03 69 * on the network. The parameters on the callback are the event type and
kevman 0:38ceb79fef03 70 * event-type dependent reason parameter.
kevman 0:38ceb79fef03 71 *
kevman 0:38ceb79fef03 72 * @param status_cb The callback for status changes
kevman 0:38ceb79fef03 73 */
kevman 0:38ceb79fef03 74 virtual void attach(mbed::Callback<void(nsapi_event_t, intptr_t)> status_cb);
kevman 0:38ceb79fef03 75
kevman 0:38ceb79fef03 76 /** Get the connection status
kevman 0:38ceb79fef03 77 *
kevman 0:38ceb79fef03 78 * @return The connection status according to ConnectionStatusType
kevman 0:38ceb79fef03 79 */
kevman 0:38ceb79fef03 80 virtual nsapi_connection_status_t get_connection_status() const;
kevman 0:38ceb79fef03 81
kevman 0:38ceb79fef03 82 /** Return MAC address of the network interface
kevman 0:38ceb79fef03 83 *
kevman 0:38ceb79fef03 84 * @return MAC address as "V:W:X:Y:Z"
kevman 0:38ceb79fef03 85 */
kevman 0:38ceb79fef03 86 virtual char *get_mac_address(char *buf, nsapi_size_t buflen);
kevman 0:38ceb79fef03 87
kevman 0:38ceb79fef03 88 /** Copies IP address of the network interface to user supplied buffer
kevman 0:38ceb79fef03 89 *
kevman 0:38ceb79fef03 90 * @param emac EMAC HAL implementation for this network interface
kevman 0:38ceb79fef03 91 * @param buf buffer to which IP address will be copied as "W:X:Y:Z"
kevman 0:38ceb79fef03 92 * @param buflen size of supplied buffer
kevman 0:38ceb79fef03 93 * @return Pointer to a buffer, or NULL if the buffer is too small
kevman 0:38ceb79fef03 94 */
kevman 0:38ceb79fef03 95 virtual char *get_ip_address(char *buf, nsapi_size_t buflen);
kevman 0:38ceb79fef03 96
kevman 0:38ceb79fef03 97 /** Copies netmask of the network interface to user supplied buffer
kevman 0:38ceb79fef03 98 *
kevman 0:38ceb79fef03 99 * @param buf buffer to which netmask will be copied as "W:X:Y:Z"
kevman 0:38ceb79fef03 100 * @param buflen size of supplied buffer
kevman 0:38ceb79fef03 101 * @return Pointer to a buffer, or NULL if the buffer is too small
kevman 0:38ceb79fef03 102 */
kevman 0:38ceb79fef03 103 virtual char *get_netmask(char *buf, nsapi_size_t buflen);
kevman 0:38ceb79fef03 104
kevman 0:38ceb79fef03 105 /** Copies gateway address of the network interface to user supplied buffer
kevman 0:38ceb79fef03 106 *
kevman 0:38ceb79fef03 107 * @param buf buffer to which gateway address will be copied as "W:X:Y:Z"
kevman 0:38ceb79fef03 108 * @param buflen size of supplied buffer
kevman 0:38ceb79fef03 109 * @return Pointer to a buffer, or NULL if the buffer is too small
kevman 0:38ceb79fef03 110 */
kevman 0:38ceb79fef03 111 virtual char *get_gateway(char *buf, nsapi_size_t buflen);
kevman 0:38ceb79fef03 112
kevman 0:38ceb79fef03 113 private:
kevman 0:38ceb79fef03 114 friend LWIP;
kevman 0:38ceb79fef03 115
kevman 0:38ceb79fef03 116 Interface();
kevman 0:38ceb79fef03 117
kevman 0:38ceb79fef03 118 nsapi_error_t set_dhcp();
kevman 0:38ceb79fef03 119 static void netif_link_irq(struct netif *netif);
kevman 0:38ceb79fef03 120 static void netif_status_irq(struct netif *netif);
kevman 0:38ceb79fef03 121 static Interface *our_if_from_netif(struct netif *netif);
kevman 0:38ceb79fef03 122
kevman 0:38ceb79fef03 123 #if LWIP_ETHERNET
kevman 0:38ceb79fef03 124 static err_t emac_low_level_output(struct netif *netif, struct pbuf *p);
kevman 0:38ceb79fef03 125 void emac_input(emac_mem_buf_t *buf);
kevman 0:38ceb79fef03 126 void emac_state_change(bool up);
kevman 0:38ceb79fef03 127 #if LWIP_IGMP
kevman 0:38ceb79fef03 128 static err_t emac_igmp_mac_filter(struct netif *netif, const ip4_addr_t *group, enum netif_mac_filter_action action);
kevman 0:38ceb79fef03 129 #endif
kevman 0:38ceb79fef03 130 #if LWIP_IPV6_MLD
kevman 0:38ceb79fef03 131 static err_t emac_mld_mac_filter(struct netif *netif, const ip6_addr_t *group, enum netif_mac_filter_action action);
kevman 0:38ceb79fef03 132 #endif
kevman 0:38ceb79fef03 133
kevman 0:38ceb79fef03 134 static err_t emac_if_init(struct netif *netif);
kevman 0:38ceb79fef03 135 #endif
kevman 0:38ceb79fef03 136
kevman 0:38ceb79fef03 137 union {
kevman 0:38ceb79fef03 138 #if LWIP_ETHERNET
kevman 0:38ceb79fef03 139 EMAC *emac; /**< HW specific emac implementation */
kevman 0:38ceb79fef03 140 #endif
kevman 0:38ceb79fef03 141 void *hw; /**< alternative implementation pointer - used for PPP */
kevman 0:38ceb79fef03 142 };
kevman 0:38ceb79fef03 143
kevman 0:38ceb79fef03 144 mbed_rtos_storage_semaphore_t linked_sem;
kevman 0:38ceb79fef03 145 osSemaphoreId_t linked;
kevman 0:38ceb79fef03 146 mbed_rtos_storage_semaphore_t unlinked_sem;
kevman 0:38ceb79fef03 147 osSemaphoreId_t unlinked;
kevman 0:38ceb79fef03 148 mbed_rtos_storage_semaphore_t has_any_addr_sem;
kevman 0:38ceb79fef03 149 osSemaphoreId_t has_any_addr;
kevman 0:38ceb79fef03 150 #define HAS_ANY_ADDR 1
kevman 0:38ceb79fef03 151 #if PREF_ADDR_TIMEOUT
kevman 0:38ceb79fef03 152 mbed_rtos_storage_semaphore_t has_pref_addr_sem;
kevman 0:38ceb79fef03 153 osSemaphoreId_t has_pref_addr;
kevman 0:38ceb79fef03 154 #define HAS_PREF_ADDR 2
kevman 0:38ceb79fef03 155 #endif
kevman 0:38ceb79fef03 156 #if BOTH_ADDR_TIMEOUT
kevman 0:38ceb79fef03 157 mbed_rtos_storage_semaphore_t has_both_addr_sem;
kevman 0:38ceb79fef03 158 osSemaphoreId_t has_both_addr;
kevman 0:38ceb79fef03 159 #define HAS_BOTH_ADDR 4
kevman 0:38ceb79fef03 160 #endif
kevman 0:38ceb79fef03 161 char has_addr_state;
kevman 0:38ceb79fef03 162 nsapi_connection_status_t connected;
kevman 0:38ceb79fef03 163 bool dhcp_started;
kevman 0:38ceb79fef03 164 bool dhcp_has_to_be_set;
kevman 0:38ceb79fef03 165 bool blocking;
kevman 0:38ceb79fef03 166 bool ppp;
kevman 0:38ceb79fef03 167 mbed::Callback<void(nsapi_event_t, intptr_t)> client_callback;
kevman 0:38ceb79fef03 168 struct netif netif;
kevman 0:38ceb79fef03 169 static Interface *list;
kevman 0:38ceb79fef03 170 Interface *next;
kevman 0:38ceb79fef03 171 LWIPMemoryManager *memory_manager;
kevman 0:38ceb79fef03 172 };
kevman 0:38ceb79fef03 173
kevman 0:38ceb79fef03 174 /** Register a network interface with the IP stack
kevman 0:38ceb79fef03 175 *
kevman 0:38ceb79fef03 176 * Connects EMAC layer with the IP stack and initializes all the required infrastructure.
kevman 0:38ceb79fef03 177 * This function should be called only once for each available interface.
kevman 0:38ceb79fef03 178 *
kevman 0:38ceb79fef03 179 * @param emac EMAC HAL implementation for this network interface
kevman 0:38ceb79fef03 180 * @param default_if true if the interface should be treated as the default one
kevman 0:38ceb79fef03 181 * @param[out] interface_out pointer to stack interface object controlling the EMAC
kevman 0:38ceb79fef03 182 * @return NSAPI_ERROR_OK on success, or error code
kevman 0:38ceb79fef03 183 */
kevman 0:38ceb79fef03 184 virtual nsapi_error_t add_ethernet_interface(EMAC &emac, bool default_if, OnboardNetworkStack::Interface **interface_out);
kevman 0:38ceb79fef03 185
kevman 0:38ceb79fef03 186 /** Register a PPP interface with the IP stack
kevman 0:38ceb79fef03 187 *
kevman 0:38ceb79fef03 188 * Connects PPP layer with the IP stack and initializes all the required infrastructure.
kevman 0:38ceb79fef03 189 * This function should be called only once for each available interface.
kevman 0:38ceb79fef03 190 *
kevman 0:38ceb79fef03 191 * This is an internal function that links ppp_lwip.cpp to mbed_ipstack_lwip.cpp,
kevman 0:38ceb79fef03 192 * once a driver starts it via the nsapi_ppp.h API.
kevman 0:38ceb79fef03 193 *
kevman 0:38ceb79fef03 194 * Ultimately the nsapi_ppp.h API will be deprecated, and there will be a
kevman 0:38ceb79fef03 195 * mbed_ipstack_add_ppp_interface() replacing nsapi_ppp_connect().
kevman 0:38ceb79fef03 196 *
kevman 0:38ceb79fef03 197 * @param pcb PPP implementation specific user data; will be passed to PPP callbacks
kevman 0:38ceb79fef03 198 * @param default_if true if the interface should be treated as the default one
kevman 0:38ceb79fef03 199 * @param stack Allow manual selection of IPv4 and/or IPv6
kevman 0:38ceb79fef03 200 * @param[out] interface_out set to interface handle that must be passed to subsequent mbed_stack calls
kevman 0:38ceb79fef03 201 * @return NSAPI_ERROR_OK on success, or error code
kevman 0:38ceb79fef03 202 */
kevman 0:38ceb79fef03 203 nsapi_error_t _add_ppp_interface(void *pcb, bool default_if, nsapi_ip_stack_t stack, LWIP::Interface **interface_out);
kevman 0:38ceb79fef03 204
kevman 0:38ceb79fef03 205 /** Get a domain name server from a list of servers to query
kevman 0:38ceb79fef03 206 *
kevman 0:38ceb79fef03 207 * Returns a DNS server address for a index. If returns error no more
kevman 0:38ceb79fef03 208 * DNS servers to read.
kevman 0:38ceb79fef03 209 *
kevman 0:38ceb79fef03 210 * @param index Index of the DNS server, starts from zero
kevman 0:38ceb79fef03 211 * @param address Destination for the host address
kevman 0:38ceb79fef03 212 * @return 0 on success, negative error code on failure
kevman 0:38ceb79fef03 213 */
kevman 0:38ceb79fef03 214 virtual nsapi_error_t get_dns_server(int index, SocketAddress *address);
kevman 0:38ceb79fef03 215
kevman 0:38ceb79fef03 216 /** Get the local IP address
kevman 0:38ceb79fef03 217 *
kevman 0:38ceb79fef03 218 * @return Null-terminated representation of the local IP address
kevman 0:38ceb79fef03 219 * or null if not yet connected
kevman 0:38ceb79fef03 220 */
kevman 0:38ceb79fef03 221 virtual const char *get_ip_address();
kevman 0:38ceb79fef03 222
kevman 0:38ceb79fef03 223 protected:
kevman 0:38ceb79fef03 224 LWIP();
kevman 0:38ceb79fef03 225 virtual ~LWIP() {}
kevman 0:38ceb79fef03 226
kevman 0:38ceb79fef03 227 /** Opens a socket
kevman 0:38ceb79fef03 228 *
kevman 0:38ceb79fef03 229 * Creates a network socket and stores it in the specified handle.
kevman 0:38ceb79fef03 230 * The handle must be passed to following calls on the socket.
kevman 0:38ceb79fef03 231 *
kevman 0:38ceb79fef03 232 * A stack may have a finite number of sockets, in this case
kevman 0:38ceb79fef03 233 * NSAPI_ERROR_NO_SOCKET is returned if no socket is available.
kevman 0:38ceb79fef03 234 *
kevman 0:38ceb79fef03 235 * @param handle Destination for the handle to a newly created socket
kevman 0:38ceb79fef03 236 * @param proto Protocol of socket to open, NSAPI_TCP or NSAPI_UDP
kevman 0:38ceb79fef03 237 * @return 0 on success, negative error code on failure
kevman 0:38ceb79fef03 238 */
kevman 0:38ceb79fef03 239 virtual nsapi_error_t socket_open(nsapi_socket_t *handle, nsapi_protocol_t proto);
kevman 0:38ceb79fef03 240
kevman 0:38ceb79fef03 241 /** Close the socket
kevman 0:38ceb79fef03 242 *
kevman 0:38ceb79fef03 243 * Closes any open connection and deallocates any memory associated
kevman 0:38ceb79fef03 244 * with the socket.
kevman 0:38ceb79fef03 245 *
kevman 0:38ceb79fef03 246 * @param handle Socket handle
kevman 0:38ceb79fef03 247 * @return 0 on success, negative error code on failure
kevman 0:38ceb79fef03 248 */
kevman 0:38ceb79fef03 249 virtual nsapi_error_t socket_close(nsapi_socket_t handle);
kevman 0:38ceb79fef03 250
kevman 0:38ceb79fef03 251 /** Bind a specific address to a socket
kevman 0:38ceb79fef03 252 *
kevman 0:38ceb79fef03 253 * Binding a socket specifies the address and port on which to recieve
kevman 0:38ceb79fef03 254 * data. If the IP address is zeroed, only the port is bound.
kevman 0:38ceb79fef03 255 *
kevman 0:38ceb79fef03 256 * @param handle Socket handle
kevman 0:38ceb79fef03 257 * @param address Local address to bind
kevman 0:38ceb79fef03 258 * @return 0 on success, negative error code on failure.
kevman 0:38ceb79fef03 259 */
kevman 0:38ceb79fef03 260 virtual nsapi_error_t socket_bind(nsapi_socket_t handle, const SocketAddress &address);
kevman 0:38ceb79fef03 261
kevman 0:38ceb79fef03 262 /** Listen for connections on a TCP socket
kevman 0:38ceb79fef03 263 *
kevman 0:38ceb79fef03 264 * Marks the socket as a passive socket that can be used to accept
kevman 0:38ceb79fef03 265 * incoming connections.
kevman 0:38ceb79fef03 266 *
kevman 0:38ceb79fef03 267 * @param handle Socket handle
kevman 0:38ceb79fef03 268 * @param backlog Number of pending connections that can be queued
kevman 0:38ceb79fef03 269 * simultaneously
kevman 0:38ceb79fef03 270 * @return 0 on success, negative error code on failure
kevman 0:38ceb79fef03 271 */
kevman 0:38ceb79fef03 272 virtual nsapi_error_t socket_listen(nsapi_socket_t handle, int backlog);
kevman 0:38ceb79fef03 273
kevman 0:38ceb79fef03 274 /** Connects TCP socket to a remote host
kevman 0:38ceb79fef03 275 *
kevman 0:38ceb79fef03 276 * Initiates a connection to a remote server specified by the
kevman 0:38ceb79fef03 277 * indicated address.
kevman 0:38ceb79fef03 278 *
kevman 0:38ceb79fef03 279 * @param handle Socket handle
kevman 0:38ceb79fef03 280 * @param address The SocketAddress of the remote host
kevman 0:38ceb79fef03 281 * @return 0 on success, negative error code on failure
kevman 0:38ceb79fef03 282 */
kevman 0:38ceb79fef03 283 virtual nsapi_error_t socket_connect(nsapi_socket_t handle, const SocketAddress &address);
kevman 0:38ceb79fef03 284
kevman 0:38ceb79fef03 285 /** Accepts a connection on a TCP socket
kevman 0:38ceb79fef03 286 *
kevman 0:38ceb79fef03 287 * The server socket must be bound and set to listen for connections.
kevman 0:38ceb79fef03 288 * On a new connection, creates a network socket and stores it in the
kevman 0:38ceb79fef03 289 * specified handle. The handle must be passed to following calls on
kevman 0:38ceb79fef03 290 * the socket.
kevman 0:38ceb79fef03 291 *
kevman 0:38ceb79fef03 292 * A stack may have a finite number of sockets, in this case
kevman 0:38ceb79fef03 293 * NSAPI_ERROR_NO_SOCKET is returned if no socket is available.
kevman 0:38ceb79fef03 294 *
kevman 0:38ceb79fef03 295 * This call is non-blocking. If accept would block,
kevman 0:38ceb79fef03 296 * NSAPI_ERROR_WOULD_BLOCK is returned immediately.
kevman 0:38ceb79fef03 297 *
kevman 0:38ceb79fef03 298 * @param server Socket handle to server to accept from
kevman 0:38ceb79fef03 299 * @param handle Destination for a handle to the newly created socket
kevman 0:38ceb79fef03 300 * @param address Destination for the remote address or NULL
kevman 0:38ceb79fef03 301 * @return 0 on success, negative error code on failure
kevman 0:38ceb79fef03 302 */
kevman 0:38ceb79fef03 303 virtual nsapi_error_t socket_accept(nsapi_socket_t server,
kevman 0:38ceb79fef03 304 nsapi_socket_t *handle, SocketAddress *address=0);
kevman 0:38ceb79fef03 305
kevman 0:38ceb79fef03 306 /** Send data over a TCP socket
kevman 0:38ceb79fef03 307 *
kevman 0:38ceb79fef03 308 * The socket must be connected to a remote host. Returns the number of
kevman 0:38ceb79fef03 309 * bytes sent from the buffer.
kevman 0:38ceb79fef03 310 *
kevman 0:38ceb79fef03 311 * This call is non-blocking. If send would block,
kevman 0:38ceb79fef03 312 * NSAPI_ERROR_WOULD_BLOCK is returned immediately.
kevman 0:38ceb79fef03 313 *
kevman 0:38ceb79fef03 314 * @param handle Socket handle
kevman 0:38ceb79fef03 315 * @param data Buffer of data to send to the host
kevman 0:38ceb79fef03 316 * @param size Size of the buffer in bytes
kevman 0:38ceb79fef03 317 * @return Number of sent bytes on success, negative error
kevman 0:38ceb79fef03 318 * code on failure
kevman 0:38ceb79fef03 319 */
kevman 0:38ceb79fef03 320 virtual nsapi_size_or_error_t socket_send(nsapi_socket_t handle,
kevman 0:38ceb79fef03 321 const void *data, nsapi_size_t size);
kevman 0:38ceb79fef03 322
kevman 0:38ceb79fef03 323 /** Receive data over a TCP socket
kevman 0:38ceb79fef03 324 *
kevman 0:38ceb79fef03 325 * The socket must be connected to a remote host. Returns the number of
kevman 0:38ceb79fef03 326 * bytes received into the buffer.
kevman 0:38ceb79fef03 327 *
kevman 0:38ceb79fef03 328 * This call is non-blocking. If recv would block,
kevman 0:38ceb79fef03 329 * NSAPI_ERROR_WOULD_BLOCK is returned immediately.
kevman 0:38ceb79fef03 330 *
kevman 0:38ceb79fef03 331 * @param handle Socket handle
kevman 0:38ceb79fef03 332 * @param data Destination buffer for data received from the host
kevman 0:38ceb79fef03 333 * @param size Size of the buffer in bytes
kevman 0:38ceb79fef03 334 * @return Number of received bytes on success, negative error
kevman 0:38ceb79fef03 335 * code on failure
kevman 0:38ceb79fef03 336 */
kevman 0:38ceb79fef03 337 virtual nsapi_size_or_error_t socket_recv(nsapi_socket_t handle,
kevman 0:38ceb79fef03 338 void *data, nsapi_size_t size);
kevman 0:38ceb79fef03 339
kevman 0:38ceb79fef03 340 /** Send a packet over a UDP socket
kevman 0:38ceb79fef03 341 *
kevman 0:38ceb79fef03 342 * Sends data to the specified address. Returns the number of bytes
kevman 0:38ceb79fef03 343 * sent from the buffer.
kevman 0:38ceb79fef03 344 *
kevman 0:38ceb79fef03 345 * This call is non-blocking. If sendto would block,
kevman 0:38ceb79fef03 346 * NSAPI_ERROR_WOULD_BLOCK is returned immediately.
kevman 0:38ceb79fef03 347 *
kevman 0:38ceb79fef03 348 * @param handle Socket handle
kevman 0:38ceb79fef03 349 * @param address The SocketAddress of the remote host
kevman 0:38ceb79fef03 350 * @param data Buffer of data to send to the host
kevman 0:38ceb79fef03 351 * @param size Size of the buffer in bytes
kevman 0:38ceb79fef03 352 * @return Number of sent bytes on success, negative error
kevman 0:38ceb79fef03 353 * code on failure
kevman 0:38ceb79fef03 354 */
kevman 0:38ceb79fef03 355 virtual nsapi_size_or_error_t socket_sendto(nsapi_socket_t handle, const SocketAddress &address,
kevman 0:38ceb79fef03 356 const void *data, nsapi_size_t size);
kevman 0:38ceb79fef03 357
kevman 0:38ceb79fef03 358 /** Receive a packet over a UDP socket
kevman 0:38ceb79fef03 359 *
kevman 0:38ceb79fef03 360 * Receives data and stores the source address in address if address
kevman 0:38ceb79fef03 361 * is not NULL. Returns the number of bytes received into the buffer.
kevman 0:38ceb79fef03 362 *
kevman 0:38ceb79fef03 363 * This call is non-blocking. If recvfrom would block,
kevman 0:38ceb79fef03 364 * NSAPI_ERROR_WOULD_BLOCK is returned immediately.
kevman 0:38ceb79fef03 365 *
kevman 0:38ceb79fef03 366 * @param handle Socket handle
kevman 0:38ceb79fef03 367 * @param address Destination for the source address or NULL
kevman 0:38ceb79fef03 368 * @param buffer Destination buffer for data received from the host
kevman 0:38ceb79fef03 369 * @param size Size of the buffer in bytes
kevman 0:38ceb79fef03 370 * @return Number of received bytes on success, negative error
kevman 0:38ceb79fef03 371 * code on failure
kevman 0:38ceb79fef03 372 */
kevman 0:38ceb79fef03 373 virtual nsapi_size_or_error_t socket_recvfrom(nsapi_socket_t handle, SocketAddress *address,
kevman 0:38ceb79fef03 374 void *buffer, nsapi_size_t size);
kevman 0:38ceb79fef03 375
kevman 0:38ceb79fef03 376 /** Register a callback on state change of the socket
kevman 0:38ceb79fef03 377 *
kevman 0:38ceb79fef03 378 * The specified callback will be called on state changes such as when
kevman 0:38ceb79fef03 379 * the socket can recv/send/accept successfully and on when an error
kevman 0:38ceb79fef03 380 * occurs. The callback may also be called spuriously without reason.
kevman 0:38ceb79fef03 381 *
kevman 0:38ceb79fef03 382 * The callback may be called in an interrupt context and should not
kevman 0:38ceb79fef03 383 * perform expensive operations such as recv/send calls.
kevman 0:38ceb79fef03 384 *
kevman 0:38ceb79fef03 385 * @param handle Socket handle
kevman 0:38ceb79fef03 386 * @param callback Function to call on state change
kevman 0:38ceb79fef03 387 * @param data Argument to pass to callback
kevman 0:38ceb79fef03 388 */
kevman 0:38ceb79fef03 389 virtual void socket_attach(nsapi_socket_t handle, void (*callback)(void *), void *data);
kevman 0:38ceb79fef03 390
kevman 0:38ceb79fef03 391 /* Set stack-specific socket options
kevman 0:38ceb79fef03 392 *
kevman 0:38ceb79fef03 393 * The setsockopt allow an application to pass stack-specific hints
kevman 0:38ceb79fef03 394 * to the underlying stack. For unsupported options,
kevman 0:38ceb79fef03 395 * NSAPI_ERROR_UNSUPPORTED is returned and the socket is unmodified.
kevman 0:38ceb79fef03 396 *
kevman 0:38ceb79fef03 397 * @param handle Socket handle
kevman 0:38ceb79fef03 398 * @param level Stack-specific protocol level
kevman 0:38ceb79fef03 399 * @param optname Stack-specific option identifier
kevman 0:38ceb79fef03 400 * @param optval Option value
kevman 0:38ceb79fef03 401 * @param optlen Length of the option value
kevman 0:38ceb79fef03 402 * @return 0 on success, negative error code on failure
kevman 0:38ceb79fef03 403 */
kevman 0:38ceb79fef03 404 virtual nsapi_error_t setsockopt(nsapi_socket_t handle, int level,
kevman 0:38ceb79fef03 405 int optname, const void *optval, unsigned optlen);
kevman 0:38ceb79fef03 406
kevman 0:38ceb79fef03 407 /* Get stack-specific socket options
kevman 0:38ceb79fef03 408 *
kevman 0:38ceb79fef03 409 * The getstackopt allow an application to retrieve stack-specific hints
kevman 0:38ceb79fef03 410 * from the underlying stack. For unsupported options,
kevman 0:38ceb79fef03 411 * NSAPI_ERROR_UNSUPPORTED is returned and optval is unmodified.
kevman 0:38ceb79fef03 412 *
kevman 0:38ceb79fef03 413 * @param handle Socket handle
kevman 0:38ceb79fef03 414 * @param level Stack-specific protocol level
kevman 0:38ceb79fef03 415 * @param optname Stack-specific option identifier
kevman 0:38ceb79fef03 416 * @param optval Destination for option value
kevman 0:38ceb79fef03 417 * @param optlen Length of the option value
kevman 0:38ceb79fef03 418 * @return 0 on success, negative error code on failure
kevman 0:38ceb79fef03 419 */
kevman 0:38ceb79fef03 420 virtual nsapi_error_t getsockopt(nsapi_socket_t handle, int level,
kevman 0:38ceb79fef03 421 int optname, void *optval, unsigned *optlen);
kevman 0:38ceb79fef03 422 private:
kevman 0:38ceb79fef03 423
kevman 0:38ceb79fef03 424 /** Call in callback
kevman 0:38ceb79fef03 425 *
kevman 0:38ceb79fef03 426 * Callback is used to call the call in method of the network stack.
kevman 0:38ceb79fef03 427 */
kevman 0:38ceb79fef03 428 typedef mbed::Callback<nsapi_error_t (int delay_ms, mbed::Callback<void()> user_cb)> call_in_callback_cb_t;
kevman 0:38ceb79fef03 429
kevman 0:38ceb79fef03 430 /** Get a call in callback
kevman 0:38ceb79fef03 431 *
kevman 0:38ceb79fef03 432 * Get a call in callback from the network stack context.
kevman 0:38ceb79fef03 433 *
kevman 0:38ceb79fef03 434 * Callback should not take more than 10ms to execute, otherwise it might
kevman 0:38ceb79fef03 435 * prevent underlying thread processing. A portable user of the callback
kevman 0:38ceb79fef03 436 * should not make calls to network operations due to stack size limitations.
kevman 0:38ceb79fef03 437 * The callback should not perform expensive operations such as socket recv/send
kevman 0:38ceb79fef03 438 * calls or blocking operations.
kevman 0:38ceb79fef03 439 *
kevman 0:38ceb79fef03 440 * @return Call in callback
kevman 0:38ceb79fef03 441 */
kevman 0:38ceb79fef03 442 virtual call_in_callback_cb_t get_call_in_callback();
kevman 0:38ceb79fef03 443
kevman 0:38ceb79fef03 444 /** Call a callback after a delay
kevman 0:38ceb79fef03 445 *
kevman 0:38ceb79fef03 446 * Call a callback from the network stack context after a delay. If function
kevman 0:38ceb79fef03 447 * returns error callback will not be called.
kevman 0:38ceb79fef03 448 *
kevman 0:38ceb79fef03 449 * @param delay Delay in milliseconds
kevman 0:38ceb79fef03 450 * @param func Callback to be called
kevman 0:38ceb79fef03 451 * @return 0 on success, negative error code on failure
kevman 0:38ceb79fef03 452 */
kevman 0:38ceb79fef03 453 nsapi_error_t call_in(int delay, mbed::Callback<void()> func);
kevman 0:38ceb79fef03 454
kevman 0:38ceb79fef03 455 struct mbed_lwip_socket {
kevman 0:38ceb79fef03 456 bool in_use;
kevman 0:38ceb79fef03 457
kevman 0:38ceb79fef03 458 struct netconn *conn;
kevman 0:38ceb79fef03 459 struct netbuf *buf;
kevman 0:38ceb79fef03 460 u16_t offset;
kevman 0:38ceb79fef03 461
kevman 0:38ceb79fef03 462 void (*cb)(void *);
kevman 0:38ceb79fef03 463 void *data;
kevman 0:38ceb79fef03 464
kevman 0:38ceb79fef03 465 // Track multicast addresses subscribed to by this socket
kevman 0:38ceb79fef03 466 nsapi_ip_mreq_t *multicast_memberships;
kevman 0:38ceb79fef03 467 uint32_t multicast_memberships_count;
kevman 0:38ceb79fef03 468 uint32_t multicast_memberships_registry;
kevman 0:38ceb79fef03 469 };
kevman 0:38ceb79fef03 470
kevman 0:38ceb79fef03 471 struct lwip_callback {
kevman 0:38ceb79fef03 472 unsigned int delay;
kevman 0:38ceb79fef03 473 mbed::Callback<void()> callback;
kevman 0:38ceb79fef03 474 };
kevman 0:38ceb79fef03 475
kevman 0:38ceb79fef03 476 static nsapi_error_t err_remap(err_t err);
kevman 0:38ceb79fef03 477 static bool is_local_addr(const ip_addr_t *ip_addr);
kevman 0:38ceb79fef03 478 static const ip_addr_t *get_ip_addr(bool any_addr, const struct netif *netif);
kevman 0:38ceb79fef03 479 static const ip_addr_t *get_ipv4_addr(const struct netif *netif);
kevman 0:38ceb79fef03 480 static const ip_addr_t *get_ipv6_addr(const struct netif *netif);
kevman 0:38ceb79fef03 481
kevman 0:38ceb79fef03 482 static void add_dns_addr(struct netif *lwip_netif);
kevman 0:38ceb79fef03 483
kevman 0:38ceb79fef03 484 /* Static arena of sockets */
kevman 0:38ceb79fef03 485 struct mbed_lwip_socket arena[MEMP_NUM_NETCONN];
kevman 0:38ceb79fef03 486 void arena_init(void);
kevman 0:38ceb79fef03 487 struct mbed_lwip_socket *arena_alloc();
kevman 0:38ceb79fef03 488 void arena_dealloc(struct mbed_lwip_socket *s);
kevman 0:38ceb79fef03 489
kevman 0:38ceb79fef03 490 static uint32_t next_registered_multicast_member(const struct mbed_lwip_socket *s, uint32_t index) {
kevman 0:38ceb79fef03 491 while (!(s->multicast_memberships_registry & (0x0001 << index))) { index++; }
kevman 0:38ceb79fef03 492 return index;
kevman 0:38ceb79fef03 493 }
kevman 0:38ceb79fef03 494
kevman 0:38ceb79fef03 495 static uint32_t next_free_multicast_member(const struct mbed_lwip_socket *s, uint32_t index) {
kevman 0:38ceb79fef03 496 while ((s->multicast_memberships_registry & (0x0001 << index))) { index++; }
kevman 0:38ceb79fef03 497 return index;
kevman 0:38ceb79fef03 498 }
kevman 0:38ceb79fef03 499
kevman 0:38ceb79fef03 500 static void set_multicast_member_registry_bit(struct mbed_lwip_socket *s, uint32_t index) {
kevman 0:38ceb79fef03 501 s->multicast_memberships_registry |= (0x0001 << index);
kevman 0:38ceb79fef03 502 }
kevman 0:38ceb79fef03 503
kevman 0:38ceb79fef03 504 static void clear_multicast_member_registry_bit(struct mbed_lwip_socket *s, uint32_t index) {
kevman 0:38ceb79fef03 505 s->multicast_memberships_registry &= ~(0x0001 << index);
kevman 0:38ceb79fef03 506 }
kevman 0:38ceb79fef03 507 static int32_t find_multicast_member(const struct mbed_lwip_socket *s, const nsapi_ip_mreq_t *imr);
kevman 0:38ceb79fef03 508
kevman 0:38ceb79fef03 509 static void socket_callback(struct netconn *nc, enum netconn_evt eh, u16_t len);
kevman 0:38ceb79fef03 510
kevman 0:38ceb79fef03 511 static void tcpip_init_irq(void *handle);
kevman 0:38ceb79fef03 512 static void tcpip_thread_callback(void *ptr);
kevman 0:38ceb79fef03 513
kevman 0:38ceb79fef03 514 char ip_address[40];
kevman 0:38ceb79fef03 515 rtos::Semaphore tcpip_inited;
kevman 0:38ceb79fef03 516 Interface *default_interface;
kevman 0:38ceb79fef03 517 LWIPMemoryManager memory_manager;
kevman 0:38ceb79fef03 518 osThreadId tcpip_thread_id;
kevman 0:38ceb79fef03 519 rtos::Mutex adaptation;
kevman 0:38ceb79fef03 520 };
kevman 0:38ceb79fef03 521
kevman 0:38ceb79fef03 522 #endif /* LWIPSTACK_H_ */