mbed official / mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

drivers/SPI.h@172:65be27845400, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 20:53:29 2019 +0000
Revision:
172:65be27845400
Parent:
171:3a7713b1edbc 
mbed library release version 165

Who changed what in which revision?

UserRevisionLine numberNew contents of line
AnnaBridge 156:ff21514d8981 1 /* mbed Microcontroller Library
AnnaBridge 156:ff21514d8981 2 * Copyright (c) 2006-2015 ARM Limited
AnnaBridge 172:65be27845400 3 * SPDX-License-Identifier: Apache-2.0
AnnaBridge 156:ff21514d8981 4 *
AnnaBridge 156:ff21514d8981 5 * Licensed under the Apache License, Version 2.0 (the "License");
AnnaBridge 156:ff21514d8981 6 * you may not use this file except in compliance with the License.
AnnaBridge 156:ff21514d8981 7 * You may obtain a copy of the License at
AnnaBridge 156:ff21514d8981 8 *
AnnaBridge 156:ff21514d8981 9 * http://www.apache.org/licenses/LICENSE-2.0
AnnaBridge 156:ff21514d8981 10 *
AnnaBridge 156:ff21514d8981 11 * Unless required by applicable law or agreed to in writing, software
AnnaBridge 156:ff21514d8981 12 * distributed under the License is distributed on an "AS IS" BASIS,
AnnaBridge 156:ff21514d8981 13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
AnnaBridge 156:ff21514d8981 14 * See the License for the specific language governing permissions and
AnnaBridge 156:ff21514d8981 15 * limitations under the License.
AnnaBridge 156:ff21514d8981 16 */
AnnaBridge 156:ff21514d8981 17 #ifndef MBED_SPI_H
AnnaBridge 156:ff21514d8981 18 #define MBED_SPI_H
AnnaBridge 156:ff21514d8981 19
AnnaBridge 156:ff21514d8981 20 #include "platform/platform.h"
AnnaBridge 156:ff21514d8981 21
AnnaBridge 172:65be27845400 22 #if DEVICE_SPI || defined(DOXYGEN_ONLY)
AnnaBridge 156:ff21514d8981 23
AnnaBridge 156:ff21514d8981 24 #include "platform/PlatformMutex.h"
AnnaBridge 156:ff21514d8981 25 #include "hal/spi_api.h"
AnnaBridge 156:ff21514d8981 26 #include "platform/SingletonPtr.h"
AnnaBridge 156:ff21514d8981 27 #include "platform/NonCopyable.h"
AnnaBridge 156:ff21514d8981 28
AnnaBridge 156:ff21514d8981 29 #if DEVICE_SPI_ASYNCH
AnnaBridge 156:ff21514d8981 30 #include "platform/CThunk.h"
AnnaBridge 156:ff21514d8981 31 #include "hal/dma_api.h"
AnnaBridge 156:ff21514d8981 32 #include "platform/CircularBuffer.h"
AnnaBridge 156:ff21514d8981 33 #include "platform/FunctionPointer.h"
AnnaBridge 156:ff21514d8981 34 #include "platform/Transaction.h"
AnnaBridge 156:ff21514d8981 35 #endif
AnnaBridge 156:ff21514d8981 36
AnnaBridge 156:ff21514d8981 37 namespace mbed {
AnnaBridge 156:ff21514d8981 38 /** \addtogroup drivers */
AnnaBridge 156:ff21514d8981 39
AnnaBridge 171:3a7713b1edbc 40 /** A SPI Master, used for communicating with SPI slave devices.
AnnaBridge 156:ff21514d8981 41 *
AnnaBridge 171:3a7713b1edbc 42 * The default format is set to 8-bits, mode 0, and a clock frequency of 1MHz.
AnnaBridge 156:ff21514d8981 43 *
AnnaBridge 156:ff21514d8981 44 * Most SPI devices will also require Chip Select and Reset signals. These
AnnaBridge 171:3a7713b1edbc 45 * can be controlled using DigitalOut pins.
AnnaBridge 156:ff21514d8981 46 *
AnnaBridge 156:ff21514d8981 47 * @note Synchronization level: Thread safe
AnnaBridge 156:ff21514d8981 48 *
AnnaBridge 171:3a7713b1edbc 49 * Example of how to send a byte to a SPI slave and record the response:
AnnaBridge 156:ff21514d8981 50 * @code
AnnaBridge 156:ff21514d8981 51 * #include "mbed.h"
AnnaBridge 156:ff21514d8981 52 *
AnnaBridge 171:3a7713b1edbc 53 * SPI device(SPI_MOSI, SPI_MISO, SPI_SCLK)
AnnaBridge 156:ff21514d8981 54 *
AnnaBridge 171:3a7713b1edbc 55 * DigitalOut chip_select(SPI_CS);
AnnaBridge 156:ff21514d8981 56 *
AnnaBridge 156:ff21514d8981 57 * int main() {
AnnaBridge 156:ff21514d8981 58 * device.lock();
AnnaBridge 171:3a7713b1edbc 59 * chip_select = 0;
AnnaBridge 171:3a7713b1edbc 60 *
AnnaBridge 156:ff21514d8981 61 * int response = device.write(0xFF);
AnnaBridge 171:3a7713b1edbc 62 *
AnnaBridge 171:3a7713b1edbc 63 * chip_select = 1;
AnnaBridge 156:ff21514d8981 64 * device.unlock();
AnnaBridge 171:3a7713b1edbc 65 * }
AnnaBridge 171:3a7713b1edbc 66 * @endcode
AnnaBridge 156:ff21514d8981 67 *
AnnaBridge 171:3a7713b1edbc 68 * Example using hardware Chip Select line:
AnnaBridge 171:3a7713b1edbc 69 * @code
AnnaBridge 171:3a7713b1edbc 70 * #include "mbed.h"
AnnaBridge 171:3a7713b1edbc 71 *
AnnaBridge 171:3a7713b1edbc 72 * SPI device(SPI_MOSI, SPI_MISO, SPI_SCLK, SPI_CS)
AnnaBridge 171:3a7713b1edbc 73 *
AnnaBridge 171:3a7713b1edbc 74 * int main() {
AnnaBridge 171:3a7713b1edbc 75 * device.lock();
AnnaBridge 171:3a7713b1edbc 76 * int response = device.write(0xFF);
AnnaBridge 171:3a7713b1edbc 77 * device.unlock();
AnnaBridge 156:ff21514d8981 78 * }
AnnaBridge 156:ff21514d8981 79 * @endcode
AnnaBridge 156:ff21514d8981 80 * @ingroup drivers
AnnaBridge 156:ff21514d8981 81 */
AnnaBridge 156:ff21514d8981 82 class SPI : private NonCopyable<SPI> {
AnnaBridge 156:ff21514d8981 83
AnnaBridge 156:ff21514d8981 84 public:
AnnaBridge 156:ff21514d8981 85
AnnaBridge 171:3a7713b1edbc 86 /** Create a SPI master connected to the specified pins.
AnnaBridge 156:ff21514d8981 87 *
AnnaBridge 171:3a7713b1edbc 88 * @note You can specify mosi or miso as NC if not used.
AnnaBridge 156:ff21514d8981 89 *
AnnaBridge 171:3a7713b1edbc 90 * @param mosi SPI Master Out, Slave In pin.
AnnaBridge 171:3a7713b1edbc 91 * @param miso SPI Master In, Slave Out pin.
AnnaBridge 171:3a7713b1edbc 92 * @param sclk SPI Clock pin.
AnnaBridge 171:3a7713b1edbc 93 * @param ssel SPI Chip Select pin.
AnnaBridge 156:ff21514d8981 94 */
AnnaBridge 170:e95d10626187 95 SPI(PinName mosi, PinName miso, PinName sclk, PinName ssel = NC);
AnnaBridge 171:3a7713b1edbc 96 virtual ~SPI();
AnnaBridge 156:ff21514d8981 97
AnnaBridge 171:3a7713b1edbc 98 /** Configure the data transmission format.
AnnaBridge 156:ff21514d8981 99 *
AnnaBridge 171:3a7713b1edbc 100 * @param bits Number of bits per SPI frame (4 - 16).
AnnaBridge 171:3a7713b1edbc 101 * @param mode Clock polarity and phase mode (0 - 3).
AnnaBridge 156:ff21514d8981 102 *
AnnaBridge 156:ff21514d8981 103 * @code
AnnaBridge 156:ff21514d8981 104 * mode | POL PHA
AnnaBridge 156:ff21514d8981 105 * -----+--------
AnnaBridge 156:ff21514d8981 106 * 0 | 0 0
AnnaBridge 156:ff21514d8981 107 * 1 | 0 1
AnnaBridge 156:ff21514d8981 108 * 2 | 1 0
AnnaBridge 156:ff21514d8981 109 * 3 | 1 1
AnnaBridge 156:ff21514d8981 110 * @endcode
AnnaBridge 156:ff21514d8981 111 */
AnnaBridge 156:ff21514d8981 112 void format(int bits, int mode = 0);
AnnaBridge 156:ff21514d8981 113
AnnaBridge 171:3a7713b1edbc 114 /** Set the SPI bus clock frequency.
AnnaBridge 156:ff21514d8981 115 *
AnnaBridge 171:3a7713b1edbc 116 * @param hz Clock frequency in Hz (default = 1MHz).
AnnaBridge 156:ff21514d8981 117 */
AnnaBridge 156:ff21514d8981 118 void frequency(int hz = 1000000);
AnnaBridge 156:ff21514d8981 119
AnnaBridge 171:3a7713b1edbc 120 /** Write to the SPI Slave and return the response.
AnnaBridge 156:ff21514d8981 121 *
AnnaBridge 171:3a7713b1edbc 122 * @param value Data to be sent to the SPI slave.
AnnaBridge 156:ff21514d8981 123 *
AnnaBridge 171:3a7713b1edbc 124 * @return Response from the SPI slave.
AnnaBridge 156:ff21514d8981 125 */
AnnaBridge 156:ff21514d8981 126 virtual int write(int value);
AnnaBridge 156:ff21514d8981 127
AnnaBridge 171:3a7713b1edbc 128 /** Write to the SPI Slave and obtain the response.
AnnaBridge 156:ff21514d8981 129 *
AnnaBridge 165:d1b4690b3f8b 130 * The total number of bytes sent and received will be the maximum of
AnnaBridge 156:ff21514d8981 131 * tx_length and rx_length. The bytes written will be padded with the
AnnaBridge 156:ff21514d8981 132 * value 0xff.
AnnaBridge 156:ff21514d8981 133 *
AnnaBridge 171:3a7713b1edbc 134 * @param tx_buffer Pointer to the byte-array of data to write to the device.
AnnaBridge 171:3a7713b1edbc 135 * @param tx_length Number of bytes to write, may be zero.
AnnaBridge 171:3a7713b1edbc 136 * @param rx_buffer Pointer to the byte-array of data to read from the device.
AnnaBridge 171:3a7713b1edbc 137 * @param rx_length Number of bytes to read, may be zero.
AnnaBridge 171:3a7713b1edbc 138 * @return
AnnaBridge 156:ff21514d8981 139 * The number of bytes written and read from the device. This is
AnnaBridge 156:ff21514d8981 140 * maximum of tx_length and rx_length.
AnnaBridge 156:ff21514d8981 141 */
AnnaBridge 156:ff21514d8981 142 virtual int write(const char *tx_buffer, int tx_length, char *rx_buffer, int rx_length);
AnnaBridge 156:ff21514d8981 143
AnnaBridge 171:3a7713b1edbc 144 /** Acquire exclusive access to this SPI bus.
AnnaBridge 156:ff21514d8981 145 */
AnnaBridge 156:ff21514d8981 146 virtual void lock(void);
AnnaBridge 156:ff21514d8981 147
AnnaBridge 171:3a7713b1edbc 148 /** Release exclusive access to this SPI bus.
AnnaBridge 156:ff21514d8981 149 */
AnnaBridge 156:ff21514d8981 150 virtual void unlock(void);
AnnaBridge 156:ff21514d8981 151
AnnaBridge 171:3a7713b1edbc 152 /** Set default write data.
AnnaBridge 156:ff21514d8981 153 * SPI requires the master to send some data during a read operation.
AnnaBridge 156:ff21514d8981 154 * Different devices may require different default byte values.
AnnaBridge 156:ff21514d8981 155 * For example: A SD Card requires default bytes to be 0xFF.
AnnaBridge 156:ff21514d8981 156 *
AnnaBridge 171:3a7713b1edbc 157 * @param data Default character to be transmitted during a read operation.
AnnaBridge 156:ff21514d8981 158 */
AnnaBridge 156:ff21514d8981 159 void set_default_write_value(char data);
AnnaBridge 156:ff21514d8981 160
AnnaBridge 156:ff21514d8981 161 #if DEVICE_SPI_ASYNCH
AnnaBridge 156:ff21514d8981 162
AnnaBridge 156:ff21514d8981 163 /** Start non-blocking SPI transfer using 8bit buffers.
AnnaBridge 156:ff21514d8981 164 *
AnnaBridge 171:3a7713b1edbc 165 * This function locks the deep sleep until any event has occurred.
AnnaBridge 170:e95d10626187 166 *
AnnaBridge 171:3a7713b1edbc 167 * @param tx_buffer The TX buffer with data to be transferred. If NULL is passed,
AnnaBridge 171:3a7713b1edbc 168 * the default SPI value is sent.
AnnaBridge 171:3a7713b1edbc 169 * @param tx_length The length of TX buffer in bytes.
AnnaBridge 156:ff21514d8981 170 * @param rx_buffer The RX buffer which is used for received data. If NULL is passed,
AnnaBridge 171:3a7713b1edbc 171 * received data are ignored.
AnnaBridge 171:3a7713b1edbc 172 * @param rx_length The length of RX buffer in bytes.
AnnaBridge 171:3a7713b1edbc 173 * @param callback The event callback function.
AnnaBridge 171:3a7713b1edbc 174 * @param event The event mask of events to modify. @see spi_api.h for SPI events.
AnnaBridge 171:3a7713b1edbc 175 *
AnnaBridge 171:3a7713b1edbc 176 * @return Operation result.
AnnaBridge 171:3a7713b1edbc 177 * @retval 0 If the transfer has started.
AnnaBridge 171:3a7713b1edbc 178 * @retval -1 If SPI peripheral is busy.
AnnaBridge 156:ff21514d8981 179 */
AnnaBridge 156:ff21514d8981 180 template<typename Type>
AnnaBridge 170:e95d10626187 181 int transfer(const Type *tx_buffer, int tx_length, Type *rx_buffer, int rx_length, const event_callback_t &callback, int event = SPI_EVENT_COMPLETE)
AnnaBridge 170:e95d10626187 182 {
AnnaBridge 156:ff21514d8981 183 if (spi_active(&_spi)) {
AnnaBridge 170:e95d10626187 184 return queue_transfer(tx_buffer, tx_length, rx_buffer, rx_length, sizeof(Type) * 8, callback, event);
AnnaBridge 156:ff21514d8981 185 }
AnnaBridge 170:e95d10626187 186 start_transfer(tx_buffer, tx_length, rx_buffer, rx_length, sizeof(Type) * 8, callback, event);
AnnaBridge 156:ff21514d8981 187 return 0;
AnnaBridge 156:ff21514d8981 188 }
AnnaBridge 156:ff21514d8981 189
AnnaBridge 171:3a7713b1edbc 190 /** Abort the on-going SPI transfer, and continue with transfers in the queue, if any.
AnnaBridge 156:ff21514d8981 191 */
AnnaBridge 156:ff21514d8981 192 void abort_transfer();
AnnaBridge 156:ff21514d8981 193
AnnaBridge 171:3a7713b1edbc 194 /** Clear the queue of transfers.
AnnaBridge 156:ff21514d8981 195 */
AnnaBridge 156:ff21514d8981 196 void clear_transfer_buffer();
AnnaBridge 156:ff21514d8981 197
AnnaBridge 171:3a7713b1edbc 198 /** Clear the queue of transfers and abort the on-going transfer.
AnnaBridge 156:ff21514d8981 199 */
AnnaBridge 156:ff21514d8981 200 void abort_all_transfers();
AnnaBridge 156:ff21514d8981 201
AnnaBridge 171:3a7713b1edbc 202 /** Configure DMA usage suggestion for non-blocking transfers.
AnnaBridge 171:3a7713b1edbc 203 *
AnnaBridge 171:3a7713b1edbc 204 * @param usage The usage DMA hint for peripheral.
AnnaBridge 156:ff21514d8981 205 *
AnnaBridge 171:3a7713b1edbc 206 * @return Result of the operation.
AnnaBridge 171:3a7713b1edbc 207 * @retval 0 The usage was set.
AnnaBridge 171:3a7713b1edbc 208 * @retval -1 Usage cannot be set as there is an ongoing transaction.
AnnaBridge 171:3a7713b1edbc 209 */
AnnaBridge 156:ff21514d8981 210 int set_dma_usage(DMAUsage usage);
AnnaBridge 156:ff21514d8981 211
AnnaBridge 172:65be27845400 212 #if !defined(DOXYGEN_ONLY)
AnnaBridge 156:ff21514d8981 213 protected:
AnnaBridge 171:3a7713b1edbc 214 /** SPI interrupt handler.
AnnaBridge 171:3a7713b1edbc 215 */
AnnaBridge 156:ff21514d8981 216 void irq_handler_asynch(void);
AnnaBridge 156:ff21514d8981 217
AnnaBridge 171:3a7713b1edbc 218 /** Start the transfer or put it on the queue.
AnnaBridge 156:ff21514d8981 219 *
AnnaBridge 171:3a7713b1edbc 220 * @param tx_buffer The TX buffer with data to be transferred. If NULL is passed,
AnnaBridge 156:ff21514d8981 221 * the default SPI value is sent
AnnaBridge 171:3a7713b1edbc 222 * @param tx_length The length of TX buffer in bytes.
AnnaBridge 156:ff21514d8981 223 * @param rx_buffer The RX buffer which is used for received data. If NULL is passed,
AnnaBridge 171:3a7713b1edbc 224 * received data are ignored.
AnnaBridge 171:3a7713b1edbc 225 * @param rx_length The length of RX buffer in bytes.
AnnaBridge 171:3a7713b1edbc 226 * @param bit_width The buffers element width in bits.
AnnaBridge 171:3a7713b1edbc 227 * @param callback The event callback function.
AnnaBridge 171:3a7713b1edbc 228 * @param event The event mask of events to modify.
AnnaBridge 171:3a7713b1edbc 229 *
AnnaBridge 171:3a7713b1edbc 230 * @return Operation success.
AnnaBridge 171:3a7713b1edbc 231 * @retval 0 A transfer was started or added to the queue.
AnnaBridge 171:3a7713b1edbc 232 * @retval -1 Transfer can't be added because queue is full.
AnnaBridge 171:3a7713b1edbc 233 */
AnnaBridge 170:e95d10626187 234 int transfer(const void *tx_buffer, int tx_length, void *rx_buffer, int rx_length, unsigned char bit_width, const event_callback_t &callback, int event);
AnnaBridge 156:ff21514d8981 235
AnnaBridge 171:3a7713b1edbc 236 /** Put a transfer on the transfer queue.
AnnaBridge 156:ff21514d8981 237 *
AnnaBridge 171:3a7713b1edbc 238 * @param tx_buffer The TX buffer with data to be transferred. If NULL is passed,
AnnaBridge 171:3a7713b1edbc 239 * the default SPI value is sent.
AnnaBridge 171:3a7713b1edbc 240 * @param tx_length The length of TX buffer in bytes.
AnnaBridge 156:ff21514d8981 241 * @param rx_buffer The RX buffer which is used for received data. If NULL is passed,
AnnaBridge 171:3a7713b1edbc 242 * received data are ignored.
AnnaBridge 171:3a7713b1edbc 243 * @param rx_length The length of RX buffer in bytes.
AnnaBridge 171:3a7713b1edbc 244 * @param bit_width The buffers element width in bits.
AnnaBridge 171:3a7713b1edbc 245 * @param callback The event callback function.
AnnaBridge 171:3a7713b1edbc 246 * @param event The event mask of events to modify.
AnnaBridge 171:3a7713b1edbc 247 *
AnnaBridge 171:3a7713b1edbc 248 * @return Operation success.
AnnaBridge 171:3a7713b1edbc 249 * @retval 0 A transfer was added to the queue.
AnnaBridge 171:3a7713b1edbc 250 * @retval -1 Transfer can't be added because queue is full.
AnnaBridge 171:3a7713b1edbc 251 */
AnnaBridge 170:e95d10626187 252 int queue_transfer(const void *tx_buffer, int tx_length, void *rx_buffer, int rx_length, unsigned char bit_width, const event_callback_t &callback, int event);
AnnaBridge 156:ff21514d8981 253
AnnaBridge 171:3a7713b1edbc 254 /** Configure a callback, SPI peripheral, and initiate a new transfer.
AnnaBridge 156:ff21514d8981 255 *
AnnaBridge 171:3a7713b1edbc 256 * @param tx_buffer The TX buffer with data to be transferred. If NULL is passed,
AnnaBridge 171:3a7713b1edbc 257 * the default SPI value is sent.
AnnaBridge 171:3a7713b1edbc 258 * @param tx_length The length of TX buffer in bytes.
AnnaBridge 156:ff21514d8981 259 * @param rx_buffer The RX buffer which is used for received data. If NULL is passed,
AnnaBridge 171:3a7713b1edbc 260 * received data are ignored.
AnnaBridge 171:3a7713b1edbc 261 * @param rx_length The length of RX buffer in bytes.
AnnaBridge 171:3a7713b1edbc 262 * @param bit_width The buffers element width.
AnnaBridge 171:3a7713b1edbc 263 * @param callback The event callback function.
AnnaBridge 171:3a7713b1edbc 264 * @param event The event mask of events to modify.
AnnaBridge 171:3a7713b1edbc 265 */
AnnaBridge 170:e95d10626187 266 void start_transfer(const void *tx_buffer, int tx_length, void *rx_buffer, int rx_length, unsigned char bit_width, const event_callback_t &callback, int event);
AnnaBridge 156:ff21514d8981 267
Anna Bridge 160:5571c4ff569f 268 private:
Anna Bridge 160:5571c4ff569f 269 /** Lock deep sleep only if it is not yet locked */
Anna Bridge 160:5571c4ff569f 270 void lock_deep_sleep();
Anna Bridge 160:5571c4ff569f 271
Anna Bridge 160:5571c4ff569f 272 /** Unlock deep sleep in case it is locked */
Anna Bridge 160:5571c4ff569f 273 void unlock_deep_sleep();
Anna Bridge 160:5571c4ff569f 274
Anna Bridge 160:5571c4ff569f 275
AnnaBridge 156:ff21514d8981 276 #if TRANSACTION_QUEUE_SIZE_SPI
AnnaBridge 156:ff21514d8981 277
AnnaBridge 171:3a7713b1edbc 278 /** Start a new transaction.
AnnaBridge 156:ff21514d8981 279 *
AnnaBridge 171:3a7713b1edbc 280 * @param data Transaction data.
AnnaBridge 171:3a7713b1edbc 281 */
AnnaBridge 156:ff21514d8981 282 void start_transaction(transaction_t *data);
AnnaBridge 156:ff21514d8981 283
AnnaBridge 171:3a7713b1edbc 284 /** Dequeue a transaction and start the transfer if there was one pending.
AnnaBridge 171:3a7713b1edbc 285 */
AnnaBridge 156:ff21514d8981 286 void dequeue_transaction();
AnnaBridge 171:3a7713b1edbc 287
AnnaBridge 171:3a7713b1edbc 288 /* Queue of pending transfers */
AnnaBridge 156:ff21514d8981 289 static CircularBuffer<Transaction<SPI>, TRANSACTION_QUEUE_SIZE_SPI> _transaction_buffer;
AnnaBridge 156:ff21514d8981 290 #endif
AnnaBridge 156:ff21514d8981 291
AnnaBridge 171:3a7713b1edbc 292 #endif //!defined(DOXYGEN_ONLY)
AnnaBridge 156:ff21514d8981 293
AnnaBridge 171:3a7713b1edbc 294 #endif //DEVICE_SPI_ASYNCH
AnnaBridge 171:3a7713b1edbc 295
AnnaBridge 171:3a7713b1edbc 296 #if !defined(DOXYGEN_ONLY)
AnnaBridge 156:ff21514d8981 297 protected:
AnnaBridge 171:3a7713b1edbc 298 /* Internal SPI object identifying the resources */
AnnaBridge 156:ff21514d8981 299 spi_t _spi;
AnnaBridge 156:ff21514d8981 300
AnnaBridge 156:ff21514d8981 301 #if DEVICE_SPI_ASYNCH
AnnaBridge 171:3a7713b1edbc 302 /* Interrupt */
AnnaBridge 156:ff21514d8981 303 CThunk<SPI> _irq;
AnnaBridge 171:3a7713b1edbc 304 /* Interrupt handler callback */
AnnaBridge 156:ff21514d8981 305 event_callback_t _callback;
AnnaBridge 171:3a7713b1edbc 306 /* Current preferred DMA mode @see dma_api.h */
AnnaBridge 156:ff21514d8981 307 DMAUsage _usage;
AnnaBridge 171:3a7713b1edbc 308 /* Current sate of the sleep manager */
Anna Bridge 160:5571c4ff569f 309 bool _deep_sleep_locked;
AnnaBridge 156:ff21514d8981 310 #endif
AnnaBridge 156:ff21514d8981 311
AnnaBridge 171:3a7713b1edbc 312 /* Take over the physical SPI and apply our settings (thread safe) */
AnnaBridge 156:ff21514d8981 313 void aquire(void);
AnnaBridge 171:3a7713b1edbc 314 /* Current user of the SPI */
AnnaBridge 156:ff21514d8981 315 static SPI *_owner;
AnnaBridge 171:3a7713b1edbc 316 /* Used by lock and unlock for thread safety */
AnnaBridge 156:ff21514d8981 317 static SingletonPtr<PlatformMutex> _mutex;
AnnaBridge 171:3a7713b1edbc 318 /* Size of the SPI frame */
AnnaBridge 156:ff21514d8981 319 int _bits;
AnnaBridge 171:3a7713b1edbc 320 /* Clock polairy and phase */
AnnaBridge 156:ff21514d8981 321 int _mode;
AnnaBridge 171:3a7713b1edbc 322 /* Clock frequency */
AnnaBridge 156:ff21514d8981 323 int _hz;
AnnaBridge 171:3a7713b1edbc 324 /* Default character used for NULL transfers */
AnnaBridge 156:ff21514d8981 325 char _write_fill;
AnnaBridge 156:ff21514d8981 326
AnnaBridge 156:ff21514d8981 327 private:
AnnaBridge 171:3a7713b1edbc 328 /** Private acquire function without locking/unlocking.
AnnaBridge 171:3a7713b1edbc 329 * Implemented in order to avoid duplicate locking and boost performance.
AnnaBridge 156:ff21514d8981 330 */
AnnaBridge 156:ff21514d8981 331 void _acquire(void);
AnnaBridge 171:3a7713b1edbc 332
AnnaBridge 171:3a7713b1edbc 333 #endif //!defined(DOXYGEN_ONLY)
AnnaBridge 156:ff21514d8981 334 };
AnnaBridge 156:ff21514d8981 335
AnnaBridge 156:ff21514d8981 336 } // namespace mbed
AnnaBridge 156:ff21514d8981 337
AnnaBridge 156:ff21514d8981 338 #endif
AnnaBridge 156:ff21514d8981 339
AnnaBridge 156:ff21514d8981 340 #endif