mbed libraries for KL25Z
Diff: SPI.h
- Revision:
- 8:c14af7958ef5
- Parent:
- 2:e9a661555b58
- Child:
- 9:663789d7729f
--- a/SPI.h Tue Oct 23 09:20:18 2012 +0000 +++ b/SPI.h Fri Nov 09 11:33:53 2012 +0000 @@ -1,23 +1,16 @@ /* mbed Microcontroller Library - SPI - * Copyright (c) 2010-2011 ARM Limited. All rights reserved. + * Copyright (c) 2010-2011 ARM Limited. All rights reserved. */ - #ifndef MBED_SPI_H #define MBED_SPI_H -#include "device.h" +#include "platform.h" #if DEVICE_SPI -#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 +/** 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 * @@ -25,85 +18,74 @@ * 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); - * > } + * @code + * // 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); + * } + * @endcode */ -class SPI : public Base { +class SPI { 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 + /** Create a SPI master connected to the specified pins * * Pin Options: * (5, 6, 7) or (11, 12, 13) * * mosi or miso can be specfied as NC if not used + * + * @param mosi SPI Master Out, Slave In pin + * @param miso SPI Master In, Slave Out pin + * @param sclk SPI Clock pin */ - SPI(PinName mosi, PinName miso, PinName sclk, const char *name = NULL); + SPI(PinName mosi, PinName miso, PinName sclk); - /* Function: format - * Configure the data transmission format + /** Configure the data transmission format * - * Variables: - * bits - Number of bits per SPI frame (4 - 16) - * mode - Clock polarity and phase mode (0 - 3) + * @param bits Number of bits per SPI frame (4 - 16) + * @param mode Clock polarity and phase mode (0 - 3) * - * > mode | POL PHA - * > -----+-------- - * > 0 | 0 0 - * > 1 | 0 1 - * > 2 | 1 0 - * > 3 | 1 1 + * @code + * mode | POL PHA + * -----+-------- + * 0 | 0 0 + * 1 | 0 1 + * 2 | 1 0 + * 3 | 1 1 + * @endcode */ void format(int bits, int mode = 0); - /* Function: frequency - * Set the spi bus clock frequency + /** Set the spi bus clock frequency * - * Variables: - * hz - SCLK frequency in hz (default = 1MHz) + * @param hz SCLK frequency in hz (default = 1MHz) */ void frequency(int hz = 1000000); - /* Function: write - * Write to the SPI Slave and return the response + /** 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 + * @param value Data to be sent to the SPI slave + * + * @returns + * Response from the SPI slave */ virtual 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(void); - static SPI *_owner; + static SPI *_owner; int _bits; int _mode; int _hz; - }; } // namespace mbed