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:
3:3818c9c7b14e
Child:
6:d733efcc2c56
Full clean up (comments, Doxygen, code)

Who changed what in which revision?

UserRevisionLine numberNew contents of line
frankvnk 0:c44f0314d6ec 1 #ifndef GLOBALPINS_H
frankvnk 0:c44f0314d6ec 2 #define GLOBALPINS_H
frankvnk 0:c44f0314d6ec 3
frankvnk 0:c44f0314d6ec 4 #include "mbed.h"
frankvnk 0:c44f0314d6ec 5
frankvnk 0:c44f0314d6ec 6 // Compiler control
frankvnk 1:bbcaf0b2f367 7 #define CC3000_UNENCRYPTED_SMART_CONFIG // No encryption
frankvnk 1:bbcaf0b2f367 8 //#define CC3000_TINY_DRIVER // Driver for small memory model CPUs
frankvnk 0:c44f0314d6ec 9 #define PATCHPROGRAMMER_ENABLE // !!!Only enable this when you want to upload new firmware
frankvnk 0:c44f0314d6ec 10
frankvnk 4:d8255a5aad46 11 // Wlan controls
frankvnk 4:d8255a5aad46 12 #define WLAN_ISF_PCR PORTA->PCR[16]
frankvnk 4:d8255a5aad46 13 #define WLAN_ISF_ISFR PORTA->ISFR
frankvnk 4:d8255a5aad46 14 #define WLAN_ISF_MASK (1<<16)
frankvnk 4:d8255a5aad46 15
frankvnk 4:d8255a5aad46 16 #define WLAN_ASSERT_CS wlan_cs = 0; //CS : active low
frankvnk 4:d8255a5aad46 17 #define WLAN_DEASSERT_CS wlan_cs = 1;
frankvnk 4:d8255a5aad46 18
frankvnk 4:d8255a5aad46 19 #define WLAN_ASSERT_EN wlan_en = 1; //EN : active high
frankvnk 4:d8255a5aad46 20 #define WLAN_DEASSERT_EN wlan_en = 0;
frankvnk 4:d8255a5aad46 21
frankvnk 4:d8255a5aad46 22 #define WLAN_READ_IRQ wlan_int
frankvnk 0:c44f0314d6ec 23
frankvnk 4:d8255a5aad46 24 #define WLAN_ENABLE_IRQ NVIC_EnableIRQ(PORTA_IRQn);
frankvnk 4:d8255a5aad46 25 #define WLAN_DISABLE_IRQ NVIC_DisableIRQ(PORTA_IRQn);
frankvnk 0:c44f0314d6ec 26
frankvnk 4:d8255a5aad46 27 #define WLAN_IRQ_PIN_CREATE InterruptIn wlan_int (PTA16);
frankvnk 4:d8255a5aad46 28 #define WLAN_EN_PIN_CREATE DigitalOut wlan_en (PTA13);
frankvnk 4:d8255a5aad46 29 #define WLAN_CS_PIN_CREATE DigitalOut wlan_cs (PTD0);
frankvnk 4:d8255a5aad46 30 #define WLAN_SPI_PORT_CREATE SPI wlan(PTD2, PTD3, PTC5); // mosi, miso, sclk
frankvnk 4:d8255a5aad46 31
frankvnk 4:d8255a5aad46 32 #define WLAN_SPI_PORT_INIT wlan.format(8,1);
frankvnk 4:d8255a5aad46 33 #define WLAN_SPI_SET_FREQ wlan.frequency(12000000);
frankvnk 4:d8255a5aad46 34 #define WLAN_SPI_SET_IRQ_HANDLER wlan_int.fall(&WLAN_IRQHandler);
frankvnk 4:d8255a5aad46 35
frankvnk 4:d8255a5aad46 36 #define WLAN_SPI_WRITE wlan.write(*data++);
frankvnk 4:d8255a5aad46 37 #define WLAN_SPI_READ wlan.write(READ);
frankvnk 0:c44f0314d6ec 38
frankvnk 0:c44f0314d6ec 39 extern DigitalOut wlan_en;
frankvnk 0:c44f0314d6ec 40 extern DigitalOut wlan_cs;
frankvnk 0:c44f0314d6ec 41 extern InterruptIn wlan_int;
frankvnk 0:c44f0314d6ec 42 extern SPI wlan;
frankvnk 0:c44f0314d6ec 43
frankvnk 0:c44f0314d6ec 44 #endif