test
Fork of WizFi250Interface by
WizFi250Interface.h@0:e3dc9e54a15b, 2016-08-30 (annotated)
- Committer:
- kaizen
- Date:
- Tue Aug 30 00:05:24 2016 +0000
- Revision:
- 0:e3dc9e54a15b
- Child:
- 1:116433d24e91
First release WizFi250Interface for NetworkInterfaceAPI
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
kaizen | 0:e3dc9e54a15b | 1 | /* WizFi250 implementation of NetworkInterfaceAPI |
kaizen | 0:e3dc9e54a15b | 2 | * Copyright (c) 2015 ARM Limited |
kaizen | 0:e3dc9e54a15b | 3 | * |
kaizen | 0:e3dc9e54a15b | 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
kaizen | 0:e3dc9e54a15b | 5 | * you may not use this file except in compliance with the License. |
kaizen | 0:e3dc9e54a15b | 6 | * You may obtain a copy of the License at |
kaizen | 0:e3dc9e54a15b | 7 | * |
kaizen | 0:e3dc9e54a15b | 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
kaizen | 0:e3dc9e54a15b | 9 | * |
kaizen | 0:e3dc9e54a15b | 10 | * Unless required by applicable law or agreed to in writing, software |
kaizen | 0:e3dc9e54a15b | 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
kaizen | 0:e3dc9e54a15b | 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
kaizen | 0:e3dc9e54a15b | 13 | * See the License for the specific language governing permissions and |
kaizen | 0:e3dc9e54a15b | 14 | * limitations under the License. |
kaizen | 0:e3dc9e54a15b | 15 | */ |
kaizen | 0:e3dc9e54a15b | 16 | |
kaizen | 0:e3dc9e54a15b | 17 | #ifndef WIZFI250_INTERFACE_H |
kaizen | 0:e3dc9e54a15b | 18 | #define WIZFI250_INTERFACE_H |
kaizen | 0:e3dc9e54a15b | 19 | |
kaizen | 0:e3dc9e54a15b | 20 | #include "WiFiInterface.h" |
kaizen | 0:e3dc9e54a15b | 21 | #include "WizFi250.h" |
kaizen | 0:e3dc9e54a15b | 22 | |
kaizen | 0:e3dc9e54a15b | 23 | #define WIZFI250_SOCKET_COUNT 8 |
kaizen | 0:e3dc9e54a15b | 24 | |
kaizen | 0:e3dc9e54a15b | 25 | /** WizFi250Interface class |
kaizen | 0:e3dc9e54a15b | 26 | * Implementation of the NetworkStack for the WizFi250 |
kaizen | 0:e3dc9e54a15b | 27 | */ |
kaizen | 0:e3dc9e54a15b | 28 | class WizFi250Interface : public NetworkStack, public WiFiInterface |
kaizen | 0:e3dc9e54a15b | 29 | { |
kaizen | 0:e3dc9e54a15b | 30 | public: |
kaizen | 0:e3dc9e54a15b | 31 | WizFi250Interface(PinName tx, PinName rx, PinName cts, PinName rts, PinName reset, PinName alarm, int baud=115200 ); |
kaizen | 0:e3dc9e54a15b | 32 | |
kaizen | 0:e3dc9e54a15b | 33 | virtual int connect( |
kaizen | 0:e3dc9e54a15b | 34 | const char *ssid, |
kaizen | 0:e3dc9e54a15b | 35 | const char *pass, |
kaizen | 0:e3dc9e54a15b | 36 | nsapi_security_t security = NSAPI_SECURITY_NONE); |
kaizen | 0:e3dc9e54a15b | 37 | |
kaizen | 0:e3dc9e54a15b | 38 | /** Stop the interface |
kaizen | 0:e3dc9e54a15b | 39 | * @return 0 on success, negative on failure |
kaizen | 0:e3dc9e54a15b | 40 | */ |
kaizen | 0:e3dc9e54a15b | 41 | virtual int disconnect(); |
kaizen | 0:e3dc9e54a15b | 42 | |
kaizen | 0:e3dc9e54a15b | 43 | /** Get the internally stored IP address |
kaizen | 0:e3dc9e54a15b | 44 | * @return IP address of the interface or null if not yet connected |
kaizen | 0:e3dc9e54a15b | 45 | */ |
kaizen | 0:e3dc9e54a15b | 46 | virtual const char *get_ip_address(); |
kaizen | 0:e3dc9e54a15b | 47 | |
kaizen | 0:e3dc9e54a15b | 48 | /** Get the internally stored MAC address |
kaizen | 0:e3dc9e54a15b | 49 | * @return MAC address of the interface |
kaizen | 0:e3dc9e54a15b | 50 | */ |
kaizen | 0:e3dc9e54a15b | 51 | virtual const char *get_mac_address(); |
kaizen | 0:e3dc9e54a15b | 52 | |
kaizen | 0:e3dc9e54a15b | 53 | protected: |
kaizen | 0:e3dc9e54a15b | 54 | /** Open a socket |
kaizen | 0:e3dc9e54a15b | 55 | * @param handle Handle in which to store new socket |
kaizen | 0:e3dc9e54a15b | 56 | * @param proto Type of socket to open, NSAPI_TCP or NSAPI_UDP |
kaizen | 0:e3dc9e54a15b | 57 | * @return 0 on success, negative on failure |
kaizen | 0:e3dc9e54a15b | 58 | */ |
kaizen | 0:e3dc9e54a15b | 59 | virtual int socket_open(void **handle, nsapi_protocol_t proto); |
kaizen | 0:e3dc9e54a15b | 60 | |
kaizen | 0:e3dc9e54a15b | 61 | /** Close the socket |
kaizen | 0:e3dc9e54a15b | 62 | * @param handle Socket handle |
kaizen | 0:e3dc9e54a15b | 63 | * @return 0 on success, negative on failure |
kaizen | 0:e3dc9e54a15b | 64 | * @note On failure, any memory associated with the socket must still |
kaizen | 0:e3dc9e54a15b | 65 | * be cleaned up |
kaizen | 0:e3dc9e54a15b | 66 | */ |
kaizen | 0:e3dc9e54a15b | 67 | virtual int socket_close(void *handle); |
kaizen | 0:e3dc9e54a15b | 68 | |
kaizen | 0:e3dc9e54a15b | 69 | /** Bind a server socket to a specific port |
kaizen | 0:e3dc9e54a15b | 70 | * @param handle Socket handle |
kaizen | 0:e3dc9e54a15b | 71 | * @param address Local address to listen for incoming connections on |
kaizen | 0:e3dc9e54a15b | 72 | * @return 0 on success, negative on failure. |
kaizen | 0:e3dc9e54a15b | 73 | */ |
kaizen | 0:e3dc9e54a15b | 74 | virtual int socket_bind(void *handle, const SocketAddress &address); |
kaizen | 0:e3dc9e54a15b | 75 | |
kaizen | 0:e3dc9e54a15b | 76 | /** Start listening for incoming connections |
kaizen | 0:e3dc9e54a15b | 77 | * @param handle Socket handle |
kaizen | 0:e3dc9e54a15b | 78 | * @param backlog Number of pending connections that can be queued up at any |
kaizen | 0:e3dc9e54a15b | 79 | * one time [Default: 1] |
kaizen | 0:e3dc9e54a15b | 80 | * @return 0 on success, negative on failure |
kaizen | 0:e3dc9e54a15b | 81 | */ |
kaizen | 0:e3dc9e54a15b | 82 | virtual int socket_listen(void *handle, int backlog); |
kaizen | 0:e3dc9e54a15b | 83 | |
kaizen | 0:e3dc9e54a15b | 84 | /** Connects this TCP socket to the server |
kaizen | 0:e3dc9e54a15b | 85 | * @param handle Socket handle |
kaizen | 0:e3dc9e54a15b | 86 | * @param address SocketAddress to connect to |
kaizen | 0:e3dc9e54a15b | 87 | * @return 0 on success, negative on failure |
kaizen | 0:e3dc9e54a15b | 88 | */ |
kaizen | 0:e3dc9e54a15b | 89 | virtual int socket_connect(void *handle, const SocketAddress &address); |
kaizen | 0:e3dc9e54a15b | 90 | |
kaizen | 0:e3dc9e54a15b | 91 | /** Accept a new connection. |
kaizen | 0:e3dc9e54a15b | 92 | * @param handle Handle in which to store new socket |
kaizen | 0:e3dc9e54a15b | 93 | * @param server Socket handle to server to accept from |
kaizen | 0:e3dc9e54a15b | 94 | * @return 0 on success, negative on failure |
kaizen | 0:e3dc9e54a15b | 95 | * @note This call is not-blocking, if this call would block, must |
kaizen | 0:e3dc9e54a15b | 96 | * immediately return NSAPI_ERROR_WOULD_WAIT |
kaizen | 0:e3dc9e54a15b | 97 | */ |
kaizen | 0:e3dc9e54a15b | 98 | virtual int socket_accept(void **handle, void *server); |
kaizen | 0:e3dc9e54a15b | 99 | |
kaizen | 0:e3dc9e54a15b | 100 | /** Send data to the remote host |
kaizen | 0:e3dc9e54a15b | 101 | * @param handle Socket handle |
kaizen | 0:e3dc9e54a15b | 102 | * @param data The buffer to send to the host |
kaizen | 0:e3dc9e54a15b | 103 | * @param size The length of the buffer to send |
kaizen | 0:e3dc9e54a15b | 104 | * @return Number of written bytes on success, negative on failure |
kaizen | 0:e3dc9e54a15b | 105 | * @note This call is not-blocking, if this call would block, must |
kaizen | 0:e3dc9e54a15b | 106 | * immediately return NSAPI_ERROR_WOULD_WAIT |
kaizen | 0:e3dc9e54a15b | 107 | */ |
kaizen | 0:e3dc9e54a15b | 108 | virtual int socket_send(void *handle, const void *data, unsigned size); |
kaizen | 0:e3dc9e54a15b | 109 | |
kaizen | 0:e3dc9e54a15b | 110 | /** Receive data from the remote host |
kaizen | 0:e3dc9e54a15b | 111 | * @param handle Socket handle |
kaizen | 0:e3dc9e54a15b | 112 | * @param data The buffer in which to store the data received from the host |
kaizen | 0:e3dc9e54a15b | 113 | * @param size The maximum length of the buffer |
kaizen | 0:e3dc9e54a15b | 114 | * @return Number of received bytes on success, negative on failure |
kaizen | 0:e3dc9e54a15b | 115 | * @note This call is not-blocking, if this call would block, must |
kaizen | 0:e3dc9e54a15b | 116 | * immediately return NSAPI_ERROR_WOULD_WAIT |
kaizen | 0:e3dc9e54a15b | 117 | */ |
kaizen | 0:e3dc9e54a15b | 118 | virtual int socket_recv(void *handle, void *data, unsigned size); |
kaizen | 0:e3dc9e54a15b | 119 | |
kaizen | 0:e3dc9e54a15b | 120 | /** Send a packet to a remote endpoint |
kaizen | 0:e3dc9e54a15b | 121 | * @param handle Socket handle |
kaizen | 0:e3dc9e54a15b | 122 | * @param address The remote SocketAddress |
kaizen | 0:e3dc9e54a15b | 123 | * @param data The packet to be sent |
kaizen | 0:e3dc9e54a15b | 124 | * @param size The length of the packet to be sent |
kaizen | 0:e3dc9e54a15b | 125 | * @return The number of written bytes on success, negative on failure |
kaizen | 0:e3dc9e54a15b | 126 | * @note This call is not-blocking, if this call would block, must |
kaizen | 0:e3dc9e54a15b | 127 | * immediately return NSAPI_ERROR_WOULD_WAIT |
kaizen | 0:e3dc9e54a15b | 128 | */ |
kaizen | 0:e3dc9e54a15b | 129 | virtual int socket_sendto(void *handle, const SocketAddress &address, const void *data, unsigned size); |
kaizen | 0:e3dc9e54a15b | 130 | |
kaizen | 0:e3dc9e54a15b | 131 | /** Receive a packet from a remote endpoint |
kaizen | 0:e3dc9e54a15b | 132 | * @param handle Socket handle |
kaizen | 0:e3dc9e54a15b | 133 | * @param address Destination for the remote SocketAddress or null |
kaizen | 0:e3dc9e54a15b | 134 | * @param buffer The buffer for storing the incoming packet data |
kaizen | 0:e3dc9e54a15b | 135 | * If a packet is too long to fit in the supplied buffer, |
kaizen | 0:e3dc9e54a15b | 136 | * excess bytes are discarded |
kaizen | 0:e3dc9e54a15b | 137 | * @param size The length of the buffer |
kaizen | 0:e3dc9e54a15b | 138 | * @return The number of received bytes on success, negative on failure |
kaizen | 0:e3dc9e54a15b | 139 | * @note This call is not-blocking, if this call would block, must |
kaizen | 0:e3dc9e54a15b | 140 | * immediately return NSAPI_ERROR_WOULD_WAIT |
kaizen | 0:e3dc9e54a15b | 141 | */ |
kaizen | 0:e3dc9e54a15b | 142 | virtual int socket_recvfrom(void *handle, SocketAddress *address, void *buffer, unsigned size); |
kaizen | 0:e3dc9e54a15b | 143 | |
kaizen | 0:e3dc9e54a15b | 144 | /** Register a callback on state change of the socket |
kaizen | 0:e3dc9e54a15b | 145 | * @param handle Socket handle |
kaizen | 0:e3dc9e54a15b | 146 | * @param callback Function to call on state change |
kaizen | 0:e3dc9e54a15b | 147 | * @param data Argument to pass to callback |
kaizen | 0:e3dc9e54a15b | 148 | * @note Callback may be called in an interrupt context. |
kaizen | 0:e3dc9e54a15b | 149 | */ |
kaizen | 0:e3dc9e54a15b | 150 | virtual void socket_attach(void *handle, void (*callback)(void *), void *data); |
kaizen | 0:e3dc9e54a15b | 151 | |
kaizen | 0:e3dc9e54a15b | 152 | private: |
kaizen | 0:e3dc9e54a15b | 153 | WizFi250 _wizfi250; |
kaizen | 0:e3dc9e54a15b | 154 | bool _ids[WIZFI250_SOCKET_COUNT]; |
kaizen | 0:e3dc9e54a15b | 155 | }; |
kaizen | 0:e3dc9e54a15b | 156 | |
kaizen | 0:e3dc9e54a15b | 157 | #endif |
kaizen | 0:e3dc9e54a15b | 158 |