Nathan Yonkee / Mbed 2 deprecated Nucleo_sinewave_output_copy

init

Dependencies:   mbed

mbed-os/drivers/SPISlave.h@10:46a4cf51ee38, 2018-03-02 (annotated)

Committer:
Nathan Yonkee
Date:
Fri Mar 02 07:16:49 2018 -0700
Revision:
10:46a4cf51ee38
Parent:
9:d58e77ebd769 
remove mbed-os

Who changed what in which revision?

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