TUKS MCU Introductory course / TUKS-COURSE-TIMER

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

mbed-dev/drivers/SPISlave.h@1:d0dfbce63a89, 2017-02-24 (annotated)

Committer:
elmot
Date:
Fri Feb 24 21:13:56 2017 +0000
Revision:
1:d0dfbce63a89
Ready-to-copy

Who changed what in which revision?

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