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@172:65be27845400, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 20:53:29 2019 +0000
Revision:
172:65be27845400
Parent:
171:3a7713b1edbc 
mbed library release version 165

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 172:65be27845400 3 * SPDX-License-Identifier: Apache-2.0
AnnaBridge 156:ff21514d8981 4 *
AnnaBridge 156:ff21514d8981 5 * Licensed under the Apache License, Version 2.0 (the "License");
AnnaBridge 156:ff21514d8981 6 * you may not use this file except in compliance with the License.
AnnaBridge 156:ff21514d8981 7 * You may obtain a copy of the License at
AnnaBridge 156:ff21514d8981 8 *
AnnaBridge 156:ff21514d8981 9 * http://www.apache.org/licenses/LICENSE-2.0
AnnaBridge 156:ff21514d8981 10 *
AnnaBridge 156:ff21514d8981 11 * Unless required by applicable law or agreed to in writing, software
AnnaBridge 156:ff21514d8981 12 * distributed under the License is distributed on an "AS IS" BASIS,
AnnaBridge 156:ff21514d8981 13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
AnnaBridge 156:ff21514d8981 14 * See the License for the specific language governing permissions and
AnnaBridge 156:ff21514d8981 15 * limitations under the License.
AnnaBridge 156:ff21514d8981 16 */
AnnaBridge 156:ff21514d8981 17 #ifndef MBED_SPISLAVE_H
AnnaBridge 156:ff21514d8981 18 #define MBED_SPISLAVE_H
AnnaBridge 156:ff21514d8981 19
AnnaBridge 156:ff21514d8981 20 #include "platform/platform.h"
AnnaBridge 156:ff21514d8981 21 #include "platform/NonCopyable.h"
AnnaBridge 156:ff21514d8981 22
AnnaBridge 172:65be27845400 23 #if DEVICE_SPISLAVE || defined(DOXYGEN_ONLY)
AnnaBridge 156:ff21514d8981 24
AnnaBridge 156:ff21514d8981 25 #include "hal/spi_api.h"
AnnaBridge 156:ff21514d8981 26
AnnaBridge 156:ff21514d8981 27 namespace mbed {
AnnaBridge 156:ff21514d8981 28 /** \addtogroup drivers */
AnnaBridge 156:ff21514d8981 29
AnnaBridge 171:3a7713b1edbc 30 /** A SPI slave, used for communicating with a SPI master device.
AnnaBridge 156:ff21514d8981 31 *
AnnaBridge 171:3a7713b1edbc 32 * The default format is set to 8 bits, mode 0 and a clock frequency of 1MHz.
AnnaBridge 156:ff21514d8981 33 *
AnnaBridge 156:ff21514d8981 34 * @note Synchronization level: Not protected
AnnaBridge 156:ff21514d8981 35 *
AnnaBridge 171:3a7713b1edbc 36 * Example of how to reply to a SPI master as slave:
AnnaBridge 156:ff21514d8981 37 * @code
AnnaBridge 156:ff21514d8981 38 *
AnnaBridge 156:ff21514d8981 39 * #include "mbed.h"
AnnaBridge 156:ff21514d8981 40 *
AnnaBridge 171:3a7713b1edbc 41 * SPISlave device(SPI_MOSI, SPI_MISO, SPI_SCLK, SPI_CS);
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 171:3a7713b1edbc 60 /** Create a SPI slave connected to the specified pins.
AnnaBridge 156:ff21514d8981 61 *
AnnaBridge 171:3a7713b1edbc 62 * @note Either mosi or miso can be specified as NC if not used.
AnnaBridge 156:ff21514d8981 63 *
AnnaBridge 171:3a7713b1edbc 64 * @param mosi SPI Master Out, Slave In pin.
AnnaBridge 171:3a7713b1edbc 65 * @param miso SPI Master In, Slave Out pin.
AnnaBridge 171:3a7713b1edbc 66 * @param sclk SPI Clock pin.
AnnaBridge 171:3a7713b1edbc 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 171:3a7713b1edbc 71 /** Configure the data transmission format.
AnnaBridge 156:ff21514d8981 72 *
AnnaBridge 171:3a7713b1edbc 73 * @param bits Number of bits per SPI frame (4 - 16).
AnnaBridge 171:3a7713b1edbc 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 171:3a7713b1edbc 87 /** Set the SPI bus clock frequency.
AnnaBridge 156:ff21514d8981 88 *
AnnaBridge 171:3a7713b1edbc 89 * @param hz Clock frequency in hz (default = 1MHz).
AnnaBridge 156:ff21514d8981 90 */
AnnaBridge 156:ff21514d8981 91 void frequency(int hz = 1000000);
AnnaBridge 156:ff21514d8981 92
AnnaBridge 171:3a7713b1edbc 93 /** Polls the SPI to see if data has been received.
AnnaBridge 156:ff21514d8981 94 *
AnnaBridge 171:3a7713b1edbc 95 * @return Presence of received data.
AnnaBridge 171:3a7713b1edbc 96 * @retval 0 No data waiting.
AnnaBridge 171:3a7713b1edbc 97 * @retval 1 Data waiting.
AnnaBridge 156:ff21514d8981 98 */
AnnaBridge 156:ff21514d8981 99 int receive(void);
AnnaBridge 156:ff21514d8981 100
AnnaBridge 171:3a7713b1edbc 101 /** Retrieve data from receive buffer as slave.
AnnaBridge 156:ff21514d8981 102 *
AnnaBridge 171:3a7713b1edbc 103 * @return The data in the receive buffer.
AnnaBridge 156:ff21514d8981 104 */
AnnaBridge 156:ff21514d8981 105 int read(void);
AnnaBridge 156:ff21514d8981 106
AnnaBridge 156:ff21514d8981 107 /** Fill the transmission buffer with the value to be written out
AnnaBridge 156:ff21514d8981 108 * as slave on the next received message from the master.
AnnaBridge 156:ff21514d8981 109 *
AnnaBridge 171:3a7713b1edbc 110 * @param value The data to be transmitted next.
AnnaBridge 156:ff21514d8981 111 */
AnnaBridge 156:ff21514d8981 112 void reply(int value);
AnnaBridge 156:ff21514d8981 113
AnnaBridge 171:3a7713b1edbc 114 #if !defined(DOXYGEN_ONLY)
AnnaBridge 171:3a7713b1edbc 115
AnnaBridge 156:ff21514d8981 116 protected:
AnnaBridge 171:3a7713b1edbc 117 /* Internal SPI object identifying the resources */
AnnaBridge 156:ff21514d8981 118 spi_t _spi;
AnnaBridge 156:ff21514d8981 119
AnnaBridge 171:3a7713b1edbc 120 /* How many bits in an SPI frame */
AnnaBridge 156:ff21514d8981 121 int _bits;
AnnaBridge 171:3a7713b1edbc 122 /* Clock phase and polarity */
AnnaBridge 156:ff21514d8981 123 int _mode;
AnnaBridge 171:3a7713b1edbc 124 /* Clock frequency */
AnnaBridge 156:ff21514d8981 125 int _hz;
AnnaBridge 171:3a7713b1edbc 126
AnnaBridge 171:3a7713b1edbc 127 #endif //!defined(DOXYGEN_ONLY)
AnnaBridge 156:ff21514d8981 128 };
AnnaBridge 156:ff21514d8981 129
AnnaBridge 156:ff21514d8981 130 } // namespace mbed
AnnaBridge 156:ff21514d8981 131
AnnaBridge 156:ff21514d8981 132 #endif
AnnaBridge 156:ff21514d8981 133
AnnaBridge 156:ff21514d8981 134 #endif