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

emw3162 driver

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

EMW3162Interface.h@7:635ff20df767, 2017-02-16 (annotated)

Committer:
sarahmarshy
Date:
Thu Feb 16 19:26:33 2017 +0000
Revision:
7:635ff20df767
Parent:
4:c92051dbb94d 
Change references to _esp to _emw.

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