mbed library sources change for ST sensors and ST BLE
Fork of mbed-src by
cpp/SPI.h
- Committer:
- mbed_official
- Date:
- 2012-11-20
- Revision:
- 0:fd0d7bdfcdc2
- Child:
- 2:143cac498751
File content as of revision 0:fd0d7bdfcdc2:
/* mbed Microcontroller Library * Copyright (c) 2006-2012 ARM Limited * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal * in the Software without restriction, including without limitation the rights * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell * copies of the Software, and to permit persons to whom the Software is * furnished to do so, subject to the following conditions: * * The above copyright notice and this permission notice shall be included in * all copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE * SOFTWARE. */ #ifndef MBED_SPI_H #define MBED_SPI_H #include "platform.h" #if DEVICE_SPI #include "spi_api.h" namespace mbed { /** A SPI Master, used for communicating with SPI slave devices * * The default format is set to 8-bits, mode 0, and a clock frequency of 1MHz * * Most SPI devices will also require Chip Select and Reset signals. These * can be controlled using <DigitalOut> pins * * Example: * @code * // Send a byte to a SPI slave, and record the response * * #include "mbed.h" * * SPI device(p5, p6, p7); // mosi, miso, sclk * * int main() { * int response = device.write(0xFF); * } * @endcode */ class SPI { public: /** Create a SPI master connected to the specified pins * * Pin Options: * (5, 6, 7) or (11, 12, 13) * * mosi or miso can be specfied as NC if not used * * @param mosi SPI Master Out, Slave In pin * @param miso SPI Master In, Slave Out pin * @param sclk SPI Clock pin */ SPI(PinName mosi, PinName miso, PinName sclk); /** Configure the data transmission format * * @param bits Number of bits per SPI frame (4 - 16) * @param mode Clock polarity and phase mode (0 - 3) * * @code * mode | POL PHA * -----+-------- * 0 | 0 0 * 1 | 0 1 * 2 | 1 0 * 3 | 1 1 * @endcode */ void format(int bits, int mode = 0); /** Set the spi bus clock frequency * * @param hz SCLK frequency in hz (default = 1MHz) */ void frequency(int hz = 1000000); /** Write to the SPI Slave and return the response * * @param value Data to be sent to the SPI slave * * @returns * Response from the SPI slave */ virtual int write(int value); protected: spi_t _spi; void aquire(void); static SPI *_owner; int _bits; int _mode; int _hz; }; } // namespace mbed #endif #endif