RYUICHI NAKAYAMA / mbed-dev

OK

Fork of mbed-dev by mbed official

api/SPISlave.h@0:9b334a45a8ff, 2015-10-01 (annotated)

Committer:
bogdanm
Date:
Thu Oct 01 15:25:22 2015 +0300
Revision:
0:9b334a45a8ff
Initial commit on mbed-dev



Replaces mbed-src (now inactive)

Who changed what in which revision?

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