jesus antonio lopez / mbed

...

Dependents:   2doejemplo Labo_TRSE_Drone

Fork of mbed by mbed official

SPI.h@43:e2ed12d17f06, 2012-10-26 (annotated)

Committer:
emilmont
Date:
Fri Oct 26 17:40:46 2012 +0100
Revision:
43:e2ed12d17f06
Parent:
27:7110ebee3484
Child:
44:24d45a770a51
Update documentation

Who changed what in which revision?

UserRevisionLine numberNew contents of line
rolf.meyer@arm.com 11:1c1ebd0324fa 1 /* mbed Microcontroller Library - SPI
emilmont 27:7110ebee3484 2 * Copyright (c) 2010-2011 ARM Limited. All rights reserved.
rolf.meyer@arm.com 11:1c1ebd0324fa 3 */
rolf.meyer@arm.com 11:1c1ebd0324fa 4
rolf.meyer@arm.com 11:1c1ebd0324fa 5 #ifndef MBED_SPI_H
rolf.meyer@arm.com 11:1c1ebd0324fa 6 #define MBED_SPI_H
rolf.meyer@arm.com 11:1c1ebd0324fa 7
emilmont 27:7110ebee3484 8 #include "device.h"
emilmont 27:7110ebee3484 9
emilmont 27:7110ebee3484 10 #if DEVICE_SPI
emilmont 27:7110ebee3484 11
rolf.meyer@arm.com 11:1c1ebd0324fa 12 #include "platform.h"
rolf.meyer@arm.com 11:1c1ebd0324fa 13 #include "PinNames.h"
rolf.meyer@arm.com 11:1c1ebd0324fa 14 #include "PeripheralNames.h"
rolf.meyer@arm.com 11:1c1ebd0324fa 15 #include "Base.h"
rolf.meyer@arm.com 11:1c1ebd0324fa 16
rolf.meyer@arm.com 11:1c1ebd0324fa 17 namespace mbed {
rolf.meyer@arm.com 11:1c1ebd0324fa 18
emilmont 43:e2ed12d17f06 19 /** A SPI Master, used for communicating with SPI slave devices
rolf.meyer@arm.com 11:1c1ebd0324fa 20 *
emilmont 43:e2ed12d17f06 21 * The default format is set to 8-bits, mode 0, and a clock frequency of 1MHz
rolf.meyer@arm.com 11:1c1ebd0324fa 22 *
emilmont 43:e2ed12d17f06 23 * Most SPI devices will also require Chip Select and Reset signals. These
emilmont 43:e2ed12d17f06 24 * can be controlled using <DigitalOut> pins
rolf.meyer@arm.com 11:1c1ebd0324fa 25 *
rolf.meyer@arm.com 11:1c1ebd0324fa 26 * Example:
emilmont 43:e2ed12d17f06 27 * @code
emilmont 43:e2ed12d17f06 28 * // Send a byte to a SPI slave, and record the response
emilmont 43:e2ed12d17f06 29 *
emilmont 43:e2ed12d17f06 30 * #include "mbed.h"
emilmont 43:e2ed12d17f06 31 *
emilmont 43:e2ed12d17f06 32 * SPI device(p5, p6, p7); // mosi, miso, sclk
emilmont 43:e2ed12d17f06 33 *
emilmont 43:e2ed12d17f06 34 * int main() {
emilmont 43:e2ed12d17f06 35 * int response = device.write(0xFF);
emilmont 43:e2ed12d17f06 36 * }
emilmont 43:e2ed12d17f06 37 * @endcode
rolf.meyer@arm.com 11:1c1ebd0324fa 38 */
rolf.meyer@arm.com 11:1c1ebd0324fa 39 class SPI : public Base {
rolf.meyer@arm.com 11:1c1ebd0324fa 40
rolf.meyer@arm.com 11:1c1ebd0324fa 41 public:
rolf.meyer@arm.com 11:1c1ebd0324fa 42
emilmont 43:e2ed12d17f06 43 /** Create a SPI master connected to the specified pins
rolf.meyer@arm.com 11:1c1ebd0324fa 44 *
emilmont 43:e2ed12d17f06 45 * Pin Options:
emilmont 43:e2ed12d17f06 46 * (5, 6, 7) or (11, 12, 13)
rolf.meyer@arm.com 11:1c1ebd0324fa 47 *
simon 20:029aa53d7323 48 * mosi or miso can be specfied as NC if not used
emilmont 43:e2ed12d17f06 49 *
emilmont 43:e2ed12d17f06 50 * @param mosi SPI Master Out, Slave In pin
emilmont 43:e2ed12d17f06 51 * @param miso SPI Master In, Slave Out pin
emilmont 43:e2ed12d17f06 52 * @param sclk SPI Clock pin
emilmont 43:e2ed12d17f06 53 * @param name (optional) A string to identify the object
rolf.meyer@arm.com 11:1c1ebd0324fa 54 */
rolf.meyer@arm.com 11:1c1ebd0324fa 55 SPI(PinName mosi, PinName miso, PinName sclk, const char *name = NULL);
rolf.meyer@arm.com 11:1c1ebd0324fa 56
emilmont 43:e2ed12d17f06 57 /** Configure the data transmission format
rolf.meyer@arm.com 11:1c1ebd0324fa 58 *
emilmont 43:e2ed12d17f06 59 * @param bits Number of bits per SPI frame (4 - 16)
emilmont 43:e2ed12d17f06 60 * @param mode Clock polarity and phase mode (0 - 3)
rolf.meyer@arm.com 11:1c1ebd0324fa 61 *
emilmont 43:e2ed12d17f06 62 * @code
emilmont 43:e2ed12d17f06 63 * mode | POL PHA
emilmont 43:e2ed12d17f06 64 * -----+--------
emilmont 43:e2ed12d17f06 65 * 0 | 0 0
emilmont 43:e2ed12d17f06 66 * 1 | 0 1
emilmont 43:e2ed12d17f06 67 * 2 | 1 0
emilmont 43:e2ed12d17f06 68 * 3 | 1 1
emilmont 43:e2ed12d17f06 69 * @endcode
rolf.meyer@arm.com 11:1c1ebd0324fa 70 */
rolf.meyer@arm.com 11:1c1ebd0324fa 71 void format(int bits, int mode = 0);
rolf.meyer@arm.com 11:1c1ebd0324fa 72
emilmont 43:e2ed12d17f06 73 /** Set the spi bus clock frequency
rolf.meyer@arm.com 11:1c1ebd0324fa 74 *
emilmont 43:e2ed12d17f06 75 * @param hz SCLK frequency in hz (default = 1MHz)
rolf.meyer@arm.com 11:1c1ebd0324fa 76 */
rolf.meyer@arm.com 11:1c1ebd0324fa 77 void frequency(int hz = 1000000);
rolf.meyer@arm.com 11:1c1ebd0324fa 78
emilmont 43:e2ed12d17f06 79 /** Write to the SPI Slave and return the response
rolf.meyer@arm.com 11:1c1ebd0324fa 80 *
emilmont 43:e2ed12d17f06 81 * @param value Data to be sent to the SPI slave
emilmont 43:e2ed12d17f06 82 *
emilmont 43:e2ed12d17f06 83 * @returns
emilmont 43:e2ed12d17f06 84 * Response from the SPI slave
rolf.meyer@arm.com 11:1c1ebd0324fa 85 */
simon 20:029aa53d7323 86 virtual int write(int value);
simon 20:029aa53d7323 87
rolf.meyer@arm.com 11:1c1ebd0324fa 88
rolf.meyer@arm.com 11:1c1ebd0324fa 89 #ifdef MBED_RPC
rolf.meyer@arm.com 11:1c1ebd0324fa 90 virtual const struct rpc_method *get_rpc_methods();
rolf.meyer@arm.com 11:1c1ebd0324fa 91 static struct rpc_class *get_rpc_class();
rolf.meyer@arm.com 11:1c1ebd0324fa 92 #endif
rolf.meyer@arm.com 11:1c1ebd0324fa 93
rolf.meyer@arm.com 11:1c1ebd0324fa 94 protected:
rolf.meyer@arm.com 11:1c1ebd0324fa 95
emilmont 43:e2ed12d17f06 96 SPIName _spi;
emilmont 43:e2ed12d17f06 97
emilmont 43:e2ed12d17f06 98 void aquire(void);
rolf.meyer@arm.com 11:1c1ebd0324fa 99 static SPI *_owner;
rolf.meyer@arm.com 11:1c1ebd0324fa 100 int _bits;
rolf.meyer@arm.com 11:1c1ebd0324fa 101 int _mode;
rolf.meyer@arm.com 11:1c1ebd0324fa 102 int _hz;
rolf.meyer@arm.com 11:1c1ebd0324fa 103
rolf.meyer@arm.com 11:1c1ebd0324fa 104 };
rolf.meyer@arm.com 11:1c1ebd0324fa 105
rolf.meyer@arm.com 11:1c1ebd0324fa 106 } // namespace mbed
rolf.meyer@arm.com 11:1c1ebd0324fa 107
rolf.meyer@arm.com 11:1c1ebd0324fa 108 #endif
emilmont 27:7110ebee3484 109
emilmont 27:7110ebee3484 110 #endif