Matthew Sims / mbed

Lab 1 Program C

Dependents:   Lab1C

Fork of mbed by -deleted-

SPISlave.h@27:7110ebee3484, 2011-11-29 (annotated)

Committer:
emilmont
Date:
Tue Nov 29 14:59:27 2011 +0000
Revision:
27:7110ebee3484
Parent:
20:029aa53d7323
Child:
43:aff670d0d510
New Libraries 11.11

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