PHung Tung / WAV2

SPKT

Dependencies:   F746_GUI SD_PlayerSkeleton F746_SAI_IO

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

Committer:
phungductung
Date:
Tue Jun 04 09:08:29 2019 +0000
Revision:
0:aa3fc5ad02f7
SPKT

Who changed what in which revision?

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