Gan likun / mbed1-dev

001

drivers/SPISlave.h@0:13413ea9a877, 2022-06-12 (annotated)

Committer:
ganlikun
Date:
Sun Jun 12 14:02:44 2022 +0000
Revision:
0:13413ea9a877
00

Who changed what in which revision?

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