George Roussos / BLE_iBeacon_Exercise

Birkbeck College Mobile and Ubiquitous Computing IoT Lab Exercise 2

Dependencies:   BLE_API_Native_blog

mbed/SPISlave.h@0:e8fdba0ed044, 2015-03-07 (annotated)

Committer:
gkroussos
Date:
Sat Mar 07 16:34:53 2015 +0000
Revision:
0:e8fdba0ed044
MUC IoT Workshop v1.0

Who changed what in which revision?

UserRevisionLine numberNew contents of line
gkroussos 0:e8fdba0ed044 1 /* mbed Microcontroller Library
gkroussos 0:e8fdba0ed044 2 * Copyright (c) 2006-2013 ARM Limited
gkroussos 0:e8fdba0ed044 3 *
gkroussos 0:e8fdba0ed044 4 * Licensed under the Apache License, Version 2.0 (the "License");
gkroussos 0:e8fdba0ed044 5 * you may not use this file except in compliance with the License.
gkroussos 0:e8fdba0ed044 6 * You may obtain a copy of the License at
gkroussos 0:e8fdba0ed044 7 *
gkroussos 0:e8fdba0ed044 8 * http://www.apache.org/licenses/LICENSE-2.0
gkroussos 0:e8fdba0ed044 9 *
gkroussos 0:e8fdba0ed044 10 * Unless required by applicable law or agreed to in writing, software
gkroussos 0:e8fdba0ed044 11 * distributed under the License is distributed on an "AS IS" BASIS,
gkroussos 0:e8fdba0ed044 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
gkroussos 0:e8fdba0ed044 13 * See the License for the specific language governing permissions and
gkroussos 0:e8fdba0ed044 14 * limitations under the License.
gkroussos 0:e8fdba0ed044 15 */
gkroussos 0:e8fdba0ed044 16 #ifndef MBED_SPISLAVE_H
gkroussos 0:e8fdba0ed044 17 #define MBED_SPISLAVE_H
gkroussos 0:e8fdba0ed044 18
gkroussos 0:e8fdba0ed044 19 #include "platform.h"
gkroussos 0:e8fdba0ed044 20
gkroussos 0:e8fdba0ed044 21 #if DEVICE_SPISLAVE
gkroussos 0:e8fdba0ed044 22
gkroussos 0:e8fdba0ed044 23 #include "spi_api.h"
gkroussos 0:e8fdba0ed044 24
gkroussos 0:e8fdba0ed044 25 namespace mbed {
gkroussos 0:e8fdba0ed044 26
gkroussos 0:e8fdba0ed044 27 /** A SPI slave, used for communicating with a SPI Master device
gkroussos 0:e8fdba0ed044 28 *
gkroussos 0:e8fdba0ed044 29 * The default format is set to 8-bits, mode 0, and a clock frequency of 1MHz
gkroussos 0:e8fdba0ed044 30 *
gkroussos 0:e8fdba0ed044 31 * Example:
gkroussos 0:e8fdba0ed044 32 * @code
gkroussos 0:e8fdba0ed044 33 * // Reply to a SPI master as slave
gkroussos 0:e8fdba0ed044 34 *
gkroussos 0:e8fdba0ed044 35 * #include "mbed.h"
gkroussos 0:e8fdba0ed044 36 *
gkroussos 0:e8fdba0ed044 37 * SPISlave device(p5, p6, p7, p8); // mosi, miso, sclk, ssel
gkroussos 0:e8fdba0ed044 38 *
gkroussos 0:e8fdba0ed044 39 * int main() {
gkroussos 0:e8fdba0ed044 40 * device.reply(0x00); // Prime SPI with first reply
gkroussos 0:e8fdba0ed044 41 * while(1) {
gkroussos 0:e8fdba0ed044 42 * if(device.receive()) {
gkroussos 0:e8fdba0ed044 43 * int v = device.read(); // Read byte from master
gkroussos 0:e8fdba0ed044 44 * v = (v + 1) % 0x100; // Add one to it, modulo 256
gkroussos 0:e8fdba0ed044 45 * device.reply(v); // Make this the next reply
gkroussos 0:e8fdba0ed044 46 * }
gkroussos 0:e8fdba0ed044 47 * }
gkroussos 0:e8fdba0ed044 48 * }
gkroussos 0:e8fdba0ed044 49 * @endcode
gkroussos 0:e8fdba0ed044 50 */
gkroussos 0:e8fdba0ed044 51 class SPISlave {
gkroussos 0:e8fdba0ed044 52
gkroussos 0:e8fdba0ed044 53 public:
gkroussos 0:e8fdba0ed044 54
gkroussos 0:e8fdba0ed044 55 /** Create a SPI slave connected to the specified pins
gkroussos 0:e8fdba0ed044 56 *
gkroussos 0:e8fdba0ed044 57 * Pin Options:
gkroussos 0:e8fdba0ed044 58 * (5, 6, 7i, 8) or (11, 12, 13, 14)
gkroussos 0:e8fdba0ed044 59 *
gkroussos 0:e8fdba0ed044 60 * mosi or miso can be specfied as NC if not used
gkroussos 0:e8fdba0ed044 61 *
gkroussos 0:e8fdba0ed044 62 * @param mosi SPI Master Out, Slave In pin
gkroussos 0:e8fdba0ed044 63 * @param miso SPI Master In, Slave Out pin
gkroussos 0:e8fdba0ed044 64 * @param sclk SPI Clock pin
gkroussos 0:e8fdba0ed044 65 * @param ssel SPI chip select pin
gkroussos 0:e8fdba0ed044 66 * @param name (optional) A string to identify the object
gkroussos 0:e8fdba0ed044 67 */
gkroussos 0:e8fdba0ed044 68 SPISlave(PinName mosi, PinName miso, PinName sclk, PinName ssel);
gkroussos 0:e8fdba0ed044 69
gkroussos 0:e8fdba0ed044 70 /** Configure the data transmission format
gkroussos 0:e8fdba0ed044 71 *
gkroussos 0:e8fdba0ed044 72 * @param bits Number of bits per SPI frame (4 - 16)
gkroussos 0:e8fdba0ed044 73 * @param mode Clock polarity and phase mode (0 - 3)
gkroussos 0:e8fdba0ed044 74 *
gkroussos 0:e8fdba0ed044 75 * @code
gkroussos 0:e8fdba0ed044 76 * mode | POL PHA
gkroussos 0:e8fdba0ed044 77 * -----+--------
gkroussos 0:e8fdba0ed044 78 * 0 | 0 0
gkroussos 0:e8fdba0ed044 79 * 1 | 0 1
gkroussos 0:e8fdba0ed044 80 * 2 | 1 0
gkroussos 0:e8fdba0ed044 81 * 3 | 1 1
gkroussos 0:e8fdba0ed044 82 * @endcode
gkroussos 0:e8fdba0ed044 83 */
gkroussos 0:e8fdba0ed044 84 void format(int bits, int mode = 0);
gkroussos 0:e8fdba0ed044 85
gkroussos 0:e8fdba0ed044 86 /** Set the spi bus clock frequency
gkroussos 0:e8fdba0ed044 87 *
gkroussos 0:e8fdba0ed044 88 * @param hz SCLK frequency in hz (default = 1MHz)
gkroussos 0:e8fdba0ed044 89 */
gkroussos 0:e8fdba0ed044 90 void frequency(int hz = 1000000);
gkroussos 0:e8fdba0ed044 91
gkroussos 0:e8fdba0ed044 92 /** Polls the SPI to see if data has been received
gkroussos 0:e8fdba0ed044 93 *
gkroussos 0:e8fdba0ed044 94 * @returns
gkroussos 0:e8fdba0ed044 95 * 0 if no data,
gkroussos 0:e8fdba0ed044 96 * 1 otherwise
gkroussos 0:e8fdba0ed044 97 */
gkroussos 0:e8fdba0ed044 98 int receive(void);
gkroussos 0:e8fdba0ed044 99
gkroussos 0:e8fdba0ed044 100 /** Retrieve data from receive buffer as slave
gkroussos 0:e8fdba0ed044 101 *
gkroussos 0:e8fdba0ed044 102 * @returns
gkroussos 0:e8fdba0ed044 103 * the data in the receive buffer
gkroussos 0:e8fdba0ed044 104 */
gkroussos 0:e8fdba0ed044 105 int read(void);
gkroussos 0:e8fdba0ed044 106
gkroussos 0:e8fdba0ed044 107 /** Fill the transmission buffer with the value to be written out
gkroussos 0:e8fdba0ed044 108 * as slave on the next received message from the master.
gkroussos 0:e8fdba0ed044 109 *
gkroussos 0:e8fdba0ed044 110 * @param value the data to be transmitted next
gkroussos 0:e8fdba0ed044 111 */
gkroussos 0:e8fdba0ed044 112 void reply(int value);
gkroussos 0:e8fdba0ed044 113
gkroussos 0:e8fdba0ed044 114 protected:
gkroussos 0:e8fdba0ed044 115 spi_t _spi;
gkroussos 0:e8fdba0ed044 116
gkroussos 0:e8fdba0ed044 117 int _bits;
gkroussos 0:e8fdba0ed044 118 int _mode;
gkroussos 0:e8fdba0ed044 119 int _hz;
gkroussos 0:e8fdba0ed044 120 };
gkroussos 0:e8fdba0ed044 121
gkroussos 0:e8fdba0ed044 122 } // namespace mbed
gkroussos 0:e8fdba0ed044 123
gkroussos 0:e8fdba0ed044 124 #endif
gkroussos 0:e8fdba0ed044 125
gkroussos 0:e8fdba0ed044 126 #endif