George Roussos / BLE_Temperature_Exercise

BLE Temperature Service Mobile and Ubiquitous Computing Module Birkbeck College

Dependencies:   DS1820

mbed/SPISlave.h@0:dd0fea342ad2, 2015-03-08 (annotated)

Committer:
gkroussos
Date:
Sun Mar 08 19:42:20 2015 +0000
Revision:
0:dd0fea342ad2
BLE Temperature Service ; Mobile and Ubiquitous Computing Module; Birkbeck College

Who changed what in which revision?

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