DongEun Koak / WizFi310Interface_Draft

This is Wi-Fi interface of WizFi310 for mbed os 5

Dependents:   mbed-os-example-wifi

WizFi310Interface.h@1:8e468bb83e1e, 2017-12-19 (annotated)

Committer:
kaizen
Date:
Tue Dec 19 16:59:33 2017 +0900
Revision:
1:8e468bb83e1e
Parent:
0:d0e3f515f99d 
This is WizFi310 Library for mbed os5

Who changed what in which revision?

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