Tim Barry / mbed_blinky_offset

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

mbed-src/cpp/SPI.h@0:2173789ea697, 2014-10-04 (annotated)

Committer:
timbobazza
Date:
Sat Oct 04 09:07:08 2014 +0000
Revision:
0:2173789ea697
First version

Who changed what in which revision?

UserRevisionLine numberNew contents of line
timbobazza 0:2173789ea697 1 /* mbed Microcontroller Library
timbobazza 0:2173789ea697 2 * Copyright (c) 2006-2013 ARM Limited
timbobazza 0:2173789ea697 3 *
timbobazza 0:2173789ea697 4 * Licensed under the Apache License, Version 2.0 (the "License");
timbobazza 0:2173789ea697 5 * you may not use this file except in compliance with the License.
timbobazza 0:2173789ea697 6 * You may obtain a copy of the License at
timbobazza 0:2173789ea697 7 *
timbobazza 0:2173789ea697 8 * http://www.apache.org/licenses/LICENSE-2.0
timbobazza 0:2173789ea697 9 *
timbobazza 0:2173789ea697 10 * Unless required by applicable law or agreed to in writing, software
timbobazza 0:2173789ea697 11 * distributed under the License is distributed on an "AS IS" BASIS,
timbobazza 0:2173789ea697 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
timbobazza 0:2173789ea697 13 * See the License for the specific language governing permissions and
timbobazza 0:2173789ea697 14 * limitations under the License.
timbobazza 0:2173789ea697 15 */
timbobazza 0:2173789ea697 16 #ifndef MBED_SPI_H
timbobazza 0:2173789ea697 17 #define MBED_SPI_H
timbobazza 0:2173789ea697 18
timbobazza 0:2173789ea697 19 #include "platform.h"
timbobazza 0:2173789ea697 20
timbobazza 0:2173789ea697 21 #if DEVICE_SPI
timbobazza 0:2173789ea697 22
timbobazza 0:2173789ea697 23 #include "spi_api.h"
timbobazza 0:2173789ea697 24
timbobazza 0:2173789ea697 25 namespace mbed {
timbobazza 0:2173789ea697 26
timbobazza 0:2173789ea697 27 /** A SPI Master, used for communicating with SPI slave devices
timbobazza 0:2173789ea697 28 *
timbobazza 0:2173789ea697 29 * The default format is set to 8-bits, mode 0, and a clock frequency of 1MHz
timbobazza 0:2173789ea697 30 *
timbobazza 0:2173789ea697 31 * Most SPI devices will also require Chip Select and Reset signals. These
timbobazza 0:2173789ea697 32 * can be controlled using <DigitalOut> pins
timbobazza 0:2173789ea697 33 *
timbobazza 0:2173789ea697 34 * Example:
timbobazza 0:2173789ea697 35 * @code
timbobazza 0:2173789ea697 36 * // Send a byte to a SPI slave, and record the response
timbobazza 0:2173789ea697 37 *
timbobazza 0:2173789ea697 38 * #include "mbed.h"
timbobazza 0:2173789ea697 39 *
timbobazza 0:2173789ea697 40 * SPI device(p5, p6, p7); // mosi, miso, sclk
timbobazza 0:2173789ea697 41 *
timbobazza 0:2173789ea697 42 * int main() {
timbobazza 0:2173789ea697 43 * int response = device.write(0xFF);
timbobazza 0:2173789ea697 44 * }
timbobazza 0:2173789ea697 45 * @endcode
timbobazza 0:2173789ea697 46 */
timbobazza 0:2173789ea697 47 class SPI {
timbobazza 0:2173789ea697 48
timbobazza 0:2173789ea697 49 public:
timbobazza 0:2173789ea697 50
timbobazza 0:2173789ea697 51 /** Create a SPI master connected to the specified pins
timbobazza 0:2173789ea697 52 *
timbobazza 0:2173789ea697 53 * Pin Options:
timbobazza 0:2173789ea697 54 * (5, 6, 7) or (11, 12, 13)
timbobazza 0:2173789ea697 55 *
timbobazza 0:2173789ea697 56 * mosi or miso can be specfied as NC if not used
timbobazza 0:2173789ea697 57 *
timbobazza 0:2173789ea697 58 * @param mosi SPI Master Out, Slave In pin
timbobazza 0:2173789ea697 59 * @param miso SPI Master In, Slave Out pin
timbobazza 0:2173789ea697 60 * @param sclk SPI Clock pin
timbobazza 0:2173789ea697 61 */
timbobazza 0:2173789ea697 62 SPI(PinName mosi, PinName miso, PinName sclk);
timbobazza 0:2173789ea697 63
timbobazza 0:2173789ea697 64 /** Configure the data transmission format
timbobazza 0:2173789ea697 65 *
timbobazza 0:2173789ea697 66 * @param bits Number of bits per SPI frame (4 - 16)
timbobazza 0:2173789ea697 67 * @param mode Clock polarity and phase mode (0 - 3)
timbobazza 0:2173789ea697 68 *
timbobazza 0:2173789ea697 69 * @code
timbobazza 0:2173789ea697 70 * mode | POL PHA
timbobazza 0:2173789ea697 71 * -----+--------
timbobazza 0:2173789ea697 72 * 0 | 0 0
timbobazza 0:2173789ea697 73 * 1 | 0 1
timbobazza 0:2173789ea697 74 * 2 | 1 0
timbobazza 0:2173789ea697 75 * 3 | 1 1
timbobazza 0:2173789ea697 76 * @endcode
timbobazza 0:2173789ea697 77 */
timbobazza 0:2173789ea697 78 void format(int bits, int mode = 0);
timbobazza 0:2173789ea697 79
timbobazza 0:2173789ea697 80 /** Set the spi bus clock frequency
timbobazza 0:2173789ea697 81 *
timbobazza 0:2173789ea697 82 * @param hz SCLK frequency in hz (default = 1MHz)
timbobazza 0:2173789ea697 83 */
timbobazza 0:2173789ea697 84 void frequency(int hz = 1000000);
timbobazza 0:2173789ea697 85
timbobazza 0:2173789ea697 86 /** Write to the SPI Slave and return the response
timbobazza 0:2173789ea697 87 *
timbobazza 0:2173789ea697 88 * @param value Data to be sent to the SPI slave
timbobazza 0:2173789ea697 89 *
timbobazza 0:2173789ea697 90 * @returns
timbobazza 0:2173789ea697 91 * Response from the SPI slave
timbobazza 0:2173789ea697 92 */
timbobazza 0:2173789ea697 93 virtual int write(int value);
timbobazza 0:2173789ea697 94
timbobazza 0:2173789ea697 95 protected:
timbobazza 0:2173789ea697 96 spi_t _spi;
timbobazza 0:2173789ea697 97
timbobazza 0:2173789ea697 98 void aquire(void);
timbobazza 0:2173789ea697 99 static SPI *_owner;
timbobazza 0:2173789ea697 100 int _bits;
timbobazza 0:2173789ea697 101 int _mode;
timbobazza 0:2173789ea697 102 int _hz;
timbobazza 0:2173789ea697 103 };
timbobazza 0:2173789ea697 104
timbobazza 0:2173789ea697 105 } // namespace mbed
timbobazza 0:2173789ea697 106
timbobazza 0:2173789ea697 107 #endif
timbobazza 0:2173789ea697 108
timbobazza 0:2173789ea697 109 #endif