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:
4:d8255a5aad46
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.c - 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
frankvnk 0:c44f0314d6ec 36 #include "netapp.h"
frankvnk 0:c44f0314d6ec 37
frankvnk 0:c44f0314d6ec 38 #define MIN_TIMER_VAL_SECONDS 20
frankvnk 0:c44f0314d6ec 39 #define MIN_TIMER_SET(t) if ((0 != t) && (t < MIN_TIMER_VAL_SECONDS)) \
frankvnk 0:c44f0314d6ec 40 { \
frankvnk 0:c44f0314d6ec 41 t = MIN_TIMER_VAL_SECONDS; \
frankvnk 0:c44f0314d6ec 42 }
frankvnk 0:c44f0314d6ec 43
frankvnk 0:c44f0314d6ec 44
frankvnk 0:c44f0314d6ec 45 #define NETAPP_DHCP_PARAMS_LEN (20)
frankvnk 0:c44f0314d6ec 46 #define NETAPP_SET_TIMER_PARAMS_LEN (20)
frankvnk 0:c44f0314d6ec 47 #define NETAPP_SET_DEBUG_LEVEL_PARAMS_LEN (4)
frankvnk 0:c44f0314d6ec 48 #define NETAPP_PING_SEND_PARAMS_LEN (16)
frankvnk 0:c44f0314d6ec 49
frankvnk 0:c44f0314d6ec 50
frankvnk 0:c44f0314d6ec 51 //*****************************************************************************
frankvnk 0:c44f0314d6ec 52 //
frankvnk 0:c44f0314d6ec 53 //! netapp_config_mac_adrress
frankvnk 0:c44f0314d6ec 54 //!
frankvnk 0:c44f0314d6ec 55 //! @param mac device mac address, 6 bytes. Saved: yes
frankvnk 0:c44f0314d6ec 56 //!
frankvnk 0:c44f0314d6ec 57 //! @return return on success 0, otherwise error.
frankvnk 0:c44f0314d6ec 58 //!
frankvnk 0:c44f0314d6ec 59 //! @brief Configure device MAC address and store it in NVMEM.
frankvnk 0:c44f0314d6ec 60 //! The value of the MAC address configured through the API will
frankvnk 0:c44f0314d6ec 61 //! be stored in CC3000 non volatile memory, thus preserved
frankvnk 0:c44f0314d6ec 62 //! over resets.
frankvnk 0:c44f0314d6ec 63 //
frankvnk 0:c44f0314d6ec 64 //*****************************************************************************
frankvnk 0:c44f0314d6ec 65 long netapp_config_mac_adrress(unsigned char * mac)
frankvnk 0:c44f0314d6ec 66 {
frankvnk 0:c44f0314d6ec 67 return nvmem_set_mac_address(mac);
frankvnk 0:c44f0314d6ec 68 }
frankvnk 0:c44f0314d6ec 69
frankvnk 0:c44f0314d6ec 70 //*****************************************************************************
frankvnk 0:c44f0314d6ec 71 //
frankvnk 0:c44f0314d6ec 72 //! netapp_dhcp
frankvnk 0:c44f0314d6ec 73 //!
frankvnk 0:c44f0314d6ec 74 //! @param aucIP device mac address, 6 bytes. Saved: yes
frankvnk 0:c44f0314d6ec 75 //! @param aucSubnetMask device mac address, 6 bytes. Saved: yes
frankvnk 0:c44f0314d6ec 76 //! @param aucDefaultGateway device mac address, 6 bytes. Saved: yes
frankvnk 0:c44f0314d6ec 77 //! @param aucDNSServer device mac address, 6 bytes. Saved: yes
frankvnk 0:c44f0314d6ec 78 //!
frankvnk 0:c44f0314d6ec 79 //! @return return on success 0, otherwise error.
frankvnk 0:c44f0314d6ec 80 //!
frankvnk 0:c44f0314d6ec 81 //! @brief netapp_dhcp is used to configure the network interface,
frankvnk 0:c44f0314d6ec 82 //! static or dynamic (DHCP).\n In order to activate DHCP mode,
frankvnk 0:c44f0314d6ec 83 //! aucIP, aucSubnetMask, aucDefaultGateway must be 0.
frankvnk 0:c44f0314d6ec 84 //! The default mode of CC3000 is DHCP mode.
frankvnk 0:c44f0314d6ec 85 //! Note that the configuration is saved in non volatile memory
frankvnk 0:c44f0314d6ec 86 //! and thus preserved over resets.
frankvnk 0:c44f0314d6ec 87 //!
frankvnk 0:c44f0314d6ec 88 //! @note If the mode is altered a reset of CC3000 device is required
frankvnk 0:c44f0314d6ec 89 //! in order to apply changes.\nAlso note that asynchronous event
frankvnk 0:c44f0314d6ec 90 //! of DHCP_EVENT, which is generated when an IP address is
frankvnk 0:c44f0314d6ec 91 //! allocated either by the DHCP server or due to static
frankvnk 0:c44f0314d6ec 92 //! allocation is generated only upon a connection to the
frankvnk 0:c44f0314d6ec 93 //! AP was established.
frankvnk 0:c44f0314d6ec 94 //!
frankvnk 0:c44f0314d6ec 95 //*****************************************************************************
frankvnk 0:c44f0314d6ec 96 long netapp_dhcp(unsigned long *aucIP, unsigned long *aucSubnetMask,unsigned long *aucDefaultGateway, unsigned long *aucDNSServer)
frankvnk 0:c44f0314d6ec 97 {
frankvnk 0:c44f0314d6ec 98 signed char scRet;
frankvnk 0:c44f0314d6ec 99 unsigned char *ptr;
frankvnk 0:c44f0314d6ec 100 unsigned char *args;
frankvnk 0:c44f0314d6ec 101
frankvnk 0:c44f0314d6ec 102 scRet = EFAIL;
frankvnk 0:c44f0314d6ec 103 ptr = tSLInformation.pucTxCommandBuffer;
frankvnk 0:c44f0314d6ec 104 args = (ptr + HEADERS_SIZE_CMD);
frankvnk 0:c44f0314d6ec 105
frankvnk 0:c44f0314d6ec 106 // Fill in temporary command buffer
frankvnk 0:c44f0314d6ec 107 ARRAY_TO_STREAM(args,aucIP,4);
frankvnk 0:c44f0314d6ec 108 ARRAY_TO_STREAM(args,aucSubnetMask,4);
frankvnk 0:c44f0314d6ec 109 ARRAY_TO_STREAM(args,aucDefaultGateway,4);
frankvnk 0:c44f0314d6ec 110 args = UINT32_TO_STREAM(args, 0);
frankvnk 0:c44f0314d6ec 111 ARRAY_TO_STREAM(args,aucDNSServer,4);
frankvnk 0:c44f0314d6ec 112
frankvnk 0:c44f0314d6ec 113 // Initiate a HCI command
frankvnk 0:c44f0314d6ec 114 hci_command_send(HCI_NETAPP_DHCP, ptr, NETAPP_DHCP_PARAMS_LEN);
frankvnk 0:c44f0314d6ec 115
frankvnk 0:c44f0314d6ec 116 // Wait for command complete event
frankvnk 0:c44f0314d6ec 117 SimpleLinkWaitEvent(HCI_NETAPP_DHCP, &scRet);
frankvnk 0:c44f0314d6ec 118
frankvnk 0:c44f0314d6ec 119 return(scRet);
frankvnk 0:c44f0314d6ec 120 }
frankvnk 0:c44f0314d6ec 121
frankvnk 0:c44f0314d6ec 122
frankvnk 0:c44f0314d6ec 123 //*****************************************************************************
frankvnk 0:c44f0314d6ec 124 //
frankvnk 0:c44f0314d6ec 125 //! netapp_timeout_values
frankvnk 0:c44f0314d6ec 126 //!
frankvnk 0:c44f0314d6ec 127 //! @param aucDHCP DHCP lease time request, also impact
frankvnk 0:c44f0314d6ec 128 //! the DHCP renew timeout. Range: [0-0xffffffff] seconds,
frankvnk 0:c44f0314d6ec 129 //! 0 or 0xffffffff == infinity lease timeout.
frankvnk 0:c44f0314d6ec 130 //! Resolution:10 seconds. Influence: only after
frankvnk 0:c44f0314d6ec 131 //! reconnecting to the AP.
frankvnk 0:c44f0314d6ec 132 //! Minimal bound value: MIN_TIMER_VAL_SECONDS - 20 seconds.
frankvnk 0:c44f0314d6ec 133 //! The parameter is saved into the CC3000 NVMEM.
frankvnk 0:c44f0314d6ec 134 //! The default value on CC3000 is 14400 seconds.
frankvnk 0:c44f0314d6ec 135 //!
frankvnk 0:c44f0314d6ec 136 //! @param aucARP ARP refresh timeout, if ARP entry is not updated by
frankvnk 0:c44f0314d6ec 137 //! incoming packet, the ARP entry will be deleted by
frankvnk 0:c44f0314d6ec 138 //! the end of the timeout.
frankvnk 0:c44f0314d6ec 139 //! Range: [0-0xffffffff] seconds, 0 == infinity ARP timeout
frankvnk 0:c44f0314d6ec 140 //! Resolution: 10 seconds. Influence: on runtime.
frankvnk 0:c44f0314d6ec 141 //! Minimal bound value: MIN_TIMER_VAL_SECONDS - 20 seconds
frankvnk 0:c44f0314d6ec 142 //! The parameter is saved into the CC3000 NVMEM.
frankvnk 0:c44f0314d6ec 143 //! The default value on CC3000 is 3600 seconds.
frankvnk 0:c44f0314d6ec 144 //!
frankvnk 0:c44f0314d6ec 145 //! @param aucKeepalive Keepalive event sent by the end of keepalive timeout
frankvnk 0:c44f0314d6ec 146 //! Range: [0-0xffffffff] seconds, 0 == infinity timeout
frankvnk 0:c44f0314d6ec 147 //! Resolution: 10 seconds.
frankvnk 0:c44f0314d6ec 148 //! Influence: on runtime.
frankvnk 0:c44f0314d6ec 149 //! Minimal bound value: MIN_TIMER_VAL_SECONDS - 20 sec
frankvnk 0:c44f0314d6ec 150 //! The parameter is saved into the CC3000 NVMEM.
frankvnk 0:c44f0314d6ec 151 //! The default value on CC3000 is 10 seconds.
frankvnk 0:c44f0314d6ec 152 //!
frankvnk 0:c44f0314d6ec 153 //! @param aucInactivity Socket inactivity timeout, socket timeout is
frankvnk 0:c44f0314d6ec 154 //! refreshed by incoming or outgoing packet, by the
frankvnk 0:c44f0314d6ec 155 //! end of the socket timeout the socket will be closed
frankvnk 0:c44f0314d6ec 156 //! Range: [0-0xffffffff] sec, 0 == infinity timeout.
frankvnk 0:c44f0314d6ec 157 //! Resolution: 10 seconds. Influence: on runtime.
frankvnk 0:c44f0314d6ec 158 //! Minimal bound value: MIN_TIMER_VAL_SECONDS - 20 sec
frankvnk 0:c44f0314d6ec 159 //! The parameter is saved into the CC3000 NVMEM.
frankvnk 0:c44f0314d6ec 160 //! The default value on CC3000 is 60 seconds.
frankvnk 0:c44f0314d6ec 161 //!
frankvnk 0:c44f0314d6ec 162 //! @return return on success 0, otherwise error.
frankvnk 0:c44f0314d6ec 163 //!
frankvnk 0:c44f0314d6ec 164 //! @brief Set new timeout values. Function set new timeout values for:
frankvnk 0:c44f0314d6ec 165 //! DHCP lease timeout, ARP refresh timeout, keepalive event
frankvnk 0:c44f0314d6ec 166 //! timeout and socket inactivity timeout
frankvnk 0:c44f0314d6ec 167 //!
frankvnk 0:c44f0314d6ec 168 //! @note If a parameter set to non zero value which is less than 20s,
frankvnk 0:c44f0314d6ec 169 //! it will be set automatically to 20s.
frankvnk 0:c44f0314d6ec 170 //!
frankvnk 0:c44f0314d6ec 171 //*****************************************************************************
frankvnk 0:c44f0314d6ec 172 #ifndef CC3000_TINY_DRIVER
frankvnk 0:c44f0314d6ec 173 long
frankvnk 0:c44f0314d6ec 174 netapp_timeout_values(unsigned long *aucDHCP, unsigned long *aucARP,unsigned long *aucKeepalive, unsigned long *aucInactivity)
frankvnk 0:c44f0314d6ec 175 {
frankvnk 0:c44f0314d6ec 176 signed char scRet;
frankvnk 0:c44f0314d6ec 177 unsigned char *ptr;
frankvnk 0:c44f0314d6ec 178 unsigned char *args;
frankvnk 0:c44f0314d6ec 179
frankvnk 0:c44f0314d6ec 180 scRet = EFAIL;
frankvnk 0:c44f0314d6ec 181 ptr = tSLInformation.pucTxCommandBuffer;
frankvnk 0:c44f0314d6ec 182 args = (ptr + HEADERS_SIZE_CMD);
frankvnk 0:c44f0314d6ec 183
frankvnk 0:c44f0314d6ec 184 // Set minimal values of timers
frankvnk 0:c44f0314d6ec 185 MIN_TIMER_SET(*aucDHCP)
frankvnk 0:c44f0314d6ec 186 MIN_TIMER_SET(*aucARP)
frankvnk 0:c44f0314d6ec 187 MIN_TIMER_SET(*aucKeepalive)
frankvnk 0:c44f0314d6ec 188 MIN_TIMER_SET(*aucInactivity)
frankvnk 0:c44f0314d6ec 189
frankvnk 0:c44f0314d6ec 190 // Fill in temporary command buffer
frankvnk 0:c44f0314d6ec 191 args = UINT32_TO_STREAM(args, *aucDHCP);
frankvnk 0:c44f0314d6ec 192 args = UINT32_TO_STREAM(args, *aucARP);
frankvnk 0:c44f0314d6ec 193 args = UINT32_TO_STREAM(args, *aucKeepalive);
frankvnk 0:c44f0314d6ec 194 args = UINT32_TO_STREAM(args, *aucInactivity);
frankvnk 0:c44f0314d6ec 195
frankvnk 0:c44f0314d6ec 196 // Initiate a HCI command
frankvnk 0:c44f0314d6ec 197 hci_command_send(HCI_NETAPP_SET_TIMERS, ptr, NETAPP_SET_TIMER_PARAMS_LEN);
frankvnk 0:c44f0314d6ec 198
frankvnk 0:c44f0314d6ec 199 // Wait for command complete event
frankvnk 0:c44f0314d6ec 200 SimpleLinkWaitEvent(HCI_NETAPP_SET_TIMERS, &scRet);
frankvnk 0:c44f0314d6ec 201
frankvnk 0:c44f0314d6ec 202 return(scRet);
frankvnk 0:c44f0314d6ec 203 }
frankvnk 0:c44f0314d6ec 204 #endif
frankvnk 0:c44f0314d6ec 205
frankvnk 0:c44f0314d6ec 206
frankvnk 0:c44f0314d6ec 207 //*****************************************************************************
frankvnk 0:c44f0314d6ec 208 //
frankvnk 0:c44f0314d6ec 209 //! netapp_ping_send
frankvnk 0:c44f0314d6ec 210 //!
frankvnk 0:c44f0314d6ec 211 //! @param ip destination IP address
frankvnk 0:c44f0314d6ec 212 //! @param pingAttempts number of echo requests to send
frankvnk 0:c44f0314d6ec 213 //! @param pingSize send buffer size which may be up to 1400 bytes
frankvnk 0:c44f0314d6ec 214 //! @param pingTimeout Time to wait for a response,in milliseconds.
frankvnk 0:c44f0314d6ec 215 //!
frankvnk 0:c44f0314d6ec 216 //! @return return on success 0, otherwise error.
frankvnk 0:c44f0314d6ec 217 //!
frankvnk 0:c44f0314d6ec 218 //! @brief send ICMP ECHO_REQUEST to network hosts
frankvnk 0:c44f0314d6ec 219 //!
frankvnk 0:c44f0314d6ec 220 //! @note If an operation finished successfully asynchronous ping report
frankvnk 0:c44f0314d6ec 221 //! event will be generated. The report structure is as defined
frankvnk 0:c44f0314d6ec 222 //! by structure netapp_pingreport_args_t.
frankvnk 0:c44f0314d6ec 223 //!
frankvnk 0:c44f0314d6ec 224 //! @warning Calling this function while a previous Ping Requests are in
frankvnk 0:c44f0314d6ec 225 //! progress will stop the previous ping request.
frankvnk 0:c44f0314d6ec 226 //*****************************************************************************
frankvnk 0:c44f0314d6ec 227
frankvnk 0:c44f0314d6ec 228 #ifndef CC3000_TINY_DRIVER
frankvnk 0:c44f0314d6ec 229 long
frankvnk 0:c44f0314d6ec 230 netapp_ping_send(unsigned long *ip, unsigned long ulPingAttempts, unsigned long ulPingSize, unsigned long ulPingTimeout)
frankvnk 0:c44f0314d6ec 231 {
frankvnk 0:c44f0314d6ec 232 signed char scRet;
frankvnk 0:c44f0314d6ec 233 unsigned char *ptr, *args;
frankvnk 0:c44f0314d6ec 234
frankvnk 0:c44f0314d6ec 235 scRet = EFAIL;
frankvnk 0:c44f0314d6ec 236 ptr = tSLInformation.pucTxCommandBuffer;
frankvnk 0:c44f0314d6ec 237 args = (ptr + HEADERS_SIZE_CMD);
frankvnk 0:c44f0314d6ec 238
frankvnk 0:c44f0314d6ec 239 // Fill in temporary command buffer
frankvnk 0:c44f0314d6ec 240 args = UINT32_TO_STREAM(args, *ip);
frankvnk 0:c44f0314d6ec 241 args = UINT32_TO_STREAM(args, ulPingAttempts);
frankvnk 0:c44f0314d6ec 242 args = UINT32_TO_STREAM(args, ulPingSize);
frankvnk 0:c44f0314d6ec 243 args = UINT32_TO_STREAM(args, ulPingTimeout);
frankvnk 0:c44f0314d6ec 244
frankvnk 0:c44f0314d6ec 245 // Initiate a HCI command
frankvnk 0:c44f0314d6ec 246 hci_command_send(HCI_NETAPP_PING_SEND, ptr, NETAPP_PING_SEND_PARAMS_LEN);
frankvnk 0:c44f0314d6ec 247
frankvnk 0:c44f0314d6ec 248 // Wait for command complete event
frankvnk 0:c44f0314d6ec 249 SimpleLinkWaitEvent(HCI_NETAPP_PING_SEND, &scRet);
frankvnk 0:c44f0314d6ec 250
frankvnk 0:c44f0314d6ec 251 return(scRet);
frankvnk 0:c44f0314d6ec 252 }
frankvnk 0:c44f0314d6ec 253 #endif
frankvnk 0:c44f0314d6ec 254
frankvnk 0:c44f0314d6ec 255 //*****************************************************************************
frankvnk 0:c44f0314d6ec 256 //
frankvnk 0:c44f0314d6ec 257 //! netapp_ping_report
frankvnk 0:c44f0314d6ec 258 //!
frankvnk 0:c44f0314d6ec 259 //! @param none
frankvnk 0:c44f0314d6ec 260 //!
frankvnk 0:c44f0314d6ec 261 //! @return none
frankvnk 0:c44f0314d6ec 262 //!
frankvnk 0:c44f0314d6ec 263 //! @brief Request for ping status. This API triggers the CC3000 to send
frankvnk 0:c44f0314d6ec 264 //! asynchronous events: HCI_EVNT_WLAN_ASYNC_PING_REPORT.
frankvnk 0:c44f0314d6ec 265 //! This event will carry the report structure:
frankvnk 0:c44f0314d6ec 266 //! netapp_pingreport_args_t. This structure is filled in with ping
frankvnk 0:c44f0314d6ec 267 //! results up till point of triggering API.
frankvnk 0:c44f0314d6ec 268 //! netapp_pingreport_args_t:\n packets_sent - echo sent,
frankvnk 0:c44f0314d6ec 269 //! packets_received - echo reply, min_round_time - minimum
frankvnk 0:c44f0314d6ec 270 //! round time, max_round_time - max round time,
frankvnk 0:c44f0314d6ec 271 //! avg_round_time - average round time
frankvnk 0:c44f0314d6ec 272 //!
frankvnk 0:c44f0314d6ec 273 //! @note When a ping operation is not active, the returned structure
frankvnk 0:c44f0314d6ec 274 //! fields are 0.
frankvnk 0:c44f0314d6ec 275 //!
frankvnk 0:c44f0314d6ec 276 //*****************************************************************************
frankvnk 0:c44f0314d6ec 277
frankvnk 0:c44f0314d6ec 278
frankvnk 0:c44f0314d6ec 279 #ifndef CC3000_TINY_DRIVER
frankvnk 0:c44f0314d6ec 280 void netapp_ping_report()
frankvnk 0:c44f0314d6ec 281 {
frankvnk 0:c44f0314d6ec 282 unsigned char *ptr;
frankvnk 0:c44f0314d6ec 283 signed char scRet;
frankvnk 0:c44f0314d6ec 284 ptr = tSLInformation.pucTxCommandBuffer;
frankvnk 0:c44f0314d6ec 285
frankvnk 0:c44f0314d6ec 286
frankvnk 0:c44f0314d6ec 287 scRet = EFAIL;
frankvnk 0:c44f0314d6ec 288
frankvnk 0:c44f0314d6ec 289 // Initiate a HCI command
frankvnk 0:c44f0314d6ec 290 hci_command_send(HCI_NETAPP_PING_REPORT, ptr, 0);
frankvnk 0:c44f0314d6ec 291
frankvnk 0:c44f0314d6ec 292 // Wait for command complete event
frankvnk 0:c44f0314d6ec 293 SimpleLinkWaitEvent(HCI_NETAPP_PING_REPORT, &scRet);
frankvnk 0:c44f0314d6ec 294 }
frankvnk 0:c44f0314d6ec 295 #endif
frankvnk 0:c44f0314d6ec 296
frankvnk 0:c44f0314d6ec 297 //*****************************************************************************
frankvnk 0:c44f0314d6ec 298 //
frankvnk 0:c44f0314d6ec 299 //! netapp_ping_stop
frankvnk 0:c44f0314d6ec 300 //!
frankvnk 0:c44f0314d6ec 301 //! @param none
frankvnk 0:c44f0314d6ec 302 //!
frankvnk 0:c44f0314d6ec 303 //! @return On success, zero is returned. On error, -1 is returned.
frankvnk 0:c44f0314d6ec 304 //!
frankvnk 0:c44f0314d6ec 305 //! @brief Stop any ping request.
frankvnk 0:c44f0314d6ec 306 //!
frankvnk 0:c44f0314d6ec 307 //!
frankvnk 0:c44f0314d6ec 308 //*****************************************************************************
frankvnk 0:c44f0314d6ec 309
frankvnk 0:c44f0314d6ec 310 #ifndef CC3000_TINY_DRIVER
frankvnk 0:c44f0314d6ec 311 long netapp_ping_stop()
frankvnk 0:c44f0314d6ec 312 {
frankvnk 0:c44f0314d6ec 313 signed char scRet;
frankvnk 0:c44f0314d6ec 314 unsigned char *ptr;
frankvnk 0:c44f0314d6ec 315
frankvnk 0:c44f0314d6ec 316 scRet = EFAIL;
frankvnk 0:c44f0314d6ec 317 ptr = tSLInformation.pucTxCommandBuffer;
frankvnk 0:c44f0314d6ec 318
frankvnk 0:c44f0314d6ec 319 // Initiate a HCI command
frankvnk 0:c44f0314d6ec 320 hci_command_send(HCI_NETAPP_PING_STOP, ptr, 0);
frankvnk 0:c44f0314d6ec 321
frankvnk 0:c44f0314d6ec 322 // Wait for command complete event
frankvnk 0:c44f0314d6ec 323 SimpleLinkWaitEvent(HCI_NETAPP_PING_STOP, &scRet);
frankvnk 0:c44f0314d6ec 324
frankvnk 0:c44f0314d6ec 325 return(scRet);
frankvnk 0:c44f0314d6ec 326 }
frankvnk 0:c44f0314d6ec 327 #endif
frankvnk 0:c44f0314d6ec 328
frankvnk 0:c44f0314d6ec 329 //*****************************************************************************
frankvnk 0:c44f0314d6ec 330 //
frankvnk 0:c44f0314d6ec 331 //! netapp_ipconfig
frankvnk 0:c44f0314d6ec 332 //!
frankvnk 0:c44f0314d6ec 333 //! @param[out] ipconfig This argument is a pointer to a
frankvnk 0:c44f0314d6ec 334 //! tNetappIpconfigRetArgs structure. This structure is
frankvnk 0:c44f0314d6ec 335 //! filled in with the network interface configuration.
frankvnk 0:c44f0314d6ec 336 //! tNetappIpconfigRetArgs:\n aucIP - ip address,
frankvnk 0:c44f0314d6ec 337 //! aucSubnetMask - mask, aucDefaultGateway - default
frankvnk 0:c44f0314d6ec 338 //! gateway address, aucDHCPServer - dhcp server address
frankvnk 0:c44f0314d6ec 339 //! aucDNSServer - dns server address, uaMacAddr - mac
frankvnk 0:c44f0314d6ec 340 //! address, uaSSID - connected AP ssid
frankvnk 0:c44f0314d6ec 341 //!
frankvnk 0:c44f0314d6ec 342 //! @return none
frankvnk 0:c44f0314d6ec 343 //!
frankvnk 0:c44f0314d6ec 344 //! @brief Obtain the CC3000 Network interface information.
frankvnk 0:c44f0314d6ec 345 //! Note that the information is available only after the WLAN
frankvnk 0:c44f0314d6ec 346 //! connection was established. Calling this function before
frankvnk 0:c44f0314d6ec 347 //! associated, will cause non-defined values to be returned.
frankvnk 0:c44f0314d6ec 348 //!
frankvnk 0:c44f0314d6ec 349 //! @note The function is useful for figuring out the IP Configuration of
frankvnk 0:c44f0314d6ec 350 //! the device when DHCP is used and for figuring out the SSID of
frankvnk 0:c44f0314d6ec 351 //! the Wireless network the device is associated with.
frankvnk 0:c44f0314d6ec 352 //!
frankvnk 0:c44f0314d6ec 353 //*****************************************************************************
frankvnk 0:c44f0314d6ec 354
frankvnk 0:c44f0314d6ec 355 #ifndef CC3000_TINY_DRIVER
frankvnk 0:c44f0314d6ec 356 void netapp_ipconfig( tNetappIpconfigRetArgs * ipconfig )
frankvnk 0:c44f0314d6ec 357 {
frankvnk 0:c44f0314d6ec 358 unsigned char *ptr;
frankvnk 0:c44f0314d6ec 359
frankvnk 0:c44f0314d6ec 360 ptr = tSLInformation.pucTxCommandBuffer;
frankvnk 0:c44f0314d6ec 361
frankvnk 0:c44f0314d6ec 362 // Initiate a HCI command
frankvnk 0:c44f0314d6ec 363 hci_command_send(HCI_NETAPP_IPCONFIG, ptr, 0);
frankvnk 0:c44f0314d6ec 364
frankvnk 0:c44f0314d6ec 365 // Wait for command complete event
frankvnk 0:c44f0314d6ec 366 SimpleLinkWaitEvent(HCI_NETAPP_IPCONFIG, ipconfig );
frankvnk 0:c44f0314d6ec 367
frankvnk 0:c44f0314d6ec 368 }
frankvnk 0:c44f0314d6ec 369 #else
frankvnk 0:c44f0314d6ec 370 void netapp_ipconfig( tNetappIpconfigRetArgs * ipconfig )
frankvnk 0:c44f0314d6ec 371 {
frankvnk 0:c44f0314d6ec 372
frankvnk 0:c44f0314d6ec 373 }
frankvnk 0:c44f0314d6ec 374 #endif
frankvnk 0:c44f0314d6ec 375
frankvnk 0:c44f0314d6ec 376 //*****************************************************************************
frankvnk 0:c44f0314d6ec 377 //
frankvnk 0:c44f0314d6ec 378 //! netapp_arp_flush
frankvnk 0:c44f0314d6ec 379 //!
frankvnk 0:c44f0314d6ec 380 //! @param none
frankvnk 0:c44f0314d6ec 381 //!
frankvnk 0:c44f0314d6ec 382 //! @return none
frankvnk 0:c44f0314d6ec 383 //!
frankvnk 0:c44f0314d6ec 384 //! @brief Flushes ARP table
frankvnk 0:c44f0314d6ec 385 //!
frankvnk 0:c44f0314d6ec 386 //*****************************************************************************
frankvnk 0:c44f0314d6ec 387
frankvnk 0:c44f0314d6ec 388 #ifndef CC3000_TINY_DRIVER
frankvnk 0:c44f0314d6ec 389 long netapp_arp_flush(void)
frankvnk 0:c44f0314d6ec 390 {
frankvnk 0:c44f0314d6ec 391 signed char scRet;
frankvnk 0:c44f0314d6ec 392 unsigned char *ptr;
frankvnk 0:c44f0314d6ec 393
frankvnk 0:c44f0314d6ec 394 scRet = EFAIL;
frankvnk 0:c44f0314d6ec 395 ptr = tSLInformation.pucTxCommandBuffer;
frankvnk 0:c44f0314d6ec 396
frankvnk 0:c44f0314d6ec 397 // Initiate a HCI command
frankvnk 0:c44f0314d6ec 398 hci_command_send(HCI_NETAPP_ARP_FLUSH, ptr, 0);
frankvnk 0:c44f0314d6ec 399
frankvnk 0:c44f0314d6ec 400 // Wait for command complete event
frankvnk 0:c44f0314d6ec 401 SimpleLinkWaitEvent(HCI_NETAPP_ARP_FLUSH, &scRet);
frankvnk 0:c44f0314d6ec 402
frankvnk 0:c44f0314d6ec 403 return(scRet);
frankvnk 0:c44f0314d6ec 404 }
frankvnk 0:c44f0314d6ec 405 #endif
frankvnk 0:c44f0314d6ec 406
frankvnk 0:c44f0314d6ec 407
frankvnk 0:c44f0314d6ec 408
frankvnk 0:c44f0314d6ec 409