Driver for CC3000 Wi-Fi module

Dependencies:   NVIC_set_all_priorities

Dependents:   CC3000_Simple_Socket Wi-Go_IOT_Demo

Information

The current code has been reworked to a full object oriented application and contains an mbed socket compatible API.

CC3000 Wi-Fi module library

Info

This is the low level driver for TI's SimpleLink CC3000 device.
Port from Avnet's Wi-Go KEIL code (based on TI's CC3000 code).
Special thanks to Jim Carver from Avnet for providing the Wi-Go board and for his assistance.

Differences with TI's original code

The code functionality stays exactly the same.
In order to make it easier to use the code, following changes were made :

  • Addition of a tool to shift all IRQ priorities to a lower level since it is very important to keep the SPI handler at the highest system priority, the WLAN interrupt the second highest and all other system interrupts at a lower priority, so their handlers can be preempted by the CC3000 interrupts.
  • Addition of low level I/O controls and conditional compiler controls in cc3000_common.h.
  • CC3000 initialisation, pin declarations, SPI and WLAN irq priorities are set in Init_HostDriver , we need to call this function at the start of the main function.
  • The SPI and HCI code are joined into one file.
  • The include list has been rearranged - Only #include "wlan.h" is needed in the user API.
  • Part of the CC3000's user eeprom memory is used to store additional info (52 bytes in NVMEM_USER_FILE_1):
# bytesDescriptionInfo
1First time config parameterUseful when connecting
2Firmware updater versionused with the Firmware update tool
2Service Pack versionused with the Firmware update tool
3Driver Versionused with the Firmware update tool
3Firmware Versionused with the Firmware update tool
1CIK validation (Client Interface Key)
40CIK data (Client Interface Key)used with the exosite

Using the Library

A user API is needed to access the CC3000 functions.
Examples:

Using the library with other processors

cc3000_common.cpp loads the irq tool for all targets:
All current mbed targets are supported by this library.

#include "NVIC_set_all_priorities.h"


All low level settings that need to change are available in cc3000_common.h

//*****************************************************************************
//              PIN CONTROLS & COMPILE CONTROLS
//*****************************************************************************
// Compiler control
#define CC3000_UNENCRYPTED_SMART_CONFIG   // No encryption
//#define CC3000_TINY_DRIVER                // Driver for small memory model CPUs

//Interrupt controls
#define NVIC_ALL_IRQ        NVIC_set_all_irq_priorities(3);         // Set ALL interrupt priorities to level 3
#define NVIC_SPI_IRQ        NVIC_SetPriority(SPI0_IRQn, 0x0);       // Wi-Fi SPI interrupt must be higher priority than SysTick
#define NVIC_PORT_IRQ       NVIC_SetPriority(PORTA_IRQn, 0x1);
#define NVIC_SYSTICK_IRQ    NVIC_SetPriority(SysTick_IRQn, 0x2);    // SysTick set to lower priority than Wi-Fi SPI bus interrupt
//#define NVIC_ADC_IRQ        NVIC_SetPriority(ADC0_IRQn, 0x3);       // ADC is the lowest of all

// Wlan controls
#define WLAN_ISF_PCR        PORTA->PCR[16]
#define WLAN_ISF_ISFR       PORTA->ISFR
#define WLAN_ISF_MASK       (1<<16)

#define WLAN_ASSERT_CS      wlan_cs = 0;   //CS : active low
#define WLAN_DEASSERT_CS    wlan_cs = 1;

#define WLAN_ASSERT_EN      wlan_en = 1;   //EN : active high
#define WLAN_DEASSERT_EN    wlan_en = 0;

#define WLAN_READ_IRQ       wlan_int

#define WLAN_ENABLE_IRQ     wlan_int.fall(&WLAN_IRQHandler);
#define WLAN_DISABLE_IRQ    wlan_int.fall(NULL);

