Knight KE / Mbed OS Game_Master

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

mbed-os/drivers/SPISlave.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-2013 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_SPISLAVE_H
WFKnight 0:9b3d4731edbb 17 #define MBED_SPISLAVE_H
WFKnight 0:9b3d4731edbb 18
WFKnight 0:9b3d4731edbb 19 #include "platform/platform.h"
WFKnight 0:9b3d4731edbb 20 #include "platform/NonCopyable.h"
WFKnight 0:9b3d4731edbb 21
WFKnight 0:9b3d4731edbb 22 #if defined (DEVICE_SPISLAVE) || defined(DOXYGEN_ONLY)
WFKnight 0:9b3d4731edbb 23
WFKnight 0:9b3d4731edbb 24 #include "hal/spi_api.h"
WFKnight 0:9b3d4731edbb 25
WFKnight 0:9b3d4731edbb 26 namespace mbed {
WFKnight 0:9b3d4731edbb 27 /** \addtogroup drivers */
WFKnight 0:9b3d4731edbb 28
WFKnight 0:9b3d4731edbb 29 /** A SPI slave, used for communicating with a SPI Master device
WFKnight 0:9b3d4731edbb 30 *
WFKnight 0:9b3d4731edbb 31 * The default format is set to 8-bits, mode 0, and a clock frequency of 1MHz
WFKnight 0:9b3d4731edbb 32 *
WFKnight 0:9b3d4731edbb 33 * @note Synchronization level: Not protected
WFKnight 0:9b3d4731edbb 34 *
WFKnight 0:9b3d4731edbb 35 * Example:
WFKnight 0:9b3d4731edbb 36 * @code
WFKnight 0:9b3d4731edbb 37 * // Reply to a SPI master as slave
WFKnight 0:9b3d4731edbb 38 *
WFKnight 0:9b3d4731edbb 39 * #include "mbed.h"
WFKnight 0:9b3d4731edbb 40 *
WFKnight 0:9b3d4731edbb 41 * SPISlave device(p5, p6, p7, p8); // mosi, miso, sclk, ssel
WFKnight 0:9b3d4731edbb 42 *
WFKnight 0:9b3d4731edbb 43 * int main() {
WFKnight 0:9b3d4731edbb 44 * device.reply(0x00); // Prime SPI with first reply
WFKnight 0:9b3d4731edbb 45 * while(1) {
WFKnight 0:9b3d4731edbb 46 * if(device.receive()) {
WFKnight 0:9b3d4731edbb 47 * int v = device.read(); // Read byte from master
WFKnight 0:9b3d4731edbb 48 * v = (v + 1) % 0x100; // Add one to it, modulo 256
WFKnight 0:9b3d4731edbb 49 * device.reply(v); // Make this the next reply
WFKnight 0:9b3d4731edbb 50 * }
WFKnight 0:9b3d4731edbb 51 * }
WFKnight 0:9b3d4731edbb 52 * }
WFKnight 0:9b3d4731edbb 53 * @endcode
WFKnight 0:9b3d4731edbb 54 * @ingroup drivers
WFKnight 0:9b3d4731edbb 55 */
WFKnight 0:9b3d4731edbb 56 class SPISlave : private NonCopyable<SPISlave> {
WFKnight 0:9b3d4731edbb 57
WFKnight 0:9b3d4731edbb 58 public:
WFKnight 0:9b3d4731edbb 59
WFKnight 0:9b3d4731edbb 60 /** Create a SPI slave connected to the specified pins
WFKnight 0:9b3d4731edbb 61 *
WFKnight 0:9b3d4731edbb 62 * mosi or miso can be specified as NC if not used
WFKnight 0:9b3d4731edbb 63 *
WFKnight 0:9b3d4731edbb 64 * @param mosi SPI Master Out, Slave In pin
WFKnight 0:9b3d4731edbb 65 * @param miso SPI Master In, Slave Out pin
WFKnight 0:9b3d4731edbb 66 * @param sclk SPI Clock pin
WFKnight 0:9b3d4731edbb 67 * @param ssel SPI chip select pin
WFKnight 0:9b3d4731edbb 68 */
WFKnight 0:9b3d4731edbb 69 SPISlave(PinName mosi, PinName miso, PinName sclk, PinName ssel);
WFKnight 0:9b3d4731edbb 70
WFKnight 0:9b3d4731edbb 71 /** Configure the data transmission format
WFKnight 0:9b3d4731edbb 72 *
WFKnight 0:9b3d4731edbb 73 * @param bits Number of bits per SPI frame (4 - 16)
WFKnight 0:9b3d4731edbb 74 * @param mode Clock polarity and phase mode (0 - 3)
WFKnight 0:9b3d4731edbb 75 *
WFKnight 0:9b3d4731edbb 76 * @code
WFKnight 0:9b3d4731edbb 77 * mode | POL PHA
WFKnight 0:9b3d4731edbb 78 * -----+--------
WFKnight 0:9b3d4731edbb 79 * 0 | 0 0
WFKnight 0:9b3d4731edbb 80 * 1 | 0 1
WFKnight 0:9b3d4731edbb 81 * 2 | 1 0
WFKnight 0:9b3d4731edbb 82 * 3 | 1 1
WFKnight 0:9b3d4731edbb 83 * @endcode
WFKnight 0:9b3d4731edbb 84 */
WFKnight 0:9b3d4731edbb 85 void format(int bits, int mode = 0);
WFKnight 0:9b3d4731edbb 86
WFKnight 0:9b3d4731edbb 87 /** Set the spi bus clock frequency
WFKnight 0:9b3d4731edbb 88 *
WFKnight 0:9b3d4731edbb 89 * @param hz SCLK frequency in hz (default = 1MHz)
WFKnight 0:9b3d4731edbb 90 */
WFKnight 0:9b3d4731edbb 91 void frequency(int hz = 1000000);
WFKnight 0:9b3d4731edbb 92
WFKnight 0:9b3d4731edbb 93 /** Polls the SPI to see if data has been received
WFKnight 0:9b3d4731edbb 94 *
WFKnight 0:9b3d4731edbb 95 * @returns
WFKnight 0:9b3d4731edbb 96 * 0 if no data,
WFKnight 0:9b3d4731edbb 97 * 1 otherwise
WFKnight 0:9b3d4731edbb 98 */
WFKnight 0:9b3d4731edbb 99 int receive(void);
WFKnight 0:9b3d4731edbb 100
WFKnight 0:9b3d4731edbb 101 /** Retrieve data from receive buffer as slave
WFKnight 0:9b3d4731edbb 102 *
WFKnight 0:9b3d4731edbb 103 * @returns
WFKnight 0:9b3d4731edbb 104 * the data in the receive buffer
WFKnight 0:9b3d4731edbb 105 */
WFKnight 0:9b3d4731edbb 106 int read(void);
WFKnight 0:9b3d4731edbb 107
WFKnight 0:9b3d4731edbb 108 /** Fill the transmission buffer with the value to be written out
WFKnight 0:9b3d4731edbb 109 * as slave on the next received message from the master.
WFKnight 0:9b3d4731edbb 110 *
WFKnight 0:9b3d4731edbb 111 * @param value the data to be transmitted next
WFKnight 0:9b3d4731edbb 112 */
WFKnight 0:9b3d4731edbb 113 void reply(int value);
WFKnight 0:9b3d4731edbb 114
WFKnight 0:9b3d4731edbb 115 protected:
WFKnight 0:9b3d4731edbb 116 spi_t _spi;
WFKnight 0:9b3d4731edbb 117
WFKnight 0:9b3d4731edbb 118 int _bits;
WFKnight 0:9b3d4731edbb 119 int _mode;
WFKnight 0:9b3d4731edbb 120 int _hz;
WFKnight 0:9b3d4731edbb 121 };
WFKnight 0:9b3d4731edbb 122
WFKnight 0:9b3d4731edbb 123 } // namespace mbed
WFKnight 0:9b3d4731edbb 124
WFKnight 0:9b3d4731edbb 125 #endif
WFKnight 0:9b3d4731edbb 126
WFKnight 0:9b3d4731edbb 127 #endif