Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
mbed-os/drivers/SPI.h@9:d58e77ebd769, 2018-03-02 (annotated)
- Committer:
- Nathan Yonkee
- Date:
- Fri Mar 02 07:12:37 2018 -0700
- Revision:
- 9:d58e77ebd769
add mbed-os library
Who changed what in which revision?
| User | Revision | Line number | New contents of line |
|---|---|---|---|
| Nathan Yonkee |
9:d58e77ebd769 | 1 | /* mbed Microcontroller Library |
| Nathan Yonkee |
9:d58e77ebd769 | 2 | * Copyright (c) 2006-2015 ARM Limited |
| Nathan Yonkee |
9:d58e77ebd769 | 3 | * |
| Nathan Yonkee |
9:d58e77ebd769 | 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| Nathan Yonkee |
9:d58e77ebd769 | 5 | * you may not use this file except in compliance with the License. |
| Nathan Yonkee |
9:d58e77ebd769 | 6 | * You may obtain a copy of the License at |
| Nathan Yonkee |
9:d58e77ebd769 | 7 | * |
| Nathan Yonkee |
9:d58e77ebd769 | 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| Nathan Yonkee |
9:d58e77ebd769 | 9 | * |
| Nathan Yonkee |
9:d58e77ebd769 | 10 | * Unless required by applicable law or agreed to in writing, software |
| Nathan Yonkee |
9:d58e77ebd769 | 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| Nathan Yonkee |
9:d58e77ebd769 | 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| Nathan Yonkee |
9:d58e77ebd769 | 13 | * See the License for the specific language governing permissions and |
| Nathan Yonkee |
9:d58e77ebd769 | 14 | * limitations under the License. |
| Nathan Yonkee |
9:d58e77ebd769 | 15 | */ |
| Nathan Yonkee |
9:d58e77ebd769 | 16 | #ifndef MBED_SPI_H |
| Nathan Yonkee |
9:d58e77ebd769 | 17 | #define MBED_SPI_H |
| Nathan Yonkee |
9:d58e77ebd769 | 18 | |
| Nathan Yonkee |
9:d58e77ebd769 | 19 | #include "platform/platform.h" |
| Nathan Yonkee |
9:d58e77ebd769 | 20 | |
| Nathan Yonkee |
9:d58e77ebd769 | 21 | #if defined (DEVICE_SPI) || defined(DOXYGEN_ONLY) |
| Nathan Yonkee |
9:d58e77ebd769 | 22 | |
| Nathan Yonkee |
9:d58e77ebd769 | 23 | #include "platform/PlatformMutex.h" |
| Nathan Yonkee |
9:d58e77ebd769 | 24 | #include "hal/spi_api.h" |
| Nathan Yonkee |
9:d58e77ebd769 | 25 | #include "platform/SingletonPtr.h" |
| Nathan Yonkee |
9:d58e77ebd769 | 26 | #include "platform/NonCopyable.h" |
| Nathan Yonkee |
9:d58e77ebd769 | 27 | |
| Nathan Yonkee |
9:d58e77ebd769 | 28 | #if DEVICE_SPI_ASYNCH |
| Nathan Yonkee |
9:d58e77ebd769 | 29 | #include "platform/CThunk.h" |
| Nathan Yonkee |
9:d58e77ebd769 | 30 | #include "hal/dma_api.h" |
| Nathan Yonkee |
9:d58e77ebd769 | 31 | #include "platform/CircularBuffer.h" |
| Nathan Yonkee |
9:d58e77ebd769 | 32 | #include "platform/FunctionPointer.h" |
| Nathan Yonkee |
9:d58e77ebd769 | 33 | #include "platform/Transaction.h" |
| Nathan Yonkee |
9:d58e77ebd769 | 34 | #endif |
| Nathan Yonkee |
9:d58e77ebd769 | 35 | |
| Nathan Yonkee |
9:d58e77ebd769 | 36 | namespace mbed { |
| Nathan Yonkee |
9:d58e77ebd769 | 37 | /** \addtogroup drivers */ |
| Nathan Yonkee |
9:d58e77ebd769 | 38 | |
| Nathan Yonkee |
9:d58e77ebd769 | 39 | /** A SPI Master, used for communicating with SPI slave devices |
| Nathan Yonkee |
9:d58e77ebd769 | 40 | * |
| Nathan Yonkee |
9:d58e77ebd769 | 41 | * The default format is set to 8-bits, mode 0, and a clock frequency of 1MHz |
| Nathan Yonkee |
9:d58e77ebd769 | 42 | * |
| Nathan Yonkee |
9:d58e77ebd769 | 43 | * Most SPI devices will also require Chip Select and Reset signals. These |
| Nathan Yonkee |
9:d58e77ebd769 | 44 | * can be controlled using DigitalOut pins |
| Nathan Yonkee |
9:d58e77ebd769 | 45 | * |
| Nathan Yonkee |
9:d58e77ebd769 | 46 | * @note Synchronization level: Thread safe |
| Nathan Yonkee |
9:d58e77ebd769 | 47 | * |
| Nathan Yonkee |
9:d58e77ebd769 | 48 | * Example: |
| Nathan Yonkee |
9:d58e77ebd769 | 49 | * @code |
| Nathan Yonkee |
9:d58e77ebd769 | 50 | * // Send a byte to a SPI slave, and record the response |
| Nathan Yonkee |
9:d58e77ebd769 | 51 | * |
| Nathan Yonkee |
9:d58e77ebd769 | 52 | * #include "mbed.h" |
| Nathan Yonkee |
9:d58e77ebd769 | 53 | * |
| Nathan Yonkee |
9:d58e77ebd769 | 54 | * // hardware ssel (where applicable) |
| Nathan Yonkee |
9:d58e77ebd769 | 55 | * //SPI device(p5, p6, p7, p8); // mosi, miso, sclk, ssel |
| Nathan Yonkee |
9:d58e77ebd769 | 56 | * |
| Nathan Yonkee |
9:d58e77ebd769 | 57 | * // software ssel |
| Nathan Yonkee |
9:d58e77ebd769 | 58 | * SPI device(p5, p6, p7); // mosi, miso, sclk |
| Nathan Yonkee |
9:d58e77ebd769 | 59 | * DigitalOut cs(p8); // ssel |
| Nathan Yonkee |
9:d58e77ebd769 | 60 | * |
| Nathan Yonkee |
9:d58e77ebd769 | 61 | * int main() { |
| Nathan Yonkee |
9:d58e77ebd769 | 62 | * // hardware ssel (where applicable) |
| Nathan Yonkee |
9:d58e77ebd769 | 63 | * //int response = device.write(0xFF); |
| Nathan Yonkee |
9:d58e77ebd769 | 64 | * |
| Nathan Yonkee |
9:d58e77ebd769 | 65 | * device.lock(); |
| Nathan Yonkee |
9:d58e77ebd769 | 66 | * // software ssel |
| Nathan Yonkee |
9:d58e77ebd769 | 67 | * cs = 0; |
| Nathan Yonkee |
9:d58e77ebd769 | 68 | * int response = device.write(0xFF); |
| Nathan Yonkee |
9:d58e77ebd769 | 69 | * cs = 1; |
| Nathan Yonkee |
9:d58e77ebd769 | 70 | * device.unlock(); |
| Nathan Yonkee |
9:d58e77ebd769 | 71 | * |
| Nathan Yonkee |
9:d58e77ebd769 | 72 | * } |
| Nathan Yonkee |
9:d58e77ebd769 | 73 | * @endcode |
| Nathan Yonkee |
9:d58e77ebd769 | 74 | * @ingroup drivers |
| Nathan Yonkee |
9:d58e77ebd769 | 75 | */ |
| Nathan Yonkee |
9:d58e77ebd769 | 76 | class SPI : private NonCopyable<SPI> { |
| Nathan Yonkee |
9:d58e77ebd769 | 77 | |
| Nathan Yonkee |
9:d58e77ebd769 | 78 | public: |
| Nathan Yonkee |
9:d58e77ebd769 | 79 | |
| Nathan Yonkee |
9:d58e77ebd769 | 80 | /** Create a SPI master connected to the specified pins |
| Nathan Yonkee |
9:d58e77ebd769 | 81 | * |
| Nathan Yonkee |
9:d58e77ebd769 | 82 | * mosi or miso can be specfied as NC if not used |
| Nathan Yonkee |
9:d58e77ebd769 | 83 | * |
| Nathan Yonkee |
9:d58e77ebd769 | 84 | * @param mosi SPI Master Out, Slave In pin |
| Nathan Yonkee |
9:d58e77ebd769 | 85 | * @param miso SPI Master In, Slave Out pin |
| Nathan Yonkee |
9:d58e77ebd769 | 86 | * @param sclk SPI Clock pin |
| Nathan Yonkee |
9:d58e77ebd769 | 87 | * @param ssel SPI chip select pin |
| Nathan Yonkee |
9:d58e77ebd769 | 88 | */ |
| Nathan Yonkee |
9:d58e77ebd769 | 89 | SPI(PinName mosi, PinName miso, PinName sclk, PinName ssel=NC); |
| Nathan Yonkee |
9:d58e77ebd769 | 90 | |
| Nathan Yonkee |
9:d58e77ebd769 | 91 | /** Configure the data transmission format |
| Nathan Yonkee |
9:d58e77ebd769 | 92 | * |
| Nathan Yonkee |
9:d58e77ebd769 | 93 | * @param bits Number of bits per SPI frame (4 - 16) |
| Nathan Yonkee |
9:d58e77ebd769 | 94 | * @param mode Clock polarity and phase mode (0 - 3) |
| Nathan Yonkee |
9:d58e77ebd769 | 95 | * |
| Nathan Yonkee |
9:d58e77ebd769 | 96 | * @code |
| Nathan Yonkee |
9:d58e77ebd769 | 97 | * mode | POL PHA |
| Nathan Yonkee |
9:d58e77ebd769 | 98 | * -----+-------- |
| Nathan Yonkee |
9:d58e77ebd769 | 99 | * 0 | 0 0 |
| Nathan Yonkee |
9:d58e77ebd769 | 100 | * 1 | 0 1 |
| Nathan Yonkee |
9:d58e77ebd769 | 101 | * 2 | 1 0 |
| Nathan Yonkee |
9:d58e77ebd769 | 102 | * 3 | 1 1 |
| Nathan Yonkee |
9:d58e77ebd769 | 103 | * @endcode |
| Nathan Yonkee |
9:d58e77ebd769 | 104 | */ |
| Nathan Yonkee |
9:d58e77ebd769 | 105 | void format(int bits, int mode = 0); |
| Nathan Yonkee |
9:d58e77ebd769 | 106 | |
| Nathan Yonkee |
9:d58e77ebd769 | 107 | /** Set the spi bus clock frequency |
| Nathan Yonkee |
9:d58e77ebd769 | 108 | * |
| Nathan Yonkee |
9:d58e77ebd769 | 109 | * @param hz SCLK frequency in hz (default = 1MHz) |
| Nathan Yonkee |
9:d58e77ebd769 | 110 | */ |
| Nathan Yonkee |
9:d58e77ebd769 | 111 | void frequency(int hz = 1000000); |
| Nathan Yonkee |
9:d58e77ebd769 | 112 | |
| Nathan Yonkee |
9:d58e77ebd769 | 113 | /** Write to the SPI Slave and return the response |
| Nathan Yonkee |
9:d58e77ebd769 | 114 | * |
| Nathan Yonkee |
9:d58e77ebd769 | 115 | * @param value Data to be sent to the SPI slave |
| Nathan Yonkee |
9:d58e77ebd769 | 116 | * |
| Nathan Yonkee |
9:d58e77ebd769 | 117 | * @returns |
| Nathan Yonkee |
9:d58e77ebd769 | 118 | * Response from the SPI slave |
| Nathan Yonkee |
9:d58e77ebd769 | 119 | */ |
| Nathan Yonkee |
9:d58e77ebd769 | 120 | virtual int write(int value); |
| Nathan Yonkee |
9:d58e77ebd769 | 121 | |
| Nathan Yonkee |
9:d58e77ebd769 | 122 | /** Write to the SPI Slave and obtain the response |
| Nathan Yonkee |
9:d58e77ebd769 | 123 | * |
| Nathan Yonkee |
9:d58e77ebd769 | 124 | * The total number of bytes sent and recieved will be the maximum of |
| Nathan Yonkee |
9:d58e77ebd769 | 125 | * tx_length and rx_length. The bytes written will be padded with the |
| Nathan Yonkee |
9:d58e77ebd769 | 126 | * value 0xff. |
| Nathan Yonkee |
9:d58e77ebd769 | 127 | * |
| Nathan Yonkee |
9:d58e77ebd769 | 128 | * @param tx_buffer Pointer to the byte-array of data to write to the device |
| Nathan Yonkee |
9:d58e77ebd769 | 129 | * @param tx_length Number of bytes to write, may be zero |
| Nathan Yonkee |
9:d58e77ebd769 | 130 | * @param rx_buffer Pointer to the byte-array of data to read from the device |
| Nathan Yonkee |
9:d58e77ebd769 | 131 | * @param rx_length Number of bytes to read, may be zero |
| Nathan Yonkee |
9:d58e77ebd769 | 132 | * @returns |
| Nathan Yonkee |
9:d58e77ebd769 | 133 | * The number of bytes written and read from the device. This is |
| Nathan Yonkee |
9:d58e77ebd769 | 134 | * maximum of tx_length and rx_length. |
| Nathan Yonkee |
9:d58e77ebd769 | 135 | */ |
| Nathan Yonkee |
9:d58e77ebd769 | 136 | virtual int write(const char *tx_buffer, int tx_length, char *rx_buffer, int rx_length); |
| Nathan Yonkee |
9:d58e77ebd769 | 137 | |
| Nathan Yonkee |
9:d58e77ebd769 | 138 | /** Acquire exclusive access to this SPI bus |
| Nathan Yonkee |
9:d58e77ebd769 | 139 | */ |
| Nathan Yonkee |
9:d58e77ebd769 | 140 | virtual void lock(void); |
| Nathan Yonkee |
9:d58e77ebd769 | 141 | |
| Nathan Yonkee |
9:d58e77ebd769 | 142 | /** Release exclusive access to this SPI bus |
| Nathan Yonkee |
9:d58e77ebd769 | 143 | */ |
| Nathan Yonkee |
9:d58e77ebd769 | 144 | virtual void unlock(void); |
| Nathan Yonkee |
9:d58e77ebd769 | 145 | |
| Nathan Yonkee |
9:d58e77ebd769 | 146 | /** Set default write data |
| Nathan Yonkee |
9:d58e77ebd769 | 147 | * SPI requires the master to send some data during a read operation. |
| Nathan Yonkee |
9:d58e77ebd769 | 148 | * Different devices may require different default byte values. |
| Nathan Yonkee |
9:d58e77ebd769 | 149 | * For example: A SD Card requires default bytes to be 0xFF. |
| Nathan Yonkee |
9:d58e77ebd769 | 150 | * |
| Nathan Yonkee |
9:d58e77ebd769 | 151 | * @param data Default character to be transmitted while read operation |
| Nathan Yonkee |
9:d58e77ebd769 | 152 | */ |
| Nathan Yonkee |
9:d58e77ebd769 | 153 | void set_default_write_value(char data); |
| Nathan Yonkee |
9:d58e77ebd769 | 154 | |
| Nathan Yonkee |
9:d58e77ebd769 | 155 | #if DEVICE_SPI_ASYNCH |
| Nathan Yonkee |
9:d58e77ebd769 | 156 | |
| Nathan Yonkee |
9:d58e77ebd769 | 157 | /** Start non-blocking SPI transfer using 8bit buffers. |
| Nathan Yonkee |
9:d58e77ebd769 | 158 | * |
| Nathan Yonkee |
9:d58e77ebd769 | 159 | * This function locks the deep sleep until any event has occured |
| Nathan Yonkee |
9:d58e77ebd769 | 160 | * |
| Nathan Yonkee |
9:d58e77ebd769 | 161 | * @param tx_buffer The TX buffer with data to be transfered. If NULL is passed, |
| Nathan Yonkee |
9:d58e77ebd769 | 162 | * the default SPI value is sent |
| Nathan Yonkee |
9:d58e77ebd769 | 163 | * @param tx_length The length of TX buffer in bytes |
| Nathan Yonkee |
9:d58e77ebd769 | 164 | * @param rx_buffer The RX buffer which is used for received data. If NULL is passed, |
| Nathan Yonkee |
9:d58e77ebd769 | 165 | * received data are ignored |
| Nathan Yonkee |
9:d58e77ebd769 | 166 | * @param rx_length The length of RX buffer in bytes |
| Nathan Yonkee |
9:d58e77ebd769 | 167 | * @param callback The event callback function |
| Nathan Yonkee |
9:d58e77ebd769 | 168 | * @param event The logical OR of events to modify. Look at spi hal header file for SPI events. |
| Nathan Yonkee |
9:d58e77ebd769 | 169 | * @return Zero if the transfer has started, or -1 if SPI peripheral is busy |
| Nathan Yonkee |
9:d58e77ebd769 | 170 | */ |
| Nathan Yonkee |
9:d58e77ebd769 | 171 | template<typename Type> |
| Nathan Yonkee |
9:d58e77ebd769 | 172 | 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) { |
| Nathan Yonkee |
9:d58e77ebd769 | 173 | if (spi_active(&_spi)) { |
| Nathan Yonkee |
9:d58e77ebd769 | 174 | return queue_transfer(tx_buffer, tx_length, rx_buffer, rx_length, sizeof(Type)*8, callback, event); |
| Nathan Yonkee |
9:d58e77ebd769 | 175 | } |
| Nathan Yonkee |
9:d58e77ebd769 | 176 | start_transfer(tx_buffer, tx_length, rx_buffer, rx_length, sizeof(Type)*8, callback, event); |
| Nathan Yonkee |
9:d58e77ebd769 | 177 | return 0; |
| Nathan Yonkee |
9:d58e77ebd769 | 178 | } |
| Nathan Yonkee |
9:d58e77ebd769 | 179 | |
| Nathan Yonkee |
9:d58e77ebd769 | 180 | /** Abort the on-going SPI transfer, and continue with transfer's in the queue if any. |
| Nathan Yonkee |
9:d58e77ebd769 | 181 | */ |
| Nathan Yonkee |
9:d58e77ebd769 | 182 | void abort_transfer(); |
| Nathan Yonkee |
9:d58e77ebd769 | 183 | |
| Nathan Yonkee |
9:d58e77ebd769 | 184 | /** Clear the transaction buffer |
| Nathan Yonkee |
9:d58e77ebd769 | 185 | */ |
| Nathan Yonkee |
9:d58e77ebd769 | 186 | void clear_transfer_buffer(); |
| Nathan Yonkee |
9:d58e77ebd769 | 187 | |
| Nathan Yonkee |
9:d58e77ebd769 | 188 | /** Clear the transaction buffer and abort on-going transfer. |
| Nathan Yonkee |
9:d58e77ebd769 | 189 | */ |
| Nathan Yonkee |
9:d58e77ebd769 | 190 | void abort_all_transfers(); |
| Nathan Yonkee |
9:d58e77ebd769 | 191 | |
| Nathan Yonkee |
9:d58e77ebd769 | 192 | /** Configure DMA usage suggestion for non-blocking transfers |
| Nathan Yonkee |
9:d58e77ebd769 | 193 | * |
| Nathan Yonkee |
9:d58e77ebd769 | 194 | * @param usage The usage DMA hint for peripheral |
| Nathan Yonkee |
9:d58e77ebd769 | 195 | * @return Zero if the usage was set, -1 if a transaction is on-going |
| Nathan Yonkee |
9:d58e77ebd769 | 196 | */ |
| Nathan Yonkee |
9:d58e77ebd769 | 197 | int set_dma_usage(DMAUsage usage); |
| Nathan Yonkee |
9:d58e77ebd769 | 198 | |
| Nathan Yonkee |
9:d58e77ebd769 | 199 | protected: |
| Nathan Yonkee |
9:d58e77ebd769 | 200 | /** SPI IRQ handler |
| Nathan Yonkee |
9:d58e77ebd769 | 201 | * |
| Nathan Yonkee |
9:d58e77ebd769 | 202 | */ |
| Nathan Yonkee |
9:d58e77ebd769 | 203 | void irq_handler_asynch(void); |
| Nathan Yonkee |
9:d58e77ebd769 | 204 | |
| Nathan Yonkee |
9:d58e77ebd769 | 205 | /** Common transfer method |
| Nathan Yonkee |
9:d58e77ebd769 | 206 | * |
| Nathan Yonkee |
9:d58e77ebd769 | 207 | * @param tx_buffer The TX buffer with data to be transfered. If NULL is passed, |
| Nathan Yonkee |
9:d58e77ebd769 | 208 | * the default SPI value is sent |
| Nathan Yonkee |
9:d58e77ebd769 | 209 | * @param tx_length The length of TX buffer in bytes |
| Nathan Yonkee |
9:d58e77ebd769 | 210 | * @param rx_buffer The RX buffer which is used for received data. If NULL is passed, |
| Nathan Yonkee |
9:d58e77ebd769 | 211 | * received data are ignored |
| Nathan Yonkee |
9:d58e77ebd769 | 212 | * @param rx_length The length of RX buffer in bytes |
| Nathan Yonkee |
9:d58e77ebd769 | 213 | * @param bit_width The buffers element width |
| Nathan Yonkee |
9:d58e77ebd769 | 214 | * @param callback The event callback function |
| Nathan Yonkee |
9:d58e77ebd769 | 215 | * @param event The logical OR of events to modify |
| Nathan Yonkee |
9:d58e77ebd769 | 216 | * @return Zero if the transfer has started or was added to the queue, or -1 if SPI peripheral is busy/buffer is full |
| Nathan Yonkee |
9:d58e77ebd769 | 217 | */ |
| Nathan Yonkee |
9:d58e77ebd769 | 218 | 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); |
| Nathan Yonkee |
9:d58e77ebd769 | 219 | |
| Nathan Yonkee |
9:d58e77ebd769 | 220 | /** |
| Nathan Yonkee |
9:d58e77ebd769 | 221 | * |
| Nathan Yonkee |
9:d58e77ebd769 | 222 | * @param tx_buffer The TX buffer with data to be transfered. If NULL is passed, |
| Nathan Yonkee |
9:d58e77ebd769 | 223 | * the default SPI value is sent |
| Nathan Yonkee |
9:d58e77ebd769 | 224 | * @param tx_length The length of TX buffer in bytes |
| Nathan Yonkee |
9:d58e77ebd769 | 225 | * @param rx_buffer The RX buffer which is used for received data. If NULL is passed, |
| Nathan Yonkee |
9:d58e77ebd769 | 226 | * received data are ignored |
| Nathan Yonkee |
9:d58e77ebd769 | 227 | * @param rx_length The length of RX buffer in bytes |
| Nathan Yonkee |
9:d58e77ebd769 | 228 | * @param bit_width The buffers element width |
| Nathan Yonkee |
9:d58e77ebd769 | 229 | * @param callback The event callback function |
| Nathan Yonkee |
9:d58e77ebd769 | 230 | * @param event The logical OR of events to modify |
| Nathan Yonkee |
9:d58e77ebd769 | 231 | * @return Zero if a transfer was added to the queue, or -1 if the queue is full |
| Nathan Yonkee |
9:d58e77ebd769 | 232 | */ |
| Nathan Yonkee |
9:d58e77ebd769 | 233 | 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); |
| Nathan Yonkee |
9:d58e77ebd769 | 234 | |
| Nathan Yonkee |
9:d58e77ebd769 | 235 | /** Configures a callback, spi peripheral and initiate a new transfer |
| Nathan Yonkee |
9:d58e77ebd769 | 236 | * |
| Nathan Yonkee |
9:d58e77ebd769 | 237 | * @param tx_buffer The TX buffer with data to be transfered. If NULL is passed, |
| Nathan Yonkee |
9:d58e77ebd769 | 238 | * the default SPI value is sent |
| Nathan Yonkee |
9:d58e77ebd769 | 239 | * @param tx_length The length of TX buffer in bytes |
| Nathan Yonkee |
9:d58e77ebd769 | 240 | * @param rx_buffer The RX buffer which is used for received data. If NULL is passed, |
| Nathan Yonkee |
9:d58e77ebd769 | 241 | * received data are ignored |
| Nathan Yonkee |
9:d58e77ebd769 | 242 | * @param rx_length The length of RX buffer in bytes |
| Nathan Yonkee |
9:d58e77ebd769 | 243 | * @param bit_width The buffers element width |
| Nathan Yonkee |
9:d58e77ebd769 | 244 | * @param callback The event callback function |
| Nathan Yonkee |
9:d58e77ebd769 | 245 | * @param event The logical OR of events to modify |
| Nathan Yonkee |
9:d58e77ebd769 | 246 | */ |
| Nathan Yonkee |
9:d58e77ebd769 | 247 | 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); |
| Nathan Yonkee |
9:d58e77ebd769 | 248 | |
| Nathan Yonkee |
9:d58e77ebd769 | 249 | private: |
| Nathan Yonkee |
9:d58e77ebd769 | 250 | /** Lock deep sleep only if it is not yet locked */ |
| Nathan Yonkee |
9:d58e77ebd769 | 251 | void lock_deep_sleep(); |
| Nathan Yonkee |
9:d58e77ebd769 | 252 | |
| Nathan Yonkee |
9:d58e77ebd769 | 253 | /** Unlock deep sleep in case it is locked */ |
| Nathan Yonkee |
9:d58e77ebd769 | 254 | void unlock_deep_sleep(); |
| Nathan Yonkee |
9:d58e77ebd769 | 255 | |
| Nathan Yonkee |
9:d58e77ebd769 | 256 | |
| Nathan Yonkee |
9:d58e77ebd769 | 257 | #if TRANSACTION_QUEUE_SIZE_SPI |
| Nathan Yonkee |
9:d58e77ebd769 | 258 | |
| Nathan Yonkee |
9:d58e77ebd769 | 259 | /** Start a new transaction |
| Nathan Yonkee |
9:d58e77ebd769 | 260 | * |
| Nathan Yonkee |
9:d58e77ebd769 | 261 | * @param data Transaction data |
| Nathan Yonkee |
9:d58e77ebd769 | 262 | */ |
| Nathan Yonkee |
9:d58e77ebd769 | 263 | void start_transaction(transaction_t *data); |
| Nathan Yonkee |
9:d58e77ebd769 | 264 | |
| Nathan Yonkee |
9:d58e77ebd769 | 265 | /** Dequeue a transaction |
| Nathan Yonkee |
9:d58e77ebd769 | 266 | * |
| Nathan Yonkee |
9:d58e77ebd769 | 267 | */ |
| Nathan Yonkee |
9:d58e77ebd769 | 268 | void dequeue_transaction(); |
| Nathan Yonkee |
9:d58e77ebd769 | 269 | static CircularBuffer<Transaction<SPI>, TRANSACTION_QUEUE_SIZE_SPI> _transaction_buffer; |
| Nathan Yonkee |
9:d58e77ebd769 | 270 | #endif |
| Nathan Yonkee |
9:d58e77ebd769 | 271 | |
| Nathan Yonkee |
9:d58e77ebd769 | 272 | #endif |
| Nathan Yonkee |
9:d58e77ebd769 | 273 | |
| Nathan Yonkee |
9:d58e77ebd769 | 274 | public: |
| Nathan Yonkee |
9:d58e77ebd769 | 275 | virtual ~SPI() { |
| Nathan Yonkee |
9:d58e77ebd769 | 276 | } |
| Nathan Yonkee |
9:d58e77ebd769 | 277 | |
| Nathan Yonkee |
9:d58e77ebd769 | 278 | protected: |
| Nathan Yonkee |
9:d58e77ebd769 | 279 | spi_t _spi; |
| Nathan Yonkee |
9:d58e77ebd769 | 280 | |
| Nathan Yonkee |
9:d58e77ebd769 | 281 | #if DEVICE_SPI_ASYNCH |
| Nathan Yonkee |
9:d58e77ebd769 | 282 | CThunk<SPI> _irq; |
| Nathan Yonkee |
9:d58e77ebd769 | 283 | event_callback_t _callback; |
| Nathan Yonkee |
9:d58e77ebd769 | 284 | DMAUsage _usage; |
| Nathan Yonkee |
9:d58e77ebd769 | 285 | bool _deep_sleep_locked; |
| Nathan Yonkee |
9:d58e77ebd769 | 286 | #endif |
| Nathan Yonkee |
9:d58e77ebd769 | 287 | |
| Nathan Yonkee |
9:d58e77ebd769 | 288 | void aquire(void); |
| Nathan Yonkee |
9:d58e77ebd769 | 289 | static SPI *_owner; |
| Nathan Yonkee |
9:d58e77ebd769 | 290 | static SingletonPtr<PlatformMutex> _mutex; |
| Nathan Yonkee |
9:d58e77ebd769 | 291 | int _bits; |
| Nathan Yonkee |
9:d58e77ebd769 | 292 | int _mode; |
| Nathan Yonkee |
9:d58e77ebd769 | 293 | int _hz; |
| Nathan Yonkee |
9:d58e77ebd769 | 294 | char _write_fill; |
| Nathan Yonkee |
9:d58e77ebd769 | 295 | |
| Nathan Yonkee |
9:d58e77ebd769 | 296 | private: |
| Nathan Yonkee |
9:d58e77ebd769 | 297 | /* Private acquire function without locking/unlocking |
| Nathan Yonkee |
9:d58e77ebd769 | 298 | * Implemented in order to avoid duplicate locking and boost performance |
| Nathan Yonkee |
9:d58e77ebd769 | 299 | */ |
| Nathan Yonkee |
9:d58e77ebd769 | 300 | void _acquire(void); |
| Nathan Yonkee |
9:d58e77ebd769 | 301 | }; |
| Nathan Yonkee |
9:d58e77ebd769 | 302 | |
| Nathan Yonkee |
9:d58e77ebd769 | 303 | } // namespace mbed |
| Nathan Yonkee |
9:d58e77ebd769 | 304 | |
| Nathan Yonkee |
9:d58e77ebd769 | 305 | #endif |
| Nathan Yonkee |
9:d58e77ebd769 | 306 | |
| Nathan Yonkee |
9:d58e77ebd769 | 307 | #endif |