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@171:3a7713b1edbc, 2018-11-08 (annotated)

Committer:
AnnaBridge
Date:
Thu Nov 08 11:45:42 2018 +0000
Revision:
171:3a7713b1edbc
Parent:
170:e95d10626187
Child:
172:65be27845400
mbed library. Release version 164

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