David Fletcher / Mbed 2 deprecated cc3100_Test_websock_Camera_CM3

TI's CC3100 websocket camera demo with Arducam mini ov5642 and freertos. Should work with other M3's. Work in progress test demo.

Dependencies:   mbed

simplelink/cc3100_spi.h@0:400d8e75a8d0, 2015-09-06 (annotated)

Committer:
dflet
Date:
Sun Sep 06 15:19:36 2015 +0000
Revision:
0:400d8e75a8d0
TI's websocket Camera demo, also uses Arducam mini 0v5642 camera.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
dflet 0:400d8e75a8d0 1 /*
dflet 0:400d8e75a8d0 2 * spi.h - mbed
dflet 0:400d8e75a8d0 3 *
dflet 0:400d8e75a8d0 4 * Copyright (C) 2014 Texas Instruments Incorporated - http://www.ti.com/
dflet 0:400d8e75a8d0 5 *
dflet 0:400d8e75a8d0 6 *
dflet 0:400d8e75a8d0 7 * Redistribution and use in source and binary forms, with or without
dflet 0:400d8e75a8d0 8 * modification, are permitted provided that the following conditions
dflet 0:400d8e75a8d0 9 * are met:
dflet 0:400d8e75a8d0 10 *
dflet 0:400d8e75a8d0 11 * Redistributions of source code must retain the above copyright
dflet 0:400d8e75a8d0 12 * notice, this list of conditions and the following disclaimer.
dflet 0:400d8e75a8d0 13 *
dflet 0:400d8e75a8d0 14 * Redistributions in binary form must reproduce the above copyright
dflet 0:400d8e75a8d0 15 * notice, this list of conditions and the following disclaimer in the
dflet 0:400d8e75a8d0 16 * documentation and/or other materials provided with the
dflet 0:400d8e75a8d0 17 * distribution.
dflet 0:400d8e75a8d0 18 *
dflet 0:400d8e75a8d0 19 * Neither the name of Texas Instruments Incorporated nor the names of
dflet 0:400d8e75a8d0 20 * its contributors may be used to endorse or promote products derived
dflet 0:400d8e75a8d0 21 * from this software without specific prior written permission.
dflet 0:400d8e75a8d0 22 *
dflet 0:400d8e75a8d0 23 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
dflet 0:400d8e75a8d0 24 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
dflet 0:400d8e75a8d0 25 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
dflet 0:400d8e75a8d0 26 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
dflet 0:400d8e75a8d0 27 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
dflet 0:400d8e75a8d0 28 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
dflet 0:400d8e75a8d0 29 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
dflet 0:400d8e75a8d0 30 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
dflet 0:400d8e75a8d0 31 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
dflet 0:400d8e75a8d0 32 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
dflet 0:400d8e75a8d0 33 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
dflet 0:400d8e75a8d0 34 *
dflet 0:400d8e75a8d0 35 */
dflet 0:400d8e75a8d0 36
dflet 0:400d8e75a8d0 37
dflet 0:400d8e75a8d0 38 #ifndef SPI_H_
dflet 0:400d8e75a8d0 39 #define SPI_H_
dflet 0:400d8e75a8d0 40
dflet 0:400d8e75a8d0 41 #include "mbed.h"
dflet 0:400d8e75a8d0 42
dflet 0:400d8e75a8d0 43 /*!
dflet 0:400d8e75a8d0 44 \brief type definition for the spi channel file descriptor
dflet 0:400d8e75a8d0 45
dflet 0:400d8e75a8d0 46 \note On each porting or platform the type could be whatever is needed
dflet 0:400d8e75a8d0 47 - integer, pointer to structure etc.
dflet 0:400d8e75a8d0 48 */
dflet 0:400d8e75a8d0 49 typedef unsigned int Fd_t;
dflet 0:400d8e75a8d0 50
dflet 0:400d8e75a8d0 51 typedef void (*P_EVENT_HANDLER)(void* pValue);
dflet 0:400d8e75a8d0 52
dflet 0:400d8e75a8d0 53 typedef enum events
dflet 0:400d8e75a8d0 54 {
dflet 0:400d8e75a8d0 55 NO_ACTION = -1,
dflet 0:400d8e75a8d0 56 PUSH_BUTTON_1_PRESSED = 3,
dflet 0:400d8e75a8d0 57 PUSH_BUTTON_2_PRESSED = 4,
dflet 0:400d8e75a8d0 58 BROKER_DISCONNECTION = 2
dflet 0:400d8e75a8d0 59 } osi_messages;
dflet 0:400d8e75a8d0 60
dflet 0:400d8e75a8d0 61 namespace mbed_cc3100 {
dflet 0:400d8e75a8d0 62
dflet 0:400d8e75a8d0 63 class cc3100_driver;
dflet 0:400d8e75a8d0 64
dflet 0:400d8e75a8d0 65 class cc3100_spi
dflet 0:400d8e75a8d0 66 {
dflet 0:400d8e75a8d0 67 public:
dflet 0:400d8e75a8d0 68
dflet 0:400d8e75a8d0 69 cc3100_spi(PinName button1_irq, PinName button2_irq, PinName cc3100_irq, PinName cc3100_nHIB, PinName cc3100_cs, SPI cc3100_spi, cc3100_driver &driver);
dflet 0:400d8e75a8d0 70
dflet 0:400d8e75a8d0 71 ~cc3100_spi();
dflet 0:400d8e75a8d0 72
dflet 0:400d8e75a8d0 73
dflet 0:400d8e75a8d0 74 /*!
dflet 0:400d8e75a8d0 75 \brief Enables the CC3100
dflet 0:400d8e75a8d0 76
dflet 0:400d8e75a8d0 77 \param[in] none
dflet 0:400d8e75a8d0 78
dflet 0:400d8e75a8d0 79 \return none
dflet 0:400d8e75a8d0 80
dflet 0:400d8e75a8d0 81 \note
dflet 0:400d8e75a8d0 82
dflet 0:400d8e75a8d0 83 \warning
dflet 0:400d8e75a8d0 84 */
dflet 0:400d8e75a8d0 85 void CC3100_enable();
dflet 0:400d8e75a8d0 86
dflet 0:400d8e75a8d0 87 /*!
dflet 0:400d8e75a8d0 88 \brief Disables the CC3100
dflet 0:400d8e75a8d0 89
dflet 0:400d8e75a8d0 90 \param[in] none
dflet 0:400d8e75a8d0 91
dflet 0:400d8e75a8d0 92 \return none
dflet 0:400d8e75a8d0 93
dflet 0:400d8e75a8d0 94 \note
dflet 0:400d8e75a8d0 95
dflet 0:400d8e75a8d0 96 \warning
dflet 0:400d8e75a8d0 97 */
dflet 0:400d8e75a8d0 98 void CC3100_disable();
dflet 0:400d8e75a8d0 99
dflet 0:400d8e75a8d0 100 /*!
dflet 0:400d8e75a8d0 101 \brief Disables the button push interrupt
dflet 0:400d8e75a8d0 102
dflet 0:400d8e75a8d0 103 \param[in] none
dflet 0:400d8e75a8d0 104
dflet 0:400d8e75a8d0 105 \return none
dflet 0:400d8e75a8d0 106
dflet 0:400d8e75a8d0 107 \note
dflet 0:400d8e75a8d0 108
dflet 0:400d8e75a8d0 109 \warning
dflet 0:400d8e75a8d0 110 */
dflet 0:400d8e75a8d0 111 void button1_InterruptDisable();
dflet 0:400d8e75a8d0 112
dflet 0:400d8e75a8d0 113 /*!
dflet 0:400d8e75a8d0 114 \brief Enables the button push interrupt
dflet 0:400d8e75a8d0 115
dflet 0:400d8e75a8d0 116 \param[in] none
dflet 0:400d8e75a8d0 117
dflet 0:400d8e75a8d0 118 \return none
dflet 0:400d8e75a8d0 119
dflet 0:400d8e75a8d0 120 \note
dflet 0:400d8e75a8d0 121
dflet 0:400d8e75a8d0 122 \warning
dflet 0:400d8e75a8d0 123 */
dflet 0:400d8e75a8d0 124 void button1_InterruptEnable();
dflet 0:400d8e75a8d0 125
dflet 0:400d8e75a8d0 126 /*!
dflet 0:400d8e75a8d0 127 \brief Disables the button push interrupt
dflet 0:400d8e75a8d0 128
dflet 0:400d8e75a8d0 129 \param[in] none
dflet 0:400d8e75a8d0 130
dflet 0:400d8e75a8d0 131 \return none
dflet 0:400d8e75a8d0 132
dflet 0:400d8e75a8d0 133 \note
dflet 0:400d8e75a8d0 134
dflet 0:400d8e75a8d0 135 \warning
dflet 0:400d8e75a8d0 136 */
dflet 0:400d8e75a8d0 137 void button2_InterruptDisable();
dflet 0:400d8e75a8d0 138
dflet 0:400d8e75a8d0 139 /*!
dflet 0:400d8e75a8d0 140 \brief Enables the button push interrupt
dflet 0:400d8e75a8d0 141
dflet 0:400d8e75a8d0 142 \param[in] none
dflet 0:400d8e75a8d0 143
dflet 0:400d8e75a8d0 144 \return none
dflet 0:400d8e75a8d0 145
dflet 0:400d8e75a8d0 146 \note
dflet 0:400d8e75a8d0 147
dflet 0:400d8e75a8d0 148 \warning
dflet 0:400d8e75a8d0 149 */
dflet 0:400d8e75a8d0 150 void button2_InterruptEnable();
dflet 0:400d8e75a8d0 151
dflet 0:400d8e75a8d0 152 /*!
dflet 0:400d8e75a8d0 153 \brief Enables the interrupt from the CC3100
dflet 0:400d8e75a8d0 154
dflet 0:400d8e75a8d0 155 \param[in] none
dflet 0:400d8e75a8d0 156
dflet 0:400d8e75a8d0 157 \return none
dflet 0:400d8e75a8d0 158
dflet 0:400d8e75a8d0 159 \note
dflet 0:400d8e75a8d0 160
dflet 0:400d8e75a8d0 161 \warning
dflet 0:400d8e75a8d0 162 */
dflet 0:400d8e75a8d0 163 void cc3100_InterruptEnable();
dflet 0:400d8e75a8d0 164
dflet 0:400d8e75a8d0 165 /*!
dflet 0:400d8e75a8d0 166 \brief Disables the interrupt from the CC3100
dflet 0:400d8e75a8d0 167
dflet 0:400d8e75a8d0 168 \param[in] none
dflet 0:400d8e75a8d0 169
dflet 0:400d8e75a8d0 170 \return none
dflet 0:400d8e75a8d0 171
dflet 0:400d8e75a8d0 172 \note
dflet 0:400d8e75a8d0 173
dflet 0:400d8e75a8d0 174 \warning
dflet 0:400d8e75a8d0 175 */
dflet 0:400d8e75a8d0 176 void cc3100_InterruptDisable();
dflet 0:400d8e75a8d0 177
dflet 0:400d8e75a8d0 178 /*!
dflet 0:400d8e75a8d0 179 \brief open spi communication port to be used for communicating with a
dflet 0:400d8e75a8d0 180 SimpleLink device
dflet 0:400d8e75a8d0 181
dflet 0:400d8e75a8d0 182 Given an interface name and option flags, this function opens the spi
dflet 0:400d8e75a8d0 183 communication port and creates a file descriptor. This file descriptor can
dflet 0:400d8e75a8d0 184 be used afterwards to read and write data from and to this specific spi
dflet 0:400d8e75a8d0 185 channel.
dflet 0:400d8e75a8d0 186 The SPI speed, clock polarity, clock phase, chip select and all other
dflet 0:400d8e75a8d0 187 attributes are all set to hardcoded values in this function.
dflet 0:400d8e75a8d0 188
dflet 0:400d8e75a8d0 189 \param[in] ifName - points to the interface name/path. The
dflet 0:400d8e75a8d0 190 interface name is an optional attributes that the simple
dflet 0:400d8e75a8d0 191 link driver receives on opening the device. in systems that
dflet 0:400d8e75a8d0 192 the spi channel is not implemented as part of the os device
dflet 0:400d8e75a8d0 193 drivers, this parameter could be NULL.
dflet 0:400d8e75a8d0 194 \param[in] flags - option flags
dflet 0:400d8e75a8d0 195
dflet 0:400d8e75a8d0 196 \return upon successful completion, the function shall open the spi
dflet 0:400d8e75a8d0 197 channel and return a non-negative integer representing the
dflet 0:400d8e75a8d0 198 file descriptor. Otherwise, -1 shall be returned
dflet 0:400d8e75a8d0 199
dflet 0:400d8e75a8d0 200 \sa spi_Close , spi_Read , spi_Write
dflet 0:400d8e75a8d0 201 \note
dflet 0:400d8e75a8d0 202 \warning
dflet 0:400d8e75a8d0 203 */
dflet 0:400d8e75a8d0 204
dflet 0:400d8e75a8d0 205 Fd_t spi_Open(int8_t *ifName, uint32_t flags);
dflet 0:400d8e75a8d0 206
dflet 0:400d8e75a8d0 207 /*!
dflet 0:400d8e75a8d0 208 \brief closes an opened spi communication port
dflet 0:400d8e75a8d0 209
dflet 0:400d8e75a8d0 210 \param[in] fd - file descriptor of an opened SPI channel
dflet 0:400d8e75a8d0 211
dflet 0:400d8e75a8d0 212 \return upon successful completion, the function shall return 0.
dflet 0:400d8e75a8d0 213 Otherwise, -1 shall be returned
dflet 0:400d8e75a8d0 214
dflet 0:400d8e75a8d0 215 \sa spi_Open
dflet 0:400d8e75a8d0 216 \note
dflet 0:400d8e75a8d0 217 \warning
dflet 0:400d8e75a8d0 218 */
dflet 0:400d8e75a8d0 219 int spi_Close(Fd_t fd);
dflet 0:400d8e75a8d0 220
dflet 0:400d8e75a8d0 221 /*!
dflet 0:400d8e75a8d0 222 \brief attempts to read up to len bytes from SPI channel into a buffer
dflet 0:400d8e75a8d0 223 starting at pBuff.
dflet 0:400d8e75a8d0 224
dflet 0:400d8e75a8d0 225 \param[in] fd - file descriptor of an opened SPI channel
dflet 0:400d8e75a8d0 226
dflet 0:400d8e75a8d0 227 \param[in] pBuff - points to first location to start writing the
dflet 0:400d8e75a8d0 228 data
dflet 0:400d8e75a8d0 229
dflet 0:400d8e75a8d0 230 \param[in] len - number of bytes to read from the SPI channel
dflet 0:400d8e75a8d0 231
dflet 0:400d8e75a8d0 232 \return upon successful completion, the function shall return 0.
dflet 0:400d8e75a8d0 233 Otherwise, -1 shall be returned
dflet 0:400d8e75a8d0 234
dflet 0:400d8e75a8d0 235 \sa spi_Open , spi_Write
dflet 0:400d8e75a8d0 236 \note
dflet 0:400d8e75a8d0 237 \warning
dflet 0:400d8e75a8d0 238 */
dflet 0:400d8e75a8d0 239 int spi_Read(Fd_t fd, uint8_t *pBuff, int len);
dflet 0:400d8e75a8d0 240
dflet 0:400d8e75a8d0 241 /*!
dflet 0:400d8e75a8d0 242 \brief attempts to write up to len bytes to the SPI channel
dflet 0:400d8e75a8d0 243
dflet 0:400d8e75a8d0 244 \param[in] fd - file descriptor of an opened SPI channel
dflet 0:400d8e75a8d0 245
dflet 0:400d8e75a8d0 246 \param[in] pBuff - points to first location to start getting the
dflet 0:400d8e75a8d0 247 data from
dflet 0:400d8e75a8d0 248
dflet 0:400d8e75a8d0 249 \param[in] len - number of bytes to write to the SPI channel
dflet 0:400d8e75a8d0 250
dflet 0:400d8e75a8d0 251 \return upon successful completion, the function shall return 0.
dflet 0:400d8e75a8d0 252 Otherwise, -1 shall be returned
dflet 0:400d8e75a8d0 253
dflet 0:400d8e75a8d0 254 \sa spi_Open , spi_Read
dflet 0:400d8e75a8d0 255 \note This function could be implemented as zero copy and return
dflet 0:400d8e75a8d0 256 only upon successful completion of writing the whole buffer,
dflet 0:400d8e75a8d0 257 but in cases that memory allocation is not too tight, the
dflet 0:400d8e75a8d0 258 function could copy the data to internal buffer, return
dflet 0:400d8e75a8d0 259 back and complete the write in parallel to other activities
dflet 0:400d8e75a8d0 260 as long as the other SPI activities would be blocked untill
dflet 0:400d8e75a8d0 261 the entire buffer write would be completed
dflet 0:400d8e75a8d0 262 \warning
dflet 0:400d8e75a8d0 263 */
dflet 0:400d8e75a8d0 264 int spi_Write(Fd_t fd, uint8_t *pBuff, int len);
dflet 0:400d8e75a8d0 265
dflet 0:400d8e75a8d0 266 /*!
dflet 0:400d8e75a8d0 267 \brief The IntSpiGPIOHandler interrupt handler
dflet 0:400d8e75a8d0 268
dflet 0:400d8e75a8d0 269 \param[in] none
dflet 0:400d8e75a8d0 270
dflet 0:400d8e75a8d0 271 \return none
dflet 0:400d8e75a8d0 272
dflet 0:400d8e75a8d0 273 \note
dflet 0:400d8e75a8d0 274
dflet 0:400d8e75a8d0 275 \warning
dflet 0:400d8e75a8d0 276 */
dflet 0:400d8e75a8d0 277 void IntSpiGPIOHandler(void);
dflet 0:400d8e75a8d0 278
dflet 0:400d8e75a8d0 279 /*!
dflet 0:400d8e75a8d0 280 \brief register an interrupt handler for the host IRQ
dflet 0:400d8e75a8d0 281
dflet 0:400d8e75a8d0 282 \param[in] InterruptHdl - pointer to interrupt handler function
dflet 0:400d8e75a8d0 283
dflet 0:400d8e75a8d0 284 \param[in] pValue - pointer to a memory strcuture that is
dflet 0:400d8e75a8d0 285 passed to the interrupt handler.
dflet 0:400d8e75a8d0 286
dflet 0:400d8e75a8d0 287 \return upon successful registration, the function shall return 0.
dflet 0:400d8e75a8d0 288 Otherwise, -1 shall be returned
dflet 0:400d8e75a8d0 289
dflet 0:400d8e75a8d0 290 \sa
dflet 0:400d8e75a8d0 291 \note If there is already registered interrupt handler, the
dflet 0:400d8e75a8d0 292 function should overwrite the old handler with the new one
dflet 0:400d8e75a8d0 293 \warning
dflet 0:400d8e75a8d0 294 */
dflet 0:400d8e75a8d0 295 int registerInterruptHandler(P_EVENT_HANDLER InterruptHdl , void* pValue);
dflet 0:400d8e75a8d0 296
dflet 0:400d8e75a8d0 297 /*!
dflet 0:400d8e75a8d0 298 \brief Masks the Host IRQ
dflet 0:400d8e75a8d0 299
dflet 0:400d8e75a8d0 300 \param[in] none
dflet 0:400d8e75a8d0 301
dflet 0:400d8e75a8d0 302 \return none
dflet 0:400d8e75a8d0 303
dflet 0:400d8e75a8d0 304 \warning
dflet 0:400d8e75a8d0 305 */
dflet 0:400d8e75a8d0 306 void MaskIntHdlr();
dflet 0:400d8e75a8d0 307
dflet 0:400d8e75a8d0 308 /*!
dflet 0:400d8e75a8d0 309 \brief Unmasks the Host IRQ
dflet 0:400d8e75a8d0 310
dflet 0:400d8e75a8d0 311 \param[in] none
dflet 0:400d8e75a8d0 312
dflet 0:400d8e75a8d0 313 \return none
dflet 0:400d8e75a8d0 314
dflet 0:400d8e75a8d0 315 \warning
dflet 0:400d8e75a8d0 316 */
dflet 0:400d8e75a8d0 317 void UnMaskIntHdlr();
dflet 0:400d8e75a8d0 318
dflet 0:400d8e75a8d0 319 void buttonHandler_1(void);
dflet 0:400d8e75a8d0 320
dflet 0:400d8e75a8d0 321 void buttonHandler_2(void);
dflet 0:400d8e75a8d0 322
dflet 0:400d8e75a8d0 323 private:
dflet 0:400d8e75a8d0 324
dflet 0:400d8e75a8d0 325 // InterruptIn _sw1_irq;
dflet 0:400d8e75a8d0 326 // InterruptIn _sw2_irq;
dflet 0:400d8e75a8d0 327 InterruptIn _wlan_irq;
dflet 0:400d8e75a8d0 328 DigitalOut _wlan_nHIB;
dflet 0:400d8e75a8d0 329 DigitalOut _wlan_cs;
dflet 0:400d8e75a8d0 330 SPI _wlan_spi;
dflet 0:400d8e75a8d0 331 cc3100_driver &_driver;
dflet 0:400d8e75a8d0 332
dflet 0:400d8e75a8d0 333
dflet 0:400d8e75a8d0 334 };//class
dflet 0:400d8e75a8d0 335 }//namespace mbed_cc3100
dflet 0:400d8e75a8d0 336 #endif
dflet 0:400d8e75a8d0 337
dflet 0:400d8e75a8d0 338
dflet 0:400d8e75a8d0 339