jesus antonio lopez / mbed

...

Dependents:   2doejemplo Labo_TRSE_Drone

Fork of mbed by mbed official

SPI.h@71:7ec3cb6bbcc4, 2013-11-29 (annotated)

Committer:
jalp89
Date:
Fri Nov 29 09:39:46 2013 +0000
Revision:
71:7ec3cb6bbcc4
Parent:
65:5798e58a58b1 
...

Who changed what in which revision?

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