Emir Sokic / mbedPAI Featured

mbed.h verzija za koristenje na predmetu PAI

SPI.h@0:05aad811ea07, 2015-03-10 (annotated)

Committer:
esokic
Date:
Tue Mar 10 09:51:52 2015 +0000
Revision:
0:05aad811ea07
mbed.h verzija od marta 2014, za koristenje na predmetu PAI

Who changed what in which revision?

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