Freeman Oldman / NUCLEO_STM32F401RE_CC3000_ILI9341

The code from https://github.com/vpcola/Nucleo

mbed-src/api/SPI.h@0:5464d5e415e5, 2014-10-08 (annotated)

Committer:
sinrab
Date:
Wed Oct 08 11:00:24 2014 +0000
Revision:
0:5464d5e415e5
The code from https://github.com/vpcola/Nucleo

Who changed what in which revision?

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