version_2.0
Dependents: cc3000_ping_demo_try_2
Fork of cc3000_hostdriver_mbedsocket by
cc3000.h@45:50ab13d8f2dc, 2013-11-06 (annotated)
- Committer:
- Kojto
- Date:
- Wed Nov 06 17:56:25 2013 +0100
- Revision:
- 45:50ab13d8f2dc
- Parent:
- 44:960b73df5981
complete Ethernet interface
- code clean-up
- IRQ - faster enable/disable, a flag to process an IRQ
- EthernetInterface
- TINY_DRIVER compilation errors correction
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
Kojto | 20:30b6ed7bf8fd | 1 | /***************************************************************************** |
Kojto | 20:30b6ed7bf8fd | 2 | * |
Kojto | 20:30b6ed7bf8fd | 3 | * C++ interface/implementation created by Martin Kojtal (0xc0170). Thanks to |
Kojto | 20:30b6ed7bf8fd | 4 | * Jim Carver and Frank Vannieuwkerke for their inital cc3000 mbed port and |
Kojto | 20:30b6ed7bf8fd | 5 | * provided help. |
Kojto | 20:30b6ed7bf8fd | 6 | * |
Kojto | 20:30b6ed7bf8fd | 7 | * This version of "host driver" uses CC3000 Host Driver Implementation. Thus |
Kojto | 20:30b6ed7bf8fd | 8 | * read the following copyright: |
Kojto | 20:30b6ed7bf8fd | 9 | * |
Kojto | 20:30b6ed7bf8fd | 10 | * Copyright (C) 2011 Texas Instruments Incorporated - http://www.ti.com/ |
Kojto | 20:30b6ed7bf8fd | 11 | * |
Kojto | 20:30b6ed7bf8fd | 12 | * Redistribution and use in source and binary forms, with or without |
Kojto | 20:30b6ed7bf8fd | 13 | * modification, are permitted provided that the following conditions |
Kojto | 20:30b6ed7bf8fd | 14 | * are met: |
Kojto | 20:30b6ed7bf8fd | 15 | * |
Kojto | 20:30b6ed7bf8fd | 16 | * Redistributions of source code must retain the above copyright |
Kojto | 20:30b6ed7bf8fd | 17 | * notice, this list of conditions and the following disclaimer. |
Kojto | 20:30b6ed7bf8fd | 18 | * |
Kojto | 20:30b6ed7bf8fd | 19 | * Redistributions in binary form must reproduce the above copyright |
Kojto | 20:30b6ed7bf8fd | 20 | * notice, this list of conditions and the following disclaimer in the |
Kojto | 20:30b6ed7bf8fd | 21 | * documentation and/or other materials provided with the |
Kojto | 20:30b6ed7bf8fd | 22 | * distribution. |
Kojto | 20:30b6ed7bf8fd | 23 | * |
Kojto | 20:30b6ed7bf8fd | 24 | * Neither the name of Texas Instruments Incorporated nor the names of |
Kojto | 20:30b6ed7bf8fd | 25 | * its contributors may be used to endorse or promote products derived |
Kojto | 20:30b6ed7bf8fd | 26 | * from this software without specific prior written permission. |
Kojto | 20:30b6ed7bf8fd | 27 | * |
Kojto | 20:30b6ed7bf8fd | 28 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
Kojto | 20:30b6ed7bf8fd | 29 | * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
Kojto | 20:30b6ed7bf8fd | 30 | * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |
Kojto | 20:30b6ed7bf8fd | 31 | * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT |
Kojto | 20:30b6ed7bf8fd | 32 | * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
Kojto | 20:30b6ed7bf8fd | 33 | * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
Kojto | 20:30b6ed7bf8fd | 34 | * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
Kojto | 20:30b6ed7bf8fd | 35 | * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
Kojto | 20:30b6ed7bf8fd | 36 | * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
Kojto | 20:30b6ed7bf8fd | 37 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
Kojto | 20:30b6ed7bf8fd | 38 | * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
Kojto | 20:30b6ed7bf8fd | 39 | * |
Kojto | 20:30b6ed7bf8fd | 40 | *****************************************************************************/ |
Kojto | 20:30b6ed7bf8fd | 41 | #ifndef CC3000_H |
Kojto | 20:30b6ed7bf8fd | 42 | #define CC3000_H |
Kojto | 20:30b6ed7bf8fd | 43 | |
Kojto | 20:30b6ed7bf8fd | 44 | #include "mbed.h" |
Kojto | 20:30b6ed7bf8fd | 45 | #include "cc3000_common.h" |
Kojto | 20:30b6ed7bf8fd | 46 | #include "cc3000_spi.h" |
Kojto | 20:30b6ed7bf8fd | 47 | #include "cc3000_simplelink.h" |
Kojto | 20:30b6ed7bf8fd | 48 | #include "cc3000_netapp.h" |
Kojto | 20:30b6ed7bf8fd | 49 | #include "cc3000_nvmem.h" |
Kojto | 20:30b6ed7bf8fd | 50 | #include "cc3000_socket.h" |
Kojto | 20:30b6ed7bf8fd | 51 | |
Kojto | 20:30b6ed7bf8fd | 52 | #define MAX_SOCKETS 4 |
Kojto | 44:960b73df5981 | 53 | // cc3000 Ethernet Interface - enabled by default |
Kojto | 44:960b73df5981 | 54 | #define CC3000_ETH_COMPAT 1 |
Kojto | 20:30b6ed7bf8fd | 55 | |
Kojto | 44:960b73df5981 | 56 | /** Enable debug messages - set 1 */ |
SolderSplashLabs | 24:ba3fa29197ac | 57 | // Debug - Socket interface messages |
Kojto | 44:960b73df5981 | 58 | #define CC3000_DEBUG_SOCKET 0 |
SolderSplashLabs | 24:ba3fa29197ac | 59 | // Debug - HCI TX messages |
Kojto | 44:960b73df5981 | 60 | #define CC3000_DEBUG_HCI_TX 0 |
SolderSplashLabs | 24:ba3fa29197ac | 61 | // Debug - HCI Rx messages |
Kojto | 44:960b73df5981 | 62 | #define CC3000_DEBUG_HCI_RX 0 |
SolderSplashLabs | 24:ba3fa29197ac | 63 | // Debug - General Debug |
Kojto | 44:960b73df5981 | 64 | #define CC3000_DEBUG 0 |
SolderSplashLabs | 26:456f73ed2a75 | 65 | // Add colour to the debug messages, requires a VT100 terminal like putty, comment out to remove |
Kojto | 44:960b73df5981 | 66 | #define VT100_COLOUR 0 |
SolderSplashLabs | 22:d23c59fec0dc | 67 | |
Kojto | 44:960b73df5981 | 68 | #if (CC3000_DEBUG_SOCKET == 1) |
Kojto | 44:960b73df5981 | 69 | #if (VT100_COLOUR == 1) |
SolderSplashLabs | 22:d23c59fec0dc | 70 | #define DBG_SOCKET(x, ...) std::printf("\x1b[2;32;40m[CC3000 : SOCKET] "x"\x1b[0;37;40m\r\n", ##__VA_ARGS__); |
SolderSplashLabs | 22:d23c59fec0dc | 71 | #else |
SolderSplashLabs | 22:d23c59fec0dc | 72 | #define DBG_SOCKET(x, ...) std::printf("[CC3000 : SOCKET] "x"\r\n", ##__VA_ARGS__); |
SolderSplashLabs | 22:d23c59fec0dc | 73 | #endif |
Kojto | 20:30b6ed7bf8fd | 74 | #else |
Kojto | 20:30b6ed7bf8fd | 75 | #define DBG_SOCKET(x, ...) |
SolderSplashLabs | 22:d23c59fec0dc | 76 | #endif |
SolderSplashLabs | 22:d23c59fec0dc | 77 | |
Kojto | 44:960b73df5981 | 78 | #if (CC3000_DEBUG_HCI_TX == 1) |
Kojto | 44:960b73df5981 | 79 | #if (VT100_COLOUR == 1) |
SolderSplashLabs | 22:d23c59fec0dc | 80 | #define DBG_HCI(x, ...) std::printf("\x1b[2;35;40m[CC3000 : HCI RX] "x"\x1b[0;37;40m\r\n", ##__VA_ARGS__); |
SolderSplashLabs | 22:d23c59fec0dc | 81 | #else |
SolderSplashLabs | 22:d23c59fec0dc | 82 | #define DBG_HCI(x, ...) std::printf("[CC3000 : HCI RX] "x"\r\n", ##__VA_ARGS__); |
SolderSplashLabs | 22:d23c59fec0dc | 83 | #endif |
SolderSplashLabs | 22:d23c59fec0dc | 84 | #else |
Kojto | 20:30b6ed7bf8fd | 85 | #define DBG_HCI(x, ...) |
SolderSplashLabs | 22:d23c59fec0dc | 86 | #endif |
SolderSplashLabs | 22:d23c59fec0dc | 87 | |
Kojto | 44:960b73df5981 | 88 | #if (CC3000_DEBUG_HCI_RX == 1) |
Kojto | 44:960b73df5981 | 89 | #if (VT100_COLOUR == 1) |
SolderSplashLabs | 22:d23c59fec0dc | 90 | #define DBG_HCI_CMD(x, ...) std::printf("\x1b[2;36;40m[CC3000 : HCI TX] "x"\x1b[0;37;40m\r\n", ##__VA_ARGS__); |
SolderSplashLabs | 22:d23c59fec0dc | 91 | #else |
SolderSplashLabs | 22:d23c59fec0dc | 92 | #define DBG_HCI_CMD(x, ...) std::printf("[CC3000 : HCI TX] "x"\r\n", ##__VA_ARGS__); |
SolderSplashLabs | 22:d23c59fec0dc | 93 | #endif |
SolderSplashLabs | 22:d23c59fec0dc | 94 | #else |
SolderSplashLabs | 22:d23c59fec0dc | 95 | #define DBG_HCI_CMD(x, ...) |
SolderSplashLabs | 22:d23c59fec0dc | 96 | #endif |
SolderSplashLabs | 22:d23c59fec0dc | 97 | |
Kojto | 44:960b73df5981 | 98 | #if (CC3000_DEBUG == 1) |
Kojto | 44:960b73df5981 | 99 | #if (VT100_COLOUR == 1) |
SolderSplashLabs | 22:d23c59fec0dc | 100 | #define DBG_CC(x, ...) std::printf("\x1b[2;32;40m[CC3000] "x"\x1b[0;37;40m\r\n", ##__VA_ARGS__); |
SolderSplashLabs | 22:d23c59fec0dc | 101 | #else |
SolderSplashLabs | 22:d23c59fec0dc | 102 | #define DBG_CC(x, ...) std::printf("[CC3000] "x"\r\n", ##__VA_ARGS__); |
SolderSplashLabs | 22:d23c59fec0dc | 103 | #endif |
SolderSplashLabs | 22:d23c59fec0dc | 104 | #else |
SolderSplashLabs | 24:ba3fa29197ac | 105 | #define DBG_CC(x, ...) |
Kojto | 20:30b6ed7bf8fd | 106 | #endif |
Kojto | 20:30b6ed7bf8fd | 107 | |
Kojto | 20:30b6ed7bf8fd | 108 | namespace mbed_cc3000 { |
Kojto | 20:30b6ed7bf8fd | 109 | |
Kojto | 20:30b6ed7bf8fd | 110 | /** User info structure |
Kojto | 20:30b6ed7bf8fd | 111 | */ |
Kojto | 20:30b6ed7bf8fd | 112 | typedef struct { |
Kojto | 20:30b6ed7bf8fd | 113 | uint8_t FTC; // First time config performed |
Kojto | 20:30b6ed7bf8fd | 114 | uint8_t PP_version[2]; // Patch Programmer version |
Kojto | 20:30b6ed7bf8fd | 115 | uint8_t SERV_PACK[2]; // Service Pack Version |
Kojto | 20:30b6ed7bf8fd | 116 | uint8_t DRV_VER[3]; // Driver Version |
Kojto | 20:30b6ed7bf8fd | 117 | uint8_t FW_VER[3]; // Firmware Version |
Kojto | 20:30b6ed7bf8fd | 118 | uint8_t validCIK; // CIK[] is valid (Client Interface Key) |
Kojto | 20:30b6ed7bf8fd | 119 | uint8_t CIK[40]; |
Kojto | 20:30b6ed7bf8fd | 120 | } tUserFS; |
Kojto | 20:30b6ed7bf8fd | 121 | |
Kojto | 20:30b6ed7bf8fd | 122 | /** Function pointers which are not yet implemented |
Kojto | 20:30b6ed7bf8fd | 123 | */ |
Kojto | 20:30b6ed7bf8fd | 124 | enum FunctionNumber { |
Kojto | 20:30b6ed7bf8fd | 125 | FW_PATCHES = 0, |
Kojto | 20:30b6ed7bf8fd | 126 | DRIVER_PATCHES = 1, |
Kojto | 20:30b6ed7bf8fd | 127 | BOOTLOADER_PATCHES = 2, |
Kojto | 20:30b6ed7bf8fd | 128 | }; |
Kojto | 20:30b6ed7bf8fd | 129 | |
Kojto | 45:50ab13d8f2dc | 130 | /** AP security |
Kojto | 45:50ab13d8f2dc | 131 | */ |
Kojto | 45:50ab13d8f2dc | 132 | enum Security { |
Kojto | 45:50ab13d8f2dc | 133 | NONE = 0, |
Kojto | 45:50ab13d8f2dc | 134 | WEP = 1, |
Kojto | 45:50ab13d8f2dc | 135 | WPA = 2, |
Kojto | 45:50ab13d8f2dc | 136 | WPA2 = 3 |
Kojto | 45:50ab13d8f2dc | 137 | }; |
Kojto | 45:50ab13d8f2dc | 138 | |
Kojto | 20:30b6ed7bf8fd | 139 | /** CC3000 Simple Link class which contains status of cc3000. |
Kojto | 20:30b6ed7bf8fd | 140 | */ |
Kojto | 20:30b6ed7bf8fd | 141 | class cc3000_simple_link { |
Kojto | 20:30b6ed7bf8fd | 142 | public: |
Kojto | 33:9e23b24fb4f3 | 143 | /** |
Kojto | 33:9e23b24fb4f3 | 144 | * \brief ctor - sets magic number in the buffers (overflow mark). |
Kojto | 33:9e23b24fb4f3 | 145 | * \param none |
Kojto | 33:9e23b24fb4f3 | 146 | * \return none |
Kojto | 20:30b6ed7bf8fd | 147 | */ |
Kojto | 20:30b6ed7bf8fd | 148 | cc3000_simple_link(); |
Kojto | 33:9e23b24fb4f3 | 149 | /** |
Kojto | 33:9e23b24fb4f3 | 150 | * \brief dtor |
Kojto | 33:9e23b24fb4f3 | 151 | * \param none |
Kojto | 33:9e23b24fb4f3 | 152 | * \return none |
Kojto | 20:30b6ed7bf8fd | 153 | */ |
Kojto | 20:30b6ed7bf8fd | 154 | ~cc3000_simple_link(); |
Kojto | 33:9e23b24fb4f3 | 155 | /** |
Kojto | 33:9e23b24fb4f3 | 156 | * \brief Returns data received flag. |
Kojto | 33:9e23b24fb4f3 | 157 | * \return Data received flag. |
Kojto | 20:30b6ed7bf8fd | 158 | */ |
Kojto | 20:30b6ed7bf8fd | 159 | uint8_t get_data_received_flag(); |
Kojto | 33:9e23b24fb4f3 | 160 | /** |
Kojto | 33:9e23b24fb4f3 | 161 | * \brief Set data received flag. |
Kojto | 20:30b6ed7bf8fd | 162 | * \param value The value to be set. |
Kojto | 20:30b6ed7bf8fd | 163 | */ |
Kojto | 20:30b6ed7bf8fd | 164 | void set_data_received_flag(uint8_t value); |
Kojto | 20:30b6ed7bf8fd | 165 | /** Returns if tx was completed. |
Kojto | 20:30b6ed7bf8fd | 166 | * \return |
Kojto | 20:30b6ed7bf8fd | 167 | * true if tx was completed, |
Kojto | 20:30b6ed7bf8fd | 168 | * false otherwise. |
Kojto | 20:30b6ed7bf8fd | 169 | */ |
Kojto | 20:30b6ed7bf8fd | 170 | bool get_tx_complete_signal(); |
Kojto | 20:30b6ed7bf8fd | 171 | /** |
Kojto | 33:9e23b24fb4f3 | 172 | * \brief Sets flag that tx was completed. |
Kojto | 33:9e23b24fb4f3 | 173 | * \param value Value to be set |
Kojto | 33:9e23b24fb4f3 | 174 | * \return none |
Kojto | 20:30b6ed7bf8fd | 175 | */ |
Kojto | 20:30b6ed7bf8fd | 176 | void set_tx_complete_signal(bool value); |
Kojto | 20:30b6ed7bf8fd | 177 | /** |
Kojto | 33:9e23b24fb4f3 | 178 | * \brief Get receive buffer. |
Kojto | 33:9e23b24fb4f3 | 179 | * \param none |
Kojto | 33:9e23b24fb4f3 | 180 | * \return Pointer to the receive buffer. |
Kojto | 20:30b6ed7bf8fd | 181 | */ |
Kojto | 20:30b6ed7bf8fd | 182 | uint8_t *get_received_buffer(); |
Kojto | 20:30b6ed7bf8fd | 183 | /** |
Kojto | 33:9e23b24fb4f3 | 184 | * \brief Get transmit buffer. |
Kojto | 33:9e23b24fb4f3 | 185 | * \param none |
Kojto | 33:9e23b24fb4f3 | 186 | * \return Pointer to the transmit buffer. |
Kojto | 20:30b6ed7bf8fd | 187 | */ |
Kojto | 20:30b6ed7bf8fd | 188 | uint8_t *get_transmit_buffer(); |
Kojto | 20:30b6ed7bf8fd | 189 | /** |
Kojto | 33:9e23b24fb4f3 | 190 | * \brief Get number of free buffers. |
Kojto | 33:9e23b24fb4f3 | 191 | * \param none |
Kojto | 29:c40918cd9b6d | 192 | * \return |
Kojto | 33:9e23b24fb4f3 | 193 | * Number of free buffers. |
Kojto | 20:30b6ed7bf8fd | 194 | */ |
Kojto | 20:30b6ed7bf8fd | 195 | uint16_t get_number_free_buffers(); |
Kojto | 20:30b6ed7bf8fd | 196 | /** |
Kojto | 33:9e23b24fb4f3 | 197 | * \brief Set number of free buffers. |
Kojto | 33:9e23b24fb4f3 | 198 | * \param value Number of free buffers. |
Kojto | 33:9e23b24fb4f3 | 199 | * \return none |
Kojto | 20:30b6ed7bf8fd | 200 | */ |
Kojto | 20:30b6ed7bf8fd | 201 | void set_number_free_buffers(uint16_t value); |
Kojto | 20:30b6ed7bf8fd | 202 | /** |
Kojto | 33:9e23b24fb4f3 | 203 | * \brief Retrieve buffer length. |
Kojto | 33:9e23b24fb4f3 | 204 | * \param none |
Kojto | 33:9e23b24fb4f3 | 205 | * \return Buffer length |
Kojto | 20:30b6ed7bf8fd | 206 | */ |
Kojto | 20:30b6ed7bf8fd | 207 | uint16_t get_buffer_length(); |
Kojto | 20:30b6ed7bf8fd | 208 | /** |
Kojto | 33:9e23b24fb4f3 | 209 | * \brief Set buffer length |
Kojto | 33:9e23b24fb4f3 | 210 | * \param value The length |
Kojto | 33:9e23b24fb4f3 | 211 | * \return none |
Kojto | 20:30b6ed7bf8fd | 212 | */ |
Kojto | 20:30b6ed7bf8fd | 213 | void set_buffer_length(uint16_t value); |
Kojto | 20:30b6ed7bf8fd | 214 | /** |
Kojto | 33:9e23b24fb4f3 | 215 | * \brief Retrieve pending data flag. |
Kojto | 33:9e23b24fb4f3 | 216 | * \param none |
Kojto | 33:9e23b24fb4f3 | 217 | * \return Pending data flag |
Kojto | 20:30b6ed7bf8fd | 218 | */ |
Kojto | 20:30b6ed7bf8fd | 219 | uint16_t get_pending_data(); |
Kojto | 20:30b6ed7bf8fd | 220 | /** |
Kojto | 33:9e23b24fb4f3 | 221 | * \brief Set pending data flag. |
Kojto | 33:9e23b24fb4f3 | 222 | * \param value Pending data value. |
Kojto | 33:9e23b24fb4f3 | 223 | * \return none |
Kojto | 20:30b6ed7bf8fd | 224 | */ |
Kojto | 20:30b6ed7bf8fd | 225 | void set_pending_data(uint16_t value); |
Kojto | 20:30b6ed7bf8fd | 226 | /** |
Kojto | 33:9e23b24fb4f3 | 227 | * \brief Retreive op code. |
Kojto | 33:9e23b24fb4f3 | 228 | * \param none |
Kojto | 33:9e23b24fb4f3 | 229 | * \return Op code |
Kojto | 20:30b6ed7bf8fd | 230 | */ |
Kojto | 20:30b6ed7bf8fd | 231 | uint16_t get_op_code(); |
Kojto | 20:30b6ed7bf8fd | 232 | /** |
Kojto | 33:9e23b24fb4f3 | 233 | * \brief Set op code. |
Kojto | 33:9e23b24fb4f3 | 234 | * \param code op code. |
Kojto | 33:9e23b24fb4f3 | 235 | * \return none |
Kojto | 20:30b6ed7bf8fd | 236 | */ |
Kojto | 20:30b6ed7bf8fd | 237 | void set_op_code(uint16_t code); |
Kojto | 20:30b6ed7bf8fd | 238 | /** |
Kojto | 33:9e23b24fb4f3 | 239 | * \brief Get number of released packets. |
Kojto | 33:9e23b24fb4f3 | 240 | * \param none |
Kojto | 33:9e23b24fb4f3 | 241 | * \return Number of released packets. |
Kojto | 20:30b6ed7bf8fd | 242 | */ |
Kojto | 20:30b6ed7bf8fd | 243 | uint16_t get_released_packets(); |
Kojto | 20:30b6ed7bf8fd | 244 | /** |
Kojto | 33:9e23b24fb4f3 | 245 | * \brief Set number of released packets. |
Kojto | 33:9e23b24fb4f3 | 246 | * \param value Number of released packets. |
Kojto | 33:9e23b24fb4f3 | 247 | * \return none |
Kojto | 20:30b6ed7bf8fd | 248 | */ |
Kojto | 20:30b6ed7bf8fd | 249 | void set_number_of_released_packets(uint16_t value); |
Kojto | 20:30b6ed7bf8fd | 250 | /** |
Kojto | 33:9e23b24fb4f3 | 251 | * \brief Get number of sent packats |
Kojto | 33:9e23b24fb4f3 | 252 | * \param none |
Kojto | 33:9e23b24fb4f3 | 253 | * \return Number of sent packets. |
Kojto | 20:30b6ed7bf8fd | 254 | */ |
Kojto | 20:30b6ed7bf8fd | 255 | uint16_t get_sent_packets(); |
Kojto | 20:30b6ed7bf8fd | 256 | /** |
Kojto | 33:9e23b24fb4f3 | 257 | * \brief Set number of sent packets |
Kojto | 33:9e23b24fb4f3 | 258 | * \param value Number of sent packets. |
Kojto | 33:9e23b24fb4f3 | 259 | * \return none |
Kojto | 20:30b6ed7bf8fd | 260 | */ |
Kojto | 20:30b6ed7bf8fd | 261 | void set_sent_packets(uint16_t value); |
Kojto | 29:c40918cd9b6d | 262 | /** |
Kojto | 33:9e23b24fb4f3 | 263 | * \brief Retrieve transmit error |
Kojto | 33:9e23b24fb4f3 | 264 | * \param none |
Kojto | 33:9e23b24fb4f3 | 265 | * \return Transmit error |
Kojto | 29:c40918cd9b6d | 266 | */ |
Kojto | 20:30b6ed7bf8fd | 267 | int32_t get_transmit_error(); |
Kojto | 29:c40918cd9b6d | 268 | /** |
Kojto | 33:9e23b24fb4f3 | 269 | * \brief Set transmit error. |
Kojto | 33:9e23b24fb4f3 | 270 | * \param value Error to be set. |
Kojto | 33:9e23b24fb4f3 | 271 | * \return none |
Kojto | 29:c40918cd9b6d | 272 | */ |
Kojto | 20:30b6ed7bf8fd | 273 | void set_transmit_error(int32_t value); |
Kojto | 29:c40918cd9b6d | 274 | /** |
Kojto | 33:9e23b24fb4f3 | 275 | * \brief Get buffer size. |
Kojto | 33:9e23b24fb4f3 | 276 | * \param none |
Kojto | 33:9e23b24fb4f3 | 277 | * \return Size of buffer. |
Kojto | 29:c40918cd9b6d | 278 | */ |
Kojto | 33:9e23b24fb4f3 | 279 | uint16_t get_buffer_size(); |
Kojto | 29:c40918cd9b6d | 280 | /** |
Kojto | 33:9e23b24fb4f3 | 281 | * \brief Set buffer size. |
Kojto | 33:9e23b24fb4f3 | 282 | * \param value Buffer size. |
Kojto | 33:9e23b24fb4f3 | 283 | * \return none |
Kojto | 29:c40918cd9b6d | 284 | */ |
Kojto | 20:30b6ed7bf8fd | 285 | void set_buffer_size(uint16_t value); |
Kojto | 29:c40918cd9b6d | 286 | /** |
Kojto | 33:9e23b24fb4f3 | 287 | * \brief Not used currently. |
Kojto | 33:9e23b24fb4f3 | 288 | * \param function Number of desired function. |
Kojto | 33:9e23b24fb4f3 | 289 | * \return void pointer to the function (need to recast). |
Kojto | 29:c40918cd9b6d | 290 | */ |
Kojto | 20:30b6ed7bf8fd | 291 | void *get_func_pointer(FunctionNumber function); |
Kojto | 29:c40918cd9b6d | 292 | /** |
Kojto | 33:9e23b24fb4f3 | 293 | * \brief Retreive pointer to the received data. |
Kojto | 33:9e23b24fb4f3 | 294 | * \param none |
Kojto | 33:9e23b24fb4f3 | 295 | * \return Pointer to the received data buffer. |
Kojto | 29:c40918cd9b6d | 296 | */ |
Kojto | 33:9e23b24fb4f3 | 297 | uint8_t *get_received_data(); |
Kojto | 29:c40918cd9b6d | 298 | /** |
Kojto | 33:9e23b24fb4f3 | 299 | * \brief Set received data pointer. |
Kojto | 33:9e23b24fb4f3 | 300 | * \param pointer Pointer to the buffer. |
Kojto | 33:9e23b24fb4f3 | 301 | * \return none |
Kojto | 29:c40918cd9b6d | 302 | */ |
Kojto | 20:30b6ed7bf8fd | 303 | void set_received_data(uint8_t *pointer); |
Kojto | 20:30b6ed7bf8fd | 304 | private: |
Kojto | 20:30b6ed7bf8fd | 305 | uint8_t _data_received_flag; |
Kojto | 20:30b6ed7bf8fd | 306 | bool _tx_complete_signal; |
Kojto | 20:30b6ed7bf8fd | 307 | uint16_t _rx_event_opcode; |
Kojto | 20:30b6ed7bf8fd | 308 | uint16_t _free_buffers; |
Kojto | 20:30b6ed7bf8fd | 309 | uint16_t _buffer_length; |
Kojto | 20:30b6ed7bf8fd | 310 | uint16_t _buffer_size; |
Kojto | 20:30b6ed7bf8fd | 311 | uint16_t _rx_data_pending; |
Kojto | 20:30b6ed7bf8fd | 312 | uint16_t _sent_packets; |
Kojto | 20:30b6ed7bf8fd | 313 | uint16_t _released_packets; |
Kojto | 20:30b6ed7bf8fd | 314 | int32_t _transmit_data_error; |
Kojto | 20:30b6ed7bf8fd | 315 | uint8_t *_received_data; |
Kojto | 20:30b6ed7bf8fd | 316 | uint8_t _rx_buffer[CC3000_RX_BUFFER_SIZE]; |
Kojto | 20:30b6ed7bf8fd | 317 | uint8_t _tx_buffer[CC3000_TX_BUFFER_SIZE]; |
Kojto | 20:30b6ed7bf8fd | 318 | private: |
Kojto | 33:9e23b24fb4f3 | 319 | /* Not used currently */ |
Kojto | 20:30b6ed7bf8fd | 320 | int8_t *(* _fFWPatches)(uint32_t *length); |
Kojto | 20:30b6ed7bf8fd | 321 | int8_t *(* _fDriverPatches)(uint32_t *length); |
Kojto | 20:30b6ed7bf8fd | 322 | int8_t *(* _fBootLoaderPatches)(uint32_t *length); |
Kojto | 20:30b6ed7bf8fd | 323 | }; |
Kojto | 20:30b6ed7bf8fd | 324 | |
Kojto | 20:30b6ed7bf8fd | 325 | /** Forward declaration classes |
Kojto | 20:30b6ed7bf8fd | 326 | */ |
Kojto | 20:30b6ed7bf8fd | 327 | class cc3000_hci; |
Kojto | 20:30b6ed7bf8fd | 328 | class cc3000_nvmem; |
Kojto | 20:30b6ed7bf8fd | 329 | class cc3000_spi; |
Kojto | 20:30b6ed7bf8fd | 330 | class cc3000; |
Kojto | 20:30b6ed7bf8fd | 331 | |
Kojto | 31:7b6e85b68b01 | 332 | /** Event layer |
Kojto | 20:30b6ed7bf8fd | 333 | */ |
Kojto | 20:30b6ed7bf8fd | 334 | class cc3000_event { |
Kojto | 20:30b6ed7bf8fd | 335 | public: |
Kojto | 29:c40918cd9b6d | 336 | /** |
Kojto | 45:50ab13d8f2dc | 337 | * \brief Ctor |
Kojto | 34:1ad18123bf11 | 338 | * \param simplelink Reference to simple link object. |
Kojto | 34:1ad18123bf11 | 339 | * \param hci Reference to hci object. |
Kojto | 34:1ad18123bf11 | 340 | * \param spi Reference to spi object. |
Kojto | 34:1ad18123bf11 | 341 | * \param cc3000 Reference to cc3000 object. |
Kojto | 34:1ad18123bf11 | 342 | * \return none |
Kojto | 29:c40918cd9b6d | 343 | */ |
Kojto | 20:30b6ed7bf8fd | 344 | cc3000_event(cc3000_simple_link &simplelink, cc3000_hci &hci, cc3000_spi &spi, cc3000 &cc3000); |
Kojto | 29:c40918cd9b6d | 345 | /** |
Kojto | 45:50ab13d8f2dc | 346 | * \brief Dtor |
Kojto | 34:1ad18123bf11 | 347 | * \param none |
Kojto | 34:1ad18123bf11 | 348 | * \return none |
Kojto | 29:c40918cd9b6d | 349 | */ |
Kojto | 29:c40918cd9b6d | 350 | ~cc3000_event(); |
Kojto | 34:1ad18123bf11 | 351 | /** |
Kojto | 34:1ad18123bf11 | 352 | * \brief Handle unsolicited event from type patch request. |
Kojto | 34:1ad18123bf11 | 353 | * \param event_hdr event header |
Kojto | 34:1ad18123bf11 | 354 | * \return none |
Kojto | 29:c40918cd9b6d | 355 | */ |
Kojto | 20:30b6ed7bf8fd | 356 | void hci_unsol_handle_patch_request(uint8_t *event_hdr); |
Kojto | 29:c40918cd9b6d | 357 | /** |
Kojto | 34:1ad18123bf11 | 358 | * \brief Parse the incoming event packets and issue corresponding event handler from global array of handlers pointers. |
Kojto | 34:1ad18123bf11 | 359 | * \param ret_param incoming data buffer |
Kojto | 34:1ad18123bf11 | 360 | * \param from from information (in case of data received) |
Kojto | 34:1ad18123bf11 | 361 | * \param fromlen from information length (in case of data received) |
Kojto | 34:1ad18123bf11 | 362 | * \return none |
Kojto | 34:1ad18123bf11 | 363 | */ |
Kojto | 45:50ab13d8f2dc | 364 | uint8_t* hci_event_handler(void *ret_param, uint8_t *from, uint8_t *fromlen); |
Kojto | 29:c40918cd9b6d | 365 | /** |
Kojto | 34:1ad18123bf11 | 366 | * \brief Handle unsolicited events. |
Kojto | 34:1ad18123bf11 | 367 | * \param event_hdr Event header |
Kojto | 34:1ad18123bf11 | 368 | * \return 1 if event supported and handled |
Kojto | 34:1ad18123bf11 | 369 | * \return 0 if event is not supported |
Kojto | 34:1ad18123bf11 | 370 | */ |
Kojto | 20:30b6ed7bf8fd | 371 | int32_t hci_unsol_event_handler(uint8_t *event_hdr); |
Kojto | 29:c40918cd9b6d | 372 | /** |
Kojto | 34:1ad18123bf11 | 373 | * \brief Parse the incoming unsolicited event packets and start corresponding event handler. |
Kojto | 34:1ad18123bf11 | 374 | * \param None |
Kojto | 34:1ad18123bf11 | 375 | * \return ESUCCESS if successful, EFAIL if an error occurred. |
Kojto | 34:1ad18123bf11 | 376 | */ |
Kojto | 20:30b6ed7bf8fd | 377 | int32_t hci_unsolicited_event_handler(void); |
Kojto | 29:c40918cd9b6d | 378 | /** |
Kojto | 34:1ad18123bf11 | 379 | * \brief Get the socket status. |
Kojto | 34:1ad18123bf11 | 380 | * \param Sd Socket IS |
Kojto | 34:1ad18123bf11 | 381 | * \return Current status of the socket. |
Kojto | 34:1ad18123bf11 | 382 | */ |
Kojto | 20:30b6ed7bf8fd | 383 | int32_t get_socket_active_status(int32_t sd); |
Kojto | 29:c40918cd9b6d | 384 | /** |
Kojto | 34:1ad18123bf11 | 385 | * \brief Check if the socket ID and status are valid and set the global socket status accordingly. |
Kojto | 34:1ad18123bf11 | 386 | * \param Sd Sock descr |
Kojto | 34:1ad18123bf11 | 387 | * \param Status status to be set |
Kojto | 34:1ad18123bf11 | 388 | * \return none |
Kojto | 34:1ad18123bf11 | 389 | */ |
Kojto | 20:30b6ed7bf8fd | 390 | void set_socket_active_status(int32_t sd, int32_t status); |
Kojto | 29:c40918cd9b6d | 391 | /** |
Kojto | 34:1ad18123bf11 | 392 | * \brief Keep track on the number of packets transmitted and update the number of free buffer in the SL device. |
Kojto | 34:1ad18123bf11 | 393 | * \brief Called when unsolicited event = HCI_EVNT_DATA_UNSOL_FREE_BUFF has received. |
Kojto | 34:1ad18123bf11 | 394 | * \param event pointer to the string contains parameters for IPERF. |
Kojto | 34:1ad18123bf11 | 395 | * \return ESUCCESS if successful, EFAIL if an error occurred. |
Kojto | 34:1ad18123bf11 | 396 | */ |
Kojto | 20:30b6ed7bf8fd | 397 | int32_t hci_event_unsol_flowcontrol_handler(uint8_t *event); |
Kojto | 29:c40918cd9b6d | 398 | /** |
Kojto | 34:1ad18123bf11 | 399 | * \brief Update the socket status. |
Kojto | 34:1ad18123bf11 | 400 | * \param resp_params Socket IS |
Kojto | 34:1ad18123bf11 | 401 | * \return Current status of the socket. |
Kojto | 34:1ad18123bf11 | 402 | */ |
Kojto | 20:30b6ed7bf8fd | 403 | void update_socket_active_status(uint8_t *resp_params); |
Kojto | 29:c40918cd9b6d | 404 | /** |
Kojto | 34:1ad18123bf11 | 405 | * \brief Wait for event, pass it to the hci_event_handler and update the event opcode in a global variable. |
Kojto | 34:1ad18123bf11 | 406 | * \param op_code Command operation code |
Kojto | 34:1ad18123bf11 | 407 | * \param ret_param Command return parameters |
Kojto | 34:1ad18123bf11 | 408 | * \return none |
Kojto | 29:c40918cd9b6d | 409 | */ |
Kojto | 20:30b6ed7bf8fd | 410 | void simplelink_wait_event(uint16_t op_code, void *ret_param); |
Kojto | 29:c40918cd9b6d | 411 | /** |
Kojto | 34:1ad18123bf11 | 412 | * \brief Wait for data, pass it to the hci_event_handler and set the data available flag. |
Kojto | 34:1ad18123bf11 | 413 | * \param buffer Data buffer |
Kojto | 34:1ad18123bf11 | 414 | * \param from From information |
Kojto | 34:1ad18123bf11 | 415 | * \param fromlen From information length |
Kojto | 34:1ad18123bf11 | 416 | * \return none |
Kojto | 29:c40918cd9b6d | 417 | */ |
Kojto | 20:30b6ed7bf8fd | 418 | void simplelink_wait_data(uint8_t *buffer, uint8_t *from, uint8_t *fromlen); |
Kojto | 29:c40918cd9b6d | 419 | /** |
Kojto | 34:1ad18123bf11 | 420 | * \brief Trigger Received event/data processing - called from the SPI library to receive the data |
Kojto | 34:1ad18123bf11 | 421 | * \param buffer pointer to the received data buffer\n |
Kojto | 34:1ad18123bf11 | 422 | * The function triggers Received event/data processing\n |
Kojto | 34:1ad18123bf11 | 423 | * \return none |
Kojto | 29:c40918cd9b6d | 424 | */ |
Kojto | 20:30b6ed7bf8fd | 425 | void received_handler(uint8_t *buffer); |
Kojto | 34:1ad18123bf11 | 426 | private: |
Kojto | 20:30b6ed7bf8fd | 427 | uint32_t socket_active_status; |
Kojto | 20:30b6ed7bf8fd | 428 | cc3000_simple_link &_simple_link; |
Kojto | 20:30b6ed7bf8fd | 429 | cc3000_hci &_hci; |
Kojto | 20:30b6ed7bf8fd | 430 | cc3000_spi &_spi; |
Kojto | 20:30b6ed7bf8fd | 431 | cc3000 &_cc3000; |
Kojto | 20:30b6ed7bf8fd | 432 | }; |
Kojto | 20:30b6ed7bf8fd | 433 | |
Kojto | 31:7b6e85b68b01 | 434 | /** Netapp layer |
Kojto | 31:7b6e85b68b01 | 435 | */ |
Kojto | 20:30b6ed7bf8fd | 436 | class cc3000_netapp { |
Kojto | 20:30b6ed7bf8fd | 437 | public: |
Kojto | 29:c40918cd9b6d | 438 | /** |
Kojto | 34:1ad18123bf11 | 439 | * \brief Ctor |
Kojto | 34:1ad18123bf11 | 440 | * \param simple_link Reference to the simple link object. |
Kojto | 34:1ad18123bf11 | 441 | * \param nvmem Reference to the nvmem object. |
Kojto | 34:1ad18123bf11 | 442 | * \param hci Reference to the hci object. |
Kojto | 34:1ad18123bf11 | 443 | * \param event Reference to the event object. |
Kojto | 34:1ad18123bf11 | 444 | * \return none |
Kojto | 29:c40918cd9b6d | 445 | */ |
Kojto | 20:30b6ed7bf8fd | 446 | cc3000_netapp(cc3000_simple_link &simple_link, cc3000_nvmem &nvmem, cc3000_hci &hci, cc3000_event &event); |
Kojto | 29:c40918cd9b6d | 447 | /** |
Kojto | 34:1ad18123bf11 | 448 | * \brief Dtor |
Kojto | 34:1ad18123bf11 | 449 | * \param none |
Kojto | 34:1ad18123bf11 | 450 | * \return none |
Kojto | 29:c40918cd9b6d | 451 | */ |
Kojto | 20:30b6ed7bf8fd | 452 | ~cc3000_netapp(); |
Kojto | 29:c40918cd9b6d | 453 | /** |
Kojto | 34:1ad18123bf11 | 454 | * \brief Configure device MAC address and store it in NVMEM. |
Kojto | 34:1ad18123bf11 | 455 | * The value of the MAC address configured through the API will be\n |
Kojto | 34:1ad18123bf11 | 456 | * stored in CC3000 non volatile memory, thus preserved over resets.\n |
Kojto | 34:1ad18123bf11 | 457 | * \param mac device mac address, 6 bytes. Saved: yes |
Kojto | 34:1ad18123bf11 | 458 | * \return return on success 0, otherwise error. |
Kojto | 29:c40918cd9b6d | 459 | */ |
Kojto | 20:30b6ed7bf8fd | 460 | int32_t config_mac_adrress(uint8_t *mac); |
Kojto | 29:c40918cd9b6d | 461 | /** |
Kojto | 34:1ad18123bf11 | 462 | * \brief Configure the network interface, static or dynamic (DHCP). |
Kojto | 34:1ad18123bf11 | 463 | * In order to activate DHCP mode, ip, subnet_mask, default_gateway must be 0.\n |
Kojto | 34:1ad18123bf11 | 464 | * The default mode of CC3000 is DHCP mode. The configuration is saved in non volatile memory\n |
Kojto | 34:1ad18123bf11 | 465 | * and thus preserved over resets.\n |
Kojto | 34:1ad18123bf11 | 466 | * \param ip device mac address, 6 bytes. Saved: yes |
Kojto | 34:1ad18123bf11 | 467 | * \param subnet_mask device mac address, 6 bytes. Saved: yes |
Kojto | 34:1ad18123bf11 | 468 | * \param default_gateway device mac address, 6 bytes. Saved: yes |
Kojto | 34:1ad18123bf11 | 469 | * \param dns_server device mac address, 6 bytes. Saved: yes |
Kojto | 34:1ad18123bf11 | 470 | * \return 0 on success, otherwise error. |
Kojto | 34:1ad18123bf11 | 471 | * \note If the mode is altered, a reset of CC3000 device is required to apply the changes.\n |
Kojto | 34:1ad18123bf11 | 472 | * Also note that an asynchronous event of type 'DHCP_EVENT' is generated only when\n |
Kojto | 34:1ad18123bf11 | 473 | * a connection to the AP was established. This event is generated when an IP address\n |
Kojto | 34:1ad18123bf11 | 474 | * is allocated either by the DHCP server or by static allocation.\n |
Kojto | 29:c40918cd9b6d | 475 | */ |
Kojto | 20:30b6ed7bf8fd | 476 | int32_t dhcp(uint32_t *ip, uint32_t *subnet_mask,uint32_t *default_gateway, uint32_t *dns_server); |
Kojto | 20:30b6ed7bf8fd | 477 | #ifndef CC3000_TINY_DRIVER |
Kojto | 29:c40918cd9b6d | 478 | /** |
Kojto | 34:1ad18123bf11 | 479 | * \brief Get the CC3000 Network interface information. |
Kojto | 34:1ad18123bf11 | 480 | * This information is only available after establishing a WLAN connection.\n |
Kojto | 34:1ad18123bf11 | 481 | * Undefined values are returned when this function is called before association.\n |
Kojto | 34:1ad18123bf11 | 482 | * \param ipconfig pointer to a tNetappIpconfigRetArgs structure for storing the network interface configuration.\n |
Kojto | 34:1ad18123bf11 | 483 | * tNetappIpconfigRetArgs: aucIP - ip address,\n |
Kojto | 34:1ad18123bf11 | 484 | * aucSubnetMask - mask |
Kojto | 34:1ad18123bf11 | 485 | * aucDefaultGateway - default gateway address\n |
Kojto | 34:1ad18123bf11 | 486 | * aucDHCPServer - dhcp server address\n |
Kojto | 34:1ad18123bf11 | 487 | * aucDNSServer - dns server address\n |
Kojto | 34:1ad18123bf11 | 488 | * uaMacAddr - mac address\n |
Kojto | 34:1ad18123bf11 | 489 | * uaSSID - connected AP ssid\n |
Kojto | 34:1ad18123bf11 | 490 | * \return none |
Kojto | 34:1ad18123bf11 | 491 | * \note This function is useful for figuring out the IP Configuration of\n |
Kojto | 34:1ad18123bf11 | 492 | * the device when DHCP is used and for figuring out the SSID of\n |
Kojto | 34:1ad18123bf11 | 493 | * the Wireless network the device is associated with.\n |
Kojto | 29:c40918cd9b6d | 494 | */ |
Kojto | 20:30b6ed7bf8fd | 495 | void ipconfig(tNetappIpconfigRetArgs *ipconfig); |
Kojto | 29:c40918cd9b6d | 496 | /** |
Kojto | 34:1ad18123bf11 | 497 | * \brief Set new timeout values for DHCP lease timeout, ARP refresh timeout, keepalive event timeout and socket inactivity timeout |
Kojto | 34:1ad18123bf11 | 498 | * \param dhcp DHCP lease time request, also impact\n |
Kojto | 34:1ad18123bf11 | 499 | * the DHCP renew timeout.\n |
Kojto | 34:1ad18123bf11 | 500 | * Range: [0-0xffffffff] seconds,\n |
Kojto | 34:1ad18123bf11 | 501 | * 0 or 0xffffffff = infinite lease timeout.\n |
Kojto | 34:1ad18123bf11 | 502 | * Resolution: 10 seconds.\n |
Kojto | 34:1ad18123bf11 | 503 | * Influence: only after reconnecting to the AP. \n |
Kojto | 34:1ad18123bf11 | 504 | * Minimal bound value: MIN_TIMER_VAL_SECONDS - 20 seconds.\n |
Kojto | 34:1ad18123bf11 | 505 | * The parameter is saved into the CC3000 NVMEM.\n |
Kojto | 34:1ad18123bf11 | 506 | * The default value on CC3000 is 14400 seconds.\n |
Kojto | 34:1ad18123bf11 | 507 | * |
Kojto | 34:1ad18123bf11 | 508 | * \param arp ARP refresh timeout, if ARP entry is not updated by\n |
Kojto | 34:1ad18123bf11 | 509 | * incoming packet, the ARP entry will be deleted by\n |
Kojto | 34:1ad18123bf11 | 510 | * the end of the timeout. \n |
Kojto | 34:1ad18123bf11 | 511 | * Range: [0-0xffffffff] seconds, 0 = infinite ARP timeout\n |
Kojto | 34:1ad18123bf11 | 512 | * Resolution: 10 seconds.\n |
Kojto | 34:1ad18123bf11 | 513 | * Influence: at runtime.\n |
Kojto | 34:1ad18123bf11 | 514 | * Minimal bound value: MIN_TIMER_VAL_SECONDS - 20 seconds\n |
Kojto | 34:1ad18123bf11 | 515 | * The parameter is saved into the CC3000 NVMEM.\n |
Kojto | 34:1ad18123bf11 | 516 | * The default value on CC3000 is 3600 seconds.\n |
Kojto | 34:1ad18123bf11 | 517 | * |
Kojto | 34:1ad18123bf11 | 518 | * \param keep_alive Keepalive event sent by the end of keepalive timeout\n |
Kojto | 34:1ad18123bf11 | 519 | * Range: [0-0xffffffff] seconds, 0 == infinite timeout\n |
Kojto | 34:1ad18123bf11 | 520 | * Resolution: 10 seconds.\n |
Kojto | 34:1ad18123bf11 | 521 | * Influence: at runtime.\n |
Kojto | 34:1ad18123bf11 | 522 | * Minimal bound value: MIN_TIMER_VAL_SECONDS - 20 sec\n |
Kojto | 34:1ad18123bf11 | 523 | * The parameter is saved into the CC3000 NVMEM. \n |
Kojto | 34:1ad18123bf11 | 524 | * The default value on CC3000 is 10 seconds.\n |
Kojto | 34:1ad18123bf11 | 525 | * |
Kojto | 34:1ad18123bf11 | 526 | * \param inactivity Socket inactivity timeout, socket timeout is\n |
Kojto | 34:1ad18123bf11 | 527 | * refreshed by incoming or outgoing packet, by the\n |
Kojto | 34:1ad18123bf11 | 528 | * end of the socket timeout the socket will be closed\n |
Kojto | 34:1ad18123bf11 | 529 | * Range: [0-0xffffffff] sec, 0 == infinite timeout.\n |
Kojto | 34:1ad18123bf11 | 530 | * Resolution: 10 seconds.\n |
Kojto | 34:1ad18123bf11 | 531 | * Influence: at runtime.\n |
Kojto | 34:1ad18123bf11 | 532 | * Minimal bound value: MIN_TIMER_VAL_SECONDS - 20 sec\n |
Kojto | 34:1ad18123bf11 | 533 | * The parameter is saved into the CC3000 NVMEM.\n |
Kojto | 34:1ad18123bf11 | 534 | * The default value on CC3000 is 60 seconds.\n |
Kojto | 34:1ad18123bf11 | 535 | * |
Kojto | 34:1ad18123bf11 | 536 | * \return 0 on success,otherwise error. |
Kojto | 34:1ad18123bf11 | 537 | * |
Kojto | 34:1ad18123bf11 | 538 | * \note A parameter set to a non zero value less than 20s automatically changes to 20s. |
Kojto | 29:c40918cd9b6d | 539 | */ |
Kojto | 20:30b6ed7bf8fd | 540 | int32_t timeout_values(uint32_t *dhcp, uint32_t *arp,uint32_t *keep_alive, uint32_t *inactivity); |
Kojto | 29:c40918cd9b6d | 541 | /** |
Kojto | 34:1ad18123bf11 | 542 | * \brief send ICMP ECHO_REQUEST to network hosts |
Kojto | 34:1ad18123bf11 | 543 | * \param ip destination IP address |
Kojto | 34:1ad18123bf11 | 544 | * \param ping_attempts number of echo requests to send |
Kojto | 34:1ad18123bf11 | 545 | * \param ping_size send buffer size which may be up to 1400 bytes |
Kojto | 34:1ad18123bf11 | 546 | * \param ping_timeout Time to wait for a response,in milliseconds. |
Kojto | 34:1ad18123bf11 | 547 | * \return 0 on success, otherwise error. |
Kojto | 34:1ad18123bf11 | 548 | * |
Kojto | 34:1ad18123bf11 | 549 | * \note A succesful operation will generate an asynchronous ping report event.\n |
Kojto | 34:1ad18123bf11 | 550 | * The report structure is defined by structure netapp_pingreport_args_t.\n |
Kojto | 34:1ad18123bf11 | 551 | * \warning Calling this function while a Ping Request is in progress will kill the ping request in progress. |
Kojto | 29:c40918cd9b6d | 552 | */ |
Kojto | 20:30b6ed7bf8fd | 553 | int32_t ping_send(uint32_t *ip, uint32_t ping_attempts, uint32_t ping_size, uint32_t ping_timeout); |
Kojto | 29:c40918cd9b6d | 554 | /** |
Kojto | 34:1ad18123bf11 | 555 | * \brief Ping status request. |
Kojto | 34:1ad18123bf11 | 556 | * This API triggers the CC3000 to send asynchronous events: HCI_EVNT_WLAN_ASYNC_PING_REPORT.\n |
Kojto | 34:1ad18123bf11 | 557 | * This event will create the report structure in netapp_pingreport_args_t.\n |
Kojto | 34:1ad18123bf11 | 558 | * This structure is filled with ping results until the API is triggered.\n |
Kojto | 34:1ad18123bf11 | 559 | * netapp_pingreport_args_t: packets_sent - echo sent\n |
Kojto | 34:1ad18123bf11 | 560 | * packets_received - echo reply\n |
Kojto | 34:1ad18123bf11 | 561 | * min_round_time - minimum round time\n |
Kojto | 34:1ad18123bf11 | 562 | * max_round_time - max round time\n |
Kojto | 34:1ad18123bf11 | 563 | * avg_round_time - average round time\n |
Kojto | 34:1ad18123bf11 | 564 | * |
Kojto | 34:1ad18123bf11 | 565 | * \param none |
Kojto | 34:1ad18123bf11 | 566 | * \return none |
Kojto | 34:1ad18123bf11 | 567 | * \note When a ping operation is not active, the returned structure fields are 0. |
Kojto | 29:c40918cd9b6d | 568 | */ |
Kojto | 20:30b6ed7bf8fd | 569 | void ping_report(); |
Kojto | 29:c40918cd9b6d | 570 | /** |
Kojto | 34:1ad18123bf11 | 571 | * \brief Stop any ping request. |
Kojto | 34:1ad18123bf11 | 572 | * \param none |
Kojto | 34:1ad18123bf11 | 573 | * \return 0 on success |
Kojto | 34:1ad18123bf11 | 574 | * -1 on error |
Kojto | 29:c40918cd9b6d | 575 | */ |
Kojto | 20:30b6ed7bf8fd | 576 | int32_t ping_stop(); |
Kojto | 29:c40918cd9b6d | 577 | /** |
Kojto | 34:1ad18123bf11 | 578 | * \brief Flush ARP table |
Kojto | 34:1ad18123bf11 | 579 | * \param none |
Kojto | 34:1ad18123bf11 | 580 | * \return none |
Kojto | 29:c40918cd9b6d | 581 | */ |
Kojto | 20:30b6ed7bf8fd | 582 | int32_t arp_flush(); |
Kojto | 20:30b6ed7bf8fd | 583 | #endif |
Kojto | 20:30b6ed7bf8fd | 584 | private: |
Kojto | 20:30b6ed7bf8fd | 585 | cc3000_simple_link &_simple_link; |
Kojto | 20:30b6ed7bf8fd | 586 | cc3000_nvmem &_nvmem; |
Kojto | 20:30b6ed7bf8fd | 587 | cc3000_hci &_hci; |
Kojto | 20:30b6ed7bf8fd | 588 | cc3000_event &_event; |
Kojto | 20:30b6ed7bf8fd | 589 | }; |
Kojto | 20:30b6ed7bf8fd | 590 | |
Kojto | 20:30b6ed7bf8fd | 591 | #ifndef CC3000_UNENCRYPTED_SMART_CONFIG |
Kojto | 31:7b6e85b68b01 | 592 | /** Security class used only if encrypted smart config is set |
Kojto | 31:7b6e85b68b01 | 593 | */ |
Kojto | 20:30b6ed7bf8fd | 594 | class cc3000_security { |
Kojto | 20:30b6ed7bf8fd | 595 | public: |
Kojto | 29:c40918cd9b6d | 596 | /** |
Kojto | 34:1ad18123bf11 | 597 | * \brief Expand a 16 bytes key for AES128 implementation. |
Kojto | 34:1ad18123bf11 | 598 | * \param expanded_key expanded AES128 key |
Kojto | 34:1ad18123bf11 | 599 | * \param key AES128 key - 16 bytes |
Kojto | 34:1ad18123bf11 | 600 | * \return none |
Kojto | 29:c40918cd9b6d | 601 | */ |
Kojto | 20:30b6ed7bf8fd | 602 | void expandKey(uint8_t *expanded_key, uint8_t *key); |
Kojto | 29:c40918cd9b6d | 603 | /** |
Kojto | 34:1ad18123bf11 | 604 | * \brief multiply by 2 in the galois field. |
Kojto | 34:1ad18123bf11 | 605 | * \param value Argument to multiply |
Kojto | 34:1ad18123bf11 | 606 | * \return multiplied argument |
Kojto | 29:c40918cd9b6d | 607 | */ |
Kojto | 20:30b6ed7bf8fd | 608 | uint8_t galois_mul2(uint8_t value); |
Kojto | 29:c40918cd9b6d | 609 | /** |
Kojto | 34:1ad18123bf11 | 610 | * \brief internal implementation of AES128 encryption. |
Kojto | 34:1ad18123bf11 | 611 | * straight forward aes encryption implementation\n |
Kojto | 34:1ad18123bf11 | 612 | * first the group of operations |
Kojto | 34:1ad18123bf11 | 613 | * - addRoundKey |
Kojto | 34:1ad18123bf11 | 614 | * - subbytes |
Kojto | 34:1ad18123bf11 | 615 | * - shiftrows |
Kojto | 34:1ad18123bf11 | 616 | * - mixcolums\n |
Kojto | 34:1ad18123bf11 | 617 | * |
Kojto | 34:1ad18123bf11 | 618 | * is executed 9 times, after this addroundkey to finish the 9th\n |
Kojto | 34:1ad18123bf11 | 619 | * round, after that the 10th round without mixcolums\n |
Kojto | 34:1ad18123bf11 | 620 | * no further subfunctions to save cycles for function calls\n |
Kojto | 34:1ad18123bf11 | 621 | * no structuring with "for (....)" to save cycles.\n |
Kojto | 34:1ad18123bf11 | 622 | * \param[in] expanded_key expanded AES128 key |
Kojto | 34:1ad18123bf11 | 623 | * \param[in/out] state 16 bytes of plain text and cipher text |
Kojto | 34:1ad18123bf11 | 624 | * \return none |
Kojto | 29:c40918cd9b6d | 625 | */ |
Kojto | 20:30b6ed7bf8fd | 626 | void aes_encr(uint8_t *state, uint8_t *expanded_key); |
Kojto | 29:c40918cd9b6d | 627 | /** |
Kojto | 34:1ad18123bf11 | 628 | * \brief internal implementation of AES128 decryption. |
Kojto | 34:1ad18123bf11 | 629 | * straightforward aes decryption implementation\n |
Kojto | 34:1ad18123bf11 | 630 | * the order of substeps is the exact reverse of decryption\n |
Kojto | 34:1ad18123bf11 | 631 | * inverse functions: |
Kojto | 34:1ad18123bf11 | 632 | * - addRoundKey is its own inverse |
Kojto | 34:1ad18123bf11 | 633 | * - rsbox is inverse of sbox |
Kojto | 34:1ad18123bf11 | 634 | * - rightshift instead of leftshift |
Kojto | 34:1ad18123bf11 | 635 | * - invMixColumns = barreto + mixColumns\n |
Kojto | 34:1ad18123bf11 | 636 | * |
Kojto | 34:1ad18123bf11 | 637 | * no further subfunctions to save cycles for function calls\n |
Kojto | 34:1ad18123bf11 | 638 | * no structuring with "for (....)" to save cycles\n |
Kojto | 34:1ad18123bf11 | 639 | * \param[in] expanded_key expanded AES128 key |
Kojto | 34:1ad18123bf11 | 640 | * \param[in\out] state 16 bytes of cipher text and plain text |
Kojto | 34:1ad18123bf11 | 641 | * \return none |
Kojto | 29:c40918cd9b6d | 642 | */ |
Kojto | 20:30b6ed7bf8fd | 643 | void aes_decr(uint8_t *state, uint8_t *expanded_key); |
Kojto | 29:c40918cd9b6d | 644 | /** |
Kojto | 34:1ad18123bf11 | 645 | * \brief AES128 encryption. |
Kojto | 34:1ad18123bf11 | 646 | * Given AES128 key and 16 bytes plain text, cipher text of 16 bytes is computed.\n |
Kojto | 34:1ad18123bf11 | 647 | * The AES implementation is in mode ECB (Electronic Code Book).\n |
Kojto | 34:1ad18123bf11 | 648 | * \param[in] key AES128 key of size 16 bytes |
Kojto | 34:1ad18123bf11 | 649 | * \param[in\out] state 16 bytes of plain text and cipher text |
Kojto | 34:1ad18123bf11 | 650 | * \return none |
Kojto | 29:c40918cd9b6d | 651 | */ |
Kojto | 20:30b6ed7bf8fd | 652 | void aes_encrypt(uint8_t *state, uint8_t *key); |
Kojto | 29:c40918cd9b6d | 653 | /** |
Kojto | 34:1ad18123bf11 | 654 | * \brief AES128 decryption. |
Kojto | 34:1ad18123bf11 | 655 | * Given AES128 key and 16 bytes cipher text, plain text of 16 bytes is computed.\n |
Kojto | 34:1ad18123bf11 | 656 | * The AES implementation is in mode ECB (Electronic Code Book).\n |
Kojto | 34:1ad18123bf11 | 657 | * \param[in] key AES128 key of size 16 bytes |
Kojto | 34:1ad18123bf11 | 658 | * \param[in\out] state 16 bytes of cipher text and plain text |
Kojto | 34:1ad18123bf11 | 659 | * \return none |
Kojto | 29:c40918cd9b6d | 660 | */ |
Kojto | 20:30b6ed7bf8fd | 661 | void aes_decrypt(uint8_t *state, uint8_t *key); |
Kojto | 29:c40918cd9b6d | 662 | /** |
Kojto | 34:1ad18123bf11 | 663 | * \brief Read the AES128 key from fileID #12 in EEPROM. |
Kojto | 34:1ad18123bf11 | 664 | * \param[out] key AES128 key of size 16 bytes |
Kojto | 34:1ad18123bf11 | 665 | * \return 0 on success, error otherwise. |
Kojto | 29:c40918cd9b6d | 666 | */ |
Kojto | 20:30b6ed7bf8fd | 667 | int32_t aes_read_key(uint8_t *key); |
Kojto | 29:c40918cd9b6d | 668 | /** |
Kojto | 34:1ad18123bf11 | 669 | * \brief Write the AES128 key to fileID #12 in EEPROM. |
Kojto | 34:1ad18123bf11 | 670 | * \param[out] key AES128 key of size 16 bytes |
Kojto | 34:1ad18123bf11 | 671 | * \return on success 0, error otherwise. |
Kojto | 29:c40918cd9b6d | 672 | */ |
Kojto | 20:30b6ed7bf8fd | 673 | int32_t aes_write_key(uint8_t *key); |
Kojto | 20:30b6ed7bf8fd | 674 | private: |
Kojto | 20:30b6ed7bf8fd | 675 | uint8_t _expanded_key[176]; |
Kojto | 20:30b6ed7bf8fd | 676 | }; |
Kojto | 20:30b6ed7bf8fd | 677 | #endif |
Kojto | 20:30b6ed7bf8fd | 678 | |
Kojto | 31:7b6e85b68b01 | 679 | /** Socket layer |
Kojto | 31:7b6e85b68b01 | 680 | */ |
Kojto | 20:30b6ed7bf8fd | 681 | class cc3000_socket { |
Kojto | 20:30b6ed7bf8fd | 682 | public: |
Kojto | 29:c40918cd9b6d | 683 | /** |
Kojto | 34:1ad18123bf11 | 684 | * \brief Ctor |
Kojto | 34:1ad18123bf11 | 685 | * \param simplelink Reference to simple link object. |
Kojto | 34:1ad18123bf11 | 686 | * \param hci Reference to hci object. |
Kojto | 34:1ad18123bf11 | 687 | * \param event Reference to event object. |
Kojto | 34:1ad18123bf11 | 688 | * \return none |
Kojto | 29:c40918cd9b6d | 689 | */ |
Kojto | 20:30b6ed7bf8fd | 690 | cc3000_socket(cc3000_simple_link &simplelink, cc3000_hci &hci, cc3000_event &event); |
Kojto | 29:c40918cd9b6d | 691 | /** |
Kojto | 34:1ad18123bf11 | 692 | * \brief Dtor |
Kojto | 29:c40918cd9b6d | 693 | * \param |
Kojto | 34:1ad18123bf11 | 694 | * \return none |
Kojto | 29:c40918cd9b6d | 695 | */ |
Kojto | 20:30b6ed7bf8fd | 696 | ~cc3000_socket(); |
Kojto | 29:c40918cd9b6d | 697 | /** |
Kojto | 34:1ad18123bf11 | 698 | * \brief create an endpoint for communication. |
Kojto | 34:1ad18123bf11 | 699 | * The socket function creates a socket that is bound to a specific transport service provider.\n |
Kojto | 34:1ad18123bf11 | 700 | * This function is called by the application layer to obtain a socket handle.\n |
Kojto | 34:1ad18123bf11 | 701 | * |
Kojto | 34:1ad18123bf11 | 702 | * \param domain selects the protocol family which will be used for\n |
Kojto | 34:1ad18123bf11 | 703 | * communication. On this version only AF_INET is supported\n |
Kojto | 34:1ad18123bf11 | 704 | * \param type specifies the communication semantics. On this version\n |
Kojto | 34:1ad18123bf11 | 705 | * only SOCK_STREAM, SOCK_DGRAM, SOCK_RAW are supported\n |
Kojto | 34:1ad18123bf11 | 706 | * \param protocol specifies a particular protocol to be used with the\n |
Kojto | 34:1ad18123bf11 | 707 | * socket IPPROTO_TCP, IPPROTO_UDP or IPPROTO_RAW are supported.\n |
Kojto | 34:1ad18123bf11 | 708 | * \return On success, socket handle that is used for consequent socket operations\n |
Kojto | 34:1ad18123bf11 | 709 | * On error, -1 is returned.\n |
Kojto | 29:c40918cd9b6d | 710 | */ |
Kojto | 20:30b6ed7bf8fd | 711 | int32_t socket(int32_t domain, int32_t type, int32_t protocol); |
Kojto | 29:c40918cd9b6d | 712 | /** |
Kojto | 34:1ad18123bf11 | 713 | * \brief accept a connection on a socket. |
Kojto | 34:1ad18123bf11 | 714 | * This function is used with connection-based socket types\n |
Kojto | 34:1ad18123bf11 | 715 | * (SOCK_STREAM). It extracts the first connection request on the\n |
Kojto | 34:1ad18123bf11 | 716 | * queue of pending connections, creates a new connected socket, and\n |
Kojto | 34:1ad18123bf11 | 717 | * returns a new file descriptor referring to that socket.\n |
Kojto | 34:1ad18123bf11 | 718 | * The newly created socket is not in the listening state.\n |
Kojto | 34:1ad18123bf11 | 719 | * The original socket sd is unaffected by this call.\n |
Kojto | 34:1ad18123bf11 | 720 | * The argument sd is a socket that has been created with socket(),\n |
Kojto | 34:1ad18123bf11 | 721 | * bound to a local address with bind(), and is listening for \n |
Kojto | 34:1ad18123bf11 | 722 | * connections after a listen(). The argument addr is a pointer \n |
Kojto | 34:1ad18123bf11 | 723 | * to a sockaddr structure. This structure is filled in with the \n |
Kojto | 34:1ad18123bf11 | 724 | * address of the peer socket, as known to the communications layer.\n |
Kojto | 34:1ad18123bf11 | 725 | * The exact format of the address returned addr is determined by the \n |
Kojto | 34:1ad18123bf11 | 726 | * socket's address family. The addrlen argument is a value-result\n |
Kojto | 34:1ad18123bf11 | 727 | * argument: it should initially contain the size of the structure\n |
Kojto | 34:1ad18123bf11 | 728 | * pointed to by addr, on return it will contain the actual\n |
Kojto | 34:1ad18123bf11 | 729 | * length (in bytes) of the address returned.\n |
Kojto | 34:1ad18123bf11 | 730 | * |
Kojto | 34:1ad18123bf11 | 731 | * \param[in] sd socket descriptor (handle)\n |
Kojto | 34:1ad18123bf11 | 732 | * \param[out] addr the argument addr is a pointer to a sockaddr structure\n |
Kojto | 34:1ad18123bf11 | 733 | * This structure is filled in with the address of the \n |
Kojto | 34:1ad18123bf11 | 734 | * peer socket, as known to the communications layer. \n |
Kojto | 34:1ad18123bf11 | 735 | * determined. The exact format of the address returned \n |
Kojto | 34:1ad18123bf11 | 736 | * addr is by the socket's address sockaddr. \n |
Kojto | 34:1ad18123bf11 | 737 | * On this version only AF_INET is supported.\n |
Kojto | 34:1ad18123bf11 | 738 | * This argument returns in network order.\n |
Kojto | 34:1ad18123bf11 | 739 | * \param[out] addrlen the addrlen argument is a value-result argument: \n |
Kojto | 34:1ad18123bf11 | 740 | * it should initially contain the size of the structure\n |
Kojto | 34:1ad18123bf11 | 741 | * pointed to by addr.\n |
Kojto | 34:1ad18123bf11 | 742 | * \return For socket in blocking mode:\n |
Kojto | 34:1ad18123bf11 | 743 | * - On success, socket handle. on failure negative\n |
Kojto | 34:1ad18123bf11 | 744 | * For socket in non-blocking mode:\n |
Kojto | 34:1ad18123bf11 | 745 | * - On connection establishment, socket handle\n |
Kojto | 34:1ad18123bf11 | 746 | * - On connection pending, SOC_IN_PROGRESS (-2)\n |
Kojto | 34:1ad18123bf11 | 747 | * - On failure, SOC_ERROR (-1)\n |
Kojto | 34:1ad18123bf11 | 748 | * \sa socket ; bind ; listen |
Kojto | 29:c40918cd9b6d | 749 | */ |
Kojto | 20:30b6ed7bf8fd | 750 | int32_t accept(int32_t sd, sockaddr *addr, socklen_t *addrlen); |
Kojto | 29:c40918cd9b6d | 751 | /** |
Kojto | 34:1ad18123bf11 | 752 | * \brief assign a name to a socket. |
Kojto | 34:1ad18123bf11 | 753 | * This function gives the socket the local address addr.\n |
Kojto | 34:1ad18123bf11 | 754 | * addr is addrlen bytes long. Traditionally, this is called when a \n |
Kojto | 34:1ad18123bf11 | 755 | * socket is created with socket, it exists in a name space (address \n |
Kojto | 34:1ad18123bf11 | 756 | * family) but has no name assigned.\n |
Kojto | 34:1ad18123bf11 | 757 | * It is necessary to assign a local address before a SOCK_STREAM\n |
Kojto | 34:1ad18123bf11 | 758 | * socket may receive connections.\n |
Kojto | 34:1ad18123bf11 | 759 | * |
Kojto | 34:1ad18123bf11 | 760 | * \param[in] sd socket descriptor (handle) |
Kojto | 34:1ad18123bf11 | 761 | * \param[out] addr specifies the destination address. On this version\n |
Kojto | 34:1ad18123bf11 | 762 | * only AF_INET is supported.\n |
Kojto | 34:1ad18123bf11 | 763 | * \param[out] addrlen contains the size of the structure pointed to by addr.\n |
Kojto | 34:1ad18123bf11 | 764 | * \return On success, zero is returned.\n |
Kojto | 34:1ad18123bf11 | 765 | * On error, -1 is returned.\n |
Kojto | 34:1ad18123bf11 | 766 | * \sa socket ; accept ; listen |
Kojto | 29:c40918cd9b6d | 767 | */ |
Kojto | 20:30b6ed7bf8fd | 768 | int32_t bind(int32_t sd, const sockaddr *addr, int32_t addrlen); |
Kojto | 29:c40918cd9b6d | 769 | /** |
Kojto | 34:1ad18123bf11 | 770 | * \brief HostFlowControlConsumeBuff. |
Kojto | 34:1ad18123bf11 | 771 | * if SEND_NON_BLOCKING is not defined - block until a free buffer is available,\n |
Kojto | 34:1ad18123bf11 | 772 | * otherwise return the status of the available buffers.\n |
Kojto | 34:1ad18123bf11 | 773 | * |
Kojto | 34:1ad18123bf11 | 774 | * \param sd socket descriptor |
Kojto | 34:1ad18123bf11 | 775 | * \return 0 in case there are buffers available, \n |
Kojto | 34:1ad18123bf11 | 776 | * -1 in case of bad socket\n |
Kojto | 34:1ad18123bf11 | 777 | * -2 if there are no free buffers present (only when SEND_NON_BLOCKING is enabled)\n |
Kojto | 29:c40918cd9b6d | 778 | */ |
Kojto | 20:30b6ed7bf8fd | 779 | int32_t HostFlowControlConsumeBuff(int32_t sd); |
Kojto | 29:c40918cd9b6d | 780 | /** |
Kojto | 34:1ad18123bf11 | 781 | * \brief The socket function closes a created socket. |
Kojto | 34:1ad18123bf11 | 782 | * \param sd socket handle. |
Kojto | 34:1ad18123bf11 | 783 | * \return On success, zero is returned. On error, -1 is returned. |
Kojto | 29:c40918cd9b6d | 784 | */ |
Kojto | 20:30b6ed7bf8fd | 785 | int32_t closesocket(int32_t sd); |
Kojto | 29:c40918cd9b6d | 786 | /** |
Kojto | 34:1ad18123bf11 | 787 | * \brief listen for connections on a socket. |
Kojto | 34:1ad18123bf11 | 788 | * The willingness to accept incoming connections and a queue\n |
Kojto | 34:1ad18123bf11 | 789 | * limit for incoming connections are specified with listen(),\n |
Kojto | 34:1ad18123bf11 | 790 | * and then the connections are accepted with accept.\n |
Kojto | 34:1ad18123bf11 | 791 | * The listen() call applies only to sockets of type SOCK_STREAM\n |
Kojto | 34:1ad18123bf11 | 792 | * The backlog parameter defines the maximum length the queue of\n |
Kojto | 34:1ad18123bf11 | 793 | * pending connections may grow to. \n |
Kojto | 34:1ad18123bf11 | 794 | * |
Kojto | 34:1ad18123bf11 | 795 | * \param[in] sd socket descriptor (handle) |
Kojto | 34:1ad18123bf11 | 796 | * \param[in] backlog specifies the listen queue depth. On this version\n |
Kojto | 34:1ad18123bf11 | 797 | * backlog is not supported.\n |
Kojto | 34:1ad18123bf11 | 798 | * \return On success, zero is returned.\n |
Kojto | 34:1ad18123bf11 | 799 | * On error, -1 is returned.\n |
Kojto | 34:1ad18123bf11 | 800 | * \sa socket ; accept ; bind |
Kojto | 34:1ad18123bf11 | 801 | * \note On this version, backlog is not supported |
Kojto | 29:c40918cd9b6d | 802 | */ |
Kojto | 20:30b6ed7bf8fd | 803 | int32_t listen(int32_t sd, int32_t backlog); |
Kojto | 29:c40918cd9b6d | 804 | /** |
Kojto | 34:1ad18123bf11 | 805 | * \brief initiate a connection on a socket. |
Kojto | 34:1ad18123bf11 | 806 | * Function connects the socket referred to by the socket descriptor\n |
Kojto | 34:1ad18123bf11 | 807 | * sd, to the address specified by addr. The addrlen argument \n |
Kojto | 34:1ad18123bf11 | 808 | * specifies the size of addr. The format of the address in addr is \n |
Kojto | 34:1ad18123bf11 | 809 | * determined by the address space of the socket. If it is of type \n |
Kojto | 34:1ad18123bf11 | 810 | * SOCK_DGRAM, this call specifies the peer with which the socket is \n |
Kojto | 34:1ad18123bf11 | 811 | * to be associated; this address is that to which datagrams are to be\n |
Kojto | 34:1ad18123bf11 | 812 | * sent, and the only address from which datagrams are to be received. \n |
Kojto | 34:1ad18123bf11 | 813 | * If the socket is of type SOCK_STREAM, this call attempts to make a \n |
Kojto | 34:1ad18123bf11 | 814 | * connection to another socket. The other socket is specified by \n |
Kojto | 34:1ad18123bf11 | 815 | * address, which is an address in the communications space of the\n |
Kojto | 34:1ad18123bf11 | 816 | * socket. Note that the function implements only blocking behavior \n |
Kojto | 34:1ad18123bf11 | 817 | * thus the caller will be waiting either for the connection \n |
Kojto | 34:1ad18123bf11 | 818 | * establishment or for the connection establishment failure.\n |
Kojto | 34:1ad18123bf11 | 819 | * |
Kojto | 34:1ad18123bf11 | 820 | * \param[in] sd socket descriptor (handle) |
Kojto | 34:1ad18123bf11 | 821 | * \param[in] addr specifies the destination addr. On this version\n |
Kojto | 34:1ad18123bf11 | 822 | * only AF_INET is supported.\n |
Kojto | 34:1ad18123bf11 | 823 | * \param[out] addrlen contains the size of the structure pointed to by addr |
Kojto | 34:1ad18123bf11 | 824 | * \return On success, zero is returned.\n |
Kojto | 34:1ad18123bf11 | 825 | On error, -1 is returned\n |
Kojto | 34:1ad18123bf11 | 826 | * \sa socket |
Kojto | 29:c40918cd9b6d | 827 | */ |
Kojto | 20:30b6ed7bf8fd | 828 | int32_t connect(int32_t sd, const sockaddr *addr, int32_t addrlen); |
Kojto | 29:c40918cd9b6d | 829 | /** |
Kojto | 34:1ad18123bf11 | 830 | * \brief Monitor socket activity. |
Kojto | 34:1ad18123bf11 | 831 | * Select allow a program to monitor multiple file descriptors,\n |
Kojto | 34:1ad18123bf11 | 832 | * waiting until one or more of the file descriptors become \n |
Kojto | 34:1ad18123bf11 | 833 | * "ready" for some class of I/O operation \n |
Kojto | 34:1ad18123bf11 | 834 | * |
Kojto | 34:1ad18123bf11 | 835 | * \param[in] nfds the highest-numbered file descriptor in any of the\n |
Kojto | 34:1ad18123bf11 | 836 | * three sets, plus 1. \n |
Kojto | 34:1ad18123bf11 | 837 | * \param[out] readsds socket descriptors list for read monitoring\n |
Kojto | 34:1ad18123bf11 | 838 | * \param[out] writesds socket descriptors list for write monitoring\n |
Kojto | 34:1ad18123bf11 | 839 | * \param[out] exceptsds socket descriptors list for exception monitoring\n |
Kojto | 34:1ad18123bf11 | 840 | * \param[in] timeout is an upper bound on the amount of time elapsed\n |
Kojto | 34:1ad18123bf11 | 841 | * before select() returns. Null means infinity \n |
Kojto | 34:1ad18123bf11 | 842 | * timeout. The minimum timeout is 5 milliseconds,\n |
Kojto | 34:1ad18123bf11 | 843 | * less than 5 milliseconds will be set\n |
Kojto | 34:1ad18123bf11 | 844 | * automatically to 5 milliseconds.\n |
Kojto | 34:1ad18123bf11 | 845 | * \return On success, select() returns the number of file descriptors\n |
Kojto | 34:1ad18123bf11 | 846 | * contained in the three returned descriptor sets (that is, the\n |
Kojto | 34:1ad18123bf11 | 847 | * total number of bits that are set in readfds, writefds,\n |
Kojto | 34:1ad18123bf11 | 848 | * exceptfds) which may be zero if the timeout expires before\n |
Kojto | 34:1ad18123bf11 | 849 | * anything interesting happens.\n |
Kojto | 34:1ad18123bf11 | 850 | * On error, -1 is returned.\n |
Kojto | 34:1ad18123bf11 | 851 | * *readsds - return the sockets on which Read request will\n |
Kojto | 34:1ad18123bf11 | 852 | * return without delay with valid data.\n |
Kojto | 34:1ad18123bf11 | 853 | * *writesds - return the sockets on which Write request \n |
Kojto | 34:1ad18123bf11 | 854 | * will return without delay.\n |
Kojto | 34:1ad18123bf11 | 855 | * *exceptsds - return the sockets which closed recently.\n |
Kojto | 34:1ad18123bf11 | 856 | * \Note If the timeout value set to less than 5ms it will automatically\n |
Kojto | 34:1ad18123bf11 | 857 | * change to 5ms to prevent overload of the system\n |
Kojto | 34:1ad18123bf11 | 858 | * \sa socket |
Kojto | 29:c40918cd9b6d | 859 | */ |
Kojto | 20:30b6ed7bf8fd | 860 | int32_t select(int32_t nfds, fd_set *readsds, fd_set *writesds, fd_set *exceptsds, struct timeval *timeout); |
Kojto | 29:c40918cd9b6d | 861 | /** |
Kojto | 34:1ad18123bf11 | 862 | * \brief get socket options. |
Kojto | 34:1ad18123bf11 | 863 | * This function manipulate the options associated with a socket.\n |
Kojto | 34:1ad18123bf11 | 864 | * Options may exist at multiple protocol levels; they are always\n |
Kojto | 34:1ad18123bf11 | 865 | * present at the uppermost socket level.\n |
Kojto | 34:1ad18123bf11 | 866 | * When manipulating socket options the level at which the option \n |
Kojto | 34:1ad18123bf11 | 867 | * resides and the name of the option must be specified. \n |
Kojto | 34:1ad18123bf11 | 868 | * To manipulate options at the socket level, level is specified as \n |
Kojto | 34:1ad18123bf11 | 869 | * SOL_SOCKET. To manipulate options at any other level the protocol \n |
Kojto | 34:1ad18123bf11 | 870 | * number of the appropriate protocol controlling the option is \n |
Kojto | 34:1ad18123bf11 | 871 | * supplied. For example, to indicate that an option is to be \n |
Kojto | 34:1ad18123bf11 | 872 | * interpreted by the TCP protocol, level should be set to the \n |
Kojto | 34:1ad18123bf11 | 873 | * protocol number of TCP; \n |
Kojto | 34:1ad18123bf11 | 874 | * The parameters optval and optlen are used to access optval -\n |
Kojto | 34:1ad18123bf11 | 875 | * use for setsockopt(). For getsockopt() they identify a buffer\n |
Kojto | 34:1ad18123bf11 | 876 | * in which the value for the requested option(s) are to \n |
Kojto | 34:1ad18123bf11 | 877 | * be returned. For getsockopt(), optlen is a value-result \n |
Kojto | 34:1ad18123bf11 | 878 | * parameter, initially containing the size of the buffer \n |
Kojto | 34:1ad18123bf11 | 879 | * pointed to by option_value, and modified on return to \n |
Kojto | 34:1ad18123bf11 | 880 | * indicate the actual size of the value returned. If no option \n |
Kojto | 34:1ad18123bf11 | 881 | * value is to be supplied or returned, option_value may be NULL.\n |
Kojto | 34:1ad18123bf11 | 882 | * |
Kojto | 34:1ad18123bf11 | 883 | * \param[in] sd socket handle |
Kojto | 34:1ad18123bf11 | 884 | * \param[in] level defines the protocol level for this option |
Kojto | 34:1ad18123bf11 | 885 | * \param[in] optname defines the option name to Interrogate |
Kojto | 34:1ad18123bf11 | 886 | * \param[out] optval specifies a value for the option |
Kojto | 34:1ad18123bf11 | 887 | * \param[out] optlen specifies the length of the option value |
Kojto | 34:1ad18123bf11 | 888 | * \return On success, zero is returned. On error, -1 is returned |
Kojto | 34:1ad18123bf11 | 889 | * |
Kojto | 34:1ad18123bf11 | 890 | * \Note On this version the following two socket options are enabled:\n |
Kojto | 34:1ad18123bf11 | 891 | * The only protocol level supported in this version is SOL_SOCKET (level).\n |
Kojto | 34:1ad18123bf11 | 892 | * 1. SOCKOPT_RECV_TIMEOUT (optname)\n |
Kojto | 34:1ad18123bf11 | 893 | * SOCKOPT_RECV_TIMEOUT configures recv and recvfrom timeout in milliseconds.\n |
Kojto | 34:1ad18123bf11 | 894 | * In that case optval should be pointer to unsigned long.\n |
Kojto | 34:1ad18123bf11 | 895 | * 2. SOCKOPT_NONBLOCK (optname). sets the socket non-blocking mode on or off.\n |
Kojto | 34:1ad18123bf11 | 896 | * In that case optval should be SOCK_ON or SOCK_OFF (optval).\n |
Kojto | 34:1ad18123bf11 | 897 | * \sa setsockopt |
Kojto | 29:c40918cd9b6d | 898 | */ |
Kojto | 20:30b6ed7bf8fd | 899 | int32_t getsockopt (int32_t sd, int32_t level, int32_t optname, void *optval, socklen_t *optlen); |
Kojto | 29:c40918cd9b6d | 900 | /** |
Kojto | 34:1ad18123bf11 | 901 | * \brief Read data from socket (simple_link_recv). |
Kojto | 34:1ad18123bf11 | 902 | * Return the length of the message on successful completion.\n |
Kojto | 34:1ad18123bf11 | 903 | * If a message is too long to fit in the supplied buffer, excess bytes may\n |
Kojto | 34:1ad18123bf11 | 904 | * be discarded depending on the type of socket the message is received from.\n |
Kojto | 34:1ad18123bf11 | 905 | * |
Kojto | 34:1ad18123bf11 | 906 | * \param sd socket handle |
Kojto | 34:1ad18123bf11 | 907 | * \param buf read buffer |
Kojto | 34:1ad18123bf11 | 908 | * \param len buffer length |
Kojto | 34:1ad18123bf11 | 909 | * \param flags indicates blocking or non-blocking operation |
Kojto | 34:1ad18123bf11 | 910 | * \param from pointer to an address structure indicating source address |
Kojto | 34:1ad18123bf11 | 911 | * \param fromlen source address structure size |
Kojto | 34:1ad18123bf11 | 912 | * \return Return the number of bytes received, or -1 if an error occurred |
Kojto | 29:c40918cd9b6d | 913 | */ |
Kojto | 20:30b6ed7bf8fd | 914 | int32_t simple_link_recv(int32_t sd, void *buf, int32_t len, int32_t flags, sockaddr *from, socklen_t *fromlen, int32_t opcode); |
Kojto | 29:c40918cd9b6d | 915 | /** |
Kojto | 34:1ad18123bf11 | 916 | * \brief Transmit a message to another socket (simple_link_send). |
Kojto | 34:1ad18123bf11 | 917 | * \param sd socket handle |
Kojto | 34:1ad18123bf11 | 918 | * \param buf write buffer |
Kojto | 34:1ad18123bf11 | 919 | * \param len buffer length |
Kojto | 34:1ad18123bf11 | 920 | * \param flags On this version, this parameter is not supported |
Kojto | 34:1ad18123bf11 | 921 | * \param to pointer to an address structure indicating destination address |
Kojto | 34:1ad18123bf11 | 922 | * \param tolen destination address structure size |
Kojto | 34:1ad18123bf11 | 923 | * \return Return the number of bytes transmitted, or -1 if an error\n |
Kojto | 34:1ad18123bf11 | 924 | * occurred, or -2 in case there are no free buffers available\n |
Kojto | 34:1ad18123bf11 | 925 | * (only when SEND_NON_BLOCKING is enabled)\n |
Kojto | 29:c40918cd9b6d | 926 | */ |
Kojto | 20:30b6ed7bf8fd | 927 | int32_t simple_link_send(int32_t sd, const void *buf, int32_t len, int32_t flags, const sockaddr *to, int32_t tolen, int32_t opcode); |
Kojto | 29:c40918cd9b6d | 928 | /** |
Kojto | 34:1ad18123bf11 | 929 | * \brief Receive a message from a connection-mode socket. |
Kojto | 34:1ad18123bf11 | 930 | * \param[in] sd socket handle |
Kojto | 34:1ad18123bf11 | 931 | * \param[out] buf Points to the buffer where the message should be stored |
Kojto | 34:1ad18123bf11 | 932 | * \param[in] len Specifies the length in bytes of the buffer pointed to \n |
Kojto | 34:1ad18123bf11 | 933 | * by the buffer argument.\n |
Kojto | 34:1ad18123bf11 | 934 | * \param[in] flags Specifies the type of message reception. \n |
Kojto | 34:1ad18123bf11 | 935 | * On this version, this parameter is not supported.\n |
Kojto | 34:1ad18123bf11 | 936 | * \return Return the number of bytes received, or -1 if an error occurred |
Kojto | 34:1ad18123bf11 | 937 | * \sa recvfrom |
Kojto | 34:1ad18123bf11 | 938 | * \Note On this version, only blocking mode is supported. |
Kojto | 29:c40918cd9b6d | 939 | */ |
Kojto | 20:30b6ed7bf8fd | 940 | int32_t recv(int32_t sd, void *buf, int32_t len, int32_t flags); |
Kojto | 29:c40918cd9b6d | 941 | /** |
Kojto | 34:1ad18123bf11 | 942 | * \brief read data from socket (recvfrom). |
Kojto | 34:1ad18123bf11 | 943 | * Receives a message from a connection-mode or connectionless-mode socket.\n |
Kojto | 34:1ad18123bf11 | 944 | * Note that raw sockets are not supported.\n |
Kojto | 34:1ad18123bf11 | 945 | * |
Kojto | 34:1ad18123bf11 | 946 | * \param[in] sd socket handle |
Kojto | 34:1ad18123bf11 | 947 | * \param[out] buf Points to the buffer where the message should be stored |
Kojto | 34:1ad18123bf11 | 948 | * \param[in] len Specifies the length in bytes of the buffer pointed to \n |
Kojto | 34:1ad18123bf11 | 949 | * by the buffer argument.\n |
Kojto | 34:1ad18123bf11 | 950 | * \param[in] flags Specifies the type of message reception.\n |
Kojto | 34:1ad18123bf11 | 951 | * On this version, this parameter is not supported.\n |
Kojto | 34:1ad18123bf11 | 952 | * \param[in] from pointer to an address structure indicating the source\n |
Kojto | 34:1ad18123bf11 | 953 | * address: sockaddr. On this version only AF_INET is\n |
Kojto | 34:1ad18123bf11 | 954 | * supported.\n |
Kojto | 34:1ad18123bf11 | 955 | * \param[in] fromlen source address structure size |
Kojto | 34:1ad18123bf11 | 956 | * \return Return the number of bytes received, or -1 if an error occurred |
Kojto | 34:1ad18123bf11 | 957 | * \sa recv |
Kojto | 34:1ad18123bf11 | 958 | * \Note On this version, only blocking mode is supported. |
Kojto | 29:c40918cd9b6d | 959 | */ |
Kojto | 20:30b6ed7bf8fd | 960 | int32_t recvfrom(int32_t sd, void *buf, int32_t len, int32_t flags, sockaddr *from, socklen_t *fromlen); |
Kojto | 29:c40918cd9b6d | 961 | /** |
Kojto | 34:1ad18123bf11 | 962 | * \brief Transmit a message to another socket (send). |
Kojto | 34:1ad18123bf11 | 963 | * \param sd socket handle |
Kojto | 34:1ad18123bf11 | 964 | * \param buf Points to a buffer containing the message to be sent |
Kojto | 34:1ad18123bf11 | 965 | * \param len message size in bytes |
Kojto | 34:1ad18123bf11 | 966 | * \param flags On this version, this parameter is not supported |
Kojto | 34:1ad18123bf11 | 967 | * \return Return the number of bytes transmitted, or -1 if an\n |
Kojto | 34:1ad18123bf11 | 968 | * error occurred\n |
Kojto | 34:1ad18123bf11 | 969 | * \Note On this version, only blocking mode is supported. |
Kojto | 34:1ad18123bf11 | 970 | * \sa sendto |
Kojto | 29:c40918cd9b6d | 971 | */ |
Kojto | 20:30b6ed7bf8fd | 972 | int32_t send(int32_t sd, const void *buf, int32_t len, int32_t flags); |
Kojto | 29:c40918cd9b6d | 973 | /** |
Kojto | 34:1ad18123bf11 | 974 | * \brief Transmit a message to another socket (sendto). |
Kojto | 34:1ad18123bf11 | 975 | * \param sd socket handle |
Kojto | 34:1ad18123bf11 | 976 | * \param buf Points to a buffer containing the message to be sent |
Kojto | 34:1ad18123bf11 | 977 | * \param len message size in bytes |
Kojto | 34:1ad18123bf11 | 978 | * \param flags On this version, this parameter is not supported |
Kojto | 34:1ad18123bf11 | 979 | * \param to pointer to an address structure indicating the destination\n |
Kojto | 34:1ad18123bf11 | 980 | * address: sockaddr. On this version only AF_INET is\n |
Kojto | 34:1ad18123bf11 | 981 | * supported.\n |
Kojto | 34:1ad18123bf11 | 982 | * \param tolen destination address structure size |
Kojto | 34:1ad18123bf11 | 983 | * \return Return the number of bytes transmitted, or -1 if an error occurred |
Kojto | 34:1ad18123bf11 | 984 | * \Note On this version, only blocking mode is supported. |
Kojto | 34:1ad18123bf11 | 985 | * \sa send |
Kojto | 29:c40918cd9b6d | 986 | */ |
Kojto | 20:30b6ed7bf8fd | 987 | int32_t sendto(int32_t sd, const void *buf, int32_t len, int32_t flags, const sockaddr *to, socklen_t tolen); |
Kojto | 29:c40918cd9b6d | 988 | /** |
Kojto | 34:1ad18123bf11 | 989 | * \brief Set CC3000 in mDNS advertiser mode in order to advertise itself. |
Kojto | 34:1ad18123bf11 | 990 | * \param[in] mdns_enabled flag to enable/disable the mDNS feature |
Kojto | 34:1ad18123bf11 | 991 | * \param[in] device_service_name Service name as part of the published\n |
Kojto | 34:1ad18123bf11 | 992 | * canonical domain name\n |
Kojto | 34:1ad18123bf11 | 993 | * \param[in] device_service_name_length Length of the service name |
Kojto | 34:1ad18123bf11 | 994 | * \return On success, zero is returned,\n |
Kojto | 34:1ad18123bf11 | 995 | * return SOC_ERROR if socket was not opened successfully, or if an error occurred.\n |
Kojto | 29:c40918cd9b6d | 996 | */ |
Kojto | 20:30b6ed7bf8fd | 997 | int32_t mdns_advertiser(uint16_t mdns_enabled, uint8_t * device_service_name, uint16_t device_service_name_length); |
SolderSplashLabs | 42:bd2c631a031a | 998 | /** |
Kojto | 44:960b73df5981 | 999 | * \brief |
SolderSplashLabs | 42:bd2c631a031a | 1000 | * \param[in] s_addr in host format ( little endian ) |
SolderSplashLabs | 42:bd2c631a031a | 1001 | * \param[in] *buf buffer to write too |
SolderSplashLabs | 42:bd2c631a031a | 1002 | * \param[in] buflen length of supplied buffer |
SolderSplashLabs | 42:bd2c631a031a | 1003 | * \return pointer to buf \n |
SolderSplashLabs | 42:bd2c631a031a | 1004 | */ |
SolderSplashLabs | 42:bd2c631a031a | 1005 | char * inet_ntoa_r(uint32_t s_addr, char *buf, int buflen); |
Kojto | 20:30b6ed7bf8fd | 1006 | #ifndef CC3000_TINY_DRIVER |
Kojto | 33:9e23b24fb4f3 | 1007 | /** |
Kojto | 34:1ad18123bf11 | 1008 | * \brief Get host IP by name.\n |
Kojto | 34:1ad18123bf11 | 1009 | * Obtain the IP Address of machine on network\n |
Kojto | 34:1ad18123bf11 | 1010 | * |
Kojto | 34:1ad18123bf11 | 1011 | * \param[in] hostname host name |
Kojto | 34:1ad18123bf11 | 1012 | * \param[in] name_length name length |
Kojto | 34:1ad18123bf11 | 1013 | * \param[out] out_ip_addr This parameter is filled in with host IP address.\n |
Kojto | 34:1ad18123bf11 | 1014 | * In case that host name is not resolved, \n |
Kojto | 34:1ad18123bf11 | 1015 | * out_ip_addr is zero.\n |
Kojto | 34:1ad18123bf11 | 1016 | * \return On success, positive is returned.\n |
Kojto | 34:1ad18123bf11 | 1017 | * On error, negative is returned by its name.\n |
Kojto | 34:1ad18123bf11 | 1018 | * \note On this version, only blocking mode is supported. Also note that\n |
Kojto | 34:1ad18123bf11 | 1019 | * The function requires DNS server to be configured prior to its usage.\n |
Kojto | 33:9e23b24fb4f3 | 1020 | */ |
Kojto | 20:30b6ed7bf8fd | 1021 | int32_t gethostbyname(uint8_t *hostname, uint16_t name_length, uint32_t *out_ip_addr); |
Kojto | 29:c40918cd9b6d | 1022 | /** |
Kojto | 34:1ad18123bf11 | 1023 | * \brief set socket options. |
Kojto | 34:1ad18123bf11 | 1024 | * This function manipulate the options associated with a socket.\n |
Kojto | 34:1ad18123bf11 | 1025 | * Options may exist at multiple protocol levels; they are always\n |
Kojto | 34:1ad18123bf11 | 1026 | * present at the uppermost socket level.\n |
Kojto | 34:1ad18123bf11 | 1027 | * When manipulating socket options the level at which the option \n |
Kojto | 34:1ad18123bf11 | 1028 | * resides and the name of the option must be specified.\n |
Kojto | 34:1ad18123bf11 | 1029 | * To manipulate options at the socket level, level is specified as\n |
Kojto | 34:1ad18123bf11 | 1030 | * SOL_SOCKET. To manipulate options at any other level the protocol \n |
Kojto | 34:1ad18123bf11 | 1031 | * number of the appropriate protocol controlling the option is \n |
Kojto | 34:1ad18123bf11 | 1032 | * supplied. For example, to indicate that an option is to be \n |
Kojto | 34:1ad18123bf11 | 1033 | * interpreted by the TCP protocol, level should be set to the \n |
Kojto | 34:1ad18123bf11 | 1034 | * protocol number of TCP; \n |
Kojto | 34:1ad18123bf11 | 1035 | * The parameters optval and optlen are used to access optval - \n |
Kojto | 34:1ad18123bf11 | 1036 | * use for setsockopt(). For getsockopt() they identify a buffer\n |
Kojto | 34:1ad18123bf11 | 1037 | * in which the value for the requested option(s) are to \n |
Kojto | 34:1ad18123bf11 | 1038 | * be returned. For getsockopt(), optlen is a value-result \n |
Kojto | 34:1ad18123bf11 | 1039 | * parameter, initially containing the size of the buffer \n |
Kojto | 34:1ad18123bf11 | 1040 | * pointed to by option_value, and modified on return to \n |
Kojto | 34:1ad18123bf11 | 1041 | * indicate the actual size of the value returned. If no option \n |
Kojto | 34:1ad18123bf11 | 1042 | * value is to be supplied or returned, option_value may be NULL.\n |
Kojto | 34:1ad18123bf11 | 1043 | * |
Kojto | 34:1ad18123bf11 | 1044 | * \param[in] sd socket handle |
Kojto | 34:1ad18123bf11 | 1045 | * \param[in] level defines the protocol level for this option |
Kojto | 34:1ad18123bf11 | 1046 | * \param[in] optname defines the option name to Interrogate |
Kojto | 34:1ad18123bf11 | 1047 | * \param[in] optval specifies a value for the option |
Kojto | 34:1ad18123bf11 | 1048 | * \param[in] optlen specifies the length of the option value |
Kojto | 34:1ad18123bf11 | 1049 | * \return On success, zero is returned.\n |
Kojto | 34:1ad18123bf11 | 1050 | * On error, -1 is returned\n |
Kojto | 34:1ad18123bf11 | 1051 | * |
Kojto | 34:1ad18123bf11 | 1052 | * \Note On this version the following two socket options are enabled:\n |
Kojto | 34:1ad18123bf11 | 1053 | * The only protocol level supported in this version is SOL_SOCKET (level).\n |
Kojto | 34:1ad18123bf11 | 1054 | * 1. SOCKOPT_RECV_TIMEOUT (optname)\n |
Kojto | 34:1ad18123bf11 | 1055 | * SOCKOPT_RECV_TIMEOUT configures recv and recvfrom timeout in milliseconds.\n |
Kojto | 34:1ad18123bf11 | 1056 | * In that case optval should be pointer to unsigned long.\n |
Kojto | 34:1ad18123bf11 | 1057 | * 2. SOCKOPT_NONBLOCK (optname). sets the socket non-blocking mode on or off.\n |
Kojto | 34:1ad18123bf11 | 1058 | * In that case optval should be SOCK_ON or SOCK_OFF (optval).\n |
Kojto | 34:1ad18123bf11 | 1059 | * \sa getsockopt |
Kojto | 29:c40918cd9b6d | 1060 | */ |
Kojto | 20:30b6ed7bf8fd | 1061 | int32_t setsockopt(int32_t sd, int32_t level, int32_t optname, const void *optval, socklen_t optlen); |
Kojto | 20:30b6ed7bf8fd | 1062 | #endif |
Kojto | 20:30b6ed7bf8fd | 1063 | private: |
Kojto | 20:30b6ed7bf8fd | 1064 | cc3000_simple_link &_simple_link; |
Kojto | 20:30b6ed7bf8fd | 1065 | cc3000_hci &_hci; |
Kojto | 20:30b6ed7bf8fd | 1066 | cc3000_event &_event; |
Kojto | 20:30b6ed7bf8fd | 1067 | }; |
Kojto | 20:30b6ed7bf8fd | 1068 | |
Kojto | 31:7b6e85b68b01 | 1069 | /** SPI communication layer |
Kojto | 20:30b6ed7bf8fd | 1070 | */ |
Kojto | 20:30b6ed7bf8fd | 1071 | class cc3000_spi { |
Kojto | 20:30b6ed7bf8fd | 1072 | public: |
Kojto | 33:9e23b24fb4f3 | 1073 | /** |
Kojto | 33:9e23b24fb4f3 | 1074 | * \brief Ctor |
Kojto | 34:1ad18123bf11 | 1075 | * \param irq IRQ pin |
Kojto | 34:1ad18123bf11 | 1076 | * \param cc3000_en Enable pin |
Kojto | 34:1ad18123bf11 | 1077 | * \param cc3000_cs Chip select pin |
Kojto | 34:1ad18123bf11 | 1078 | * \param cc3000_spi SPI object |
Kojto | 34:1ad18123bf11 | 1079 | * \param irq_port Port for IRQ pin (needed for enable/disable interrupts) |
Kojto | 34:1ad18123bf11 | 1080 | * \param event Reference to the event object. |
Kojto | 34:1ad18123bf11 | 1081 | * \param simple_link Reference to the simple link object. |
Kojto | 33:9e23b24fb4f3 | 1082 | * \return none |
Kojto | 20:30b6ed7bf8fd | 1083 | */ |
Kojto | 45:50ab13d8f2dc | 1084 | cc3000_spi(PinName cc3000_irq, PinName cc3000_en, PinName cc3000_cs, SPI cc3000_spi, cc3000_event &event, cc3000_simple_link &simple_link); |
Kojto | 33:9e23b24fb4f3 | 1085 | /** |
Kojto | 33:9e23b24fb4f3 | 1086 | * \brief Dtor |
Kojto | 33:9e23b24fb4f3 | 1087 | * \param none |
Kojto | 33:9e23b24fb4f3 | 1088 | * \return none |
Kojto | 20:30b6ed7bf8fd | 1089 | */ |
Kojto | 20:30b6ed7bf8fd | 1090 | ~cc3000_spi(); |
Kojto | 33:9e23b24fb4f3 | 1091 | /** |
Kojto | 33:9e23b24fb4f3 | 1092 | * \brief Close SPI - disables IRQ and set received buffer to 0 |
Kojto | 20:30b6ed7bf8fd | 1093 | * \param none |
Kojto | 20:30b6ed7bf8fd | 1094 | * \return none |
Kojto | 20:30b6ed7bf8fd | 1095 | */ |
Kojto | 20:30b6ed7bf8fd | 1096 | void close(); |
Kojto | 34:1ad18123bf11 | 1097 | /** |
Kojto | 34:1ad18123bf11 | 1098 | * \brief Open the SPI interface |
Kojto | 34:1ad18123bf11 | 1099 | * \param none |
Kojto | 34:1ad18123bf11 | 1100 | * \return none |
Kojto | 20:30b6ed7bf8fd | 1101 | */ |
Kojto | 20:30b6ed7bf8fd | 1102 | void open(); |
Kojto | 34:1ad18123bf11 | 1103 | /** |
Kojto | 34:1ad18123bf11 | 1104 | * \brief First SPI write after powerup (delay needed between SPI header and body) |
Kojto | 34:1ad18123bf11 | 1105 | * \param buffer pointer to write buffer |
Kojto | 34:1ad18123bf11 | 1106 | * \param length buffer length |
Kojto | 34:1ad18123bf11 | 1107 | * \return 0 |
Kojto | 20:30b6ed7bf8fd | 1108 | */ |
Kojto | 20:30b6ed7bf8fd | 1109 | uint32_t first_write(uint8_t *buffer, uint16_t length); |
Kojto | 34:1ad18123bf11 | 1110 | /** |
Kojto | 34:1ad18123bf11 | 1111 | * \brief SPI Write function |
Kojto | 34:1ad18123bf11 | 1112 | * \param buffer pointer to write buffer |
Kojto | 34:1ad18123bf11 | 1113 | * \param length buffer length |
Kojto | 34:1ad18123bf11 | 1114 | * \return 0 |
Kojto | 20:30b6ed7bf8fd | 1115 | */ |
Kojto | 20:30b6ed7bf8fd | 1116 | uint32_t write(uint8_t *buffer, uint16_t length); |
Kojto | 34:1ad18123bf11 | 1117 | /** |
Kojto | 34:1ad18123bf11 | 1118 | * \brief Low level SPI write |
Kojto | 34:1ad18123bf11 | 1119 | * \param data pointer to data buffer |
Kojto | 34:1ad18123bf11 | 1120 | * \param size number of bytes |
Kojto | 34:1ad18123bf11 | 1121 | * \return none |
Kojto | 20:30b6ed7bf8fd | 1122 | */ |
Kojto | 20:30b6ed7bf8fd | 1123 | void write_synchronous(uint8_t *data, uint16_t size); |
Kojto | 34:1ad18123bf11 | 1124 | /** |
Kojto | 34:1ad18123bf11 | 1125 | * \brief Low level SPI read |
Kojto | 34:1ad18123bf11 | 1126 | * \param data pointer to data buffer |
Kojto | 34:1ad18123bf11 | 1127 | * \param size number of bytes |
Kojto | 34:1ad18123bf11 | 1128 | * \return none |
Kojto | 20:30b6ed7bf8fd | 1129 | */ |
Kojto | 20:30b6ed7bf8fd | 1130 | void read_synchronous(uint8_t *data, uint16_t size); |
Kojto | 34:1ad18123bf11 | 1131 | /** |
Kojto | 34:1ad18123bf11 | 1132 | * \brief Process the received SPI Header and in accordance with it - continue reading the packet |
Kojto | 34:1ad18123bf11 | 1133 | * \param None |
Kojto | 34:1ad18123bf11 | 1134 | * \return 0 |
Kojto | 20:30b6ed7bf8fd | 1135 | */ |
Kojto | 20:30b6ed7bf8fd | 1136 | uint32_t read_data_cont(); |
Kojto | 20:30b6ed7bf8fd | 1137 | /** |
Kojto | 34:1ad18123bf11 | 1138 | * \brief Enable WLAN interrutp |
Kojto | 34:1ad18123bf11 | 1139 | * \param None |
Kojto | 34:1ad18123bf11 | 1140 | * \return None |
Kojto | 20:30b6ed7bf8fd | 1141 | */ |
Kojto | 20:30b6ed7bf8fd | 1142 | void wlan_irq_enable(); |
Kojto | 34:1ad18123bf11 | 1143 | /** |
Kojto | 34:1ad18123bf11 | 1144 | * \brief Disable WLAN interrutp |
Kojto | 34:1ad18123bf11 | 1145 | * \param None |
Kojto | 34:1ad18123bf11 | 1146 | * \return None |
Kojto | 20:30b6ed7bf8fd | 1147 | */ |
Kojto | 20:30b6ed7bf8fd | 1148 | void wlan_irq_disable(); |
Kojto | 20:30b6ed7bf8fd | 1149 | /** |
Kojto | 34:1ad18123bf11 | 1150 | * \brief Get WLAN interrupt status |
Kojto | 34:1ad18123bf11 | 1151 | * \param None |
Kojto | 34:1ad18123bf11 | 1152 | * \return 0 : No interrupt occured |
Kojto | 34:1ad18123bf11 | 1153 | * 1 : Interrupt occured |
Kojto | 20:30b6ed7bf8fd | 1154 | */ |
Kojto | 20:30b6ed7bf8fd | 1155 | uint32_t wlan_irq_read(); |
Kojto | 20:30b6ed7bf8fd | 1156 | /** |
Kojto | 34:1ad18123bf11 | 1157 | * \brief SPI interrupt Handler. |
Kojto | 34:1ad18123bf11 | 1158 | * The external WLAN device asserts the IRQ line when data is ready.\n |
Kojto | 34:1ad18123bf11 | 1159 | * The host CPU needs to acknowledges the IRQ by asserting CS.\n |
Kojto | 34:1ad18123bf11 | 1160 | * |
Kojto | 34:1ad18123bf11 | 1161 | * \param none |
Kojto | 34:1ad18123bf11 | 1162 | * \return none |
Kojto | 20:30b6ed7bf8fd | 1163 | */ |
Kojto | 20:30b6ed7bf8fd | 1164 | void WLAN_IRQHandler(); |
Kojto | 20:30b6ed7bf8fd | 1165 | /** |
Kojto | 34:1ad18123bf11 | 1166 | * \brief Enable/Disable the WLAN module |
Kojto | 34:1ad18123bf11 | 1167 | * \param value 1 : Enable |
Kojto | 34:1ad18123bf11 | 1168 | * 0 : Disable |
Kojto | 34:1ad18123bf11 | 1169 | * \return None |
Kojto | 20:30b6ed7bf8fd | 1170 | */ |
Kojto | 34:1ad18123bf11 | 1171 | void set_wlan_en(uint8_t value); |
Kojto | 20:30b6ed7bf8fd | 1172 | private: |
Kojto | 20:30b6ed7bf8fd | 1173 | tSpiInfo _spi_info; |
Kojto | 20:30b6ed7bf8fd | 1174 | InterruptIn _wlan_irq; |
Kojto | 20:30b6ed7bf8fd | 1175 | DigitalOut _wlan_en; |
Kojto | 20:30b6ed7bf8fd | 1176 | DigitalOut _wlan_cs; |
Kojto | 20:30b6ed7bf8fd | 1177 | SPI _wlan_spi; |
Kojto | 20:30b6ed7bf8fd | 1178 | cc3000_event &_event; |
Kojto | 20:30b6ed7bf8fd | 1179 | cc3000_simple_link &_simple_link; |
Kojto | 45:50ab13d8f2dc | 1180 | bool _process_irq; |
Kojto | 20:30b6ed7bf8fd | 1181 | }; |
Kojto | 20:30b6ed7bf8fd | 1182 | |
Kojto | 31:7b6e85b68b01 | 1183 | /** HCI layer |
Kojto | 31:7b6e85b68b01 | 1184 | */ |
Kojto | 20:30b6ed7bf8fd | 1185 | class cc3000_hci { |
Kojto | 20:30b6ed7bf8fd | 1186 | public: |
Kojto | 29:c40918cd9b6d | 1187 | /** |
Kojto | 29:c40918cd9b6d | 1188 | * \brief Ctor |
Kojto | 34:1ad18123bf11 | 1189 | * \param spi Reference to the spi object. |
Kojto | 29:c40918cd9b6d | 1190 | * \return none |
Kojto | 29:c40918cd9b6d | 1191 | */ |
Kojto | 20:30b6ed7bf8fd | 1192 | cc3000_hci(cc3000_spi &spi); |
Kojto | 29:c40918cd9b6d | 1193 | /** |
Kojto | 29:c40918cd9b6d | 1194 | * \brief Dtor |
Kojto | 29:c40918cd9b6d | 1195 | * \param none |
Kojto | 29:c40918cd9b6d | 1196 | * \return none |
Kojto | 29:c40918cd9b6d | 1197 | */ |
Kojto | 20:30b6ed7bf8fd | 1198 | ~cc3000_hci(); |
Kojto | 29:c40918cd9b6d | 1199 | /** |
Kojto | 29:c40918cd9b6d | 1200 | * \brief Initiate an HCI command. |
Kojto | 29:c40918cd9b6d | 1201 | * \param op_code command operation code |
Kojto | 29:c40918cd9b6d | 1202 | * \param buffer pointer to the command's arguments buffer |
Kojto | 29:c40918cd9b6d | 1203 | * \param length length of the arguments |
Kojto | 34:1ad18123bf11 | 1204 | * \return 0 |
Kojto | 29:c40918cd9b6d | 1205 | */ |
Kojto | 20:30b6ed7bf8fd | 1206 | uint16_t command_send(uint16_t op_code, uint8_t *buffer, uint8_t length); |
Kojto | 29:c40918cd9b6d | 1207 | /** |
Kojto | 29:c40918cd9b6d | 1208 | * \brief Initiate an HCI data write operation |
Kojto | 29:c40918cd9b6d | 1209 | * \param op_code command operation code |
Kojto | 29:c40918cd9b6d | 1210 | * \param args pointer to the command's arguments buffer |
Kojto | 29:c40918cd9b6d | 1211 | * \param arg_length length of the arguments |
Kojto | 29:c40918cd9b6d | 1212 | * \param data_length length od data |
Kojto | 29:c40918cd9b6d | 1213 | * \param tail pointer to the data buffer |
Kojto | 29:c40918cd9b6d | 1214 | * \param tail_length buffer length |
Kojto | 34:1ad18123bf11 | 1215 | * \return ESUCCESS |
Kojto | 29:c40918cd9b6d | 1216 | */ |
Kojto | 20:30b6ed7bf8fd | 1217 | uint32_t data_send(uint8_t op_code, uint8_t *args, uint16_t arg_length, |
Kojto | 20:30b6ed7bf8fd | 1218 | uint16_t data_length, const uint8_t *tail, uint16_t tail_length); |
Kojto | 29:c40918cd9b6d | 1219 | /** |
Kojto | 29:c40918cd9b6d | 1220 | * \brief Prepare HCI header and initiate an HCI data write operation. |
Kojto | 29:c40918cd9b6d | 1221 | * \param op_code command operation code |
Kojto | 29:c40918cd9b6d | 1222 | * \param buffer pointer to the data buffer |
Kojto | 29:c40918cd9b6d | 1223 | * \param arg_length arguments length |
Kojto | 29:c40918cd9b6d | 1224 | * \param data_length data length |
Kojto | 29:c40918cd9b6d | 1225 | * \return none |
Kojto | 29:c40918cd9b6d | 1226 | */ |
Kojto | 20:30b6ed7bf8fd | 1227 | void data_command_send(uint16_t op_code, uint8_t *buffer, uint8_t arg_length, |
Kojto | 20:30b6ed7bf8fd | 1228 | uint16_t data_length); |
Kojto | 29:c40918cd9b6d | 1229 | /** |
Kojto | 29:c40918cd9b6d | 1230 | * \brief Prepare HCI header and initiate an HCI patch write operation. |
Kojto | 29:c40918cd9b6d | 1231 | * \param op_code command operation code |
Kojto | 29:c40918cd9b6d | 1232 | * \param buffer pointer to the command's arguments buffer |
Kojto | 29:c40918cd9b6d | 1233 | * \param patch pointer to patch content buffer |
Kojto | 29:c40918cd9b6d | 1234 | * \param data_length data length |
Kojto | 29:c40918cd9b6d | 1235 | * \return none |
Kojto | 29:c40918cd9b6d | 1236 | */ |
Kojto | 20:30b6ed7bf8fd | 1237 | void patch_send(uint8_t op_code, uint8_t *buffer, uint8_t *patch, uint16_t data_length); |
Kojto | 20:30b6ed7bf8fd | 1238 | private: |
Kojto | 20:30b6ed7bf8fd | 1239 | cc3000_spi &_spi; |
Kojto | 20:30b6ed7bf8fd | 1240 | }; |
Kojto | 20:30b6ed7bf8fd | 1241 | |
Kojto | 31:7b6e85b68b01 | 1242 | /** NVMEM layer |
Kojto | 31:7b6e85b68b01 | 1243 | */ |
Kojto | 20:30b6ed7bf8fd | 1244 | class cc3000_nvmem { |
Kojto | 20:30b6ed7bf8fd | 1245 | public: |
Kojto | 29:c40918cd9b6d | 1246 | /** |
Kojto | 29:c40918cd9b6d | 1247 | * \brief Ctor |
Kojto | 34:1ad18123bf11 | 1248 | * \param hci Reference to the hci object. |
Kojto | 34:1ad18123bf11 | 1249 | * \param event Reference to the event object. |
Kojto | 34:1ad18123bf11 | 1250 | * \param simple_link Reference to the simple link object. |
Kojto | 29:c40918cd9b6d | 1251 | * \return none |
Kojto | 29:c40918cd9b6d | 1252 | */ |
Kojto | 29:c40918cd9b6d | 1253 | cc3000_nvmem(cc3000_hci &hci, cc3000_event &event, cc3000_simple_link &simple_link); |
Kojto | 29:c40918cd9b6d | 1254 | /** |
Kojto | 29:c40918cd9b6d | 1255 | * \brief Dtor |
Kojto | 29:c40918cd9b6d | 1256 | * \param none |
Kojto | 29:c40918cd9b6d | 1257 | * \return none |
Kojto | 29:c40918cd9b6d | 1258 | */ |
Kojto | 20:30b6ed7bf8fd | 1259 | ~cc3000_nvmem(); |
Kojto | 29:c40918cd9b6d | 1260 | /** |
Kojto | 29:c40918cd9b6d | 1261 | * \brief Reads data from the file referred by the file_id parameter. |
Kojto | 29:c40918cd9b6d | 1262 | * Reads data from file offset till length. Err if the file can't be used, |
Kojto | 29:c40918cd9b6d | 1263 | * is invalid, or if the read is out of bounds. |
Kojto | 29:c40918cd9b6d | 1264 | * \param file_id nvmem file id. |
Kojto | 29:c40918cd9b6d | 1265 | * \param length number of bytes to read. |
Kojto | 29:c40918cd9b6d | 1266 | * \param offset offset in file from where to read. |
Kojto | 29:c40918cd9b6d | 1267 | * \param buff output buffer pointer. |
Kojto | 29:c40918cd9b6d | 1268 | * \return |
Kojto | 29:c40918cd9b6d | 1269 | * Number of bytes read, otherwise error. |
Kojto | 29:c40918cd9b6d | 1270 | */ |
Kojto | 20:30b6ed7bf8fd | 1271 | int32_t read(uint32_t file_id, uint32_t length, uint32_t offset, uint8_t *buff); |
Kojto | 29:c40918cd9b6d | 1272 | /** |
Kojto | 29:c40918cd9b6d | 1273 | * \brief Write data to nvmem. |
Kojto | 29:c40918cd9b6d | 1274 | * \param file_id Nvmem file id |
Kojto | 29:c40918cd9b6d | 1275 | * \param length number of bytes to write |
Kojto | 29:c40918cd9b6d | 1276 | * \param entry_offset offset in file to start write operation from |
Kojto | 29:c40918cd9b6d | 1277 | * \param buff data to write |
Kojto | 29:c40918cd9b6d | 1278 | * \return |
Kojto | 29:c40918cd9b6d | 1279 | * On success 0, error otherwise. |
Kojto | 29:c40918cd9b6d | 1280 | */ |
Kojto | 20:30b6ed7bf8fd | 1281 | int32_t write(uint32_t file_id, uint32_t length, uint32_t entry_offset, uint8_t *buff); |
Kojto | 29:c40918cd9b6d | 1282 | /** |
Kojto | 29:c40918cd9b6d | 1283 | * \brief Write MAC address to EEPROM. |
Kojto | 29:c40918cd9b6d | 1284 | * \param mac Mac address to be set |
Kojto | 29:c40918cd9b6d | 1285 | * \return |
Kojto | 29:c40918cd9b6d | 1286 | * On success 0, error otherwise. |
Kojto | 29:c40918cd9b6d | 1287 | */ |
Kojto | 20:30b6ed7bf8fd | 1288 | uint8_t set_mac_address(uint8_t *mac); |
Kojto | 29:c40918cd9b6d | 1289 | /** |
Kojto | 29:c40918cd9b6d | 1290 | * \brief Read MAC address from EEPROM. |
Kojto | 29:c40918cd9b6d | 1291 | * \param mac Mac address |
Kojto | 29:c40918cd9b6d | 1292 | * \return |
Kojto | 33:9e23b24fb4f3 | 1293 | * On success 0, error otherwise. |
Kojto | 29:c40918cd9b6d | 1294 | */ |
Kojto | 20:30b6ed7bf8fd | 1295 | uint8_t get_mac_address(uint8_t *mac); |
Kojto | 29:c40918cd9b6d | 1296 | /** |
Kojto | 29:c40918cd9b6d | 1297 | * \brief Program a patch to a specific file ID. The SP data is assumed to be organized in 2-dimensional. |
Kojto | 29:c40918cd9b6d | 1298 | * Each line is SP_PORTION_SIZE bytes long. |
Kojto | 29:c40918cd9b6d | 1299 | * \param file_id nvmem file id/ |
Kojto | 29:c40918cd9b6d | 1300 | * \param length number of bytes to write |
Kojto | 29:c40918cd9b6d | 1301 | * \param data SP data to write |
Kojto | 29:c40918cd9b6d | 1302 | * \return |
Kojto | 29:c40918cd9b6d | 1303 | * On success 0, error otherwise. |
Kojto | 29:c40918cd9b6d | 1304 | */ |
Kojto | 20:30b6ed7bf8fd | 1305 | uint8_t write_patch(uint32_t file_id, uint32_t length, const uint8_t *data); |
Kojto | 29:c40918cd9b6d | 1306 | /** |
Kojto | 29:c40918cd9b6d | 1307 | * \brief Create new file entry and allocate space on the NVMEM. Applies only to user files. |
Kojto | 29:c40918cd9b6d | 1308 | * \param file_id nvmem file Id |
Kojto | 29:c40918cd9b6d | 1309 | * \param new_len entry ulLength |
Kojto | 29:c40918cd9b6d | 1310 | * \return |
Kojto | 29:c40918cd9b6d | 1311 | */ |
Kojto | 20:30b6ed7bf8fd | 1312 | int32_t create_entry(uint32_t file_id, uint32_t new_len); |
Kojto | 20:30b6ed7bf8fd | 1313 | #ifndef CC3000_TINY_DRIVER |
Kojto | 29:c40918cd9b6d | 1314 | /** |
Kojto | 29:c40918cd9b6d | 1315 | * \brief Read patch version. read package version (WiFi FW patch, river-supplicant-NS patch, |
Kojto | 29:c40918cd9b6d | 1316 | * bootloader patch) |
Kojto | 29:c40918cd9b6d | 1317 | * \param patch_ver First number indicates package ID and the second number indicates |
Kojto | 29:c40918cd9b6d | 1318 | * package build number |
Kojto | 29:c40918cd9b6d | 1319 | * \return |
Kojto | 29:c40918cd9b6d | 1320 | * On success 0, error otherwise. |
Kojto | 29:c40918cd9b6d | 1321 | */ |
Kojto | 20:30b6ed7bf8fd | 1322 | uint8_t read_sp_version(uint8_t* patch_ver); |
Kojto | 20:30b6ed7bf8fd | 1323 | #endif |
Kojto | 20:30b6ed7bf8fd | 1324 | private: |
Kojto | 20:30b6ed7bf8fd | 1325 | cc3000_hci &_hci; |
Kojto | 20:30b6ed7bf8fd | 1326 | cc3000_event &_event; |
Kojto | 20:30b6ed7bf8fd | 1327 | cc3000_simple_link &_simple_link; |
Kojto | 20:30b6ed7bf8fd | 1328 | }; |
Kojto | 20:30b6ed7bf8fd | 1329 | |
Kojto | 31:7b6e85b68b01 | 1330 | /** WLAN layer |
Kojto | 31:7b6e85b68b01 | 1331 | */ |
Kojto | 20:30b6ed7bf8fd | 1332 | class cc3000_wlan { |
Kojto | 20:30b6ed7bf8fd | 1333 | public: |
Kojto | 29:c40918cd9b6d | 1334 | /** |
Kojto | 29:c40918cd9b6d | 1335 | * \brief Ctor |
Kojto | 34:1ad18123bf11 | 1336 | * \param simple_link Reference to the simple link object. |
Kojto | 34:1ad18123bf11 | 1337 | * \param event Reference to the event object. |
Kojto | 34:1ad18123bf11 | 1338 | * \param spi Reference to the spi object. |
Kojto | 34:1ad18123bf11 | 1339 | * \param hci Reference to the hci object. |
Kojto | 29:c40918cd9b6d | 1340 | * \return none |
Kojto | 29:c40918cd9b6d | 1341 | */ |
Kojto | 20:30b6ed7bf8fd | 1342 | cc3000_wlan(cc3000_simple_link &simple_link, cc3000_event &event, cc3000_spi &spi, cc3000_hci &hci); |
Kojto | 29:c40918cd9b6d | 1343 | /** |
Kojto | 29:c40918cd9b6d | 1344 | * \brief Dtor |
Kojto | 29:c40918cd9b6d | 1345 | * \param none |
Kojto | 29:c40918cd9b6d | 1346 | * \return none |
Kojto | 29:c40918cd9b6d | 1347 | */ |
Kojto | 20:30b6ed7bf8fd | 1348 | ~cc3000_wlan(); |
Kojto | 29:c40918cd9b6d | 1349 | /** |
Kojto | 29:c40918cd9b6d | 1350 | * \brief Send SIMPLE LINK START to cc3000. |
Kojto | 29:c40918cd9b6d | 1351 | * \param patches_available_host Flag to indicate if patches are available. |
Kojto | 20:30b6ed7bf8fd | 1352 | * \return none |
Kojto | 20:30b6ed7bf8fd | 1353 | */ |
Kojto | 20:30b6ed7bf8fd | 1354 | void simpleLink_init_start(uint16_t patches_available_host); |
Kojto | 29:c40918cd9b6d | 1355 | /** |
Kojto | 29:c40918cd9b6d | 1356 | * \brief Start wlan device. Blocking call until init is completed. |
Kojto | 29:c40918cd9b6d | 1357 | * \param patches_available_host Flag to indicate if patches are available. |
Kojto | 20:30b6ed7bf8fd | 1358 | * \return none |
Kojto | 20:30b6ed7bf8fd | 1359 | */ |
Kojto | 20:30b6ed7bf8fd | 1360 | void start(uint16_t patches_available_host); |
Kojto | 29:c40918cd9b6d | 1361 | /** |
Kojto | 29:c40918cd9b6d | 1362 | * \brief Stop wlan device |
Kojto | 20:30b6ed7bf8fd | 1363 | * \param none |
Kojto | 20:30b6ed7bf8fd | 1364 | * \return none |
Kojto | 20:30b6ed7bf8fd | 1365 | */ |
Kojto | 20:30b6ed7bf8fd | 1366 | void stop(void); |
Kojto | 20:30b6ed7bf8fd | 1367 | #ifndef CC3000_TINY_DRIVER |
Kojto | 29:c40918cd9b6d | 1368 | /** |
Kojto | 29:c40918cd9b6d | 1369 | * \brief Connect to AP. |
Kojto | 29:c40918cd9b6d | 1370 | * \param sec_type Security option. |
Kojto | 29:c40918cd9b6d | 1371 | * \param ssid up to 32 bytes, ASCII SSID |
Kojto | 29:c40918cd9b6d | 1372 | * \param ssid_length length of SSID |
Kojto | 29:c40918cd9b6d | 1373 | * \param b_ssid 6 bytes specified the AP bssid |
Kojto | 29:c40918cd9b6d | 1374 | * \param key up to 16 bytes specified the AP security key |
Kojto | 29:c40918cd9b6d | 1375 | * \param key_len key length |
Kojto | 29:c40918cd9b6d | 1376 | * \return |
Kojto | 29:c40918cd9b6d | 1377 | * On success, zero is returned. On error, negative is returned. |
Kojto | 29:c40918cd9b6d | 1378 | */ |
Kojto | 20:30b6ed7bf8fd | 1379 | int32_t connect(uint32_t sec_type, const uint8_t *ssid, int32_t ssid_length, uint8_t *b_ssid, uint8_t *key, int32_t key_len); |
Kojto | 29:c40918cd9b6d | 1380 | /** |
Kojto | 29:c40918cd9b6d | 1381 | * \brief Add profile. Up to 7 profiles are supported. |
Kojto | 29:c40918cd9b6d | 1382 | * \param sec_type Security option. |
Kojto | 29:c40918cd9b6d | 1383 | * \param ssid Up to 32 bytes, ASCII SSID |
Kojto | 29:c40918cd9b6d | 1384 | * \param ssid_length Length of SSID |
Kojto | 29:c40918cd9b6d | 1385 | * \param b_ssid 6 bytes specified the AP bssid |
Kojto | 29:c40918cd9b6d | 1386 | * \param priority Up to 16 bytes specified the AP security key |
Kojto | 29:c40918cd9b6d | 1387 | * \param pairwise_cipher_or_tx_key_len Key length |
Kojto | 29:c40918cd9b6d | 1388 | * \param group_cipher_tx_key_index Key length for WEP security |
Kojto | 29:c40918cd9b6d | 1389 | * \param key_mgmt KEY management |
Kojto | 29:c40918cd9b6d | 1390 | * \param pf_or_key Security key |
Kojto | 29:c40918cd9b6d | 1391 | * \param pass_phrase_length Security key length for WPA\WPA2 |
Kojto | 29:c40918cd9b6d | 1392 | * \return |
Kojto | 29:c40918cd9b6d | 1393 | * On success, zero is returned. On error, negative is returned. |
Kojto | 29:c40918cd9b6d | 1394 | */ |
Kojto | 20:30b6ed7bf8fd | 1395 | int32_t add_profile(uint32_t sec_type, uint8_t* ssid, uint32_t ssid_length, uint8_t *b_ssid, uint32_t priority, uint32_t pairwise_cipher_or_tx_key_len, uint32_t group_cipher_tx_key_index, |
Kojto | 20:30b6ed7bf8fd | 1396 | uint32_t key_mgmt, uint8_t* pf_or_key, uint32_t pass_phrase_length); |
Kojto | 29:c40918cd9b6d | 1397 | /** |
Kojto | 29:c40918cd9b6d | 1398 | * \brief Gets entry from scan result table. The scan results are returned |
Kojto | 29:c40918cd9b6d | 1399 | * one by one, and each entry represents a single AP found in the area. |
Kojto | 29:c40918cd9b6d | 1400 | * \param scan_timeout Not supported yet |
Kojto | 29:c40918cd9b6d | 1401 | * \param results Scan result |
Kojto | 29:c40918cd9b6d | 1402 | * \return |
Kojto | 29:c40918cd9b6d | 1403 | * On success, zero is returned. On error, -1 is returned |
Kojto | 29:c40918cd9b6d | 1404 | */ |
Kojto | 20:30b6ed7bf8fd | 1405 | int32_t ioctl_get_scan_results(uint32_t scan_timeout, uint8_t *results); |
Kojto | 29:c40918cd9b6d | 1406 | /** |
Kojto | 29:c40918cd9b6d | 1407 | * \brief Start and stop scan procedure. Set scan parameters. |
Kojto | 29:c40918cd9b6d | 1408 | * \param enable Start/stop application scan |
Kojto | 29:c40918cd9b6d | 1409 | * \param min_dwell_time Minimum dwell time value to be used for each channel, in ms. (Default: 20) |
Kojto | 29:c40918cd9b6d | 1410 | * \param max_dwell_time Maximum dwell time value to be used for each channel, in ms. (Default: 30) |
Kojto | 29:c40918cd9b6d | 1411 | * \param num_probe_requests Max probe request between dwell time. (Default:2) |
Kojto | 29:c40918cd9b6d | 1412 | * \param channel_mask Bitwise, up to 13 channels (0x1fff). |
Kojto | 29:c40918cd9b6d | 1413 | * \param rssi_threshold RSSI threshold. Saved: yes (Default: -80) |
Kojto | 29:c40918cd9b6d | 1414 | * \param snr_threshold NSR threshold. Saved: yes (Default: 0) |
Kojto | 29:c40918cd9b6d | 1415 | * \param default_tx_power probe Tx power. Saved: yes (Default: 205) |
Kojto | 29:c40918cd9b6d | 1416 | * \param interval_list Pointer to array with 16 entries (16 channels) |
Kojto | 29:c40918cd9b6d | 1417 | * \return |
Kojto | 29:c40918cd9b6d | 1418 | * On success, zero is returned. On error, -1 is returned. |
Kojto | 29:c40918cd9b6d | 1419 | */ |
Kojto | 20:30b6ed7bf8fd | 1420 | int32_t ioctl_set_scan_params(uint32_t enable, uint32_t min_dwell_time, uint32_t max_dwell_time, uint32_t num_probe_requests, |
Kojto | 20:30b6ed7bf8fd | 1421 | uint32_t channel_mask, int32_t rssi_threshold, uint32_t snr_threshold, uint32_t default_tx_power, uint32_t *interval_list); |
Kojto | 29:c40918cd9b6d | 1422 | /** |
Kojto | 29:c40918cd9b6d | 1423 | * \brief Get wlan status: disconnected, scanning, connecting or connected |
Kojto | 29:c40918cd9b6d | 1424 | * \param none |
Kojto | 29:c40918cd9b6d | 1425 | * \return |
Kojto | 29:c40918cd9b6d | 1426 | * WLAN_STATUS_DISCONNECTED, WLAN_STATUS_SCANING, STATUS_CONNECTING or WLAN_STATUS_CONNECTED |
Kojto | 29:c40918cd9b6d | 1427 | */ |
Kojto | 20:30b6ed7bf8fd | 1428 | int32_t ioctl_statusget(void); |
Kojto | 20:30b6ed7bf8fd | 1429 | #else |
Kojto | 29:c40918cd9b6d | 1430 | /** |
Kojto | 29:c40918cd9b6d | 1431 | * \brief Connect to AP |
Kojto | 29:c40918cd9b6d | 1432 | * \param ssid Up to 32 bytes and is ASCII SSID of the AP |
Kojto | 29:c40918cd9b6d | 1433 | * \param ssid_length Length of the SSID |
Kojto | 29:c40918cd9b6d | 1434 | * \return |
Kojto | 29:c40918cd9b6d | 1435 | * On success, zero is returned. On error, negative is returned. |
Kojto | 29:c40918cd9b6d | 1436 | */ |
Kojto | 20:30b6ed7bf8fd | 1437 | int32_t connect(const uint8_t *ssid, int32_t ssid_length); |
Kojto | 29:c40918cd9b6d | 1438 | /** |
Kojto | 29:c40918cd9b6d | 1439 | * \brief When auto start is enabled, the device connects to station from the profiles table. |
Kojto | 29:c40918cd9b6d | 1440 | * If several profiles configured the device choose the highest priority profile. |
Kojto | 29:c40918cd9b6d | 1441 | * \param sec_type WLAN_SEC_UNSEC,WLAN_SEC_WEP,WLAN_SEC_WPA,WLAN_SEC_WPA2 |
Kojto | 29:c40918cd9b6d | 1442 | * \param ssid SSID up to 32 bytes |
Kojto | 29:c40918cd9b6d | 1443 | * \param ssid_length SSID length |
Kojto | 29:c40918cd9b6d | 1444 | * \param b_ssid bssid 6 bytes |
Kojto | 29:c40918cd9b6d | 1445 | * \param priority Profile priority. Lowest priority:0. |
Kojto | 29:c40918cd9b6d | 1446 | * \param pairwise_cipher_or_tx_key_len Key length for WEP security |
Kojto | 29:c40918cd9b6d | 1447 | * \param group_cipher_tx_key_index Key index |
Kojto | 29:c40918cd9b6d | 1448 | * \param key_mgmt KEY management |
Kojto | 29:c40918cd9b6d | 1449 | * \param pf_or_key Security key |
Kojto | 29:c40918cd9b6d | 1450 | * \param pass_phrase_length Security key length for WPA\WPA2 |
Kojto | 29:c40918cd9b6d | 1451 | * \return |
Kojto | 29:c40918cd9b6d | 1452 | * On success, zero is returned. On error, -1 is returned |
Kojto | 29:c40918cd9b6d | 1453 | */ |
Kojto | 20:30b6ed7bf8fd | 1454 | int32_t add_profile(uint32_t sec_type, uint8_t *ssid, uint32_t ssid_length, uint8_t *b_ssid, uint32_t priority, |
Kojto | 20:30b6ed7bf8fd | 1455 | uint32_t pairwise_cipher_or_tx_key_len, uint32_t group_cipher_tx_key_index, uint32_t key_mgmt, |
Kojto | 20:30b6ed7bf8fd | 1456 | uint8_t* pf_or_key, uint32_t pass_phrase_length); |
Kojto | 20:30b6ed7bf8fd | 1457 | #endif |
Kojto | 20:30b6ed7bf8fd | 1458 | #ifndef CC3000_UNENCRYPTED_SMART_CONFIG |
Kojto | 29:c40918cd9b6d | 1459 | /** |
Kojto | 29:c40918cd9b6d | 1460 | * \brief Process the acquired data and store it as a profile. |
Kojto | 29:c40918cd9b6d | 1461 | * \param none |
Kojto | 29:c40918cd9b6d | 1462 | * \return |
Kojto | 29:c40918cd9b6d | 1463 | * On success, zero is returned. On error, -1 is returned. |
Kojto | 29:c40918cd9b6d | 1464 | */ |
Kojto | 20:30b6ed7bf8fd | 1465 | int32_t smart_config_process(void); |
Kojto | 20:30b6ed7bf8fd | 1466 | #endif |
Kojto | 29:c40918cd9b6d | 1467 | /** |
Kojto | 29:c40918cd9b6d | 1468 | * \brief Disconnect connection from AP. |
Kojto | 29:c40918cd9b6d | 1469 | * \param none |
Kojto | 29:c40918cd9b6d | 1470 | * \return |
Kojto | 29:c40918cd9b6d | 1471 | * 0 if disconnected done, other CC3000 already disconnected. |
Kojto | 29:c40918cd9b6d | 1472 | */ |
Kojto | 20:30b6ed7bf8fd | 1473 | int32_t disconnect(); |
Kojto | 29:c40918cd9b6d | 1474 | /** |
Kojto | 29:c40918cd9b6d | 1475 | * \brief When auto is enabled, the device tries to connect according the following policy: |
Kojto | 29:c40918cd9b6d | 1476 | * 1) If fast connect is enabled and last connection is valid, the device will try to |
Kojto | 29:c40918cd9b6d | 1477 | * connect to it without the scanning procedure (fast). The last connection will be |
Kojto | 29:c40918cd9b6d | 1478 | * marked as invalid, due to adding/removing profile. |
Kojto | 29:c40918cd9b6d | 1479 | * 2) If profile exists, the device will try to connect it (Up to seven profiles). |
Kojto | 29:c40918cd9b6d | 1480 | * 3) If fast and profiles are not found, and open mode is enabled, the device |
Kojto | 29:c40918cd9b6d | 1481 | * will try to connect to any AP. |
Kojto | 29:c40918cd9b6d | 1482 | * Note that the policy settings are stored in the CC3000 NVMEM. |
Kojto | 29:c40918cd9b6d | 1483 | * \param should_connect_to_open_ap Enable(1), disable(0) connect to any available AP. |
Kojto | 29:c40918cd9b6d | 1484 | * \param use_fast_connect Enable(1), disable(0). if enabled, tries to |
Kojto | 29:c40918cd9b6d | 1485 | * connect to the last connected AP. |
Kojto | 29:c40918cd9b6d | 1486 | * \param use_profiles Enable(1), disable(0) auto connect after reset. |
Kojto | 29:c40918cd9b6d | 1487 | * and periodically reconnect if needed. |
Kojto | 29:c40918cd9b6d | 1488 | * \return |
Kojto | 29:c40918cd9b6d | 1489 | * On success, zero is returned. On error, -1 is returned |
Kojto | 29:c40918cd9b6d | 1490 | */ |
Kojto | 20:30b6ed7bf8fd | 1491 | int32_t ioctl_set_connection_policy(uint32_t should_connect_to_open_ap, uint32_t use_fast_connect, uint32_t use_profiles); |
Kojto | 29:c40918cd9b6d | 1492 | /** |
Kojto | 29:c40918cd9b6d | 1493 | * \brief Delete WLAN profile |
Kojto | 29:c40918cd9b6d | 1494 | * \param index Number of profile to delete |
Kojto | 29:c40918cd9b6d | 1495 | * \return |
Kojto | 29:c40918cd9b6d | 1496 | * On success, zero is returned. On error, -1 is returned |
Kojto | 29:c40918cd9b6d | 1497 | */ |
Kojto | 20:30b6ed7bf8fd | 1498 | int32_t ioctl_del_profile(uint32_t index); |
Kojto | 29:c40918cd9b6d | 1499 | /** |
Kojto | 29:c40918cd9b6d | 1500 | * \brief Mask event according to bit mask. In case that event is |
Kojto | 29:c40918cd9b6d | 1501 | * masked (1), the device will not send the masked event to host. |
Kojto | 29:c40918cd9b6d | 1502 | * \param mask event mask |
Kojto | 29:c40918cd9b6d | 1503 | * \return |
Kojto | 29:c40918cd9b6d | 1504 | * On success, zero is returned. On error, -1 is returned |
Kojto | 29:c40918cd9b6d | 1505 | */ |
Kojto | 20:30b6ed7bf8fd | 1506 | int32_t set_event_mask(uint32_t mask); |
Kojto | 29:c40918cd9b6d | 1507 | /** |
Kojto | 29:c40918cd9b6d | 1508 | * \brief Start to acquire device profile. The device acquire its own |
Kojto | 29:c40918cd9b6d | 1509 | * profile, if profile message is found. |
Kojto | 29:c40918cd9b6d | 1510 | * \param encrypted_flag Indicates whether the information is encrypted |
Kojto | 29:c40918cd9b6d | 1511 | * \return |
Kojto | 29:c40918cd9b6d | 1512 | * On success, zero is returned. On error, -1 is returned. |
Kojto | 29:c40918cd9b6d | 1513 | */ |
Kojto | 20:30b6ed7bf8fd | 1514 | int32_t smart_config_start(uint32_t encrypted_flag); |
Kojto | 29:c40918cd9b6d | 1515 | /** |
Kojto | 29:c40918cd9b6d | 1516 | * \brief Stop the acquire profile procedure. |
Kojto | 29:c40918cd9b6d | 1517 | * \param none |
Kojto | 29:c40918cd9b6d | 1518 | * \return |
Kojto | 29:c40918cd9b6d | 1519 | * On success, zero is returned. On error, -1 is returned |
Kojto | 29:c40918cd9b6d | 1520 | */ |
Kojto | 20:30b6ed7bf8fd | 1521 | int32_t smart_config_stop(void); |
Kojto | 29:c40918cd9b6d | 1522 | /** |
Kojto | 29:c40918cd9b6d | 1523 | * \brief Configure station ssid prefix. |
Kojto | 29:c40918cd9b6d | 1524 | * \param new_prefix 3 bytes identify the SSID prefix for the Smart Config. |
Kojto | 29:c40918cd9b6d | 1525 | * \return |
Kojto | 29:c40918cd9b6d | 1526 | * On success, zero is returned. On error, -1 is returned. |
Kojto | 29:c40918cd9b6d | 1527 | */ |
Kojto | 20:30b6ed7bf8fd | 1528 | int32_t smart_config_set_prefix(uint8_t *new_prefix); |
Kojto | 20:30b6ed7bf8fd | 1529 | private: |
Kojto | 20:30b6ed7bf8fd | 1530 | cc3000_simple_link &_simple_link; |
Kojto | 20:30b6ed7bf8fd | 1531 | cc3000_event &_event; |
Kojto | 20:30b6ed7bf8fd | 1532 | cc3000_spi &_spi; |
Kojto | 20:30b6ed7bf8fd | 1533 | cc3000_hci &_hci; |
Kojto | 20:30b6ed7bf8fd | 1534 | }; |
Kojto | 20:30b6ed7bf8fd | 1535 | |
Kojto | 31:7b6e85b68b01 | 1536 | /** The main object of cc3000 implementation |
Kojto | 20:30b6ed7bf8fd | 1537 | */ |
Kojto | 20:30b6ed7bf8fd | 1538 | class cc3000 { |
Kojto | 20:30b6ed7bf8fd | 1539 | public: |
Kojto | 29:c40918cd9b6d | 1540 | /** status structure */ |
Kojto | 20:30b6ed7bf8fd | 1541 | typedef struct { |
Kojto | 45:50ab13d8f2dc | 1542 | uint8_t socket; |
Kojto | 29:c40918cd9b6d | 1543 | bool dhcp; |
Kojto | 29:c40918cd9b6d | 1544 | bool connected; |
Kojto | 29:c40918cd9b6d | 1545 | bool smart_config_complete; |
Kojto | 29:c40918cd9b6d | 1546 | bool stop_smart_config; |
Kojto | 29:c40918cd9b6d | 1547 | bool dhcp_configured; |
Kojto | 29:c40918cd9b6d | 1548 | bool ok_to_shut_down; |
SolderSplashLabs | 39:03ac37ab34eb | 1549 | bool enabled; |
Kojto | 20:30b6ed7bf8fd | 1550 | } tStatus; |
Kojto | 29:c40918cd9b6d | 1551 | /** |
Kojto | 29:c40918cd9b6d | 1552 | * \brief Ctor. |
Kojto | 20:30b6ed7bf8fd | 1553 | * \param cc3000_irq IRQ pin |
Kojto | 20:30b6ed7bf8fd | 1554 | * \param cc3000_en Enable pin |
Kojto | 20:30b6ed7bf8fd | 1555 | * \param cc3000_cs Chip select pin |
Kojto | 20:30b6ed7bf8fd | 1556 | * \param cc3000_spi SPI interface |
Kojto | 20:30b6ed7bf8fd | 1557 | */ |
Kojto | 45:50ab13d8f2dc | 1558 | cc3000(PinName cc3000_irq, PinName cc3000_en, PinName cc3000_cs, SPI cc3000_spi); |
Kojto | 29:c40918cd9b6d | 1559 | /** |
Kojto | 29:c40918cd9b6d | 1560 | * \brief Dtor. |
Kojto | 20:30b6ed7bf8fd | 1561 | */ |
Kojto | 20:30b6ed7bf8fd | 1562 | ~cc3000(); |
Kojto | 29:c40918cd9b6d | 1563 | /** |
Kojto | 45:50ab13d8f2dc | 1564 | * \brief Initiate cc3000. It starts the wlan communication. |
Kojto | 20:30b6ed7bf8fd | 1565 | * \param patch Patch |
Kojto | 20:30b6ed7bf8fd | 1566 | */ |
Kojto | 20:30b6ed7bf8fd | 1567 | void start(uint8_t patch); |
Kojto | 29:c40918cd9b6d | 1568 | /** |
Kojto | 29:c40918cd9b6d | 1569 | * \brief Stops the wlan communication. |
Kojto | 20:30b6ed7bf8fd | 1570 | */ |
Kojto | 20:30b6ed7bf8fd | 1571 | void stop(); |
Kojto | 29:c40918cd9b6d | 1572 | /** |
Kojto | 29:c40918cd9b6d | 1573 | * \brief Restarts the wlan communication. |
Kojto | 20:30b6ed7bf8fd | 1574 | */ |
Kojto | 20:30b6ed7bf8fd | 1575 | void restart(uint8_t patch); |
Kojto | 29:c40918cd9b6d | 1576 | /** |
Kojto | 29:c40918cd9b6d | 1577 | * \brief Callback which is called from the event class. This updates status of cc3000. |
Kojto | 20:30b6ed7bf8fd | 1578 | * \param event_type Type of the event |
Kojto | 20:30b6ed7bf8fd | 1579 | * \param data Pointer to data |
Kojto | 20:30b6ed7bf8fd | 1580 | * \param length Length of data |
Kojto | 20:30b6ed7bf8fd | 1581 | * \return none |
Kojto | 20:30b6ed7bf8fd | 1582 | */ |
Kojto | 20:30b6ed7bf8fd | 1583 | void usync_callback(int32_t event_type, uint8_t *data, uint8_t length); |
Kojto | 29:c40918cd9b6d | 1584 | /** |
SolderSplashLabs | 39:03ac37ab34eb | 1585 | * \brief Start connection to SSID (open/secured) non-blocking |
SolderSplashLabs | 39:03ac37ab34eb | 1586 | * \param ssid SSID name |
SolderSplashLabs | 39:03ac37ab34eb | 1587 | * \param key Security key (if key = 0, open connection) |
SolderSplashLabs | 39:03ac37ab34eb | 1588 | * \param security_mode Security mode |
SolderSplashLabs | 39:03ac37ab34eb | 1589 | * \return true if connection was established, false otherwise. |
SolderSplashLabs | 39:03ac37ab34eb | 1590 | */ |
SolderSplashLabs | 39:03ac37ab34eb | 1591 | bool connect_non_blocking(const uint8_t *ssid, const uint8_t *key, int32_t security_mode); |
SolderSplashLabs | 39:03ac37ab34eb | 1592 | /** |
SolderSplashLabs | 39:03ac37ab34eb | 1593 | * \brief Connect to SSID (open/secured) with timeout (10s). |
Kojto | 20:30b6ed7bf8fd | 1594 | * \param ssid SSID name |
Kojto | 20:30b6ed7bf8fd | 1595 | * \param key Security key (if key = 0, open connection) |
Kojto | 20:30b6ed7bf8fd | 1596 | * \param security_mode Security mode |
Kojto | 20:30b6ed7bf8fd | 1597 | * \return true if connection was established, false otherwise. |
Kojto | 20:30b6ed7bf8fd | 1598 | */ |
Kojto | 20:30b6ed7bf8fd | 1599 | bool connect_to_AP(const uint8_t *ssid, const uint8_t *key, int32_t security_mode); |
Kojto | 29:c40918cd9b6d | 1600 | /** |
Kojto | 29:c40918cd9b6d | 1601 | * \brief Connect to SSID which is secured |
Kojto | 20:30b6ed7bf8fd | 1602 | * \param ssid SSID name |
Kojto | 20:30b6ed7bf8fd | 1603 | * \param key Security key |
Kojto | 20:30b6ed7bf8fd | 1604 | * \param security_mode Security mode |
Kojto | 20:30b6ed7bf8fd | 1605 | * \return true if connection was established, false otherwise. |
Kojto | 20:30b6ed7bf8fd | 1606 | */ |
Kojto | 20:30b6ed7bf8fd | 1607 | bool connect_secure(const uint8_t *ssid, const uint8_t *key, int32_t security_mode); |
Kojto | 29:c40918cd9b6d | 1608 | /** |
Kojto | 29:c40918cd9b6d | 1609 | * \brief Connect to SSID which is open (no security) |
Kojto | 20:30b6ed7bf8fd | 1610 | * \param ssid SSID name |
Kojto | 20:30b6ed7bf8fd | 1611 | * \return true if connection was established, false otherwise. |
Kojto | 20:30b6ed7bf8fd | 1612 | */ |
Kojto | 20:30b6ed7bf8fd | 1613 | bool connect_open(const uint8_t *ssid); |
Kojto | 29:c40918cd9b6d | 1614 | /** |
SolderSplashLabs | 39:03ac37ab34eb | 1615 | * \brief Status of the cc3000 module. |
SolderSplashLabs | 39:03ac37ab34eb | 1616 | * \return true if it's enabled, false otherwise. |
SolderSplashLabs | 39:03ac37ab34eb | 1617 | */ |
SolderSplashLabs | 39:03ac37ab34eb | 1618 | bool is_enabled(); |
SolderSplashLabs | 39:03ac37ab34eb | 1619 | /** |
Kojto | 29:c40918cd9b6d | 1620 | * \brief Status of the cc3000 connection. |
Kojto | 20:30b6ed7bf8fd | 1621 | * \return true if it's connected, false otherwise. |
Kojto | 20:30b6ed7bf8fd | 1622 | */ |
Kojto | 20:30b6ed7bf8fd | 1623 | bool is_connected(); |
Kojto | 29:c40918cd9b6d | 1624 | /** |
Kojto | 29:c40918cd9b6d | 1625 | * \brief Status of DHCP. |
Kojto | 20:30b6ed7bf8fd | 1626 | * \param none |
Kojto | 20:30b6ed7bf8fd | 1627 | * \return true if DCHP is configured, false otherwise. |
Kojto | 20:30b6ed7bf8fd | 1628 | */ |
Kojto | 20:30b6ed7bf8fd | 1629 | bool is_dhcp_configured(); |
Kojto | 29:c40918cd9b6d | 1630 | /** |
Kojto | 29:c40918cd9b6d | 1631 | * \brief Status of smart confing completation. |
Kojto | 20:30b6ed7bf8fd | 1632 | * \param none |
Kojto | 20:30b6ed7bf8fd | 1633 | * \return smart config was set, false otherwise. |
Kojto | 20:30b6ed7bf8fd | 1634 | */ |
Kojto | 20:30b6ed7bf8fd | 1635 | bool is_smart_confing_completed(); |
Kojto | 29:c40918cd9b6d | 1636 | /** |
Kojto | 29:c40918cd9b6d | 1637 | * \brief Return the cc3000's mac address. |
Kojto | 20:30b6ed7bf8fd | 1638 | * \param address Retreived mac address. |
Kojto | 20:30b6ed7bf8fd | 1639 | * \return |
Kojto | 20:30b6ed7bf8fd | 1640 | */ |
Kojto | 20:30b6ed7bf8fd | 1641 | uint8_t get_mac_address(uint8_t address[6]); |
Kojto | 29:c40918cd9b6d | 1642 | /** |
Kojto | 29:c40918cd9b6d | 1643 | * \brief Set the cc3000's mac address. |
Kojto | 29:c40918cd9b6d | 1644 | * \param address Mac address to be set. |
Kojto | 20:30b6ed7bf8fd | 1645 | * \return |
Kojto | 20:30b6ed7bf8fd | 1646 | */ |
Kojto | 20:30b6ed7bf8fd | 1647 | uint8_t set_mac_address(uint8_t address[6]); |
Kojto | 29:c40918cd9b6d | 1648 | /** |
Kojto | 29:c40918cd9b6d | 1649 | * \brief Get user file info. |
Kojto | 29:c40918cd9b6d | 1650 | * \param info_file Pointer where info will be stored. |
Kojto | 29:c40918cd9b6d | 1651 | * \param size Available size. |
Kojto | 20:30b6ed7bf8fd | 1652 | * \return none |
Kojto | 20:30b6ed7bf8fd | 1653 | */ |
Kojto | 20:30b6ed7bf8fd | 1654 | void get_user_file_info(uint8_t *info_file, size_t size); |
Kojto | 29:c40918cd9b6d | 1655 | /** |
Kojto | 29:c40918cd9b6d | 1656 | * \brief Set user filo info. |
Kojto | 29:c40918cd9b6d | 1657 | * \param info_file Pointer to user's info. |
Kojto | 20:30b6ed7bf8fd | 1658 | * \return none |
Kojto | 20:30b6ed7bf8fd | 1659 | */ |
Kojto | 20:30b6ed7bf8fd | 1660 | void set_user_file_info(uint8_t *info_file, size_t size); |
Kojto | 29:c40918cd9b6d | 1661 | /** |
Kojto | 29:c40918cd9b6d | 1662 | * \brief Start smart config. |
Kojto | 29:c40918cd9b6d | 1663 | * \param smart_config_key Pointer to smart config key. |
Kojto | 20:30b6ed7bf8fd | 1664 | * \return none |
Kojto | 20:30b6ed7bf8fd | 1665 | */ |
Kojto | 20:30b6ed7bf8fd | 1666 | void start_smart_config(const uint8_t *smart_config_key); /* TODO enable AES ? */ |
Kojto | 20:30b6ed7bf8fd | 1667 | #ifndef CC3000_TINY_DRIVER |
Kojto | 29:c40918cd9b6d | 1668 | /** |
Kojto | 29:c40918cd9b6d | 1669 | * \brief Return ip configuration. |
Kojto | 29:c40918cd9b6d | 1670 | * \param ip_config Pointer to ipconfig data. |
Kojto | 29:c40918cd9b6d | 1671 | * \return true if it's connected and info was retrieved, false otherwise. |
Kojto | 20:30b6ed7bf8fd | 1672 | */ |
Kojto | 20:30b6ed7bf8fd | 1673 | bool get_ip_config(tNetappIpconfigRetArgs *ip_config); |
Kojto | 20:30b6ed7bf8fd | 1674 | #endif |
Kojto | 29:c40918cd9b6d | 1675 | /** |
Kojto | 33:9e23b24fb4f3 | 1676 | * \brief Delete all stored profiles. |
Kojto | 29:c40918cd9b6d | 1677 | * \param none |
Kojto | 20:30b6ed7bf8fd | 1678 | * \return none |
Kojto | 20:30b6ed7bf8fd | 1679 | */ |
Kojto | 20:30b6ed7bf8fd | 1680 | void delete_profiles(void); |
Kojto | 20:30b6ed7bf8fd | 1681 | /** |
Kojto | 33:9e23b24fb4f3 | 1682 | * \brief Ping an ip address. |
Kojto | 29:c40918cd9b6d | 1683 | * \param ip Destination IP address |
Kojto | 29:c40918cd9b6d | 1684 | * \param attempts Number of attempts |
Kojto | 29:c40918cd9b6d | 1685 | * \param timeout Time to wait for a response,in milliseconds. |
Kojto | 29:c40918cd9b6d | 1686 | * \param size Send buffer size which may be up to 1400 bytes |
Kojto | 20:30b6ed7bf8fd | 1687 | */ |
Kojto | 20:30b6ed7bf8fd | 1688 | uint32_t ping(uint32_t ip, uint8_t attempts, uint16_t timeout, uint8_t size); |
Kojto | 29:c40918cd9b6d | 1689 | /** |
Kojto | 33:9e23b24fb4f3 | 1690 | * \brief Returns cc3000 instance. Used in Socket interface. |
Kojto | 29:c40918cd9b6d | 1691 | * \param none |
Kojto | 29:c40918cd9b6d | 1692 | * \return Pointer to cc3000 object |
Kojto | 29:c40918cd9b6d | 1693 | */ |
Kojto | 45:50ab13d8f2dc | 1694 | static cc3000* get_instance() { |
Kojto | 20:30b6ed7bf8fd | 1695 | return _inst; |
Kojto | 20:30b6ed7bf8fd | 1696 | } |
Kojto | 44:960b73df5981 | 1697 | #if (CC3000_ETH_COMPAT == 1) |
SolderSplashLabs | 39:03ac37ab34eb | 1698 | /** |
Kojto | 45:50ab13d8f2dc | 1699 | * \brief Ctor for EthernetInterface |
Kojto | 45:50ab13d8f2dc | 1700 | * \param cc3000_irq IRQ pin |
Kojto | 45:50ab13d8f2dc | 1701 | * \param cc3000_en Enable pin |
Kojto | 45:50ab13d8f2dc | 1702 | * \param cc3000_cs Chip select pin |
Kojto | 45:50ab13d8f2dc | 1703 | * \param cc3000_spi SPI interface |
Kojto | 45:50ab13d8f2dc | 1704 | * \param ssid SSID |
Kojto | 45:50ab13d8f2dc | 1705 | * \param phrase Password |
Kojto | 45:50ab13d8f2dc | 1706 | * \param sec Security of the AP |
Kojto | 45:50ab13d8f2dc | 1707 | * \param smart_config Smart config selection |
Kojto | 45:50ab13d8f2dc | 1708 | */ |
Kojto | 45:50ab13d8f2dc | 1709 | cc3000(PinName cc3000_irq, PinName cc3000_en, PinName cc3000_cs, SPI cc3000_spi, const char *ssid, const char *phrase, Security sec, bool smart_config); |
Kojto | 45:50ab13d8f2dc | 1710 | /** |
Kojto | 45:50ab13d8f2dc | 1711 | * \brief Disconnect wlan device. |
Kojto | 45:50ab13d8f2dc | 1712 | * \param none |
Kojto | 45:50ab13d8f2dc | 1713 | * \return 0 if successful, -1 otherwise. |
Kojto | 45:50ab13d8f2dc | 1714 | */ |
Kojto | 45:50ab13d8f2dc | 1715 | int disconnect(); |
Kojto | 45:50ab13d8f2dc | 1716 | /** |
Kojto | 45:50ab13d8f2dc | 1717 | * \brief Initialize the interface with DHCP. |
Kojto | 45:50ab13d8f2dc | 1718 | * \param none |
Kojto | 45:50ab13d8f2dc | 1719 | * \return none |
Kojto | 45:50ab13d8f2dc | 1720 | */ |
Kojto | 45:50ab13d8f2dc | 1721 | void init(); |
Kojto | 45:50ab13d8f2dc | 1722 | /** |
Kojto | 45:50ab13d8f2dc | 1723 | * \brief Initialize the interface with a static IP address. |
Kojto | 45:50ab13d8f2dc | 1724 | * \param ip the IP address to use. |
Kojto | 45:50ab13d8f2dc | 1725 | * \param mask the IP address mask |
Kojto | 45:50ab13d8f2dc | 1726 | * \param gateway the gateway to use |
Kojto | 45:50ab13d8f2dc | 1727 | * \return none |
Kojto | 45:50ab13d8f2dc | 1728 | */ |
Kojto | 45:50ab13d8f2dc | 1729 | void init(const char *ip, const char *mask, const char *gateway); |
Kojto | 45:50ab13d8f2dc | 1730 | /** |
Kojto | 45:50ab13d8f2dc | 1731 | * \brief Connect Bring the interface up. |
Kojto | 45:50ab13d8f2dc | 1732 | * \param timeout_ms timeout in ms |
Kojto | 45:50ab13d8f2dc | 1733 | * \return 0 if successful, -1 otherwise. |
Kojto | 45:50ab13d8f2dc | 1734 | */ |
Kojto | 45:50ab13d8f2dc | 1735 | int connect(unsigned int timeout_ms = 20000); |
Kojto | 45:50ab13d8f2dc | 1736 | /** |
Kojto | 44:960b73df5981 | 1737 | * \brief Get the MAC address of your Ethernet interface. |
Kojto | 44:960b73df5981 | 1738 | * \param none |
Kojto | 44:960b73df5981 | 1739 | * \return |
Kojto | 44:960b73df5981 | 1740 | * Pointer to a string containing the MAC address. |
SolderSplashLabs | 39:03ac37ab34eb | 1741 | */ |
SolderSplashLabs | 39:03ac37ab34eb | 1742 | char* getMACAddress(); |
SolderSplashLabs | 39:03ac37ab34eb | 1743 | /** |
Kojto | 44:960b73df5981 | 1744 | * \brief Get the IP address of your Ethernet interface. |
Kojto | 44:960b73df5981 | 1745 | * \param none |
Kojto | 44:960b73df5981 | 1746 | * \return |
Kojto | 44:960b73df5981 | 1747 | * Pointer to a string containing the IP address. |
SolderSplashLabs | 39:03ac37ab34eb | 1748 | */ |
SolderSplashLabs | 39:03ac37ab34eb | 1749 | char* getIPAddress(); |
SolderSplashLabs | 39:03ac37ab34eb | 1750 | /** |
Kojto | 44:960b73df5981 | 1751 | * \brief Get the Gateway address of your Ethernet interface |
Kojto | 44:960b73df5981 | 1752 | * \param none |
Kojto | 44:960b73df5981 | 1753 | * \return |
Kojto | 44:960b73df5981 | 1754 | * Pointer to a string containing the Gateway address |
SolderSplashLabs | 39:03ac37ab34eb | 1755 | */ |
SolderSplashLabs | 39:03ac37ab34eb | 1756 | char* getGateway(); |
SolderSplashLabs | 39:03ac37ab34eb | 1757 | /** |
Kojto | 44:960b73df5981 | 1758 | * \brief Get the Network mask of your Ethernet interface |
Kojto | 44:960b73df5981 | 1759 | * \param none |
Kojto | 44:960b73df5981 | 1760 | * \return |
Kojto | 44:960b73df5981 | 1761 | * Pointer to a string containing the Network mask |
SolderSplashLabs | 39:03ac37ab34eb | 1762 | */ |
SolderSplashLabs | 39:03ac37ab34eb | 1763 | char* getNetworkMask(); |
SolderSplashLabs | 39:03ac37ab34eb | 1764 | #endif |
Kojto | 20:30b6ed7bf8fd | 1765 | public: |
Kojto | 20:30b6ed7bf8fd | 1766 | cc3000_simple_link _simple_link; |
Kojto | 20:30b6ed7bf8fd | 1767 | cc3000_event _event; |
Kojto | 20:30b6ed7bf8fd | 1768 | cc3000_socket _socket; |
Kojto | 20:30b6ed7bf8fd | 1769 | cc3000_spi _spi; |
Kojto | 20:30b6ed7bf8fd | 1770 | cc3000_hci _hci; |
Kojto | 20:30b6ed7bf8fd | 1771 | cc3000_nvmem _nvmem; |
Kojto | 20:30b6ed7bf8fd | 1772 | cc3000_netapp _netapp; |
Kojto | 20:30b6ed7bf8fd | 1773 | cc3000_wlan _wlan; |
Kojto | 45:50ab13d8f2dc | 1774 | #ifndef CC3000_UNENCRYPTED_SMART_CONFIG |
Kojto | 45:50ab13d8f2dc | 1775 | cc3000_security _security; |
Kojto | 45:50ab13d8f2dc | 1776 | #endif |
Kojto | 20:30b6ed7bf8fd | 1777 | protected: |
Kojto | 20:30b6ed7bf8fd | 1778 | static cc3000 *_inst; |
Kojto | 20:30b6ed7bf8fd | 1779 | private: |
Kojto | 20:30b6ed7bf8fd | 1780 | tStatus _status; |
Kojto | 20:30b6ed7bf8fd | 1781 | netapp_pingreport_args_t _ping_report; |
Kojto | 20:30b6ed7bf8fd | 1782 | bool _closed_sockets[MAX_SOCKETS]; |
Kojto | 45:50ab13d8f2dc | 1783 | #if (CC3000_ETH_COMPAT == 1) |
Kojto | 45:50ab13d8f2dc | 1784 | uint8_t _phrase[30]; |
Kojto | 45:50ab13d8f2dc | 1785 | uint8_t _ssid[30]; |
Kojto | 45:50ab13d8f2dc | 1786 | Security _sec; |
Kojto | 45:50ab13d8f2dc | 1787 | bool _smart_config; |
Kojto | 45:50ab13d8f2dc | 1788 | #endif |
Kojto | 20:30b6ed7bf8fd | 1789 | }; |
Kojto | 20:30b6ed7bf8fd | 1790 | |
Kojto | 20:30b6ed7bf8fd | 1791 | /** |
Kojto | 29:c40918cd9b6d | 1792 | * Copy 32 bit to stream while converting to little endian format. |
Kojto | 29:c40918cd9b6d | 1793 | * @param p pointer to the new stream |
Kojto | 29:c40918cd9b6d | 1794 | * @param u32 pointer to the 32 bit |
Kojto | 29:c40918cd9b6d | 1795 | * @return pointer to the new stream |
Kojto | 29:c40918cd9b6d | 1796 | */ |
Kojto | 20:30b6ed7bf8fd | 1797 | uint8_t *UINT32_TO_STREAM_f (uint8_t *p, uint32_t u32); |
Kojto | 20:30b6ed7bf8fd | 1798 | |
Kojto | 20:30b6ed7bf8fd | 1799 | /** |
Kojto | 29:c40918cd9b6d | 1800 | * Copy 16 bit to stream while converting to little endian format. |
Kojto | 29:c40918cd9b6d | 1801 | * @param p pointer to the new stream |
Kojto | 29:c40918cd9b6d | 1802 | * @param u32 pointer to the 16 bit |
Kojto | 29:c40918cd9b6d | 1803 | * @return pointer to the new stream |
Kojto | 29:c40918cd9b6d | 1804 | */ |
Kojto | 20:30b6ed7bf8fd | 1805 | uint8_t *UINT16_TO_STREAM_f (uint8_t *p, uint16_t u16); |
Kojto | 20:30b6ed7bf8fd | 1806 | |
Kojto | 20:30b6ed7bf8fd | 1807 | /** |
Kojto | 29:c40918cd9b6d | 1808 | * Copy received stream to 16 bit in little endian format. |
Kojto | 29:c40918cd9b6d | 1809 | * @param p pointer to the stream |
Kojto | 29:c40918cd9b6d | 1810 | * @param offset offset in the stream |
Kojto | 29:c40918cd9b6d | 1811 | * @return pointer to the new 16 bit |
Kojto | 29:c40918cd9b6d | 1812 | */ |
Kojto | 20:30b6ed7bf8fd | 1813 | uint16_t STREAM_TO_UINT16_f(uint8_t* p, uint16_t offset); |
Kojto | 20:30b6ed7bf8fd | 1814 | |
Kojto | 20:30b6ed7bf8fd | 1815 | /** |
Kojto | 29:c40918cd9b6d | 1816 | * Copy received stream to 32 bit in little endian format. |
Kojto | 29:c40918cd9b6d | 1817 | * @param p pointer to the stream |
Kojto | 29:c40918cd9b6d | 1818 | * @param offset offset in the stream |
Kojto | 29:c40918cd9b6d | 1819 | * @return pointer to the new 32 bit |
Kojto | 29:c40918cd9b6d | 1820 | */ |
Kojto | 20:30b6ed7bf8fd | 1821 | uint32_t STREAM_TO_UINT32_f(uint8_t* p, uint16_t offset); |
Kojto | 20:30b6ed7bf8fd | 1822 | |
Kojto | 20:30b6ed7bf8fd | 1823 | } /* end of mbed_cc3000 namespace */ |
Kojto | 20:30b6ed7bf8fd | 1824 | |
Kojto | 20:30b6ed7bf8fd | 1825 | |
Kojto | 20:30b6ed7bf8fd | 1826 | #endif |