David Fletcher / Mbed 2 deprecated cc3100_test

TI's CC3100 host driver and demo. Experimental and a work in progress.

Dependencies:   mbed

simplelink/cc3100_spi.h@2:a3e52cf86086, 2014-11-19 (annotated)

Committer:
dflet
Date:
Wed Nov 19 23:04:04 2014 +0000
Revision:
2:a3e52cf86086
Parent:
0:bbe98578d4c0 
Added more boards!

Who changed what in which revision?

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