Yihui Xiong / mbed-src-nrf51822

customized mbed library sources for nrf51822

Dependents:   Grove_Node Potentiometer BLE_Beacon I2C_Scanner

api/SPI.h@0:700cadd8b708, 2014-11-04 (annotated)

Committer:
yihui
Date:
Tue Nov 04 07:38:53 2014 +0000
Revision:
0:700cadd8b708
customized mbed-src library for nrf51822

Who changed what in which revision?

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