Emilio Monti / mbed-KL25Z

mbed libraries for KL25Z

Dependents:   FRDM_RGBLED

SPI.h@0:8024c367e29f, 2012-10-05 (annotated)

Committer:
emilmont
Date:
Fri Oct 05 09:16:41 2012 +0000
Revision:
0:8024c367e29f
Child:
2:e9a661555b58
First release of the mbed libraries for KL25Z

Who changed what in which revision?

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