Emilio Monti / mbed-KL25Z

mbed libraries for KL25Z

Dependents:   FRDM_RGBLED

SPI.h@2:e9a661555b58, 2012-10-10 (annotated)

Committer:
emilmont
Date:
Wed Oct 10 14:14:12 2012 +0000
Revision:
2:e9a661555b58
Parent:
0:8024c367e29f
Child:
8:c14af7958ef5
Add PWM and I2C implementation;

Who changed what in which revision?

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