Freeman Oldman / NUCLEO_STM32F401RE_CC3000_ILI9341

The code from https://github.com/vpcola/Nucleo

mbed-src/api/SPISlave.h@0:5464d5e415e5, 2014-10-08 (annotated)

Committer:
sinrab
Date:
Wed Oct 08 11:00:24 2014 +0000
Revision:
0:5464d5e415e5
The code from https://github.com/vpcola/Nucleo

Who changed what in which revision?

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