David Fletcher / Mbed 2 deprecated cc3100_Test_mqtt_CM4F

TI's MQTT Demo with freertos CM4F

Dependencies:   mbed

simplelink/cc3100_spi.h@0:1e7b5dd9edb4, 2015-09-03 (annotated)

Committer:
dflet
Date:
Thu Sep 03 14:07:01 2015 +0000
Revision:
0:1e7b5dd9edb4
First commit, it's been hanging around for a while. Updated SPI mode change 1 to 0.

Who changed what in which revision?

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