cc3000_hostdriver_mbedsocket - cc3000 hostdriver with the mbed socket interface

Users » frankvnk » Code » cc3000_hostdriver_mbedsocket

Frank Vannieuwkerke / cc3000_hostdriver_mbedsocket

cc3000 hostdriver with the mbed socket interface

Fork of cc3000_hostdriver_mbedsocket by Martin Kojtal

cc3000.h@38:1d374a7f0c0d, 2013-10-08 (annotated)

Committer:: SolderSplashLabs
Date:: Tue Oct 08 22:37:53 2013 +0000
Revision:: 38:1d374a7f0c0d
Parent:: 35:9dd909fb7caf
Child:: 39:03ac37ab34eb

Enabling debugging

Who changed what in which revision?

User	Revision	Line number	New contents of line
Kojto	20:30b6ed7bf8fd	1	/*****************************************************************************
Kojto	20:30b6ed7bf8fd	2	*
Kojto	20:30b6ed7bf8fd	3	* C++ interface/implementation created by Martin Kojtal (0xc0170). Thanks to
Kojto	20:30b6ed7bf8fd	4	* Jim Carver and Frank Vannieuwkerke for their inital cc3000 mbed port and
Kojto	20:30b6ed7bf8fd	5	* provided help.
Kojto	20:30b6ed7bf8fd	6	*
Kojto	20:30b6ed7bf8fd	7	* This version of "host driver" uses CC3000 Host Driver Implementation. Thus
Kojto	20:30b6ed7bf8fd	8	* read the following copyright:
Kojto	20:30b6ed7bf8fd	9	*
Kojto	20:30b6ed7bf8fd	10	* Copyright (C) 2011 Texas Instruments Incorporated - http://www.ti.com/
Kojto	20:30b6ed7bf8fd	11	*
Kojto	20:30b6ed7bf8fd	12	* Redistribution and use in source and binary forms, with or without
Kojto	20:30b6ed7bf8fd	13	* modification, are permitted provided that the following conditions
Kojto	20:30b6ed7bf8fd	14	* are met:
Kojto	20:30b6ed7bf8fd	15	*
Kojto	20:30b6ed7bf8fd	16	* Redistributions of source code must retain the above copyright
Kojto	20:30b6ed7bf8fd	17	* notice, this list of conditions and the following disclaimer.
Kojto	20:30b6ed7bf8fd	18	*
Kojto	20:30b6ed7bf8fd	19	* Redistributions in binary form must reproduce the above copyright
Kojto	20:30b6ed7bf8fd	20	* notice, this list of conditions and the following disclaimer in the
Kojto	20:30b6ed7bf8fd	21	* documentation and/or other materials provided with the
Kojto	20:30b6ed7bf8fd	22	* distribution.
Kojto	20:30b6ed7bf8fd	23	*
Kojto	20:30b6ed7bf8fd	24	* Neither the name of Texas Instruments Incorporated nor the names of
Kojto	20:30b6ed7bf8fd	25	* its contributors may be used to endorse or promote products derived
Kojto	20:30b6ed7bf8fd	26	* from this software without specific prior written permission.
Kojto	20:30b6ed7bf8fd	27	*
Kojto	20:30b6ed7bf8fd	28	* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
Kojto	20:30b6ed7bf8fd	29	* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
Kojto	20:30b6ed7bf8fd	30	* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
Kojto	20:30b6ed7bf8fd	31	* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
Kojto	20:30b6ed7bf8fd	32	* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
Kojto	20:30b6ed7bf8fd	33	* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
Kojto	20:30b6ed7bf8fd	34	* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
Kojto	20:30b6ed7bf8fd	35	* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
Kojto	20:30b6ed7bf8fd	36	* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
Kojto	20:30b6ed7bf8fd	37	* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
Kojto	20:30b6ed7bf8fd	38	* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Kojto	20:30b6ed7bf8fd	39	*
Kojto	20:30b6ed7bf8fd	40	*****************************************************************************/
Kojto	20:30b6ed7bf8fd	41	#ifndef CC3000_H
Kojto	20:30b6ed7bf8fd	42	#define CC3000_H
Kojto	20:30b6ed7bf8fd	43
Kojto	20:30b6ed7bf8fd	44	#include "mbed.h"
Kojto	20:30b6ed7bf8fd	45	#include "cc3000_common.h"
Kojto	20:30b6ed7bf8fd	46	#include "cc3000_spi.h"
Kojto	20:30b6ed7bf8fd	47	#include "cc3000_simplelink.h"
Kojto	20:30b6ed7bf8fd	48	#include "cc3000_netapp.h"
Kojto	20:30b6ed7bf8fd	49	#include "cc3000_nvmem.h"
Kojto	20:30b6ed7bf8fd	50	#include "cc3000_socket.h"
Kojto	20:30b6ed7bf8fd	51
Kojto	20:30b6ed7bf8fd	52	#define MAX_SOCKETS 4
Kojto	20:30b6ed7bf8fd	53
Kojto	35:9dd909fb7caf	54	/** Enable debug messages, remove comment from the ones you want or all.
Kojto	20:30b6ed7bf8fd	55	*/
SolderSplashLabs	26:456f73ed2a75	56
SolderSplashLabs	24:ba3fa29197ac	57	// Debug - Socket interface messages
SolderSplashLabs	38:1d374a7f0c0d	58	#define CC3000_DEBUG_SOCKET
SolderSplashLabs	26:456f73ed2a75	59
SolderSplashLabs	24:ba3fa29197ac	60	// Debug - HCI TX messages
SolderSplashLabs	38:1d374a7f0c0d	61	#define CC3000_DEBUG_HCI_TX
SolderSplashLabs	26:456f73ed2a75	62
SolderSplashLabs	24:ba3fa29197ac	63	// Debug - HCI Rx messages
SolderSplashLabs	38:1d374a7f0c0d	64	#define CC3000_DEBUG_HCI_RX
SolderSplashLabs	26:456f73ed2a75	65
SolderSplashLabs	24:ba3fa29197ac	66	// Debug - General Debug
SolderSplashLabs	38:1d374a7f0c0d	67	#define CC3000_DEBUG
Kojto	20:30b6ed7bf8fd	68
SolderSplashLabs	26:456f73ed2a75	69	// Add colour to the debug messages, requires a VT100 terminal like putty, comment out to remove
SolderSplashLabs	38:1d374a7f0c0d	70	#define VT100_COLOUR
SolderSplashLabs	22:d23c59fec0dc	71
SolderSplashLabs	22:d23c59fec0dc	72	#ifdef CC3000_DEBUG_SOCKET
Kojto	20:30b6ed7bf8fd	73
SolderSplashLabs	22:d23c59fec0dc	74	#ifdef VT100_COLOUR
SolderSplashLabs	22:d23c59fec0dc	75	#define DBG_SOCKET(x, ...) std::printf("\x1b[2;32;40m[CC3000 : SOCKET] "x"\x1b[0;37;40m\r\n", ##__VA_ARGS__);
SolderSplashLabs	22:d23c59fec0dc	76	#else
SolderSplashLabs	22:d23c59fec0dc	77	#define DBG_SOCKET(x, ...) std::printf("[CC3000 : SOCKET] "x"\r\n", ##__VA_ARGS__);
SolderSplashLabs	22:d23c59fec0dc	78	#endif
Kojto	29:c40918cd9b6d	79
Kojto	20:30b6ed7bf8fd	80	#else
Kojto	20:30b6ed7bf8fd	81	#define DBG_SOCKET(x, ...)
SolderSplashLabs	22:d23c59fec0dc	82	#endif
SolderSplashLabs	22:d23c59fec0dc	83
SolderSplashLabs	22:d23c59fec0dc	84	#ifdef CC3000_DEBUG_HCI_TX
SolderSplashLabs	22:d23c59fec0dc	85
SolderSplashLabs	22:d23c59fec0dc	86	#ifdef VT100_COLOUR
SolderSplashLabs	22:d23c59fec0dc	87	#define DBG_HCI(x, ...) std::printf("\x1b[2;35;40m[CC3000 : HCI RX] "x"\x1b[0;37;40m\r\n", ##__VA_ARGS__);
SolderSplashLabs	22:d23c59fec0dc	88	#else
SolderSplashLabs	22:d23c59fec0dc	89	#define DBG_HCI(x, ...) std::printf("[CC3000 : HCI RX] "x"\r\n", ##__VA_ARGS__);
SolderSplashLabs	22:d23c59fec0dc	90	#endif
Kojto	29:c40918cd9b6d	91
SolderSplashLabs	22:d23c59fec0dc	92	#else
Kojto	20:30b6ed7bf8fd	93	#define DBG_HCI(x, ...)
SolderSplashLabs	22:d23c59fec0dc	94	#endif
SolderSplashLabs	22:d23c59fec0dc	95
SolderSplashLabs	22:d23c59fec0dc	96	#ifdef CC3000_DEBUG_HCI_RX
SolderSplashLabs	22:d23c59fec0dc	97
SolderSplashLabs	22:d23c59fec0dc	98	#ifdef VT100_COLOUR
SolderSplashLabs	22:d23c59fec0dc	99	#define DBG_HCI_CMD(x, ...) std::printf("\x1b[2;36;40m[CC3000 : HCI TX] "x"\x1b[0;37;40m\r\n", ##__VA_ARGS__);
SolderSplashLabs	22:d23c59fec0dc	100	#else
SolderSplashLabs	22:d23c59fec0dc	101	#define DBG_HCI_CMD(x, ...) std::printf("[CC3000 : HCI TX] "x"\r\n", ##__VA_ARGS__);
SolderSplashLabs	22:d23c59fec0dc	102	#endif
Kojto	29:c40918cd9b6d	103
SolderSplashLabs	22:d23c59fec0dc	104	#else
SolderSplashLabs	22:d23c59fec0dc	105	#define DBG_HCI_CMD(x, ...)
SolderSplashLabs	22:d23c59fec0dc	106	#endif
SolderSplashLabs	22:d23c59fec0dc	107
SolderSplashLabs	22:d23c59fec0dc	108
SolderSplashLabs	22:d23c59fec0dc	109	#ifdef CC3000_DEBUG
SolderSplashLabs	22:d23c59fec0dc	110
SolderSplashLabs	22:d23c59fec0dc	111	#ifdef VT100_COLOUR
SolderSplashLabs	22:d23c59fec0dc	112	#define DBG_CC(x, ...) std::printf("\x1b[2;32;40m[CC3000] "x"\x1b[0;37;40m\r\n", ##__VA_ARGS__);
SolderSplashLabs	22:d23c59fec0dc	113	#else
SolderSplashLabs	22:d23c59fec0dc	114	#define DBG_CC(x, ...) std::printf("[CC3000] "x"\r\n", ##__VA_ARGS__);
SolderSplashLabs	22:d23c59fec0dc	115	#endif
Kojto	29:c40918cd9b6d	116
SolderSplashLabs	22:d23c59fec0dc	117	#else
SolderSplashLabs	24:ba3fa29197ac	118	#define DBG_CC(x, ...)
Kojto	20:30b6ed7bf8fd	119	#endif
Kojto	20:30b6ed7bf8fd	120
Kojto	20:30b6ed7bf8fd	121	namespace mbed_cc3000 {
Kojto	20:30b6ed7bf8fd	122
Kojto	20:30b6ed7bf8fd	123	/** User info structure
Kojto	20:30b6ed7bf8fd	124	*/
Kojto	20:30b6ed7bf8fd	125	typedef struct {
Kojto	20:30b6ed7bf8fd	126	uint8_t FTC; // First time config performed
Kojto	20:30b6ed7bf8fd	127	uint8_t PP_version[2]; // Patch Programmer version
Kojto	20:30b6ed7bf8fd	128	uint8_t SERV_PACK[2]; // Service Pack Version
Kojto	20:30b6ed7bf8fd	129	uint8_t DRV_VER[3]; // Driver Version
Kojto	20:30b6ed7bf8fd	130	uint8_t FW_VER[3]; // Firmware Version
Kojto	20:30b6ed7bf8fd	131	uint8_t validCIK; // CIK[] is valid (Client Interface Key)
Kojto	20:30b6ed7bf8fd	132	uint8_t CIK[40];
Kojto	20:30b6ed7bf8fd	133	} tUserFS;
Kojto	20:30b6ed7bf8fd	134
Kojto	20:30b6ed7bf8fd	135	/** Function pointers which are not yet implemented
Kojto	20:30b6ed7bf8fd	136	*/
Kojto	20:30b6ed7bf8fd	137	enum FunctionNumber {
Kojto	20:30b6ed7bf8fd	138	FW_PATCHES = 0,
Kojto	20:30b6ed7bf8fd	139	DRIVER_PATCHES = 1,
Kojto	20:30b6ed7bf8fd	140	BOOTLOADER_PATCHES = 2,
Kojto	20:30b6ed7bf8fd	141	};
Kojto	20:30b6ed7bf8fd	142
Kojto	20:30b6ed7bf8fd	143	/** CC3000 Simple Link class which contains status of cc3000.
Kojto	20:30b6ed7bf8fd	144	*/
Kojto	20:30b6ed7bf8fd	145	class cc3000_simple_link {
Kojto	20:30b6ed7bf8fd	146	public:
Kojto	33:9e23b24fb4f3	147	/**
Kojto	33:9e23b24fb4f3	148	* \brief ctor - sets magic number in the buffers (overflow mark).
Kojto	33:9e23b24fb4f3	149	* \param none
Kojto	33:9e23b24fb4f3	150	* \return none
Kojto	20:30b6ed7bf8fd	151	*/
Kojto	20:30b6ed7bf8fd	152	cc3000_simple_link();
Kojto	33:9e23b24fb4f3	153	/**
Kojto	33:9e23b24fb4f3	154	* \brief dtor
Kojto	33:9e23b24fb4f3	155	* \param none
Kojto	33:9e23b24fb4f3	156	* \return none
Kojto	20:30b6ed7bf8fd	157	*/
Kojto	20:30b6ed7bf8fd	158	~cc3000_simple_link();
Kojto	33:9e23b24fb4f3	159	/**
Kojto	33:9e23b24fb4f3	160	* \brief Returns data received flag.
Kojto	33:9e23b24fb4f3	161	* \return Data received flag.
Kojto	20:30b6ed7bf8fd	162	*/
Kojto	20:30b6ed7bf8fd	163	uint8_t get_data_received_flag();
Kojto	33:9e23b24fb4f3	164	/**
Kojto	33:9e23b24fb4f3	165	* \brief Set data received flag.
Kojto	20:30b6ed7bf8fd	166	* \param value The value to be set.
Kojto	20:30b6ed7bf8fd	167	*/
Kojto	20:30b6ed7bf8fd	168	void set_data_received_flag(uint8_t value);
Kojto	20:30b6ed7bf8fd	169	/** Returns if tx was completed.
Kojto	20:30b6ed7bf8fd	170	* \return
Kojto	20:30b6ed7bf8fd	171	* true if tx was completed,
Kojto	20:30b6ed7bf8fd	172	* false otherwise.
Kojto	20:30b6ed7bf8fd	173	*/
Kojto	20:30b6ed7bf8fd	174	bool get_tx_complete_signal();
Kojto	20:30b6ed7bf8fd	175	/**
Kojto	33:9e23b24fb4f3	176	* \brief Sets flag that tx was completed.
Kojto	33:9e23b24fb4f3	177	* \param value Value to be set
Kojto	33:9e23b24fb4f3	178	* \return none
Kojto	20:30b6ed7bf8fd	179	*/
Kojto	20:30b6ed7bf8fd	180	void set_tx_complete_signal(bool value);
Kojto	20:30b6ed7bf8fd	181	/**
Kojto	33:9e23b24fb4f3	182	* \brief Get receive buffer.
Kojto	33:9e23b24fb4f3	183	* \param none
Kojto	33:9e23b24fb4f3	184	* \return Pointer to the receive buffer.
Kojto	20:30b6ed7bf8fd	185	*/
Kojto	20:30b6ed7bf8fd	186	uint8_t *get_received_buffer();
Kojto	20:30b6ed7bf8fd	187	/**
Kojto	33:9e23b24fb4f3	188	* \brief Get transmit buffer.
Kojto	33:9e23b24fb4f3	189	* \param none
Kojto	33:9e23b24fb4f3	190	* \return Pointer to the transmit buffer.
Kojto	20:30b6ed7bf8fd	191	*/
Kojto	20:30b6ed7bf8fd	192	uint8_t *get_transmit_buffer();
Kojto	20:30b6ed7bf8fd	193	/**
Kojto	33:9e23b24fb4f3	194	* \brief Get number of free buffers.
Kojto	33:9e23b24fb4f3	195	* \param none
Kojto	29:c40918cd9b6d	196	* \return
Kojto	33:9e23b24fb4f3	197	* Number of free buffers.
Kojto	20:30b6ed7bf8fd	198	*/
Kojto	20:30b6ed7bf8fd	199	uint16_t get_number_free_buffers();
Kojto	20:30b6ed7bf8fd	200	/**
Kojto	33:9e23b24fb4f3	201	* \brief Set number of free buffers.
Kojto	33:9e23b24fb4f3	202	* \param value Number of free buffers.
Kojto	33:9e23b24fb4f3	203	* \return none
Kojto	20:30b6ed7bf8fd	204	*/
Kojto	20:30b6ed7bf8fd	205	void set_number_free_buffers(uint16_t value);
Kojto	20:30b6ed7bf8fd	206	/**
Kojto	33:9e23b24fb4f3	207	* \brief Retrieve buffer length.
Kojto	33:9e23b24fb4f3	208	* \param none
Kojto	33:9e23b24fb4f3	209	* \return Buffer length
Kojto	20:30b6ed7bf8fd	210	*/
Kojto	20:30b6ed7bf8fd	211	uint16_t get_buffer_length();
Kojto	20:30b6ed7bf8fd	212	/**
Kojto	33:9e23b24fb4f3	213	* \brief Set buffer length
Kojto	33:9e23b24fb4f3	214	* \param value The length
Kojto	33:9e23b24fb4f3	215	* \return none
Kojto	20:30b6ed7bf8fd	216	*/
Kojto	20:30b6ed7bf8fd	217	void set_buffer_length(uint16_t value);
Kojto	20:30b6ed7bf8fd	218	/**
Kojto	33:9e23b24fb4f3	219	* \brief Retrieve pending data flag.
Kojto	33:9e23b24fb4f3	220	* \param none
Kojto	33:9e23b24fb4f3	221	* \return Pending data flag
Kojto	20:30b6ed7bf8fd	222	*/
Kojto	20:30b6ed7bf8fd	223	uint16_t get_pending_data();
Kojto	20:30b6ed7bf8fd	224	/**
Kojto	33:9e23b24fb4f3	225	* \brief Set pending data flag.
Kojto	33:9e23b24fb4f3	226	* \param value Pending data value.
Kojto	33:9e23b24fb4f3	227	* \return none
Kojto	20:30b6ed7bf8fd	228	*/
Kojto	20:30b6ed7bf8fd	229	void set_pending_data(uint16_t value);
Kojto	20:30b6ed7bf8fd	230	/**
Kojto	33:9e23b24fb4f3	231	* \brief Retreive op code.
Kojto	33:9e23b24fb4f3	232	* \param none
Kojto	33:9e23b24fb4f3	233	* \return Op code
Kojto	20:30b6ed7bf8fd	234	*/
Kojto	20:30b6ed7bf8fd	235	uint16_t get_op_code();
Kojto	20:30b6ed7bf8fd	236	/**
Kojto	33:9e23b24fb4f3	237	* \brief Set op code.
Kojto	33:9e23b24fb4f3	238	* \param code op code.
Kojto	33:9e23b24fb4f3	239	* \return none
Kojto	20:30b6ed7bf8fd	240	*/
Kojto	20:30b6ed7bf8fd	241	void set_op_code(uint16_t code);
Kojto	20:30b6ed7bf8fd	242	/**
Kojto	33:9e23b24fb4f3	243	* \brief Get number of released packets.
Kojto	33:9e23b24fb4f3	244	* \param none
Kojto	33:9e23b24fb4f3	245	* \return Number of released packets.
Kojto	20:30b6ed7bf8fd	246	*/
Kojto	20:30b6ed7bf8fd	247	uint16_t get_released_packets();
Kojto	20:30b6ed7bf8fd	248	/**
Kojto	33:9e23b24fb4f3	249	* \brief Set number of released packets.
Kojto	33:9e23b24fb4f3	250	* \param value Number of released packets.
Kojto	33:9e23b24fb4f3	251	* \return none
Kojto	20:30b6ed7bf8fd	252	*/
Kojto	20:30b6ed7bf8fd	253	void set_number_of_released_packets(uint16_t value);
Kojto	20:30b6ed7bf8fd	254	/**
Kojto	33:9e23b24fb4f3	255	* \brief Get number of sent packats
Kojto	33:9e23b24fb4f3	256	* \param none
Kojto	33:9e23b24fb4f3	257	* \return Number of sent packets.
Kojto	20:30b6ed7bf8fd	258	*/
Kojto	20:30b6ed7bf8fd	259	uint16_t get_sent_packets();
Kojto	20:30b6ed7bf8fd	260	/**
Kojto	33:9e23b24fb4f3	261	* \brief Set number of sent packets
Kojto	33:9e23b24fb4f3	262	* \param value Number of sent packets.
Kojto	33:9e23b24fb4f3	263	* \return none
Kojto	20:30b6ed7bf8fd	264	*/
Kojto	20:30b6ed7bf8fd	265	void set_sent_packets(uint16_t value);
Kojto	29:c40918cd9b6d	266	/**
Kojto	33:9e23b24fb4f3	267	* \brief Retrieve transmit error
Kojto	33:9e23b24fb4f3	268	* \param none
Kojto	33:9e23b24fb4f3	269	* \return Transmit error
Kojto	29:c40918cd9b6d	270	*/
Kojto	20:30b6ed7bf8fd	271	int32_t get_transmit_error();
Kojto	29:c40918cd9b6d	272	/**
Kojto	33:9e23b24fb4f3	273	* \brief Set transmit error.
Kojto	33:9e23b24fb4f3	274	* \param value Error to be set.
Kojto	33:9e23b24fb4f3	275	* \return none
Kojto	29:c40918cd9b6d	276	*/
Kojto	20:30b6ed7bf8fd	277	void set_transmit_error(int32_t value);
Kojto	29:c40918cd9b6d	278	/**
Kojto	33:9e23b24fb4f3	279	* \brief Get buffer size.
Kojto	33:9e23b24fb4f3	280	* \param none
Kojto	33:9e23b24fb4f3	281	* \return Size of buffer.
Kojto	29:c40918cd9b6d	282	*/
Kojto	33:9e23b24fb4f3	283	uint16_t get_buffer_size();
Kojto	29:c40918cd9b6d	284	/**
Kojto	33:9e23b24fb4f3	285	* \brief Set buffer size.
Kojto	33:9e23b24fb4f3	286	* \param value Buffer size.
Kojto	33:9e23b24fb4f3	287	* \return none
Kojto	29:c40918cd9b6d	288	*/
Kojto	20:30b6ed7bf8fd	289	void set_buffer_size(uint16_t value);
Kojto	29:c40918cd9b6d	290	/**
Kojto	33:9e23b24fb4f3	291	* \brief Not used currently.
Kojto	33:9e23b24fb4f3	292	* \param function Number of desired function.
Kojto	33:9e23b24fb4f3	293	* \return void pointer to the function (need to recast).
Kojto	29:c40918cd9b6d	294	*/
Kojto	20:30b6ed7bf8fd	295	void *get_func_pointer(FunctionNumber function);
Kojto	29:c40918cd9b6d	296	/**
Kojto	33:9e23b24fb4f3	297	* \brief Retreive pointer to the received data.
Kojto	33:9e23b24fb4f3	298	* \param none
Kojto	33:9e23b24fb4f3	299	* \return Pointer to the received data buffer.
Kojto	29:c40918cd9b6d	300	*/
Kojto	33:9e23b24fb4f3	301	uint8_t *get_received_data();
Kojto	29:c40918cd9b6d	302	/**
Kojto	33:9e23b24fb4f3	303	* \brief Set received data pointer.
Kojto	33:9e23b24fb4f3	304	* \param pointer Pointer to the buffer.
Kojto	33:9e23b24fb4f3	305	* \return none
Kojto	29:c40918cd9b6d	306	*/
Kojto	20:30b6ed7bf8fd	307	void set_received_data(uint8_t *pointer);
Kojto	20:30b6ed7bf8fd	308	private:
Kojto	20:30b6ed7bf8fd	309	uint8_t _data_received_flag;
Kojto	20:30b6ed7bf8fd	310	bool _tx_complete_signal;
Kojto	20:30b6ed7bf8fd	311	uint16_t _rx_event_opcode;
Kojto	20:30b6ed7bf8fd	312	uint16_t _free_buffers;
Kojto	20:30b6ed7bf8fd	313	uint16_t _buffer_length;
Kojto	20:30b6ed7bf8fd	314	uint16_t _buffer_size;
Kojto	20:30b6ed7bf8fd	315	uint16_t _rx_data_pending;
Kojto	20:30b6ed7bf8fd	316	uint16_t _sent_packets;
Kojto	20:30b6ed7bf8fd	317	uint16_t _released_packets;
Kojto	20:30b6ed7bf8fd	318	int32_t _transmit_data_error;
Kojto	20:30b6ed7bf8fd	319	uint8_t *_received_data;
Kojto	20:30b6ed7bf8fd	320	uint8_t _rx_buffer[CC3000_RX_BUFFER_SIZE];
Kojto	20:30b6ed7bf8fd	321	uint8_t _tx_buffer[CC3000_TX_BUFFER_SIZE];
Kojto	20:30b6ed7bf8fd	322	private:
Kojto	33:9e23b24fb4f3	323	/* Not used currently */
Kojto	20:30b6ed7bf8fd	324	int8_t ( _fFWPatches)(uint32_t *length);
Kojto	20:30b6ed7bf8fd	325	int8_t ( _fDriverPatches)(uint32_t *length);
Kojto	20:30b6ed7bf8fd	326	int8_t ( _fBootLoaderPatches)(uint32_t *length);
Kojto	20:30b6ed7bf8fd	327	};
Kojto	20:30b6ed7bf8fd	328
Kojto	20:30b6ed7bf8fd	329	/** Forward declaration classes
Kojto	20:30b6ed7bf8fd	330	*/
Kojto	20:30b6ed7bf8fd	331	class cc3000_hci;
Kojto	20:30b6ed7bf8fd	332	class cc3000_nvmem;
Kojto	20:30b6ed7bf8fd	333	class cc3000_spi;
Kojto	20:30b6ed7bf8fd	334	class cc3000;
Kojto	20:30b6ed7bf8fd	335
Kojto	31:7b6e85b68b01	336	/** Event layer
Kojto	20:30b6ed7bf8fd	337	*/
Kojto	20:30b6ed7bf8fd	338	class cc3000_event {
Kojto	20:30b6ed7bf8fd	339	public:
Kojto	29:c40918cd9b6d	340	/**
Kojto	29:c40918cd9b6d	341	* \brief
Kojto	34:1ad18123bf11	342	* \param simplelink Reference to simple link object.
Kojto	34:1ad18123bf11	343	* \param hci Reference to hci object.
Kojto	34:1ad18123bf11	344	* \param spi Reference to spi object.
Kojto	34:1ad18123bf11	345	* \param cc3000 Reference to cc3000 object.
Kojto	34:1ad18123bf11	346	* \return none
Kojto	29:c40918cd9b6d	347	*/
Kojto	20:30b6ed7bf8fd	348	cc3000_event(cc3000_simple_link &simplelink, cc3000_hci &hci, cc3000_spi &spi, cc3000 &cc3000);
Kojto	29:c40918cd9b6d	349	/**
Kojto	34:1ad18123bf11	350	* \brief Ctor
Kojto	34:1ad18123bf11	351	* \param none
Kojto	34:1ad18123bf11	352	* \return none
Kojto	29:c40918cd9b6d	353	*/
Kojto	29:c40918cd9b6d	354	~cc3000_event();
Kojto	34:1ad18123bf11	355	/**
Kojto	34:1ad18123bf11	356	* \brief Handle unsolicited event from type patch request.
Kojto	34:1ad18123bf11	357	* \param event_hdr event header
Kojto	34:1ad18123bf11	358	* \return none
Kojto	29:c40918cd9b6d	359	*/
Kojto	20:30b6ed7bf8fd	360	void hci_unsol_handle_patch_request(uint8_t *event_hdr);
Kojto	29:c40918cd9b6d	361	/**
Kojto	34:1ad18123bf11	362	* \brief Parse the incoming event packets and issue corresponding event handler from global array of handlers pointers.
Kojto	34:1ad18123bf11	363	* \param ret_param incoming data buffer
Kojto	34:1ad18123bf11	364	* \param from from information (in case of data received)
Kojto	34:1ad18123bf11	365	* \param fromlen from information length (in case of data received)
Kojto	34:1ad18123bf11	366	* \return none
Kojto	34:1ad18123bf11	367	*/
Kojto	20:30b6ed7bf8fd	368	uint8_t hci_event_handler(void ret_param, uint8_t from, uint8_t fromlen);
Kojto	29:c40918cd9b6d	369	/**
Kojto	34:1ad18123bf11	370	* \brief Handle unsolicited events.
Kojto	34:1ad18123bf11	371	* \param event_hdr Event header
Kojto	34:1ad18123bf11	372	* \return 1 if event supported and handled
Kojto	34:1ad18123bf11	373	* \return 0 if event is not supported
Kojto	34:1ad18123bf11	374	*/
Kojto	20:30b6ed7bf8fd	375	int32_t hci_unsol_event_handler(uint8_t *event_hdr);
Kojto	29:c40918cd9b6d	376	/**
Kojto	34:1ad18123bf11	377	* \brief Parse the incoming unsolicited event packets and start corresponding event handler.
Kojto	34:1ad18123bf11	378	* \param None
Kojto	34:1ad18123bf11	379	* \return ESUCCESS if successful, EFAIL if an error occurred.
Kojto	34:1ad18123bf11	380	*/
Kojto	20:30b6ed7bf8fd	381	int32_t hci_unsolicited_event_handler(void);
Kojto	29:c40918cd9b6d	382	/**
Kojto	34:1ad18123bf11	383	* \brief Get the socket status.
Kojto	34:1ad18123bf11	384	* \param Sd Socket IS
Kojto	34:1ad18123bf11	385	* \return Current status of the socket.
Kojto	34:1ad18123bf11	386	*/
Kojto	20:30b6ed7bf8fd	387	int32_t get_socket_active_status(int32_t sd);
Kojto	29:c40918cd9b6d	388	/**
Kojto	34:1ad18123bf11	389	* \brief Check if the socket ID and status are valid and set the global socket status accordingly.
Kojto	34:1ad18123bf11	390	* \param Sd Sock descr
Kojto	34:1ad18123bf11	391	* \param Status status to be set
Kojto	34:1ad18123bf11	392	* \return none
Kojto	34:1ad18123bf11	393	*/
Kojto	20:30b6ed7bf8fd	394	void set_socket_active_status(int32_t sd, int32_t status);
Kojto	29:c40918cd9b6d	395	/**
Kojto	34:1ad18123bf11	396	* \brief Keep track on the number of packets transmitted and update the number of free buffer in the SL device.
Kojto	34:1ad18123bf11	397	* \brief Called when unsolicited event = HCI_EVNT_DATA_UNSOL_FREE_BUFF has received.
Kojto	34:1ad18123bf11	398	* \param event pointer to the string contains parameters for IPERF.
Kojto	34:1ad18123bf11	399	* \return ESUCCESS if successful, EFAIL if an error occurred.
Kojto	34:1ad18123bf11	400	*/
Kojto	20:30b6ed7bf8fd	401	int32_t hci_event_unsol_flowcontrol_handler(uint8_t *event);
Kojto	29:c40918cd9b6d	402	/**
Kojto	34:1ad18123bf11	403	* \brief Update the socket status.
Kojto	34:1ad18123bf11	404	* \param resp_params Socket IS
Kojto	34:1ad18123bf11	405	* \return Current status of the socket.
Kojto	34:1ad18123bf11	406	*/
Kojto	20:30b6ed7bf8fd	407	void update_socket_active_status(uint8_t *resp_params);
Kojto	29:c40918cd9b6d	408	/**
Kojto	34:1ad18123bf11	409	* \brief Wait for event, pass it to the hci_event_handler and update the event opcode in a global variable.
Kojto	34:1ad18123bf11	410	* \param op_code Command operation code
Kojto	34:1ad18123bf11	411	* \param ret_param Command return parameters
Kojto	34:1ad18123bf11	412	* \return none
Kojto	29:c40918cd9b6d	413	*/
Kojto	20:30b6ed7bf8fd	414	void simplelink_wait_event(uint16_t op_code, void *ret_param);
Kojto	29:c40918cd9b6d	415	/**
Kojto	34:1ad18123bf11	416	* \brief Wait for data, pass it to the hci_event_handler and set the data available flag.
Kojto	34:1ad18123bf11	417	* \param buffer Data buffer
Kojto	34:1ad18123bf11	418	* \param from From information
Kojto	34:1ad18123bf11	419	* \param fromlen From information length
Kojto	34:1ad18123bf11	420	* \return none
Kojto	29:c40918cd9b6d	421	*/
Kojto	20:30b6ed7bf8fd	422	void simplelink_wait_data(uint8_t buffer, uint8_t from, uint8_t *fromlen);
Kojto	29:c40918cd9b6d	423	/**
Kojto	34:1ad18123bf11	424	* \brief Trigger Received event/data processing - called from the SPI library to receive the data
Kojto	34:1ad18123bf11	425	* \param buffer pointer to the received data buffer\n
Kojto	34:1ad18123bf11	426	* The function triggers Received event/data processing\n
Kojto	34:1ad18123bf11	427	* \return none
Kojto	29:c40918cd9b6d	428	*/
Kojto	20:30b6ed7bf8fd	429	void received_handler(uint8_t *buffer);
Kojto	34:1ad18123bf11	430	private:
Kojto	20:30b6ed7bf8fd	431	uint32_t socket_active_status;
Kojto	20:30b6ed7bf8fd	432	cc3000_simple_link &_simple_link;
Kojto	20:30b6ed7bf8fd	433	cc3000_hci &_hci;
Kojto	20:30b6ed7bf8fd	434	cc3000_spi &_spi;
Kojto	20:30b6ed7bf8fd	435	cc3000 &_cc3000;
Kojto	20:30b6ed7bf8fd	436	};
Kojto	20:30b6ed7bf8fd	437
Kojto	31:7b6e85b68b01	438	/** Netapp layer
Kojto	31:7b6e85b68b01	439	*/
Kojto	20:30b6ed7bf8fd	440	class cc3000_netapp {
Kojto	20:30b6ed7bf8fd	441	public:
Kojto	29:c40918cd9b6d	442	/**
Kojto	34:1ad18123bf11	443	* \brief Ctor
Kojto	34:1ad18123bf11	444	* \param simple_link Reference to the simple link object.
Kojto	34:1ad18123bf11	445	* \param nvmem Reference to the nvmem object.
Kojto	34:1ad18123bf11	446	* \param hci Reference to the hci object.
Kojto	34:1ad18123bf11	447	* \param event Reference to the event object.
Kojto	34:1ad18123bf11	448	* \return none
Kojto	29:c40918cd9b6d	449	*/
Kojto	20:30b6ed7bf8fd	450	cc3000_netapp(cc3000_simple_link &simple_link, cc3000_nvmem &nvmem, cc3000_hci &hci, cc3000_event &event);
Kojto	29:c40918cd9b6d	451	/**
Kojto	34:1ad18123bf11	452	* \brief Dtor
Kojto	34:1ad18123bf11	453	* \param none
Kojto	34:1ad18123bf11	454	* \return none
Kojto	29:c40918cd9b6d	455	*/
Kojto	20:30b6ed7bf8fd	456	~cc3000_netapp();
Kojto	29:c40918cd9b6d	457	/**
Kojto	34:1ad18123bf11	458	* \brief Configure device MAC address and store it in NVMEM.
Kojto	34:1ad18123bf11	459	* The value of the MAC address configured through the API will be\n
Kojto	34:1ad18123bf11	460	* stored in CC3000 non volatile memory, thus preserved over resets.\n
Kojto	34:1ad18123bf11	461	* \param mac device mac address, 6 bytes. Saved: yes
Kojto	34:1ad18123bf11	462	* \return return on success 0, otherwise error.
Kojto	29:c40918cd9b6d	463	*/
Kojto	20:30b6ed7bf8fd	464	int32_t config_mac_adrress(uint8_t *mac);
Kojto	29:c40918cd9b6d	465	/**
Kojto	34:1ad18123bf11	466	* \brief Configure the network interface, static or dynamic (DHCP).
Kojto	34:1ad18123bf11	467	* In order to activate DHCP mode, ip, subnet_mask, default_gateway must be 0.\n
Kojto	34:1ad18123bf11	468	* The default mode of CC3000 is DHCP mode. The configuration is saved in non volatile memory\n
Kojto	34:1ad18123bf11	469	* and thus preserved over resets.\n
Kojto	34:1ad18123bf11	470	* \param ip device mac address, 6 bytes. Saved: yes
Kojto	34:1ad18123bf11	471	* \param subnet_mask device mac address, 6 bytes. Saved: yes
Kojto	34:1ad18123bf11	472	* \param default_gateway device mac address, 6 bytes. Saved: yes
Kojto	34:1ad18123bf11	473	* \param dns_server device mac address, 6 bytes. Saved: yes
Kojto	34:1ad18123bf11	474	* \return 0 on success, otherwise error.
Kojto	34:1ad18123bf11	475	* \note If the mode is altered, a reset of CC3000 device is required to apply the changes.\n
Kojto	34:1ad18123bf11	476	* Also note that an asynchronous event of type 'DHCP_EVENT' is generated only when\n
Kojto	34:1ad18123bf11	477	* a connection to the AP was established. This event is generated when an IP address\n
Kojto	34:1ad18123bf11	478	* is allocated either by the DHCP server or by static allocation.\n
Kojto	29:c40918cd9b6d	479	*/
Kojto	20:30b6ed7bf8fd	480	int32_t dhcp(uint32_t ip, uint32_t subnet_mask,uint32_t default_gateway, uint32_t dns_server);
Kojto	20:30b6ed7bf8fd	481	#ifndef CC3000_TINY_DRIVER
Kojto	29:c40918cd9b6d	482	/**
Kojto	34:1ad18123bf11	483	* \brief Get the CC3000 Network interface information.
Kojto	34:1ad18123bf11	484	* This information is only available after establishing a WLAN connection.\n
Kojto	34:1ad18123bf11	485	* Undefined values are returned when this function is called before association.\n
Kojto	34:1ad18123bf11	486	* \param ipconfig pointer to a tNetappIpconfigRetArgs structure for storing the network interface configuration.\n
Kojto	34:1ad18123bf11	487	* tNetappIpconfigRetArgs: aucIP - ip address,\n
Kojto	34:1ad18123bf11	488	* aucSubnetMask - mask
Kojto	34:1ad18123bf11	489	* aucDefaultGateway - default gateway address\n
Kojto	34:1ad18123bf11	490	* aucDHCPServer - dhcp server address\n
Kojto	34:1ad18123bf11	491	* aucDNSServer - dns server address\n
Kojto	34:1ad18123bf11	492	* uaMacAddr - mac address\n
Kojto	34:1ad18123bf11	493	* uaSSID - connected AP ssid\n
Kojto	34:1ad18123bf11	494	* \return none
Kojto	34:1ad18123bf11	495	* \note This function is useful for figuring out the IP Configuration of\n
Kojto	34:1ad18123bf11	496	* the device when DHCP is used and for figuring out the SSID of\n
Kojto	34:1ad18123bf11	497	* the Wireless network the device is associated with.\n
Kojto	29:c40918cd9b6d	498	*/
Kojto	20:30b6ed7bf8fd	499	void ipconfig(tNetappIpconfigRetArgs *ipconfig);
Kojto	29:c40918cd9b6d	500	/**
Kojto	34:1ad18123bf11	501	* \brief Set new timeout values for DHCP lease timeout, ARP refresh timeout, keepalive event timeout and socket inactivity timeout
Kojto	34:1ad18123bf11	502	* \param dhcp DHCP lease time request, also impact\n
Kojto	34:1ad18123bf11	503	* the DHCP renew timeout.\n
Kojto	34:1ad18123bf11	504	* Range: [0-0xffffffff] seconds,\n
Kojto	34:1ad18123bf11	505	* 0 or 0xffffffff = infinite lease timeout.\n
Kojto	34:1ad18123bf11	506	* Resolution: 10 seconds.\n
Kojto	34:1ad18123bf11	507	* Influence: only after reconnecting to the AP. \n
Kojto	34:1ad18123bf11	508	* Minimal bound value: MIN_TIMER_VAL_SECONDS - 20 seconds.\n
Kojto	34:1ad18123bf11	509	* The parameter is saved into the CC3000 NVMEM.\n
Kojto	34:1ad18123bf11	510	* The default value on CC3000 is 14400 seconds.\n
Kojto	34:1ad18123bf11	511	*
Kojto	34:1ad18123bf11	512	* \param arp ARP refresh timeout, if ARP entry is not updated by\n
Kojto	34:1ad18123bf11	513	* incoming packet, the ARP entry will be deleted by\n
Kojto	34:1ad18123bf11	514	* the end of the timeout. \n
Kojto	34:1ad18123bf11	515	* Range: [0-0xffffffff] seconds, 0 = infinite ARP timeout\n
Kojto	34:1ad18123bf11	516	* Resolution: 10 seconds.\n
Kojto	34:1ad18123bf11	517	* Influence: at runtime.\n
Kojto	34:1ad18123bf11	518	* Minimal bound value: MIN_TIMER_VAL_SECONDS - 20 seconds\n
Kojto	34:1ad18123bf11	519	* The parameter is saved into the CC3000 NVMEM.\n
Kojto	34:1ad18123bf11	520	* The default value on CC3000 is 3600 seconds.\n
Kojto	34:1ad18123bf11	521	*
Kojto	34:1ad18123bf11	522	* \param keep_alive Keepalive event sent by the end of keepalive timeout\n
Kojto	34:1ad18123bf11	523	* Range: [0-0xffffffff] seconds, 0 == infinite timeout\n
Kojto	34:1ad18123bf11	524	* Resolution: 10 seconds.\n
Kojto	34:1ad18123bf11	525	* Influence: at runtime.\n
Kojto	34:1ad18123bf11	526	* Minimal bound value: MIN_TIMER_VAL_SECONDS - 20 sec\n
Kojto	34:1ad18123bf11	527	* The parameter is saved into the CC3000 NVMEM. \n
Kojto	34:1ad18123bf11	528	* The default value on CC3000 is 10 seconds.\n
Kojto	34:1ad18123bf11	529	*
Kojto	34:1ad18123bf11	530	* \param inactivity Socket inactivity timeout, socket timeout is\n
Kojto	34:1ad18123bf11	531	* refreshed by incoming or outgoing packet, by the\n
Kojto	34:1ad18123bf11	532	* end of the socket timeout the socket will be closed\n
Kojto	34:1ad18123bf11	533	* Range: [0-0xffffffff] sec, 0 == infinite timeout.\n
Kojto	34:1ad18123bf11	534	* Resolution: 10 seconds.\n
Kojto	34:1ad18123bf11	535	* Influence: at runtime.\n
Kojto	34:1ad18123bf11	536	* Minimal bound value: MIN_TIMER_VAL_SECONDS - 20 sec\n
Kojto	34:1ad18123bf11	537	* The parameter is saved into the CC3000 NVMEM.\n
Kojto	34:1ad18123bf11	538	* The default value on CC3000 is 60 seconds.\n
Kojto	34:1ad18123bf11	539	*
Kojto	34:1ad18123bf11	540	* \return 0 on success,otherwise error.
Kojto	34:1ad18123bf11	541	*
Kojto	34:1ad18123bf11	542	* \note A parameter set to a non zero value less than 20s automatically changes to 20s.
Kojto	29:c40918cd9b6d	543	*/
Kojto	20:30b6ed7bf8fd	544	int32_t timeout_values(uint32_t dhcp, uint32_t arp,uint32_t keep_alive, uint32_t inactivity);
Kojto	29:c40918cd9b6d	545	/**
Kojto	34:1ad18123bf11	546	* \brief send ICMP ECHO_REQUEST to network hosts
Kojto	34:1ad18123bf11	547	* \param ip destination IP address
Kojto	34:1ad18123bf11	548	* \param ping_attempts number of echo requests to send
Kojto	34:1ad18123bf11	549	* \param ping_size send buffer size which may be up to 1400 bytes
Kojto	34:1ad18123bf11	550	* \param ping_timeout Time to wait for a response,in milliseconds.
Kojto	34:1ad18123bf11	551	* \return 0 on success, otherwise error.
Kojto	34:1ad18123bf11	552	*
Kojto	34:1ad18123bf11	553	* \note A succesful operation will generate an asynchronous ping report event.\n
Kojto	34:1ad18123bf11	554	* The report structure is defined by structure netapp_pingreport_args_t.\n
Kojto	34:1ad18123bf11	555	* \warning Calling this function while a Ping Request is in progress will kill the ping request in progress.
Kojto	29:c40918cd9b6d	556	*/
Kojto	20:30b6ed7bf8fd	557	int32_t ping_send(uint32_t *ip, uint32_t ping_attempts, uint32_t ping_size, uint32_t ping_timeout);
Kojto	29:c40918cd9b6d	558	/**
Kojto	34:1ad18123bf11	559	* \brief Ping status request.
Kojto	34:1ad18123bf11	560	* This API triggers the CC3000 to send asynchronous events: HCI_EVNT_WLAN_ASYNC_PING_REPORT.\n
Kojto	34:1ad18123bf11	561	* This event will create the report structure in netapp_pingreport_args_t.\n
Kojto	34:1ad18123bf11	562	* This structure is filled with ping results until the API is triggered.\n
Kojto	34:1ad18123bf11	563	* netapp_pingreport_args_t: packets_sent - echo sent\n
Kojto	34:1ad18123bf11	564	* packets_received - echo reply\n
Kojto	34:1ad18123bf11	565	* min_round_time - minimum round time\n
Kojto	34:1ad18123bf11	566	* max_round_time - max round time\n
Kojto	34:1ad18123bf11	567	* avg_round_time - average round time\n
Kojto	34:1ad18123bf11	568	*
Kojto	34:1ad18123bf11	569	* \param none
Kojto	34:1ad18123bf11	570	* \return none
Kojto	34:1ad18123bf11	571	* \note When a ping operation is not active, the returned structure fields are 0.
Kojto	29:c40918cd9b6d	572	*/
Kojto	20:30b6ed7bf8fd	573	void ping_report();
Kojto	29:c40918cd9b6d	574	/**
Kojto	34:1ad18123bf11	575	* \brief Stop any ping request.
Kojto	34:1ad18123bf11	576	* \param none
Kojto	34:1ad18123bf11	577	* \return 0 on success
Kojto	34:1ad18123bf11	578	* -1 on error
Kojto	29:c40918cd9b6d	579	*/
Kojto	20:30b6ed7bf8fd	580	int32_t ping_stop();
Kojto	29:c40918cd9b6d	581	/**
Kojto	34:1ad18123bf11	582	* \brief Flush ARP table
Kojto	34:1ad18123bf11	583	* \param none
Kojto	34:1ad18123bf11	584	* \return none
Kojto	29:c40918cd9b6d	585	*/
Kojto	20:30b6ed7bf8fd	586	int32_t arp_flush();
Kojto	20:30b6ed7bf8fd	587	#endif
Kojto	20:30b6ed7bf8fd	588	private:
Kojto	20:30b6ed7bf8fd	589	cc3000_simple_link &_simple_link;
Kojto	20:30b6ed7bf8fd	590	cc3000_nvmem &_nvmem;
Kojto	20:30b6ed7bf8fd	591	cc3000_hci &_hci;
Kojto	20:30b6ed7bf8fd	592	cc3000_event &_event;
Kojto	20:30b6ed7bf8fd	593	};
Kojto	20:30b6ed7bf8fd	594
Kojto	20:30b6ed7bf8fd	595	#ifndef CC3000_UNENCRYPTED_SMART_CONFIG
Kojto	31:7b6e85b68b01	596	/** Security class used only if encrypted smart config is set
Kojto	31:7b6e85b68b01	597	*/
Kojto	20:30b6ed7bf8fd	598	class cc3000_security {
Kojto	20:30b6ed7bf8fd	599	public:
Kojto	29:c40918cd9b6d	600	/**
Kojto	34:1ad18123bf11	601	* \brief Expand a 16 bytes key for AES128 implementation.
Kojto	34:1ad18123bf11	602	* \param expanded_key expanded AES128 key
Kojto	34:1ad18123bf11	603	* \param key AES128 key - 16 bytes
Kojto	34:1ad18123bf11	604	* \return none
Kojto	29:c40918cd9b6d	605	*/
Kojto	20:30b6ed7bf8fd	606	void expandKey(uint8_t expanded_key, uint8_t key);
Kojto	29:c40918cd9b6d	607	/**
Kojto	34:1ad18123bf11	608	* \brief multiply by 2 in the galois field.
Kojto	34:1ad18123bf11	609	* \param value Argument to multiply
Kojto	34:1ad18123bf11	610	* \return multiplied argument
Kojto	29:c40918cd9b6d	611	*/
Kojto	20:30b6ed7bf8fd	612	uint8_t galois_mul2(uint8_t value);
Kojto	29:c40918cd9b6d	613	/**
Kojto	34:1ad18123bf11	614	* \brief internal implementation of AES128 encryption.
Kojto	34:1ad18123bf11	615	* straight forward aes encryption implementation\n
Kojto	34:1ad18123bf11	616	* first the group of operations
Kojto	34:1ad18123bf11	617	* - addRoundKey
Kojto	34:1ad18123bf11	618	* - subbytes
Kojto	34:1ad18123bf11	619	* - shiftrows
Kojto	34:1ad18123bf11	620	* - mixcolums\n
Kojto	34:1ad18123bf11	621	*
Kojto	34:1ad18123bf11	622	* is executed 9 times, after this addroundkey to finish the 9th\n
Kojto	34:1ad18123bf11	623	* round, after that the 10th round without mixcolums\n
Kojto	34:1ad18123bf11	624	* no further subfunctions to save cycles for function calls\n
Kojto	34:1ad18123bf11	625	* no structuring with "for (....)" to save cycles.\n
Kojto	34:1ad18123bf11	626	* \param[in] expanded_key expanded AES128 key
Kojto	34:1ad18123bf11	627	* \param[in/out] state 16 bytes of plain text and cipher text
Kojto	34:1ad18123bf11	628	* \return none
Kojto	29:c40918cd9b6d	629	*/
Kojto	20:30b6ed7bf8fd	630	void aes_encr(uint8_t state, uint8_t expanded_key);
Kojto	29:c40918cd9b6d	631	/**
Kojto	34:1ad18123bf11	632	* \brief internal implementation of AES128 decryption.
Kojto	34:1ad18123bf11	633	* straightforward aes decryption implementation\n
Kojto	34:1ad18123bf11	634	* the order of substeps is the exact reverse of decryption\n
Kojto	34:1ad18123bf11	635	* inverse functions:
Kojto	34:1ad18123bf11	636	* - addRoundKey is its own inverse
Kojto	34:1ad18123bf11	637	* - rsbox is inverse of sbox
Kojto	34:1ad18123bf11	638	* - rightshift instead of leftshift
Kojto	34:1ad18123bf11	639	* - invMixColumns = barreto + mixColumns\n
Kojto	34:1ad18123bf11	640	*
Kojto	34:1ad18123bf11	641	* no further subfunctions to save cycles for function calls\n
Kojto	34:1ad18123bf11	642	* no structuring with "for (....)" to save cycles\n
Kojto	34:1ad18123bf11	643	* \param[in] expanded_key expanded AES128 key
Kojto	34:1ad18123bf11	644	* \param[in\out] state 16 bytes of cipher text and plain text
Kojto	34:1ad18123bf11	645	* \return none
Kojto	29:c40918cd9b6d	646	*/
Kojto	20:30b6ed7bf8fd	647	void aes_decr(uint8_t state, uint8_t expanded_key);
Kojto	29:c40918cd9b6d	648	/**
Kojto	34:1ad18123bf11	649	* \brief AES128 encryption.
Kojto	34:1ad18123bf11	650	* Given AES128 key and 16 bytes plain text, cipher text of 16 bytes is computed.\n
Kojto	34:1ad18123bf11	651	* The AES implementation is in mode ECB (Electronic Code Book).\n
Kojto	34:1ad18123bf11	652	* \param[in] key AES128 key of size 16 bytes
Kojto	34:1ad18123bf11	653	* \param[in\out] state 16 bytes of plain text and cipher text
Kojto	34:1ad18123bf11	654	* \return none
Kojto	29:c40918cd9b6d	655	*/
Kojto	20:30b6ed7bf8fd	656	void aes_encrypt(uint8_t state, uint8_t key);
Kojto	29:c40918cd9b6d	657	/**
Kojto	34:1ad18123bf11	658	* \brief AES128 decryption.
Kojto	34:1ad18123bf11	659	* Given AES128 key and 16 bytes cipher text, plain text of 16 bytes is computed.\n
Kojto	34:1ad18123bf11	660	* The AES implementation is in mode ECB (Electronic Code Book).\n
Kojto	34:1ad18123bf11	661	* \param[in] key AES128 key of size 16 bytes
Kojto	34:1ad18123bf11	662	* \param[in\out] state 16 bytes of cipher text and plain text
Kojto	34:1ad18123bf11	663	* \return none
Kojto	29:c40918cd9b6d	664	*/
Kojto	20:30b6ed7bf8fd	665	void aes_decrypt(uint8_t state, uint8_t key);
Kojto	29:c40918cd9b6d	666	/**
Kojto	34:1ad18123bf11	667	* \brief Read the AES128 key from fileID #12 in EEPROM.
Kojto	34:1ad18123bf11	668	* \param[out] key AES128 key of size 16 bytes
Kojto	34:1ad18123bf11	669	* \return 0 on success, error otherwise.
Kojto	29:c40918cd9b6d	670	*/
Kojto	20:30b6ed7bf8fd	671	int32_t aes_read_key(uint8_t *key);
Kojto	29:c40918cd9b6d	672	/**
Kojto	34:1ad18123bf11	673	* \brief Write the AES128 key to fileID #12 in EEPROM.
Kojto	34:1ad18123bf11	674	* \param[out] key AES128 key of size 16 bytes
Kojto	34:1ad18123bf11	675	* \return on success 0, error otherwise.
Kojto	29:c40918cd9b6d	676	*/
Kojto	20:30b6ed7bf8fd	677	int32_t aes_write_key(uint8_t *key);
Kojto	20:30b6ed7bf8fd	678	private:
Kojto	20:30b6ed7bf8fd	679	uint8_t _expanded_key[176];
Kojto	20:30b6ed7bf8fd	680	};
Kojto	20:30b6ed7bf8fd	681	#endif
Kojto	20:30b6ed7bf8fd	682
Kojto	31:7b6e85b68b01	683	/** Socket layer
Kojto	31:7b6e85b68b01	684	*/
Kojto	20:30b6ed7bf8fd	685	class cc3000_socket {
Kojto	20:30b6ed7bf8fd	686	public:
Kojto	29:c40918cd9b6d	687	/**
Kojto	34:1ad18123bf11	688	* \brief Ctor
Kojto	34:1ad18123bf11	689	* \param simplelink Reference to simple link object.
Kojto	34:1ad18123bf11	690	* \param hci Reference to hci object.
Kojto	34:1ad18123bf11	691	* \param event Reference to event object.
Kojto	34:1ad18123bf11	692	* \return none
Kojto	29:c40918cd9b6d	693	*/
Kojto	20:30b6ed7bf8fd	694	cc3000_socket(cc3000_simple_link &simplelink, cc3000_hci &hci, cc3000_event &event);
Kojto	29:c40918cd9b6d	695	/**
Kojto	34:1ad18123bf11	696	* \brief Dtor
Kojto	29:c40918cd9b6d	697	* \param
Kojto	34:1ad18123bf11	698	* \return none
Kojto	29:c40918cd9b6d	699	*/
Kojto	20:30b6ed7bf8fd	700	~cc3000_socket();
Kojto	29:c40918cd9b6d	701	/**
Kojto	34:1ad18123bf11	702	* \brief create an endpoint for communication.
Kojto	34:1ad18123bf11	703	* The socket function creates a socket that is bound to a specific transport service provider.\n
Kojto	34:1ad18123bf11	704	* This function is called by the application layer to obtain a socket handle.\n
Kojto	34:1ad18123bf11	705	*
Kojto	34:1ad18123bf11	706	* \param domain selects the protocol family which will be used for\n
Kojto	34:1ad18123bf11	707	* communication. On this version only AF_INET is supported\n
Kojto	34:1ad18123bf11	708	* \param type specifies the communication semantics. On this version\n
Kojto	34:1ad18123bf11	709	* only SOCK_STREAM, SOCK_DGRAM, SOCK_RAW are supported\n
Kojto	34:1ad18123bf11	710	* \param protocol specifies a particular protocol to be used with the\n
Kojto	34:1ad18123bf11	711	* socket IPPROTO_TCP, IPPROTO_UDP or IPPROTO_RAW are supported.\n
Kojto	34:1ad18123bf11	712	* \return On success, socket handle that is used for consequent socket operations\n
Kojto	34:1ad18123bf11	713	* On error, -1 is returned.\n
Kojto	29:c40918cd9b6d	714	*/
Kojto	20:30b6ed7bf8fd	715	int32_t socket(int32_t domain, int32_t type, int32_t protocol);
Kojto	29:c40918cd9b6d	716	/**
Kojto	34:1ad18123bf11	717	* \brief accept a connection on a socket.
Kojto	34:1ad18123bf11	718	* This function is used with connection-based socket types\n
Kojto	34:1ad18123bf11	719	* (SOCK_STREAM). It extracts the first connection request on the\n
Kojto	34:1ad18123bf11	720	* queue of pending connections, creates a new connected socket, and\n
Kojto	34:1ad18123bf11	721	* returns a new file descriptor referring to that socket.\n
Kojto	34:1ad18123bf11	722	* The newly created socket is not in the listening state.\n
Kojto	34:1ad18123bf11	723	* The original socket sd is unaffected by this call.\n
Kojto	34:1ad18123bf11	724	* The argument sd is a socket that has been created with socket(),\n
Kojto	34:1ad18123bf11	725	* bound to a local address with bind(), and is listening for \n
Kojto	34:1ad18123bf11	726	* connections after a listen(). The argument addr is a pointer \n
Kojto	34:1ad18123bf11	727	* to a sockaddr structure. This structure is filled in with the \n
Kojto	34:1ad18123bf11	728	* address of the peer socket, as known to the communications layer.\n
Kojto	34:1ad18123bf11	729	* The exact format of the address returned addr is determined by the \n
Kojto	34:1ad18123bf11	730	* socket's address family. The addrlen argument is a value-result\n
Kojto	34:1ad18123bf11	731	* argument: it should initially contain the size of the structure\n
Kojto	34:1ad18123bf11	732	* pointed to by addr, on return it will contain the actual\n
Kojto	34:1ad18123bf11	733	* length (in bytes) of the address returned.\n
Kojto	34:1ad18123bf11	734	*
Kojto	34:1ad18123bf11	735	* \param[in] sd socket descriptor (handle)\n
Kojto	34:1ad18123bf11	736	* \param[out] addr the argument addr is a pointer to a sockaddr structure\n
Kojto	34:1ad18123bf11	737	* This structure is filled in with the address of the \n
Kojto	34:1ad18123bf11	738	* peer socket, as known to the communications layer. \n
Kojto	34:1ad18123bf11	739	* determined. The exact format of the address returned \n
Kojto	34:1ad18123bf11	740	* addr is by the socket's address sockaddr. \n
Kojto	34:1ad18123bf11	741	* On this version only AF_INET is supported.\n
Kojto	34:1ad18123bf11	742	* This argument returns in network order.\n
Kojto	34:1ad18123bf11	743	* \param[out] addrlen the addrlen argument is a value-result argument: \n
Kojto	34:1ad18123bf11	744	* it should initially contain the size of the structure\n
Kojto	34:1ad18123bf11	745	* pointed to by addr.\n
Kojto	34:1ad18123bf11	746	* \return For socket in blocking mode:\n
Kojto	34:1ad18123bf11	747	* - On success, socket handle. on failure negative\n
Kojto	34:1ad18123bf11	748	* For socket in non-blocking mode:\n
Kojto	34:1ad18123bf11	749	* - On connection establishment, socket handle\n
Kojto	34:1ad18123bf11	750	* - On connection pending, SOC_IN_PROGRESS (-2)\n
Kojto	34:1ad18123bf11	751	* - On failure, SOC_ERROR (-1)\n
Kojto	34:1ad18123bf11	752	* \sa socket ; bind ; listen
Kojto	29:c40918cd9b6d	753	*/
Kojto	20:30b6ed7bf8fd	754	int32_t accept(int32_t sd, sockaddr addr, socklen_t addrlen);
Kojto	29:c40918cd9b6d	755	/**
Kojto	34:1ad18123bf11	756	* \brief assign a name to a socket.
Kojto	34:1ad18123bf11	757	* This function gives the socket the local address addr.\n
Kojto	34:1ad18123bf11	758	* addr is addrlen bytes long. Traditionally, this is called when a \n
Kojto	34:1ad18123bf11	759	* socket is created with socket, it exists in a name space (address \n
Kojto	34:1ad18123bf11	760	* family) but has no name assigned.\n
Kojto	34:1ad18123bf11	761	* It is necessary to assign a local address before a SOCK_STREAM\n
Kojto	34:1ad18123bf11	762	* socket may receive connections.\n
Kojto	34:1ad18123bf11	763	*
Kojto	34:1ad18123bf11	764	* \param[in] sd socket descriptor (handle)
Kojto	34:1ad18123bf11	765	* \param[out] addr specifies the destination address. On this version\n
Kojto	34:1ad18123bf11	766	* only AF_INET is supported.\n
Kojto	34:1ad18123bf11	767	* \param[out] addrlen contains the size of the structure pointed to by addr.\n
Kojto	34:1ad18123bf11	768	* \return On success, zero is returned.\n
Kojto	34:1ad18123bf11	769	* On error, -1 is returned.\n
Kojto	34:1ad18123bf11	770	* \sa socket ; accept ; listen
Kojto	29:c40918cd9b6d	771	*/
Kojto	20:30b6ed7bf8fd	772	int32_t bind(int32_t sd, const sockaddr *addr, int32_t addrlen);
Kojto	29:c40918cd9b6d	773	/**
Kojto	34:1ad18123bf11	774	* \brief HostFlowControlConsumeBuff.
Kojto	34:1ad18123bf11	775	* if SEND_NON_BLOCKING is not defined - block until a free buffer is available,\n
Kojto	34:1ad18123bf11	776	* otherwise return the status of the available buffers.\n
Kojto	34:1ad18123bf11	777	*
Kojto	34:1ad18123bf11	778	* \param sd socket descriptor
Kojto	34:1ad18123bf11	779	* \return 0 in case there are buffers available, \n
Kojto	34:1ad18123bf11	780	* -1 in case of bad socket\n
Kojto	34:1ad18123bf11	781	* -2 if there are no free buffers present (only when SEND_NON_BLOCKING is enabled)\n
Kojto	29:c40918cd9b6d	782	*/
Kojto	20:30b6ed7bf8fd	783	int32_t HostFlowControlConsumeBuff(int32_t sd);
Kojto	29:c40918cd9b6d	784	/**
Kojto	34:1ad18123bf11	785	* \brief The socket function closes a created socket.
Kojto	34:1ad18123bf11	786	* \param sd socket handle.
Kojto	34:1ad18123bf11	787	* \return On success, zero is returned. On error, -1 is returned.
Kojto	29:c40918cd9b6d	788	*/
Kojto	20:30b6ed7bf8fd	789	int32_t closesocket(int32_t sd);
Kojto	29:c40918cd9b6d	790	/**
Kojto	34:1ad18123bf11	791	* \brief listen for connections on a socket.
Kojto	34:1ad18123bf11	792	* The willingness to accept incoming connections and a queue\n
Kojto	34:1ad18123bf11	793	* limit for incoming connections are specified with listen(),\n
Kojto	34:1ad18123bf11	794	* and then the connections are accepted with accept.\n
Kojto	34:1ad18123bf11	795	* The listen() call applies only to sockets of type SOCK_STREAM\n
Kojto	34:1ad18123bf11	796	* The backlog parameter defines the maximum length the queue of\n
Kojto	34:1ad18123bf11	797	* pending connections may grow to. \n
Kojto	34:1ad18123bf11	798	*
Kojto	34:1ad18123bf11	799	* \param[in] sd socket descriptor (handle)
Kojto	34:1ad18123bf11	800	* \param[in] backlog specifies the listen queue depth. On this version\n
Kojto	34:1ad18123bf11	801	* backlog is not supported.\n
Kojto	34:1ad18123bf11	802	* \return On success, zero is returned.\n
Kojto	34:1ad18123bf11	803	* On error, -1 is returned.\n
Kojto	34:1ad18123bf11	804	* \sa socket ; accept ; bind
Kojto	34:1ad18123bf11	805	* \note On this version, backlog is not supported
Kojto	29:c40918cd9b6d	806	*/
Kojto	20:30b6ed7bf8fd	807	int32_t listen(int32_t sd, int32_t backlog);
Kojto	29:c40918cd9b6d	808	/**
Kojto	34:1ad18123bf11	809	* \brief initiate a connection on a socket.
Kojto	34:1ad18123bf11	810	* Function connects the socket referred to by the socket descriptor\n
Kojto	34:1ad18123bf11	811	* sd, to the address specified by addr. The addrlen argument \n
Kojto	34:1ad18123bf11	812	* specifies the size of addr. The format of the address in addr is \n
Kojto	34:1ad18123bf11	813	* determined by the address space of the socket. If it is of type \n
Kojto	34:1ad18123bf11	814	* SOCK_DGRAM, this call specifies the peer with which the socket is \n
Kojto	34:1ad18123bf11	815	* to be associated; this address is that to which datagrams are to be\n
Kojto	34:1ad18123bf11	816	* sent, and the only address from which datagrams are to be received. \n
Kojto	34:1ad18123bf11	817	* If the socket is of type SOCK_STREAM, this call attempts to make a \n
Kojto	34:1ad18123bf11	818	* connection to another socket. The other socket is specified by \n
Kojto	34:1ad18123bf11	819	* address, which is an address in the communications space of the\n
Kojto	34:1ad18123bf11	820	* socket. Note that the function implements only blocking behavior \n
Kojto	34:1ad18123bf11	821	* thus the caller will be waiting either for the connection \n
Kojto	34:1ad18123bf11	822	* establishment or for the connection establishment failure.\n
Kojto	34:1ad18123bf11	823	*
Kojto	34:1ad18123bf11	824	* \param[in] sd socket descriptor (handle)
Kojto	34:1ad18123bf11	825	* \param[in] addr specifies the destination addr. On this version\n
Kojto	34:1ad18123bf11	826	* only AF_INET is supported.\n
Kojto	34:1ad18123bf11	827	* \param[out] addrlen contains the size of the structure pointed to by addr
Kojto	34:1ad18123bf11	828	* \return On success, zero is returned.\n
Kojto	34:1ad18123bf11	829	On error, -1 is returned\n
Kojto	34:1ad18123bf11	830	* \sa socket
Kojto	29:c40918cd9b6d	831	*/
Kojto	20:30b6ed7bf8fd	832	int32_t connect(int32_t sd, const sockaddr *addr, int32_t addrlen);
Kojto	29:c40918cd9b6d	833	/**
Kojto	34:1ad18123bf11	834	* \brief Monitor socket activity.
Kojto	34:1ad18123bf11	835	* Select allow a program to monitor multiple file descriptors,\n
Kojto	34:1ad18123bf11	836	* waiting until one or more of the file descriptors become \n
Kojto	34:1ad18123bf11	837	* "ready" for some class of I/O operation \n
Kojto	34:1ad18123bf11	838	*
Kojto	34:1ad18123bf11	839	* \param[in] nfds the highest-numbered file descriptor in any of the\n
Kojto	34:1ad18123bf11	840	* three sets, plus 1. \n
Kojto	34:1ad18123bf11	841	* \param[out] readsds socket descriptors list for read monitoring\n
Kojto	34:1ad18123bf11	842	* \param[out] writesds socket descriptors list for write monitoring\n
Kojto	34:1ad18123bf11	843	* \param[out] exceptsds socket descriptors list for exception monitoring\n
Kojto	34:1ad18123bf11	844	* \param[in] timeout is an upper bound on the amount of time elapsed\n
Kojto	34:1ad18123bf11	845	* before select() returns. Null means infinity \n
Kojto	34:1ad18123bf11	846	* timeout. The minimum timeout is 5 milliseconds,\n
Kojto	34:1ad18123bf11	847	* less than 5 milliseconds will be set\n
Kojto	34:1ad18123bf11	848	* automatically to 5 milliseconds.\n
Kojto	34:1ad18123bf11	849	* \return On success, select() returns the number of file descriptors\n
Kojto	34:1ad18123bf11	850	* contained in the three returned descriptor sets (that is, the\n
Kojto	34:1ad18123bf11	851	* total number of bits that are set in readfds, writefds,\n
Kojto	34:1ad18123bf11	852	* exceptfds) which may be zero if the timeout expires before\n
Kojto	34:1ad18123bf11	853	* anything interesting happens.\n
Kojto	34:1ad18123bf11	854	* On error, -1 is returned.\n
Kojto	34:1ad18123bf11	855	* *readsds - return the sockets on which Read request will\n
Kojto	34:1ad18123bf11	856	* return without delay with valid data.\n
Kojto	34:1ad18123bf11	857	* *writesds - return the sockets on which Write request \n
Kojto	34:1ad18123bf11	858	* will return without delay.\n
Kojto	34:1ad18123bf11	859	* *exceptsds - return the sockets which closed recently.\n
Kojto	34:1ad18123bf11	860	* \Note If the timeout value set to less than 5ms it will automatically\n
Kojto	34:1ad18123bf11	861	* change to 5ms to prevent overload of the system\n
Kojto	34:1ad18123bf11	862	* \sa socket
Kojto	29:c40918cd9b6d	863	*/
Kojto	20:30b6ed7bf8fd	864	int32_t select(int32_t nfds, fd_set readsds, fd_set writesds, fd_set exceptsds, struct timeval timeout);
Kojto	29:c40918cd9b6d	865	/**
Kojto	34:1ad18123bf11	866	* \brief get socket options.
Kojto	34:1ad18123bf11	867	* This function manipulate the options associated with a socket.\n
Kojto	34:1ad18123bf11	868	* Options may exist at multiple protocol levels; they are always\n
Kojto	34:1ad18123bf11	869	* present at the uppermost socket level.\n
Kojto	34:1ad18123bf11	870	* When manipulating socket options the level at which the option \n
Kojto	34:1ad18123bf11	871	* resides and the name of the option must be specified. \n
Kojto	34:1ad18123bf11	872	* To manipulate options at the socket level, level is specified as \n
Kojto	34:1ad18123bf11	873	* SOL_SOCKET. To manipulate options at any other level the protocol \n
Kojto	34:1ad18123bf11	874	* number of the appropriate protocol controlling the option is \n
Kojto	34:1ad18123bf11	875	* supplied. For example, to indicate that an option is to be \n
Kojto	34:1ad18123bf11	876	* interpreted by the TCP protocol, level should be set to the \n
Kojto	34:1ad18123bf11	877	* protocol number of TCP; \n
Kojto	34:1ad18123bf11	878	* The parameters optval and optlen are used to access optval -\n
Kojto	34:1ad18123bf11	879	* use for setsockopt(). For getsockopt() they identify a buffer\n
Kojto	34:1ad18123bf11	880	* in which the value for the requested option(s) are to \n
Kojto	34:1ad18123bf11	881	* be returned. For getsockopt(), optlen is a value-result \n
Kojto	34:1ad18123bf11	882	* parameter, initially containing the size of the buffer \n
Kojto	34:1ad18123bf11	883	* pointed to by option_value, and modified on return to \n
Kojto	34:1ad18123bf11	884	* indicate the actual size of the value returned. If no option \n
Kojto	34:1ad18123bf11	885	* value is to be supplied or returned, option_value may be NULL.\n
Kojto	34:1ad18123bf11	886	*
Kojto	34:1ad18123bf11	887	* \param[in] sd socket handle
Kojto	34:1ad18123bf11	888	* \param[in] level defines the protocol level for this option
Kojto	34:1ad18123bf11	889	* \param[in] optname defines the option name to Interrogate
Kojto	34:1ad18123bf11	890	* \param[out] optval specifies a value for the option
Kojto	34:1ad18123bf11	891	* \param[out] optlen specifies the length of the option value
Kojto	34:1ad18123bf11	892	* \return On success, zero is returned. On error, -1 is returned
Kojto	34:1ad18123bf11	893	*
Kojto	34:1ad18123bf11	894	* \Note On this version the following two socket options are enabled:\n
Kojto	34:1ad18123bf11	895	* The only protocol level supported in this version is SOL_SOCKET (level).\n
Kojto	34:1ad18123bf11	896	* 1. SOCKOPT_RECV_TIMEOUT (optname)\n
Kojto	34:1ad18123bf11	897	* SOCKOPT_RECV_TIMEOUT configures recv and recvfrom timeout in milliseconds.\n
Kojto	34:1ad18123bf11	898	* In that case optval should be pointer to unsigned long.\n
Kojto	34:1ad18123bf11	899	* 2. SOCKOPT_NONBLOCK (optname). sets the socket non-blocking mode on or off.\n
Kojto	34:1ad18123bf11	900	* In that case optval should be SOCK_ON or SOCK_OFF (optval).\n
Kojto	34:1ad18123bf11	901	* \sa setsockopt
Kojto	29:c40918cd9b6d	902	*/
Kojto	20:30b6ed7bf8fd	903	int32_t getsockopt (int32_t sd, int32_t level, int32_t optname, void optval, socklen_t optlen);
Kojto	29:c40918cd9b6d	904	/**
Kojto	34:1ad18123bf11	905	* \brief Read data from socket (simple_link_recv).
Kojto	34:1ad18123bf11	906	* Return the length of the message on successful completion.\n
Kojto	34:1ad18123bf11	907	* If a message is too long to fit in the supplied buffer, excess bytes may\n
Kojto	34:1ad18123bf11	908	* be discarded depending on the type of socket the message is received from.\n
Kojto	34:1ad18123bf11	909	*
Kojto	34:1ad18123bf11	910	* \param sd socket handle
Kojto	34:1ad18123bf11	911	* \param buf read buffer
Kojto	34:1ad18123bf11	912	* \param len buffer length
Kojto	34:1ad18123bf11	913	* \param flags indicates blocking or non-blocking operation
Kojto	34:1ad18123bf11	914	* \param from pointer to an address structure indicating source address
Kojto	34:1ad18123bf11	915	* \param fromlen source address structure size
Kojto	34:1ad18123bf11	916	* \return Return the number of bytes received, or -1 if an error occurred
Kojto	29:c40918cd9b6d	917	*/
Kojto	20:30b6ed7bf8fd	918	int32_t simple_link_recv(int32_t sd, void buf, int32_t len, int32_t flags, sockaddr from, socklen_t *fromlen, int32_t opcode);
Kojto	29:c40918cd9b6d	919	/**
Kojto	34:1ad18123bf11	920	* \brief Transmit a message to another socket (simple_link_send).
Kojto	34:1ad18123bf11	921	* \param sd socket handle
Kojto	34:1ad18123bf11	922	* \param buf write buffer
Kojto	34:1ad18123bf11	923	* \param len buffer length
Kojto	34:1ad18123bf11	924	* \param flags On this version, this parameter is not supported
Kojto	34:1ad18123bf11	925	* \param to pointer to an address structure indicating destination address
Kojto	34:1ad18123bf11	926	* \param tolen destination address structure size
Kojto	34:1ad18123bf11	927	* \return Return the number of bytes transmitted, or -1 if an error\n
Kojto	34:1ad18123bf11	928	* occurred, or -2 in case there are no free buffers available\n
Kojto	34:1ad18123bf11	929	* (only when SEND_NON_BLOCKING is enabled)\n
Kojto	29:c40918cd9b6d	930	*/
Kojto	20:30b6ed7bf8fd	931	int32_t simple_link_send(int32_t sd, const void buf, int32_t len, int32_t flags, const sockaddr to, int32_t tolen, int32_t opcode);
Kojto	29:c40918cd9b6d	932	/**
Kojto	34:1ad18123bf11	933	* \brief Receive a message from a connection-mode socket.
Kojto	34:1ad18123bf11	934	* \param[in] sd socket handle
Kojto	34:1ad18123bf11	935	* \param[out] buf Points to the buffer where the message should be stored
Kojto	34:1ad18123bf11	936	* \param[in] len Specifies the length in bytes of the buffer pointed to \n
Kojto	34:1ad18123bf11	937	* by the buffer argument.\n
Kojto	34:1ad18123bf11	938	* \param[in] flags Specifies the type of message reception. \n
Kojto	34:1ad18123bf11	939	* On this version, this parameter is not supported.\n
Kojto	34:1ad18123bf11	940	* \return Return the number of bytes received, or -1 if an error occurred
Kojto	34:1ad18123bf11	941	* \sa recvfrom
Kojto	34:1ad18123bf11	942	* \Note On this version, only blocking mode is supported.
Kojto	29:c40918cd9b6d	943	*/
Kojto	20:30b6ed7bf8fd	944	int32_t recv(int32_t sd, void *buf, int32_t len, int32_t flags);
Kojto	29:c40918cd9b6d	945	/**
Kojto	34:1ad18123bf11	946	* \brief read data from socket (recvfrom).
Kojto	34:1ad18123bf11	947	* Receives a message from a connection-mode or connectionless-mode socket.\n
Kojto	34:1ad18123bf11	948	* Note that raw sockets are not supported.\n
Kojto	34:1ad18123bf11	949	*
Kojto	34:1ad18123bf11	950	* \param[in] sd socket handle
Kojto	34:1ad18123bf11	951	* \param[out] buf Points to the buffer where the message should be stored
Kojto	34:1ad18123bf11	952	* \param[in] len Specifies the length in bytes of the buffer pointed to \n
Kojto	34:1ad18123bf11	953	* by the buffer argument.\n
Kojto	34:1ad18123bf11	954	* \param[in] flags Specifies the type of message reception.\n
Kojto	34:1ad18123bf11	955	* On this version, this parameter is not supported.\n
Kojto	34:1ad18123bf11	956	* \param[in] from pointer to an address structure indicating the source\n
Kojto	34:1ad18123bf11	957	* address: sockaddr. On this version only AF_INET is\n
Kojto	34:1ad18123bf11	958	* supported.\n
Kojto	34:1ad18123bf11	959	* \param[in] fromlen source address structure size
Kojto	34:1ad18123bf11	960	* \return Return the number of bytes received, or -1 if an error occurred
Kojto	34:1ad18123bf11	961	* \sa recv
Kojto	34:1ad18123bf11	962	* \Note On this version, only blocking mode is supported.
Kojto	29:c40918cd9b6d	963	*/
Kojto	20:30b6ed7bf8fd	964	int32_t recvfrom(int32_t sd, void buf, int32_t len, int32_t flags, sockaddr from, socklen_t *fromlen);
Kojto	29:c40918cd9b6d	965	/**
Kojto	34:1ad18123bf11	966	* \brief Transmit a message to another socket (send).
Kojto	34:1ad18123bf11	967	* \param sd socket handle
Kojto	34:1ad18123bf11	968	* \param buf Points to a buffer containing the message to be sent
Kojto	34:1ad18123bf11	969	* \param len message size in bytes
Kojto	34:1ad18123bf11	970	* \param flags On this version, this parameter is not supported
Kojto	34:1ad18123bf11	971	* \return Return the number of bytes transmitted, or -1 if an\n
Kojto	34:1ad18123bf11	972	* error occurred\n
Kojto	34:1ad18123bf11	973	* \Note On this version, only blocking mode is supported.
Kojto	34:1ad18123bf11	974	* \sa sendto
Kojto	29:c40918cd9b6d	975	*/
Kojto	20:30b6ed7bf8fd	976	int32_t send(int32_t sd, const void *buf, int32_t len, int32_t flags);
Kojto	29:c40918cd9b6d	977	/**
Kojto	34:1ad18123bf11	978	* \brief Transmit a message to another socket (sendto).
Kojto	34:1ad18123bf11	979	* \param sd socket handle
Kojto	34:1ad18123bf11	980	* \param buf Points to a buffer containing the message to be sent
Kojto	34:1ad18123bf11	981	* \param len message size in bytes
Kojto	34:1ad18123bf11	982	* \param flags On this version, this parameter is not supported
Kojto	34:1ad18123bf11	983	* \param to pointer to an address structure indicating the destination\n
Kojto	34:1ad18123bf11	984	* address: sockaddr. On this version only AF_INET is\n
Kojto	34:1ad18123bf11	985	* supported.\n
Kojto	34:1ad18123bf11	986	* \param tolen destination address structure size
Kojto	34:1ad18123bf11	987	* \return Return the number of bytes transmitted, or -1 if an error occurred
Kojto	34:1ad18123bf11	988	* \Note On this version, only blocking mode is supported.
Kojto	34:1ad18123bf11	989	* \sa send
Kojto	29:c40918cd9b6d	990	*/
Kojto	20:30b6ed7bf8fd	991	int32_t sendto(int32_t sd, const void buf, int32_t len, int32_t flags, const sockaddr to, socklen_t tolen);
Kojto	29:c40918cd9b6d	992	/**
Kojto	34:1ad18123bf11	993	* \brief Set CC3000 in mDNS advertiser mode in order to advertise itself.
Kojto	34:1ad18123bf11	994	* \param[in] mdns_enabled flag to enable/disable the mDNS feature
Kojto	34:1ad18123bf11	995	* \param[in] device_service_name Service name as part of the published\n
Kojto	34:1ad18123bf11	996	* canonical domain name\n
Kojto	34:1ad18123bf11	997	* \param[in] device_service_name_length Length of the service name
Kojto	34:1ad18123bf11	998	* \return On success, zero is returned,\n
Kojto	34:1ad18123bf11	999	* return SOC_ERROR if socket was not opened successfully, or if an error occurred.\n
Kojto	29:c40918cd9b6d	1000	*/
Kojto	20:30b6ed7bf8fd	1001	int32_t mdns_advertiser(uint16_t mdns_enabled, uint8_t * device_service_name, uint16_t device_service_name_length);
Kojto	20:30b6ed7bf8fd	1002	#ifndef CC3000_TINY_DRIVER
Kojto	33:9e23b24fb4f3	1003	/**
Kojto	34:1ad18123bf11	1004	* \brief Get host IP by name.\n
Kojto	34:1ad18123bf11	1005	* Obtain the IP Address of machine on network\n
Kojto	34:1ad18123bf11	1006	*
Kojto	34:1ad18123bf11	1007	* \param[in] hostname host name
Kojto	34:1ad18123bf11	1008	* \param[in] name_length name length
Kojto	34:1ad18123bf11	1009	* \param[out] out_ip_addr This parameter is filled in with host IP address.\n
Kojto	34:1ad18123bf11	1010	* In case that host name is not resolved, \n
Kojto	34:1ad18123bf11	1011	* out_ip_addr is zero.\n
Kojto	34:1ad18123bf11	1012	* \return On success, positive is returned.\n
Kojto	34:1ad18123bf11	1013	* On error, negative is returned by its name.\n
Kojto	34:1ad18123bf11	1014	* \note On this version, only blocking mode is supported. Also note that\n
Kojto	34:1ad18123bf11	1015	* The function requires DNS server to be configured prior to its usage.\n
Kojto	33:9e23b24fb4f3	1016	*/
Kojto	20:30b6ed7bf8fd	1017	int32_t gethostbyname(uint8_t hostname, uint16_t name_length, uint32_t out_ip_addr);
Kojto	29:c40918cd9b6d	1018	/**
Kojto	34:1ad18123bf11	1019	* \brief set socket options.
Kojto	34:1ad18123bf11	1020	* This function manipulate the options associated with a socket.\n
Kojto	34:1ad18123bf11	1021	* Options may exist at multiple protocol levels; they are always\n
Kojto	34:1ad18123bf11	1022	* present at the uppermost socket level.\n
Kojto	34:1ad18123bf11	1023	* When manipulating socket options the level at which the option \n
Kojto	34:1ad18123bf11	1024	* resides and the name of the option must be specified.\n
Kojto	34:1ad18123bf11	1025	* To manipulate options at the socket level, level is specified as\n
Kojto	34:1ad18123bf11	1026	* SOL_SOCKET. To manipulate options at any other level the protocol \n
Kojto	34:1ad18123bf11	1027	* number of the appropriate protocol controlling the option is \n
Kojto	34:1ad18123bf11	1028	* supplied. For example, to indicate that an option is to be \n
Kojto	34:1ad18123bf11	1029	* interpreted by the TCP protocol, level should be set to the \n
Kojto	34:1ad18123bf11	1030	* protocol number of TCP; \n
Kojto	34:1ad18123bf11	1031	* The parameters optval and optlen are used to access optval - \n
Kojto	34:1ad18123bf11	1032	* use for setsockopt(). For getsockopt() they identify a buffer\n
Kojto	34:1ad18123bf11	1033	* in which the value for the requested option(s) are to \n
Kojto	34:1ad18123bf11	1034	* be returned. For getsockopt(), optlen is a value-result \n
Kojto	34:1ad18123bf11	1035	* parameter, initially containing the size of the buffer \n
Kojto	34:1ad18123bf11	1036	* pointed to by option_value, and modified on return to \n
Kojto	34:1ad18123bf11	1037	* indicate the actual size of the value returned. If no option \n
Kojto	34:1ad18123bf11	1038	* value is to be supplied or returned, option_value may be NULL.\n
Kojto	34:1ad18123bf11	1039	*
Kojto	34:1ad18123bf11	1040	* \param[in] sd socket handle
Kojto	34:1ad18123bf11	1041	* \param[in] level defines the protocol level for this option
Kojto	34:1ad18123bf11	1042	* \param[in] optname defines the option name to Interrogate
Kojto	34:1ad18123bf11	1043	* \param[in] optval specifies a value for the option
Kojto	34:1ad18123bf11	1044	* \param[in] optlen specifies the length of the option value
Kojto	34:1ad18123bf11	1045	* \return On success, zero is returned.\n
Kojto	34:1ad18123bf11	1046	* On error, -1 is returned\n
Kojto	34:1ad18123bf11	1047	*
Kojto	34:1ad18123bf11	1048	* \Note On this version the following two socket options are enabled:\n
Kojto	34:1ad18123bf11	1049	* The only protocol level supported in this version is SOL_SOCKET (level).\n
Kojto	34:1ad18123bf11	1050	* 1. SOCKOPT_RECV_TIMEOUT (optname)\n
Kojto	34:1ad18123bf11	1051	* SOCKOPT_RECV_TIMEOUT configures recv and recvfrom timeout in milliseconds.\n
Kojto	34:1ad18123bf11	1052	* In that case optval should be pointer to unsigned long.\n
Kojto	34:1ad18123bf11	1053	* 2. SOCKOPT_NONBLOCK (optname). sets the socket non-blocking mode on or off.\n
Kojto	34:1ad18123bf11	1054	* In that case optval should be SOCK_ON or SOCK_OFF (optval).\n
Kojto	34:1ad18123bf11	1055	* \sa getsockopt
Kojto	29:c40918cd9b6d	1056	*/
Kojto	20:30b6ed7bf8fd	1057	int32_t setsockopt(int32_t sd, int32_t level, int32_t optname, const void *optval, socklen_t optlen);
Kojto	20:30b6ed7bf8fd	1058	#endif
Kojto	20:30b6ed7bf8fd	1059	private:
Kojto	20:30b6ed7bf8fd	1060	cc3000_simple_link &_simple_link;
Kojto	20:30b6ed7bf8fd	1061	cc3000_hci &_hci;
Kojto	20:30b6ed7bf8fd	1062	cc3000_event &_event;
Kojto	20:30b6ed7bf8fd	1063	};
Kojto	20:30b6ed7bf8fd	1064
Kojto	31:7b6e85b68b01	1065	/** SPI communication layer
Kojto	20:30b6ed7bf8fd	1066	*/
Kojto	20:30b6ed7bf8fd	1067	class cc3000_spi {
Kojto	20:30b6ed7bf8fd	1068	public:
Kojto	33:9e23b24fb4f3	1069	/**
Kojto	33:9e23b24fb4f3	1070	* \brief Ctor
Kojto	34:1ad18123bf11	1071	* \param irq IRQ pin
Kojto	34:1ad18123bf11	1072	* \param cc3000_en Enable pin
Kojto	34:1ad18123bf11	1073	* \param cc3000_cs Chip select pin
Kojto	34:1ad18123bf11	1074	* \param cc3000_spi SPI object
Kojto	34:1ad18123bf11	1075	* \param irq_port Port for IRQ pin (needed for enable/disable interrupts)
Kojto	34:1ad18123bf11	1076	* \param event Reference to the event object.
Kojto	34:1ad18123bf11	1077	* \param simple_link Reference to the simple link object.
Kojto	33:9e23b24fb4f3	1078	* \return none
Kojto	20:30b6ed7bf8fd	1079	*/
Kojto	20:30b6ed7bf8fd	1080	cc3000_spi(PinName cc3000_irq, PinName cc3000_en, PinName cc3000_cs, SPI cc3000_spi, IRQn_Type irq_port, cc3000_event &event, cc3000_simple_link &simple_link);
Kojto	33:9e23b24fb4f3	1081	/**
Kojto	33:9e23b24fb4f3	1082	* \brief Dtor
Kojto	33:9e23b24fb4f3	1083	* \param none
Kojto	33:9e23b24fb4f3	1084	* \return none
Kojto	20:30b6ed7bf8fd	1085	*/
Kojto	20:30b6ed7bf8fd	1086	~cc3000_spi();
Kojto	33:9e23b24fb4f3	1087	/**
Kojto	33:9e23b24fb4f3	1088	* \brief Close SPI - disables IRQ and set received buffer to 0
Kojto	20:30b6ed7bf8fd	1089	* \param none
Kojto	20:30b6ed7bf8fd	1090	* \return none
Kojto	20:30b6ed7bf8fd	1091	*/
Kojto	20:30b6ed7bf8fd	1092	void close();
Kojto	34:1ad18123bf11	1093	/**
Kojto	34:1ad18123bf11	1094	* \brief Open the SPI interface
Kojto	34:1ad18123bf11	1095	* \param none
Kojto	34:1ad18123bf11	1096	* \return none
Kojto	20:30b6ed7bf8fd	1097	*/
Kojto	20:30b6ed7bf8fd	1098	void open();
Kojto	34:1ad18123bf11	1099	/**
Kojto	34:1ad18123bf11	1100	* \brief First SPI write after powerup (delay needed between SPI header and body)
Kojto	34:1ad18123bf11	1101	* \param buffer pointer to write buffer
Kojto	34:1ad18123bf11	1102	* \param length buffer length
Kojto	34:1ad18123bf11	1103	* \return 0
Kojto	20:30b6ed7bf8fd	1104	*/
Kojto	20:30b6ed7bf8fd	1105	uint32_t first_write(uint8_t *buffer, uint16_t length);
Kojto	34:1ad18123bf11	1106	/**
Kojto	34:1ad18123bf11	1107	* \brief SPI Write function
Kojto	34:1ad18123bf11	1108	* \param buffer pointer to write buffer
Kojto	34:1ad18123bf11	1109	* \param length buffer length
Kojto	34:1ad18123bf11	1110	* \return 0
Kojto	20:30b6ed7bf8fd	1111	*/
Kojto	20:30b6ed7bf8fd	1112	uint32_t write(uint8_t *buffer, uint16_t length);
Kojto	34:1ad18123bf11	1113	/**
Kojto	34:1ad18123bf11	1114	* \brief Low level SPI write
Kojto	34:1ad18123bf11	1115	* \param data pointer to data buffer
Kojto	34:1ad18123bf11	1116	* \param size number of bytes
Kojto	34:1ad18123bf11	1117	* \return none
Kojto	20:30b6ed7bf8fd	1118	*/
Kojto	20:30b6ed7bf8fd	1119	void write_synchronous(uint8_t *data, uint16_t size);
Kojto	34:1ad18123bf11	1120	/**
Kojto	34:1ad18123bf11	1121	* \brief Low level SPI read
Kojto	34:1ad18123bf11	1122	* \param data pointer to data buffer
Kojto	34:1ad18123bf11	1123	* \param size number of bytes
Kojto	34:1ad18123bf11	1124	* \return none
Kojto	20:30b6ed7bf8fd	1125	*/
Kojto	20:30b6ed7bf8fd	1126	void read_synchronous(uint8_t *data, uint16_t size);
Kojto	34:1ad18123bf11	1127	/**
Kojto	34:1ad18123bf11	1128	* \brief Process the received SPI Header and in accordance with it - continue reading the packet
Kojto	34:1ad18123bf11	1129	* \param None
Kojto	34:1ad18123bf11	1130	* \return 0
Kojto	20:30b6ed7bf8fd	1131	*/
Kojto	20:30b6ed7bf8fd	1132	uint32_t read_data_cont();
Kojto	20:30b6ed7bf8fd	1133	/**
Kojto	34:1ad18123bf11	1134	* \brief Enable WLAN interrutp
Kojto	34:1ad18123bf11	1135	* \param None
Kojto	34:1ad18123bf11	1136	* \return None
Kojto	20:30b6ed7bf8fd	1137	*/
Kojto	20:30b6ed7bf8fd	1138	void wlan_irq_enable();
Kojto	34:1ad18123bf11	1139	/**
Kojto	34:1ad18123bf11	1140	* \brief Disable WLAN interrutp
Kojto	34:1ad18123bf11	1141	* \param None
Kojto	34:1ad18123bf11	1142	* \return None
Kojto	20:30b6ed7bf8fd	1143	*/
Kojto	20:30b6ed7bf8fd	1144	void wlan_irq_disable();
Kojto	20:30b6ed7bf8fd	1145	/**
Kojto	34:1ad18123bf11	1146	* \brief Get WLAN interrupt status
Kojto	34:1ad18123bf11	1147	* \param None
Kojto	34:1ad18123bf11	1148	* \return 0 : No interrupt occured
Kojto	34:1ad18123bf11	1149	* 1 : Interrupt occured
Kojto	20:30b6ed7bf8fd	1150	*/
Kojto	20:30b6ed7bf8fd	1151	uint32_t wlan_irq_read();
Kojto	20:30b6ed7bf8fd	1152	/**
Kojto	34:1ad18123bf11	1153	* \brief SPI interrupt Handler.
Kojto	34:1ad18123bf11	1154	* The external WLAN device asserts the IRQ line when data is ready.\n
Kojto	34:1ad18123bf11	1155	* The host CPU needs to acknowledges the IRQ by asserting CS.\n
Kojto	34:1ad18123bf11	1156	*
Kojto	34:1ad18123bf11	1157	* \param none
Kojto	34:1ad18123bf11	1158	* \return none
Kojto	20:30b6ed7bf8fd	1159	*/
Kojto	20:30b6ed7bf8fd	1160	void WLAN_IRQHandler();
Kojto	20:30b6ed7bf8fd	1161	/**
Kojto	34:1ad18123bf11	1162	* \brief Enable/Disable the WLAN module
Kojto	34:1ad18123bf11	1163	* \param value 1 : Enable
Kojto	34:1ad18123bf11	1164	* 0 : Disable
Kojto	34:1ad18123bf11	1165	* \return None
Kojto	20:30b6ed7bf8fd	1166	*/
Kojto	34:1ad18123bf11	1167	void set_wlan_en(uint8_t value);
Kojto	20:30b6ed7bf8fd	1168	private:
Kojto	20:30b6ed7bf8fd	1169	tSpiInfo _spi_info;
Kojto	20:30b6ed7bf8fd	1170	InterruptIn _wlan_irq;
Kojto	20:30b6ed7bf8fd	1171	DigitalOut _wlan_en;
Kojto	20:30b6ed7bf8fd	1172	DigitalOut _wlan_cs;
Kojto	20:30b6ed7bf8fd	1173	SPI _wlan_spi;
Kojto	20:30b6ed7bf8fd	1174	IRQn_Type _irq_port;
Kojto	20:30b6ed7bf8fd	1175	pFunctionPointer_t _function_pointer;
Kojto	20:30b6ed7bf8fd	1176	cc3000_event &_event;
Kojto	20:30b6ed7bf8fd	1177	cc3000_simple_link &_simple_link;
Kojto	20:30b6ed7bf8fd	1178	};
Kojto	20:30b6ed7bf8fd	1179
Kojto	31:7b6e85b68b01	1180	/** HCI layer
Kojto	31:7b6e85b68b01	1181	*/
Kojto	20:30b6ed7bf8fd	1182	class cc3000_hci {
Kojto	20:30b6ed7bf8fd	1183	public:
Kojto	29:c40918cd9b6d	1184	/**
Kojto	29:c40918cd9b6d	1185	* \brief Ctor
Kojto	34:1ad18123bf11	1186	* \param spi Reference to the spi object.
Kojto	29:c40918cd9b6d	1187	* \return none
Kojto	29:c40918cd9b6d	1188	*/
Kojto	20:30b6ed7bf8fd	1189	cc3000_hci(cc3000_spi &spi);
Kojto	29:c40918cd9b6d	1190	/**
Kojto	29:c40918cd9b6d	1191	* \brief Dtor
Kojto	29:c40918cd9b6d	1192	* \param none
Kojto	29:c40918cd9b6d	1193	* \return none
Kojto	29:c40918cd9b6d	1194	*/
Kojto	20:30b6ed7bf8fd	1195	~cc3000_hci();
Kojto	29:c40918cd9b6d	1196	/**
Kojto	29:c40918cd9b6d	1197	* \brief Initiate an HCI command.
Kojto	29:c40918cd9b6d	1198	* \param op_code command operation code
Kojto	29:c40918cd9b6d	1199	* \param buffer pointer to the command's arguments buffer
Kojto	29:c40918cd9b6d	1200	* \param length length of the arguments
Kojto	34:1ad18123bf11	1201	* \return 0
Kojto	29:c40918cd9b6d	1202	*/
Kojto	20:30b6ed7bf8fd	1203	uint16_t command_send(uint16_t op_code, uint8_t *buffer, uint8_t length);
Kojto	29:c40918cd9b6d	1204	/**
Kojto	29:c40918cd9b6d	1205	* \brief Initiate an HCI data write operation
Kojto	29:c40918cd9b6d	1206	* \param op_code command operation code
Kojto	29:c40918cd9b6d	1207	* \param args pointer to the command's arguments buffer
Kojto	29:c40918cd9b6d	1208	* \param arg_length length of the arguments
Kojto	29:c40918cd9b6d	1209	* \param data_length length od data
Kojto	29:c40918cd9b6d	1210	* \param tail pointer to the data buffer
Kojto	29:c40918cd9b6d	1211	* \param tail_length buffer length
Kojto	34:1ad18123bf11	1212	* \return ESUCCESS
Kojto	29:c40918cd9b6d	1213	*/
Kojto	20:30b6ed7bf8fd	1214	uint32_t data_send(uint8_t op_code, uint8_t *args, uint16_t arg_length,
Kojto	20:30b6ed7bf8fd	1215	uint16_t data_length, const uint8_t *tail, uint16_t tail_length);
Kojto	29:c40918cd9b6d	1216	/**
Kojto	29:c40918cd9b6d	1217	* \brief Prepare HCI header and initiate an HCI data write operation.
Kojto	29:c40918cd9b6d	1218	* \param op_code command operation code
Kojto	29:c40918cd9b6d	1219	* \param buffer pointer to the data buffer
Kojto	29:c40918cd9b6d	1220	* \param arg_length arguments length
Kojto	29:c40918cd9b6d	1221	* \param data_length data length
Kojto	29:c40918cd9b6d	1222	* \return none
Kojto	29:c40918cd9b6d	1223	*/
Kojto	20:30b6ed7bf8fd	1224	void data_command_send(uint16_t op_code, uint8_t *buffer, uint8_t arg_length,
Kojto	20:30b6ed7bf8fd	1225	uint16_t data_length);
Kojto	29:c40918cd9b6d	1226	/**
Kojto	29:c40918cd9b6d	1227	* \brief Prepare HCI header and initiate an HCI patch write operation.
Kojto	29:c40918cd9b6d	1228	* \param op_code command operation code
Kojto	29:c40918cd9b6d	1229	* \param buffer pointer to the command's arguments buffer
Kojto	29:c40918cd9b6d	1230	* \param patch pointer to patch content buffer
Kojto	29:c40918cd9b6d	1231	* \param data_length data length
Kojto	29:c40918cd9b6d	1232	* \return none
Kojto	29:c40918cd9b6d	1233	*/
Kojto	20:30b6ed7bf8fd	1234	void patch_send(uint8_t op_code, uint8_t buffer, uint8_t patch, uint16_t data_length);
Kojto	20:30b6ed7bf8fd	1235	private:
Kojto	20:30b6ed7bf8fd	1236	cc3000_spi &_spi;
Kojto	20:30b6ed7bf8fd	1237	};
Kojto	20:30b6ed7bf8fd	1238
Kojto	31:7b6e85b68b01	1239	/** NVMEM layer
Kojto	31:7b6e85b68b01	1240	*/
Kojto	20:30b6ed7bf8fd	1241	class cc3000_nvmem {
Kojto	20:30b6ed7bf8fd	1242	public:
Kojto	29:c40918cd9b6d	1243	/**
Kojto	29:c40918cd9b6d	1244	* \brief Ctor
Kojto	34:1ad18123bf11	1245	* \param hci Reference to the hci object.
Kojto	34:1ad18123bf11	1246	* \param event Reference to the event object.
Kojto	34:1ad18123bf11	1247	* \param simple_link Reference to the simple link object.
Kojto	29:c40918cd9b6d	1248	* \return none
Kojto	29:c40918cd9b6d	1249	*/
Kojto	29:c40918cd9b6d	1250	cc3000_nvmem(cc3000_hci &hci, cc3000_event &event, cc3000_simple_link &simple_link);
Kojto	29:c40918cd9b6d	1251	/**
Kojto	29:c40918cd9b6d	1252	* \brief Dtor
Kojto	29:c40918cd9b6d	1253	* \param none
Kojto	29:c40918cd9b6d	1254	* \return none
Kojto	29:c40918cd9b6d	1255	*/
Kojto	20:30b6ed7bf8fd	1256	~cc3000_nvmem();
Kojto	29:c40918cd9b6d	1257	/**
Kojto	29:c40918cd9b6d	1258	* \brief Reads data from the file referred by the file_id parameter.
Kojto	29:c40918cd9b6d	1259	* Reads data from file offset till length. Err if the file can't be used,
Kojto	29:c40918cd9b6d	1260	* is invalid, or if the read is out of bounds.
Kojto	29:c40918cd9b6d	1261	* \param file_id nvmem file id.
Kojto	29:c40918cd9b6d	1262	* \param length number of bytes to read.
Kojto	29:c40918cd9b6d	1263	* \param offset offset in file from where to read.
Kojto	29:c40918cd9b6d	1264	* \param buff output buffer pointer.
Kojto	29:c40918cd9b6d	1265	* \return
Kojto	29:c40918cd9b6d	1266	* Number of bytes read, otherwise error.
Kojto	29:c40918cd9b6d	1267	*/
Kojto	20:30b6ed7bf8fd	1268	int32_t read(uint32_t file_id, uint32_t length, uint32_t offset, uint8_t *buff);
Kojto	29:c40918cd9b6d	1269	/**
Kojto	29:c40918cd9b6d	1270	* \brief Write data to nvmem.
Kojto	29:c40918cd9b6d	1271	* \param file_id Nvmem file id
Kojto	29:c40918cd9b6d	1272	* \param length number of bytes to write
Kojto	29:c40918cd9b6d	1273	* \param entry_offset offset in file to start write operation from
Kojto	29:c40918cd9b6d	1274	* \param buff data to write
Kojto	29:c40918cd9b6d	1275	* \return
Kojto	29:c40918cd9b6d	1276	* On success 0, error otherwise.
Kojto	29:c40918cd9b6d	1277	*/
Kojto	20:30b6ed7bf8fd	1278	int32_t write(uint32_t file_id, uint32_t length, uint32_t entry_offset, uint8_t *buff);
Kojto	29:c40918cd9b6d	1279	/**
Kojto	29:c40918cd9b6d	1280	* \brief Write MAC address to EEPROM.
Kojto	29:c40918cd9b6d	1281	* \param mac Mac address to be set
Kojto	29:c40918cd9b6d	1282	* \return
Kojto	29:c40918cd9b6d	1283	* On success 0, error otherwise.
Kojto	29:c40918cd9b6d	1284	*/
Kojto	20:30b6ed7bf8fd	1285	uint8_t set_mac_address(uint8_t *mac);
Kojto	29:c40918cd9b6d	1286	/**
Kojto	29:c40918cd9b6d	1287	* \brief Read MAC address from EEPROM.
Kojto	29:c40918cd9b6d	1288	* \param mac Mac address
Kojto	29:c40918cd9b6d	1289	* \return
Kojto	33:9e23b24fb4f3	1290	* On success 0, error otherwise.
Kojto	29:c40918cd9b6d	1291	*/
Kojto	20:30b6ed7bf8fd	1292	uint8_t get_mac_address(uint8_t *mac);
Kojto	29:c40918cd9b6d	1293	/**
Kojto	29:c40918cd9b6d	1294	* \brief Program a patch to a specific file ID. The SP data is assumed to be organized in 2-dimensional.
Kojto	29:c40918cd9b6d	1295	* Each line is SP_PORTION_SIZE bytes long.
Kojto	29:c40918cd9b6d	1296	* \param file_id nvmem file id/
Kojto	29:c40918cd9b6d	1297	* \param length number of bytes to write
Kojto	29:c40918cd9b6d	1298	* \param data SP data to write
Kojto	29:c40918cd9b6d	1299	* \return
Kojto	29:c40918cd9b6d	1300	* On success 0, error otherwise.
Kojto	29:c40918cd9b6d	1301	*/
Kojto	20:30b6ed7bf8fd	1302	uint8_t write_patch(uint32_t file_id, uint32_t length, const uint8_t *data);
Kojto	29:c40918cd9b6d	1303	/**
Kojto	29:c40918cd9b6d	1304	* \brief Create new file entry and allocate space on the NVMEM. Applies only to user files.
Kojto	29:c40918cd9b6d	1305	* \param file_id nvmem file Id
Kojto	29:c40918cd9b6d	1306	* \param new_len entry ulLength
Kojto	29:c40918cd9b6d	1307	* \return
Kojto	29:c40918cd9b6d	1308	*/
Kojto	20:30b6ed7bf8fd	1309	int32_t create_entry(uint32_t file_id, uint32_t new_len);
Kojto	20:30b6ed7bf8fd	1310	#ifndef CC3000_TINY_DRIVER
Kojto	29:c40918cd9b6d	1311	/**
Kojto	29:c40918cd9b6d	1312	* \brief Read patch version. read package version (WiFi FW patch, river-supplicant-NS patch,
Kojto	29:c40918cd9b6d	1313	* bootloader patch)
Kojto	29:c40918cd9b6d	1314	* \param patch_ver First number indicates package ID and the second number indicates
Kojto	29:c40918cd9b6d	1315	* package build number
Kojto	29:c40918cd9b6d	1316	* \return
Kojto	29:c40918cd9b6d	1317	* On success 0, error otherwise.
Kojto	29:c40918cd9b6d	1318	*/
Kojto	20:30b6ed7bf8fd	1319	uint8_t read_sp_version(uint8_t* patch_ver);
Kojto	20:30b6ed7bf8fd	1320	#endif
Kojto	20:30b6ed7bf8fd	1321	private:
Kojto	20:30b6ed7bf8fd	1322	cc3000_hci &_hci;
Kojto	20:30b6ed7bf8fd	1323	cc3000_event &_event;
Kojto	20:30b6ed7bf8fd	1324	cc3000_simple_link &_simple_link;
Kojto	20:30b6ed7bf8fd	1325	};
Kojto	20:30b6ed7bf8fd	1326
Kojto	31:7b6e85b68b01	1327	/** WLAN layer
Kojto	31:7b6e85b68b01	1328	*/
Kojto	20:30b6ed7bf8fd	1329	class cc3000_wlan {
Kojto	20:30b6ed7bf8fd	1330	public:
Kojto	29:c40918cd9b6d	1331	/**
Kojto	29:c40918cd9b6d	1332	* \brief Ctor
Kojto	34:1ad18123bf11	1333	* \param simple_link Reference to the simple link object.
Kojto	34:1ad18123bf11	1334	* \param event Reference to the event object.
Kojto	34:1ad18123bf11	1335	* \param spi Reference to the spi object.
Kojto	34:1ad18123bf11	1336	* \param hci Reference to the hci object.
Kojto	29:c40918cd9b6d	1337	* \return none
Kojto	29:c40918cd9b6d	1338	*/
Kojto	20:30b6ed7bf8fd	1339	cc3000_wlan(cc3000_simple_link &simple_link, cc3000_event &event, cc3000_spi &spi, cc3000_hci &hci);
Kojto	29:c40918cd9b6d	1340	/**
Kojto	29:c40918cd9b6d	1341	* \brief Dtor
Kojto	29:c40918cd9b6d	1342	* \param none
Kojto	29:c40918cd9b6d	1343	* \return none
Kojto	29:c40918cd9b6d	1344	*/
Kojto	20:30b6ed7bf8fd	1345	~cc3000_wlan();
Kojto	29:c40918cd9b6d	1346	/**
Kojto	29:c40918cd9b6d	1347	* \brief Send SIMPLE LINK START to cc3000.
Kojto	29:c40918cd9b6d	1348	* \param patches_available_host Flag to indicate if patches are available.
Kojto	20:30b6ed7bf8fd	1349	* \return none
Kojto	20:30b6ed7bf8fd	1350	*/
Kojto	20:30b6ed7bf8fd	1351	void simpleLink_init_start(uint16_t patches_available_host);
Kojto	29:c40918cd9b6d	1352	/**
Kojto	29:c40918cd9b6d	1353	* \brief Start wlan device. Blocking call until init is completed.
Kojto	29:c40918cd9b6d	1354	* \param patches_available_host Flag to indicate if patches are available.
Kojto	20:30b6ed7bf8fd	1355	* \return none
Kojto	20:30b6ed7bf8fd	1356	*/
Kojto	20:30b6ed7bf8fd	1357	void start(uint16_t patches_available_host);
Kojto	29:c40918cd9b6d	1358	/**
Kojto	29:c40918cd9b6d	1359	* \brief Stop wlan device
Kojto	20:30b6ed7bf8fd	1360	* \param none
Kojto	20:30b6ed7bf8fd	1361	* \return none
Kojto	20:30b6ed7bf8fd	1362	*/
Kojto	20:30b6ed7bf8fd	1363	void stop(void);
Kojto	20:30b6ed7bf8fd	1364	#ifndef CC3000_TINY_DRIVER
Kojto	29:c40918cd9b6d	1365	/**
Kojto	29:c40918cd9b6d	1366	* \brief Connect to AP.
Kojto	29:c40918cd9b6d	1367	* \param sec_type Security option.
Kojto	29:c40918cd9b6d	1368	* \param ssid up to 32 bytes, ASCII SSID
Kojto	29:c40918cd9b6d	1369	* \param ssid_length length of SSID
Kojto	29:c40918cd9b6d	1370	* \param b_ssid 6 bytes specified the AP bssid
Kojto	29:c40918cd9b6d	1371	* \param key up to 16 bytes specified the AP security key
Kojto	29:c40918cd9b6d	1372	* \param key_len key length
Kojto	29:c40918cd9b6d	1373	* \return
Kojto	29:c40918cd9b6d	1374	* On success, zero is returned. On error, negative is returned.
Kojto	29:c40918cd9b6d	1375	*/
Kojto	20:30b6ed7bf8fd	1376	int32_t connect(uint32_t sec_type, const uint8_t ssid, int32_t ssid_length, uint8_t b_ssid, uint8_t *key, int32_t key_len);
Kojto	29:c40918cd9b6d	1377	/**
Kojto	29:c40918cd9b6d	1378	* \brief Add profile. Up to 7 profiles are supported.
Kojto	29:c40918cd9b6d	1379	* \param sec_type Security option.
Kojto	29:c40918cd9b6d	1380	* \param ssid Up to 32 bytes, ASCII SSID
Kojto	29:c40918cd9b6d	1381	* \param ssid_length Length of SSID
Kojto	29:c40918cd9b6d	1382	* \param b_ssid 6 bytes specified the AP bssid
Kojto	29:c40918cd9b6d	1383	* \param priority Up to 16 bytes specified the AP security key
Kojto	29:c40918cd9b6d	1384	* \param pairwise_cipher_or_tx_key_len Key length
Kojto	29:c40918cd9b6d	1385	* \param group_cipher_tx_key_index Key length for WEP security
Kojto	29:c40918cd9b6d	1386	* \param key_mgmt KEY management
Kojto	29:c40918cd9b6d	1387	* \param pf_or_key Security key
Kojto	29:c40918cd9b6d	1388	* \param pass_phrase_length Security key length for WPA\WPA2
Kojto	29:c40918cd9b6d	1389	* \return
Kojto	29:c40918cd9b6d	1390	* On success, zero is returned. On error, negative is returned.
Kojto	29:c40918cd9b6d	1391	*/
Kojto	20:30b6ed7bf8fd	1392	int32_t add_profile(uint32_t sec_type, uint8_t* ssid, uint32_t ssid_length, uint8_t *b_ssid, uint32_t priority, uint32_t pairwise_cipher_or_tx_key_len, uint32_t group_cipher_tx_key_index,
Kojto	20:30b6ed7bf8fd	1393	uint32_t key_mgmt, uint8_t* pf_or_key, uint32_t pass_phrase_length);
Kojto	29:c40918cd9b6d	1394	/**
Kojto	29:c40918cd9b6d	1395	* \brief Gets entry from scan result table. The scan results are returned
Kojto	29:c40918cd9b6d	1396	* one by one, and each entry represents a single AP found in the area.
Kojto	29:c40918cd9b6d	1397	* \param scan_timeout Not supported yet
Kojto	29:c40918cd9b6d	1398	* \param results Scan result
Kojto	29:c40918cd9b6d	1399	* \return
Kojto	29:c40918cd9b6d	1400	* On success, zero is returned. On error, -1 is returned
Kojto	29:c40918cd9b6d	1401	*/
Kojto	20:30b6ed7bf8fd	1402	int32_t ioctl_get_scan_results(uint32_t scan_timeout, uint8_t *results);
Kojto	29:c40918cd9b6d	1403	/**
Kojto	29:c40918cd9b6d	1404	* \brief Start and stop scan procedure. Set scan parameters.
Kojto	29:c40918cd9b6d	1405	* \param enable Start/stop application scan
Kojto	29:c40918cd9b6d	1406	* \param min_dwell_time Minimum dwell time value to be used for each channel, in ms. (Default: 20)
Kojto	29:c40918cd9b6d	1407	* \param max_dwell_time Maximum dwell time value to be used for each channel, in ms. (Default: 30)
Kojto	29:c40918cd9b6d	1408	* \param num_probe_requests Max probe request between dwell time. (Default:2)
Kojto	29:c40918cd9b6d	1409	* \param channel_mask Bitwise, up to 13 channels (0x1fff).
Kojto	29:c40918cd9b6d	1410	* \param rssi_threshold RSSI threshold. Saved: yes (Default: -80)
Kojto	29:c40918cd9b6d	1411	* \param snr_threshold NSR threshold. Saved: yes (Default: 0)
Kojto	29:c40918cd9b6d	1412	* \param default_tx_power probe Tx power. Saved: yes (Default: 205)
Kojto	29:c40918cd9b6d	1413	* \param interval_list Pointer to array with 16 entries (16 channels)
Kojto	29:c40918cd9b6d	1414	* \return
Kojto	29:c40918cd9b6d	1415	* On success, zero is returned. On error, -1 is returned.
Kojto	29:c40918cd9b6d	1416	*/
Kojto	20:30b6ed7bf8fd	1417	int32_t ioctl_set_scan_params(uint32_t enable, uint32_t min_dwell_time, uint32_t max_dwell_time, uint32_t num_probe_requests,
Kojto	20:30b6ed7bf8fd	1418	uint32_t channel_mask, int32_t rssi_threshold, uint32_t snr_threshold, uint32_t default_tx_power, uint32_t *interval_list);
Kojto	29:c40918cd9b6d	1419	/**
Kojto	29:c40918cd9b6d	1420	* \brief Get wlan status: disconnected, scanning, connecting or connected
Kojto	29:c40918cd9b6d	1421	* \param none
Kojto	29:c40918cd9b6d	1422	* \return
Kojto	29:c40918cd9b6d	1423	* WLAN_STATUS_DISCONNECTED, WLAN_STATUS_SCANING, STATUS_CONNECTING or WLAN_STATUS_CONNECTED
Kojto	29:c40918cd9b6d	1424	*/
Kojto	20:30b6ed7bf8fd	1425	int32_t ioctl_statusget(void);
Kojto	20:30b6ed7bf8fd	1426	#else
Kojto	29:c40918cd9b6d	1427	/**
Kojto	29:c40918cd9b6d	1428	* \brief Connect to AP
Kojto	29:c40918cd9b6d	1429	* \param ssid Up to 32 bytes and is ASCII SSID of the AP
Kojto	29:c40918cd9b6d	1430	* \param ssid_length Length of the SSID
Kojto	29:c40918cd9b6d	1431	* \return
Kojto	29:c40918cd9b6d	1432	* On success, zero is returned. On error, negative is returned.
Kojto	29:c40918cd9b6d	1433	*/
Kojto	20:30b6ed7bf8fd	1434	int32_t connect(const uint8_t *ssid, int32_t ssid_length);
Kojto	29:c40918cd9b6d	1435	/**
Kojto	29:c40918cd9b6d	1436	* \brief When auto start is enabled, the device connects to station from the profiles table.
Kojto	29:c40918cd9b6d	1437	* If several profiles configured the device choose the highest priority profile.
Kojto	29:c40918cd9b6d	1438	* \param sec_type WLAN_SEC_UNSEC,WLAN_SEC_WEP,WLAN_SEC_WPA,WLAN_SEC_WPA2
Kojto	29:c40918cd9b6d	1439	* \param ssid SSID up to 32 bytes
Kojto	29:c40918cd9b6d	1440	* \param ssid_length SSID length
Kojto	29:c40918cd9b6d	1441	* \param b_ssid bssid 6 bytes
Kojto	29:c40918cd9b6d	1442	* \param priority Profile priority. Lowest priority:0.
Kojto	29:c40918cd9b6d	1443	* \param pairwise_cipher_or_tx_key_len Key length for WEP security
Kojto	29:c40918cd9b6d	1444	* \param group_cipher_tx_key_index Key index
Kojto	29:c40918cd9b6d	1445	* \param key_mgmt KEY management
Kojto	29:c40918cd9b6d	1446	* \param pf_or_key Security key
Kojto	29:c40918cd9b6d	1447	* \param pass_phrase_length Security key length for WPA\WPA2
Kojto	29:c40918cd9b6d	1448	* \return
Kojto	29:c40918cd9b6d	1449	* On success, zero is returned. On error, -1 is returned
Kojto	29:c40918cd9b6d	1450	*/
Kojto	20:30b6ed7bf8fd	1451	int32_t add_profile(uint32_t sec_type, uint8_t ssid, uint32_t ssid_length, uint8_t b_ssid, uint32_t priority,
Kojto	20:30b6ed7bf8fd	1452	uint32_t pairwise_cipher_or_tx_key_len, uint32_t group_cipher_tx_key_index, uint32_t key_mgmt,
Kojto	20:30b6ed7bf8fd	1453	uint8_t* pf_or_key, uint32_t pass_phrase_length);
Kojto	20:30b6ed7bf8fd	1454	#endif
Kojto	20:30b6ed7bf8fd	1455	#ifndef CC3000_UNENCRYPTED_SMART_CONFIG
Kojto	29:c40918cd9b6d	1456	/**
Kojto	29:c40918cd9b6d	1457	* \brief Process the acquired data and store it as a profile.
Kojto	29:c40918cd9b6d	1458	* \param none
Kojto	29:c40918cd9b6d	1459	* \return
Kojto	29:c40918cd9b6d	1460	* On success, zero is returned. On error, -1 is returned.
Kojto	29:c40918cd9b6d	1461	*/
Kojto	20:30b6ed7bf8fd	1462	int32_t smart_config_process(void);
Kojto	20:30b6ed7bf8fd	1463	#endif
Kojto	29:c40918cd9b6d	1464	/**
Kojto	29:c40918cd9b6d	1465	* \brief Disconnect connection from AP.
Kojto	29:c40918cd9b6d	1466	* \param none
Kojto	29:c40918cd9b6d	1467	* \return
Kojto	29:c40918cd9b6d	1468	* 0 if disconnected done, other CC3000 already disconnected.
Kojto	29:c40918cd9b6d	1469	*/
Kojto	20:30b6ed7bf8fd	1470	int32_t disconnect();
Kojto	29:c40918cd9b6d	1471	/**
Kojto	29:c40918cd9b6d	1472	* \brief When auto is enabled, the device tries to connect according the following policy:
Kojto	29:c40918cd9b6d	1473	* 1) If fast connect is enabled and last connection is valid, the device will try to
Kojto	29:c40918cd9b6d	1474	* connect to it without the scanning procedure (fast). The last connection will be
Kojto	29:c40918cd9b6d	1475	* marked as invalid, due to adding/removing profile.
Kojto	29:c40918cd9b6d	1476	* 2) If profile exists, the device will try to connect it (Up to seven profiles).
Kojto	29:c40918cd9b6d	1477	* 3) If fast and profiles are not found, and open mode is enabled, the device
Kojto	29:c40918cd9b6d	1478	* will try to connect to any AP.
Kojto	29:c40918cd9b6d	1479	* Note that the policy settings are stored in the CC3000 NVMEM.
Kojto	29:c40918cd9b6d	1480	* \param should_connect_to_open_ap Enable(1), disable(0) connect to any available AP.
Kojto	29:c40918cd9b6d	1481	* \param use_fast_connect Enable(1), disable(0). if enabled, tries to
Kojto	29:c40918cd9b6d	1482	* connect to the last connected AP.
Kojto	29:c40918cd9b6d	1483	* \param use_profiles Enable(1), disable(0) auto connect after reset.
Kojto	29:c40918cd9b6d	1484	* and periodically reconnect if needed.
Kojto	29:c40918cd9b6d	1485	* \return
Kojto	29:c40918cd9b6d	1486	* On success, zero is returned. On error, -1 is returned
Kojto	29:c40918cd9b6d	1487	*/
Kojto	20:30b6ed7bf8fd	1488	int32_t ioctl_set_connection_policy(uint32_t should_connect_to_open_ap, uint32_t use_fast_connect, uint32_t use_profiles);
Kojto	29:c40918cd9b6d	1489	/**
Kojto	29:c40918cd9b6d	1490	* \brief Delete WLAN profile
Kojto	29:c40918cd9b6d	1491	* \param index Number of profile to delete
Kojto	29:c40918cd9b6d	1492	* \return
Kojto	29:c40918cd9b6d	1493	* On success, zero is returned. On error, -1 is returned
Kojto	29:c40918cd9b6d	1494	*/
Kojto	20:30b6ed7bf8fd	1495	int32_t ioctl_del_profile(uint32_t index);
Kojto	29:c40918cd9b6d	1496	/**
Kojto	29:c40918cd9b6d	1497	* \brief Mask event according to bit mask. In case that event is
Kojto	29:c40918cd9b6d	1498	* masked (1), the device will not send the masked event to host.
Kojto	29:c40918cd9b6d	1499	* \param mask event mask
Kojto	29:c40918cd9b6d	1500	* \return
Kojto	29:c40918cd9b6d	1501	* On success, zero is returned. On error, -1 is returned
Kojto	29:c40918cd9b6d	1502	*/
Kojto	20:30b6ed7bf8fd	1503	int32_t set_event_mask(uint32_t mask);
Kojto	29:c40918cd9b6d	1504	/**
Kojto	29:c40918cd9b6d	1505	* \brief Start to acquire device profile. The device acquire its own
Kojto	29:c40918cd9b6d	1506	* profile, if profile message is found.
Kojto	29:c40918cd9b6d	1507	* \param encrypted_flag Indicates whether the information is encrypted
Kojto	29:c40918cd9b6d	1508	* \return
Kojto	29:c40918cd9b6d	1509	* On success, zero is returned. On error, -1 is returned.
Kojto	29:c40918cd9b6d	1510	*/
Kojto	20:30b6ed7bf8fd	1511	int32_t smart_config_start(uint32_t encrypted_flag);
Kojto	29:c40918cd9b6d	1512	/**
Kojto	29:c40918cd9b6d	1513	* \brief Stop the acquire profile procedure.
Kojto	29:c40918cd9b6d	1514	* \param none
Kojto	29:c40918cd9b6d	1515	* \return
Kojto	29:c40918cd9b6d	1516	* On success, zero is returned. On error, -1 is returned
Kojto	29:c40918cd9b6d	1517	*/
Kojto	20:30b6ed7bf8fd	1518	int32_t smart_config_stop(void);
Kojto	29:c40918cd9b6d	1519	/**
Kojto	29:c40918cd9b6d	1520	* \brief Configure station ssid prefix.
Kojto	29:c40918cd9b6d	1521	* \param new_prefix 3 bytes identify the SSID prefix for the Smart Config.
Kojto	29:c40918cd9b6d	1522	* \return
Kojto	29:c40918cd9b6d	1523	* On success, zero is returned. On error, -1 is returned.
Kojto	29:c40918cd9b6d	1524	*/
Kojto	20:30b6ed7bf8fd	1525	int32_t smart_config_set_prefix(uint8_t *new_prefix);
Kojto	20:30b6ed7bf8fd	1526	private:
Kojto	20:30b6ed7bf8fd	1527	cc3000_simple_link &_simple_link;
Kojto	20:30b6ed7bf8fd	1528	cc3000_event &_event;
Kojto	20:30b6ed7bf8fd	1529	cc3000_spi &_spi;
Kojto	20:30b6ed7bf8fd	1530	cc3000_hci &_hci;
Kojto	20:30b6ed7bf8fd	1531	};
Kojto	20:30b6ed7bf8fd	1532
Kojto	31:7b6e85b68b01	1533	/** The main object of cc3000 implementation
Kojto	20:30b6ed7bf8fd	1534	*/
Kojto	20:30b6ed7bf8fd	1535	class cc3000 {
Kojto	20:30b6ed7bf8fd	1536	public:
Kojto	29:c40918cd9b6d	1537	/** status structure */
Kojto	20:30b6ed7bf8fd	1538	typedef struct {
Kojto	29:c40918cd9b6d	1539	bool dhcp;
Kojto	29:c40918cd9b6d	1540	bool connected;
Kojto	20:30b6ed7bf8fd	1541	uint8_t socket;
Kojto	29:c40918cd9b6d	1542	bool smart_config_complete;
Kojto	29:c40918cd9b6d	1543	bool stop_smart_config;
Kojto	29:c40918cd9b6d	1544	bool dhcp_configured;
Kojto	29:c40918cd9b6d	1545	bool ok_to_shut_down;
Kojto	20:30b6ed7bf8fd	1546	} tStatus;
Kojto	29:c40918cd9b6d	1547	/**
Kojto	29:c40918cd9b6d	1548	* \brief Ctor.
Kojto	20:30b6ed7bf8fd	1549	* \param cc3000_irq IRQ pin
Kojto	20:30b6ed7bf8fd	1550	* \param cc3000_en Enable pin
Kojto	20:30b6ed7bf8fd	1551	* \param cc3000_cs Chip select pin
Kojto	20:30b6ed7bf8fd	1552	* \param cc3000_spi SPI interface
Kojto	20:30b6ed7bf8fd	1553	* \param irq_port IRQ pin's port
Kojto	20:30b6ed7bf8fd	1554	*/
Kojto	20:30b6ed7bf8fd	1555	cc3000(PinName cc3000_irq, PinName cc3000_en, PinName cc3000_cs, SPI cc3000_spi, IRQn_Type irq_port);
Kojto	29:c40918cd9b6d	1556	/**
Kojto	29:c40918cd9b6d	1557	* \brief Dtor.
Kojto	20:30b6ed7bf8fd	1558	*/
Kojto	20:30b6ed7bf8fd	1559	~cc3000();
Kojto	29:c40918cd9b6d	1560	/**
Kojto	29:c40918cd9b6d	1561	* \brief Initiate cc3000. It starts the wlan communication and deletes profiles.
Kojto	20:30b6ed7bf8fd	1562	* \param patch Patch
Kojto	20:30b6ed7bf8fd	1563	*/
Kojto	20:30b6ed7bf8fd	1564	void start(uint8_t patch);
Kojto	29:c40918cd9b6d	1565	/**
Kojto	29:c40918cd9b6d	1566	* \brief Stops the wlan communication.
Kojto	20:30b6ed7bf8fd	1567	*/
Kojto	20:30b6ed7bf8fd	1568	void stop();
Kojto	29:c40918cd9b6d	1569	/**
Kojto	29:c40918cd9b6d	1570	* \brief Restarts the wlan communication.
Kojto	20:30b6ed7bf8fd	1571	*/
Kojto	20:30b6ed7bf8fd	1572	void restart(uint8_t patch);
Kojto	29:c40918cd9b6d	1573	/**
Kojto	29:c40918cd9b6d	1574	* \brief Disconnect wlan device
Kojto	20:30b6ed7bf8fd	1575	*
Kojto	20:30b6ed7bf8fd	1576	*/
Kojto	20:30b6ed7bf8fd	1577	bool disconnect(void);
Kojto	29:c40918cd9b6d	1578	/**
Kojto	29:c40918cd9b6d	1579	* \brief Callback which is called from the event class. This updates status of cc3000.
Kojto	20:30b6ed7bf8fd	1580	* \param event_type Type of the event
Kojto	20:30b6ed7bf8fd	1581	* \param data Pointer to data
Kojto	20:30b6ed7bf8fd	1582	* \param length Length of data
Kojto	20:30b6ed7bf8fd	1583	* \return none
Kojto	20:30b6ed7bf8fd	1584	*/
Kojto	20:30b6ed7bf8fd	1585	void usync_callback(int32_t event_type, uint8_t *data, uint8_t length);
Kojto	29:c40918cd9b6d	1586	/**
Kojto	29:c40918cd9b6d	1587	* \brief Connect to SSID (open/secured) with timeout (10ms).
Kojto	20:30b6ed7bf8fd	1588	* \param ssid SSID name
Kojto	20:30b6ed7bf8fd	1589	* \param key Security key (if key = 0, open connection)
Kojto	20:30b6ed7bf8fd	1590	* \param security_mode Security mode
Kojto	20:30b6ed7bf8fd	1591	* \return true if connection was established, false otherwise.
Kojto	20:30b6ed7bf8fd	1592	*/
Kojto	20:30b6ed7bf8fd	1593	bool connect_to_AP(const uint8_t ssid, const uint8_t key, int32_t security_mode);
Kojto	29:c40918cd9b6d	1594	/**
Kojto	29:c40918cd9b6d	1595	* \brief Connect to SSID which is secured
Kojto	20:30b6ed7bf8fd	1596	* \param ssid SSID name
Kojto	20:30b6ed7bf8fd	1597	* \param key Security key
Kojto	20:30b6ed7bf8fd	1598	* \param security_mode Security mode
Kojto	20:30b6ed7bf8fd	1599	* \return true if connection was established, false otherwise.
Kojto	20:30b6ed7bf8fd	1600	*/
Kojto	20:30b6ed7bf8fd	1601	bool connect_secure(const uint8_t ssid, const uint8_t key, int32_t security_mode);
Kojto	29:c40918cd9b6d	1602	/**
Kojto	29:c40918cd9b6d	1603	* \brief Connect to SSID which is open (no security)
Kojto	20:30b6ed7bf8fd	1604	* \param ssid SSID name
Kojto	20:30b6ed7bf8fd	1605	* \return true if connection was established, false otherwise.
Kojto	20:30b6ed7bf8fd	1606	*/
Kojto	20:30b6ed7bf8fd	1607	bool connect_open(const uint8_t *ssid);
Kojto	29:c40918cd9b6d	1608	/**
Kojto	29:c40918cd9b6d	1609	* \brief Status of the cc3000 connection.
Kojto	20:30b6ed7bf8fd	1610	* \return true if it's connected, false otherwise.
Kojto	20:30b6ed7bf8fd	1611	*/
Kojto	20:30b6ed7bf8fd	1612	bool is_connected();
Kojto	29:c40918cd9b6d	1613	/**
Kojto	29:c40918cd9b6d	1614	* \brief Status of DHCP.
Kojto	20:30b6ed7bf8fd	1615	* \param none
Kojto	20:30b6ed7bf8fd	1616	* \return true if DCHP is configured, false otherwise.
Kojto	20:30b6ed7bf8fd	1617	*/
Kojto	20:30b6ed7bf8fd	1618	bool is_dhcp_configured();
Kojto	29:c40918cd9b6d	1619	/**
Kojto	29:c40918cd9b6d	1620	* \brief Status of smart confing completation.
Kojto	20:30b6ed7bf8fd	1621	* \param none
Kojto	20:30b6ed7bf8fd	1622	* \return smart config was set, false otherwise.
Kojto	20:30b6ed7bf8fd	1623	*/
Kojto	20:30b6ed7bf8fd	1624	bool is_smart_confing_completed();
Kojto	29:c40918cd9b6d	1625	/**
Kojto	29:c40918cd9b6d	1626	* \brief Return the cc3000's mac address.
Kojto	20:30b6ed7bf8fd	1627	* \param address Retreived mac address.
Kojto	20:30b6ed7bf8fd	1628	* \return
Kojto	20:30b6ed7bf8fd	1629	*/
Kojto	20:30b6ed7bf8fd	1630	uint8_t get_mac_address(uint8_t address[6]);
Kojto	29:c40918cd9b6d	1631	/**
Kojto	29:c40918cd9b6d	1632	* \brief Set the cc3000's mac address.
Kojto	29:c40918cd9b6d	1633	* \param address Mac address to be set.
Kojto	20:30b6ed7bf8fd	1634	* \return
Kojto	20:30b6ed7bf8fd	1635	*/
Kojto	20:30b6ed7bf8fd	1636	uint8_t set_mac_address(uint8_t address[6]);
Kojto	29:c40918cd9b6d	1637	/**
Kojto	29:c40918cd9b6d	1638	* \brief Get user file info.
Kojto	29:c40918cd9b6d	1639	* \param info_file Pointer where info will be stored.
Kojto	29:c40918cd9b6d	1640	* \param size Available size.
Kojto	20:30b6ed7bf8fd	1641	* \return none
Kojto	20:30b6ed7bf8fd	1642	*/
Kojto	20:30b6ed7bf8fd	1643	void get_user_file_info(uint8_t *info_file, size_t size);
Kojto	29:c40918cd9b6d	1644	/**
Kojto	29:c40918cd9b6d	1645	* \brief Set user filo info.
Kojto	29:c40918cd9b6d	1646	* \param info_file Pointer to user's info.
Kojto	20:30b6ed7bf8fd	1647	* \return none
Kojto	20:30b6ed7bf8fd	1648	*/
Kojto	20:30b6ed7bf8fd	1649	void set_user_file_info(uint8_t *info_file, size_t size);
Kojto	29:c40918cd9b6d	1650	/**
Kojto	29:c40918cd9b6d	1651	* \brief Start smart config.
Kojto	29:c40918cd9b6d	1652	* \param smart_config_key Pointer to smart config key.
Kojto	20:30b6ed7bf8fd	1653	* \return none
Kojto	20:30b6ed7bf8fd	1654	*/
Kojto	20:30b6ed7bf8fd	1655	void start_smart_config(const uint8_t smart_config_key); / TODO enable AES ? */
Kojto	20:30b6ed7bf8fd	1656	#ifndef CC3000_TINY_DRIVER
Kojto	29:c40918cd9b6d	1657	/**
Kojto	29:c40918cd9b6d	1658	* \brief Return ip configuration.
Kojto	29:c40918cd9b6d	1659	* \param ip_config Pointer to ipconfig data.
Kojto	29:c40918cd9b6d	1660	* \return true if it's connected and info was retrieved, false otherwise.
Kojto	20:30b6ed7bf8fd	1661	*/
Kojto	20:30b6ed7bf8fd	1662	bool get_ip_config(tNetappIpconfigRetArgs *ip_config);
Kojto	20:30b6ed7bf8fd	1663	#endif
Kojto	29:c40918cd9b6d	1664	/**
Kojto	33:9e23b24fb4f3	1665	* \brief Delete all stored profiles.
Kojto	29:c40918cd9b6d	1666	* \param none
Kojto	20:30b6ed7bf8fd	1667	* \return none
Kojto	20:30b6ed7bf8fd	1668	*/
Kojto	20:30b6ed7bf8fd	1669	void delete_profiles(void);
Kojto	20:30b6ed7bf8fd	1670	/**
Kojto	33:9e23b24fb4f3	1671	* \brief Ping an ip address.
Kojto	29:c40918cd9b6d	1672	* \param ip Destination IP address
Kojto	29:c40918cd9b6d	1673	* \param attempts Number of attempts
Kojto	29:c40918cd9b6d	1674	* \param timeout Time to wait for a response,in milliseconds.
Kojto	29:c40918cd9b6d	1675	* \param size Send buffer size which may be up to 1400 bytes
Kojto	20:30b6ed7bf8fd	1676	*/
Kojto	20:30b6ed7bf8fd	1677	uint32_t ping(uint32_t ip, uint8_t attempts, uint16_t timeout, uint8_t size);
Kojto	29:c40918cd9b6d	1678	/**
Kojto	33:9e23b24fb4f3	1679	* \brief Returns cc3000 instance. Used in Socket interface.
Kojto	29:c40918cd9b6d	1680	* \param none
Kojto	29:c40918cd9b6d	1681	* \return Pointer to cc3000 object
Kojto	29:c40918cd9b6d	1682	*/
Kojto	20:30b6ed7bf8fd	1683	static cc3000 *get_instance() {
Kojto	20:30b6ed7bf8fd	1684	return _inst;
Kojto	20:30b6ed7bf8fd	1685	}
Kojto	20:30b6ed7bf8fd	1686	public:
Kojto	20:30b6ed7bf8fd	1687	cc3000_simple_link _simple_link;
Kojto	20:30b6ed7bf8fd	1688	cc3000_event _event;
Kojto	20:30b6ed7bf8fd	1689	#ifndef CC3000_UNENCRYPTED_SMART_CONFIG
Kojto	20:30b6ed7bf8fd	1690	cc3000_security _security;
Kojto	20:30b6ed7bf8fd	1691	#endif
Kojto	20:30b6ed7bf8fd	1692	cc3000_socket _socket;
Kojto	20:30b6ed7bf8fd	1693	cc3000_spi _spi;
Kojto	20:30b6ed7bf8fd	1694	cc3000_hci _hci;
Kojto	20:30b6ed7bf8fd	1695	cc3000_nvmem _nvmem;
Kojto	20:30b6ed7bf8fd	1696	cc3000_netapp _netapp;
Kojto	20:30b6ed7bf8fd	1697	cc3000_wlan _wlan;
Kojto	20:30b6ed7bf8fd	1698	protected:
Kojto	20:30b6ed7bf8fd	1699	static cc3000 *_inst;
Kojto	20:30b6ed7bf8fd	1700	private:
Kojto	20:30b6ed7bf8fd	1701	tStatus _status;
Kojto	20:30b6ed7bf8fd	1702	netapp_pingreport_args_t _ping_report;
Kojto	20:30b6ed7bf8fd	1703	bool _closed_sockets[MAX_SOCKETS];
Kojto	20:30b6ed7bf8fd	1704	};
Kojto	20:30b6ed7bf8fd	1705
Kojto	20:30b6ed7bf8fd	1706	/**
Kojto	29:c40918cd9b6d	1707	* Copy 32 bit to stream while converting to little endian format.
Kojto	29:c40918cd9b6d	1708	* @param p pointer to the new stream
Kojto	29:c40918cd9b6d	1709	* @param u32 pointer to the 32 bit
Kojto	29:c40918cd9b6d	1710	* @return pointer to the new stream
Kojto	29:c40918cd9b6d	1711	*/
Kojto	20:30b6ed7bf8fd	1712	uint8_t UINT32_TO_STREAM_f (uint8_t p, uint32_t u32);
Kojto	20:30b6ed7bf8fd	1713
Kojto	20:30b6ed7bf8fd	1714	/**
Kojto	29:c40918cd9b6d	1715	* Copy 16 bit to stream while converting to little endian format.
Kojto	29:c40918cd9b6d	1716	* @param p pointer to the new stream
Kojto	29:c40918cd9b6d	1717	* @param u32 pointer to the 16 bit
Kojto	29:c40918cd9b6d	1718	* @return pointer to the new stream
Kojto	29:c40918cd9b6d	1719	*/
Kojto	20:30b6ed7bf8fd	1720	uint8_t UINT16_TO_STREAM_f (uint8_t p, uint16_t u16);
Kojto	20:30b6ed7bf8fd	1721
Kojto	20:30b6ed7bf8fd	1722	/**
Kojto	29:c40918cd9b6d	1723	* Copy received stream to 16 bit in little endian format.
Kojto	29:c40918cd9b6d	1724	* @param p pointer to the stream
Kojto	29:c40918cd9b6d	1725	* @param offset offset in the stream
Kojto	29:c40918cd9b6d	1726	* @return pointer to the new 16 bit
Kojto	29:c40918cd9b6d	1727	*/
Kojto	20:30b6ed7bf8fd	1728	uint16_t STREAM_TO_UINT16_f(uint8_t* p, uint16_t offset);
Kojto	20:30b6ed7bf8fd	1729
Kojto	20:30b6ed7bf8fd	1730	/**
Kojto	29:c40918cd9b6d	1731	* Copy received stream to 32 bit in little endian format.
Kojto	29:c40918cd9b6d	1732	* @param p pointer to the stream
Kojto	29:c40918cd9b6d	1733	* @param offset offset in the stream
Kojto	29:c40918cd9b6d	1734	* @return pointer to the new 32 bit
Kojto	29:c40918cd9b6d	1735	*/
Kojto	20:30b6ed7bf8fd	1736	uint32_t STREAM_TO_UINT32_f(uint8_t* p, uint16_t offset);
Kojto	20:30b6ed7bf8fd	1737
Kojto	20:30b6ed7bf8fd	1738	} /* end of mbed_cc3000 namespace */
Kojto	20:30b6ed7bf8fd	1739
Kojto	20:30b6ed7bf8fd	1740
Kojto	20:30b6ed7bf8fd	1741	#endif

Repository toolbox

Export to desktop IDE

Repository details

Type:	Library
Created:	28 Feb 2015
Imports:	3
Forks:	0
Commits:	52
Dependents:	0
Dependencies:	0
Followers:	1

This repository is Public (Unlisted).

cc3000.h@38:1d374a7f0c0d, 2013-10-08 (annotated)

Who changed what in which revision?

Repository toolbox

Repository details

Important Information for this Arm website

Access Warning