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 Nov 29 13:20:07 2013 +0000
Revision:
13:e1ab6b5ab826
Parent:
12:0366fd270fc8
update CC3000_MAXIMAL_RX_SIZE

Who changed what in which revision?

UserRevisionLine numberNew contents of line
frankvnk 0:c44f0314d6ec 1 /*****************************************************************************
frankvnk 0:c44f0314d6ec 2 *
frankvnk 0:c44f0314d6ec 3 * cc3000_common.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 __COMMON_H__
frankvnk 0:c44f0314d6ec 36 #define __COMMON_H__
frankvnk 0:c44f0314d6ec 37
frankvnk 9:8db50def96e5 38 //#include "GlobalAssigns.h"
frankvnk 9:8db50def96e5 39 #include "mbed.h"
frankvnk 0:c44f0314d6ec 40 #include <errno.h>
frankvnk 0:c44f0314d6ec 41
frankvnk 5:854f9b13a0f9 42 //*****************************************************************************
frankvnk 5:854f9b13a0f9 43 //
frankvnk 5:854f9b13a0f9 44 //! \addtogroup cc3000_common
frankvnk 5:854f9b13a0f9 45 //! @{
frankvnk 5:854f9b13a0f9 46 //
frankvnk 5:854f9b13a0f9 47 //*****************************************************************************
frankvnk 0:c44f0314d6ec 48 /** CC3000 Host driver - common
frankvnk 0:c44f0314d6ec 49 *
frankvnk 0:c44f0314d6ec 50 */
frankvnk 4:d8255a5aad46 51
frankvnk 0:c44f0314d6ec 52 #ifdef __cplusplus
frankvnk 0:c44f0314d6ec 53 extern "C" {
frankvnk 0:c44f0314d6ec 54 #endif
frankvnk 0:c44f0314d6ec 55
frankvnk 0:c44f0314d6ec 56 //*****************************************************************************
frankvnk 0:c44f0314d6ec 57 // ERROR CODES
frankvnk 0:c44f0314d6ec 58 //*****************************************************************************
frankvnk 0:c44f0314d6ec 59 #define ESUCCESS 0
frankvnk 0:c44f0314d6ec 60 #define EFAIL -1
frankvnk 0:c44f0314d6ec 61 #define EERROR EFAIL
frankvnk 0:c44f0314d6ec 62
frankvnk 9:8db50def96e5 63
frankvnk 9:8db50def96e5 64 //*****************************************************************************
frankvnk 9:8db50def96e5 65 // PIN CONTROLS & COMPILE CONTROLS
frankvnk 9:8db50def96e5 66 //*****************************************************************************
frankvnk 9:8db50def96e5 67 // Compiler control
frankvnk 9:8db50def96e5 68 #define CC3000_UNENCRYPTED_SMART_CONFIG // No encryption
frankvnk 9:8db50def96e5 69 //#define CC3000_TINY_DRIVER // Driver for small memory model CPUs
frankvnk 9:8db50def96e5 70
frankvnk 11:3884d0600caa 71 //Interrupt controls
frankvnk 11:3884d0600caa 72 #define NVIC_ALL_IRQ NVIC_set_all_irq_priorities(3); // Set ALL interrupt priorities to level 3// Set ALL interrupt priorities to level 3
frankvnk 11:3884d0600caa 73 #define NVIC_SPI_IRQ NVIC_SetPriority(SPI0_IRQn, 0x0); // Wi-Fi SPI interrupt must be higher priority than SysTick
frankvnk 11:3884d0600caa 74 #define NVIC_PORT_IRQ NVIC_SetPriority(PORTA_IRQn, 0x1);
frankvnk 11:3884d0600caa 75 #define NVIC_SYSTICK_IRQ NVIC_SetPriority(SysTick_IRQn, 0x2); // SysTick set to lower priority than Wi-Fi SPI bus interrupt
frankvnk 11:3884d0600caa 76 //#define NVIC_ADC_IRQ NVIC_SetPriority(ADC0_IRQn, 0x3); // ADC is the lowest of all
frankvnk 9:8db50def96e5 77
frankvnk 9:8db50def96e5 78 // Wlan controls
frankvnk 9:8db50def96e5 79 #define WLAN_ISF_PCR PORTA->PCR[16]
frankvnk 9:8db50def96e5 80 #define WLAN_ISF_ISFR PORTA->ISFR
frankvnk 9:8db50def96e5 81 #define WLAN_ISF_MASK (1<<16)
frankvnk 9:8db50def96e5 82
frankvnk 9:8db50def96e5 83 #define WLAN_ASSERT_CS wlan_cs = 0; //CS : active low
frankvnk 9:8db50def96e5 84 #define WLAN_DEASSERT_CS wlan_cs = 1;
frankvnk 9:8db50def96e5 85
frankvnk 9:8db50def96e5 86 #define WLAN_ASSERT_EN wlan_en = 1; //EN : active high
frankvnk 9:8db50def96e5 87 #define WLAN_DEASSERT_EN wlan_en = 0;
frankvnk 9:8db50def96e5 88
frankvnk 9:8db50def96e5 89 #define WLAN_READ_IRQ wlan_int
frankvnk 9:8db50def96e5 90
frankvnk 12:0366fd270fc8 91 //#define WLAN_ENABLE_IRQ NVIC_EnableIRQ(PORTA_IRQn);
frankvnk 12:0366fd270fc8 92 //#define WLAN_DISABLE_IRQ NVIC_DisableIRQ(PORTA_IRQn);
frankvnk 12:0366fd270fc8 93 #define WLAN_ENABLE_IRQ wlan_int.fall(&WLAN_IRQHandler);
frankvnk 12:0366fd270fc8 94 #define WLAN_DISABLE_IRQ wlan_int.fall(NULL);
frankvnk 9:8db50def96e5 95
frankvnk 9:8db50def96e5 96 #define WLAN_IRQ_PIN_CREATE InterruptIn wlan_int (PTA16);
frankvnk 9:8db50def96e5 97 #define WLAN_EN_PIN_CREATE DigitalOut wlan_en (PTA13);
frankvnk 9:8db50def96e5 98 #define WLAN_CS_PIN_CREATE DigitalOut wlan_cs (PTD0);
frankvnk 9:8db50def96e5 99 #define WLAN_SPI_PORT_CREATE SPI wlan(PTD2, PTD3, PTC5); // mosi, miso, sclk
frankvnk 9:8db50def96e5 100
frankvnk 9:8db50def96e5 101 #define WLAN_SPI_PORT_INIT wlan.format(8,1);
frankvnk 9:8db50def96e5 102 #define WLAN_SPI_SET_FREQ wlan.frequency(12000000);
frankvnk 9:8db50def96e5 103 #define WLAN_SPI_SET_IRQ_HANDLER wlan_int.fall(&WLAN_IRQHandler);
frankvnk 9:8db50def96e5 104
frankvnk 9:8db50def96e5 105 #define WLAN_SPI_WRITE wlan.write(*data++);
frankvnk 9:8db50def96e5 106 #define WLAN_SPI_READ wlan.write(0x03); // !! DO NOT MODIFY the 0x03 parameter (CC3000 will not respond).
frankvnk 9:8db50def96e5 107
frankvnk 9:8db50def96e5 108 extern DigitalOut wlan_en;
frankvnk 9:8db50def96e5 109 extern DigitalOut wlan_cs;
frankvnk 9:8db50def96e5 110 extern InterruptIn wlan_int;
frankvnk 9:8db50def96e5 111 extern SPI wlan;
frankvnk 9:8db50def96e5 112 extern void CC3000_UsynchCallback(long lEventType, char * data, unsigned char length);
frankvnk 9:8db50def96e5 113
frankvnk 9:8db50def96e5 114
frankvnk 9:8db50def96e5 115 /** Set basic controls and parameters for the HostDriver.
frankvnk 9:8db50def96e5 116 * @param none
frankvnk 9:8db50def96e5 117 * @return none
frankvnk 9:8db50def96e5 118 */
frankvnk 9:8db50def96e5 119 void Init_HostDriver(void);
frankvnk 9:8db50def96e5 120
frankvnk 9:8db50def96e5 121 /** Return a pointer to the driver patch.
frankvnk 9:8db50def96e5 122 * Since there is no patch, 0 is returned\n
frankvnk 9:8db50def96e5 123 * (the patches are taken from the EEPROM and not from the host)\n
frankvnk 9:8db50def96e5 124 * @param pointer to the length
frankvnk 9:8db50def96e5 125 * @return NULL
frankvnk 9:8db50def96e5 126 */
frankvnk 9:8db50def96e5 127 char *sendDriverPatch(unsigned long *Length);
frankvnk 9:8db50def96e5 128
frankvnk 9:8db50def96e5 129 /** Return a pointer to the bootloader patch.
frankvnk 9:8db50def96e5 130 * Since there is no patch, 0 is returned \n
frankvnk 9:8db50def96e5 131 * (the patches are taken from the EEPROM and not from the host)\n
frankvnk 9:8db50def96e5 132 * @param pointer to the length
frankvnk 9:8db50def96e5 133 * @return NULL
frankvnk 9:8db50def96e5 134 */
frankvnk 9:8db50def96e5 135 char *sendBootLoaderPatch(unsigned long *Length);
frankvnk 9:8db50def96e5 136
frankvnk 9:8db50def96e5 137 /** Return a pointer to the firmware patch.
frankvnk 9:8db50def96e5 138 * Since there is no patch, 0 is returned\n
frankvnk 9:8db50def96e5 139 * (the patches are taken from the EEPROM and not from the host)\n
frankvnk 9:8db50def96e5 140 * @param pointer to the length
frankvnk 9:8db50def96e5 141 * @return NULL
frankvnk 9:8db50def96e5 142 */
frankvnk 9:8db50def96e5 143 char *sendWLFWPatch(unsigned long *Length);
frankvnk 9:8db50def96e5 144
frankvnk 9:8db50def96e5 145 /** Read Wlan Interrupt pin.
frankvnk 9:8db50def96e5 146 * @param none
frankvnk 9:8db50def96e5 147 * @return wlan interrup pin level
frankvnk 9:8db50def96e5 148 */
frankvnk 9:8db50def96e5 149 long ReadWlanInterruptPin(void);
frankvnk 9:8db50def96e5 150
frankvnk 9:8db50def96e5 151 /** Enable waln IrQ pin.
frankvnk 9:8db50def96e5 152 * @param none
frankvnk 9:8db50def96e5 153 * @return none
frankvnk 9:8db50def96e5 154 */
frankvnk 9:8db50def96e5 155 void WlanInterruptEnable(void);
frankvnk 9:8db50def96e5 156
frankvnk 9:8db50def96e5 157 /** Disable waln IrQ pin.
frankvnk 9:8db50def96e5 158 * @param none
frankvnk 9:8db50def96e5 159 * @return none
frankvnk 9:8db50def96e5 160 */
frankvnk 9:8db50def96e5 161 void WlanInterruptDisable(void);
frankvnk 9:8db50def96e5 162
frankvnk 9:8db50def96e5 163 /** WriteWlanPin.
frankvnk 9:8db50def96e5 164 * @param val (1: enable - 0: disable)
frankvnk 9:8db50def96e5 165 * @return none
frankvnk 9:8db50def96e5 166 */
frankvnk 9:8db50def96e5 167 void WriteWlanPin( unsigned char val );
frankvnk 9:8db50def96e5 168
frankvnk 9:8db50def96e5 169
frankvnk 0:c44f0314d6ec 170 //*****************************************************************************
frankvnk 0:c44f0314d6ec 171 // COMMON DEFINES
frankvnk 0:c44f0314d6ec 172 //*****************************************************************************
frankvnk 0:c44f0314d6ec 173 #define ERROR_SOCKET_INACTIVE -57
frankvnk 0:c44f0314d6ec 174
frankvnk 0:c44f0314d6ec 175 #define HCI_CC_PAYLOAD_LEN 5
frankvnk 0:c44f0314d6ec 176
frankvnk 1:bbcaf0b2f367 177 #define WLAN_ENABLE (1)
frankvnk 1:bbcaf0b2f367 178 #define WLAN_DISABLE (0)
frankvnk 0:c44f0314d6ec 179
frankvnk 1:bbcaf0b2f367 180 #define MAC_ADDR_LEN (6)
frankvnk 0:c44f0314d6ec 181
frankvnk 0:c44f0314d6ec 182
frankvnk 0:c44f0314d6ec 183
frankvnk 0:c44f0314d6ec 184 /*Defines for minimal and maximal RX buffer size. This size includes the spi
frankvnk 0:c44f0314d6ec 185 header and hci header.
frankvnk 1:bbcaf0b2f367 186 maximal buffer size: MTU + HCI header + SPI header + sendto() args size
frankvnk 1:bbcaf0b2f367 187 minimum buffer size: HCI header + SPI header + max args size
frankvnk 0:c44f0314d6ec 188
frankvnk 0:c44f0314d6ec 189 This buffer is used for receiving events and data.
frankvnk 0:c44f0314d6ec 190 The packet can not be longer than MTU size and CC3000 does not support
frankvnk 0:c44f0314d6ec 191 fragmentation. Note that the same buffer is used for reception of the data
frankvnk 0:c44f0314d6ec 192 and events from CC3000. That is why the minimum is defined.
frankvnk 0:c44f0314d6ec 193 The calculation for the actual size of buffer for reception is:
frankvnk 0:c44f0314d6ec 194 Given the maximal data size MAX_DATA that is expected to be received by
frankvnk 1:bbcaf0b2f367 195 application, the required buffer Using recv() or recvfrom():
frankvnk 0:c44f0314d6ec 196
frankvnk 1:bbcaf0b2f367 197 max(CC3000_MINIMAL_RX_SIZE, MAX_DATA + HEADERS_SIZE_DATA + fromlen + ucArgsize + 1)
frankvnk 0:c44f0314d6ec 198
frankvnk 1:bbcaf0b2f367 199 Using gethostbyname() with minimal buffer size will limit the host name returned to 99 bytes.
frankvnk 0:c44f0314d6ec 200 The 1 is used for the overrun detection
frankvnk 0:c44f0314d6ec 201 */
frankvnk 0:c44f0314d6ec 202
frankvnk 1:bbcaf0b2f367 203 #define CC3000_MINIMAL_RX_SIZE (118 + 1)
frankvnk 13:e1ab6b5ab826 204 #define CC3000_MAXIMAL_RX_SIZE (1519 + 1)
frankvnk 0:c44f0314d6ec 205
frankvnk 0:c44f0314d6ec 206 /*Defines for minimal and maximal TX buffer size.
frankvnk 0:c44f0314d6ec 207 This buffer is used for sending events and data.
frankvnk 0:c44f0314d6ec 208 The packet can not be longer than MTU size and CC3000 does not support
frankvnk 0:c44f0314d6ec 209 fragmentation. Note that the same buffer is used for transmission of the data
frankvnk 0:c44f0314d6ec 210 and commands. That is why the minimum is defined.
frankvnk 0:c44f0314d6ec 211 The calculation for the actual size of buffer for transmission is:
frankvnk 0:c44f0314d6ec 212 Given the maximal data size MAX_DATA, the required buffer is:
frankvnk 0:c44f0314d6ec 213 Using Sendto():
frankvnk 0:c44f0314d6ec 214
frankvnk 0:c44f0314d6ec 215 max(CC3000_MINIMAL_TX_SIZE, MAX_DATA + SPI_HEADER_SIZE
frankvnk 0:c44f0314d6ec 216 + SOCKET_SENDTO_PARAMS_LEN + SIMPLE_LINK_HCI_DATA_HEADER_SIZE + 1)
frankvnk 0:c44f0314d6ec 217
frankvnk 0:c44f0314d6ec 218 Using Send():
frankvnk 0:c44f0314d6ec 219
frankvnk 0:c44f0314d6ec 220 max(CC3000_MINIMAL_TX_SIZE, MAX_DATA + SPI_HEADER_SIZE
frankvnk 0:c44f0314d6ec 221 + HCI_CMND_SEND_ARG_LENGTH + SIMPLE_LINK_HCI_DATA_HEADER_SIZE + 1)
frankvnk 0:c44f0314d6ec 222
frankvnk 0:c44f0314d6ec 223 The 1 is used for the overrun detection */
frankvnk 0:c44f0314d6ec 224
frankvnk 4:d8255a5aad46 225 #define CC3000_MINIMAL_TX_SIZE (118 + 1)
frankvnk 0:c44f0314d6ec 226 #define CC3000_MAXIMAL_TX_SIZE (1519 + 1)
frankvnk 0:c44f0314d6ec 227
frankvnk 1:bbcaf0b2f367 228 //TX and RX buffer size - allow to receive and transmit maximum data at lengh 8.
frankvnk 0:c44f0314d6ec 229 #ifdef CC3000_TINY_DRIVER
frankvnk 0:c44f0314d6ec 230 #define TINY_CC3000_MAXIMAL_RX_SIZE 44
frankvnk 0:c44f0314d6ec 231 #define TINY_CC3000_MAXIMAL_TX_SIZE 59
frankvnk 0:c44f0314d6ec 232 #endif
frankvnk 0:c44f0314d6ec 233
frankvnk 0:c44f0314d6ec 234 /*In order to determine your preferred buffer size,
frankvnk 0:c44f0314d6ec 235 change CC3000_MAXIMAL_RX_SIZE and CC3000_MAXIMAL_TX_SIZE to a value between
frankvnk 0:c44f0314d6ec 236 the minimal and maximal specified above.
frankvnk 0:c44f0314d6ec 237 Note that the buffers are allocated by SPI.
frankvnk 0:c44f0314d6ec 238 */
frankvnk 0:c44f0314d6ec 239
frankvnk 0:c44f0314d6ec 240 #ifndef CC3000_TINY_DRIVER
frankvnk 0:c44f0314d6ec 241
frankvnk 0:c44f0314d6ec 242 #define CC3000_RX_BUFFER_SIZE (CC3000_MAXIMAL_RX_SIZE)
frankvnk 0:c44f0314d6ec 243 #define CC3000_TX_BUFFER_SIZE (CC3000_MAXIMAL_TX_SIZE)
frankvnk 1:bbcaf0b2f367 244 #define SP_PORTION_SIZE 512
frankvnk 0:c44f0314d6ec 245
frankvnk 1:bbcaf0b2f367 246 //TINY DRIVER: We use smaller rx and tx buffers in order to minimize RAM consumption
frankvnk 0:c44f0314d6ec 247 #else
frankvnk 0:c44f0314d6ec 248 #define CC3000_RX_BUFFER_SIZE (TINY_CC3000_MAXIMAL_RX_SIZE)
frankvnk 0:c44f0314d6ec 249 #define CC3000_TX_BUFFER_SIZE (TINY_CC3000_MAXIMAL_TX_SIZE)
frankvnk 1:bbcaf0b2f367 250 #define SP_PORTION_SIZE 32
frankvnk 0:c44f0314d6ec 251
frankvnk 0:c44f0314d6ec 252 #endif
frankvnk 0:c44f0314d6ec 253 //*****************************************************************************
frankvnk 0:c44f0314d6ec 254 // Compound Types
frankvnk 0:c44f0314d6ec 255 //*****************************************************************************
frankvnk 0:c44f0314d6ec 256 typedef struct timeval timeval;
frankvnk 0:c44f0314d6ec 257
frankvnk 6:d733efcc2c56 258 typedef struct _sockaddr_t
frankvnk 6:d733efcc2c56 259 {
frankvnk 6:d733efcc2c56 260 unsigned short int sa_family;
frankvnk 6:d733efcc2c56 261 unsigned char sa_data[14];
frankvnk 6:d733efcc2c56 262 } sockaddr;
frankvnk 6:d733efcc2c56 263
frankvnk 0:c44f0314d6ec 264 struct timeval
frankvnk 0:c44f0314d6ec 265 {
frankvnk 4:d8255a5aad46 266 long tv_sec; /* seconds */
frankvnk 4:d8255a5aad46 267 long tv_usec; /* microseconds */
frankvnk 0:c44f0314d6ec 268 };
frankvnk 0:c44f0314d6ec 269
frankvnk 0:c44f0314d6ec 270 typedef char *(*tFWPatches)(unsigned long *usLength);
frankvnk 0:c44f0314d6ec 271 typedef char *(*tDriverPatches)(unsigned long *usLength);
frankvnk 0:c44f0314d6ec 272 typedef char *(*tBootLoaderPatches)(unsigned long *usLength);
frankvnk 0:c44f0314d6ec 273 typedef void (*tWlanCB)(long event_type, char * data, unsigned char length );
frankvnk 0:c44f0314d6ec 274 typedef long (*tWlanReadInteruptPin)(void);
frankvnk 0:c44f0314d6ec 275 typedef void (*tWlanInterruptEnable)(void);
frankvnk 0:c44f0314d6ec 276 typedef void (*tWlanInterruptDisable)(void);
frankvnk 0:c44f0314d6ec 277 typedef void (*tWriteWlanPin)(unsigned char val);
frankvnk 0:c44f0314d6ec 278
frankvnk 0:c44f0314d6ec 279 typedef struct
frankvnk 0:c44f0314d6ec 280 {
frankvnk 1:bbcaf0b2f367 281 unsigned short usRxEventOpcode;
frankvnk 1:bbcaf0b2f367 282 unsigned short usEventOrDataReceived;
frankvnk 1:bbcaf0b2f367 283 unsigned char *pucReceivedData;
frankvnk 1:bbcaf0b2f367 284 unsigned char *pucTxCommandBuffer;
frankvnk 1:bbcaf0b2f367 285 tFWPatches sFWPatches;
frankvnk 1:bbcaf0b2f367 286 tDriverPatches sDriverPatches;
frankvnk 1:bbcaf0b2f367 287 tBootLoaderPatches sBootLoaderPatches;
frankvnk 1:bbcaf0b2f367 288 tWlanCB sWlanCB;
frankvnk 0:c44f0314d6ec 289 tWlanReadInteruptPin ReadWlanInterruptPin;
frankvnk 0:c44f0314d6ec 290 tWlanInterruptEnable WlanInterruptEnable;
frankvnk 0:c44f0314d6ec 291 tWlanInterruptDisable WlanInterruptDisable;
frankvnk 0:c44f0314d6ec 292 tWriteWlanPin WriteWlanPin;
frankvnk 1:bbcaf0b2f367 293 signed long slTransmitDataError;
frankvnk 1:bbcaf0b2f367 294 unsigned short usNumberOfFreeBuffers;
frankvnk 1:bbcaf0b2f367 295 unsigned short usSlBufferLength;
frankvnk 1:bbcaf0b2f367 296 unsigned short usBufferSize;
frankvnk 1:bbcaf0b2f367 297 unsigned short usRxDataPending;
frankvnk 1:bbcaf0b2f367 298 unsigned long NumberOfSentPackets;
frankvnk 1:bbcaf0b2f367 299 unsigned long NumberOfReleasedPackets;
frankvnk 1:bbcaf0b2f367 300 unsigned char InformHostOnTxComplete;
frankvnk 0:c44f0314d6ec 301 }sSimplLinkInformation;
frankvnk 0:c44f0314d6ec 302
frankvnk 0:c44f0314d6ec 303 extern volatile sSimplLinkInformation tSLInformation;
frankvnk 0:c44f0314d6ec 304
frankvnk 0:c44f0314d6ec 305
frankvnk 0:c44f0314d6ec 306 //*****************************************************************************
frankvnk 0:c44f0314d6ec 307 // Prototypes for the APIs.
frankvnk 0:c44f0314d6ec 308 //*****************************************************************************
frankvnk 0:c44f0314d6ec 309
frankvnk 4:d8255a5aad46 310 /**
frankvnk 4:d8255a5aad46 311 * Wait for event, pass it to the hci_event_handler and update the event opcode in a global variable.
frankvnk 4:d8255a5aad46 312 * @param usOpcode command operation code
frankvnk 4:d8255a5aad46 313 * @param pRetParams command return parameters
frankvnk 4:d8255a5aad46 314 * @return none
frankvnk 4:d8255a5aad46 315 */
frankvnk 0:c44f0314d6ec 316 extern void SimpleLinkWaitEvent(unsigned short usOpcode, void *pRetParams);
frankvnk 0:c44f0314d6ec 317
frankvnk 4:d8255a5aad46 318 /**
frankvnk 4:d8255a5aad46 319 * Wait for data, pass it to the hci_event_handler and update in a global variable that there is data to read.
frankvnk 4:d8255a5aad46 320 * @param pBuf data buffer
frankvnk 4:d8255a5aad46 321 * @param from from information
frankvnk 4:d8255a5aad46 322 * @param fromlen from information length
frankvnk 4:d8255a5aad46 323 * @return none
frankvnk 4:d8255a5aad46 324 */
frankvnk 0:c44f0314d6ec 325 extern void SimpleLinkWaitData(unsigned char *pBuf, unsigned char *from, unsigned char *fromlen);
frankvnk 0:c44f0314d6ec 326
frankvnk 4:d8255a5aad46 327 /**
frankvnk 4:d8255a5aad46 328 * Copy 32 bit to stream while converting to little endian format.
frankvnk 4:d8255a5aad46 329 * @param p pointer to the new stream
frankvnk 4:d8255a5aad46 330 * @param u32 pointer to the 32 bit
frankvnk 4:d8255a5aad46 331 * @return pointer to the new stream
frankvnk 4:d8255a5aad46 332 */
frankvnk 0:c44f0314d6ec 333 extern unsigned char* UINT32_TO_STREAM_f (unsigned char *p, unsigned long u32);
frankvnk 0:c44f0314d6ec 334
frankvnk 4:d8255a5aad46 335 /**
frankvnk 4:d8255a5aad46 336 * Copy 16 bit to stream while converting to little endian format.
frankvnk 4:d8255a5aad46 337 * @param p pointer to the new stream
frankvnk 4:d8255a5aad46 338 * @param u32 pointer to the 16 bit
frankvnk 4:d8255a5aad46 339 * @return pointer to the new stream
frankvnk 4:d8255a5aad46 340 */
frankvnk 0:c44f0314d6ec 341 extern unsigned char* UINT16_TO_STREAM_f (unsigned char *p, unsigned short u16);
frankvnk 0:c44f0314d6ec 342
frankvnk 4:d8255a5aad46 343 /**
frankvnk 4:d8255a5aad46 344 * Copy received stream to 16 bit in little endian format.
frankvnk 4:d8255a5aad46 345 * @param p pointer to the stream
frankvnk 4:d8255a5aad46 346 * @param offset offset in the stream
frankvnk 4:d8255a5aad46 347 * @return pointer to the new 16 bit
frankvnk 4:d8255a5aad46 348 */
frankvnk 0:c44f0314d6ec 349 extern unsigned short STREAM_TO_UINT16_f(char* p, unsigned short offset);
frankvnk 0:c44f0314d6ec 350
frankvnk 4:d8255a5aad46 351 /**
frankvnk 4:d8255a5aad46 352 * Copy received stream to 32 bit in little endian format.
frankvnk 4:d8255a5aad46 353 * @param p pointer to the stream
frankvnk 4:d8255a5aad46 354 * @param offset offset in the stream
frankvnk 4:d8255a5aad46 355 * @return pointer to the new 32 bit
frankvnk 4:d8255a5aad46 356 */
frankvnk 0:c44f0314d6ec 357 extern unsigned long STREAM_TO_UINT32_f(char* p, unsigned short offset);
frankvnk 0:c44f0314d6ec 358
frankvnk 0:c44f0314d6ec 359
frankvnk 0:c44f0314d6ec 360 //*****************************************************************************
frankvnk 0:c44f0314d6ec 361 // COMMON MACROs
frankvnk 0:c44f0314d6ec 362 //*****************************************************************************
frankvnk 0:c44f0314d6ec 363
frankvnk 0:c44f0314d6ec 364
frankvnk 4:d8255a5aad46 365 //Copy 8 bit to stream while converting to little endian format.
frankvnk 0:c44f0314d6ec 366 #define UINT8_TO_STREAM(_p, _val) {*(_p)++ = (_val);}
frankvnk 4:d8255a5aad46 367 //Copy 16 bit to stream while converting to little endian format.
frankvnk 0:c44f0314d6ec 368 #define UINT16_TO_STREAM(_p, _u16) (UINT16_TO_STREAM_f(_p, _u16))
frankvnk 4:d8255a5aad46 369 //Copy 32 bit to stream while converting to little endian format.
frankvnk 0:c44f0314d6ec 370 #define UINT32_TO_STREAM(_p, _u32) (UINT32_TO_STREAM_f(_p, _u32))
frankvnk 4:d8255a5aad46 371 //Copy a specified value length bits (l) to stream while converting to little endian format.
frankvnk 0:c44f0314d6ec 372 #define ARRAY_TO_STREAM(p, a, l) {register short _i; for (_i = 0; _i < l; _i++) *(p)++ = ((unsigned char *) a)[_i];}
frankvnk 4:d8255a5aad46 373 //Copy received stream to 8 bit in little endian format.
frankvnk 0:c44f0314d6ec 374 #define STREAM_TO_UINT8(_p, _offset, _u8) {_u8 = (unsigned char)(*(_p + _offset));}
frankvnk 4:d8255a5aad46 375 //Copy received stream to 16 bit in little endian format.
frankvnk 0:c44f0314d6ec 376 #define STREAM_TO_UINT16(_p, _offset, _u16) {_u16 = STREAM_TO_UINT16_f(_p, _offset);}
frankvnk 4:d8255a5aad46 377 //Copy received stream to 32 bit in little endian format.
frankvnk 0:c44f0314d6ec 378 #define STREAM_TO_UINT32(_p, _offset, _u32) {_u32 = STREAM_TO_UINT32_f(_p, _offset);}
frankvnk 0:c44f0314d6ec 379 #define STREAM_TO_STREAM(p, a, l) {register short _i; for (_i = 0; _i < l; _i++) *(a)++= ((unsigned char *) p)[_i];}
frankvnk 0:c44f0314d6ec 380
frankvnk 0:c44f0314d6ec 381 #ifdef __cplusplus
frankvnk 0:c44f0314d6ec 382 }
frankvnk 0:c44f0314d6ec 383 #endif // __cplusplus
frankvnk 5:854f9b13a0f9 384 //*****************************************************************************
frankvnk 5:854f9b13a0f9 385 //
frankvnk 5:854f9b13a0f9 386 // Close the Doxygen group.
frankvnk 5:854f9b13a0f9 387 //! @}
frankvnk 5:854f9b13a0f9 388 //
frankvnk 5:854f9b13a0f9 389 //*****************************************************************************
frankvnk 0:c44f0314d6ec 390
frankvnk 0:c44f0314d6ec 391 #endif // __COMMON_H__
frankvnk 0:c44f0314d6ec 392
frankvnk 5:854f9b13a0f9 393
frankvnk 6:d733efcc2c56 394
frankvnk 6:d733efcc2c56 395
frankvnk 6:d733efcc2c56 396
frankvnk 6:d733efcc2c56 397
frankvnk 6:d733efcc2c56 398
frankvnk 7:875e62bb780c 399
frankvnk 8:b48bb4df9319 400
frankvnk 13:e1ab6b5ab826 401