Andrew SaLoutos / mbed-dev-STM-lean

From Ben Katz mbed-dev library. Removed unnecessary target files to reduce the overall size by a factor of 10 to make it easier to import into the online IDE.

Dependents:   motor_driver motor_driver_screaming_fix

drivers/SPISlave.h@0:083111ae2a11, 2020-11-26 (annotated)

Committer:
saloutos
Date:
Thu Nov 26 04:08:56 2020 +0000
Revision:
0:083111ae2a11
first commit of leaned mbed dev lib

Who changed what in which revision?

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