Yihui Xiong / Mbed 2 deprecated Seeed_nRF51822_Motion

initial

Dependencies:   mbed

mbed-src/api/SPISlave.h@0:638edba3adf6, 2016-01-11 (annotated)

Committer:
yihui
Date:
Mon Jan 11 02:32:24 2016 +0000
Revision:
0:638edba3adf6
initial

Who changed what in which revision?

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