Emilio Monti / mbed-KL25Z

mbed libraries for KL25Z

Dependents:   FRDM_RGBLED

SPI.h@9:663789d7729f, 2013-02-18 (annotated)

Committer:
emilmont
Date:
Mon Feb 18 09:41:56 2013 +0000
Revision:
9:663789d7729f
Parent:
8:c14af7958ef5 
Update mbed-KL25Z to latest build

Who changed what in which revision?

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