Gan likun / The prosthetic control

The prosthetic control（MIT）

drivers/SPISlave.h@0:20e0c61e0684, 2022-06-23 (annotated)

Committer:
ganlikun
Date:
Thu Jun 23 05:23:34 2022 +0000
Revision:
0:20e0c61e0684
01

Who changed what in which revision?

UserRevisionLine numberNew contents of line
ganlikun 0:20e0c61e0684 1 /* mbed Microcontroller Library
ganlikun 0:20e0c61e0684 2 * Copyright (c) 2006-2013 ARM Limited
ganlikun 0:20e0c61e0684 3 *
ganlikun 0:20e0c61e0684 4 * Licensed under the Apache License, Version 2.0 (the "License");
ganlikun 0:20e0c61e0684 5 * you may not use this file except in compliance with the License.
ganlikun 0:20e0c61e0684 6 * You may obtain a copy of the License at
ganlikun 0:20e0c61e0684 7 *
ganlikun 0:20e0c61e0684 8 * http://www.apache.org/licenses/LICENSE-2.0
ganlikun 0:20e0c61e0684 9 *
ganlikun 0:20e0c61e0684 10 * Unless required by applicable law or agreed to in writing, software
ganlikun 0:20e0c61e0684 11 * distributed under the License is distributed on an "AS IS" BASIS,
ganlikun 0:20e0c61e0684 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
ganlikun 0:20e0c61e0684 13 * See the License for the specific language governing permissions and
ganlikun 0:20e0c61e0684 14 * limitations under the License.
ganlikun 0:20e0c61e0684 15 */
ganlikun 0:20e0c61e0684 16 #ifndef MBED_SPISLAVE_H
ganlikun 0:20e0c61e0684 17 #define MBED_SPISLAVE_H
ganlikun 0:20e0c61e0684 18
ganlikun 0:20e0c61e0684 19 #include "platform/platform.h"
ganlikun 0:20e0c61e0684 20 #include "platform/NonCopyable.h"
ganlikun 0:20e0c61e0684 21
ganlikun 0:20e0c61e0684 22 #if defined (DEVICE_SPISLAVE) || defined(DOXYGEN_ONLY)
ganlikun 0:20e0c61e0684 23
ganlikun 0:20e0c61e0684 24 #include "hal/spi_api.h"
ganlikun 0:20e0c61e0684 25
ganlikun 0:20e0c61e0684 26 namespace mbed {
ganlikun 0:20e0c61e0684 27 /** \addtogroup drivers */
ganlikun 0:20e0c61e0684 28
ganlikun 0:20e0c61e0684 29 /** A SPI slave, used for communicating with a SPI Master device
ganlikun 0:20e0c61e0684 30 *
ganlikun 0:20e0c61e0684 31 * The default format is set to 8-bits, mode 0, and a clock frequency of 1MHz
ganlikun 0:20e0c61e0684 32 *
ganlikun 0:20e0c61e0684 33 * @note Synchronization level: Not protected
ganlikun 0:20e0c61e0684 34 *
ganlikun 0:20e0c61e0684 35 * Example:
ganlikun 0:20e0c61e0684 36 * @code
ganlikun 0:20e0c61e0684 37 * // Reply to a SPI master as slave
ganlikun 0:20e0c61e0684 38 *
ganlikun 0:20e0c61e0684 39 * #include "mbed.h"
ganlikun 0:20e0c61e0684 40 *
ganlikun 0:20e0c61e0684 41 * SPISlave device(p5, p6, p7, p8); // mosi, miso, sclk, ssel
ganlikun 0:20e0c61e0684 42 *
ganlikun 0:20e0c61e0684 43 * int main() {
ganlikun 0:20e0c61e0684 44 * device.reply(0x00); // Prime SPI with first reply
ganlikun 0:20e0c61e0684 45 * while(1) {
ganlikun 0:20e0c61e0684 46 * if(device.receive()) {
ganlikun 0:20e0c61e0684 47 * int v = device.read(); // Read byte from master
ganlikun 0:20e0c61e0684 48 * v = (v + 1) % 0x100; // Add one to it, modulo 256
ganlikun 0:20e0c61e0684 49 * device.reply(v); // Make this the next reply
ganlikun 0:20e0c61e0684 50 * }
ganlikun 0:20e0c61e0684 51 * }
ganlikun 0:20e0c61e0684 52 * }
ganlikun 0:20e0c61e0684 53 * @endcode
ganlikun 0:20e0c61e0684 54 * @ingroup drivers
ganlikun 0:20e0c61e0684 55 */
ganlikun 0:20e0c61e0684 56 class SPISlave : private NonCopyable<SPISlave> {
ganlikun 0:20e0c61e0684 57
ganlikun 0:20e0c61e0684 58 public:
ganlikun 0:20e0c61e0684 59
ganlikun 0:20e0c61e0684 60 /** Create a SPI slave connected to the specified pins
ganlikun 0:20e0c61e0684 61 *
ganlikun 0:20e0c61e0684 62 * mosi or miso can be specfied as NC if not used
ganlikun 0:20e0c61e0684 63 *
ganlikun 0:20e0c61e0684 64 * @param mosi SPI Master Out, Slave In pin
ganlikun 0:20e0c61e0684 65 * @param miso SPI Master In, Slave Out pin
ganlikun 0:20e0c61e0684 66 * @param sclk SPI Clock pin
ganlikun 0:20e0c61e0684 67 * @param ssel SPI chip select pin
ganlikun 0:20e0c61e0684 68 */
ganlikun 0:20e0c61e0684 69 SPISlave(PinName mosi, PinName miso, PinName sclk, PinName ssel);
ganlikun 0:20e0c61e0684 70
ganlikun 0:20e0c61e0684 71 /** Configure the data transmission format
ganlikun 0:20e0c61e0684 72 *
ganlikun 0:20e0c61e0684 73 * @param bits Number of bits per SPI frame (4 - 16)
ganlikun 0:20e0c61e0684 74 * @param mode Clock polarity and phase mode (0 - 3)
ganlikun 0:20e0c61e0684 75 *
ganlikun 0:20e0c61e0684 76 * @code
ganlikun 0:20e0c61e0684 77 * mode | POL PHA
ganlikun 0:20e0c61e0684 78 * -----+--------
ganlikun 0:20e0c61e0684 79 * 0 | 0 0
ganlikun 0:20e0c61e0684 80 * 1 | 0 1
ganlikun 0:20e0c61e0684 81 * 2 | 1 0
ganlikun 0:20e0c61e0684 82 * 3 | 1 1
ganlikun 0:20e0c61e0684 83 * @endcode
ganlikun 0:20e0c61e0684 84 */
ganlikun 0:20e0c61e0684 85 void format(int bits, int mode = 0);
ganlikun 0:20e0c61e0684 86
ganlikun 0:20e0c61e0684 87 /** Set the spi bus clock frequency
ganlikun 0:20e0c61e0684 88 *
ganlikun 0:20e0c61e0684 89 * @param hz SCLK frequency in hz (default = 1MHz)
ganlikun 0:20e0c61e0684 90 */
ganlikun 0:20e0c61e0684 91 void frequency(int hz = 1000000);
ganlikun 0:20e0c61e0684 92
ganlikun 0:20e0c61e0684 93 /** Polls the SPI to see if data has been received
ganlikun 0:20e0c61e0684 94 *
ganlikun 0:20e0c61e0684 95 * @returns
ganlikun 0:20e0c61e0684 96 * 0 if no data,
ganlikun 0:20e0c61e0684 97 * 1 otherwise
ganlikun 0:20e0c61e0684 98 */
ganlikun 0:20e0c61e0684 99 int receive(void);
ganlikun 0:20e0c61e0684 100
ganlikun 0:20e0c61e0684 101 /** Retrieve data from receive buffer as slave
ganlikun 0:20e0c61e0684 102 *
ganlikun 0:20e0c61e0684 103 * @returns
ganlikun 0:20e0c61e0684 104 * the data in the receive buffer
ganlikun 0:20e0c61e0684 105 */
ganlikun 0:20e0c61e0684 106 int read(void);
ganlikun 0:20e0c61e0684 107
ganlikun 0:20e0c61e0684 108 /** Fill the transmission buffer with the value to be written out
ganlikun 0:20e0c61e0684 109 * as slave on the next received message from the master.
ganlikun 0:20e0c61e0684 110 *
ganlikun 0:20e0c61e0684 111 * @param value the data to be transmitted next
ganlikun 0:20e0c61e0684 112 */
ganlikun 0:20e0c61e0684 113 void reply(int value);
ganlikun 0:20e0c61e0684 114
ganlikun 0:20e0c61e0684 115 protected:
ganlikun 0:20e0c61e0684 116 spi_t _spi;
ganlikun 0:20e0c61e0684 117
ganlikun 0:20e0c61e0684 118 int _bits;
ganlikun 0:20e0c61e0684 119 int _mode;
ganlikun 0:20e0c61e0684 120 int _hz;
ganlikun 0:20e0c61e0684 121 };
ganlikun 0:20e0c61e0684 122
ganlikun 0:20e0c61e0684 123 } // namespace mbed
ganlikun 0:20e0c61e0684 124
ganlikun 0:20e0c61e0684 125 #endif
ganlikun 0:20e0c61e0684 126
ganlikun 0:20e0c61e0684 127 #endif