Sarah Marsh / emw3162-driver-mbed-os-5

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Fork of emw3162-driver-mbed-os-5 by Maggie Mei

EMW3162Interface.h@3:a6f80a95b039, 2016-11-17 (annotated)

Committer:
Maggie17
Date:
Thu Nov 17 03:52:22 2016 +0000
Revision:
3:a6f80a95b039
Parent:
2:fb6251306b21
Child:
4:c92051dbb94d
emw3162 driver for mbed os 5

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Maggie17 2:fb6251306b21 1 /* EMW3162 implementation of NetworkInterfaceAPI
Maggie17 0:2d5090e1ceb4 2 * Copyright (c) 2015 ARM Limited
Maggie17 0:2d5090e1ceb4 3 *
Maggie17 0:2d5090e1ceb4 4 * Licensed under the Apache License, Version 2.0 (the "License");
Maggie17 0:2d5090e1ceb4 5 * you may not use this file except in compliance with the License.
Maggie17 0:2d5090e1ceb4 6 * You may obtain a copy of the License at
Maggie17 0:2d5090e1ceb4 7 *
Maggie17 0:2d5090e1ceb4 8 * http://www.apache.org/licenses/LICENSE-2.0
Maggie17 0:2d5090e1ceb4 9 *
Maggie17 0:2d5090e1ceb4 10 * Unless required by applicable law or agreed to in writing, software
Maggie17 0:2d5090e1ceb4 11 * distributed under the License is distributed on an "AS IS" BASIS,
Maggie17 0:2d5090e1ceb4 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
Maggie17 0:2d5090e1ceb4 13 * See the License for the specific language governing permissions and
Maggie17 0:2d5090e1ceb4 14 * limitations under the License.
Maggie17 0:2d5090e1ceb4 15 */
Maggie17 0:2d5090e1ceb4 16
Maggie17 2:fb6251306b21 17 #ifndef EMW3162_INTERFACE_H
Maggie17 2:fb6251306b21 18 #define EMW3162_INTERFACE_H
Maggie17 0:2d5090e1ceb4 19
Maggie17 3:a6f80a95b039 20 #include "mbed.h"
Maggie17 3:a6f80a95b039 21 //#include "NetworkSocketAPI/NetworkStack.h"
Maggie17 3:a6f80a95b039 22 //#include "NetworkSocketAPI/WiFiInterface.h"
Maggie17 1:3c8bed04849d 23 #include "EMW3162.h"
Maggie17 0:2d5090e1ceb4 24
Maggie17 0:2d5090e1ceb4 25
Maggie17 2:fb6251306b21 26 #define EMW3162_SOCKET_COUNT 5
Maggie17 0:2d5090e1ceb4 27
Maggie17 2:fb6251306b21 28 /** EMW3162Interface class
Maggie17 2:fb6251306b21 29 * Implementation of the NetworkStack for the EMW3162
Maggie17 0:2d5090e1ceb4 30 */
Maggie17 2:fb6251306b21 31 class EMW3162Interface : public NetworkStack, public WiFiInterface
Maggie17 0:2d5090e1ceb4 32 {
Maggie17 0:2d5090e1ceb4 33 public:
Maggie17 2:fb6251306b21 34 /** EMW3162Interface lifetime
Maggie17 0:2d5090e1ceb4 35 * @param tx TX pin
Maggie17 0:2d5090e1ceb4 36 * @param rx RX pin
Maggie17 0:2d5090e1ceb4 37 * @param debug Enable debugging
Maggie17 0:2d5090e1ceb4 38 */
Maggie17 2:fb6251306b21 39 EMW3162Interface(PinName tx, PinName rx, bool debug = false);
Maggie17 0:2d5090e1ceb4 40
Maggie17 0:2d5090e1ceb4 41 /** Start the interface
Maggie17 0:2d5090e1ceb4 42 *
Maggie17 3:a6f80a95b039 43 * Attempts to connect to a WiFi network. Requires ssid and passphrase to be set.
Maggie17 3:a6f80a95b039 44 * If passphrase is invalid, NSAPI_ERROR_AUTH_ERROR is returned.
Maggie17 3:a6f80a95b039 45 *
Maggie17 3:a6f80a95b039 46 * @return 0 on success, negative error code on failure
Maggie17 3:a6f80a95b039 47 */
Maggie17 3:a6f80a95b039 48 virtual int connect();
Maggie17 3:a6f80a95b039 49
Maggie17 3:a6f80a95b039 50 /** Start the interface
Maggie17 3:a6f80a95b039 51 *
Maggie17 3:a6f80a95b039 52 * Attempts to connect to a WiFi network.
Maggie17 3:a6f80a95b039 53 *
Maggie17 3:a6f80a95b039 54 * @param ssid Name of the network to connect to
Maggie17 3:a6f80a95b039 55 * @param pass Security passphrase to connect to the network
Maggie17 3:a6f80a95b039 56 * @param security Type of encryption for connection (Default: NSAPI_SECURITY_NONE)
Maggie17 3:a6f80a95b039 57 * @param channel This parameter is not supported, setting it to anything else than 0 will result in NSAPI_ERROR_UNSUPPORTED
Maggie17 3:a6f80a95b039 58 * @return 0 on success, or error code on failure
Maggie17 3:a6f80a95b039 59 */
Maggie17 3:a6f80a95b039 60 virtual int connect(const char *ssid, const char *pass, nsapi_security_t security = NSAPI_SECURITY_NONE,
Maggie17 3:a6f80a95b039 61 uint8_t channel = 0);
Maggie17 3:a6f80a95b039 62
Maggie17 3:a6f80a95b039 63 /** Set the WiFi network credentials
Maggie17 0:2d5090e1ceb4 64 *
Maggie17 0:2d5090e1ceb4 65 * @param ssid Name of the network to connect to
Maggie17 0:2d5090e1ceb4 66 * @param pass Security passphrase to connect to the network
Maggie17 0:2d5090e1ceb4 67 * @param security Type of encryption for connection
Maggie17 3:a6f80a95b039 68 * (defaults to NSAPI_SECURITY_NONE)
Maggie17 3:a6f80a95b039 69 * @return 0 on success, or error code on failure
Maggie17 0:2d5090e1ceb4 70 */
Maggie17 3:a6f80a95b039 71 virtual int set_credentials(const char *ssid, const char *pass, nsapi_security_t security = NSAPI_SECURITY_NONE);
Maggie17 3:a6f80a95b039 72
Maggie17 3:a6f80a95b039 73 /** Set the WiFi network channel - NOT SUPPORTED
Maggie17 3:a6f80a95b039 74 *
Maggie17 3:a6f80a95b039 75 * This function is not supported and will return NSAPI_ERROR_UNSUPPORTED
Maggie17 3:a6f80a95b039 76 *
Maggie17 3:a6f80a95b039 77 * @param channel Channel on which the connection is to be made, or 0 for any (Default: 0)
Maggie17 3:a6f80a95b039 78 * @return Not supported, returns NSAPI_ERROR_UNSUPPORTED
Maggie17 3:a6f80a95b039 79 */
Maggie17 3:a6f80a95b039 80 virtual int set_channel(uint8_t channel);
Maggie17 0:2d5090e1ceb4 81
Maggie17 0:2d5090e1ceb4 82 /** Stop the interface
Maggie17 0:2d5090e1ceb4 83 * @return 0 on success, negative on failure
Maggie17 0:2d5090e1ceb4 84 */
Maggie17 0:2d5090e1ceb4 85 virtual int disconnect();
Maggie17 0:2d5090e1ceb4 86
Maggie17 0:2d5090e1ceb4 87 /** Get the internally stored IP address
Maggie17 0:2d5090e1ceb4 88 * @return IP address of the interface or null if not yet connected
Maggie17 0:2d5090e1ceb4 89 */
Maggie17 0:2d5090e1ceb4 90 virtual const char *get_ip_address();
Maggie17 0:2d5090e1ceb4 91
Maggie17 0:2d5090e1ceb4 92 /** Get the internally stored MAC address
Maggie17 0:2d5090e1ceb4 93 * @return MAC address of the interface
Maggie17 0:2d5090e1ceb4 94 */
Maggie17 0:2d5090e1ceb4 95 virtual const char *get_mac_address();
Maggie17 0:2d5090e1ceb4 96
Maggie17 3:a6f80a95b039 97 /** Get the local gateway
Maggie17 3:a6f80a95b039 98 *
Maggie17 3:a6f80a95b039 99 * @return Null-terminated representation of the local gateway
Maggie17 3:a6f80a95b039 100 * or null if no network mask has been recieved
Maggie17 3:a6f80a95b039 101 */
Maggie17 3:a6f80a95b039 102 virtual const char *get_gateway();
Maggie17 3:a6f80a95b039 103
Maggie17 3:a6f80a95b039 104 /** Get the local network mask
Maggie17 3:a6f80a95b039 105 *
Maggie17 3:a6f80a95b039 106 * @return Null-terminated representation of the local network mask
Maggie17 3:a6f80a95b039 107 * or null if no network mask has been recieved
Maggie17 3:a6f80a95b039 108 */
Maggie17 3:a6f80a95b039 109 virtual const char *get_netmask();
Maggie17 3:a6f80a95b039 110
Maggie17 3:a6f80a95b039 111 /** Gets the current radio signal strength for active connection
Maggie17 3:a6f80a95b039 112 *
Maggie17 3:a6f80a95b039 113 * @return Connection strength in dBm (negative value)
Maggie17 3:a6f80a95b039 114 */
Maggie17 3:a6f80a95b039 115 virtual int8_t get_rssi();
Maggie17 3:a6f80a95b039 116
Maggie17 3:a6f80a95b039 117 /** Scan for available networks
Maggie17 3:a6f80a95b039 118 *
Maggie17 3:a6f80a95b039 119 * This function will block.
Maggie17 3:a6f80a95b039 120 *
Maggie17 3:a6f80a95b039 121 * @param ap Pointer to allocated array to store discovered AP
Maggie17 3:a6f80a95b039 122 * @param count Size of allocated @a res array, or 0 to only count available AP
Maggie17 3:a6f80a95b039 123 * @param timeout Timeout in milliseconds; 0 for no timeout (Default: 0)
Maggie17 3:a6f80a95b039 124 * @return Number of entries in @a, or if @a count was 0 number of available networks, negative on error
Maggie17 3:a6f80a95b039 125 * see @a nsapi_error
Maggie17 3:a6f80a95b039 126 */
Maggie17 3:a6f80a95b039 127 virtual int scan(WiFiAccessPoint *res, unsigned count);
Maggie17 3:a6f80a95b039 128
Maggie17 0:2d5090e1ceb4 129 protected:
Maggie17 0:2d5090e1ceb4 130 /** Open a socket
Maggie17 0:2d5090e1ceb4 131 * @param handle Handle in which to store new socket
Maggie17 0:2d5090e1ceb4 132 * @param proto Type of socket to open, NSAPI_TCP or NSAPI_UDP
Maggie17 0:2d5090e1ceb4 133 * @return 0 on success, negative on failure
Maggie17 0:2d5090e1ceb4 134 */
Maggie17 0:2d5090e1ceb4 135 virtual int socket_open(void **handle, nsapi_protocol_t proto);
Maggie17 0:2d5090e1ceb4 136
Maggie17 0:2d5090e1ceb4 137 /** Close the socket
Maggie17 0:2d5090e1ceb4 138 * @param handle Socket handle
Maggie17 0:2d5090e1ceb4 139 * @return 0 on success, negative on failure
Maggie17 0:2d5090e1ceb4 140 * @note On failure, any memory associated with the socket must still
Maggie17 0:2d5090e1ceb4 141 * be cleaned up
Maggie17 0:2d5090e1ceb4 142 */
Maggie17 0:2d5090e1ceb4 143 virtual int socket_close(void *handle);
Maggie17 0:2d5090e1ceb4 144
Maggie17 0:2d5090e1ceb4 145 /** Bind a server socket to a specific port
Maggie17 0:2d5090e1ceb4 146 * @param handle Socket handle
Maggie17 0:2d5090e1ceb4 147 * @param address Local address to listen for incoming connections on
Maggie17 0:2d5090e1ceb4 148 * @return 0 on success, negative on failure.
Maggie17 0:2d5090e1ceb4 149 */
Maggie17 0:2d5090e1ceb4 150 virtual int socket_bind(void *handle, const SocketAddress &address);
Maggie17 0:2d5090e1ceb4 151
Maggie17 0:2d5090e1ceb4 152 /** Start listening for incoming connections
Maggie17 0:2d5090e1ceb4 153 * @param handle Socket handle
Maggie17 0:2d5090e1ceb4 154 * @param backlog Number of pending connections that can be queued up at any
Maggie17 0:2d5090e1ceb4 155 * one time [Default: 1]
Maggie17 0:2d5090e1ceb4 156 * @return 0 on success, negative on failure
Maggie17 0:2d5090e1ceb4 157 */
Maggie17 0:2d5090e1ceb4 158 virtual int socket_listen(void *handle, int backlog);
Maggie17 0:2d5090e1ceb4 159
Maggie17 0:2d5090e1ceb4 160 /** Connects this TCP socket to the server
Maggie17 0:2d5090e1ceb4 161 * @param handle Socket handle
Maggie17 0:2d5090e1ceb4 162 * @param address SocketAddress to connect to
Maggie17 0:2d5090e1ceb4 163 * @return 0 on success, negative on failure
Maggie17 0:2d5090e1ceb4 164 */
Maggie17 0:2d5090e1ceb4 165 virtual int socket_connect(void *handle, const SocketAddress &address);
Maggie17 0:2d5090e1ceb4 166
Maggie17 0:2d5090e1ceb4 167 /** Accept a new connection.
Maggie17 0:2d5090e1ceb4 168 * @param handle Handle in which to store new socket
Maggie17 0:2d5090e1ceb4 169 * @param server Socket handle to server to accept from
Maggie17 0:2d5090e1ceb4 170 * @return 0 on success, negative on failure
Maggie17 0:2d5090e1ceb4 171 * @note This call is not-blocking, if this call would block, must
Maggie17 0:2d5090e1ceb4 172 * immediately return NSAPI_ERROR_WOULD_WAIT
Maggie17 0:2d5090e1ceb4 173 */
Maggie17 3:a6f80a95b039 174 virtual int socket_accept(void *handle, void **socket, SocketAddress *address);
Maggie17 0:2d5090e1ceb4 175
Maggie17 0:2d5090e1ceb4 176 /** Send data to the remote host
Maggie17 0:2d5090e1ceb4 177 * @param handle Socket handle
Maggie17 0:2d5090e1ceb4 178 * @param data The buffer to send to the host
Maggie17 0:2d5090e1ceb4 179 * @param size The length of the buffer to send
Maggie17 0:2d5090e1ceb4 180 * @return Number of written bytes on success, negative on failure
Maggie17 0:2d5090e1ceb4 181 * @note This call is not-blocking, if this call would block, must
Maggie17 0:2d5090e1ceb4 182 * immediately return NSAPI_ERROR_WOULD_WAIT
Maggie17 0:2d5090e1ceb4 183 */
Maggie17 0:2d5090e1ceb4 184 virtual int socket_send(void *handle, const void *data, unsigned size);
Maggie17 0:2d5090e1ceb4 185
Maggie17 0:2d5090e1ceb4 186 /** Receive data from the remote host
Maggie17 0:2d5090e1ceb4 187 * @param handle Socket handle
Maggie17 0:2d5090e1ceb4 188 * @param data The buffer in which to store the data received from the host
Maggie17 0:2d5090e1ceb4 189 * @param size The maximum length of the buffer
Maggie17 0:2d5090e1ceb4 190 * @return Number of received bytes on success, negative on failure
Maggie17 0:2d5090e1ceb4 191 * @note This call is not-blocking, if this call would block, must
Maggie17 0:2d5090e1ceb4 192 * immediately return NSAPI_ERROR_WOULD_WAIT
Maggie17 0:2d5090e1ceb4 193 */
Maggie17 0:2d5090e1ceb4 194 virtual int socket_recv(void *handle, void *data, unsigned size);
Maggie17 0:2d5090e1ceb4 195
Maggie17 0:2d5090e1ceb4 196 /** Send a packet to a remote endpoint
Maggie17 0:2d5090e1ceb4 197 * @param handle Socket handle
Maggie17 0:2d5090e1ceb4 198 * @param address The remote SocketAddress
Maggie17 0:2d5090e1ceb4 199 * @param data The packet to be sent
Maggie17 0:2d5090e1ceb4 200 * @param size The length of the packet to be sent
Maggie17 0:2d5090e1ceb4 201 * @return The number of written bytes on success, negative on failure
Maggie17 0:2d5090e1ceb4 202 * @note This call is not-blocking, if this call would block, must
Maggie17 0:2d5090e1ceb4 203 * immediately return NSAPI_ERROR_WOULD_WAIT
Maggie17 0:2d5090e1ceb4 204 */
Maggie17 0:2d5090e1ceb4 205 virtual int socket_sendto(void *handle, const SocketAddress &address, const void *data, unsigned size);
Maggie17 0:2d5090e1ceb4 206
Maggie17 0:2d5090e1ceb4 207 /** Receive a packet from a remote endpoint
Maggie17 0:2d5090e1ceb4 208 * @param handle Socket handle
Maggie17 0:2d5090e1ceb4 209 * @param address Destination for the remote SocketAddress or null
Maggie17 0:2d5090e1ceb4 210 * @param buffer The buffer for storing the incoming packet data
Maggie17 0:2d5090e1ceb4 211 * If a packet is too long to fit in the supplied buffer,
Maggie17 0:2d5090e1ceb4 212 * excess bytes are discarded
Maggie17 0:2d5090e1ceb4 213 * @param size The length of the buffer
Maggie17 0:2d5090e1ceb4 214 * @return The number of received bytes on success, negative on failure
Maggie17 0:2d5090e1ceb4 215 * @note This call is not-blocking, if this call would block, must
Maggie17 0:2d5090e1ceb4 216 * immediately return NSAPI_ERROR_WOULD_WAIT
Maggie17 0:2d5090e1ceb4 217 */
Maggie17 0:2d5090e1ceb4 218 virtual int socket_recvfrom(void *handle, SocketAddress *address, void *buffer, unsigned size);
Maggie17 0:2d5090e1ceb4 219
Maggie17 0:2d5090e1ceb4 220 /** Register a callback on state change of the socket
Maggie17 0:2d5090e1ceb4 221 * @param handle Socket handle
Maggie17 0:2d5090e1ceb4 222 * @param callback Function to call on state change
Maggie17 0:2d5090e1ceb4 223 * @param data Argument to pass to callback
Maggie17 0:2d5090e1ceb4 224 * @note Callback may be called in an interrupt context.
Maggie17 0:2d5090e1ceb4 225 */
Maggie17 0:2d5090e1ceb4 226 virtual void socket_attach(void *handle, void (*callback)(void *), void *data);
Maggie17 0:2d5090e1ceb4 227
Maggie17 0:2d5090e1ceb4 228 /** Provide access to the NetworkStack object
Maggie17 0:2d5090e1ceb4 229 *
Maggie17 0:2d5090e1ceb4 230 * @return The underlying NetworkStack object
Maggie17 0:2d5090e1ceb4 231 */
Maggie17 0:2d5090e1ceb4 232 virtual NetworkStack *get_stack()
Maggie17 0:2d5090e1ceb4 233 {
Maggie17 0:2d5090e1ceb4 234 return this;
Maggie17 0:2d5090e1ceb4 235 }
Maggie17 0:2d5090e1ceb4 236
Maggie17 0:2d5090e1ceb4 237 private:
Maggie17 2:fb6251306b21 238 EMW3162 _esp;
Maggie17 2:fb6251306b21 239 bool _ids[EMW3162_SOCKET_COUNT];
Maggie17 0:2d5090e1ceb4 240
Maggie17 3:a6f80a95b039 241 char ap_ssid[33]; /* 32 is what 802.11 defines as longest possible name; +1 for the \0 */
Maggie17 3:a6f80a95b039 242 nsapi_security_t ap_sec;
Maggie17 3:a6f80a95b039 243 uint8_t ap_ch;
Maggie17 3:a6f80a95b039 244 char ap_pass[64]; /* The longest allowed passphrase */
Maggie17 3:a6f80a95b039 245
Maggie17 0:2d5090e1ceb4 246 void event();
Maggie17 0:2d5090e1ceb4 247 struct {
Maggie17 0:2d5090e1ceb4 248 void (*callback)(void *);
Maggie17 0:2d5090e1ceb4 249 void *data;
Maggie17 2:fb6251306b21 250 } _cbs[EMW3162_SOCKET_COUNT];
Maggie17 0:2d5090e1ceb4 251 };
Maggie17 0:2d5090e1ceb4 252
Maggie17 0:2d5090e1ceb4 253
Maggie17 0:2d5090e1ceb4 254 #endif