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 19:54:53 2013 +0000
Revision:
5:854f9b13a0f9
Parent:
4:d8255a5aad46
Child:
6:d733efcc2c56
Doxygen fixed

Who changed what in which revision?

UserRevisionLine numberNew contents of line
frankvnk 0:c44f0314d6ec 1 /*****************************************************************************
frankvnk 0:c44f0314d6ec 2 *
frankvnk 0:c44f0314d6ec 3 * nvmem.h - CC3000 Host Driver Implementation.
frankvnk 0:c44f0314d6ec 4 * Copyright (C) 2011 Texas Instruments Incorporated - http://www.ti.com/
frankvnk 0:c44f0314d6ec 5 *
frankvnk 0:c44f0314d6ec 6 * Redistribution and use in source and binary forms, with or without
frankvnk 0:c44f0314d6ec 7 * modification, are permitted provided that the following conditions
frankvnk 0:c44f0314d6ec 8 * are met:
frankvnk 0:c44f0314d6ec 9 *
frankvnk 0:c44f0314d6ec 10 * Redistributions of source code must retain the above copyright
frankvnk 0:c44f0314d6ec 11 * notice, this list of conditions and the following disclaimer.
frankvnk 0:c44f0314d6ec 12 *
frankvnk 0:c44f0314d6ec 13 * Redistributions in binary form must reproduce the above copyright
frankvnk 0:c44f0314d6ec 14 * notice, this list of conditions and the following disclaimer in the
frankvnk 0:c44f0314d6ec 15 * documentation and/or other materials provided with the
frankvnk 0:c44f0314d6ec 16 * distribution.
frankvnk 0:c44f0314d6ec 17 *
frankvnk 0:c44f0314d6ec 18 * Neither the name of Texas Instruments Incorporated nor the names of
frankvnk 0:c44f0314d6ec 19 * its contributors may be used to endorse or promote products derived
frankvnk 0:c44f0314d6ec 20 * from this software without specific prior written permission.
frankvnk 0:c44f0314d6ec 21 *
frankvnk 0:c44f0314d6ec 22 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
frankvnk 0:c44f0314d6ec 23 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
frankvnk 0:c44f0314d6ec 24 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
frankvnk 0:c44f0314d6ec 25 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
frankvnk 0:c44f0314d6ec 26 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
frankvnk 0:c44f0314d6ec 27 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
frankvnk 0:c44f0314d6ec 28 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
frankvnk 0:c44f0314d6ec 29 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
frankvnk 0:c44f0314d6ec 30 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
frankvnk 0:c44f0314d6ec 31 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
frankvnk 0:c44f0314d6ec 32 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
frankvnk 0:c44f0314d6ec 33 *
frankvnk 0:c44f0314d6ec 34 *****************************************************************************/
frankvnk 0:c44f0314d6ec 35 #ifndef __NVRAM_H__
frankvnk 0:c44f0314d6ec 36 #define __NVRAM_H__
frankvnk 0:c44f0314d6ec 37
frankvnk 0:c44f0314d6ec 38 #include "GlobalAssigns.h"
frankvnk 0:c44f0314d6ec 39 #include "cc3000_common.h"
frankvnk 0:c44f0314d6ec 40 #include "hci.h"
frankvnk 0:c44f0314d6ec 41 #include "socket.h"
frankvnk 0:c44f0314d6ec 42 #include "evnt_handler.h"
frankvnk 0:c44f0314d6ec 43
frankvnk 5:854f9b13a0f9 44 //*****************************************************************************
frankvnk 5:854f9b13a0f9 45 //
frankvnk 5:854f9b13a0f9 46 //! \addtogroup nvmem
frankvnk 5:854f9b13a0f9 47 //! @{
frankvnk 5:854f9b13a0f9 48 //
frankvnk 5:854f9b13a0f9 49 //*****************************************************************************
frankvnk 0:c44f0314d6ec 50
frankvnk 0:c44f0314d6ec 51 /** CC3000 Host driver - NVMEM
frankvnk 0:c44f0314d6ec 52 *
frankvnk 0:c44f0314d6ec 53 */
frankvnk 4:d8255a5aad46 54
frankvnk 0:c44f0314d6ec 55 #ifdef __cplusplus
frankvnk 0:c44f0314d6ec 56 extern "C" {
frankvnk 0:c44f0314d6ec 57 #endif
frankvnk 0:c44f0314d6ec 58
frankvnk 0:c44f0314d6ec 59 //*****************************************************************************
frankvnk 0:c44f0314d6ec 60 //
frankvnk 4:d8255a5aad46 61 // Prototypes for the structures for APIs.
frankvnk 0:c44f0314d6ec 62 //
frankvnk 0:c44f0314d6ec 63 //*****************************************************************************
frankvnk 0:c44f0314d6ec 64
frankvnk 4:d8255a5aad46 65 #define NVMEM_READ_PARAMS_LEN (12)
frankvnk 4:d8255a5aad46 66 #define NVMEM_CREATE_PARAMS_LEN (8)
frankvnk 4:d8255a5aad46 67 #define NVMEM_WRITE_PARAMS_LEN (16)
frankvnk 4:d8255a5aad46 68
frankvnk 4:d8255a5aad46 69
frankvnk 0:c44f0314d6ec 70 /****************************************************************************
frankvnk 0:c44f0314d6ec 71 **
frankvnk 0:c44f0314d6ec 72 ** Definitions for File IDs
frankvnk 0:c44f0314d6ec 73 **
frankvnk 0:c44f0314d6ec 74 ****************************************************************************/
frankvnk 0:c44f0314d6ec 75 /* NVMEM file ID - system files*/
frankvnk 0:c44f0314d6ec 76 #define NVMEM_NVS_FILEID (0)
frankvnk 1:bbcaf0b2f367 77 #define NVMEM_NVS_SHADOW_FILEID (1)
frankvnk 0:c44f0314d6ec 78 #define NVMEM_WLAN_CONFIG_FILEID (2)
frankvnk 1:bbcaf0b2f367 79 #define NVMEM_WLAN_CONFIG_SHADOW_FILEID (3)
frankvnk 1:bbcaf0b2f367 80 #define NVMEM_WLAN_DRIVER_SP_FILEID (4)
frankvnk 1:bbcaf0b2f367 81 #define NVMEM_WLAN_FW_SP_FILEID (5)
frankvnk 0:c44f0314d6ec 82 #define NVMEM_MAC_FILEID (6)
frankvnk 1:bbcaf0b2f367 83 #define NVMEM_FRONTEND_VARS_FILEID (7)
frankvnk 1:bbcaf0b2f367 84 #define NVMEM_IP_CONFIG_FILEID (8)
frankvnk 1:bbcaf0b2f367 85 #define NVMEM_IP_CONFIG_SHADOW_FILEID (9)
frankvnk 1:bbcaf0b2f367 86 #define NVMEM_BOOTLOADER_SP_FILEID (10)
frankvnk 1:bbcaf0b2f367 87 #define NVMEM_RM_FILEID (11)
frankvnk 0:c44f0314d6ec 88
frankvnk 0:c44f0314d6ec 89 /* NVMEM file ID - user files*/
frankvnk 1:bbcaf0b2f367 90 #define NVMEM_AES128_KEY_FILEID (12)
frankvnk 1:bbcaf0b2f367 91 #define NVMEM_SHARED_MEM_FILEID (13)
frankvnk 1:bbcaf0b2f367 92 #define NVMEM_USER_FILE_1_FILEID (14)
frankvnk 1:bbcaf0b2f367 93 #define NVMEM_USER_FILE_2_FILEID (15)
frankvnk 0:c44f0314d6ec 94
frankvnk 0:c44f0314d6ec 95 /* max entry in order to invalid nvmem */
frankvnk 0:c44f0314d6ec 96 #define NVMEM_MAX_ENTRY (16)
frankvnk 0:c44f0314d6ec 97
frankvnk 0:c44f0314d6ec 98
frankvnk 4:d8255a5aad46 99 /**
frankvnk 4:d8255a5aad46 100 * Read 'length' data at offset 'ulOffset' from nvmem to file 'ulFileId'.
frankvnk 5:854f9b13a0f9 101 * @param ulFileId Possible nvmem file id values:\n
frankvnk 5:854f9b13a0f9 102 * NVMEM_NVS_FILEID, NVMEM_NVS_SHADOW_FILEID,\n
frankvnk 5:854f9b13a0f9 103 * NVMEM_WLAN_CONFIG_FILEID, NVMEM_WLAN_CONFIG_SHADOW_FILEID,\n
frankvnk 5:854f9b13a0f9 104 * NVMEM_WLAN_DRIVER_SP_FILEID, NVMEM_WLAN_FW_SP_FILEID,\n
frankvnk 5:854f9b13a0f9 105 * NVMEM_MAC_FILEID, NVMEM_FRONTEND_VARS_FILEID,\n
frankvnk 5:854f9b13a0f9 106 * NVMEM_IP_CONFIG_FILEID, NVMEM_IP_CONFIG_SHADOW_FILEID,\n
frankvnk 5:854f9b13a0f9 107 * NVMEM_BOOTLOADER_SP_FILEID, NVMEM_RM_FILEID,\n
frankvnk 5:854f9b13a0f9 108 * and user files 12-15.\n
frankvnk 4:d8255a5aad46 109 * @param ulLength number of bytes to read
frankvnk 4:d8255a5aad46 110 * @param ulOffset ulOffset in file from where to read
frankvnk 4:d8255a5aad46 111 * @param buff output buffer pointer
frankvnk 5:854f9b13a0f9 112 * @return number of bytes read, otherwise error.\n
frankvnk 5:854f9b13a0f9 113 * Error conditions : file can't be used\n
frankvnk 5:854f9b13a0f9 114 * file is invalid\n
frankvnk 5:854f9b13a0f9 115 * read out of bounds. \n
frankvnk 4:d8255a5aad46 116 */
frankvnk 0:c44f0314d6ec 117 extern signed long nvmem_read(unsigned long file_id, unsigned long length, unsigned long offset, unsigned char *buff);
frankvnk 0:c44f0314d6ec 118
frankvnk 4:d8255a5aad46 119 /**
frankvnk 4:d8255a5aad46 120 * Write 'length' data at offset 'ulOffset' from file 'ulFileId' to nvmem.
frankvnk 5:854f9b13a0f9 121 * The file id is marked as invalid until writing is ended.\n
frankvnk 5:854f9b13a0f9 122 * The file entry doesn't need to be valid - only allocated.\n
frankvnk 5:854f9b13a0f9 123 * @param ulFileId Possible nvmem file id values:\n
frankvnk 5:854f9b13a0f9 124 * NVMEM_WLAN_DRIVER_SP_FILEID, NVMEM_WLAN_FW_SP_FILEID,\n
frankvnk 5:854f9b13a0f9 125 * NVMEM_MAC_FILEID, NVMEM_BOOTLOADER_SP_FILEID,\n
frankvnk 5:854f9b13a0f9 126 * and user files 12-15.\n
frankvnk 4:d8255a5aad46 127 * @param ulLength number of bytes to write
frankvnk 4:d8255a5aad46 128 * @param ulEntryOffset offset in file to start write operation from
frankvnk 4:d8255a5aad46 129 * @param buff data to write
frankvnk 4:d8255a5aad46 130 *
frankvnk 4:d8255a5aad46 131 * @return 0 on success, error otherwise.
frankvnk 4:d8255a5aad46 132 */
frankvnk 0:c44f0314d6ec 133 extern signed long nvmem_write(unsigned long ulFileId, unsigned long ulLength, unsigned long ulEntryOffset, unsigned char *buff);
frankvnk 0:c44f0314d6ec 134
frankvnk 0:c44f0314d6ec 135
frankvnk 4:d8255a5aad46 136 /**
frankvnk 4:d8255a5aad46 137 * Write the MAC address to EEPROM (OUI first)
frankvnk 4:d8255a5aad46 138 * @param mac mac address to be set
frankvnk 4:d8255a5aad46 139 * @return 0 on success, error otherwise.
frankvnk 4:d8255a5aad46 140 */
frankvnk 1:bbcaf0b2f367 141 extern unsigned char nvmem_set_mac_address(unsigned char *mac);
frankvnk 0:c44f0314d6ec 142
frankvnk 0:c44f0314d6ec 143
frankvnk 4:d8255a5aad46 144 /**
frankvnk 4:d8255a5aad46 145 * Read the MAC address from EEPROM (OUI first)
frankvnk 4:d8255a5aad46 146 * @param[out] mac mac address
frankvnk 4:d8255a5aad46 147 *
frankvnk 4:d8255a5aad46 148 * @return on success 0, error otherwise.
frankvnk 4:d8255a5aad46 149 */
frankvnk 1:bbcaf0b2f367 150 extern unsigned char nvmem_get_mac_address(unsigned char *mac);
frankvnk 0:c44f0314d6ec 151
frankvnk 0:c44f0314d6ec 152
frankvnk 4:d8255a5aad46 153 /**
frankvnk 4:d8255a5aad46 154 * Write patch code to a specific file ID. Each write contains SP_PORTION_SIZE bytes.
frankvnk 5:854f9b13a0f9 155 * @param ulFileId Possible nvmem file id values:\n
frankvnk 5:854f9b13a0f9 156 * NVMEM_WLAN_DRIVER_SP_FILEID, NVMEM_WLAN_FW_SP_FILEID,\n
frankvnk 4:d8255a5aad46 157 * @param spLength number of bytes to write
frankvnk 4:d8255a5aad46 158 * @param spData SP data to write
frankvnk 4:d8255a5aad46 159 *
frankvnk 4:d8255a5aad46 160 * @return 0 on success, error otherwise.
frankvnk 4:d8255a5aad46 161 */
frankvnk 1:bbcaf0b2f367 162 extern unsigned char nvmem_write_patch(unsigned long ulFileId, unsigned long spLength, const unsigned char *spData);
frankvnk 0:c44f0314d6ec 163
frankvnk 4:d8255a5aad46 164 /**
frankvnk 5:854f9b13a0f9 165 * Read the patch version.
frankvnk 5:854f9b13a0f9 166 * Read package version (WiFi FW patch, driver-supplicant-NS patch, bootloader patch)\n
frankvnk 4:d8255a5aad46 167 * @param[out] patchVer first number indicates package ID and the second number indicates package build number
frankvnk 4:d8255a5aad46 168 * @return 0 on success, error otherwise.
frankvnk 4:d8255a5aad46 169 */
frankvnk 0:c44f0314d6ec 170 #ifndef CC3000_TINY_DRIVER
frankvnk 1:bbcaf0b2f367 171 extern unsigned char nvmem_read_sp_version(unsigned char* patchVer);
frankvnk 0:c44f0314d6ec 172 #endif
frankvnk 0:c44f0314d6ec 173
frankvnk 4:d8255a5aad46 174 /**
frankvnk 4:d8255a5aad46 175 * Create a new file entry and allocate space in NVMEM.
frankvnk 5:854f9b13a0f9 176 * Applies only to user files.\n
frankvnk 5:854f9b13a0f9 177 * Modify the size of file.\n
frankvnk 5:854f9b13a0f9 178 * If the entry is unallocated - allocate it to size ulNewLen (marked invalid).\n
frankvnk 5:854f9b13a0f9 179 * If it is allocated then deallocate it first.\n
frankvnk 5:854f9b13a0f9 180 * To just mark the file as invalid without resizing - set ulNewLen=0.\n
frankvnk 5:854f9b13a0f9 181 * @param ulFileId Possible nvmem file Ids:\n
frankvnk 5:854f9b13a0f9 182 * * NVMEM_AES128_KEY_FILEID: 12\n
frankvnk 5:854f9b13a0f9 183 * * NVMEM_SHARED_MEM_FILEID: 13\n
frankvnk 5:854f9b13a0f9 184 * * and fileIDs 14 and 15\n
frankvnk 4:d8255a5aad46 185 * @param ulNewLen entry ulLength
frankvnk 4:d8255a5aad46 186 *
frankvnk 4:d8255a5aad46 187 * @return 0 on success, error otherwise.
frankvnk 4:d8255a5aad46 188 */
frankvnk 0:c44f0314d6ec 189 extern signed long nvmem_create_entry(unsigned long file_id, unsigned long newlen);
frankvnk 0:c44f0314d6ec 190
frankvnk 0:c44f0314d6ec 191
frankvnk 0:c44f0314d6ec 192
frankvnk 0:c44f0314d6ec 193 #ifdef __cplusplus
frankvnk 0:c44f0314d6ec 194 }
frankvnk 0:c44f0314d6ec 195 #endif // __cplusplus
frankvnk 0:c44f0314d6ec 196
frankvnk 5:854f9b13a0f9 197 //*****************************************************************************
frankvnk 5:854f9b13a0f9 198 //
frankvnk 5:854f9b13a0f9 199 // Close the Doxygen group.
frankvnk 5:854f9b13a0f9 200 //! @}
frankvnk 5:854f9b13a0f9 201 //
frankvnk 5:854f9b13a0f9 202 //*****************************************************************************
frankvnk 5:854f9b13a0f9 203
frankvnk 0:c44f0314d6ec 204 #endif // __NVRAM_H__
frankvnk 0:c44f0314d6ec 205
frankvnk 0:c44f0314d6ec 206