Mihail Stoyanov / mbed

Fork of the official mbed C/C++ SDK provides the software platform and libraries to build your applications. The fork has the documentation converted to Doxygen format

Dependents:   NervousPuppySprintOne NervousPuppySprint2602 Robot WarehouseBot1 ... more

Fork of mbed by mbed official

SPI.h@5:62573be585e9, 2009-01-22 (annotated)

Committer:
simon.ford@mbed.co.uk
Date:
Thu Jan 22 18:32:40 2009 +0000
Revision:
5:62573be585e9
Parent:
4:5d1359a283bc
Child:
11:1c1ebd0324fa
* Added initial RPC release

 * Added RTC and helper functions

 * Added read_u16()/write_u16() to AnalogIn/Out

 * Ticker/Timeout timing fixed!

 * mbedinfo() helper added

 * error() and printf() added to replace DEBUG() and ERROR()

 * DigitalIn supports methods on rise/fall

 * SPI and Serial support NC

 * LED1-4 also map to 1-4

 * Timer object reset fixed

 * SPI uses single mode

 * SPI3 added

Who changed what in which revision?

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