Matthew Sims / mbed

Lab 1 Program C

Dependents:   Lab1C

Fork of mbed by -deleted-

SPISlave.h@20:029aa53d7323, 2010-06-03 (annotated)

Committer:
simon
Date:
Thu Jun 03 11:17:50 2010 +0000
Revision:
20:029aa53d7323
Child:
27:7110ebee3484
* Add SPISlave, SPIHalfDuplex, SerialHalfDuplex

 * Add I2C repeated start

 * Add ethernet set_link()

 * Add documentation for wait()

Who changed what in which revision?

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