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 08 13:18:12 2013 +0000
Revision:
2:f1d50c7f8bdb
Parent:
1:bbcaf0b2f367
Child:
3:3818c9c7b14e
See history.h

Who changed what in which revision?

UserRevisionLine numberNew contents of line
frankvnk 0:c44f0314d6ec 1 /*****************************************************************************
frankvnk 0:c44f0314d6ec 2 *
frankvnk 0:c44f0314d6ec 3 * hci.c - 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 //
frankvnk 0:c44f0314d6ec 38 //! \addtogroup hci_app
frankvnk 0:c44f0314d6ec 39 //! @{
frankvnk 0:c44f0314d6ec 40 //
frankvnk 0:c44f0314d6ec 41 //*****************************************************************************
frankvnk 0:c44f0314d6ec 42
frankvnk 0:c44f0314d6ec 43 #include "hci.h"
frankvnk 0:c44f0314d6ec 44 #define SL_PATCH_PORTION_SIZE (1000)
frankvnk 0:c44f0314d6ec 45
frankvnk 0:c44f0314d6ec 46
frankvnk 0:c44f0314d6ec 47 //*****************************************************************************
frankvnk 0:c44f0314d6ec 48 //
frankvnk 0:c44f0314d6ec 49 //! hci_command_send
frankvnk 0:c44f0314d6ec 50 //!
frankvnk 0:c44f0314d6ec 51 //! @param usOpcode command operation code
frankvnk 0:c44f0314d6ec 52 //! @param pucBuff pointer to the command's arguments buffer
frankvnk 0:c44f0314d6ec 53 //! @param ucArgsLength length of the arguments
frankvnk 0:c44f0314d6ec 54 //!
frankvnk 0:c44f0314d6ec 55 //! @return none
frankvnk 0:c44f0314d6ec 56 //!
frankvnk 0:c44f0314d6ec 57 //! @brief Initiate an HCI command.
frankvnk 0:c44f0314d6ec 58 //
frankvnk 0:c44f0314d6ec 59 //*****************************************************************************
frankvnk 1:bbcaf0b2f367 60 unsigned short hci_command_send(unsigned short usOpcode, unsigned char *pucBuff, unsigned char ucArgsLength)
frankvnk 0:c44f0314d6ec 61 {
frankvnk 0:c44f0314d6ec 62 unsigned char *stream;
frankvnk 0:c44f0314d6ec 63
frankvnk 0:c44f0314d6ec 64 stream = (pucBuff + SPI_HEADER_SIZE);
frankvnk 0:c44f0314d6ec 65
frankvnk 0:c44f0314d6ec 66 UINT8_TO_STREAM(stream, HCI_TYPE_CMND);
frankvnk 0:c44f0314d6ec 67 stream = UINT16_TO_STREAM(stream, usOpcode);
frankvnk 0:c44f0314d6ec 68 UINT8_TO_STREAM(stream, ucArgsLength);
frankvnk 0:c44f0314d6ec 69 //Update the opcode of the event we will be waiting for
frankvnk 0:c44f0314d6ec 70 SpiWrite(pucBuff, ucArgsLength + SIMPLE_LINK_HCI_CMND_HEADER_SIZE);
frankvnk 2:f1d50c7f8bdb 71
frankvnk 0:c44f0314d6ec 72 return(0);
frankvnk 0:c44f0314d6ec 73 }
frankvnk 0:c44f0314d6ec 74
frankvnk 0:c44f0314d6ec 75 //*****************************************************************************
frankvnk 0:c44f0314d6ec 76 //
frankvnk 0:c44f0314d6ec 77 //! hci_data_send
frankvnk 0:c44f0314d6ec 78 //!
frankvnk 0:c44f0314d6ec 79 //! @param usOpcode command operation code
frankvnk 1:bbcaf0b2f367 80 //! @param ucArgs pointer to the command's arguments buffer
frankvnk 0:c44f0314d6ec 81 //! @param usArgsLength length of the arguments
frankvnk 0:c44f0314d6ec 82 //! @param ucTail pointer to the data buffer
frankvnk 0:c44f0314d6ec 83 //! @param usTailLength buffer length
frankvnk 0:c44f0314d6ec 84 //!
frankvnk 0:c44f0314d6ec 85 //! @return none
frankvnk 0:c44f0314d6ec 86 //!
frankvnk 0:c44f0314d6ec 87 //! @brief Initiate an HCI data write operation
frankvnk 0:c44f0314d6ec 88 //
frankvnk 0:c44f0314d6ec 89 //*****************************************************************************
frankvnk 1:bbcaf0b2f367 90 long hci_data_send(unsigned char ucOpcode,
frankvnk 1:bbcaf0b2f367 91 unsigned char *ucArgs,
frankvnk 1:bbcaf0b2f367 92 unsigned short usArgsLength,
frankvnk 1:bbcaf0b2f367 93 unsigned short usDataLength,
frankvnk 1:bbcaf0b2f367 94 const unsigned char *ucTail,
frankvnk 1:bbcaf0b2f367 95 unsigned short usTailLength)
frankvnk 0:c44f0314d6ec 96 {
frankvnk 0:c44f0314d6ec 97 unsigned char *stream;
frankvnk 0:c44f0314d6ec 98
frankvnk 0:c44f0314d6ec 99 stream = ((ucArgs) + SPI_HEADER_SIZE);
frankvnk 0:c44f0314d6ec 100
frankvnk 0:c44f0314d6ec 101 UINT8_TO_STREAM(stream, HCI_TYPE_DATA);
frankvnk 0:c44f0314d6ec 102 UINT8_TO_STREAM(stream, ucOpcode);
frankvnk 0:c44f0314d6ec 103 UINT8_TO_STREAM(stream, usArgsLength);
frankvnk 0:c44f0314d6ec 104 stream = UINT16_TO_STREAM(stream, usArgsLength + usDataLength + usTailLength);
frankvnk 0:c44f0314d6ec 105
frankvnk 0:c44f0314d6ec 106 // Send the packet over the SPI
frankvnk 0:c44f0314d6ec 107 SpiWrite(ucArgs, SIMPLE_LINK_HCI_DATA_HEADER_SIZE + usArgsLength + usDataLength + usTailLength);
frankvnk 0:c44f0314d6ec 108
frankvnk 0:c44f0314d6ec 109 return(ESUCCESS);
frankvnk 0:c44f0314d6ec 110 }
frankvnk 0:c44f0314d6ec 111
frankvnk 0:c44f0314d6ec 112
frankvnk 0:c44f0314d6ec 113 //*****************************************************************************
frankvnk 0:c44f0314d6ec 114 //
frankvnk 0:c44f0314d6ec 115 //! hci_data_command_send
frankvnk 0:c44f0314d6ec 116 //!
frankvnk 0:c44f0314d6ec 117 //! @param usOpcode command operation code
frankvnk 0:c44f0314d6ec 118 //! @param pucBuff pointer to the data buffer
frankvnk 0:c44f0314d6ec 119 //! @param ucArgsLength arguments length
frankvnk 0:c44f0314d6ec 120 //! @param ucDataLength data length
frankvnk 0:c44f0314d6ec 121 //!
frankvnk 0:c44f0314d6ec 122 //! @return none
frankvnk 0:c44f0314d6ec 123 //!
frankvnk 0:c44f0314d6ec 124 //! @brief Prepeare HCI header and initiate an HCI data write operation
frankvnk 0:c44f0314d6ec 125 //
frankvnk 0:c44f0314d6ec 126 //*****************************************************************************
frankvnk 1:bbcaf0b2f367 127 void hci_data_command_send(unsigned short usOpcode,
frankvnk 1:bbcaf0b2f367 128 unsigned char *pucBuff,
frankvnk 1:bbcaf0b2f367 129 unsigned char ucArgsLength,
frankvnk 1:bbcaf0b2f367 130 unsigned short ucDataLength)
frankvnk 0:c44f0314d6ec 131 {
frankvnk 0:c44f0314d6ec 132 unsigned char *stream = (pucBuff + SPI_HEADER_SIZE);
frankvnk 0:c44f0314d6ec 133
frankvnk 0:c44f0314d6ec 134 UINT8_TO_STREAM(stream, HCI_TYPE_DATA);
frankvnk 0:c44f0314d6ec 135 UINT8_TO_STREAM(stream, usOpcode);
frankvnk 0:c44f0314d6ec 136 UINT8_TO_STREAM(stream, ucArgsLength);
frankvnk 0:c44f0314d6ec 137 stream = UINT16_TO_STREAM(stream, ucArgsLength + ucDataLength);
frankvnk 0:c44f0314d6ec 138
frankvnk 0:c44f0314d6ec 139 // Send the command over SPI on data channel
frankvnk 0:c44f0314d6ec 140 SpiWrite(pucBuff, ucArgsLength + ucDataLength + SIMPLE_LINK_HCI_DATA_CMND_HEADER_SIZE);
frankvnk 0:c44f0314d6ec 141
frankvnk 0:c44f0314d6ec 142 return;
frankvnk 0:c44f0314d6ec 143 }
frankvnk 0:c44f0314d6ec 144
frankvnk 0:c44f0314d6ec 145 //*****************************************************************************
frankvnk 0:c44f0314d6ec 146 //
frankvnk 0:c44f0314d6ec 147 //! hci_patch_send
frankvnk 0:c44f0314d6ec 148 //!
frankvnk 0:c44f0314d6ec 149 //! @param usOpcode command operation code
frankvnk 0:c44f0314d6ec 150 //! @param pucBuff pointer to the command's arguments buffer
frankvnk 0:c44f0314d6ec 151 //! @param patch pointer to patch content buffer
frankvnk 0:c44f0314d6ec 152 //! @param usDataLength data length
frankvnk 0:c44f0314d6ec 153 //!
frankvnk 0:c44f0314d6ec 154 //! @return none
frankvnk 0:c44f0314d6ec 155 //!
frankvnk 0:c44f0314d6ec 156 //! @brief Prepeare HCI header and initiate an HCI patch write operation
frankvnk 0:c44f0314d6ec 157 //
frankvnk 0:c44f0314d6ec 158 //*****************************************************************************
frankvnk 1:bbcaf0b2f367 159 void hci_patch_send(unsigned char ucOpcode,
frankvnk 1:bbcaf0b2f367 160 unsigned char *pucBuff,
frankvnk 1:bbcaf0b2f367 161 char *patch,
frankvnk 1:bbcaf0b2f367 162 unsigned short usDataLength)
frankvnk 0:c44f0314d6ec 163 {
frankvnk 1:bbcaf0b2f367 164 unsigned char *data_ptr = (pucBuff + SPI_HEADER_SIZE);
frankvnk 0:c44f0314d6ec 165 unsigned short usTransLength;
frankvnk 0:c44f0314d6ec 166 unsigned char *stream = (pucBuff + SPI_HEADER_SIZE);
frankvnk 2:f1d50c7f8bdb 167
frankvnk 0:c44f0314d6ec 168 UINT8_TO_STREAM(stream, HCI_TYPE_PATCH);
frankvnk 0:c44f0314d6ec 169 UINT8_TO_STREAM(stream, ucOpcode);
frankvnk 0:c44f0314d6ec 170 stream = UINT16_TO_STREAM(stream, usDataLength + SIMPLE_LINK_HCI_PATCH_HEADER_SIZE);
frankvnk 0:c44f0314d6ec 171 if (usDataLength <= SL_PATCH_PORTION_SIZE)
frankvnk 0:c44f0314d6ec 172 {
frankvnk 0:c44f0314d6ec 173 UINT16_TO_STREAM(stream, usDataLength);
frankvnk 0:c44f0314d6ec 174 stream = UINT16_TO_STREAM(stream, usDataLength);
frankvnk 0:c44f0314d6ec 175 memcpy((pucBuff + SPI_HEADER_SIZE) + HCI_PATCH_HEADER_SIZE, patch, usDataLength);
frankvnk 0:c44f0314d6ec 176 // Update the opcode of the event we will be waiting for
frankvnk 0:c44f0314d6ec 177 SpiWrite(pucBuff, usDataLength + HCI_PATCH_HEADER_SIZE);
frankvnk 0:c44f0314d6ec 178 }
frankvnk 0:c44f0314d6ec 179 else
frankvnk 0:c44f0314d6ec 180 {
frankvnk 0:c44f0314d6ec 181
frankvnk 0:c44f0314d6ec 182 usTransLength = (usDataLength/SL_PATCH_PORTION_SIZE);
frankvnk 0:c44f0314d6ec 183 UINT16_TO_STREAM(stream, usDataLength + SIMPLE_LINK_HCI_PATCH_HEADER_SIZE + usTransLength*SIMPLE_LINK_HCI_PATCH_HEADER_SIZE);
frankvnk 0:c44f0314d6ec 184 stream = UINT16_TO_STREAM(stream, SL_PATCH_PORTION_SIZE);
frankvnk 0:c44f0314d6ec 185 memcpy(pucBuff + SPI_HEADER_SIZE + HCI_PATCH_HEADER_SIZE, patch, SL_PATCH_PORTION_SIZE);
frankvnk 0:c44f0314d6ec 186 usDataLength -= SL_PATCH_PORTION_SIZE;
frankvnk 0:c44f0314d6ec 187 patch += SL_PATCH_PORTION_SIZE;
frankvnk 0:c44f0314d6ec 188
frankvnk 0:c44f0314d6ec 189 // Update the opcode of the event we will be waiting for
frankvnk 0:c44f0314d6ec 190 SpiWrite(pucBuff, SL_PATCH_PORTION_SIZE + HCI_PATCH_HEADER_SIZE);
frankvnk 0:c44f0314d6ec 191
frankvnk 0:c44f0314d6ec 192 while (usDataLength)
frankvnk 0:c44f0314d6ec 193 {
frankvnk 0:c44f0314d6ec 194 if (usDataLength <= SL_PATCH_PORTION_SIZE)
frankvnk 0:c44f0314d6ec 195 {
frankvnk 0:c44f0314d6ec 196 usTransLength = usDataLength;
frankvnk 0:c44f0314d6ec 197 usDataLength = 0;
frankvnk 0:c44f0314d6ec 198
frankvnk 0:c44f0314d6ec 199 }
frankvnk 0:c44f0314d6ec 200 else
frankvnk 0:c44f0314d6ec 201 {
frankvnk 0:c44f0314d6ec 202 usTransLength = SL_PATCH_PORTION_SIZE;
frankvnk 0:c44f0314d6ec 203 usDataLength -= usTransLength;
frankvnk 0:c44f0314d6ec 204 }
frankvnk 0:c44f0314d6ec 205
frankvnk 0:c44f0314d6ec 206 *(unsigned short *)data_ptr = usTransLength;
frankvnk 0:c44f0314d6ec 207 memcpy(data_ptr + SIMPLE_LINK_HCI_PATCH_HEADER_SIZE, patch, usTransLength);
frankvnk 0:c44f0314d6ec 208 patch += usTransLength;
frankvnk 0:c44f0314d6ec 209
frankvnk 0:c44f0314d6ec 210 // Update the opcode of the event we will be waiting for
frankvnk 0:c44f0314d6ec 211 SpiWrite((unsigned char *)data_ptr, usTransLength + sizeof(usTransLength));
frankvnk 0:c44f0314d6ec 212 }
frankvnk 0:c44f0314d6ec 213 }
frankvnk 0:c44f0314d6ec 214 }
frankvnk 0:c44f0314d6ec 215
frankvnk 0:c44f0314d6ec 216 //*****************************************************************************
frankvnk 0:c44f0314d6ec 217 //
frankvnk 0:c44f0314d6ec 218 // Close the Doxygen group.
frankvnk 0:c44f0314d6ec 219 //! @}
frankvnk 0:c44f0314d6ec 220 //
frankvnk 0:c44f0314d6ec 221 //
frankvnk 0:c44f0314d6ec 222 //*****************************************************************************
frankvnk 0:c44f0314d6ec 223
frankvnk 0:c44f0314d6ec 224