Vladimir Vana / mbed

pro vyuku PSS v Jecne

SPI.h@0:23d1f73bf130, 2017-09-24 (annotated)

Committer:
vladvana
Date:
Sun Sep 24 12:31:52 2017 +0000
Revision:
0:23d1f73bf130
podklady pro cviceni z PSS

Who changed what in which revision?

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