Matthew Sims / mbed

Lab 1 Program C

Dependents:   Lab1C

Fork of mbed by -deleted-

SPIHalfDuplex.h@43:aff670d0d510, 2012-10-24 (annotated)

Committer:
screamer
Date:
Wed Oct 24 10:44:49 2012 +0000
Revision:
43:aff670d0d510
Parent:
30:3991a86798e3 
Conversion of the classes documentation to Doxygen format

Who changed what in which revision?

UserRevisionLine numberNew contents of line
emilmont 27:7110ebee3484 1 /* mbed Microcontroller Library - SPIHalfDuplex
emilmont 27:7110ebee3484 2 * Copyright (c) 2010-2011 ARM Limited. All rights reserved.
simon 20:029aa53d7323 3 */
simon 20:029aa53d7323 4
simon 20:029aa53d7323 5 #ifndef MBED_SPIHALFDUPLEX_H
simon 20:029aa53d7323 6 #define MBED_SPIHALFDUPLEX_H
simon 20:029aa53d7323 7
emilmont 27:7110ebee3484 8 #include "device.h"
emilmont 27:7110ebee3484 9
emilmont 30:3991a86798e3 10 #if DEVICE_SPI
emilmont 27:7110ebee3484 11
simon 20:029aa53d7323 12 #include "SPI.h"
simon 20:029aa53d7323 13
simon 20:029aa53d7323 14 namespace mbed {
simon 20:029aa53d7323 15
screamer 43:aff670d0d510 16 /** A SPI half-duplex master, used for communicating with SPI slave devices
screamer 43:aff670d0d510 17 * over a shared data line.
simon 20:029aa53d7323 18 *
screamer 43:aff670d0d510 19 * The default format is set to 8-bits for both master and slave, and a
screamer 43:aff670d0d510 20 * clock frequency of 1MHz
simon 20:029aa53d7323 21 *
screamer 43:aff670d0d510 22 * Most SPI devies will also require Chip Select and Reset signals. These
screamer 43:aff670d0d510 23 * can be controlled using <DigitalOut> pins.
simon 20:029aa53d7323 24 *
screamer 43:aff670d0d510 25 * Although this is for a shared data line, both MISO and MOSI are defined,
screamer 43:aff670d0d510 26 * and should be tied together externally to the mbed. This class handles
screamer 43:aff670d0d510 27 * the tri-stating of the MOSI pin.
simon 20:029aa53d7323 28 *
simon 20:029aa53d7323 29 * Example:
screamer 43:aff670d0d510 30 * @code
screamer 43:aff670d0d510 31 * // Send a byte to a SPI half-duplex slave, and record the response
screamer 43:aff670d0d510 32 *
screamer 43:aff670d0d510 33 * #include "mbed.h"
screamer 43:aff670d0d510 34 *
screamer 43:aff670d0d510 35 * SPIHalfDuplex device(p5, p6, p7) // mosi, miso, sclk
screamer 43:aff670d0d510 36 *
screamer 43:aff670d0d510 37 * int main() {
screamer 43:aff670d0d510 38 * int respone = device.write(0xAA);
screamer 43:aff670d0d510 39 * }
screamer 43:aff670d0d510 40 * @endcode
simon 20:029aa53d7323 41 */
simon 20:029aa53d7323 42
simon 20:029aa53d7323 43 class SPIHalfDuplex : public SPI {
simon 20:029aa53d7323 44
simon 20:029aa53d7323 45 public:
simon 20:029aa53d7323 46
screamer 43:aff670d0d510 47 /** Create a SPI half-duplex master connected to the specified pins
simon 20:029aa53d7323 48 *
screamer 43:aff670d0d510 49 * Pin Options:
screamer 43:aff670d0d510 50 * (5, 6, 7) or (11, 12, 13)
simon 20:029aa53d7323 51 *
simon 20:029aa53d7323 52 * mosi or miso can be specfied as NC if not used
screamer 43:aff670d0d510 53 *
screamer 43:aff670d0d510 54 * @param mosi SPI Master Out, Slave In pin
screamer 43:aff670d0d510 55 * @param miso SPI Master In, Slave Out pin
screamer 43:aff670d0d510 56 * @param sclk SPI Clock pin
screamer 43:aff670d0d510 57 * @param name (optional) A string to identify the object
simon 20:029aa53d7323 58 */
simon 20:029aa53d7323 59 SPIHalfDuplex(PinName mosi, PinName miso, PinName sclk,
simon 20:029aa53d7323 60 const char *name = NULL);
simon 20:029aa53d7323 61
simon 20:029aa53d7323 62 #if 0 // Inherited from SPI - documentation only
screamer 43:aff670d0d510 63 /** Configure the data transmission format
simon 20:029aa53d7323 64 *
screamer 43:aff670d0d510 65 * @param bits Number of bits per SPI frame (4 - 16)
screamer 43:aff670d0d510 66 * @param mode Clock polarity and phase mode (0 - 3)
simon 20:029aa53d7323 67 *
screamer 43:aff670d0d510 68 * @code
screamer 43:aff670d0d510 69 * mode | POL PHA
screamer 43:aff670d0d510 70 * -----+--------
screamer 43:aff670d0d510 71 * 0 | 0 0
screamer 43:aff670d0d510 72 * 1 | 0 1
screamer 43:aff670d0d510 73 * 2 | 1 0
screamer 43:aff670d0d510 74 * 3 | 1 1
screamer 43:aff670d0d510 75 * @endcode
simon 20:029aa53d7323 76 */
simon 20:029aa53d7323 77 void format(int bits, int mode = 0);
simon 20:029aa53d7323 78
screamer 43:aff670d0d510 79 /** Set the spi bus clock frequency
simon 20:029aa53d7323 80 *
screamer 43:aff670d0d510 81 * @param hz SCLK frequency in hz (default = 1MHz)
simon 20:029aa53d7323 82 */
simon 20:029aa53d7323 83 void frequency(int hz = 1000000);
simon 20:029aa53d7323 84 #endif
simon 20:029aa53d7323 85
screamer 43:aff670d0d510 86 /** Write to the SPI Slave and return the response
simon 20:029aa53d7323 87 *
screamer 43:aff670d0d510 88 * @param value Data to be sent to the SPI slave
screamer 43:aff670d0d510 89 *
screamer 43:aff670d0d510 90 * @returns
screamer 43:aff670d0d510 91 * Response from the SPI slave
simon 20:029aa53d7323 92 */
simon 20:029aa53d7323 93 virtual int write(int value);
simon 20:029aa53d7323 94
screamer 43:aff670d0d510 95 /** Set the number of databits expected from the slave, from 4-16
simon 20:029aa53d7323 96 *
screamer 43:aff670d0d510 97 * @param sbits Number of expected bits in the slave response
simon 20:029aa53d7323 98 */
simon 20:029aa53d7323 99 void slave_format(int sbits);
simon 20:029aa53d7323 100
simon 20:029aa53d7323 101 protected:
simon 20:029aa53d7323 102 PinName _mosi;
simon 20:029aa53d7323 103 PinName _miso;
simon 20:029aa53d7323 104 int _sbits;
simon 20:029aa53d7323 105
simon 20:029aa53d7323 106 }; // End of class
simon 20:029aa53d7323 107
simon 20:029aa53d7323 108 } // End of namespace mbed
simon 20:029aa53d7323 109
simon 20:029aa53d7323 110 #endif
emilmont 27:7110ebee3484 111
emilmont 27:7110ebee3484 112 #endif