mbed official / mbed-src

mbed library sources

Dependents:   Encrypted my_mbed lklk CyaSSL_DTLS_Cellular ... more

Superseded

This library was superseded by mbed-dev - https://os.mbed.com/users/mbed_official/code/mbed-dev/.

Development branch of the mbed library sources. This library is kept in synch with the latest changes from the mbed SDK and it is not guaranteed to work.

If you are looking for a stable and tested release, please import one of the official mbed library releases:

Import librarymbed

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

Last commit 20 Feb 2019 by mbed official

cpp/SPISlave.h@0:fd0d7bdfcdc2, 2012-11-20 (annotated)

Committer:
mbed_official
Date:
Tue Nov 20 17:24:08 2012 +0000
Revision:
0:fd0d7bdfcdc2
Child:
2:143cac498751
mbed sources

Who changed what in which revision?

UserRevisionLine numberNew contents of line
mbed_official 0:fd0d7bdfcdc2 1 /* mbed Microcontroller Library
mbed_official 0:fd0d7bdfcdc2 2 * Copyright (c) 2006-2012 ARM Limited
mbed_official 0:fd0d7bdfcdc2 3 *
mbed_official 0:fd0d7bdfcdc2 4 * Permission is hereby granted, free of charge, to any person obtaining a copy
mbed_official 0:fd0d7bdfcdc2 5 * of this software and associated documentation files (the "Software"), to deal
mbed_official 0:fd0d7bdfcdc2 6 * in the Software without restriction, including without limitation the rights
mbed_official 0:fd0d7bdfcdc2 7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
mbed_official 0:fd0d7bdfcdc2 8 * copies of the Software, and to permit persons to whom the Software is
mbed_official 0:fd0d7bdfcdc2 9 * furnished to do so, subject to the following conditions:
mbed_official 0:fd0d7bdfcdc2 10 *
mbed_official 0:fd0d7bdfcdc2 11 * The above copyright notice and this permission notice shall be included in
mbed_official 0:fd0d7bdfcdc2 12 * all copies or substantial portions of the Software.
mbed_official 0:fd0d7bdfcdc2 13 *
mbed_official 0:fd0d7bdfcdc2 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
mbed_official 0:fd0d7bdfcdc2 15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
mbed_official 0:fd0d7bdfcdc2 16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
mbed_official 0:fd0d7bdfcdc2 17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
mbed_official 0:fd0d7bdfcdc2 18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
mbed_official 0:fd0d7bdfcdc2 19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
mbed_official 0:fd0d7bdfcdc2 20 * SOFTWARE.
mbed_official 0:fd0d7bdfcdc2 21 */
mbed_official 0:fd0d7bdfcdc2 22 #ifndef MBED_SPISLAVE_H
mbed_official 0:fd0d7bdfcdc2 23 #define MBED_SPISLAVE_H
mbed_official 0:fd0d7bdfcdc2 24
mbed_official 0:fd0d7bdfcdc2 25 #include "platform.h"
mbed_official 0:fd0d7bdfcdc2 26
mbed_official 0:fd0d7bdfcdc2 27 #if DEVICE_SPISLAVE
mbed_official 0:fd0d7bdfcdc2 28
mbed_official 0:fd0d7bdfcdc2 29 #include "spi_api.h"
mbed_official 0:fd0d7bdfcdc2 30
mbed_official 0:fd0d7bdfcdc2 31 namespace mbed {
mbed_official 0:fd0d7bdfcdc2 32
mbed_official 0:fd0d7bdfcdc2 33 /** A SPI slave, used for communicating with a SPI Master device
mbed_official 0:fd0d7bdfcdc2 34 *
mbed_official 0:fd0d7bdfcdc2 35 * The default format is set to 8-bits, mode 0, and a clock frequency of 1MHz
mbed_official 0:fd0d7bdfcdc2 36 *
mbed_official 0:fd0d7bdfcdc2 37 * Example:
mbed_official 0:fd0d7bdfcdc2 38 * @code
mbed_official 0:fd0d7bdfcdc2 39 * // Reply to a SPI master as slave
mbed_official 0:fd0d7bdfcdc2 40 *
mbed_official 0:fd0d7bdfcdc2 41 * #include "mbed.h"
mbed_official 0:fd0d7bdfcdc2 42 *
mbed_official 0:fd0d7bdfcdc2 43 * SPISlave device(p5, p6, p7, p8); // mosi, miso, sclk, ssel
mbed_official 0:fd0d7bdfcdc2 44 *
mbed_official 0:fd0d7bdfcdc2 45 * int main() {
mbed_official 0:fd0d7bdfcdc2 46 * device.reply(0x00); // Prime SPI with first reply
mbed_official 0:fd0d7bdfcdc2 47 * while(1) {
mbed_official 0:fd0d7bdfcdc2 48 * if(device.receive()) {
mbed_official 0:fd0d7bdfcdc2 49 * int v = device.read(); // Read byte from master
mbed_official 0:fd0d7bdfcdc2 50 * v = (v + 1) % 0x100; // Add one to it, modulo 256
mbed_official 0:fd0d7bdfcdc2 51 * device.reply(v); // Make this the next reply
mbed_official 0:fd0d7bdfcdc2 52 * }
mbed_official 0:fd0d7bdfcdc2 53 * }
mbed_official 0:fd0d7bdfcdc2 54 * }
mbed_official 0:fd0d7bdfcdc2 55 * @endcode
mbed_official 0:fd0d7bdfcdc2 56 */
mbed_official 0:fd0d7bdfcdc2 57 class SPISlave {
mbed_official 0:fd0d7bdfcdc2 58
mbed_official 0:fd0d7bdfcdc2 59 public:
mbed_official 0:fd0d7bdfcdc2 60
mbed_official 0:fd0d7bdfcdc2 61 /** Create a SPI slave connected to the specified pins
mbed_official 0:fd0d7bdfcdc2 62 *
mbed_official 0:fd0d7bdfcdc2 63 * Pin Options:
mbed_official 0:fd0d7bdfcdc2 64 * (5, 6, 7i, 8) or (11, 12, 13, 14)
mbed_official 0:fd0d7bdfcdc2 65 *
mbed_official 0:fd0d7bdfcdc2 66 * mosi or miso can be specfied as NC if not used
mbed_official 0:fd0d7bdfcdc2 67 *
mbed_official 0:fd0d7bdfcdc2 68 * @param mosi SPI Master Out, Slave In pin
mbed_official 0:fd0d7bdfcdc2 69 * @param miso SPI Master In, Slave Out pin
mbed_official 0:fd0d7bdfcdc2 70 * @param sclk SPI Clock pin
mbed_official 0:fd0d7bdfcdc2 71 * @param ssel SPI chip select pin
mbed_official 0:fd0d7bdfcdc2 72 * @param name (optional) A string to identify the object
mbed_official 0:fd0d7bdfcdc2 73 */
mbed_official 0:fd0d7bdfcdc2 74 SPISlave(PinName mosi, PinName miso, PinName sclk, PinName ssel);
mbed_official 0:fd0d7bdfcdc2 75
mbed_official 0:fd0d7bdfcdc2 76 /** Configure the data transmission format
mbed_official 0:fd0d7bdfcdc2 77 *
mbed_official 0:fd0d7bdfcdc2 78 * @param bits Number of bits per SPI frame (4 - 16)
mbed_official 0:fd0d7bdfcdc2 79 * @param mode Clock polarity and phase mode (0 - 3)
mbed_official 0:fd0d7bdfcdc2 80 *
mbed_official 0:fd0d7bdfcdc2 81 * @code
mbed_official 0:fd0d7bdfcdc2 82 * mode | POL PHA
mbed_official 0:fd0d7bdfcdc2 83 * -----+--------
mbed_official 0:fd0d7bdfcdc2 84 * 0 | 0 0
mbed_official 0:fd0d7bdfcdc2 85 * 1 | 0 1
mbed_official 0:fd0d7bdfcdc2 86 * 2 | 1 0
mbed_official 0:fd0d7bdfcdc2 87 * 3 | 1 1
mbed_official 0:fd0d7bdfcdc2 88 * @endcode
mbed_official 0:fd0d7bdfcdc2 89 */
mbed_official 0:fd0d7bdfcdc2 90 void format(int bits, int mode = 0);
mbed_official 0:fd0d7bdfcdc2 91
mbed_official 0:fd0d7bdfcdc2 92 /** Set the spi bus clock frequency
mbed_official 0:fd0d7bdfcdc2 93 *
mbed_official 0:fd0d7bdfcdc2 94 * @param hz SCLK frequency in hz (default = 1MHz)
mbed_official 0:fd0d7bdfcdc2 95 */
mbed_official 0:fd0d7bdfcdc2 96 void frequency(int hz = 1000000);
mbed_official 0:fd0d7bdfcdc2 97
mbed_official 0:fd0d7bdfcdc2 98 /** Polls the SPI to see if data has been received
mbed_official 0:fd0d7bdfcdc2 99 *
mbed_official 0:fd0d7bdfcdc2 100 * @returns
mbed_official 0:fd0d7bdfcdc2 101 * 0 if no data,
mbed_official 0:fd0d7bdfcdc2 102 * 1 otherwise
mbed_official 0:fd0d7bdfcdc2 103 */
mbed_official 0:fd0d7bdfcdc2 104 int receive(void);
mbed_official 0:fd0d7bdfcdc2 105
mbed_official 0:fd0d7bdfcdc2 106 /** Retrieve data from receive buffer as slave
mbed_official 0:fd0d7bdfcdc2 107 *
mbed_official 0:fd0d7bdfcdc2 108 * @returns
mbed_official 0:fd0d7bdfcdc2 109 * the data in the receive buffer
mbed_official 0:fd0d7bdfcdc2 110 */
mbed_official 0:fd0d7bdfcdc2 111 int read(void);
mbed_official 0:fd0d7bdfcdc2 112
mbed_official 0:fd0d7bdfcdc2 113 /** Fill the transmission buffer with the value to be written out
mbed_official 0:fd0d7bdfcdc2 114 * as slave on the next received message from the master.
mbed_official 0:fd0d7bdfcdc2 115 *
mbed_official 0:fd0d7bdfcdc2 116 * @param value the data to be transmitted next
mbed_official 0:fd0d7bdfcdc2 117 */
mbed_official 0:fd0d7bdfcdc2 118 void reply(int value);
mbed_official 0:fd0d7bdfcdc2 119
mbed_official 0:fd0d7bdfcdc2 120 protected:
mbed_official 0:fd0d7bdfcdc2 121 spi_t _spi;
mbed_official 0:fd0d7bdfcdc2 122
mbed_official 0:fd0d7bdfcdc2 123 int _bits;
mbed_official 0:fd0d7bdfcdc2 124 int _mode;
mbed_official 0:fd0d7bdfcdc2 125 int _hz;
mbed_official 0:fd0d7bdfcdc2 126 };
mbed_official 0:fd0d7bdfcdc2 127
mbed_official 0:fd0d7bdfcdc2 128 } // namespace mbed
mbed_official 0:fd0d7bdfcdc2 129
mbed_official 0:fd0d7bdfcdc2 130 #endif
mbed_official 0:fd0d7bdfcdc2 131
mbed_official 0:fd0d7bdfcdc2 132 #endif