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):
# bytes | Description | Info |
1 | First time config parameter | Useful when connecting |
2 | Firmware updater version | used with the Firmware update tool |
2 | Service Pack version | used with the Firmware update tool |
3 | Driver Version | used with the Firmware update tool |
3 | Firmware Version | used with the Firmware update tool |
1 | CIK validation (Client Interface Key) | |
40 | CIK data (Client Interface Key) | used with the exosite |
Using the Library
A user API is needed to access the CC3000 functions.
Examples:
- Internet Of Things full WiGo demo (SmartConfig - WebServer - Exosite - Android sensor Fusion App)
- CC3000_Simple_Socket
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
History
update CC3000_MAXIMAL_RX_SIZE
2013-11-29, by frankvnk [Fri, 29 Nov 2013 13:20:07 +0000] rev 13
update CC3000_MAXIMAL_RX_SIZE
WlanInterruptEnable - added read_irq
2013-10-17, by frankvnk [Thu, 17 Oct 2013 17:18:17 +0000] rev 12
WlanInterruptEnable - added read_irq
; replace enable/disable port_irq with pin_irq
;
Replaced KL25Z irq tool with irq tool for all targets
2013-09-20, by frankvnk [Fri, 20 Sep 2013 07:26:44 +0000] rev 11
Replaced KL25Z irq tool with irq tool for all targets
Fixed closesocket error
2013-09-16, by frankvnk [Mon, 16 Sep 2013 12:36:14 +0000] rev 10
Fixed closesocket error
moved GlobalAssigns.h content to cc3000_common.h
2013-08-15, by frankvnk [Thu, 15 Aug 2013 10:09:57 +0000] rev 9
moved GlobalAssigns.h content to cc3000_common.h
; further code cleanup
issue with enable/disable IRQ through wlan_int.fall - replaced with NVIC_... code.
2013-08-09, by frankvnk [Fri, 09 Aug 2013 12:23:24 +0000] rev 8
issue with enable/disable IRQ through wlan_int.fall - replaced with NVIC_... code.
; Additional code improvements
final clean up - removed cc3000.cpp/.h
2013-08-02, by frankvnk [Fri, 02 Aug 2013 15:19:38 +0000] rev 7
final clean up - removed cc3000.cpp/.h
Cleanup includes - combined spi and hci into 1 file
2013-07-28, by frankvnk [Sun, 28 Jul 2013 19:22:18 +0000] rev 6
Cleanup includes - combined spi and hci into 1 file
;
Doxygen fixed
2013-07-15, by frankvnk [Mon, 15 Jul 2013 19:54:53 +0000] rev 5
Doxygen fixed
Full clean up (comments, Doxygen, code)
2013-07-15, by frankvnk [Mon, 15 Jul 2013 14:19:46 +0000] rev 4
Full clean up (comments, Doxygen, code)