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:
Fri Jun 28 17:48:37 2013 +0000
Revision:
0:c44f0314d6ec
Child:
4:d8255a5aad46
Initial release

Who changed what in which revision?

UserRevisionLine numberNew contents of line
frankvnk 0:c44f0314d6ec 1 /*****************************************************************************
frankvnk 0:c44f0314d6ec 2 *
frankvnk 0:c44f0314d6ec 3 * evnt_handler.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 __EVENT_HANDLER_H__
frankvnk 0:c44f0314d6ec 36 #define __EVENT_HANDLER_H__
frankvnk 0:c44f0314d6ec 37
frankvnk 0:c44f0314d6ec 38 //#include "mbed.h"
frankvnk 0:c44f0314d6ec 39 #include "cc3000_common.h"
frankvnk 0:c44f0314d6ec 40 #include "hci.h"
frankvnk 0:c44f0314d6ec 41 #include "wlan.h"
frankvnk 0:c44f0314d6ec 42 #include "socket.h"
frankvnk 0:c44f0314d6ec 43 #include "netapp.h"
frankvnk 0:c44f0314d6ec 44 #include "CC3000_spi.h"
frankvnk 0:c44f0314d6ec 45
frankvnk 0:c44f0314d6ec 46 /** CC3000 Host driver - event handler
frankvnk 0:c44f0314d6ec 47 *
frankvnk 0:c44f0314d6ec 48 */
frankvnk 0:c44f0314d6ec 49 //*****************************************************************************
frankvnk 0:c44f0314d6ec 50 //
frankvnk 0:c44f0314d6ec 51 // If building with a C++ compiler, make all of the definitions in this header
frankvnk 0:c44f0314d6ec 52 // have a C binding.
frankvnk 0:c44f0314d6ec 53 //
frankvnk 0:c44f0314d6ec 54 //*****************************************************************************
frankvnk 0:c44f0314d6ec 55 #ifdef __cplusplus
frankvnk 0:c44f0314d6ec 56 extern "C" {
frankvnk 0:c44f0314d6ec 57 #endif
frankvnk 0:c44f0314d6ec 58
frankvnk 0:c44f0314d6ec 59 //*****************************************************************************
frankvnk 0:c44f0314d6ec 60 //
frankvnk 0:c44f0314d6ec 61 // Prototypes for the APIs.
frankvnk 0:c44f0314d6ec 62 //
frankvnk 0:c44f0314d6ec 63 //*****************************************************************************
frankvnk 0:c44f0314d6ec 64
frankvnk 0:c44f0314d6ec 65 //*****************************************************************************
frankvnk 0:c44f0314d6ec 66 //
frankvnk 0:c44f0314d6ec 67 //! hci_event_handler
frankvnk 0:c44f0314d6ec 68 //!
frankvnk 0:c44f0314d6ec 69 //! @param pRetParams incoming data buffer
frankvnk 0:c44f0314d6ec 70 //! @param from from information (in case of data received)
frankvnk 0:c44f0314d6ec 71 //! @param fromlen from information length (in case of data received)
frankvnk 0:c44f0314d6ec 72 //!
frankvnk 0:c44f0314d6ec 73 //! @return none
frankvnk 0:c44f0314d6ec 74 //!
frankvnk 0:c44f0314d6ec 75 //! @brief Parse the incoming events packets and issues corresponding
frankvnk 0:c44f0314d6ec 76 //! event handler from global array of handlers pointers
frankvnk 0:c44f0314d6ec 77 //
frankvnk 0:c44f0314d6ec 78 //*****************************************************************************
frankvnk 0:c44f0314d6ec 79 extern unsigned char *hci_event_handler(void *pRetParams, unsigned char *from, unsigned char *fromlen);
frankvnk 0:c44f0314d6ec 80
frankvnk 0:c44f0314d6ec 81 //*****************************************************************************
frankvnk 0:c44f0314d6ec 82 //
frankvnk 0:c44f0314d6ec 83 //! hci_unsol_event_handler
frankvnk 0:c44f0314d6ec 84 //!
frankvnk 0:c44f0314d6ec 85 //! @param event_hdr event header
frankvnk 0:c44f0314d6ec 86 //!
frankvnk 0:c44f0314d6ec 87 //! @return 1 if event supported and handled
frankvnk 0:c44f0314d6ec 88 //! 0 if event is not supported
frankvnk 0:c44f0314d6ec 89 //!
frankvnk 0:c44f0314d6ec 90 //! @brief Handle unsolicited events
frankvnk 0:c44f0314d6ec 91 //
frankvnk 0:c44f0314d6ec 92 //*****************************************************************************
frankvnk 0:c44f0314d6ec 93 extern long hci_unsol_event_handler(char *event_hdr);
frankvnk 0:c44f0314d6ec 94
frankvnk 0:c44f0314d6ec 95 //*****************************************************************************
frankvnk 0:c44f0314d6ec 96 //
frankvnk 0:c44f0314d6ec 97 //! hci_unsolicited_event_handler
frankvnk 0:c44f0314d6ec 98 //!
frankvnk 0:c44f0314d6ec 99 //! @param None
frankvnk 0:c44f0314d6ec 100 //!
frankvnk 0:c44f0314d6ec 101 //! @return ESUCCESS if successful, EFAIL if an error occurred
frankvnk 0:c44f0314d6ec 102 //!
frankvnk 0:c44f0314d6ec 103 //! @brief Parse the incoming unsolicited event packets and issues
frankvnk 0:c44f0314d6ec 104 //! corresponding event handler.
frankvnk 0:c44f0314d6ec 105 //
frankvnk 0:c44f0314d6ec 106 //*****************************************************************************
frankvnk 0:c44f0314d6ec 107 extern long hci_unsolicited_event_handler(void);
frankvnk 0:c44f0314d6ec 108
frankvnk 0:c44f0314d6ec 109 #define M_BSD_RESP_PARAMS_OFFSET(hci_event_hdr)((char *)(hci_event_hdr) + HCI_EVENT_HEADER_SIZE)
frankvnk 0:c44f0314d6ec 110
frankvnk 0:c44f0314d6ec 111 #define SOCKET_STATUS_ACTIVE 0
frankvnk 0:c44f0314d6ec 112 #define SOCKET_STATUS_INACTIVE 1
frankvnk 0:c44f0314d6ec 113 /* Init socket_active_status = 'all ones': init all sockets with SOCKET_STATUS_INACTIVE.
frankvnk 0:c44f0314d6ec 114 Will be changed by 'set_socket_active_status' upon 'connect' and 'accept' calls */
frankvnk 0:c44f0314d6ec 115 #define SOCKET_STATUS_INIT_VAL 0xFFFF
frankvnk 0:c44f0314d6ec 116 #define M_IS_VALID_SD(sd) ((0 <= (sd)) && ((sd) <= 7))
frankvnk 0:c44f0314d6ec 117 #define M_IS_VALID_STATUS(status) (((status) == SOCKET_STATUS_ACTIVE)||((status) == SOCKET_STATUS_INACTIVE))
frankvnk 0:c44f0314d6ec 118
frankvnk 0:c44f0314d6ec 119 extern unsigned long socket_active_status;
frankvnk 0:c44f0314d6ec 120
frankvnk 0:c44f0314d6ec 121 extern void set_socket_active_status(long Sd, long Status);
frankvnk 0:c44f0314d6ec 122 extern long get_socket_active_status(long Sd);
frankvnk 0:c44f0314d6ec 123
frankvnk 0:c44f0314d6ec 124 typedef struct _bsd_accept_return_t
frankvnk 0:c44f0314d6ec 125 {
frankvnk 0:c44f0314d6ec 126 long iSocketDescriptor;
frankvnk 0:c44f0314d6ec 127 long iStatus;
frankvnk 0:c44f0314d6ec 128 sockaddr tSocketAddress;
frankvnk 0:c44f0314d6ec 129
frankvnk 0:c44f0314d6ec 130 } tBsdReturnParams;
frankvnk 0:c44f0314d6ec 131
frankvnk 0:c44f0314d6ec 132
frankvnk 0:c44f0314d6ec 133 typedef struct _bsd_read_return_t
frankvnk 0:c44f0314d6ec 134 {
frankvnk 0:c44f0314d6ec 135 long iSocketDescriptor;
frankvnk 0:c44f0314d6ec 136 long iNumberOfBytes;
frankvnk 0:c44f0314d6ec 137 unsigned long uiFlags;
frankvnk 0:c44f0314d6ec 138 } tBsdReadReturnParams;
frankvnk 0:c44f0314d6ec 139
frankvnk 0:c44f0314d6ec 140 #define BSD_RECV_FROM_FROMLEN_OFFSET (4)
frankvnk 0:c44f0314d6ec 141 #define BSD_RECV_FROM_FROM_OFFSET (16)
frankvnk 0:c44f0314d6ec 142
frankvnk 0:c44f0314d6ec 143
frankvnk 0:c44f0314d6ec 144 typedef struct _bsd_select_return_t
frankvnk 0:c44f0314d6ec 145 {
frankvnk 0:c44f0314d6ec 146 long iStatus;
frankvnk 0:c44f0314d6ec 147 unsigned long uiRdfd;
frankvnk 0:c44f0314d6ec 148 unsigned long uiWrfd;
frankvnk 0:c44f0314d6ec 149 unsigned long uiExfd;
frankvnk 0:c44f0314d6ec 150 } tBsdSelectRecvParams;
frankvnk 0:c44f0314d6ec 151
frankvnk 0:c44f0314d6ec 152
frankvnk 0:c44f0314d6ec 153 typedef struct _bsd_getsockopt_return_t
frankvnk 0:c44f0314d6ec 154 {
frankvnk 0:c44f0314d6ec 155 unsigned char ucOptValue[4];
frankvnk 0:c44f0314d6ec 156 char iStatus;
frankvnk 0:c44f0314d6ec 157 } tBsdGetSockOptReturnParams;
frankvnk 0:c44f0314d6ec 158
frankvnk 0:c44f0314d6ec 159 typedef struct _bsd_gethostbyname_return_t
frankvnk 0:c44f0314d6ec 160 {
frankvnk 0:c44f0314d6ec 161 long retVal;
frankvnk 0:c44f0314d6ec 162 long outputAddress;
frankvnk 0:c44f0314d6ec 163 } tBsdGethostbynameParams;
frankvnk 0:c44f0314d6ec 164
frankvnk 0:c44f0314d6ec 165 //*****************************************************************************
frankvnk 0:c44f0314d6ec 166 //
frankvnk 0:c44f0314d6ec 167 // Mark the end of the C bindings section for C++ compilers.
frankvnk 0:c44f0314d6ec 168 //
frankvnk 0:c44f0314d6ec 169 //*****************************************************************************
frankvnk 0:c44f0314d6ec 170 #ifdef __cplusplus
frankvnk 0:c44f0314d6ec 171 }
frankvnk 0:c44f0314d6ec 172 #endif // __cplusplus
frankvnk 0:c44f0314d6ec 173
frankvnk 0:c44f0314d6ec 174 #endif // __EVENT_HANDLER_H__
frankvnk 0:c44f0314d6ec 175
frankvnk 0:c44f0314d6ec 176
frankvnk 0:c44f0314d6ec 177