CC3000_Hostdriver - Driver for CC3000 Wi-Fi module

Users » frankvnk » Code » 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):

# bytes	Description	Info
1	First time config parameter	Useful when connecting
2	Firmware updater version	used with the Firmware update tool
2	Service Pack version	used with the Firmware update tool
3	Driver Version	used with the Firmware update tool
3	Firmware Version	used with the Firmware update tool
1	CIK validation (Client Interface Key)
40	CIK 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:: 4:d8255a5aad46
Parent:: 1:bbcaf0b2f367
Child:: 5:854f9b13a0f9

--- a/cc3000_common.h	Sat Jul 13 13:12:46 2013 +0000
+++ b/cc3000_common.h	Mon Jul 15 14:19:46 2013 +0000
@@ -35,21 +35,12 @@
 #ifndef __COMMON_H__
 #define __COMMON_H__
 
-//******************************************************************************
-// Include files
-//******************************************************************************
-//#include "mbed.h"
 #include <errno.h>
 
 /** CC3000 Host driver - common
 *
 */
-//*****************************************************************************
-//
-// If building with a C++ compiler, make all of the definitions in this header
-// have a C binding.
-//
-//*****************************************************************************
+
 #ifdef  __cplusplus
 extern "C" {
 #endif
@@ -116,7 +107,7 @@
  
   The 1 is used for the overrun detection */ 
 
-#define  CC3000_MINIMAL_TX_SIZE      (118 + 1) 
+#define CC3000_MINIMAL_TX_SIZE      (118 + 1) 
 #define CC3000_MAXIMAL_TX_SIZE      (1519 + 1)
 
 //TX and RX buffer size - allow to receive and transmit maximum data at lengh 8.
@@ -151,24 +142,17 @@
 
 struct timeval 
 {
-    long         tv_sec;                  /* seconds */
-    long         tv_usec;                 /* microseconds */
+    long tv_sec;       /* seconds */
+    long tv_usec;      /* microseconds */
 };
 
 typedef char *(*tFWPatches)(unsigned long *usLength);
-
 typedef char *(*tDriverPatches)(unsigned long *usLength);
-
 typedef char *(*tBootLoaderPatches)(unsigned long *usLength);
-
 typedef void (*tWlanCB)(long event_type, char * data, unsigned char length );
-
 typedef long (*tWlanReadInteruptPin)(void);
-
 typedef void (*tWlanInterruptEnable)(void);
-
 typedef void (*tWlanInterruptDisable)(void);
-
 typedef void (*tWriteWlanPin)(unsigned char val);
 
 typedef struct
@@ -202,103 +186,53 @@
 // Prototypes for the APIs.
 //*****************************************************************************
 
-
-
-//*****************************************************************************
-//
-//!  SimpleLinkWaitEvent
-//!
-//!  @param  usOpcode      command operation code
-//!  @param  pRetParams    command return parameters
-//!
-//!  @return               none
-//!
-//!  @brief                Wait for event, pass it to the hci_event_handler and
-//!                        update the event opcode in a global variable.
-//
-//*****************************************************************************
-
+/**
+* Wait for event, pass it to the hci_event_handler and update the event opcode in a global variable.
+* @param  usOpcode      command operation code
+* @param  pRetParams    command return parameters
+* @return               none
+*/
 extern void SimpleLinkWaitEvent(unsigned short usOpcode, void *pRetParams);
 
-//*****************************************************************************
-//
-//!  SimpleLinkWaitData
-//!
-//!  @param  pBuf       data buffer
-//!  @param  from       from information
-//!  @param  fromlen    from information length
-//!
-//!  @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.
-//
-//*****************************************************************************
-
+/**
+* Wait for data, pass it to the hci_event_handler and update in a global variable that there is data to read.
+* @param  pBuf       data buffer
+* @param  from       from information
+* @param  fromlen    from information length
+* @return            none
+*/
 extern void SimpleLinkWaitData(unsigned char *pBuf, unsigned char *from, unsigned char *fromlen);
 
-//*****************************************************************************
-//
-//!  UINT32_TO_STREAM_f
-//!
-//!  \param  p       pointer to the new stream
-//!  \param  u32     pointer to the 32 bit
-//!
-//!  \return         pointer to the new stream
-//!
-//!  \brief          This function is used for copying 32 bit to stream
-//!                  while converting to little endian format.
-//
-//*****************************************************************************
-
+/**
+* Copy 32 bit to stream while converting to little endian format.
+* @param  p       pointer to the new stream
+* @param  u32     pointer to the 32 bit
+* @return         pointer to the new stream
+*/
 extern unsigned char* UINT32_TO_STREAM_f (unsigned char *p, unsigned long u32);
 
-//*****************************************************************************
-//
-//!  UINT16_TO_STREAM_f
-//!
-//!  \param  p       pointer to the new stream
-//!  \param  u32     pointer to the 16 bit
-//!
-//!  \return         pointer to the new stream
-//!
-//!  \brief         This function is used for copying 16 bit to stream 
-//!                 while converting to little endian format.
-//
-//*****************************************************************************
-
+/**
+* Copy 16 bit to stream while converting to little endian format.
+* @param  p       pointer to the new stream
+* @param  u32     pointer to the 16 bit
+* @return         pointer to the new stream
+*/
 extern unsigned char* UINT16_TO_STREAM_f (unsigned char *p, unsigned short u16);
 
-//*****************************************************************************
-//
-//!  STREAM_TO_UINT16_f
-//!
-//!  \param  p          pointer to the stream
-//!  \param  offset     offset in the stream
-//!
-//!  \return            pointer to the new 16 bit
-//!
-//!  \brief             This function is used for copying received stream to 
-//!                     16 bit in little endian format.
-//
-//*****************************************************************************
-
+/**
+* Copy received stream to 16 bit in little endian format.
+* @param  p          pointer to the stream
+* @param  offset     offset in the stream
+* @return            pointer to the new 16 bit
+*/
 extern unsigned short STREAM_TO_UINT16_f(char* p, unsigned short offset);
 
-//*****************************************************************************
-//
-//!  STREAM_TO_UINT32_f
-//!
-//!  \param  p          pointer to the stream
-//!  \param  offset     offset in the stream
-//!
-//!  \return            pointer to the new 32 bit
-//!
-//!  \brief             This function is used for copying received stream to
-//!                     32 bit in little endian format.
-//
-//*****************************************************************************
-
+/**
+* Copy received stream to 32 bit in little endian format.
+* @param  p          pointer to the stream
+* @param  offset     offset in the stream
+* @return            pointer to the new 32 bit
+*/
 extern unsigned long STREAM_TO_UINT32_f(char* p, unsigned short offset);
 
 
@@ -307,30 +241,22 @@
 //*****************************************************************************
 
 
-//This macro is used for copying 8 bit to stream while converting to little endian format.
+//Copy 8 bit to stream while converting to little endian format.
 #define UINT8_TO_STREAM(_p, _val)    {*(_p)++ = (_val);}
-//This macro is used for copying 16 bit to stream while converting to little endian format.
+//Copy 16 bit to stream while converting to little endian format.
 #define UINT16_TO_STREAM(_p, _u16)    (UINT16_TO_STREAM_f(_p, _u16))
-//This macro is used for copying 32 bit to stream while converting to little endian format.
+//Copy 32 bit to stream while converting to little endian format.
 #define UINT32_TO_STREAM(_p, _u32)    (UINT32_TO_STREAM_f(_p, _u32))
-//This macro is used for copying a specified value length bits (l) to stream while converting to little endian format.
+//Copy a specified value length bits (l) to stream while converting to little endian format.
 #define ARRAY_TO_STREAM(p, a, l)     {register short _i; for (_i = 0; _i < l; _i++) *(p)++ = ((unsigned char *) a)[_i];}
-//This macro is used for copying received stream to 8 bit in little endian format.
+//Copy received stream to 8 bit in little endian format.
 #define STREAM_TO_UINT8(_p, _offset, _u8)    {_u8 = (unsigned char)(*(_p + _offset));}
-//This macro is used for copying received stream to 16 bit in little endian format.
+//Copy received stream to 16 bit in little endian format.
 #define STREAM_TO_UINT16(_p, _offset, _u16)    {_u16 = STREAM_TO_UINT16_f(_p, _offset);}
-//This macro is used for copying received stream to 32 bit in little endian format.
+//Copy received stream to 32 bit in little endian format.
 #define STREAM_TO_UINT32(_p, _offset, _u32)    {_u32 = STREAM_TO_UINT32_f(_p, _offset);}
 #define STREAM_TO_STREAM(p, a, l)     {register short _i; for (_i = 0; _i < l; _i++) *(a)++= ((unsigned char *) p)[_i];}
 
-
-
-
-//*****************************************************************************
-//
-// Mark the end of the C bindings section for C++ compilers.
-//
-//*****************************************************************************
 #ifdef  __cplusplus
 }
 #endif // __cplusplus

Repository toolbox

Export to desktop IDE

Repository details

Type:	Library
Created:	28 Jun 2013
Imports:	120
Forks:	0
Commits:	14
Dependents:	2
Dependencies:	1
Followers:	9
Issues:	0

The code in this repository is Apache licensed.

Components

SimpleLink Wi-Fi CC3000