Frank Vannieuwkerke / CC3000_Hostdriver

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

Diff: nvmem.h

Revision:
1:bbcaf0b2f367
Parent:
0:c44f0314d6ec
Child:
4:d8255a5aad46
--- a/nvmem.h	Fri Jun 28 17:48:37 2013 +0000
+++ b/nvmem.h	Thu Jul 04 08:10:21 2013 +0000
@@ -71,23 +71,23 @@
 ****************************************************************************/
 /* NVMEM file ID - system files*/
 #define NVMEM_NVS_FILEID                             (0)
-#define NVMEM_NVS_SHADOW_FILEID                     (1)
+#define NVMEM_NVS_SHADOW_FILEID                      (1)
 #define NVMEM_WLAN_CONFIG_FILEID                     (2)
-#define NVMEM_WLAN_CONFIG_SHADOW_FILEID             (3)
-#define NVMEM_WLAN_DRIVER_SP_FILEID                    (4)
-#define NVMEM_WLAN_FW_SP_FILEID                        (5)
+#define NVMEM_WLAN_CONFIG_SHADOW_FILEID              (3)
+#define NVMEM_WLAN_DRIVER_SP_FILEID                  (4)
+#define NVMEM_WLAN_FW_SP_FILEID                      (5)
 #define NVMEM_MAC_FILEID                             (6)
-#define NVMEM_FRONTEND_VARS_FILEID                     (7)
-#define NVMEM_IP_CONFIG_FILEID                         (8)
-#define NVMEM_IP_CONFIG_SHADOW_FILEID                 (9)
-#define NVMEM_BOOTLOADER_SP_FILEID                     (10)
-#define NVMEM_RM_FILEID                                 (11)
+#define NVMEM_FRONTEND_VARS_FILEID                   (7)
+#define NVMEM_IP_CONFIG_FILEID                       (8)
+#define NVMEM_IP_CONFIG_SHADOW_FILEID                (9)
+#define NVMEM_BOOTLOADER_SP_FILEID                   (10)
+#define NVMEM_RM_FILEID                              (11)
 
 /* NVMEM file ID - user files*/
-#define NVMEM_AES128_KEY_FILEID                         (12)
-#define NVMEM_SHARED_MEM_FILEID                         (13)
-#define NVMEM_USER_FILE_1_FILEID                    (14)
-#define NVMEM_USER_FILE_2_FILEID                    (15)
+#define NVMEM_AES128_KEY_FILEID                      (12)
+#define NVMEM_SHARED_MEM_FILEID                      (13)
+#define NVMEM_USER_FILE_1_FILEID                     (14)
+#define NVMEM_USER_FILE_2_FILEID                     (15)
 
 /*  max entry in order to invalid nvmem              */
 #define NVMEM_MAX_ENTRY                              (16)
@@ -105,9 +105,9 @@
 //!                     NVMEM_IP_CONFIG_FILEID, NVMEM_IP_CONFIG_SHADOW_FILEID,
 //!                     NVMEM_BOOTLOADER_SP_FILEID, NVMEM_RM_FILEID,
 //!                     and user files 12-15.
-//!  @param  ulLength    number of bytes to read 
-//!  @param  ulOffset    ulOffset in file from where to read  
-//!  @param  buff        output buffer pointer
+//!  @param  ulLength   number of bytes to read 
+//!  @param  ulOffset   ulOffset in file from where to read  
+//!  @param  buff       output buffer pointer
 //!
 //!  @return       number of bytes read, otherwise error.
 //!
@@ -131,7 +131,7 @@
 //!  @param  ulEntryOffset  offset in file to start write operation from 
 //!  @param  buff           data to write
 //!
-//!  @return       on success 0, error otherwise.
+//!  @return      on success 0, error otherwise.
 //!
 //!  @brief       Write data to nvmem.
 //!               writes data to file referred by the ulFileId parameter. 
@@ -148,15 +148,15 @@
 //
 //!  nvmem_set_mac_address
 //!
-//!  @param  mac   mac address to be set
+//!  @param  mac  mac address to be set
 //!
-//!  @return       on success 0, error otherwise.
+//!  @return      on success 0, error otherwise.
 //!
 //!  @brief       Write MAC address to EEPROM. 
 //!               mac address as appears over the air (OUI first)
 //!     
 //*****************************************************************************
-extern    unsigned char nvmem_set_mac_address(unsigned char *mac);
+extern unsigned char nvmem_set_mac_address(unsigned char *mac);
 
 
 //*****************************************************************************
@@ -165,13 +165,13 @@
 //!
 //!  @param[out]  mac   mac address  
 //!
-//!  @return       on success 0, error otherwise.
+//!  @return      on success 0, error otherwise.
 //!
 //!  @brief       Read MAC address from EEPROM. 
 //!               mac address as appears over the air (OUI first)
 //!     
 //*****************************************************************************
-extern    unsigned char nvmem_get_mac_address(unsigned char *mac);
+extern unsigned char nvmem_get_mac_address(unsigned char *mac);
 
 
 //*****************************************************************************
@@ -183,7 +183,7 @@
 //!  @param  spLength   number of bytes to write 
 //!  @param  spData     SP data to write
 //!
-//!  @return       on success 0, error otherwise.
+//!  @return     on success 0, error otherwise.
 //!
 //!  @brief      program a patch to a specific file ID. 
 //!              The SP data is assumed to be organized in 2-dimensional.
@@ -191,7 +191,7 @@
 //!              applied in SP_PORTION_SIZE bytes portions.
 //!     
 //*****************************************************************************
-extern    unsigned char nvmem_write_patch(unsigned long ulFileId, unsigned long spLength, const unsigned char *spData);
+extern unsigned char nvmem_write_patch(unsigned long ulFileId, unsigned long spLength, const unsigned char *spData);
 
 
 //*****************************************************************************
@@ -201,14 +201,14 @@
 //!  @param[out]  patchVer    first number indicates package ID and the second 
 //!                           number indicates package build number   
 //!
-//!  @return       on success 0, error otherwise.
+//!  @return     on success 0, error otherwise.
 //!
 //!  @brief      Read patch version. read package version (WiFi FW patch, 
 //!              driver-supplicant-NS patch, bootloader patch)
 //!     
 //*****************************************************************************
 #ifndef CC3000_TINY_DRIVER 
-extern    unsigned char nvmem_read_sp_version(unsigned char* patchVer);
+extern unsigned char nvmem_read_sp_version(unsigned char* patchVer);
 #endif
 
 //*****************************************************************************
@@ -221,7 +221,7 @@
 //!                           * and fileIDs 14 and 15
 //!  @param       ulNewLen    entry ulLength  
 //!
-//!  @return       on success 0, error otherwise.
+//!  @return     on success 0, error otherwise.
 //!
 //!  @brief      Create new file entry and allocate space on the NVMEM. 
 //!              Applies only to user files.