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:
Sun Jul 28 19:22:18 2013 +0000
Revision:
6:d733efcc2c56
Parent:
5:854f9b13a0f9
Child:
7:875e62bb780c
Cleanup includes - combined spi and hci into 1 file
;

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 6:d733efcc2c56 38 #include "cc3000_spi_hci.h"
frankvnk 0:c44f0314d6ec 39
frankvnk 5:854f9b13a0f9 40 //*****************************************************************************
frankvnk 5:854f9b13a0f9 41 //
frankvnk 5:854f9b13a0f9 42 //! \addtogroup nvmem
frankvnk 5:854f9b13a0f9 43 //! @{
frankvnk 5:854f9b13a0f9 44 //
frankvnk 5:854f9b13a0f9 45 //*****************************************************************************
frankvnk 0:c44f0314d6ec 46
frankvnk 0:c44f0314d6ec 47 /** CC3000 Host driver - NVMEM
frankvnk 0:c44f0314d6ec 48 *
frankvnk 0:c44f0314d6ec 49 */
frankvnk 4:d8255a5aad46 50
frankvnk 0:c44f0314d6ec 51 #ifdef __cplusplus
frankvnk 0:c44f0314d6ec 52 extern "C" {
frankvnk 0:c44f0314d6ec 53 #endif
frankvnk 0:c44f0314d6ec 54
frankvnk 0:c44f0314d6ec 55 //*****************************************************************************
frankvnk 0:c44f0314d6ec 56 //
frankvnk 4:d8255a5aad46 57 // Prototypes for the structures for APIs.
frankvnk 0:c44f0314d6ec 58 //
frankvnk 0:c44f0314d6ec 59 //*****************************************************************************
frankvnk 0:c44f0314d6ec 60
frankvnk 4:d8255a5aad46 61 #define NVMEM_READ_PARAMS_LEN (12)
frankvnk 4:d8255a5aad46 62 #define NVMEM_CREATE_PARAMS_LEN (8)
frankvnk 4:d8255a5aad46 63 #define NVMEM_WRITE_PARAMS_LEN (16)
frankvnk 4:d8255a5aad46 64
frankvnk 4:d8255a5aad46 65
frankvnk 0:c44f0314d6ec 66 /****************************************************************************
frankvnk 0:c44f0314d6ec 67 **
frankvnk 0:c44f0314d6ec 68 ** Definitions for File IDs
frankvnk 0:c44f0314d6ec 69 **
frankvnk 0:c44f0314d6ec 70 ****************************************************************************/
frankvnk 0:c44f0314d6ec 71 /* NVMEM file ID - system files*/
frankvnk 0:c44f0314d6ec 72 #define NVMEM_NVS_FILEID (0)
frankvnk 1:bbcaf0b2f367 73 #define NVMEM_NVS_SHADOW_FILEID (1)
frankvnk 0:c44f0314d6ec 74 #define NVMEM_WLAN_CONFIG_FILEID (2)
frankvnk 1:bbcaf0b2f367 75 #define NVMEM_WLAN_CONFIG_SHADOW_FILEID (3)
frankvnk 1:bbcaf0b2f367 76 #define NVMEM_WLAN_DRIVER_SP_FILEID (4)
frankvnk 1:bbcaf0b2f367 77 #define NVMEM_WLAN_FW_SP_FILEID (5)
frankvnk 0:c44f0314d6ec 78 #define NVMEM_MAC_FILEID (6)
frankvnk 1:bbcaf0b2f367 79 #define NVMEM_FRONTEND_VARS_FILEID (7)
frankvnk 1:bbcaf0b2f367 80 #define NVMEM_IP_CONFIG_FILEID (8)
frankvnk 1:bbcaf0b2f367 81 #define NVMEM_IP_CONFIG_SHADOW_FILEID (9)
frankvnk 1:bbcaf0b2f367 82 #define NVMEM_BOOTLOADER_SP_FILEID (10)
frankvnk 1:bbcaf0b2f367 83 #define NVMEM_RM_FILEID (11)
frankvnk 0:c44f0314d6ec 84
frankvnk 0:c44f0314d6ec 85 /* NVMEM file ID - user files*/
frankvnk 1:bbcaf0b2f367 86 #define NVMEM_AES128_KEY_FILEID (12)
frankvnk 1:bbcaf0b2f367 87 #define NVMEM_SHARED_MEM_FILEID (13)
frankvnk 1:bbcaf0b2f367 88 #define NVMEM_USER_FILE_1_FILEID (14)
frankvnk 1:bbcaf0b2f367 89 #define NVMEM_USER_FILE_2_FILEID (15)
frankvnk 0:c44f0314d6ec 90
frankvnk 0:c44f0314d6ec 91 /* max entry in order to invalid nvmem */
frankvnk 0:c44f0314d6ec 92 #define NVMEM_MAX_ENTRY (16)
frankvnk 0:c44f0314d6ec 93
frankvnk 0:c44f0314d6ec 94
frankvnk 4:d8255a5aad46 95 /**
frankvnk 4:d8255a5aad46 96 * Read 'length' data at offset 'ulOffset' from nvmem to file 'ulFileId'.
frankvnk 5:854f9b13a0f9 97 * @param ulFileId Possible nvmem file id values:\n
frankvnk 5:854f9b13a0f9 98 * NVMEM_NVS_FILEID, NVMEM_NVS_SHADOW_FILEID,\n
frankvnk 5:854f9b13a0f9 99 * NVMEM_WLAN_CONFIG_FILEID, NVMEM_WLAN_CONFIG_SHADOW_FILEID,\n
frankvnk 5:854f9b13a0f9 100 * NVMEM_WLAN_DRIVER_SP_FILEID, NVMEM_WLAN_FW_SP_FILEID,\n
frankvnk 5:854f9b13a0f9 101 * NVMEM_MAC_FILEID, NVMEM_FRONTEND_VARS_FILEID,\n
frankvnk 5:854f9b13a0f9 102 * NVMEM_IP_CONFIG_FILEID, NVMEM_IP_CONFIG_SHADOW_FILEID,\n
frankvnk 5:854f9b13a0f9 103 * NVMEM_BOOTLOADER_SP_FILEID, NVMEM_RM_FILEID,\n
frankvnk 5:854f9b13a0f9 104 * and user files 12-15.\n
frankvnk 4:d8255a5aad46 105 * @param ulLength number of bytes to read
frankvnk 4:d8255a5aad46 106 * @param ulOffset ulOffset in file from where to read
frankvnk 4:d8255a5aad46 107 * @param buff output buffer pointer
frankvnk 5:854f9b13a0f9 108 * @return number of bytes read, otherwise error.\n
frankvnk 5:854f9b13a0f9 109 * Error conditions : file can't be used\n
frankvnk 5:854f9b13a0f9 110 * file is invalid\n
frankvnk 5:854f9b13a0f9 111 * read out of bounds. \n
frankvnk 4:d8255a5aad46 112 */
frankvnk 0:c44f0314d6ec 113 extern signed long nvmem_read(unsigned long file_id, unsigned long length, unsigned long offset, unsigned char *buff);
frankvnk 0:c44f0314d6ec 114
frankvnk 4:d8255a5aad46 115 /**
frankvnk 4:d8255a5aad46 116 * Write 'length' data at offset 'ulOffset' from file 'ulFileId' to nvmem.
frankvnk 5:854f9b13a0f9 117 * The file id is marked as invalid until writing is ended.\n
frankvnk 5:854f9b13a0f9 118 * The file entry doesn't need to be valid - only allocated.\n
frankvnk 5:854f9b13a0f9 119 * @param ulFileId Possible nvmem file id values:\n
frankvnk 5:854f9b13a0f9 120 * NVMEM_WLAN_DRIVER_SP_FILEID, NVMEM_WLAN_FW_SP_FILEID,\n
frankvnk 5:854f9b13a0f9 121 * NVMEM_MAC_FILEID, NVMEM_BOOTLOADER_SP_FILEID,\n
frankvnk 5:854f9b13a0f9 122 * and user files 12-15.\n
frankvnk 4:d8255a5aad46 123 * @param ulLength number of bytes to write
frankvnk 4:d8255a5aad46 124 * @param ulEntryOffset offset in file to start write operation from
frankvnk 4:d8255a5aad46 125 * @param buff data to write
frankvnk 4:d8255a5aad46 126 *
frankvnk 4:d8255a5aad46 127 * @return 0 on success, error otherwise.
frankvnk 4:d8255a5aad46 128 */
frankvnk 0:c44f0314d6ec 129 extern signed long nvmem_write(unsigned long ulFileId, unsigned long ulLength, unsigned long ulEntryOffset, unsigned char *buff);
frankvnk 0:c44f0314d6ec 130
frankvnk 0:c44f0314d6ec 131
frankvnk 4:d8255a5aad46 132 /**
frankvnk 4:d8255a5aad46 133 * Write the MAC address to EEPROM (OUI first)
frankvnk 4:d8255a5aad46 134 * @param mac mac address to be set
frankvnk 4:d8255a5aad46 135 * @return 0 on success, error otherwise.
frankvnk 4:d8255a5aad46 136 */
frankvnk 1:bbcaf0b2f367 137 extern unsigned char nvmem_set_mac_address(unsigned char *mac);
frankvnk 0:c44f0314d6ec 138
frankvnk 0:c44f0314d6ec 139
frankvnk 4:d8255a5aad46 140 /**
frankvnk 4:d8255a5aad46 141 * Read the MAC address from EEPROM (OUI first)
frankvnk 4:d8255a5aad46 142 * @param[out] mac mac address
frankvnk 4:d8255a5aad46 143 *
frankvnk 4:d8255a5aad46 144 * @return on success 0, error otherwise.
frankvnk 4:d8255a5aad46 145 */
frankvnk 1:bbcaf0b2f367 146 extern unsigned char nvmem_get_mac_address(unsigned char *mac);
frankvnk 0:c44f0314d6ec 147
frankvnk 0:c44f0314d6ec 148
frankvnk 4:d8255a5aad46 149 /**
frankvnk 4:d8255a5aad46 150 * Write patch code to a specific file ID. Each write contains SP_PORTION_SIZE bytes.
frankvnk 5:854f9b13a0f9 151 * @param ulFileId Possible nvmem file id values:\n
frankvnk 5:854f9b13a0f9 152 * NVMEM_WLAN_DRIVER_SP_FILEID, NVMEM_WLAN_FW_SP_FILEID,\n
frankvnk 4:d8255a5aad46 153 * @param spLength number of bytes to write
frankvnk 4:d8255a5aad46 154 * @param spData SP data to write
frankvnk 4:d8255a5aad46 155 *
frankvnk 4:d8255a5aad46 156 * @return 0 on success, error otherwise.
frankvnk 4:d8255a5aad46 157 */
frankvnk 1:bbcaf0b2f367 158 extern unsigned char nvmem_write_patch(unsigned long ulFileId, unsigned long spLength, const unsigned char *spData);
frankvnk 0:c44f0314d6ec 159
frankvnk 4:d8255a5aad46 160 /**
frankvnk 5:854f9b13a0f9 161 * Read the patch version.
frankvnk 5:854f9b13a0f9 162 * Read package version (WiFi FW patch, driver-supplicant-NS patch, bootloader patch)\n
frankvnk 4:d8255a5aad46 163 * @param[out] patchVer first number indicates package ID and the second number indicates package build number
frankvnk 4:d8255a5aad46 164 * @return 0 on success, error otherwise.
frankvnk 4:d8255a5aad46 165 */
frankvnk 6:d733efcc2c56 166 #ifndef CC3000_TINY_DRIVER
frankvnk 1:bbcaf0b2f367 167 extern unsigned char nvmem_read_sp_version(unsigned char* patchVer);
frankvnk 0:c44f0314d6ec 168 #endif
frankvnk 0:c44f0314d6ec 169
frankvnk 4:d8255a5aad46 170 /**
frankvnk 4:d8255a5aad46 171 * Create a new file entry and allocate space in NVMEM.
frankvnk 5:854f9b13a0f9 172 * Applies only to user files.\n
frankvnk 5:854f9b13a0f9 173 * Modify the size of file.\n
frankvnk 5:854f9b13a0f9 174 * If the entry is unallocated - allocate it to size ulNewLen (marked invalid).\n
frankvnk 5:854f9b13a0f9 175 * If it is allocated then deallocate it first.\n
frankvnk 5:854f9b13a0f9 176 * To just mark the file as invalid without resizing - set ulNewLen=0.\n
frankvnk 5:854f9b13a0f9 177 * @param ulFileId Possible nvmem file Ids:\n
frankvnk 5:854f9b13a0f9 178 * * NVMEM_AES128_KEY_FILEID: 12\n
frankvnk 5:854f9b13a0f9 179 * * NVMEM_SHARED_MEM_FILEID: 13\n
frankvnk 5:854f9b13a0f9 180 * * and fileIDs 14 and 15\n
frankvnk 4:d8255a5aad46 181 * @param ulNewLen entry ulLength
frankvnk 4:d8255a5aad46 182 *
frankvnk 4:d8255a5aad46 183 * @return 0 on success, error otherwise.
frankvnk 4:d8255a5aad46 184 */
frankvnk 0:c44f0314d6ec 185 extern signed long nvmem_create_entry(unsigned long file_id, unsigned long newlen);
frankvnk 0:c44f0314d6ec 186
frankvnk 0:c44f0314d6ec 187
frankvnk 0:c44f0314d6ec 188
frankvnk 0:c44f0314d6ec 189 #ifdef __cplusplus
frankvnk 0:c44f0314d6ec 190 }
frankvnk 0:c44f0314d6ec 191 #endif // __cplusplus
frankvnk 0:c44f0314d6ec 192
frankvnk 5:854f9b13a0f9 193 //*****************************************************************************
frankvnk 5:854f9b13a0f9 194 //
frankvnk 5:854f9b13a0f9 195 // Close the Doxygen group.
frankvnk 5:854f9b13a0f9 196 //! @}
frankvnk 5:854f9b13a0f9 197 //
frankvnk 5:854f9b13a0f9 198 //*****************************************************************************
frankvnk 5:854f9b13a0f9 199
frankvnk 0:c44f0314d6ec 200 #endif // __NVRAM_H__
frankvnk 0:c44f0314d6ec 201
frankvnk 0:c44f0314d6ec 202
frankvnk 6:d733efcc2c56 203
frankvnk 6:d733efcc2c56 204
frankvnk 6:d733efcc2c56 205