BA / SerialCom

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.

Fork of OmniWheels by Gustav Atmel

mbed-os/drivers/SPI.cpp@2:798925c9e4a8, 2018-05-01 (annotated)

Committer:
gustavatmel
Date:
Tue May 01 15:55:34 2018 +0000
Revision:
2:798925c9e4a8
Parent:
1:9c5af431a1f1 
bluetooth

Who changed what in which revision?

UserRevisionLine numberNew contents of line
gustavatmel 1:9c5af431a1f1 1 /* mbed Microcontroller Library
gustavatmel 1:9c5af431a1f1 2 * Copyright (c) 2006-2013 ARM Limited
gustavatmel 1:9c5af431a1f1 3 *
gustavatmel 1:9c5af431a1f1 4 * Licensed under the Apache License, Version 2.0 (the "License");
gustavatmel 1:9c5af431a1f1 5 * you may not use this file except in compliance with the License.
gustavatmel 1:9c5af431a1f1 6 * You may obtain a copy of the License at
gustavatmel 1:9c5af431a1f1 7 *
gustavatmel 1:9c5af431a1f1 8 * http://www.apache.org/licenses/LICENSE-2.0
gustavatmel 1:9c5af431a1f1 9 *
gustavatmel 1:9c5af431a1f1 10 * Unless required by applicable law or agreed to in writing, software
gustavatmel 1:9c5af431a1f1 11 * distributed under the License is distributed on an "AS IS" BASIS,
gustavatmel 1:9c5af431a1f1 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
gustavatmel 1:9c5af431a1f1 13 * See the License for the specific language governing permissions and
gustavatmel 1:9c5af431a1f1 14 * limitations under the License.
gustavatmel 1:9c5af431a1f1 15 */
gustavatmel 1:9c5af431a1f1 16 #include "drivers/SPI.h"
gustavatmel 1:9c5af431a1f1 17 #include "platform/mbed_critical.h"
gustavatmel 1:9c5af431a1f1 18
gustavatmel 1:9c5af431a1f1 19 #if DEVICE_SPI_ASYNCH
gustavatmel 1:9c5af431a1f1 20 #include "platform/mbed_power_mgmt.h"
gustavatmel 1:9c5af431a1f1 21 #endif
gustavatmel 1:9c5af431a1f1 22
gustavatmel 1:9c5af431a1f1 23 #if DEVICE_SPI
gustavatmel 1:9c5af431a1f1 24
gustavatmel 1:9c5af431a1f1 25 namespace mbed {
gustavatmel 1:9c5af431a1f1 26
gustavatmel 1:9c5af431a1f1 27 #if DEVICE_SPI_ASYNCH && TRANSACTION_QUEUE_SIZE_SPI
gustavatmel 1:9c5af431a1f1 28 CircularBuffer<Transaction<SPI>, TRANSACTION_QUEUE_SIZE_SPI> SPI::_transaction_buffer;
gustavatmel 1:9c5af431a1f1 29 #endif
gustavatmel 1:9c5af431a1f1 30
gustavatmel 1:9c5af431a1f1 31 SPI::SPI(PinName mosi, PinName miso, PinName sclk, PinName ssel) :
gustavatmel 1:9c5af431a1f1 32 _spi(),
gustavatmel 1:9c5af431a1f1 33 #if DEVICE_SPI_ASYNCH
gustavatmel 1:9c5af431a1f1 34 _irq(this),
gustavatmel 1:9c5af431a1f1 35 _usage(DMA_USAGE_NEVER),
gustavatmel 1:9c5af431a1f1 36 _deep_sleep_locked(false),
gustavatmel 1:9c5af431a1f1 37 #endif
gustavatmel 1:9c5af431a1f1 38 _bits(8),
gustavatmel 1:9c5af431a1f1 39 _mode(0),
gustavatmel 1:9c5af431a1f1 40 _hz(1000000),
gustavatmel 1:9c5af431a1f1 41 _write_fill(SPI_FILL_CHAR) {
gustavatmel 1:9c5af431a1f1 42 // No lock needed in the constructor
gustavatmel 1:9c5af431a1f1 43
gustavatmel 1:9c5af431a1f1 44 spi_init(&_spi, mosi, miso, sclk, ssel);
gustavatmel 1:9c5af431a1f1 45 _acquire();
gustavatmel 1:9c5af431a1f1 46 }
gustavatmel 1:9c5af431a1f1 47
gustavatmel 1:9c5af431a1f1 48 void SPI::format(int bits, int mode) {
gustavatmel 1:9c5af431a1f1 49 lock();
gustavatmel 1:9c5af431a1f1 50 _bits = bits;
gustavatmel 1:9c5af431a1f1 51 _mode = mode;
gustavatmel 1:9c5af431a1f1 52 // If changing format while you are the owner then just
gustavatmel 1:9c5af431a1f1 53 // update format, but if owner is changed then even frequency should be
gustavatmel 1:9c5af431a1f1 54 // updated which is done by acquire.
gustavatmel 1:9c5af431a1f1 55 if (_owner == this) {
gustavatmel 1:9c5af431a1f1 56 spi_format(&_spi, _bits, _mode, 0);
gustavatmel 1:9c5af431a1f1 57 } else {
gustavatmel 1:9c5af431a1f1 58 _acquire();
gustavatmel 1:9c5af431a1f1 59 }
gustavatmel 1:9c5af431a1f1 60 unlock();
gustavatmel 1:9c5af431a1f1 61 }
gustavatmel 1:9c5af431a1f1 62
gustavatmel 1:9c5af431a1f1 63 void SPI::frequency(int hz) {
gustavatmel 1:9c5af431a1f1 64 lock();
gustavatmel 1:9c5af431a1f1 65 _hz = hz;
gustavatmel 1:9c5af431a1f1 66 // If changing format while you are the owner then just
gustavatmel 1:9c5af431a1f1 67 // update frequency, but if owner is changed then even frequency should be
gustavatmel 1:9c5af431a1f1 68 // updated which is done by acquire.
gustavatmel 1:9c5af431a1f1 69 if (_owner == this) {
gustavatmel 1:9c5af431a1f1 70 spi_frequency(&_spi, _hz);
gustavatmel 1:9c5af431a1f1 71 } else {
gustavatmel 1:9c5af431a1f1 72 _acquire();
gustavatmel 1:9c5af431a1f1 73 }
gustavatmel 1:9c5af431a1f1 74 unlock();
gustavatmel 1:9c5af431a1f1 75 }
gustavatmel 1:9c5af431a1f1 76
gustavatmel 1:9c5af431a1f1 77 SPI* SPI::_owner = NULL;
gustavatmel 1:9c5af431a1f1 78 SingletonPtr<PlatformMutex> SPI::_mutex;
gustavatmel 1:9c5af431a1f1 79
gustavatmel 1:9c5af431a1f1 80 // ignore the fact there are multiple physical spis, and always update if it wasn't us last
gustavatmel 1:9c5af431a1f1 81 void SPI::aquire() {
gustavatmel 1:9c5af431a1f1 82 lock();
gustavatmel 1:9c5af431a1f1 83 if (_owner != this) {
gustavatmel 1:9c5af431a1f1 84 spi_format(&_spi, _bits, _mode, 0);
gustavatmel 1:9c5af431a1f1 85 spi_frequency(&_spi, _hz);
gustavatmel 1:9c5af431a1f1 86 _owner = this;
gustavatmel 1:9c5af431a1f1 87 }
gustavatmel 1:9c5af431a1f1 88 unlock();
gustavatmel 1:9c5af431a1f1 89 }
gustavatmel 1:9c5af431a1f1 90
gustavatmel 1:9c5af431a1f1 91 // Note: Private function with no locking
gustavatmel 1:9c5af431a1f1 92 void SPI::_acquire() {
gustavatmel 1:9c5af431a1f1 93 if (_owner != this) {
gustavatmel 1:9c5af431a1f1 94 spi_format(&_spi, _bits, _mode, 0);
gustavatmel 1:9c5af431a1f1 95 spi_frequency(&_spi, _hz);
gustavatmel 1:9c5af431a1f1 96 _owner = this;
gustavatmel 1:9c5af431a1f1 97 }
gustavatmel 1:9c5af431a1f1 98 }
gustavatmel 1:9c5af431a1f1 99
gustavatmel 1:9c5af431a1f1 100 int SPI::write(int value) {
gustavatmel 1:9c5af431a1f1 101 lock();
gustavatmel 1:9c5af431a1f1 102 _acquire();
gustavatmel 1:9c5af431a1f1 103 int ret = spi_master_write(&_spi, value);
gustavatmel 1:9c5af431a1f1 104 unlock();
gustavatmel 1:9c5af431a1f1 105 return ret;
gustavatmel 1:9c5af431a1f1 106 }
gustavatmel 1:9c5af431a1f1 107
gustavatmel 1:9c5af431a1f1 108 int SPI::write(const char *tx_buffer, int tx_length, char *rx_buffer, int rx_length) {
gustavatmel 1:9c5af431a1f1 109 lock();
gustavatmel 1:9c5af431a1f1 110 _acquire();
gustavatmel 1:9c5af431a1f1 111 int ret = spi_master_block_write(&_spi, tx_buffer, tx_length, rx_buffer, rx_length, _write_fill);
gustavatmel 1:9c5af431a1f1 112 unlock();
gustavatmel 1:9c5af431a1f1 113 return ret;
gustavatmel 1:9c5af431a1f1 114 }
gustavatmel 1:9c5af431a1f1 115
gustavatmel 1:9c5af431a1f1 116 void SPI::lock() {
gustavatmel 1:9c5af431a1f1 117 _mutex->lock();
gustavatmel 1:9c5af431a1f1 118 }
gustavatmel 1:9c5af431a1f1 119
gustavatmel 1:9c5af431a1f1 120 void SPI::unlock() {
gustavatmel 1:9c5af431a1f1 121 _mutex->unlock();
gustavatmel 1:9c5af431a1f1 122 }
gustavatmel 1:9c5af431a1f1 123
gustavatmel 1:9c5af431a1f1 124 void SPI::set_default_write_value(char data) {
gustavatmel 1:9c5af431a1f1 125 lock();
gustavatmel 1:9c5af431a1f1 126 _write_fill = data;
gustavatmel 1:9c5af431a1f1 127 unlock();
gustavatmel 1:9c5af431a1f1 128 }
gustavatmel 1:9c5af431a1f1 129
gustavatmel 1:9c5af431a1f1 130 #if DEVICE_SPI_ASYNCH
gustavatmel 1:9c5af431a1f1 131
gustavatmel 1:9c5af431a1f1 132 int SPI::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)
gustavatmel 1:9c5af431a1f1 133 {
gustavatmel 1:9c5af431a1f1 134 if (spi_active(&_spi)) {
gustavatmel 1:9c5af431a1f1 135 return queue_transfer(tx_buffer, tx_length, rx_buffer, rx_length, bit_width, callback, event);
gustavatmel 1:9c5af431a1f1 136 }
gustavatmel 1:9c5af431a1f1 137 start_transfer(tx_buffer, tx_length, rx_buffer, rx_length, bit_width, callback, event);
gustavatmel 1:9c5af431a1f1 138 return 0;
gustavatmel 1:9c5af431a1f1 139 }
gustavatmel 1:9c5af431a1f1 140
gustavatmel 1:9c5af431a1f1 141 void SPI::abort_transfer()
gustavatmel 1:9c5af431a1f1 142 {
gustavatmel 1:9c5af431a1f1 143 spi_abort_asynch(&_spi);
gustavatmel 1:9c5af431a1f1 144 unlock_deep_sleep();
gustavatmel 1:9c5af431a1f1 145 #if TRANSACTION_QUEUE_SIZE_SPI
gustavatmel 1:9c5af431a1f1 146 dequeue_transaction();
gustavatmel 1:9c5af431a1f1 147 #endif
gustavatmel 1:9c5af431a1f1 148 }
gustavatmel 1:9c5af431a1f1 149
gustavatmel 1:9c5af431a1f1 150
gustavatmel 1:9c5af431a1f1 151 void SPI::clear_transfer_buffer()
gustavatmel 1:9c5af431a1f1 152 {
gustavatmel 1:9c5af431a1f1 153 #if TRANSACTION_QUEUE_SIZE_SPI
gustavatmel 1:9c5af431a1f1 154 _transaction_buffer.reset();
gustavatmel 1:9c5af431a1f1 155 #endif
gustavatmel 1:9c5af431a1f1 156 }
gustavatmel 1:9c5af431a1f1 157
gustavatmel 1:9c5af431a1f1 158 void SPI::abort_all_transfers()
gustavatmel 1:9c5af431a1f1 159 {
gustavatmel 1:9c5af431a1f1 160 clear_transfer_buffer();
gustavatmel 1:9c5af431a1f1 161 abort_transfer();
gustavatmel 1:9c5af431a1f1 162 }
gustavatmel 1:9c5af431a1f1 163
gustavatmel 1:9c5af431a1f1 164 int SPI::set_dma_usage(DMAUsage usage)
gustavatmel 1:9c5af431a1f1 165 {
gustavatmel 1:9c5af431a1f1 166 if (spi_active(&_spi)) {
gustavatmel 1:9c5af431a1f1 167 return -1;
gustavatmel 1:9c5af431a1f1 168 }
gustavatmel 1:9c5af431a1f1 169 _usage = usage;
gustavatmel 1:9c5af431a1f1 170 return 0;
gustavatmel 1:9c5af431a1f1 171 }
gustavatmel 1:9c5af431a1f1 172
gustavatmel 1:9c5af431a1f1 173 int SPI::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)
gustavatmel 1:9c5af431a1f1 174 {
gustavatmel 1:9c5af431a1f1 175 #if TRANSACTION_QUEUE_SIZE_SPI
gustavatmel 1:9c5af431a1f1 176 transaction_t t;
gustavatmel 1:9c5af431a1f1 177
gustavatmel 1:9c5af431a1f1 178 t.tx_buffer = const_cast<void *>(tx_buffer);
gustavatmel 1:9c5af431a1f1 179 t.tx_length = tx_length;
gustavatmel 1:9c5af431a1f1 180 t.rx_buffer = rx_buffer;
gustavatmel 1:9c5af431a1f1 181 t.rx_length = rx_length;
gustavatmel 1:9c5af431a1f1 182 t.event = event;
gustavatmel 1:9c5af431a1f1 183 t.callback = callback;
gustavatmel 1:9c5af431a1f1 184 t.width = bit_width;
gustavatmel 1:9c5af431a1f1 185 Transaction<SPI> transaction(this, t);
gustavatmel 1:9c5af431a1f1 186 if (_transaction_buffer.full()) {
gustavatmel 1:9c5af431a1f1 187 return -1; // the buffer is full
gustavatmel 1:9c5af431a1f1 188 } else {
gustavatmel 1:9c5af431a1f1 189 core_util_critical_section_enter();
gustavatmel 1:9c5af431a1f1 190 _transaction_buffer.push(transaction);
gustavatmel 1:9c5af431a1f1 191 if (!spi_active(&_spi)) {
gustavatmel 1:9c5af431a1f1 192 dequeue_transaction();
gustavatmel 1:9c5af431a1f1 193 }
gustavatmel 1:9c5af431a1f1 194 core_util_critical_section_exit();
gustavatmel 1:9c5af431a1f1 195 return 0;
gustavatmel 1:9c5af431a1f1 196 }
gustavatmel 1:9c5af431a1f1 197 #else
gustavatmel 1:9c5af431a1f1 198 return -1;
gustavatmel 1:9c5af431a1f1 199 #endif
gustavatmel 1:9c5af431a1f1 200 }
gustavatmel 1:9c5af431a1f1 201
gustavatmel 1:9c5af431a1f1 202 void SPI::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)
gustavatmel 1:9c5af431a1f1 203 {
gustavatmel 1:9c5af431a1f1 204 lock_deep_sleep();
gustavatmel 1:9c5af431a1f1 205 _acquire();
gustavatmel 1:9c5af431a1f1 206 _callback = callback;
gustavatmel 1:9c5af431a1f1 207 _irq.callback(&SPI::irq_handler_asynch);
gustavatmel 1:9c5af431a1f1 208 spi_master_transfer(&_spi, tx_buffer, tx_length, rx_buffer, rx_length, bit_width, _irq.entry(), event , _usage);
gustavatmel 1:9c5af431a1f1 209 }
gustavatmel 1:9c5af431a1f1 210
gustavatmel 1:9c5af431a1f1 211 void SPI::lock_deep_sleep()
gustavatmel 1:9c5af431a1f1 212 {
gustavatmel 1:9c5af431a1f1 213 if (_deep_sleep_locked == false) {
gustavatmel 1:9c5af431a1f1 214 sleep_manager_lock_deep_sleep();
gustavatmel 1:9c5af431a1f1 215 _deep_sleep_locked = true;
gustavatmel 1:9c5af431a1f1 216 }
gustavatmel 1:9c5af431a1f1 217 }
gustavatmel 1:9c5af431a1f1 218
gustavatmel 1:9c5af431a1f1 219 void SPI::unlock_deep_sleep()
gustavatmel 1:9c5af431a1f1 220 {
gustavatmel 1:9c5af431a1f1 221 if (_deep_sleep_locked == true) {
gustavatmel 1:9c5af431a1f1 222 sleep_manager_unlock_deep_sleep();
gustavatmel 1:9c5af431a1f1 223 _deep_sleep_locked = false;
gustavatmel 1:9c5af431a1f1 224 }
gustavatmel 1:9c5af431a1f1 225 }
gustavatmel 1:9c5af431a1f1 226
gustavatmel 1:9c5af431a1f1 227 #if TRANSACTION_QUEUE_SIZE_SPI
gustavatmel 1:9c5af431a1f1 228
gustavatmel 1:9c5af431a1f1 229 void SPI::start_transaction(transaction_t *data)
gustavatmel 1:9c5af431a1f1 230 {
gustavatmel 1:9c5af431a1f1 231 start_transfer(data->tx_buffer, data->tx_length, data->rx_buffer, data->rx_length, data->width, data->callback, data->event);
gustavatmel 1:9c5af431a1f1 232 }
gustavatmel 1:9c5af431a1f1 233
gustavatmel 1:9c5af431a1f1 234 void SPI::dequeue_transaction()
gustavatmel 1:9c5af431a1f1 235 {
gustavatmel 1:9c5af431a1f1 236 Transaction<SPI> t;
gustavatmel 1:9c5af431a1f1 237 if (_transaction_buffer.pop(t)) {
gustavatmel 1:9c5af431a1f1 238 SPI* obj = t.get_object();
gustavatmel 1:9c5af431a1f1 239 transaction_t* data = t.get_transaction();
gustavatmel 1:9c5af431a1f1 240 obj->start_transaction(data);
gustavatmel 1:9c5af431a1f1 241 }
gustavatmel 1:9c5af431a1f1 242 }
gustavatmel 1:9c5af431a1f1 243
gustavatmel 1:9c5af431a1f1 244 #endif
gustavatmel 1:9c5af431a1f1 245
gustavatmel 1:9c5af431a1f1 246 void SPI::irq_handler_asynch(void)
gustavatmel 1:9c5af431a1f1 247 {
gustavatmel 1:9c5af431a1f1 248 int event = spi_irq_handler_asynch(&_spi);
gustavatmel 1:9c5af431a1f1 249 if (_callback && (event & SPI_EVENT_ALL)) {
gustavatmel 1:9c5af431a1f1 250 unlock_deep_sleep();
gustavatmel 1:9c5af431a1f1 251 _callback.call(event & SPI_EVENT_ALL);
gustavatmel 1:9c5af431a1f1 252 }
gustavatmel 1:9c5af431a1f1 253 #if TRANSACTION_QUEUE_SIZE_SPI
gustavatmel 1:9c5af431a1f1 254 if (event & (SPI_EVENT_ALL | SPI_EVENT_INTERNAL_TRANSFER_COMPLETE)) {
gustavatmel 1:9c5af431a1f1 255 // SPI peripheral is free (event happened), dequeue transaction
gustavatmel 1:9c5af431a1f1 256 dequeue_transaction();
gustavatmel 1:9c5af431a1f1 257 }
gustavatmel 1:9c5af431a1f1 258 #endif
gustavatmel 1:9c5af431a1f1 259 }
gustavatmel 1:9c5af431a1f1 260
gustavatmel 1:9c5af431a1f1 261 #endif
gustavatmel 1:9c5af431a1f1 262
gustavatmel 1:9c5af431a1f1 263 } // namespace mbed
gustavatmel 1:9c5af431a1f1 264
gustavatmel 1:9c5af431a1f1 265 #endif