PHung Tung / SRC_STM32F7

SPKT

Dependents:   WAV

api/SPI.h@0:e87aa4c49e95, 2019-06-04 (annotated)

Committer:
phungductung
Date:
Tue Jun 04 21:51:46 2019 +0000
Revision:
0:e87aa4c49e95
libray

Who changed what in which revision?

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