George Roussos / BLE_Temperature_Exercise

BLE Temperature Service Mobile and Ubiquitous Computing Module Birkbeck College

Dependencies:   DS1820

mbed/SPI.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_SPI_H
gkroussos 0:dd0fea342ad2 17 #define MBED_SPI_H
gkroussos 0:dd0fea342ad2 18
gkroussos 0:dd0fea342ad2 19 #include "platform.h"
gkroussos 0:dd0fea342ad2 20
gkroussos 0:dd0fea342ad2 21 #if DEVICE_SPI
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 Master, used for communicating with SPI slave devices
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 * Most SPI devices will also require Chip Select and Reset signals. These
gkroussos 0:dd0fea342ad2 32 * can be controlled using <DigitalOut> pins
gkroussos 0:dd0fea342ad2 33 *
gkroussos 0:dd0fea342ad2 34 * Example:
gkroussos 0:dd0fea342ad2 35 * @code
gkroussos 0:dd0fea342ad2 36 * // Send a byte to a SPI slave, and record the response
gkroussos 0:dd0fea342ad2 37 *
gkroussos 0:dd0fea342ad2 38 * #include "mbed.h"
gkroussos 0:dd0fea342ad2 39 *
gkroussos 0:dd0fea342ad2 40 * SPI device(p5, p6, p7); // mosi, miso, sclk
gkroussos 0:dd0fea342ad2 41 *
gkroussos 0:dd0fea342ad2 42 * int main() {
gkroussos 0:dd0fea342ad2 43 * int response = device.write(0xFF);
gkroussos 0:dd0fea342ad2 44 * }
gkroussos 0:dd0fea342ad2 45 * @endcode
gkroussos 0:dd0fea342ad2 46 */
gkroussos 0:dd0fea342ad2 47 class SPI {
gkroussos 0:dd0fea342ad2 48
gkroussos 0:dd0fea342ad2 49 public:
gkroussos 0:dd0fea342ad2 50
gkroussos 0:dd0fea342ad2 51 /** Create a SPI master connected to the specified pins
gkroussos 0:dd0fea342ad2 52 *
gkroussos 0:dd0fea342ad2 53 * Pin Options:
gkroussos 0:dd0fea342ad2 54 * (5, 6, 7) or (11, 12, 13)
gkroussos 0:dd0fea342ad2 55 *
gkroussos 0:dd0fea342ad2 56 * mosi or miso can be specfied as NC if not used
gkroussos 0:dd0fea342ad2 57 *
gkroussos 0:dd0fea342ad2 58 * @param mosi SPI Master Out, Slave In pin
gkroussos 0:dd0fea342ad2 59 * @param miso SPI Master In, Slave Out pin
gkroussos 0:dd0fea342ad2 60 * @param sclk SPI Clock pin
gkroussos 0:dd0fea342ad2 61 */
gkroussos 0:dd0fea342ad2 62 SPI(PinName mosi, PinName miso, PinName sclk, PinName _unused=NC);
gkroussos 0:dd0fea342ad2 63
gkroussos 0:dd0fea342ad2 64 /** Configure the data transmission format
gkroussos 0:dd0fea342ad2 65 *
gkroussos 0:dd0fea342ad2 66 * @param bits Number of bits per SPI frame (4 - 16)
gkroussos 0:dd0fea342ad2 67 * @param mode Clock polarity and phase mode (0 - 3)
gkroussos 0:dd0fea342ad2 68 *
gkroussos 0:dd0fea342ad2 69 * @code
gkroussos 0:dd0fea342ad2 70 * mode | POL PHA
gkroussos 0:dd0fea342ad2 71 * -----+--------
gkroussos 0:dd0fea342ad2 72 * 0 | 0 0
gkroussos 0:dd0fea342ad2 73 * 1 | 0 1
gkroussos 0:dd0fea342ad2 74 * 2 | 1 0
gkroussos 0:dd0fea342ad2 75 * 3 | 1 1
gkroussos 0:dd0fea342ad2 76 * @endcode
gkroussos 0:dd0fea342ad2 77 */
gkroussos 0:dd0fea342ad2 78 void format(int bits, int mode = 0);
gkroussos 0:dd0fea342ad2 79
gkroussos 0:dd0fea342ad2 80 /** Set the spi bus clock frequency
gkroussos 0:dd0fea342ad2 81 *
gkroussos 0:dd0fea342ad2 82 * @param hz SCLK frequency in hz (default = 1MHz)
gkroussos 0:dd0fea342ad2 83 */
gkroussos 0:dd0fea342ad2 84 void frequency(int hz = 1000000);
gkroussos 0:dd0fea342ad2 85
gkroussos 0:dd0fea342ad2 86 /** Write to the SPI Slave and return the response
gkroussos 0:dd0fea342ad2 87 *
gkroussos 0:dd0fea342ad2 88 * @param value Data to be sent to the SPI slave
gkroussos 0:dd0fea342ad2 89 *
gkroussos 0:dd0fea342ad2 90 * @returns
gkroussos 0:dd0fea342ad2 91 * Response from the SPI slave
gkroussos 0:dd0fea342ad2 92 */
gkroussos 0:dd0fea342ad2 93 virtual int write(int value);
gkroussos 0:dd0fea342ad2 94
gkroussos 0:dd0fea342ad2 95 protected:
gkroussos 0:dd0fea342ad2 96 spi_t _spi;
gkroussos 0:dd0fea342ad2 97
gkroussos 0:dd0fea342ad2 98 void aquire(void);
gkroussos 0:dd0fea342ad2 99 static SPI *_owner;
gkroussos 0:dd0fea342ad2 100 int _bits;
gkroussos 0:dd0fea342ad2 101 int _mode;
gkroussos 0:dd0fea342ad2 102 int _hz;
gkroussos 0:dd0fea342ad2 103 };
gkroussos 0:dd0fea342ad2 104
gkroussos 0:dd0fea342ad2 105 } // namespace mbed
gkroussos 0:dd0fea342ad2 106
gkroussos 0:dd0fea342ad2 107 #endif
gkroussos 0:dd0fea342ad2 108
gkroussos 0:dd0fea342ad2 109 #endif