Denislam Valeev / Mbed OS Nucleo_rtos_basic

1

mbed-os/drivers/SPI.h@0:e056ac8fecf8, 2018-03-13 (annotated)

Committer:
valeyev
Date:
Tue Mar 13 07:17:50 2018 +0000
Revision:
0:e056ac8fecf8
looking for...

Who changed what in which revision?

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