#define WLAN_IRQ_PIN_CREATE         InterruptIn wlan_int (PTA16);
#define WLAN_EN_PIN_CREATE          DigitalOut  wlan_en  (PTA13);
#define WLAN_CS_PIN_CREATE          DigitalOut  wlan_cs  (PTD0);
#define WLAN_SPI_PORT_CREATE        SPI wlan(PTD2, PTD3, PTC5); // mosi, miso, sclk

#define WLAN_SPI_PORT_INIT          wlan.format(8,1);
#define WLAN_SPI_SET_FREQ           wlan.frequency(12000000);
#define WLAN_SPI_SET_IRQ_HANDLER    wlan_int.fall(&WLAN_IRQHandler);

#define WLAN_SPI_WRITE              wlan.write(*data++);
#define WLAN_SPI_READ               wlan.write(0x03);          // !! DO NOT MODIFY the 0x03 parameter (CC3000 will not respond).

API documentation

Due to a little problem with the links on the mbed site, the API documentation is not directly accessible (will be solved in a next release).
Currently, it is only accessible by adding modules.html to the API doc link: http://mbed.org/users/frankvnk/code/CC3000_Hostdriver/docs/tip/modules.html

Committer:
frankvnk
Date:
Fri Jun 28 17:48:37 2013 +0000
Revision:
0:c44f0314d6ec
Child:
1:bbcaf0b2f367
Initial release

Who changed what in which revision?

