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

nvmem.h

Committer:: frankvnk
Date:: 2013-11-29
Revision:: 13:e1ab6b5ab826
Parent:: 7:875e62bb780c

File content as of revision 13:e1ab6b5ab826:

/*****************************************************************************
*
*  nvmem.h  - CC3000 Host Driver Implementation.
*  Copyright (C) 2011 Texas Instruments Incorporated - http://www.ti.com/
*
*  Redistribution and use in source and binary forms, with or without
*  modification, are permitted provided that the following conditions
*  are met:
*
*    Redistributions of source code must retain the above copyright
*    notice, this list of conditions and the following disclaimer.
*
*    Redistributions in binary form must reproduce the above copyright
*    notice, this list of conditions and the following disclaimer in the
*    documentation and/or other materials provided with the   
*    distribution.
*
*    Neither the name of Texas Instruments Incorporated nor the names of
*    its contributors may be used to endorse or promote products derived
*    from this software without specific prior written permission.
*
*  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
*  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
*  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
*  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 
*  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 
*  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 
*  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
*  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
*  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 
*  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 
*  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
*****************************************************************************/
#ifndef __NVRAM_H__
#define __NVRAM_H__

#include "cc3000_spi_hci.h"

//*****************************************************************************
//
//! \addtogroup nvmem
//! @{
//
//*****************************************************************************

/** CC3000 Host driver - NVMEM
*
*/

#ifdef  __cplusplus
extern "C" {
#endif

//*****************************************************************************
//
// 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
**    
****************************************************************************/
/* --------------------------------------------------------- EEPROM FAT table ---------------------------------------------------------

 File ID                            Offset      File Size   Used Size   Parameter
 #  ID                              address     (bytes)     (bytes)
 --------------------------------------------------------------------------------------------------------------------------------------
 0  NVMEM_NVS_FILEID                0x50        0x1A0       0x1A        RF Calibration results table(generated automatically by TX Bip)  
 1  NVMEM_NVS_SHADOW_FILEID         0x1F0       0x1A0       0x1A        NVS Shadow
 2  NVMEM_WLAN_CONFIG_FILEID        0x390       0x1000      0x64        WLAN configuration  
 3  NVMEM_WLAN_CONFIG_SHADOW_FILEID 0x1390      0x1000      0x64        WLAN configuration shadow
 4  NVMEM_WLAN_DRIVER_SP_FILEID     0x2390      0x2000      variable    WLAN Driver ROM Patches  
 5  NVMEM_WLAN_FW_SP_FILEID         0x4390      0x2000      variable    WLAN FW Patches  
 6  NVMEM_MAC_FILEID                0x6390      0x10        0x10        6 bytes of MAC address  
 7  NVMEM_FRONTEND_VARS_FILEID      0x63A0      0x10        0x10        Frontend Vars
 8  NVMEM_IP_CONFIG_FILEID          0x63B0      0x40        0x40        IP configuration  
 9  NVMEM_IP_CONFIG_SHADOW_FILEID   0x63F0      0x40        0x40        IP configuration shadow
10  NVMEM_BOOTLOADER_SP_FILEID      0x6430      0x400       variable    Bootloader Patches  
11  NVMEM_RM_FILEID                 0x6830      0x200       0x7F        Radio parameters  
12  NVMEM_AES128_KEY_FILEID         0x6A30      0x10        0x10        AES128 key file  
13  NVMEM_SHARED_MEM_FILEID         0x6A40      0x50        0x44        Host-CC3000 shared memory file  
14  NVMEM_USER_FILE_1_FILEID        0x6A90      variable    variable    1st user file  
15  NVMEM_USER_FILE_2_FILEID        variable    variable    variable    2nd user file  
*/
/* NVMEM file ID - system files*/
#define NVMEM_NVS_FILEID                             (0)
#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_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)

/* 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)

/*  max entry in order to invalid nvmem              */
#define NVMEM_MAX_ENTRY                              (16)


/**
* Read 'length' data at offset 'ulOffset' from nvmem to file 'ulFileId'.
* @param  ulFileId   Possible nvmem file id values:\n
*                    NVMEM_NVS_FILEID, NVMEM_NVS_SHADOW_FILEID,\n
*                    NVMEM_WLAN_CONFIG_FILEID, NVMEM_WLAN_CONFIG_SHADOW_FILEID,\n
*                    NVMEM_WLAN_DRIVER_SP_FILEID, NVMEM_WLAN_FW_SP_FILEID,\n
*                    NVMEM_MAC_FILEID, NVMEM_FRONTEND_VARS_FILEID,\n
*                    NVMEM_IP_CONFIG_FILEID, NVMEM_IP_CONFIG_SHADOW_FILEID,\n
*                    NVMEM_BOOTLOADER_SP_FILEID, NVMEM_RM_FILEID,\n
*                    and user files 12-15.\n
* @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.\n
*                    Error conditions : file can't be used\n
*                                       file is invalid\n
*                                       read out of bounds. \n
*/
extern signed long nvmem_read(unsigned long file_id, unsigned long length, unsigned long offset, unsigned char *buff);

/**
* Write 'length' data at offset 'ulOffset' from file 'ulFileId' to nvmem.
* The file id is marked as invalid until writing is ended.\n
* The file entry doesn't need to be valid - only allocated.\n
* @param  ulFileId  Possible nvmem file id values:\n
*                   NVMEM_WLAN_DRIVER_SP_FILEID, NVMEM_WLAN_FW_SP_FILEID,\n
*                   NVMEM_MAC_FILEID, NVMEM_BOOTLOADER_SP_FILEID,\n
*                   and user files 12-15.\n
* @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);


/**
* 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);


/**
* 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);


/**
* Write patch code to a specific file ID. Each write contains SP_PORTION_SIZE bytes.
* @param    ulFileId   Possible nvmem file id values:\n
*                      NVMEM_WLAN_DRIVER_SP_FILEID, NVMEM_WLAN_FW_SP_FILEID,\n
* @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);

/**
* Read the patch version.
* Read package version (WiFi FW patch, driver-supplicant-NS patch, bootloader patch)\n
* @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

/**
* Create a new file entry and allocate space in NVMEM. 
* Applies only to user files.\n
* Modify the size of file.\n
* If the entry is unallocated - allocate it to size ulNewLen (marked invalid).\n
* If it is allocated then deallocate it first.\n
* To just mark the file as invalid without resizing - set ulNewLen=0.\n
* @param       ulFileId    Possible nvmem file Ids:\n
*                          * NVMEM_AES128_KEY_FILEID: 12\n
*                          * NVMEM_SHARED_MEM_FILEID: 13\n
*                          * and fileIDs 14 and 15\n
* @param       ulNewLen    entry ulLength  
*
* @return      0 on success, error otherwise.
*/
extern signed long nvmem_create_entry(unsigned long file_id, unsigned long newlen);



#ifdef  __cplusplus
}
#endif // __cplusplus

//*****************************************************************************
//
// Close the Doxygen group.
//! @}
//
//*****************************************************************************

#endif // __NVRAM_H__

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