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 15 19:54:53 2013 +0000
Revision:
5:854f9b13a0f9
Parent:
4:d8255a5aad46
Child:
6:d733efcc2c56
Doxygen fixed

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 0:c44f0314d6ec 38 #include <errno.h>
frankvnk 0:c44f0314d6ec 39
frankvnk 5:854f9b13a0f9 40 //*****************************************************************************
frankvnk 5:854f9b13a0f9 41 //
frankvnk 5:854f9b13a0f9 42 //! \addtogroup cc3000_common
frankvnk 5:854f9b13a0f9 43 //! @{
frankvnk 5:854f9b13a0f9 44 //
frankvnk 5:854f9b13a0f9 45 //*****************************************************************************
frankvnk 0:c44f0314d6ec 46 /** CC3000 Host driver - common
frankvnk 0:c44f0314d6ec 47 *
frankvnk 0:c44f0314d6ec 48 */
frankvnk 4:d8255a5aad46 49
frankvnk 0:c44f0314d6ec 50 #ifdef __cplusplus
frankvnk 0:c44f0314d6ec 51 extern "C" {
frankvnk 0:c44f0314d6ec 52 #endif
frankvnk 0:c44f0314d6ec 53
frankvnk 0:c44f0314d6ec 54 //*****************************************************************************
frankvnk 0:c44f0314d6ec 55 // ERROR CODES
frankvnk 0:c44f0314d6ec 56 //*****************************************************************************
frankvnk 0:c44f0314d6ec 57 #define ESUCCESS 0
frankvnk 0:c44f0314d6ec 58 #define EFAIL -1
frankvnk 0:c44f0314d6ec 59 #define EERROR EFAIL
frankvnk 0:c44f0314d6ec 60
frankvnk 0:c44f0314d6ec 61 //*****************************************************************************
frankvnk 0:c44f0314d6ec 62 // COMMON DEFINES
frankvnk 0:c44f0314d6ec 63 //*****************************************************************************
frankvnk 0:c44f0314d6ec 64 #define ERROR_SOCKET_INACTIVE -57
frankvnk 0:c44f0314d6ec 65
frankvnk 0:c44f0314d6ec 66 #define HCI_CC_PAYLOAD_LEN 5
frankvnk 0:c44f0314d6ec 67
frankvnk 1:bbcaf0b2f367 68 #define WLAN_ENABLE (1)
frankvnk 1:bbcaf0b2f367 69 #define WLAN_DISABLE (0)
frankvnk 0:c44f0314d6ec 70
frankvnk 1:bbcaf0b2f367 71 #define MAC_ADDR_LEN (6)
frankvnk 0:c44f0314d6ec 72
frankvnk 0:c44f0314d6ec 73
frankvnk 0:c44f0314d6ec 74
frankvnk 0:c44f0314d6ec 75 /*Defines for minimal and maximal RX buffer size. This size includes the spi
frankvnk 0:c44f0314d6ec 76 header and hci header.
frankvnk 1:bbcaf0b2f367 77 maximal buffer size: MTU + HCI header + SPI header + sendto() args size
frankvnk 1:bbcaf0b2f367 78 minimum buffer size: HCI header + SPI header + max args size
frankvnk 0:c44f0314d6ec 79
frankvnk 0:c44f0314d6ec 80 This buffer is used for receiving events and data.
frankvnk 0:c44f0314d6ec 81 The packet can not be longer than MTU size and CC3000 does not support
frankvnk 0:c44f0314d6ec 82 fragmentation. Note that the same buffer is used for reception of the data
frankvnk 0:c44f0314d6ec 83 and events from CC3000. That is why the minimum is defined.
frankvnk 0:c44f0314d6ec 84 The calculation for the actual size of buffer for reception is:
frankvnk 0:c44f0314d6ec 85 Given the maximal data size MAX_DATA that is expected to be received by
frankvnk 1:bbcaf0b2f367 86 application, the required buffer Using recv() or recvfrom():
frankvnk 0:c44f0314d6ec 87
frankvnk 1:bbcaf0b2f367 88 max(CC3000_MINIMAL_RX_SIZE, MAX_DATA + HEADERS_SIZE_DATA + fromlen + ucArgsize + 1)
frankvnk 0:c44f0314d6ec 89
frankvnk 1:bbcaf0b2f367 90 Using gethostbyname() with minimal buffer size will limit the host name returned to 99 bytes.
frankvnk 0:c44f0314d6ec 91 The 1 is used for the overrun detection
frankvnk 0:c44f0314d6ec 92 */
frankvnk 0:c44f0314d6ec 93
frankvnk 1:bbcaf0b2f367 94 #define CC3000_MINIMAL_RX_SIZE (118 + 1)
frankvnk 0:c44f0314d6ec 95 #define CC3000_MAXIMAL_RX_SIZE (1519 + 1)
frankvnk 0:c44f0314d6ec 96
frankvnk 0:c44f0314d6ec 97 /*Defines for minimal and maximal TX buffer size.
frankvnk 0:c44f0314d6ec 98 This buffer is used for sending events and data.
frankvnk 0:c44f0314d6ec 99 The packet can not be longer than MTU size and CC3000 does not support
frankvnk 0:c44f0314d6ec 100 fragmentation. Note that the same buffer is used for transmission of the data
frankvnk 0:c44f0314d6ec 101 and commands. That is why the minimum is defined.
frankvnk 0:c44f0314d6ec 102 The calculation for the actual size of buffer for transmission is:
frankvnk 0:c44f0314d6ec 103 Given the maximal data size MAX_DATA, the required buffer is:
frankvnk 0:c44f0314d6ec 104 Using Sendto():
frankvnk 0:c44f0314d6ec 105
frankvnk 0:c44f0314d6ec 106 max(CC3000_MINIMAL_TX_SIZE, MAX_DATA + SPI_HEADER_SIZE
frankvnk 0:c44f0314d6ec 107 + SOCKET_SENDTO_PARAMS_LEN + SIMPLE_LINK_HCI_DATA_HEADER_SIZE + 1)
frankvnk 0:c44f0314d6ec 108
frankvnk 0:c44f0314d6ec 109 Using Send():
frankvnk 0:c44f0314d6ec 110
frankvnk 0:c44f0314d6ec 111 max(CC3000_MINIMAL_TX_SIZE, MAX_DATA + SPI_HEADER_SIZE
frankvnk 0:c44f0314d6ec 112 + HCI_CMND_SEND_ARG_LENGTH + SIMPLE_LINK_HCI_DATA_HEADER_SIZE + 1)
frankvnk 0:c44f0314d6ec 113
frankvnk 0:c44f0314d6ec 114 The 1 is used for the overrun detection */
frankvnk 0:c44f0314d6ec 115
frankvnk 4:d8255a5aad46 116 #define CC3000_MINIMAL_TX_SIZE (118 + 1)
frankvnk 0:c44f0314d6ec 117 #define CC3000_MAXIMAL_TX_SIZE (1519 + 1)
frankvnk 0:c44f0314d6ec 118
frankvnk 1:bbcaf0b2f367 119 //TX and RX buffer size - allow to receive and transmit maximum data at lengh 8.
frankvnk 0:c44f0314d6ec 120 #ifdef CC3000_TINY_DRIVER
frankvnk 0:c44f0314d6ec 121 #define TINY_CC3000_MAXIMAL_RX_SIZE 44
frankvnk 0:c44f0314d6ec 122 #define TINY_CC3000_MAXIMAL_TX_SIZE 59
frankvnk 0:c44f0314d6ec 123 #endif
frankvnk 0:c44f0314d6ec 124
frankvnk 0:c44f0314d6ec 125 /*In order to determine your preferred buffer size,
frankvnk 0:c44f0314d6ec 126 change CC3000_MAXIMAL_RX_SIZE and CC3000_MAXIMAL_TX_SIZE to a value between
frankvnk 0:c44f0314d6ec 127 the minimal and maximal specified above.
frankvnk 0:c44f0314d6ec 128 Note that the buffers are allocated by SPI.
frankvnk 0:c44f0314d6ec 129 */
frankvnk 0:c44f0314d6ec 130
frankvnk 0:c44f0314d6ec 131 #ifndef CC3000_TINY_DRIVER
frankvnk 0:c44f0314d6ec 132
frankvnk 0:c44f0314d6ec 133 #define CC3000_RX_BUFFER_SIZE (CC3000_MAXIMAL_RX_SIZE)
frankvnk 0:c44f0314d6ec 134 #define CC3000_TX_BUFFER_SIZE (CC3000_MAXIMAL_TX_SIZE)
frankvnk 1:bbcaf0b2f367 135 #define SP_PORTION_SIZE 512
frankvnk 0:c44f0314d6ec 136
frankvnk 1:bbcaf0b2f367 137 //TINY DRIVER: We use smaller rx and tx buffers in order to minimize RAM consumption
frankvnk 0:c44f0314d6ec 138 #else
frankvnk 0:c44f0314d6ec 139 #define CC3000_RX_BUFFER_SIZE (TINY_CC3000_MAXIMAL_RX_SIZE)
frankvnk 0:c44f0314d6ec 140 #define CC3000_TX_BUFFER_SIZE (TINY_CC3000_MAXIMAL_TX_SIZE)
frankvnk 1:bbcaf0b2f367 141 #define SP_PORTION_SIZE 32
frankvnk 0:c44f0314d6ec 142
frankvnk 0:c44f0314d6ec 143 #endif
frankvnk 0:c44f0314d6ec 144 //*****************************************************************************
frankvnk 0:c44f0314d6ec 145 // Compound Types
frankvnk 0:c44f0314d6ec 146 //*****************************************************************************
frankvnk 0:c44f0314d6ec 147 typedef struct timeval timeval;
frankvnk 0:c44f0314d6ec 148
frankvnk 0:c44f0314d6ec 149 struct timeval
frankvnk 0:c44f0314d6ec 150 {
frankvnk 4:d8255a5aad46 151 long tv_sec; /* seconds */
frankvnk 4:d8255a5aad46 152 long tv_usec; /* microseconds */
frankvnk 0:c44f0314d6ec 153 };
frankvnk 0:c44f0314d6ec 154
frankvnk 0:c44f0314d6ec 155 typedef char *(*tFWPatches)(unsigned long *usLength);
frankvnk 0:c44f0314d6ec 156 typedef char *(*tDriverPatches)(unsigned long *usLength);
frankvnk 0:c44f0314d6ec 157 typedef char *(*tBootLoaderPatches)(unsigned long *usLength);
frankvnk 0:c44f0314d6ec 158 typedef void (*tWlanCB)(long event_type, char * data, unsigned char length );
frankvnk 0:c44f0314d6ec 159 typedef long (*tWlanReadInteruptPin)(void);
frankvnk 0:c44f0314d6ec 160 typedef void (*tWlanInterruptEnable)(void);
frankvnk 0:c44f0314d6ec 161 typedef void (*tWlanInterruptDisable)(void);
frankvnk 0:c44f0314d6ec 162 typedef void (*tWriteWlanPin)(unsigned char val);
frankvnk 0:c44f0314d6ec 163
frankvnk 0:c44f0314d6ec 164 typedef struct
frankvnk 0:c44f0314d6ec 165 {
frankvnk 1:bbcaf0b2f367 166 unsigned short usRxEventOpcode;
frankvnk 1:bbcaf0b2f367 167 unsigned short usEventOrDataReceived;
frankvnk 1:bbcaf0b2f367 168 unsigned char *pucReceivedData;
frankvnk 1:bbcaf0b2f367 169 unsigned char *pucTxCommandBuffer;
frankvnk 1:bbcaf0b2f367 170 tFWPatches sFWPatches;
frankvnk 1:bbcaf0b2f367 171 tDriverPatches sDriverPatches;
frankvnk 1:bbcaf0b2f367 172 tBootLoaderPatches sBootLoaderPatches;
frankvnk 1:bbcaf0b2f367 173 tWlanCB sWlanCB;
frankvnk 0:c44f0314d6ec 174 tWlanReadInteruptPin ReadWlanInterruptPin;
frankvnk 0:c44f0314d6ec 175 tWlanInterruptEnable WlanInterruptEnable;
frankvnk 0:c44f0314d6ec 176 tWlanInterruptDisable WlanInterruptDisable;
frankvnk 0:c44f0314d6ec 177 tWriteWlanPin WriteWlanPin;
frankvnk 1:bbcaf0b2f367 178 signed long slTransmitDataError;
frankvnk 1:bbcaf0b2f367 179 unsigned short usNumberOfFreeBuffers;
frankvnk 1:bbcaf0b2f367 180 unsigned short usSlBufferLength;
frankvnk 1:bbcaf0b2f367 181 unsigned short usBufferSize;
frankvnk 1:bbcaf0b2f367 182 unsigned short usRxDataPending;
frankvnk 1:bbcaf0b2f367 183 unsigned long NumberOfSentPackets;
frankvnk 1:bbcaf0b2f367 184 unsigned long NumberOfReleasedPackets;
frankvnk 1:bbcaf0b2f367 185 unsigned char InformHostOnTxComplete;
frankvnk 0:c44f0314d6ec 186 }sSimplLinkInformation;
frankvnk 0:c44f0314d6ec 187
frankvnk 0:c44f0314d6ec 188 extern volatile sSimplLinkInformation tSLInformation;
frankvnk 0:c44f0314d6ec 189
frankvnk 0:c44f0314d6ec 190
frankvnk 0:c44f0314d6ec 191 //*****************************************************************************
frankvnk 0:c44f0314d6ec 192 // Prototypes for the APIs.
frankvnk 0:c44f0314d6ec 193 //*****************************************************************************
frankvnk 0:c44f0314d6ec 194
frankvnk 4:d8255a5aad46 195 /**
frankvnk 4:d8255a5aad46 196 * Wait for event, pass it to the hci_event_handler and update the event opcode in a global variable.
frankvnk 4:d8255a5aad46 197 * @param usOpcode command operation code
frankvnk 4:d8255a5aad46 198 * @param pRetParams command return parameters
frankvnk 4:d8255a5aad46 199 * @return none
frankvnk 4:d8255a5aad46 200 */
frankvnk 0:c44f0314d6ec 201 extern void SimpleLinkWaitEvent(unsigned short usOpcode, void *pRetParams);
frankvnk 0:c44f0314d6ec 202
frankvnk 4:d8255a5aad46 203 /**
frankvnk 4:d8255a5aad46 204 * 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 205 * @param pBuf data buffer
frankvnk 4:d8255a5aad46 206 * @param from from information
frankvnk 4:d8255a5aad46 207 * @param fromlen from information length
frankvnk 4:d8255a5aad46 208 * @return none
frankvnk 4:d8255a5aad46 209 */
frankvnk 0:c44f0314d6ec 210 extern void SimpleLinkWaitData(unsigned char *pBuf, unsigned char *from, unsigned char *fromlen);
frankvnk 0:c44f0314d6ec 211
frankvnk 4:d8255a5aad46 212 /**
frankvnk 4:d8255a5aad46 213 * Copy 32 bit to stream while converting to little endian format.
frankvnk 4:d8255a5aad46 214 * @param p pointer to the new stream
frankvnk 4:d8255a5aad46 215 * @param u32 pointer to the 32 bit
frankvnk 4:d8255a5aad46 216 * @return pointer to the new stream
frankvnk 4:d8255a5aad46 217 */
frankvnk 0:c44f0314d6ec 218 extern unsigned char* UINT32_TO_STREAM_f (unsigned char *p, unsigned long u32);
frankvnk 0:c44f0314d6ec 219
frankvnk 4:d8255a5aad46 220 /**
frankvnk 4:d8255a5aad46 221 * Copy 16 bit to stream while converting to little endian format.
frankvnk 4:d8255a5aad46 222 * @param p pointer to the new stream
frankvnk 4:d8255a5aad46 223 * @param u32 pointer to the 16 bit
frankvnk 4:d8255a5aad46 224 * @return pointer to the new stream
frankvnk 4:d8255a5aad46 225 */
frankvnk 0:c44f0314d6ec 226 extern unsigned char* UINT16_TO_STREAM_f (unsigned char *p, unsigned short u16);
frankvnk 0:c44f0314d6ec 227
frankvnk 4:d8255a5aad46 228 /**
frankvnk 4:d8255a5aad46 229 * Copy received stream to 16 bit in little endian format.
frankvnk 4:d8255a5aad46 230 * @param p pointer to the stream
frankvnk 4:d8255a5aad46 231 * @param offset offset in the stream
frankvnk 4:d8255a5aad46 232 * @return pointer to the new 16 bit
frankvnk 4:d8255a5aad46 233 */
frankvnk 0:c44f0314d6ec 234 extern unsigned short STREAM_TO_UINT16_f(char* p, unsigned short offset);
frankvnk 0:c44f0314d6ec 235
frankvnk 4:d8255a5aad46 236 /**
frankvnk 4:d8255a5aad46 237 * Copy received stream to 32 bit in little endian format.
frankvnk 4:d8255a5aad46 238 * @param p pointer to the stream
frankvnk 4:d8255a5aad46 239 * @param offset offset in the stream
frankvnk 4:d8255a5aad46 240 * @return pointer to the new 32 bit
frankvnk 4:d8255a5aad46 241 */
frankvnk 0:c44f0314d6ec 242 extern unsigned long STREAM_TO_UINT32_f(char* p, unsigned short offset);
frankvnk 0:c44f0314d6ec 243
frankvnk 0:c44f0314d6ec 244
frankvnk 0:c44f0314d6ec 245 //*****************************************************************************
frankvnk 0:c44f0314d6ec 246 // COMMON MACROs
frankvnk 0:c44f0314d6ec 247 //*****************************************************************************
frankvnk 0:c44f0314d6ec 248
frankvnk 0:c44f0314d6ec 249
frankvnk 4:d8255a5aad46 250 //Copy 8 bit to stream while converting to little endian format.
frankvnk 0:c44f0314d6ec 251 #define UINT8_TO_STREAM(_p, _val) {*(_p)++ = (_val);}
frankvnk 4:d8255a5aad46 252 //Copy 16 bit to stream while converting to little endian format.
frankvnk 0:c44f0314d6ec 253 #define UINT16_TO_STREAM(_p, _u16) (UINT16_TO_STREAM_f(_p, _u16))
frankvnk 4:d8255a5aad46 254 //Copy 32 bit to stream while converting to little endian format.
frankvnk 0:c44f0314d6ec 255 #define UINT32_TO_STREAM(_p, _u32) (UINT32_TO_STREAM_f(_p, _u32))
frankvnk 4:d8255a5aad46 256 //Copy a specified value length bits (l) to stream while converting to little endian format.
frankvnk 0:c44f0314d6ec 257 #define ARRAY_TO_STREAM(p, a, l) {register short _i; for (_i = 0; _i < l; _i++) *(p)++ = ((unsigned char *) a)[_i];}
frankvnk 4:d8255a5aad46 258 //Copy received stream to 8 bit in little endian format.
frankvnk 0:c44f0314d6ec 259 #define STREAM_TO_UINT8(_p, _offset, _u8) {_u8 = (unsigned char)(*(_p + _offset));}
frankvnk 4:d8255a5aad46 260 //Copy received stream to 16 bit in little endian format.
frankvnk 0:c44f0314d6ec 261 #define STREAM_TO_UINT16(_p, _offset, _u16) {_u16 = STREAM_TO_UINT16_f(_p, _offset);}
frankvnk 4:d8255a5aad46 262 //Copy received stream to 32 bit in little endian format.
frankvnk 0:c44f0314d6ec 263 #define STREAM_TO_UINT32(_p, _offset, _u32) {_u32 = STREAM_TO_UINT32_f(_p, _offset);}
frankvnk 0:c44f0314d6ec 264 #define STREAM_TO_STREAM(p, a, l) {register short _i; for (_i = 0; _i < l; _i++) *(a)++= ((unsigned char *) p)[_i];}
frankvnk 0:c44f0314d6ec 265
frankvnk 0:c44f0314d6ec 266 #ifdef __cplusplus
frankvnk 0:c44f0314d6ec 267 }
frankvnk 0:c44f0314d6ec 268 #endif // __cplusplus
frankvnk 5:854f9b13a0f9 269 //*****************************************************************************
frankvnk 5:854f9b13a0f9 270 //
frankvnk 5:854f9b13a0f9 271 // Close the Doxygen group.
frankvnk 5:854f9b13a0f9 272 //! @}
frankvnk 5:854f9b13a0f9 273 //
frankvnk 5:854f9b13a0f9 274 //*****************************************************************************
frankvnk 0:c44f0314d6ec 275
frankvnk 0:c44f0314d6ec 276 #endif // __COMMON_H__
frankvnk 0:c44f0314d6ec 277
frankvnk 5:854f9b13a0f9 278