First Last / mbed-src

mbed library sources

Fork of mbed-src by mbed official

cpp/SPI.h@0:fd0d7bdfcdc2, 2012-11-20 (annotated)

Committer:
mbed_official
Date:
Tue Nov 20 17:24:08 2012 +0000
Revision:
0:fd0d7bdfcdc2
Child:
2:143cac498751
mbed sources

Who changed what in which revision?

UserRevisionLine numberNew contents of line
mbed_official 0:fd0d7bdfcdc2 1 /* mbed Microcontroller Library
mbed_official 0:fd0d7bdfcdc2 2 * Copyright (c) 2006-2012 ARM Limited
mbed_official 0:fd0d7bdfcdc2 3 *
mbed_official 0:fd0d7bdfcdc2 4 * Permission is hereby granted, free of charge, to any person obtaining a copy
mbed_official 0:fd0d7bdfcdc2 5 * of this software and associated documentation files (the "Software"), to deal
mbed_official 0:fd0d7bdfcdc2 6 * in the Software without restriction, including without limitation the rights
mbed_official 0:fd0d7bdfcdc2 7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
mbed_official 0:fd0d7bdfcdc2 8 * copies of the Software, and to permit persons to whom the Software is
mbed_official 0:fd0d7bdfcdc2 9 * furnished to do so, subject to the following conditions:
mbed_official 0:fd0d7bdfcdc2 10 *
mbed_official 0:fd0d7bdfcdc2 11 * The above copyright notice and this permission notice shall be included in
mbed_official 0:fd0d7bdfcdc2 12 * all copies or substantial portions of the Software.
mbed_official 0:fd0d7bdfcdc2 13 *
mbed_official 0:fd0d7bdfcdc2 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
mbed_official 0:fd0d7bdfcdc2 15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
mbed_official 0:fd0d7bdfcdc2 16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
mbed_official 0:fd0d7bdfcdc2 17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
mbed_official 0:fd0d7bdfcdc2 18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
mbed_official 0:fd0d7bdfcdc2 19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
mbed_official 0:fd0d7bdfcdc2 20 * SOFTWARE.
mbed_official 0:fd0d7bdfcdc2 21 */
mbed_official 0:fd0d7bdfcdc2 22 #ifndef MBED_SPI_H
mbed_official 0:fd0d7bdfcdc2 23 #define MBED_SPI_H
mbed_official 0:fd0d7bdfcdc2 24
mbed_official 0:fd0d7bdfcdc2 25 #include "platform.h"
mbed_official 0:fd0d7bdfcdc2 26
mbed_official 0:fd0d7bdfcdc2 27 #if DEVICE_SPI
mbed_official 0:fd0d7bdfcdc2 28
mbed_official 0:fd0d7bdfcdc2 29 #include "spi_api.h"
mbed_official 0:fd0d7bdfcdc2 30
mbed_official 0:fd0d7bdfcdc2 31 namespace mbed {
mbed_official 0:fd0d7bdfcdc2 32
mbed_official 0:fd0d7bdfcdc2 33 /** A SPI Master, used for communicating with SPI slave devices
mbed_official 0:fd0d7bdfcdc2 34 *
mbed_official 0:fd0d7bdfcdc2 35 * The default format is set to 8-bits, mode 0, and a clock frequency of 1MHz
mbed_official 0:fd0d7bdfcdc2 36 *
mbed_official 0:fd0d7bdfcdc2 37 * Most SPI devices will also require Chip Select and Reset signals. These
mbed_official 0:fd0d7bdfcdc2 38 * can be controlled using <DigitalOut> pins
mbed_official 0:fd0d7bdfcdc2 39 *
mbed_official 0:fd0d7bdfcdc2 40 * Example:
mbed_official 0:fd0d7bdfcdc2 41 * @code
mbed_official 0:fd0d7bdfcdc2 42 * // Send a byte to a SPI slave, and record the response
mbed_official 0:fd0d7bdfcdc2 43 *
mbed_official 0:fd0d7bdfcdc2 44 * #include "mbed.h"
mbed_official 0:fd0d7bdfcdc2 45 *
mbed_official 0:fd0d7bdfcdc2 46 * SPI device(p5, p6, p7); // mosi, miso, sclk
mbed_official 0:fd0d7bdfcdc2 47 *
mbed_official 0:fd0d7bdfcdc2 48 * int main() {
mbed_official 0:fd0d7bdfcdc2 49 * int response = device.write(0xFF);
mbed_official 0:fd0d7bdfcdc2 50 * }
mbed_official 0:fd0d7bdfcdc2 51 * @endcode
mbed_official 0:fd0d7bdfcdc2 52 */
mbed_official 0:fd0d7bdfcdc2 53 class SPI {
mbed_official 0:fd0d7bdfcdc2 54
mbed_official 0:fd0d7bdfcdc2 55 public:
mbed_official 0:fd0d7bdfcdc2 56
mbed_official 0:fd0d7bdfcdc2 57 /** Create a SPI master connected to the specified pins
mbed_official 0:fd0d7bdfcdc2 58 *
mbed_official 0:fd0d7bdfcdc2 59 * Pin Options:
mbed_official 0:fd0d7bdfcdc2 60 * (5, 6, 7) or (11, 12, 13)
mbed_official 0:fd0d7bdfcdc2 61 *
mbed_official 0:fd0d7bdfcdc2 62 * mosi or miso can be specfied as NC if not used
mbed_official 0:fd0d7bdfcdc2 63 *
mbed_official 0:fd0d7bdfcdc2 64 * @param mosi SPI Master Out, Slave In pin
mbed_official 0:fd0d7bdfcdc2 65 * @param miso SPI Master In, Slave Out pin
mbed_official 0:fd0d7bdfcdc2 66 * @param sclk SPI Clock pin
mbed_official 0:fd0d7bdfcdc2 67 */
mbed_official 0:fd0d7bdfcdc2 68 SPI(PinName mosi, PinName miso, PinName sclk);
mbed_official 0:fd0d7bdfcdc2 69
mbed_official 0:fd0d7bdfcdc2 70 /** Configure the data transmission format
mbed_official 0:fd0d7bdfcdc2 71 *
mbed_official 0:fd0d7bdfcdc2 72 * @param bits Number of bits per SPI frame (4 - 16)
mbed_official 0:fd0d7bdfcdc2 73 * @param mode Clock polarity and phase mode (0 - 3)
mbed_official 0:fd0d7bdfcdc2 74 *
mbed_official 0:fd0d7bdfcdc2 75 * @code
mbed_official 0:fd0d7bdfcdc2 76 * mode | POL PHA
mbed_official 0:fd0d7bdfcdc2 77 * -----+--------
mbed_official 0:fd0d7bdfcdc2 78 * 0 | 0 0
mbed_official 0:fd0d7bdfcdc2 79 * 1 | 0 1
mbed_official 0:fd0d7bdfcdc2 80 * 2 | 1 0
mbed_official 0:fd0d7bdfcdc2 81 * 3 | 1 1
mbed_official 0:fd0d7bdfcdc2 82 * @endcode
mbed_official 0:fd0d7bdfcdc2 83 */
mbed_official 0:fd0d7bdfcdc2 84 void format(int bits, int mode = 0);
mbed_official 0:fd0d7bdfcdc2 85
mbed_official 0:fd0d7bdfcdc2 86 /** Set the spi bus clock frequency
mbed_official 0:fd0d7bdfcdc2 87 *
mbed_official 0:fd0d7bdfcdc2 88 * @param hz SCLK frequency in hz (default = 1MHz)
mbed_official 0:fd0d7bdfcdc2 89 */
mbed_official 0:fd0d7bdfcdc2 90 void frequency(int hz = 1000000);
mbed_official 0:fd0d7bdfcdc2 91
mbed_official 0:fd0d7bdfcdc2 92 /** Write to the SPI Slave and return the response
mbed_official 0:fd0d7bdfcdc2 93 *
mbed_official 0:fd0d7bdfcdc2 94 * @param value Data to be sent to the SPI slave
mbed_official 0:fd0d7bdfcdc2 95 *
mbed_official 0:fd0d7bdfcdc2 96 * @returns
mbed_official 0:fd0d7bdfcdc2 97 * Response from the SPI slave
mbed_official 0:fd0d7bdfcdc2 98 */
mbed_official 0:fd0d7bdfcdc2 99 virtual int write(int value);
mbed_official 0:fd0d7bdfcdc2 100
mbed_official 0:fd0d7bdfcdc2 101 protected:
mbed_official 0:fd0d7bdfcdc2 102 spi_t _spi;
mbed_official 0:fd0d7bdfcdc2 103
mbed_official 0:fd0d7bdfcdc2 104 void aquire(void);
mbed_official 0:fd0d7bdfcdc2 105 static SPI *_owner;
mbed_official 0:fd0d7bdfcdc2 106 int _bits;
mbed_official 0:fd0d7bdfcdc2 107 int _mode;
mbed_official 0:fd0d7bdfcdc2 108 int _hz;
mbed_official 0:fd0d7bdfcdc2 109 };
mbed_official 0:fd0d7bdfcdc2 110
mbed_official 0:fd0d7bdfcdc2 111 } // namespace mbed
mbed_official 0:fd0d7bdfcdc2 112
mbed_official 0:fd0d7bdfcdc2 113 #endif
mbed_official 0:fd0d7bdfcdc2 114
mbed_official 0:fd0d7bdfcdc2 115 #endif