Emir Sokic / mbedPAI Featured

mbed.h verzija za koristenje na predmetu PAI

SPISlave.h@0:05aad811ea07, 2015-03-10 (annotated)

Committer:
esokic
Date:
Tue Mar 10 09:51:52 2015 +0000
Revision:
0:05aad811ea07
mbed.h verzija od marta 2014, za koristenje na predmetu PAI

Who changed what in which revision?

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