Mihail Stoyanov / mbed

Fork of the official mbed C/C++ SDK provides the software platform and libraries to build your applications. The fork has the documentation converted to Doxygen format

Dependents:   NervousPuppySprintOne NervousPuppySprint2602 Robot WarehouseBot1 ... more

Fork of mbed by mbed official

SPISlave.h@43:aff670d0d510, 2012-10-24 (annotated)

Committer:
screamer
Date:
Wed Oct 24 10:44:49 2012 +0000
Revision:
43:aff670d0d510
Parent:
27:7110ebee3484 
Conversion of the classes documentation to Doxygen format

Who changed what in which revision?

UserRevisionLine numberNew contents of line
emilmont 27:7110ebee3484 1 /* mbed Microcontroller Library - SPISlave
emilmont 27:7110ebee3484 2 * Copyright (c) 2010-2011 ARM Limited. All rights reserved.
simon 20:029aa53d7323 3 */
simon 20:029aa53d7323 4
simon 20:029aa53d7323 5 #ifndef MBED_SPISLAVE_H
simon 20:029aa53d7323 6 #define MBED_SPISLAVE_H
simon 20:029aa53d7323 7
emilmont 27:7110ebee3484 8 #include "device.h"
emilmont 27:7110ebee3484 9
emilmont 27:7110ebee3484 10 #if DEVICE_SPISLAVE
emilmont 27:7110ebee3484 11
simon 20:029aa53d7323 12 #include "platform.h"
simon 20:029aa53d7323 13 #include "PinNames.h"
simon 20:029aa53d7323 14 #include "PeripheralNames.h"
simon 20:029aa53d7323 15 #include "Base.h"
simon 20:029aa53d7323 16
simon 20:029aa53d7323 17 namespace mbed {
simon 20:029aa53d7323 18
screamer 43:aff670d0d510 19 /** A SPI slave, used for communicating with a SPI Master device
simon 20:029aa53d7323 20 *
screamer 43:aff670d0d510 21 * The default format is set to 8-bits, mode 0, and a clock frequency of 1MHz
simon 20:029aa53d7323 22 *
simon 20:029aa53d7323 23 * Example:
screamer 43:aff670d0d510 24 * @code
screamer 43:aff670d0d510 25 * // Reply to a SPI master as slave
screamer 43:aff670d0d510 26 *
screamer 43:aff670d0d510 27 * #include "mbed.h"
screamer 43:aff670d0d510 28 *
screamer 43:aff670d0d510 29 * SPISlave device(p5, p6, p7, p8); // mosi, miso, sclk, ssel
screamer 43:aff670d0d510 30 *
screamer 43:aff670d0d510 31 * int main() {
screamer 43:aff670d0d510 32 * device.reply(0x00); // Prime SPI with first reply
screamer 43:aff670d0d510 33 * while(1) {
screamer 43:aff670d0d510 34 * if(device.receive()) {
screamer 43:aff670d0d510 35 * int v = device.read(); // Read byte from master
screamer 43:aff670d0d510 36 * v = (v + 1) % 0x100; // Add one to it, modulo 256
screamer 43:aff670d0d510 37 * device.reply(v); // Make this the next reply
screamer 43:aff670d0d510 38 * }
screamer 43:aff670d0d510 39 * }
screamer 43:aff670d0d510 40 * }
screamer 43:aff670d0d510 41 * @endcode
simon 20:029aa53d7323 42 */
simon 20:029aa53d7323 43 class SPISlave : public Base {
simon 20:029aa53d7323 44
simon 20:029aa53d7323 45 public:
simon 20:029aa53d7323 46
screamer 43:aff670d0d510 47 /** Create a SPI slave connected to the specified pins
simon 20:029aa53d7323 48 *
screamer 43:aff670d0d510 49 * Pin Options:
simon 20:029aa53d7323 50 * (5, 6, 7i, 8) or (11, 12, 13, 14)
simon 20:029aa53d7323 51 *
simon 20:029aa53d7323 52 * mosi or miso can be specfied as NC if not used
screamer 43:aff670d0d510 53 *
screamer 43:aff670d0d510 54 * @param mosi SPI Master Out, Slave In pin
screamer 43:aff670d0d510 55 * @param miso SPI Master In, Slave Out pin
screamer 43:aff670d0d510 56 * @param sclk SPI Clock pin
screamer 43:aff670d0d510 57 * @param ssel SPI chip select pin
screamer 43:aff670d0d510 58 * @param name (optional) A string to identify the object
simon 20:029aa53d7323 59 */
simon 20:029aa53d7323 60 SPISlave(PinName mosi, PinName miso, PinName sclk, PinName ssel,
simon 20:029aa53d7323 61 const char *name = NULL);
simon 20:029aa53d7323 62
screamer 43:aff670d0d510 63 /** Configure the data transmission format
simon 20:029aa53d7323 64 *
screamer 43:aff670d0d510 65 * @param bits Number of bits per SPI frame (4 - 16)
screamer 43:aff670d0d510 66 * @param mode Clock polarity and phase mode (0 - 3)
simon 20:029aa53d7323 67 *
screamer 43:aff670d0d510 68 * @code
screamer 43:aff670d0d510 69 * mode | POL PHA
screamer 43:aff670d0d510 70 * -----+--------
screamer 43:aff670d0d510 71 * 0 | 0 0
screamer 43:aff670d0d510 72 * 1 | 0 1
screamer 43:aff670d0d510 73 * 2 | 1 0
screamer 43:aff670d0d510 74 * 3 | 1 1
screamer 43:aff670d0d510 75 * @endcode
simon 20:029aa53d7323 76 */
simon 20:029aa53d7323 77 void format(int bits, int mode = 0);
simon 20:029aa53d7323 78
screamer 43:aff670d0d510 79 /** Set the spi bus clock frequency
simon 20:029aa53d7323 80 *
screamer 43:aff670d0d510 81 * @param hz SCLK frequency in hz (default = 1MHz)
simon 20:029aa53d7323 82 */
simon 20:029aa53d7323 83 void frequency(int hz = 1000000);
simon 20:029aa53d7323 84
screamer 43:aff670d0d510 85 /** Polls the SPI to see if data has been received
simon 20:029aa53d7323 86 *
screamer 43:aff670d0d510 87 * @returns
screamer 43:aff670d0d510 88 * 0 if no data,
screamer 43:aff670d0d510 89 * 1 otherwise
simon 20:029aa53d7323 90 */
simon 20:029aa53d7323 91 int receive(void);
simon 20:029aa53d7323 92
screamer 43:aff670d0d510 93 /** Retrieve data from receive buffer as slave
simon 20:029aa53d7323 94 *
screamer 43:aff670d0d510 95 * @returns
screamer 43:aff670d0d510 96 * the data in the receive buffer
simon 20:029aa53d7323 97 */
simon 20:029aa53d7323 98 int read(void);
simon 20:029aa53d7323 99
screamer 43:aff670d0d510 100 /** Fill the transmission buffer with the value to be written out
simon 20:029aa53d7323 101 * as slave on the next received message from the master.
simon 20:029aa53d7323 102 *
screamer 43:aff670d0d510 103 * @param value the data to be transmitted next
simon 20:029aa53d7323 104 */
simon 20:029aa53d7323 105 void reply(int value);
simon 20:029aa53d7323 106
simon 20:029aa53d7323 107 protected:
simon 20:029aa53d7323 108
screamer 43:aff670d0d510 109 SPIName _spi;
screamer 43:aff670d0d510 110
simon 20:029aa53d7323 111 int _bits;
simon 20:029aa53d7323 112 int _mode;
simon 20:029aa53d7323 113 int _hz;
simon 20:029aa53d7323 114
simon 20:029aa53d7323 115 };
simon 20:029aa53d7323 116
simon 20:029aa53d7323 117 } // namespace mbed
simon 20:029aa53d7323 118
simon 20:029aa53d7323 119 #endif
emilmont 27:7110ebee3484 120
emilmont 27:7110ebee3484 121 #endif