Vladimir Vana / mbed

pro vyuku PSS v Jecne

SPISlave.h@0:23d1f73bf130, 2017-09-24 (annotated)

Committer:
vladvana
Date:
Sun Sep 24 12:31:52 2017 +0000
Revision:
0:23d1f73bf130
podklady pro cviceni z PSS

Who changed what in which revision?

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