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 14:19:46 2013 +0000
Revision:
4:d8255a5aad46
Parent:
3:3818c9c7b14e
Child:
5:854f9b13a0f9
Full clean up (comments, Doxygen, code)

Who changed what in which revision?

UserRevisionLine numberNew contents of line
frankvnk 0:c44f0314d6ec 1 /*****************************************************************************
frankvnk 0:c44f0314d6ec 2 *
frankvnk 0:c44f0314d6ec 3 * spi.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
frankvnk 0:c44f0314d6ec 36
frankvnk 0:c44f0314d6ec 37 #ifndef __SPI_H__
frankvnk 0:c44f0314d6ec 38 #define __SPI_H__
frankvnk 0:c44f0314d6ec 39
frankvnk 0:c44f0314d6ec 40 #include "GlobalAssigns.h"
frankvnk 0:c44f0314d6ec 41 #include "hci.h"
frankvnk 0:c44f0314d6ec 42
frankvnk 0:c44f0314d6ec 43 /** CC3000 SPI library
frankvnk 0:c44f0314d6ec 44 *
frankvnk 0:c44f0314d6ec 45 */
frankvnk 0:c44f0314d6ec 46
frankvnk 0:c44f0314d6ec 47 #ifdef __cplusplus
frankvnk 0:c44f0314d6ec 48 extern "C" {
frankvnk 0:c44f0314d6ec 49 #endif
frankvnk 0:c44f0314d6ec 50
frankvnk 1:bbcaf0b2f367 51 #define READ 3
frankvnk 1:bbcaf0b2f367 52 #define WRITE 1
frankvnk 1:bbcaf0b2f367 53
frankvnk 1:bbcaf0b2f367 54 #define HI(value) (((value) & 0xFF00) >> 8)
frankvnk 1:bbcaf0b2f367 55 #define LO(value) ((value) & 0x00FF)
frankvnk 1:bbcaf0b2f367 56
frankvnk 1:bbcaf0b2f367 57 #define HEADERS_SIZE_EVNT (SPI_HEADER_SIZE + 5)
frankvnk 1:bbcaf0b2f367 58
frankvnk 1:bbcaf0b2f367 59 #define SPI_HEADER_SIZE (5)
frankvnk 1:bbcaf0b2f367 60
frankvnk 1:bbcaf0b2f367 61 #define eSPI_STATE_POWERUP (0)
frankvnk 1:bbcaf0b2f367 62 #define eSPI_STATE_INITIALIZED (1)
frankvnk 1:bbcaf0b2f367 63 #define eSPI_STATE_IDLE (2)
frankvnk 1:bbcaf0b2f367 64 #define eSPI_STATE_WRITE_IRQ (3)
frankvnk 1:bbcaf0b2f367 65 #define eSPI_STATE_WRITE_FIRST_PORTION (4)
frankvnk 1:bbcaf0b2f367 66 #define eSPI_STATE_WRITE_EOT (5)
frankvnk 1:bbcaf0b2f367 67 #define eSPI_STATE_READ_IRQ (6)
frankvnk 1:bbcaf0b2f367 68 #define eSPI_STATE_READ_FIRST_PORTION (7)
frankvnk 1:bbcaf0b2f367 69 #define eSPI_STATE_READ_EOT (8)
frankvnk 1:bbcaf0b2f367 70
frankvnk 1:bbcaf0b2f367 71 // The magic number that resides at the end of the TX/RX buffer (1 byte after the allocated size)
frankvnk 1:bbcaf0b2f367 72 // for the purpose of detection of the overrun. The location of the memory where the magic number
frankvnk 1:bbcaf0b2f367 73 // resides shall never be written. In case it is written - overrun occured and either recevie function
frankvnk 1:bbcaf0b2f367 74 // or send function will be stuck forever.
frankvnk 1:bbcaf0b2f367 75 #define CC3000_BUFFER_MAGIC_NUMBER (0xDE)
frankvnk 1:bbcaf0b2f367 76
frankvnk 1:bbcaf0b2f367 77
frankvnk 0:c44f0314d6ec 78 typedef void (*gcSpiHandleRx)(void *p);
frankvnk 0:c44f0314d6ec 79 typedef void (*gcSpiHandleTx)(void);
frankvnk 0:c44f0314d6ec 80
frankvnk 1:bbcaf0b2f367 81 typedef struct
frankvnk 1:bbcaf0b2f367 82 {
frankvnk 1:bbcaf0b2f367 83 gcSpiHandleRx SPIRxHandler;
frankvnk 1:bbcaf0b2f367 84 unsigned short usTxPacketLength;
frankvnk 1:bbcaf0b2f367 85 unsigned short usRxPacketLength;
frankvnk 1:bbcaf0b2f367 86 unsigned long ulSpiState;
frankvnk 1:bbcaf0b2f367 87 unsigned char *pTxPacket;
frankvnk 1:bbcaf0b2f367 88 unsigned char *pRxPacket;
frankvnk 1:bbcaf0b2f367 89
frankvnk 1:bbcaf0b2f367 90 }tSpiInformation;
frankvnk 1:bbcaf0b2f367 91
frankvnk 0:c44f0314d6ec 92 extern unsigned char wlan_tx_buffer[];
frankvnk 4:d8255a5aad46 93
frankvnk 4:d8255a5aad46 94 /**
frankvnk 4:d8255a5aad46 95 * First SPI write after powerup (delay needed between SPI header and body)
frankvnk 4:d8255a5aad46 96 * @param pointer to write buffer
frankvnk 4:d8255a5aad46 97 * @param buffer length
frankvnk 4:d8255a5aad46 98 * @return none
frankvnk 4:d8255a5aad46 99 */
frankvnk 4:d8255a5aad46 100 long SpiFirstWrite(unsigned char *ucBuf, unsigned short usLength);
frankvnk 4:d8255a5aad46 101
frankvnk 4:d8255a5aad46 102 /**
frankvnk 4:d8255a5aad46 103 * Low level SPI write
frankvnk 4:d8255a5aad46 104 * @param pointer to data buffer
frankvnk 4:d8255a5aad46 105 * @param number of bytes
frankvnk 4:d8255a5aad46 106 * @return none
frankvnk 4:d8255a5aad46 107 */
frankvnk 1:bbcaf0b2f367 108 void SpiWriteDataSynchronous(unsigned char *data, unsigned short size);
frankvnk 4:d8255a5aad46 109
frankvnk 4:d8255a5aad46 110 /**
frankvnk 4:d8255a5aad46 111 * Low level SPI read
frankvnk 4:d8255a5aad46 112 * @param pointer to data buffer
frankvnk 4:d8255a5aad46 113 * @param number of bytes
frankvnk 4:d8255a5aad46 114 * @return none
frankvnk 4:d8255a5aad46 115 */
frankvnk 4:d8255a5aad46 116 void SpiReadDataSynchronous(unsigned char *data, unsigned short size);
frankvnk 4:d8255a5aad46 117
frankvnk 4:d8255a5aad46 118 /**
frankvnk 4:d8255a5aad46 119 * Read 5 SPI header bytes and 5 Event Data bytes
frankvnk 4:d8255a5aad46 120 * @param none
frankvnk 4:d8255a5aad46 121 * @return none
frankvnk 4:d8255a5aad46 122 */
frankvnk 4:d8255a5aad46 123 void SpiReadHeader(void);
frankvnk 4:d8255a5aad46 124
frankvnk 4:d8255a5aad46 125 /**
frankvnk 4:d8255a5aad46 126 * Process the received SPI Header and in accordance with it - continue reading the packet
frankvnk 4:d8255a5aad46 127 * @param None
frankvnk 4:d8255a5aad46 128 * @return 0
frankvnk 4:d8255a5aad46 129 */
frankvnk 4:d8255a5aad46 130 long SpiReadDataCont(void);
frankvnk 4:d8255a5aad46 131
frankvnk 4:d8255a5aad46 132 /**
frankvnk 4:d8255a5aad46 133 * Trigger RX processing
frankvnk 4:d8255a5aad46 134 * @param SpiTriggerRxProcessing
frankvnk 4:d8255a5aad46 135 * @return none
frankvnk 4:d8255a5aad46 136 */
frankvnk 4:d8255a5aad46 137 void SpiTriggerRxProcessing(void);
frankvnk 4:d8255a5aad46 138
frankvnk 4:d8255a5aad46 139 /**
frankvnk 4:d8255a5aad46 140 * SSIContReadOperation
frankvnk 4:d8255a5aad46 141 * @param none
frankvnk 4:d8255a5aad46 142 * @return none
frankvnk 4:d8255a5aad46 143 */
frankvnk 1:bbcaf0b2f367 144 void SSIContReadOperation(void);
frankvnk 1:bbcaf0b2f367 145
frankvnk 0:c44f0314d6ec 146 //*****************************************************************************
frankvnk 0:c44f0314d6ec 147 //
frankvnk 0:c44f0314d6ec 148 // Prototypes for the APIs.
frankvnk 0:c44f0314d6ec 149 //
frankvnk 0:c44f0314d6ec 150 //*****************************************************************************
frankvnk 4:d8255a5aad46 151 /**
frankvnk 4:d8255a5aad46 152 * Open the SPI interface
frankvnk 4:d8255a5aad46 153 * @param pointer to RX handle
frankvnk 4:d8255a5aad46 154 * @return none
frankvnk 4:d8255a5aad46 155 */
frankvnk 0:c44f0314d6ec 156 extern void SpiOpen(gcSpiHandleRx pfRxHandler);
frankvnk 4:d8255a5aad46 157
frankvnk 4:d8255a5aad46 158 /**
frankvnk 4:d8255a5aad46 159 * Close the SPI interface
frankvnk 4:d8255a5aad46 160 * @param none
frankvnk 4:d8255a5aad46 161 * @return none
frankvnk 4:d8255a5aad46 162 */
frankvnk 0:c44f0314d6ec 163 extern void SpiClose(void);
frankvnk 4:d8255a5aad46 164
frankvnk 4:d8255a5aad46 165 /**
frankvnk 4:d8255a5aad46 166 * SPI Write function
frankvnk 4:d8255a5aad46 167 * @param pointer to write buffer
frankvnk 4:d8255a5aad46 168 * @param buffer length
frankvnk 4:d8255a5aad46 169 * @return 0
frankvnk 4:d8255a5aad46 170 */
frankvnk 0:c44f0314d6ec 171 extern long SpiWrite(unsigned char *pUserBuffer, unsigned short usLength);
frankvnk 4:d8255a5aad46 172
frankvnk 4:d8255a5aad46 173 /**
frankvnk 4:d8255a5aad46 174 * SPI interrupt Handler
frankvnk 4:d8255a5aad46 175 * The external WLAN device asserts the IRQ line when data is ready.
frankvnk 4:d8255a5aad46 176 * The host CPU needs to acknowledges the IRQ by asserting CS.
frankvnk 4:d8255a5aad46 177 * @param none
frankvnk 4:d8255a5aad46 178 * @return none
frankvnk 4:d8255a5aad46 179 */
frankvnk 4:d8255a5aad46 180 extern void WLAN_IRQHandler(void);
frankvnk 4:d8255a5aad46 181
frankvnk 0:c44f0314d6ec 182 #ifdef __cplusplus
frankvnk 0:c44f0314d6ec 183 }
frankvnk 0:c44f0314d6ec 184 #endif // __cplusplus
frankvnk 0:c44f0314d6ec 185
frankvnk 0:c44f0314d6ec 186 #endif
frankvnk 0:c44f0314d6ec 187
frankvnk 3:3818c9c7b14e 188
frankvnk 4:d8255a5aad46 189