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:
Sun Jul 28 19:22:18 2013 +0000
Revision:
6:d733efcc2c56
Parent:
4:d8255a5aad46
Cleanup includes - combined spi and hci into 1 file
;

Who changed what in which revision?

UserRevisionLine numberNew contents of line
frankvnk 0:c44f0314d6ec 1 /*****************************************************************************
frankvnk 0:c44f0314d6ec 2 *
frankvnk 6:d733efcc2c56 3 * netapp - 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 long netapp_config_mac_adrress(unsigned char * mac)
frankvnk 0:c44f0314d6ec 39 {
frankvnk 0:c44f0314d6ec 40 return nvmem_set_mac_address(mac);
frankvnk 0:c44f0314d6ec 41 }
frankvnk 0:c44f0314d6ec 42
frankvnk 4:d8255a5aad46 43
frankvnk 0:c44f0314d6ec 44 long netapp_dhcp(unsigned long *aucIP, unsigned long *aucSubnetMask,unsigned long *aucDefaultGateway, unsigned long *aucDNSServer)
frankvnk 0:c44f0314d6ec 45 {
frankvnk 0:c44f0314d6ec 46 signed char scRet;
frankvnk 0:c44f0314d6ec 47 unsigned char *ptr;
frankvnk 0:c44f0314d6ec 48 unsigned char *args;
frankvnk 0:c44f0314d6ec 49
frankvnk 0:c44f0314d6ec 50 scRet = EFAIL;
frankvnk 0:c44f0314d6ec 51 ptr = tSLInformation.pucTxCommandBuffer;
frankvnk 0:c44f0314d6ec 52 args = (ptr + HEADERS_SIZE_CMD);
frankvnk 0:c44f0314d6ec 53
frankvnk 0:c44f0314d6ec 54 // Fill in temporary command buffer
frankvnk 0:c44f0314d6ec 55 ARRAY_TO_STREAM(args,aucIP,4);
frankvnk 0:c44f0314d6ec 56 ARRAY_TO_STREAM(args,aucSubnetMask,4);
frankvnk 0:c44f0314d6ec 57 ARRAY_TO_STREAM(args,aucDefaultGateway,4);
frankvnk 0:c44f0314d6ec 58 args = UINT32_TO_STREAM(args, 0);
frankvnk 0:c44f0314d6ec 59 ARRAY_TO_STREAM(args,aucDNSServer,4);
frankvnk 0:c44f0314d6ec 60
frankvnk 0:c44f0314d6ec 61 // Initiate a HCI command
frankvnk 0:c44f0314d6ec 62 hci_command_send(HCI_NETAPP_DHCP, ptr, NETAPP_DHCP_PARAMS_LEN);
frankvnk 0:c44f0314d6ec 63
frankvnk 0:c44f0314d6ec 64 // Wait for command complete event
frankvnk 0:c44f0314d6ec 65 SimpleLinkWaitEvent(HCI_NETAPP_DHCP, &scRet);
frankvnk 0:c44f0314d6ec 66
frankvnk 0:c44f0314d6ec 67 return(scRet);
frankvnk 0:c44f0314d6ec 68 }
frankvnk 0:c44f0314d6ec 69
frankvnk 0:c44f0314d6ec 70
frankvnk 0:c44f0314d6ec 71 #ifndef CC3000_TINY_DRIVER
frankvnk 4:d8255a5aad46 72 long netapp_timeout_values(unsigned long *aucDHCP, unsigned long *aucARP,unsigned long *aucKeepalive, unsigned long *aucInactivity)
frankvnk 0:c44f0314d6ec 73 {
frankvnk 0:c44f0314d6ec 74 signed char scRet;
frankvnk 0:c44f0314d6ec 75 unsigned char *ptr;
frankvnk 0:c44f0314d6ec 76 unsigned char *args;
frankvnk 0:c44f0314d6ec 77
frankvnk 0:c44f0314d6ec 78 scRet = EFAIL;
frankvnk 0:c44f0314d6ec 79 ptr = tSLInformation.pucTxCommandBuffer;
frankvnk 0:c44f0314d6ec 80 args = (ptr + HEADERS_SIZE_CMD);
frankvnk 0:c44f0314d6ec 81
frankvnk 0:c44f0314d6ec 82 // Set minimal values of timers
frankvnk 0:c44f0314d6ec 83 MIN_TIMER_SET(*aucDHCP)
frankvnk 0:c44f0314d6ec 84 MIN_TIMER_SET(*aucARP)
frankvnk 0:c44f0314d6ec 85 MIN_TIMER_SET(*aucKeepalive)
frankvnk 0:c44f0314d6ec 86 MIN_TIMER_SET(*aucInactivity)
frankvnk 0:c44f0314d6ec 87
frankvnk 0:c44f0314d6ec 88 // Fill in temporary command buffer
frankvnk 0:c44f0314d6ec 89 args = UINT32_TO_STREAM(args, *aucDHCP);
frankvnk 0:c44f0314d6ec 90 args = UINT32_TO_STREAM(args, *aucARP);
frankvnk 0:c44f0314d6ec 91 args = UINT32_TO_STREAM(args, *aucKeepalive);
frankvnk 0:c44f0314d6ec 92 args = UINT32_TO_STREAM(args, *aucInactivity);
frankvnk 0:c44f0314d6ec 93
frankvnk 0:c44f0314d6ec 94 // Initiate a HCI command
frankvnk 0:c44f0314d6ec 95 hci_command_send(HCI_NETAPP_SET_TIMERS, ptr, NETAPP_SET_TIMER_PARAMS_LEN);
frankvnk 0:c44f0314d6ec 96
frankvnk 0:c44f0314d6ec 97 // Wait for command complete event
frankvnk 0:c44f0314d6ec 98 SimpleLinkWaitEvent(HCI_NETAPP_SET_TIMERS, &scRet);
frankvnk 0:c44f0314d6ec 99
frankvnk 0:c44f0314d6ec 100 return(scRet);
frankvnk 0:c44f0314d6ec 101 }
frankvnk 0:c44f0314d6ec 102 #endif
frankvnk 0:c44f0314d6ec 103
frankvnk 0:c44f0314d6ec 104
frankvnk 0:c44f0314d6ec 105 #ifndef CC3000_TINY_DRIVER
frankvnk 4:d8255a5aad46 106 long netapp_ping_send(unsigned long *ip, unsigned long ulPingAttempts, unsigned long ulPingSize, unsigned long ulPingTimeout)
frankvnk 0:c44f0314d6ec 107 {
frankvnk 0:c44f0314d6ec 108 signed char scRet;
frankvnk 0:c44f0314d6ec 109 unsigned char *ptr, *args;
frankvnk 0:c44f0314d6ec 110
frankvnk 0:c44f0314d6ec 111 scRet = EFAIL;
frankvnk 0:c44f0314d6ec 112 ptr = tSLInformation.pucTxCommandBuffer;
frankvnk 0:c44f0314d6ec 113 args = (ptr + HEADERS_SIZE_CMD);
frankvnk 0:c44f0314d6ec 114
frankvnk 0:c44f0314d6ec 115 // Fill in temporary command buffer
frankvnk 0:c44f0314d6ec 116 args = UINT32_TO_STREAM(args, *ip);
frankvnk 0:c44f0314d6ec 117 args = UINT32_TO_STREAM(args, ulPingAttempts);
frankvnk 0:c44f0314d6ec 118 args = UINT32_TO_STREAM(args, ulPingSize);
frankvnk 0:c44f0314d6ec 119 args = UINT32_TO_STREAM(args, ulPingTimeout);
frankvnk 0:c44f0314d6ec 120
frankvnk 0:c44f0314d6ec 121 // Initiate a HCI command
frankvnk 0:c44f0314d6ec 122 hci_command_send(HCI_NETAPP_PING_SEND, ptr, NETAPP_PING_SEND_PARAMS_LEN);
frankvnk 0:c44f0314d6ec 123
frankvnk 0:c44f0314d6ec 124 // Wait for command complete event
frankvnk 0:c44f0314d6ec 125 SimpleLinkWaitEvent(HCI_NETAPP_PING_SEND, &scRet);
frankvnk 0:c44f0314d6ec 126
frankvnk 0:c44f0314d6ec 127 return(scRet);
frankvnk 0:c44f0314d6ec 128 }
frankvnk 0:c44f0314d6ec 129 #endif
frankvnk 0:c44f0314d6ec 130
frankvnk 0:c44f0314d6ec 131
frankvnk 0:c44f0314d6ec 132 #ifndef CC3000_TINY_DRIVER
frankvnk 0:c44f0314d6ec 133 void netapp_ping_report()
frankvnk 0:c44f0314d6ec 134 {
frankvnk 0:c44f0314d6ec 135 unsigned char *ptr;
frankvnk 0:c44f0314d6ec 136 signed char scRet;
frankvnk 0:c44f0314d6ec 137 ptr = tSLInformation.pucTxCommandBuffer;
frankvnk 0:c44f0314d6ec 138
frankvnk 0:c44f0314d6ec 139
frankvnk 0:c44f0314d6ec 140 scRet = EFAIL;
frankvnk 0:c44f0314d6ec 141
frankvnk 0:c44f0314d6ec 142 // Initiate a HCI command
frankvnk 0:c44f0314d6ec 143 hci_command_send(HCI_NETAPP_PING_REPORT, ptr, 0);
frankvnk 0:c44f0314d6ec 144
frankvnk 0:c44f0314d6ec 145 // Wait for command complete event
frankvnk 0:c44f0314d6ec 146 SimpleLinkWaitEvent(HCI_NETAPP_PING_REPORT, &scRet);
frankvnk 0:c44f0314d6ec 147 }
frankvnk 0:c44f0314d6ec 148 #endif
frankvnk 0:c44f0314d6ec 149
frankvnk 0:c44f0314d6ec 150
frankvnk 0:c44f0314d6ec 151 #ifndef CC3000_TINY_DRIVER
frankvnk 0:c44f0314d6ec 152 long netapp_ping_stop()
frankvnk 0:c44f0314d6ec 153 {
frankvnk 0:c44f0314d6ec 154 signed char scRet;
frankvnk 0:c44f0314d6ec 155 unsigned char *ptr;
frankvnk 0:c44f0314d6ec 156
frankvnk 0:c44f0314d6ec 157 scRet = EFAIL;
frankvnk 0:c44f0314d6ec 158 ptr = tSLInformation.pucTxCommandBuffer;
frankvnk 0:c44f0314d6ec 159
frankvnk 0:c44f0314d6ec 160 // Initiate a HCI command
frankvnk 0:c44f0314d6ec 161 hci_command_send(HCI_NETAPP_PING_STOP, ptr, 0);
frankvnk 0:c44f0314d6ec 162
frankvnk 0:c44f0314d6ec 163 // Wait for command complete event
frankvnk 0:c44f0314d6ec 164 SimpleLinkWaitEvent(HCI_NETAPP_PING_STOP, &scRet);
frankvnk 0:c44f0314d6ec 165
frankvnk 0:c44f0314d6ec 166 return(scRet);
frankvnk 0:c44f0314d6ec 167 }
frankvnk 0:c44f0314d6ec 168 #endif
frankvnk 0:c44f0314d6ec 169
frankvnk 0:c44f0314d6ec 170
frankvnk 0:c44f0314d6ec 171 #ifndef CC3000_TINY_DRIVER
frankvnk 0:c44f0314d6ec 172 void netapp_ipconfig( tNetappIpconfigRetArgs * ipconfig )
frankvnk 0:c44f0314d6ec 173 {
frankvnk 0:c44f0314d6ec 174 unsigned char *ptr;
frankvnk 0:c44f0314d6ec 175
frankvnk 0:c44f0314d6ec 176 ptr = tSLInformation.pucTxCommandBuffer;
frankvnk 0:c44f0314d6ec 177
frankvnk 0:c44f0314d6ec 178 // Initiate a HCI command
frankvnk 0:c44f0314d6ec 179 hci_command_send(HCI_NETAPP_IPCONFIG, ptr, 0);
frankvnk 0:c44f0314d6ec 180
frankvnk 0:c44f0314d6ec 181 // Wait for command complete event
frankvnk 0:c44f0314d6ec 182 SimpleLinkWaitEvent(HCI_NETAPP_IPCONFIG, ipconfig );
frankvnk 0:c44f0314d6ec 183
frankvnk 0:c44f0314d6ec 184 }
frankvnk 0:c44f0314d6ec 185 #else
frankvnk 0:c44f0314d6ec 186 void netapp_ipconfig( tNetappIpconfigRetArgs * ipconfig )
frankvnk 0:c44f0314d6ec 187 {
frankvnk 0:c44f0314d6ec 188
frankvnk 0:c44f0314d6ec 189 }
frankvnk 0:c44f0314d6ec 190 #endif
frankvnk 0:c44f0314d6ec 191
frankvnk 0:c44f0314d6ec 192
frankvnk 0:c44f0314d6ec 193 #ifndef CC3000_TINY_DRIVER
frankvnk 0:c44f0314d6ec 194 long netapp_arp_flush(void)
frankvnk 0:c44f0314d6ec 195 {
frankvnk 0:c44f0314d6ec 196 signed char scRet;
frankvnk 0:c44f0314d6ec 197 unsigned char *ptr;
frankvnk 0:c44f0314d6ec 198
frankvnk 0:c44f0314d6ec 199 scRet = EFAIL;
frankvnk 0:c44f0314d6ec 200 ptr = tSLInformation.pucTxCommandBuffer;
frankvnk 0:c44f0314d6ec 201
frankvnk 0:c44f0314d6ec 202 // Initiate a HCI command
frankvnk 0:c44f0314d6ec 203 hci_command_send(HCI_NETAPP_ARP_FLUSH, ptr, 0);
frankvnk 0:c44f0314d6ec 204
frankvnk 0:c44f0314d6ec 205 // Wait for command complete event
frankvnk 0:c44f0314d6ec 206 SimpleLinkWaitEvent(HCI_NETAPP_ARP_FLUSH, &scRet);
frankvnk 0:c44f0314d6ec 207
frankvnk 0:c44f0314d6ec 208 return(scRet);
frankvnk 0:c44f0314d6ec 209 }
frankvnk 0:c44f0314d6ec 210 #endif
frankvnk 0:c44f0314d6ec 211
frankvnk 0:c44f0314d6ec 212
frankvnk 0:c44f0314d6ec 213
frankvnk 0:c44f0314d6ec 214
frankvnk 4:d8255a5aad46 215
frankvnk 6:d733efcc2c56 216