my fork
Fork of mbed by
Diff: SPI.h
- Revision:
- 11:1c1ebd0324fa
- Parent:
- 5:62573be585e9
- Child:
- 20:029aa53d7323
diff -r fcb9359f0959 -r 1c1ebd0324fa SPI.h --- a/SPI.h Thu May 14 14:44:00 2009 +0000 +++ b/SPI.h Fri Aug 28 12:10:11 2009 +0000 @@ -1,108 +1,107 @@ -/* mbed Microcontroller Library - SPI - * Copyright (c) 2006-2009 ARM Limited. All rights reserved. - * sford - */ - -#ifndef MBED_SPI_H -#define MBED_SPI_H - -#include "Base.h" -#include "LPC2300.h" - -namespace mbed { - -/* Class: SPI - * A SPI Master, used for communicating with SPI slave devices - * - * The default format is set to 8-bits, mode 0, and a clock frequency of 1MHz - * - * Most SPI devices will also require Chip Select and Reset signals. These - * can be controlled using <DigitalOut> pins - * - * Example: - * > // Send a byte to a SPI slave, and record the response - * > - * > #include "mbed.h" - * > - * > SPI device(5, 6, 7); // mosi, miso, sclk - * > - * > int main() { - * > int response = device.write(0xFF); - * > } - */ -class SPI : public Base { - -public: - - /* Constructor: SPI - * Create a SPI master connected to the specified pins - * - * Variables: - * mosi - SPI Master Out, Slave In pin - * miso - SPI Master In, Slave Out pin - * sclk - SPI Clock pin - * name - (optional) A string to identify the object - * - * Pin Options: - * (5, 6, 7) or (11, 12, 13) - * - * mosi and miso can each be specfied as NC (not connected) e.g. (5, NC, 7) - */ - SPI(int mosi, int miso, int sclk, const char *name = NULL); - - /* Function: format - * Configure the data transmission format - * - * Variables: - * bits - Number of bits per SPI frame (4 - 16) - * mode - Clock polarity and phase mode (0 - 3) - * - * > mode | POL PHA - * > -----+-------- - * > 0 | 0 0 - * > 1 | 0 1 - * > 2 | 1 0 - * > 3 | 1 1 - */ - void format(int bits, int mode = 0); - - // old one, to be removed over time... - void format(int bits, int polarity, int phase) __attribute__((deprecated)); - - /* Function: frequency - * Set the bus clock frequency - * - * Variables: - * hz - SCLK frequency in hz (default = 1MHz) - */ - void frequency(int hz = 1000000); - - /* Function: write - * Write to the SPI Slave and return the response - * - * Variables: - * value - Data to be sent to the SPI slave - * returns - Response from the SPI slave - */ - int write(int value); - - virtual const struct rpc_method *get_rpc_methods(); - static struct rpc_class *get_rpc_class(); - -protected: - - void configure(); - - int _id; - - int _uid; - static int _uidcounter; - - int _bits, _polarity, _phase, _hz; - static int _config[2]; -}; - -} - -#endif - +/* mbed Microcontroller Library - SPI + * Copyright (c) 2006-2009 ARM Limited. All rights reserved. + * sford + */ + +#ifndef MBED_SPI_H +#define MBED_SPI_H + +#include "platform.h" +#include "PinNames.h" +#include "PeripheralNames.h" +#include "Base.h" + +namespace mbed { + +/* Class: SPI + * A SPI Master, used for communicating with SPI slave devices + * + * The default format is set to 8-bits, mode 0, and a clock frequency of 1MHz + * + * Most SPI devices will also require Chip Select and Reset signals. These + * can be controlled using <DigitalOut> pins + * + * Example: + * > // Send a byte to a SPI slave, and record the response + * > + * > #include "mbed.h" + * > + * > SPI device(p5, p6, p7); // mosi, miso, sclk + * > + * > int main() { + * > int response = device.write(0xFF); + * > } + */ +class SPI : public Base { + +public: + + /* Constructor: SPI + * Create a SPI master connected to the specified pins + * + * Variables: + * mosi - SPI Master Out, Slave In pin + * miso - SPI Master In, Slave Out pin + * sclk - SPI Clock pin + * name - (optional) A string to identify the object + * + * Pin Options: + * (5, 6, 7) or (11, 12, 13) + * + * mosi or miso can be specfied as NOT_CONNECTED if not used + */ + SPI(PinName mosi, PinName miso, PinName sclk, const char *name = NULL); + + /* Function: format + * Configure the data transmission format + * + * Variables: + * bits - Number of bits per SPI frame (4 - 16) + * mode - Clock polarity and phase mode (0 - 3) + * + * > mode | POL PHA + * > -----+-------- + * > 0 | 0 0 + * > 1 | 0 1 + * > 2 | 1 0 + * > 3 | 1 1 + */ + void format(int bits, int mode = 0); + + /* Function: frequency + * Set the spi bus clock frequency + * + * Variables: + * hz - SCLK frequency in hz (default = 1MHz) + */ + void frequency(int hz = 1000000); + + /* Function: write + * Write to the SPI Slave and return the response + * + * Variables: + * value - Data to be sent to the SPI slave + * returns - Response from the SPI slave + */ + int write(int value); + +#ifdef MBED_RPC + virtual const struct rpc_method *get_rpc_methods(); + static struct rpc_class *get_rpc_class(); +#endif + +protected: + + SPIName _spi; + + void aquire(); + static SPI *_owner; + int _bits; + int _mode; + int _hz; + +}; + +} // namespace mbed + +#endif