Knight KE / Mbed OS Game_Master

游戏王对战板，目前code还是空的

mbed-os/drivers/SPI.h@0:9b3d4731edbb, 2018-06-21 (annotated)

Committer:
WFKnight
Date:
Thu Jun 21 13:51:43 2018 +0000
Revision:
0:9b3d4731edbb
UART, RTOS, LED

Who changed what in which revision?

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