TUKS MCU Introductory course / TUKS-COURSE-2-LED

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-dev/drivers/SPI.h@6:0018763974d3, 2017-02-25 (annotated)

Committer:
elmot
Date:
Sat Feb 25 08:59:21 2017 +0000
Revision:
6:0018763974d3
Parent:
1:d0dfbce63a89 
No comment

Who changed what in which revision?

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