Ermanno Brusadin / mbed

mbed library sources

Dependents:   FRDM-KL46Z_LCD_Test FRDM-KL46Z_LCD_Test FRDM-KL46Z_Plantilla FRDM-KL46Z_Plantilla ... more

api/SPI.h@0:6bc4ac881c8e, 2016-07-28 (annotated)

Committer:
ebrus
Date:
Thu Jul 28 15:56:34 2016 +0000
Revision:
0:6bc4ac881c8e
1;

Who changed what in which revision?

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