mbed official / mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

drivers/SPISlave.h@169:a7c7b631e539, 2018-06-22 (annotated)

Committer:
Anna Bridge
Date:
Fri Jun 22 15:38:59 2018 +0100
Revision:
169:a7c7b631e539
Parent:
165:d1b4690b3f8b
Child:
171:3a7713b1edbc
mbed library. Release version 162

Who changed what in which revision?

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