Yihui Xiong / BLE_NODE_TEST

Test code for Grove Node BLE

Dependencies:   BLE_API nRF51822

Fork of BLE_LoopbackUART by Bluetooth Low Energy

mbed-src/api/SPI.h@10:22480ac31879, 2014-11-27 (annotated)

Committer:
yihui
Date:
Thu Nov 27 09:30:36 2014 +0000
Revision:
10:22480ac31879
Parent:
9:05f0b5a3a70a 
change to new revision hardware

Who changed what in which revision?

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