Sertel_Srinath Gopalan / USB_SERTEL_LOG

Soundharrajan

Fork of mbed by mbed official

SPI.h@92:f7fcbaa5f1b5, 2016-06-12 (annotated)

Committer:
mrsoundhar
Date:
Sun Jun 12 16:45:04 2016 +0000
Revision:
92:f7fcbaa5f1b5
Parent:
27:7110ebee3484
Child:
43:e2ed12d17f06
Soundharrajan

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