Mohamed Moawya / SnakeGame

test test test

Dependencies:   mbed

snake-test/mbed/drivers/SPI.h@0:e4c5e6ec922e, 2020-05-25 (annotated)

Committer:
mohamedmoawya
Date:
Mon May 25 19:06:11 2020 +0000
Revision:
0:e4c5e6ec922e
snake game tteest

Who changed what in which revision?

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