Yihui Xiong / mbed-src-nrf51822

customized mbed library sources for nrf51822

Dependents:   Grove_Node Potentiometer BLE_Beacon I2C_Scanner

api/SPISlave.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_SPISLAVE_H
yihui 0:700cadd8b708 17 #define MBED_SPISLAVE_H
yihui 0:700cadd8b708 18
yihui 0:700cadd8b708 19 #include "platform.h"
yihui 0:700cadd8b708 20
yihui 0:700cadd8b708 21 #if DEVICE_SPISLAVE
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 slave, used for communicating with a SPI Master device
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 * Example:
yihui 0:700cadd8b708 32 * @code
yihui 0:700cadd8b708 33 * // Reply to a SPI master as slave
yihui 0:700cadd8b708 34 *
yihui 0:700cadd8b708 35 * #include "mbed.h"
yihui 0:700cadd8b708 36 *
yihui 0:700cadd8b708 37 * SPISlave device(p5, p6, p7, p8); // mosi, miso, sclk, ssel
yihui 0:700cadd8b708 38 *
yihui 0:700cadd8b708 39 * int main() {
yihui 0:700cadd8b708 40 * device.reply(0x00); // Prime SPI with first reply
yihui 0:700cadd8b708 41 * while(1) {
yihui 0:700cadd8b708 42 * if(device.receive()) {
yihui 0:700cadd8b708 43 * int v = device.read(); // Read byte from master
yihui 0:700cadd8b708 44 * v = (v + 1) % 0x100; // Add one to it, modulo 256
yihui 0:700cadd8b708 45 * device.reply(v); // Make this the next reply
yihui 0:700cadd8b708 46 * }
yihui 0:700cadd8b708 47 * }
yihui 0:700cadd8b708 48 * }
yihui 0:700cadd8b708 49 * @endcode
yihui 0:700cadd8b708 50 */
yihui 0:700cadd8b708 51 class SPISlave {
yihui 0:700cadd8b708 52
yihui 0:700cadd8b708 53 public:
yihui 0:700cadd8b708 54
yihui 0:700cadd8b708 55 /** Create a SPI slave connected to the specified pins
yihui 0:700cadd8b708 56 *
yihui 0:700cadd8b708 57 * Pin Options:
yihui 0:700cadd8b708 58 * (5, 6, 7i, 8) or (11, 12, 13, 14)
yihui 0:700cadd8b708 59 *
yihui 0:700cadd8b708 60 * mosi or miso can be specfied as NC if not used
yihui 0:700cadd8b708 61 *
yihui 0:700cadd8b708 62 * @param mosi SPI Master Out, Slave In pin
yihui 0:700cadd8b708 63 * @param miso SPI Master In, Slave Out pin
yihui 0:700cadd8b708 64 * @param sclk SPI Clock pin
yihui 0:700cadd8b708 65 * @param ssel SPI chip select pin
yihui 0:700cadd8b708 66 * @param name (optional) A string to identify the object
yihui 0:700cadd8b708 67 */
yihui 0:700cadd8b708 68 SPISlave(PinName mosi, PinName miso, PinName sclk, PinName ssel);
yihui 0:700cadd8b708 69
yihui 0:700cadd8b708 70 /** Configure the data transmission format
yihui 0:700cadd8b708 71 *
yihui 0:700cadd8b708 72 * @param bits Number of bits per SPI frame (4 - 16)
yihui 0:700cadd8b708 73 * @param mode Clock polarity and phase mode (0 - 3)
yihui 0:700cadd8b708 74 *
yihui 0:700cadd8b708 75 * @code
yihui 0:700cadd8b708 76 * mode | POL PHA
yihui 0:700cadd8b708 77 * -----+--------
yihui 0:700cadd8b708 78 * 0 | 0 0
yihui 0:700cadd8b708 79 * 1 | 0 1
yihui 0:700cadd8b708 80 * 2 | 1 0
yihui 0:700cadd8b708 81 * 3 | 1 1
yihui 0:700cadd8b708 82 * @endcode
yihui 0:700cadd8b708 83 */
yihui 0:700cadd8b708 84 void format(int bits, int mode = 0);
yihui 0:700cadd8b708 85
yihui 0:700cadd8b708 86 /** Set the spi bus clock frequency
yihui 0:700cadd8b708 87 *
yihui 0:700cadd8b708 88 * @param hz SCLK frequency in hz (default = 1MHz)
yihui 0:700cadd8b708 89 */
yihui 0:700cadd8b708 90 void frequency(int hz = 1000000);
yihui 0:700cadd8b708 91
yihui 0:700cadd8b708 92 /** Polls the SPI to see if data has been received
yihui 0:700cadd8b708 93 *
yihui 0:700cadd8b708 94 * @returns
yihui 0:700cadd8b708 95 * 0 if no data,
yihui 0:700cadd8b708 96 * 1 otherwise
yihui 0:700cadd8b708 97 */
yihui 0:700cadd8b708 98 int receive(void);
yihui 0:700cadd8b708 99
yihui 0:700cadd8b708 100 /** Retrieve data from receive buffer as slave
yihui 0:700cadd8b708 101 *
yihui 0:700cadd8b708 102 * @returns
yihui 0:700cadd8b708 103 * the data in the receive buffer
yihui 0:700cadd8b708 104 */
yihui 0:700cadd8b708 105 int read(void);
yihui 0:700cadd8b708 106
yihui 0:700cadd8b708 107 /** Fill the transmission buffer with the value to be written out
yihui 0:700cadd8b708 108 * as slave on the next received message from the master.
yihui 0:700cadd8b708 109 *
yihui 0:700cadd8b708 110 * @param value the data to be transmitted next
yihui 0:700cadd8b708 111 */
yihui 0:700cadd8b708 112 void reply(int value);
yihui 0:700cadd8b708 113
yihui 0:700cadd8b708 114 protected:
yihui 0:700cadd8b708 115 spi_t _spi;
yihui 0:700cadd8b708 116
yihui 0:700cadd8b708 117 int _bits;
yihui 0:700cadd8b708 118 int _mode;
yihui 0:700cadd8b708 119 int _hz;
yihui 0:700cadd8b708 120 };
yihui 0:700cadd8b708 121
yihui 0:700cadd8b708 122 } // namespace mbed
yihui 0:700cadd8b708 123
yihui 0:700cadd8b708 124 #endif
yihui 0:700cadd8b708 125
yihui 0:700cadd8b708 126 #endif