Mark Turner / mbed

mbed library for slider v2

Dependents:   kl46z_slider_v2

SPISlave.h@0:b7116bd48af6, 2016-09-14 (annotated)

Committer:
mturner5
Date:
Wed Sep 14 07:04:27 2016 +0000
Revision:
0:b7116bd48af6
Tried to use the timer.

Who changed what in which revision?

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