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:
Mon Jul 15 14:19:46 2013 +0000
Revision:
4:d8255a5aad46
Parent:
2:f1d50c7f8bdb
Child:
6:d733efcc2c56
Full clean up (comments, Doxygen, code)

Who changed what in which revision?

UserRevisionLine numberNew contents of line
frankvnk 0:c44f0314d6ec 1 /*****************************************************************************
frankvnk 0:c44f0314d6ec 2 *
frankvnk 0:c44f0314d6ec 3 * cc3000_common.c.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 4:d8255a5aad46 35
frankvnk 0:c44f0314d6ec 36 #include "cc3000_common.h"
frankvnk 0:c44f0314d6ec 37 #include "socket.h"
frankvnk 0:c44f0314d6ec 38 #include "wlan.h"
frankvnk 0:c44f0314d6ec 39 #include "evnt_handler.h"
frankvnk 0:c44f0314d6ec 40
frankvnk 4:d8255a5aad46 41 /**
frankvnk 4:d8255a5aad46 42 * stub function for ASSERT macro
frankvnk 4:d8255a5aad46 43 * @param pcFilename - file name, where error occurred
frankvnk 4:d8255a5aad46 44 * @param ulLine - line number, where error occurred
frankvnk 4:d8255a5aad46 45 * @return none
frankvnk 4:d8255a5aad46 46 */
frankvnk 2:f1d50c7f8bdb 47 void __error__(char *pcFilename, unsigned long ulLine)
frankvnk 0:c44f0314d6ec 48 {
frankvnk 1:bbcaf0b2f367 49 //TODO: create function
frankvnk 0:c44f0314d6ec 50 }
frankvnk 0:c44f0314d6ec 51
frankvnk 0:c44f0314d6ec 52
frankvnk 0:c44f0314d6ec 53 unsigned char* UINT32_TO_STREAM_f (unsigned char *p, unsigned long u32)
frankvnk 0:c44f0314d6ec 54 {
frankvnk 0:c44f0314d6ec 55 *(p)++ = (unsigned char)(u32);
frankvnk 0:c44f0314d6ec 56 *(p)++ = (unsigned char)((u32) >> 8);
frankvnk 0:c44f0314d6ec 57 *(p)++ = (unsigned char)((u32) >> 16);
frankvnk 0:c44f0314d6ec 58 *(p)++ = (unsigned char)((u32) >> 24);
frankvnk 0:c44f0314d6ec 59 return p;
frankvnk 0:c44f0314d6ec 60 }
frankvnk 0:c44f0314d6ec 61
frankvnk 0:c44f0314d6ec 62
frankvnk 0:c44f0314d6ec 63 unsigned char* UINT16_TO_STREAM_f (unsigned char *p, unsigned short u16)
frankvnk 0:c44f0314d6ec 64 {
frankvnk 0:c44f0314d6ec 65 *(p)++ = (unsigned char)(u16);
frankvnk 0:c44f0314d6ec 66 *(p)++ = (unsigned char)((u16) >> 8);
frankvnk 0:c44f0314d6ec 67 return p;
frankvnk 0:c44f0314d6ec 68 }
frankvnk 0:c44f0314d6ec 69
frankvnk 0:c44f0314d6ec 70
frankvnk 0:c44f0314d6ec 71 unsigned short STREAM_TO_UINT16_f(char* p, unsigned short offset)
frankvnk 0:c44f0314d6ec 72 {
frankvnk 0:c44f0314d6ec 73 return (unsigned short)((unsigned short)((unsigned short)
frankvnk 1:bbcaf0b2f367 74 (*(p + offset + 1)) << 8) + (unsigned short)(*(p + offset)));
frankvnk 0:c44f0314d6ec 75 }
frankvnk 0:c44f0314d6ec 76
frankvnk 0:c44f0314d6ec 77
frankvnk 0:c44f0314d6ec 78 unsigned long STREAM_TO_UINT32_f(char* p, unsigned short offset)
frankvnk 0:c44f0314d6ec 79 {
frankvnk 0:c44f0314d6ec 80 return (unsigned long)((unsigned long)((unsigned long)
frankvnk 1:bbcaf0b2f367 81 (*(p + offset + 3)) << 24) + (unsigned long)((unsigned long)
frankvnk 1:bbcaf0b2f367 82 (*(p + offset + 2)) << 16) + (unsigned long)((unsigned long)
frankvnk 1:bbcaf0b2f367 83 (*(p + offset + 1)) << 8) + (unsigned long)(*(p + offset)));
frankvnk 0:c44f0314d6ec 84 }
frankvnk 0:c44f0314d6ec 85