CC3000_Hostdriver - Driver for CC3000 Wi-Fi module

Users » frankvnk » Code » 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):

# 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:

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:: 4:d8255a5aad46
Parent:: 1:bbcaf0b2f367
Child:: 5:854f9b13a0f9

--- a/nvmem.h	Sat Jul 13 13:12:46 2013 +0000
+++ b/nvmem.h	Mon Jul 15 14:19:46 2013 +0000
@@ -35,7 +35,6 @@
 #ifndef __NVRAM_H__
 #define __NVRAM_H__
 
-//#include "mbed.h"
 #include "GlobalAssigns.h"
 #include "cc3000_common.h"
 #include "hci.h"
@@ -46,24 +45,22 @@
 /** CC3000 Host driver - NVMEM
 *
 */
-//*****************************************************************************
-//
-// If building with a C++ compiler, make all of the definitions in this header
-// have a C binding.
-//
-//*****************************************************************************
+
 #ifdef  __cplusplus
 extern "C" {
 #endif
 
-
 //*****************************************************************************
 //
-//! \addtogroup nvmem_api
-//! @{
+// Prototypes for the structures for APIs.
 //
 //*****************************************************************************
 
+#define NVMEM_READ_PARAMS_LEN       (12)
+#define NVMEM_CREATE_PARAMS_LEN     (8)
+#define NVMEM_WRITE_PARAMS_LEN      (16)
+
+
 /****************************************************************************
 **
 **    Definitions for File IDs
@@ -93,163 +90,98 @@
 #define NVMEM_MAX_ENTRY                              (16)
 
 
-//*****************************************************************************
-//
-//!  nvmem_read
-//!
-//!  @param  ulFileId   nvmem file id:\n
-//!                     NVMEM_NVS_FILEID, NVMEM_NVS_SHADOW_FILEID,
-//!                     NVMEM_WLAN_CONFIG_FILEID, NVMEM_WLAN_CONFIG_SHADOW_FILEID,
-//!                     NVMEM_WLAN_DRIVER_SP_FILEID, NVMEM_WLAN_FW_SP_FILEID,
-//!                     NVMEM_MAC_FILEID, NVMEM_FRONTEND_VARS_FILEID,
-//!                     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
-//!
-//!  @return       number of bytes read, otherwise error.
-//!
-//!  @brief       Reads data from the file referred by the ulFileId parameter. 
-//!               Reads data from file ulOffset till length. Err if the file can't
-//!               be used, is invalid, or if the read is out of bounds. 
-//!     
-//*****************************************************************************
-
+/**
+* Read 'length' data at offset 'ulOffset' from nvmem to file 'ulFileId'.
+* @param  ulFileId   Possible nvmem file id values:
+*                    NVMEM_NVS_FILEID, NVMEM_NVS_SHADOW_FILEID,
+*                    NVMEM_WLAN_CONFIG_FILEID, NVMEM_WLAN_CONFIG_SHADOW_FILEID,
+*                    NVMEM_WLAN_DRIVER_SP_FILEID, NVMEM_WLAN_FW_SP_FILEID,
+*                    NVMEM_MAC_FILEID, NVMEM_FRONTEND_VARS_FILEID,
+*                    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
+* @return            number of bytes read, otherwise error.
+*                    Error conditions : file can't be used
+*                                       file is invalid
+*                                       read out of bounds. 
+*/
 extern signed long nvmem_read(unsigned long file_id, unsigned long length, unsigned long offset, unsigned char *buff);
 
-//*****************************************************************************
-//
-//!  nvmem_write
-//!
-//!  @param  ulFileId nvmem file id:\n
-//!                   NVMEM_WLAN_DRIVER_SP_FILEID, NVMEM_WLAN_FW_SP_FILEID,
-//!                   NVMEM_MAC_FILEID, NVMEM_BOOTLOADER_SP_FILEID,
-//!                   and user files 12-15.
-//!  @param  ulLength       number of bytes to write  
-//!  @param  ulEntryOffset  offset in file to start write operation from 
-//!  @param  buff           data to write
-//!
-//!  @return      on success 0, error otherwise.
-//!
-//!  @brief       Write data to nvmem.
-//!               writes data to file referred by the ulFileId parameter. 
-//!               Writes data to file ulOffset till ulLength.The file id will be 
-//!               marked invalid till the write is done. The file entry doesn't
-//!               need to be valid - only allocated.
-//!     
-//*****************************************************************************
-
+/**
+* Write 'length' data at offset 'ulOffset' from file 'ulFileId' to nvmem.
+* The file id is marked as invalid until writing is ended.
+* The file entry doesn't need to be valid - only allocated.
+* @param  ulFileId  Possible nvmem file id values:
+*                   NVMEM_WLAN_DRIVER_SP_FILEID, NVMEM_WLAN_FW_SP_FILEID,
+*                   NVMEM_MAC_FILEID, NVMEM_BOOTLOADER_SP_FILEID,
+*                   and user files 12-15.
+* @param  ulLength       number of bytes to write  
+* @param  ulEntryOffset  offset in file to start write operation from 
+* @param  buff           data to write
+*
+* @return      0 on success, error otherwise.
+*/
 extern signed long nvmem_write(unsigned long ulFileId, unsigned long ulLength, unsigned long ulEntryOffset, unsigned char *buff);
 
 
-//*****************************************************************************
-//
-//!  nvmem_set_mac_address
-//!
-//!  @param  mac  mac address to be set
-//!
-//!  @return      on success 0, error otherwise.
-//!
-//!  @brief       Write MAC address to EEPROM. 
-//!               mac address as appears over the air (OUI first)
-//!     
-//*****************************************************************************
+/**
+* Write the MAC address to EEPROM (OUI first)
+* @param  mac  mac address to be set
+* @return      0 on success, error otherwise.
+*/
 extern unsigned char nvmem_set_mac_address(unsigned char *mac);
 
 
-//*****************************************************************************
-//
-//!  nvmem_get_mac_address
-//!
-//!  @param[out]  mac   mac address  
-//!
-//!  @return      on success 0, error otherwise.
-//!
-//!  @brief       Read MAC address from EEPROM. 
-//!               mac address as appears over the air (OUI first)
-//!     
-//*****************************************************************************
+/**
+* Read the MAC address from EEPROM (OUI first)
+* @param[out]  mac   mac address  
+*
+* @return      on success 0, error otherwise.
+*/
 extern unsigned char nvmem_get_mac_address(unsigned char *mac);
 
 
-//*****************************************************************************
-//
-//!  nvmem_write_patch
-//!
-//!  @param  ulFileId   nvmem file id:\n
-//!                     NVMEM_WLAN_DRIVER_SP_FILEID, NVMEM_WLAN_FW_SP_FILEID,
-//!  @param  spLength   number of bytes to write 
-//!  @param  spData     SP data to write
-//!
-//!  @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.
-//!              Each line is SP_PORTION_SIZE bytes long. Actual programming is 
-//!              applied in SP_PORTION_SIZE bytes portions.
-//!     
-//*****************************************************************************
+/**
+* Write patch code to a specific file ID. Each write contains SP_PORTION_SIZE bytes.
+* @param    ulFileId   Possible nvmem file id values:
+*                      NVMEM_WLAN_DRIVER_SP_FILEID, NVMEM_WLAN_FW_SP_FILEID,
+* @param    spLength   number of bytes to write 
+* @param    spData     SP data to write
+*
+* @return   0 on success, error otherwise.
+*/
 extern unsigned char nvmem_write_patch(unsigned long ulFileId, unsigned long spLength, const unsigned char *spData);
 
-
-//*****************************************************************************
-//
-//!  nvmem_read_sp_version
-//!
-//!  @param[out]  patchVer    first number indicates package ID and the second 
-//!                           number indicates package build number   
-//!
-//!  @return     on success 0, error otherwise.
-//!
-//!  @brief      Read patch version. read package version (WiFi FW patch, 
-//!              driver-supplicant-NS patch, bootloader patch)
-//!     
-//*****************************************************************************
+/**
+* Read the patch version. read package version (WiFi FW patch, driver-supplicant-NS patch, bootloader patch)
+* @param[out]  patchVer    first number indicates package ID and the second number indicates package build number   
+* @return      0 on success, error otherwise.
+*/
 #ifndef CC3000_TINY_DRIVER 
 extern unsigned char nvmem_read_sp_version(unsigned char* patchVer);
 #endif
 
-//*****************************************************************************
-//
-//!  nvmem_create_entry
-//!
-//!  @param       ulFileId    nvmem file Id:\n
-//!                           * NVMEM_AES128_KEY_FILEID: 12
-//!                           * NVMEM_SHARED_MEM_FILEID: 13
-//!                           * and fileIDs 14 and 15
-//!  @param       ulNewLen    entry ulLength  
-//!
-//!  @return     on success 0, error otherwise.
-//!
-//!  @brief      Create new file entry and allocate space on the NVMEM. 
-//!              Applies only to user files.
-//!              Modify the size of file.
-//!              If the entry is unallocated - allocate it to size 
-//!              ulNewLen (marked invalid).
-//!              If it is allocated then deallocate it first.
-//!              To just mark the file as invalid without resizing - 
-//!              set ulNewLen=0.
-//!     
-//*****************************************************************************
+/**
+* Create a new file entry and allocate space in NVMEM. 
+* Applies only to user files.
+* Modify the size of file.
+* If the entry is unallocated - allocate it to size ulNewLen (marked invalid).
+* If it is allocated then deallocate it first.
+* To just mark the file as invalid without resizing - set ulNewLen=0.
+* @param       ulFileId    Possible nvmem file Ids:
+*                          * NVMEM_AES128_KEY_FILEID: 12
+*                          * NVMEM_SHARED_MEM_FILEID: 13
+*                          * and fileIDs 14 and 15
+* @param       ulNewLen    entry ulLength  
+*
+* @return      0 on success, error otherwise.
+*/
 extern signed long nvmem_create_entry(unsigned long file_id, unsigned long newlen);
 
 
-//*****************************************************************************
-//
-// Mark the end of the C bindings section for C++ compilers.
-//
-//*****************************************************************************
-
-
-//*****************************************************************************
-//
-// Close the Doxygen group.
-//! @}
-//
-//*****************************************************************************
-
 
 #ifdef  __cplusplus
 }

Repository toolbox

Export to desktop IDE

Repository details

Type:	Library
Created:	28 Jun 2013
Imports:	120
Forks:	0
Commits:	14
Dependents:	2
Dependencies:	1
Followers:	9
Issues:	0

The code in this repository is Apache licensed.

Components

SimpleLink Wi-Fi CC3000