Frank Vannieuwkerke / 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):
# 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

Diff: cc3000_common.h

Revision:
1:bbcaf0b2f367
Parent:
0:c44f0314d6ec
Child:
4:d8255a5aad46
--- a/cc3000_common.h	Fri Jun 28 17:48:37 2013 +0000
+++ b/cc3000_common.h	Thu Jul 04 08:10:21 2013 +0000
@@ -68,20 +68,17 @@
 
 #define HCI_CC_PAYLOAD_LEN      5
 
-#define WLAN_ENABLE      (1)   
-#define WLAN_DISABLE     (0)
+#define WLAN_ENABLE            (1)   
+#define WLAN_DISABLE           (0)
 
-
-#define    MAC_ADDR_LEN    (6)
+#define MAC_ADDR_LEN           (6)
 
 
 
 /*Defines for minimal and maximal RX buffer size. This size includes the spi 
   header and hci header.
-  The maximal buffer size derives from:
-    MTU + HCI header + SPI header + sendto() agrs size
-  The minimum buffer size derives from:
-    HCI header + SPI header + max args size
+  maximal buffer size: MTU + HCI header + SPI header + sendto() args size
+  minimum buffer size: HCI header + SPI header + max args size
 
   This buffer is used for receiving events and data.
   The packet can not be longer than MTU size and CC3000 does not support 
@@ -89,18 +86,15 @@
   and events from CC3000. That is why the minimum is defined. 
   The calculation for the actual size of buffer for reception is:
   Given the maximal data size MAX_DATA that is expected to be received by
-  application, the required buffer is:
-  Using recv() or recvfrom():
+  application, the required buffer Using recv() or recvfrom():
  
-    max(CC3000_MINIMAL_RX_SIZE, MAX_DATA + HEADERS_SIZE_DATA + fromlen
-    + ucArgsize + 1)
+    max(CC3000_MINIMAL_RX_SIZE, MAX_DATA + HEADERS_SIZE_DATA + fromlen + ucArgsize + 1)
  
-  Using gethostbyname() with minimal buffer size will limit the host name
-  returned to 99 bytes only.
+  Using gethostbyname() with minimal buffer size will limit the host name returned to 99 bytes.
   The 1 is used for the overrun detection 
 */
 
-#define CC3000_MINIMAL_RX_SIZE      (118+1)
+#define CC3000_MINIMAL_RX_SIZE      (118 + 1)
 #define CC3000_MAXIMAL_RX_SIZE      (1519 + 1)
 
 /*Defines for minimal and maximal TX buffer size.
@@ -125,7 +119,7 @@
 #define  CC3000_MINIMAL_TX_SIZE      (118 + 1) 
 #define CC3000_MAXIMAL_TX_SIZE      (1519 + 1)
 
-//TX and RX buffer sizes - allow to receive and transmit maximum data at lengh 8.
+//TX and RX buffer size - allow to receive and transmit maximum data at lengh 8.
 #ifdef CC3000_TINY_DRIVER
 #define TINY_CC3000_MAXIMAL_RX_SIZE 44
 #define TINY_CC3000_MAXIMAL_TX_SIZE 59
@@ -135,31 +129,24 @@
   change CC3000_MAXIMAL_RX_SIZE and CC3000_MAXIMAL_TX_SIZE to a value between
   the minimal and maximal specified above. 
   Note that the buffers are allocated by SPI.
-  In case you change the size of those buffers, you might need also to change
-  the linker file, since for example on MSP430 FRAM devices the buffers are
-  allocated in the FRAM section that is allocated manually and not by IDE.
 */
   
 #ifndef CC3000_TINY_DRIVER
   
     #define CC3000_RX_BUFFER_SIZE   (CC3000_MAXIMAL_RX_SIZE)
     #define CC3000_TX_BUFFER_SIZE   (CC3000_MAXIMAL_TX_SIZE)
-    #define    SP_PORTION_SIZE            512
+    #define SP_PORTION_SIZE         512
   
-//if defined TINY DRIVER we use smaller rx and tx buffer in order to minimize RAM consumption
+//TINY DRIVER: We use smaller rx and tx buffers in order to minimize RAM consumption
 #else
     #define CC3000_RX_BUFFER_SIZE   (TINY_CC3000_MAXIMAL_RX_SIZE)
     #define CC3000_TX_BUFFER_SIZE   (TINY_CC3000_MAXIMAL_TX_SIZE)
-    #define    SP_PORTION_SIZE         32
+    #define SP_PORTION_SIZE         32
 
 #endif  
 //*****************************************************************************
 //                  Compound Types
 //*****************************************************************************