UserRevisionLine numberNew contents of line
frankvnk 0:c44f0314d6ec 1 /*****************************************************************************
frankvnk 0:c44f0314d6ec 2 *
frankvnk 0:c44f0314d6ec 3 * netapp.h - CC3000 Host Driver Implementation.
frankvnk 0:c44f0314d6ec 4 * Copyright (C) 2011 Texas Instruments Incorporated - http://www.ti.com/
frankvnk 0:c44f0314d6ec 5 *
frankvnk 0:c44f0314d6ec 6 * Redistribution and use in source and binary forms, with or without
frankvnk 0:c44f0314d6ec 7 * modification, are permitted provided that the following conditions
frankvnk 0:c44f0314d6ec 8 * are met:
frankvnk 0:c44f0314d6ec 9 *
frankvnk 0:c44f0314d6ec 10 * Redistributions of source code must retain the above copyright
frankvnk 0:c44f0314d6ec 11 * notice, this list of conditions and the following disclaimer.
frankvnk 0:c44f0314d6ec 12 *
frankvnk 0:c44f0314d6ec 13 * Redistributions in binary form must reproduce the above copyright
frankvnk 0:c44f0314d6ec 14 * notice, this list of conditions and the following disclaimer in the
frankvnk 0:c44f0314d6ec 15 * documentation and/or other materials provided with the
frankvnk 0:c44f0314d6ec 16 * distribution.
frankvnk 0:c44f0314d6ec 17 *
frankvnk 0:c44f0314d6ec 18 * Neither the name of Texas Instruments Incorporated nor the names of
frankvnk 0:c44f0314d6ec 19 * its contributors may be used to endorse or promote products derived
frankvnk 0:c44f0314d6ec 20 * from this software without specific prior written permission.
frankvnk 0:c44f0314d6ec 21 *
frankvnk 0:c44f0314d6ec 22 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
frankvnk 0:c44f0314d6ec 23 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
frankvnk 0:c44f0314d6ec 24 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
frankvnk 0:c44f0314d6ec 25 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
frankvnk 0:c44f0314d6ec 26 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
frankvnk 0:c44f0314d6ec 27 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
frankvnk 0:c44f0314d6ec 28 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
frankvnk 0:c44f0314d6ec 29 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
frankvnk 0:c44f0314d6ec 30 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
frankvnk 0:c44f0314d6ec 31 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
frankvnk 0:c44f0314d6ec 32 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
frankvnk 0:c44f0314d6ec 33 *
frankvnk 0:c44f0314d6ec 34 *****************************************************************************/
frankvnk 0:c44f0314d6ec 35 #ifndef __NETAPP_H__
frankvnk 0:c44f0314d6ec 36 #define __NETAPP_H__
frankvnk 0:c44f0314d6ec 37
frankvnk 0:c44f0314d6ec 38 //#include "mbed.h"
frankvnk 0:c44f0314d6ec 39 #include "GlobalAssigns.h"
frankvnk 0:c44f0314d6ec 40 #include "hci.h"
frankvnk 0:c44f0314d6ec 41 #include "socket.h"
frankvnk 0:c44f0314d6ec 42 #include "evnt_handler.h"
frankvnk 0:c44f0314d6ec 43 #include "nvmem.h"
frankvnk 0:c44f0314d6ec 44
frankvnk 0:c44f0314d6ec 45 /** CC3000 Host driver - netapp
frankvnk 0:c44f0314d6ec 46 *
frankvnk 0:c44f0314d6ec 47 */
frankvnk 0:c44f0314d6ec 48 //*****************************************************************************
frankvnk 0:c44f0314d6ec 49 //
frankvnk 0:c44f0314d6ec 50 // If building with a C++ compiler, make all of the definitions in this header
frankvnk 0:c44f0314d6ec 51 // have a C binding.
frankvnk 0:c44f0314d6ec 52 //
frankvnk 0:c44f0314d6ec 53 //*****************************************************************************
frankvnk 0:c44f0314d6ec 54 #ifdef __cplusplus
frankvnk 0:c44f0314d6ec 55 extern "C" {
frankvnk 0:c44f0314d6ec 56 #endif
frankvnk 0:c44f0314d6ec 57
frankvnk 0:c44f0314d6ec 58 //*****************************************************************************
frankvnk 0:c44f0314d6ec 59 //
frankvnk 0:c44f0314d6ec 60 //! \addtogroup netapp_api
frankvnk 0:c44f0314d6ec 61 //! @{
frankvnk 0:c44f0314d6ec 62 //
frankvnk 0:c44f0314d6ec 63 //*****************************************************************************
frankvnk 0:c44f0314d6ec 64
frankvnk 0:c44f0314d6ec 65 typedef struct _netapp_dhcp_ret_args_t
frankvnk 0:c44f0314d6ec 66 {
frankvnk 0:c44f0314d6ec 67 unsigned char aucIP[4];
frankvnk 0:c44f0314d6ec 68 unsigned char aucSubnetMask[4];
frankvnk 0:c44f0314d6ec 69 unsigned char aucDefaultGateway[4];
frankvnk 0:c44f0314d6ec 70 unsigned char aucDHCPServer[4];
frankvnk 0:c44f0314d6ec 71 unsigned char aucDNSServer[4];
frankvnk 0:c44f0314d6ec 72 }tNetappDhcpParams;
frankvnk 0:c44f0314d6ec 73
frankvnk 0:c44f0314d6ec 74 typedef struct _netapp_ipconfig_ret_args_t
frankvnk 0:c44f0314d6ec 75 {
frankvnk 0:c44f0314d6ec 76 unsigned char aucIP[4];
frankvnk 0:c44f0314d6ec 77 unsigned char aucSubnetMask[4];
frankvnk 0:c44f0314d6ec 78 unsigned char aucDefaultGateway[4];
frankvnk 0:c44f0314d6ec 79 unsigned char aucDHCPServer[4];
frankvnk 0:c44f0314d6ec 80 unsigned char aucDNSServer[4];
frankvnk 0:c44f0314d6ec 81 unsigned char uaMacAddr[6];
frankvnk 0:c44f0314d6ec 82 unsigned char uaSSID[32];
frankvnk 0:c44f0314d6ec 83 }tNetappIpconfigRetArgs;
frankvnk 0:c44f0314d6ec 84
frankvnk 0:c44f0314d6ec 85
frankvnk 0:c44f0314d6ec 86 /*Ping send report parameters*/
frankvnk 0:c44f0314d6ec 87 typedef struct _netapp_pingreport_args
frankvnk 0:c44f0314d6ec 88 {
frankvnk 0:c44f0314d6ec 89 unsigned long packets_sent;
frankvnk 0:c44f0314d6ec 90 unsigned long packets_received;
frankvnk 0:c44f0314d6ec 91 unsigned long min_round_time;
frankvnk 0:c44f0314d6ec 92 unsigned long max_round_time;
frankvnk 0:c44f0314d6ec 93 unsigned long avg_round_time;
frankvnk 0:c44f0314d6ec 94 } netapp_pingreport_args_t;
frankvnk 0:c44f0314d6ec 95
frankvnk 0:c44f0314d6ec 96
frankvnk 0:c44f0314d6ec 97 //*****************************************************************************
frankvnk 0:c44f0314d6ec 98 //
frankvnk 0:c44f0314d6ec 99 //! netapp_config_mac_adrress
frankvnk 0:c44f0314d6ec 100 //!
frankvnk 0:c44f0314d6ec 101 //! @param mac device mac address, 6 bytes. Saved: yes
frankvnk 0:c44f0314d6ec 102 //!
frankvnk 0:c44f0314d6ec 103 //! @return return on success 0, otherwise error.
frankvnk 0:c44f0314d6ec 104 //!
frankvnk 0:c44f0314d6ec 105 //! @brief Configure device MAC address and store it in NVMEM.
frankvnk 0:c44f0314d6ec 106 //! The value of the MAC address configured through the API will
frankvnk 0:c44f0314d6ec 107 //! be stored in CC3000 non volatile memory, thus preserved
frankvnk 0:c44f0314d6ec 108 //! over resets.
frankvnk 0:c44f0314d6ec 109 //
frankvnk 0:c44f0314d6ec 110 //*****************************************************************************
frankvnk 0:c44f0314d6ec 111 extern long netapp_config_mac_adrress( unsigned char *mac );
frankvnk 0:c44f0314d6ec 112
frankvnk 0:c44f0314d6ec 113 //*****************************************************************************
frankvnk 0:c44f0314d6ec 114 //
frankvnk 0:c44f0314d6ec 115 //! netapp_dhcp
frankvnk 0:c44f0314d6ec 116 //!
frankvnk 0:c44f0314d6ec 117 //! @param aucIP device mac address, 6 bytes. Saved: yes
frankvnk 0:c44f0314d6ec 118 //! @param aucSubnetMask device mac address, 6 bytes. Saved: yes
frankvnk 0:c44f0314d6ec 119 //! @param aucDefaultGateway device mac address, 6 bytes. Saved: yes
frankvnk 0:c44f0314d6ec 120 //! @param aucDNSServer device mac address, 6 bytes. Saved: yes
frankvnk 0:c44f0314d6ec 121 //!
frankvnk 0:c44f0314d6ec 122 //! @return return on success 0, otherwise error.
frankvnk 0:c44f0314d6ec 123 //!
frankvnk 0:c44f0314d6ec 124 //! @brief netapp_dhcp is used to configure the network interface,
frankvnk 0:c44f0314d6ec 125 //! static or dynamic (DHCP).\n In order to activate DHCP mode,
frankvnk 0:c44f0314d6ec 126 //! aucIP, aucSubnetMask, aucDefaultGateway must be 0.
frankvnk 0:c44f0314d6ec 127 //! The default mode of CC3000 is DHCP mode.
frankvnk 0:c44f0314d6ec 128 //! Note that the configuration is saved in non volatile memory
frankvnk 0:c44f0314d6ec 129 //! and thus preserved over resets.
frankvnk 0:c44f0314d6ec 130 //!
frankvnk 0:c44f0314d6ec 131 //! @note If the mode is altered a reset of CC3000 device is required
frankvnk 0:c44f0314d6ec 132 //! in order to apply changes.\nAlso note that asynchronous event
frankvnk 0:c44f0314d6ec 133 //! of DHCP_EVENT, which is generated when an IP address is
frankvnk 0:c44f0314d6ec 134 //! allocated either by the DHCP server or due to static
frankvnk 0:c44f0314d6ec 135 //! allocation is generated only upon a connection to the
frankvnk 0:c44f0314d6ec 136 //! AP was established.
frankvnk 0:c44f0314d6ec 137 //!
frankvnk 0:c44f0314d6ec 138 //*****************************************************************************
frankvnk 0:c44f0314d6ec 139 extern long netapp_dhcp(unsigned long *aucIP, unsigned long *aucSubnetMask,unsigned long *aucDefaultGateway, unsigned long *aucDNSServer);
frankvnk 0:c44f0314d6ec 140
frankvnk 0:c44f0314d6ec 141
frankvnk 0:c44f0314d6ec 142
frankvnk 0:c44f0314d6ec 143 //*****************************************************************************
frankvnk 0:c44f0314d6ec 144 //
frankvnk 0:c44f0314d6ec 145 //! netapp_timeout_values
frankvnk 0:c44f0314d6ec 146 //!
frankvnk 0:c44f0314d6ec 147 //! @param aucDHCP DHCP lease time request, also impact
frankvnk 0:c44f0314d6ec 148 //! the DHCP renew timeout. Range: [0-0xffffffff] seconds,
frankvnk 0:c44f0314d6ec 149 //! 0 or 0xffffffff == infinity lease timeout.
frankvnk 0:c44f0314d6ec 150 //! Resolution:10 seconds. Influence: only after
frankvnk 0:c44f0314d6ec 151 //! reconnecting to the AP.
frankvnk 0:c44f0314d6ec 152 //! Minimal bound value: MIN_TIMER_VAL_SECONDS - 20 seconds.
frankvnk 0:c44f0314d6ec 153 //! The parameter is saved into the CC3000 NVMEM.
frankvnk 0:c44f0314d6ec 154 //! The default value on CC3000 is 14400 seconds.
frankvnk 0:c44f0314d6ec 155 //!
frankvnk 0:c44f0314d6ec 156 //! @param aucARP ARP refresh timeout, if ARP entry is not updated by
frankvnk 0:c44f0314d6ec 157 //! incoming packet, the ARP entry will be deleted by
frankvnk 0:c44f0314d6ec 158 //! the end of the timeout.
frankvnk 0:c44f0314d6ec 159 //! Range: [0-0xffffffff] seconds, 0 == infinity ARP timeout
frankvnk 0:c44f0314d6ec 160 //! Resolution: 10 seconds. Influence: on runtime.
frankvnk 0:c44f0314d6ec 161 //! Minimal bound value: MIN_TIMER_VAL_SECONDS - 20 seconds
frankvnk 0:c44f0314d6ec 162 //! The parameter is saved into the CC3000 NVMEM.
frankvnk 0:c44f0314d6ec 163 //! The default value on CC3000 is 3600 seconds.
frankvnk 0:c44f0314d6ec 164 //!
frankvnk 0:c44f0314d6ec 165 //! @param aucKeepalive Keepalive event sent by the end of keepalive timeout
frankvnk 0:c44f0314d6ec 166 //! Range: [0-0xffffffff] seconds, 0 == infinity timeout
frankvnk 0:c44f0314d6ec 167 //! Resolution: 10 seconds.
frankvnk 0:c44f0314d6ec 168 //! Influence: on runtime.
frankvnk 0:c44f0314d6ec 169 //! Minimal bound value: MIN_TIMER_VAL_SECONDS - 20 sec
frankvnk 0:c44f0314d6ec 170 //! The parameter is saved into the CC3000 NVMEM.
frankvnk 0:c44f0314d6ec 171 //! The default value on CC3000 is 10 seconds.
frankvnk 0:c44f0314d6ec 172 //!
frankvnk 0:c44f0314d6ec 173 //! @param aucInactivity Socket inactivity timeout, socket timeout is
frankvnk 0:c44f0314d6ec 174 //! refreshed by incoming or outgoing packet, by the
frankvnk 0:c44f0314d6ec 175 //! end of the socket timeout the socket will be closed
frankvnk 0:c44f0314d6ec 176 //! Range: [0-0xffffffff] sec, 0 == infinity timeout.
frankvnk 0:c44f0314d6ec 177 //! Resolution: 10 seconds. Influence: on runtime.
frankvnk 0:c44f0314d6ec 178 //! Minimal bound value: MIN_TIMER_VAL_SECONDS - 20 sec
frankvnk 0:c44f0314d6ec 179 //! The parameter is saved into the CC3000 NVMEM.
frankvnk 0:c44f0314d6ec 180 //! The default value on CC3000 is 60 seconds.
frankvnk 0:c44f0314d6ec 181 //!
frankvnk 0:c44f0314d6ec 182 //! @return return on success 0, otherwise error.
frankvnk 0:c44f0314d6ec 183 //!
frankvnk 0:c44f0314d6ec 184 //! @brief Set new timeout values. Function set new timeout values for:
frankvnk 0:c44f0314d6ec 185 //! DHCP lease timeout, ARP refresh timeout, keepalive event
frankvnk 0:c44f0314d6ec 186 //! timeout and socket inactivity timeout
frankvnk 0:c44f0314d6ec 187 //!
frankvnk 0:c44f0314d6ec 188 //! @note If a parameter set to non zero value which is less than 20s,
frankvnk 0:c44f0314d6ec 189 //! it will be set automatically to 20s.
frankvnk 0:c44f0314d6ec 190 //!
frankvnk 0:c44f0314d6ec 191 //*****************************************************************************
frankvnk 0:c44f0314d6ec 192 #ifndef CC3000_TINY_DRIVER
frankvnk 0:c44f0314d6ec 193 extern long netapp_timeout_values(unsigned long *aucDHCP, unsigned long *aucARP,unsigned long *aucKeepalive, unsigned long *aucInactivity);
frankvnk 0:c44f0314d6ec 194 #endif
frankvnk 0:c44f0314d6ec 195 //*****************************************************************************
frankvnk 0:c44f0314d6ec 196 //
frankvnk 0:c44f0314d6ec 197 //! netapp_ping_send
frankvnk 0:c44f0314d6ec 198 //!
frankvnk 0:c44f0314d6ec 199 //! @param ip destination IP address
frankvnk 0:c44f0314d6ec 200 //! @param pingAttempts number of echo requests to send
frankvnk 0:c44f0314d6ec 201 //! @param pingSize send buffer size which may be up to 1400 bytes
frankvnk 0:c44f0314d6ec 202 //! @param pingTimeout Time to wait for a response,in milliseconds.
frankvnk 0:c44f0314d6ec 203 //!
frankvnk 0:c44f0314d6ec 204 //! @return return on success 0, otherwise error.
frankvnk 0:c44f0314d6ec 205 //!
frankvnk 0:c44f0314d6ec 206 //! @brief send ICMP ECHO_REQUEST to network hosts
frankvnk 0:c44f0314d6ec 207 //!
frankvnk 0:c44f0314d6ec 208 //! @note If an operation finished successfully asynchronous ping report
frankvnk 0:c44f0314d6ec 209 //! event will be generated. The report structure is as defined
frankvnk 0:c44f0314d6ec 210 //! by structure netapp_pingreport_args_t.
frankvnk 0:c44f0314d6ec 211 //!
frankvnk 0:c44f0314d6ec 212 //! @warning Calling this function while a previous Ping Requests are in
frankvnk 0:c44f0314d6ec 213 //! progress will stop the previous ping request.
frankvnk 0:c44f0314d6ec 214 //*****************************************************************************
frankvnk 0:c44f0314d6ec 215
frankvnk 0:c44f0314d6ec 216 #ifndef CC3000_TINY_DRIVER
frankvnk 0:c44f0314d6ec 217 extern long netapp_ping_send(unsigned long *ip, unsigned long ulPingAttempts, unsigned long ulPingSize, unsigned long ulPingTimeout);
frankvnk 0:c44f0314d6ec 218 #endif
frankvnk 0:c44f0314d6ec 219
frankvnk 0:c44f0314d6ec 220 //*****************************************************************************
frankvnk 0:c44f0314d6ec 221 //
frankvnk 0:c44f0314d6ec 222 //! netapp_ping_stop
frankvnk 0:c44f0314d6ec 223 //!
frankvnk 0:c44f0314d6ec 224 //! @param none
frankvnk 0:c44f0314d6ec 225 //!
frankvnk 0:c44f0314d6ec 226 //! @return On success, zero is returned. On error, -1 is returned.
frankvnk 0:c44f0314d6ec 227 //!
frankvnk 0:c44f0314d6ec 228 //! @brief Stop any ping request.
frankvnk 0:c44f0314d6ec 229 //!
frankvnk 0:c44f0314d6ec 230 //!
frankvnk 0:c44f0314d6ec 231 //*****************************************************************************
frankvnk 0:c44f0314d6ec 232
frankvnk 0:c44f0314d6ec 233 #ifndef CC3000_TINY_DRIVER
frankvnk 0:c44f0314d6ec 234 extern long netapp_ping_stop(void);
frankvnk 0:c44f0314d6ec 235 #endif
frankvnk 0:c44f0314d6ec 236 //*****************************************************************************
frankvnk 0:c44f0314d6ec 237 //
frankvnk 0:c44f0314d6ec 238 //! netapp_ping_report
frankvnk 0:c44f0314d6ec 239 //!
frankvnk 0:c44f0314d6ec 240 //! @param none
frankvnk 0:c44f0314d6ec 241 //!
frankvnk 0:c44f0314d6ec 242 //! @return none
frankvnk 0:c44f0314d6ec 243 //!
frankvnk 0:c44f0314d6ec 244 //! @brief Request for ping status. This API triggers the CC3000 to send
frankvnk 0:c44f0314d6ec 245 //! asynchronous events: HCI_EVNT_WLAN_ASYNC_PING_REPORT.
frankvnk 0:c44f0314d6ec 246 //! This event will carry the report structure:
frankvnk 0:c44f0314d6ec 247 //! netapp_pingreport_args_t. This structure is filled in with ping
frankvnk 0:c44f0314d6ec 248 //! results up till point of triggering API.
frankvnk 0:c44f0314d6ec 249 //! netapp_pingreport_args_t:\n packets_sent - echo sent,
frankvnk 0:c44f0314d6ec 250 //! packets_received - echo reply, min_round_time - minimum
frankvnk 0:c44f0314d6ec 251 //! round time, max_round_time - max round time,
frankvnk 0:c44f0314d6ec 252 //! avg_round_time - average round time
frankvnk 0:c44f0314d6ec 253 //!
frankvnk 0:c44f0314d6ec 254 //! @note When a ping operation is not active, the returned structure
frankvnk 0:c44f0314d6ec 255 //! fields are 0.
frankvnk 0:c44f0314d6ec 256 //!
frankvnk 0:c44f0314d6ec 257 //*****************************************************************************
frankvnk 0:c44f0314d6ec 258 #ifndef CC3000_TINY_DRIVER
frankvnk 0:c44f0314d6ec 259 extern void netapp_ping_report(void);
frankvnk 0:c44f0314d6ec 260 #endif
frankvnk 0:c44f0314d6ec 261
frankvnk 0:c44f0314d6ec 262
frankvnk 0:c44f0314d6ec 263 //*****************************************************************************
frankvnk 0:c44f0314d6ec 264 //
frankvnk 0:c44f0314d6ec 265 //! netapp_ipconfig
frankvnk 0:c44f0314d6ec 266 //!
frankvnk 0:c44f0314d6ec 267 //! @param[out] ipconfig This argument is a pointer to a
frankvnk 0:c44f0314d6ec 268 //! tNetappIpconfigRetArgs structure. This structure is
frankvnk 0:c44f0314d6ec 269 //! filled in with the network interface configuration.
frankvnk 0:c44f0314d6ec 270 //! tNetappIpconfigRetArgs:\n aucIP - ip address,
frankvnk 0:c44f0314d6ec 271 //! aucSubnetMask - mask, aucDefaultGateway - default
frankvnk 0:c44f0314d6ec 272 //! gateway address, aucDHCPServer - dhcp server address
frankvnk 0:c44f0314d6ec 273 //! aucDNSServer - dns server address, uaMacAddr - mac
frankvnk 0:c44f0314d6ec 274 //! address, uaSSID - connected AP ssid
frankvnk 0:c44f0314d6ec 275 //!
frankvnk 0:c44f0314d6ec 276 //! @return none
frankvnk 0:c44f0314d6ec 277 //!
frankvnk 0:c44f0314d6ec 278 //! @brief Obtain the CC3000 Network interface information.
frankvnk 0:c44f0314d6ec 279 //! Note that the information is available only after the WLAN
frankvnk 0:c44f0314d6ec 280 //! connection was established. Calling this function before
frankvnk 0:c44f0314d6ec 281 //! associated, will cause non-defined values to be returned.
frankvnk 0:c44f0314d6ec 282 //!
frankvnk 0:c44f0314d6ec 283 //! @note The function is useful for figuring out the IP Configuration of
frankvnk 0:c44f0314d6ec 284 //! the device when DHCP is used and for figuring out the SSID of
frankvnk 0:c44f0314d6ec 285 //! the Wireless network the device is associated with.
frankvnk 0:c44f0314d6ec 286 //!
frankvnk 0:c44f0314d6ec 287 //*****************************************************************************
frankvnk 0:c44f0314d6ec 288
frankvnk 0:c44f0314d6ec 289 extern void netapp_ipconfig( tNetappIpconfigRetArgs * ipconfig );
frankvnk 0:c44f0314d6ec 290
frankvnk 0:c44f0314d6ec 291
frankvnk 0:c44f0314d6ec 292 //*****************************************************************************
frankvnk 0:c44f0314d6ec 293 //
frankvnk 0:c44f0314d6ec 294 //! netapp_arp_flush
frankvnk 0:c44f0314d6ec 295 //!
frankvnk 0:c44f0314d6ec 296 //! @param none
frankvnk 0:c44f0314d6ec 297 //!
frankvnk 0:c44f0314d6ec 298 //! @return none
frankvnk 0:c44f0314d6ec 299 //!
frankvnk 0:c44f0314d6ec 300 //! @brief Flushes ARP table
frankvnk 0:c44f0314d6ec 301 //!
frankvnk 0:c44f0314d6ec 302 //*****************************************************************************
frankvnk 0:c44f0314d6ec 303
frankvnk 0:c44f0314d6ec 304 #ifndef CC3000_TINY_DRIVER
frankvnk 0:c44f0314d6ec 305 extern long netapp_arp_flush(void);
frankvnk 0:c44f0314d6ec 306 #endif
frankvnk 0:c44f0314d6ec 307
frankvnk 0:c44f0314d6ec 308
frankvnk 0:c44f0314d6ec 309
frankvnk 0:c44f0314d6ec 310 //*****************************************************************************
frankvnk 0:c44f0314d6ec 311 //
frankvnk 0:c44f0314d6ec 312 // Close the Doxygen group.
frankvnk 0:c44f0314d6ec 313 //! @}
frankvnk 0:c44f0314d6ec 314 //
frankvnk 0:c44f0314d6ec 315 //*****************************************************************************
frankvnk 0:c44f0314d6ec 316
frankvnk 0:c44f0314d6ec 317
frankvnk 0:c44f0314d6ec 318
frankvnk 0:c44f0314d6ec 319 //*****************************************************************************
frankvnk 0:c44f0314d6ec 320 //
frankvnk 0:c44f0314d6ec 321 // Mark the end of the C bindings section for C++ compilers.
frankvnk 0:c44f0314d6ec 322 //
frankvnk 0:c44f0314d6ec 323 //*****************************************************************************
frankvnk 0:c44f0314d6ec 324 #ifdef __cplusplus
frankvnk 0:c44f0314d6ec 325 }
frankvnk 0:c44f0314d6ec 326 #endif // __cplusplus
frankvnk 0:c44f0314d6ec 327
frankvnk 0:c44f0314d6ec 328 #endif // __NETAPP_H__
frankvnk 0:c44f0314d6ec 329
frankvnk 0:c44f0314d6ec 330
frankvnk 0:c44f0314d6ec 331