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 Nov 29 13:20:07 2013 +0000
Revision:
13:e1ab6b5ab826
Parent:
7:875e62bb780c
update CC3000_MAXIMAL_RX_SIZE

Who changed what in which revision?

UserRevisionLine numberNew contents of line
frankvnk 0:c44f0314d6ec 1 /*****************************************************************************
frankvnk 0:c44f0314d6ec 2 *
frankvnk 6:d733efcc2c56 3 * nvmem - 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
frankvnk 0:c44f0314d6ec 37 #include "nvmem.h"
frankvnk 0:c44f0314d6ec 38
frankvnk 3:3818c9c7b14e 39 signed long nvmem_read(unsigned long ulFileId, unsigned long ulLength, unsigned long ulOffset, unsigned char *buff)
frankvnk 0:c44f0314d6ec 40 {
frankvnk 0:c44f0314d6ec 41 unsigned char ucStatus = 0xFF;
frankvnk 0:c44f0314d6ec 42 unsigned char *ptr;
frankvnk 0:c44f0314d6ec 43 unsigned char *args;
frankvnk 0:c44f0314d6ec 44
frankvnk 0:c44f0314d6ec 45 ptr = tSLInformation.pucTxCommandBuffer;
frankvnk 0:c44f0314d6ec 46 args = (ptr + HEADERS_SIZE_CMD);
frankvnk 0:c44f0314d6ec 47 // Fill in HCI packet structure
frankvnk 0:c44f0314d6ec 48 args = UINT32_TO_STREAM(args, ulFileId);
frankvnk 0:c44f0314d6ec 49 args = UINT32_TO_STREAM(args, ulLength);
frankvnk 0:c44f0314d6ec 50 args = UINT32_TO_STREAM(args, ulOffset);
frankvnk 0:c44f0314d6ec 51
frankvnk 4:d8255a5aad46 52 // Initiate HCI command
frankvnk 0:c44f0314d6ec 53 hci_command_send(HCI_CMND_NVMEM_READ, ptr, NVMEM_READ_PARAMS_LEN);
frankvnk 0:c44f0314d6ec 54 SimpleLinkWaitEvent(HCI_CMND_NVMEM_READ, &ucStatus);
frankvnk 0:c44f0314d6ec 55
frankvnk 4:d8255a5aad46 56 // If data is present, read it even when an error is returned.
frankvnk 4:d8255a5aad46 57 // Note: It is the users responsibility to ignore the data when an error is returned.
frankvnk 4:d8255a5aad46 58 // Wait for the data in a synchronous way.
frankvnk 4:d8255a5aad46 59 // We assume the buffer is large enough to also store nvmem parameters.
frankvnk 0:c44f0314d6ec 60 SimpleLinkWaitData(buff, 0, 0);
frankvnk 4:d8255a5aad46 61
frankvnk 0:c44f0314d6ec 62 return(ucStatus);
frankvnk 0:c44f0314d6ec 63 }
frankvnk 0:c44f0314d6ec 64
frankvnk 0:c44f0314d6ec 65
frankvnk 3:3818c9c7b14e 66 signed long nvmem_write(unsigned long ulFileId, unsigned long ulLength, unsigned long ulEntryOffset, unsigned char *buff)
frankvnk 0:c44f0314d6ec 67 {
frankvnk 0:c44f0314d6ec 68 long iRes;
frankvnk 0:c44f0314d6ec 69 unsigned char *ptr;
frankvnk 0:c44f0314d6ec 70 unsigned char *args;
frankvnk 0:c44f0314d6ec 71
frankvnk 0:c44f0314d6ec 72 iRes = EFAIL;
frankvnk 0:c44f0314d6ec 73
frankvnk 0:c44f0314d6ec 74 ptr = tSLInformation.pucTxCommandBuffer;
frankvnk 0:c44f0314d6ec 75 args = (ptr + SPI_HEADER_SIZE + HCI_DATA_CMD_HEADER_SIZE);
frankvnk 0:c44f0314d6ec 76
frankvnk 0:c44f0314d6ec 77 // Fill in HCI packet structure
frankvnk 0:c44f0314d6ec 78 args = UINT32_TO_STREAM(args, ulFileId);
frankvnk 0:c44f0314d6ec 79 args = UINT32_TO_STREAM(args, 12);
frankvnk 0:c44f0314d6ec 80 args = UINT32_TO_STREAM(args, ulLength);
frankvnk 0:c44f0314d6ec 81 args = UINT32_TO_STREAM(args, ulEntryOffset);
frankvnk 0:c44f0314d6ec 82
frankvnk 0:c44f0314d6ec 83 memcpy((ptr + SPI_HEADER_SIZE + HCI_DATA_CMD_HEADER_SIZE +
frankvnk 0:c44f0314d6ec 84 NVMEM_WRITE_PARAMS_LEN),buff,ulLength);
frankvnk 0:c44f0314d6ec 85
frankvnk 4:d8255a5aad46 86 // Initiate a HCI command on the data channel
frankvnk 4:d8255a5aad46 87 hci_data_command_send(HCI_CMND_NVMEM_WRITE, ptr, NVMEM_WRITE_PARAMS_LEN, ulLength);
frankvnk 0:c44f0314d6ec 88
frankvnk 0:c44f0314d6ec 89 SimpleLinkWaitEvent(HCI_EVNT_NVMEM_WRITE, &iRes);
frankvnk 0:c44f0314d6ec 90
frankvnk 0:c44f0314d6ec 91 return(iRes);
frankvnk 0:c44f0314d6ec 92 }
frankvnk 0:c44f0314d6ec 93
frankvnk 0:c44f0314d6ec 94
frankvnk 0:c44f0314d6ec 95 unsigned char nvmem_set_mac_address(unsigned char *mac)
frankvnk 0:c44f0314d6ec 96 {
frankvnk 0:c44f0314d6ec 97 return nvmem_write(NVMEM_MAC_FILEID, MAC_ADDR_LEN, 0, mac);
frankvnk 0:c44f0314d6ec 98 }
frankvnk 0:c44f0314d6ec 99
frankvnk 0:c44f0314d6ec 100
frankvnk 0:c44f0314d6ec 101 unsigned char nvmem_get_mac_address(unsigned char *mac)
frankvnk 0:c44f0314d6ec 102 {
frankvnk 0:c44f0314d6ec 103 return nvmem_read(NVMEM_MAC_FILEID, MAC_ADDR_LEN, 0, mac);
frankvnk 0:c44f0314d6ec 104 }
frankvnk 0:c44f0314d6ec 105
frankvnk 0:c44f0314d6ec 106
frankvnk 0:c44f0314d6ec 107 unsigned char nvmem_write_patch(unsigned long ulFileId, unsigned long spLength, const unsigned char *spData)
frankvnk 0:c44f0314d6ec 108 {
frankvnk 0:c44f0314d6ec 109 unsigned char status = 0;
frankvnk 0:c44f0314d6ec 110 unsigned short offset = 0;
frankvnk 0:c44f0314d6ec 111 unsigned char* spDataPtr = (unsigned char*)spData;
frankvnk 0:c44f0314d6ec 112
frankvnk 0:c44f0314d6ec 113 while ((status == 0) && (spLength >= SP_PORTION_SIZE))
frankvnk 0:c44f0314d6ec 114 {
frankvnk 0:c44f0314d6ec 115 status = nvmem_write(ulFileId, SP_PORTION_SIZE, offset, spDataPtr);
frankvnk 0:c44f0314d6ec 116 offset += SP_PORTION_SIZE;
frankvnk 0:c44f0314d6ec 117 spLength -= SP_PORTION_SIZE;
frankvnk 0:c44f0314d6ec 118 spDataPtr += SP_PORTION_SIZE;
frankvnk 0:c44f0314d6ec 119 }
frankvnk 0:c44f0314d6ec 120
frankvnk 0:c44f0314d6ec 121 if (status !=0)
frankvnk 0:c44f0314d6ec 122 {
frankvnk 0:c44f0314d6ec 123 // NVMEM error occurred
frankvnk 0:c44f0314d6ec 124 return status;
frankvnk 0:c44f0314d6ec 125 }
frankvnk 0:c44f0314d6ec 126
frankvnk 0:c44f0314d6ec 127 if (spLength != 0)
frankvnk 0:c44f0314d6ec 128 {
frankvnk 4:d8255a5aad46 129 // If spLength MOD 512 is nonzero, write the remaining bytes.
frankvnk 0:c44f0314d6ec 130 status = nvmem_write(ulFileId, spLength, offset, spDataPtr);
frankvnk 0:c44f0314d6ec 131 }
frankvnk 0:c44f0314d6ec 132
frankvnk 0:c44f0314d6ec 133 return status;
frankvnk 0:c44f0314d6ec 134 }
frankvnk 0:c44f0314d6ec 135
frankvnk 4:d8255a5aad46 136
frankvnk 0:c44f0314d6ec 137 #ifndef CC3000_TINY_DRIVER
frankvnk 0:c44f0314d6ec 138 unsigned char nvmem_read_sp_version(unsigned char* patchVer)
frankvnk 0:c44f0314d6ec 139 {
frankvnk 0:c44f0314d6ec 140 unsigned char *ptr;
frankvnk 0:c44f0314d6ec 141 // 1st byte is the status and the rest is the SP version
frankvnk 4:d8255a5aad46 142 unsigned char retBuf[5];
frankvnk 0:c44f0314d6ec 143
frankvnk 0:c44f0314d6ec 144 ptr = tSLInformation.pucTxCommandBuffer;
frankvnk 0:c44f0314d6ec 145
frankvnk 0:c44f0314d6ec 146 // Initiate a HCI command, no args are required
frankvnk 0:c44f0314d6ec 147 hci_command_send(HCI_CMND_READ_SP_VERSION, ptr, 0);
frankvnk 0:c44f0314d6ec 148 SimpleLinkWaitEvent(HCI_CMND_READ_SP_VERSION, retBuf);
frankvnk 0:c44f0314d6ec 149
frankvnk 0:c44f0314d6ec 150 // package ID
frankvnk 0:c44f0314d6ec 151 *patchVer = retBuf[3];
frankvnk 0:c44f0314d6ec 152 // package build number
frankvnk 0:c44f0314d6ec 153 *(patchVer+1) = retBuf[4];
frankvnk 0:c44f0314d6ec 154
frankvnk 0:c44f0314d6ec 155 return(retBuf[0]);
frankvnk 0:c44f0314d6ec 156 }
frankvnk 0:c44f0314d6ec 157 #endif
frankvnk 0:c44f0314d6ec 158
frankvnk 0:c44f0314d6ec 159
frankvnk 0:c44f0314d6ec 160 signed long
frankvnk 0:c44f0314d6ec 161 nvmem_create_entry(unsigned long ulFileId, unsigned long ulNewLen)
frankvnk 0:c44f0314d6ec 162 {
frankvnk 0:c44f0314d6ec 163 unsigned char *ptr;
frankvnk 0:c44f0314d6ec 164 unsigned char *args;
frankvnk 0:c44f0314d6ec 165 unsigned short retval;
frankvnk 0:c44f0314d6ec 166
frankvnk 0:c44f0314d6ec 167 ptr = tSLInformation.pucTxCommandBuffer;
frankvnk 0:c44f0314d6ec 168 args = (ptr + HEADERS_SIZE_CMD);
frankvnk 0:c44f0314d6ec 169
frankvnk 0:c44f0314d6ec 170 // Fill in HCI packet structure
frankvnk 0:c44f0314d6ec 171 args = UINT32_TO_STREAM(args, ulFileId);
frankvnk 0:c44f0314d6ec 172 args = UINT32_TO_STREAM(args, ulNewLen);
frankvnk 0:c44f0314d6ec 173
frankvnk 0:c44f0314d6ec 174 // Initiate a HCI command
frankvnk 0:c44f0314d6ec 175 hci_command_send(HCI_CMND_NVMEM_CREATE_ENTRY,ptr, NVMEM_CREATE_PARAMS_LEN);
frankvnk 0:c44f0314d6ec 176
frankvnk 0:c44f0314d6ec 177 SimpleLinkWaitEvent(HCI_CMND_NVMEM_CREATE_ENTRY, &retval);
frankvnk 0:c44f0314d6ec 178
frankvnk 0:c44f0314d6ec 179 return(retval);
frankvnk 0:c44f0314d6ec 180 }
frankvnk 0:c44f0314d6ec 181
frankvnk 6:d733efcc2c56 182