-//typedef long time_t;
-//typedef unsigned long clock_t;
-//typedef long suseconds_t;
-
 typedef struct timeval timeval;
 
 struct timeval 
@@ -186,30 +173,26 @@
 
 typedef struct
 {
-    unsigned short     usRxEventOpcode;
-    unsigned short     usEventOrDataReceived;
-    unsigned char     *pucReceivedData;
-    unsigned char     *pucTxCommandBuffer;
-
-    tFWPatches             sFWPatches;
-    tDriverPatches         sDriverPatches;
-    tBootLoaderPatches     sBootLoaderPatches;
-    tWlanCB                 sWlanCB;
+    unsigned short        usRxEventOpcode;
+    unsigned short        usEventOrDataReceived;
+    unsigned char         *pucReceivedData;
+    unsigned char         *pucTxCommandBuffer;
+    tFWPatches            sFWPatches;
+    tDriverPatches        sDriverPatches;
+    tBootLoaderPatches    sBootLoaderPatches;
+    tWlanCB               sWlanCB;
     tWlanReadInteruptPin  ReadWlanInterruptPin;
     tWlanInterruptEnable  WlanInterruptEnable;
     tWlanInterruptDisable WlanInterruptDisable;
     tWriteWlanPin         WriteWlanPin;
-
-    signed long         slTransmitDataError;
-    unsigned short     usNumberOfFreeBuffers;
-    unsigned short     usSlBufferLength;
-    unsigned short     usBufferSize;
-    unsigned short     usRxDataPending;
-
-    unsigned long    NumberOfSentPackets;
-    unsigned long    NumberOfReleasedPackets;
-
-    unsigned char     InformHostOnTxComplete;
+    signed long           slTransmitDataError;
+    unsigned short        usNumberOfFreeBuffers;
+    unsigned short        usSlBufferLength;
+    unsigned short        usBufferSize;
+    unsigned short        usRxDataPending;
+    unsigned long         NumberOfSentPackets;
+    unsigned long         NumberOfReleasedPackets;
+    unsigned char         InformHostOnTxComplete;
 }sSimplLinkInformation;
 
 extern volatile sSimplLinkInformation tSLInformation;
@@ -243,13 +226,12 @@
 //!
 //!  @param  pBuf       data buffer
 //!  @param  from       from information
-//!  @param  fromlen      from information length
-//!
-//!  @return               none
+//!  @param  fromlen    from information length
 //!
-//!  @brief                Wait for data, pass it to the hci_event_handler
-//!                        and update in a global variable that there is 
-//!                           data to read.
+//!  @return            none
+//!
+//!  @brief             Wait for data, pass it to the hci_event_handler and
+//!                     update in a global variable that there is data to read.
 //
 //*****************************************************************************
 
@@ -262,10 +244,10 @@
 //!  \param  p       pointer to the new stream
 //!  \param  u32     pointer to the 32 bit
 //!
-//!  \return               pointer to the new stream
+//!  \return         pointer to the new stream
 //!
-//!  \brief                This function is used for copying 32 bit to stream
-//!                           while converting to little endian format.
+//!  \brief          This function is used for copying 32 bit to stream
+//!                  while converting to little endian format.
 //
 //*****************************************************************************
 
@@ -278,10 +260,10 @@
 //!  \param  p       pointer to the new stream
 //!  \param  u32     pointer to the 16 bit
 //!
-//!  \return               pointer to the new stream
+//!  \return         pointer to the new stream
 //!
-//!  \brief               This function is used for copying 16 bit to stream 
-//!                       while converting to little endian format.
+//!  \brief         This function is used for copying 16 bit to stream 
+//!                 while converting to little endian format.
 //
 //*****************************************************************************
 
@@ -294,10 +276,10 @@
 //!  \param  p          pointer to the stream
 //!  \param  offset     offset in the stream
 //!
-//!  \return               pointer to the new 16 bit
+//!  \return            pointer to the new 16 bit
 //!
-//!  \brief               This function is used for copying received stream to 
-//!                       16 bit in little endian format.
+//!  \brief             This function is used for copying received stream to 
+//!                     16 bit in little endian format.
 //
 //*****************************************************************************
 
@@ -310,10 +292,10 @@
 //!  \param  p          pointer to the stream
 //!  \param  offset     offset in the stream
 //!
-//!  \return               pointer to the new 32 bit
+//!  \return            pointer to the new 32 bit
 //!
-//!  \brief               This function is used for copying received stream to
-//!                       32 bit in little endian format.
+//!  \brief             This function is used for copying received stream to
+//!                     32 bit in little endian format.
 //
 //*****************************************************************************