Kazuki Yamamoto / SWSPI

forked library from davervw/SWSPI

Dependents:   11u35_usbLocalFilesystem

Fork of SWSPI by Dave Van Wagner

SWSPI.h@6:a8ef62fa9c4c, 2016-08-30 (annotated)

Committer:
K4zuki
Date:
Tue Aug 30 00:30:11 2016 +0900
Revision:
6:a8ef62fa9c4c
Parent:
3:8c6310f2038f 
Merge branch 'master' of github.com:K4zuki/SWSPI

Who changed what in which revision?

UserRevisionLine numberNew contents of line
davervw 0:6a500a08c7fd 1 /* SWSPI, Software SPI library
davervw 0:6a500a08c7fd 2 * Copyright (c) 2012-2014, David R. Van Wagner, http://techwithdave.blogspot.com
davervw 0:6a500a08c7fd 3 *
davervw 0:6a500a08c7fd 4 * Permission is hereby granted, free of charge, to any person obtaining a copy
davervw 0:6a500a08c7fd 5 * of this software and associated documentation files (the "Software"), to deal
davervw 0:6a500a08c7fd 6 * in the Software without restriction, including without limitation the rights
davervw 0:6a500a08c7fd 7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
davervw 0:6a500a08c7fd 8 * copies of the Software, and to permit persons to whom the Software is
davervw 0:6a500a08c7fd 9 * furnished to do so, subject to the following conditions:
davervw 0:6a500a08c7fd 10 *
davervw 0:6a500a08c7fd 11 * The above copyright notice and this permission notice shall be included in
davervw 0:6a500a08c7fd 12 * all copies or substantial portions of the Software.
davervw 0:6a500a08c7fd 13 *
davervw 0:6a500a08c7fd 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
davervw 0:6a500a08c7fd 15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
davervw 0:6a500a08c7fd 16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
davervw 0:6a500a08c7fd 17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
davervw 0:6a500a08c7fd 18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
davervw 0:6a500a08c7fd 19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
davervw 0:6a500a08c7fd 20 * THE SOFTWARE.
davervw 0:6a500a08c7fd 21 */
davervw 0:6a500a08c7fd 22
davervw 0:6a500a08c7fd 23 #ifndef SWSPI_H
davervw 0:6a500a08c7fd 24 #define SWSPI_H
davervw 0:6a500a08c7fd 25
k4zuki 2:457a920a1223 26 #include "mbed.h"
k4zuki 2:457a920a1223 27
davervw 0:6a500a08c7fd 28 /** A software implemented SPI that can use any digital pins
davervw 0:6a500a08c7fd 29 *
davervw 0:6a500a08c7fd 30 * Useful when don't want to share a single SPI hardware among attached devices
davervw 0:6a500a08c7fd 31 * or when pinout doesn't match exactly to the target's SPI pins
davervw 0:6a500a08c7fd 32 *
davervw 0:6a500a08c7fd 33 * @code
davervw 0:6a500a08c7fd 34 * #include "mbed.h"
davervw 0:6a500a08c7fd 35 * #include "SWSPI.h"
davervw 0:6a500a08c7fd 36 *
davervw 0:6a500a08c7fd 37 * SWSPI spi(p5, p6, p7); // mosi, miso, sclk
davervw 0:6a500a08c7fd 38 *
davervw 0:6a500a08c7fd 39 * int main()
davervw 0:6a500a08c7fd 40 * {
davervw 0:6a500a08c7fd 41 * DigitalOut cs(p8);
davervw 0:6a500a08c7fd 42 * spi.format(8, 0);
davervw 0:6a500a08c7fd 43 * spi.frequency(10000000);
davervw 0:6a500a08c7fd 44 * cs.write(0);
davervw 0:6a500a08c7fd 45 * spi.write(0x9f);
davervw 0:6a500a08c7fd 46 * int jedecid = (spi.write(0) << 16) | (spi.write(0) << 8) | spi.write(0);
davervw 0:6a500a08c7fd 47 * cs.write(1);
davervw 0:6a500a08c7fd 48 * }
davervw 0:6a500a08c7fd 49 * @endcode
davervw 0:6a500a08c7fd 50 */
davervw 0:6a500a08c7fd 51 class SWSPI
davervw 0:6a500a08c7fd 52 {
davervw 0:6a500a08c7fd 53 private:
k4zuki 1:0f59aa4b839f 54 uint8_t fast_write(uint8_t value);
k4zuki 3:8c6310f2038f 55 DigitalInOut* mosi;
k4zuki 3:8c6310f2038f 56 DigitalInOut* miso;
k4zuki 3:8c6310f2038f 57 DigitalInOut* sclk;
davervw 0:6a500a08c7fd 58 int port;
davervw 0:6a500a08c7fd 59 int bits;
davervw 0:6a500a08c7fd 60 int mode;
davervw 0:6a500a08c7fd 61 int polarity; // idle clock value
davervw 0:6a500a08c7fd 62 int phase; // 0=sample on leading (first) clock edge, 1=trailing (second)
davervw 0:6a500a08c7fd 63 int freq;
k4zuki 1:0f59aa4b839f 64 bool _fast;
davervw 0:6a500a08c7fd 65
davervw 0:6a500a08c7fd 66 public:
davervw 0:6a500a08c7fd 67 /** Create SWSPI object
davervw 0:6a500a08c7fd 68 *
davervw 0:6a500a08c7fd 69 * @param mosi_pin
davervw 0:6a500a08c7fd 70 * @param miso_pin
davervw 0:6a500a08c7fd 71 * @param sclk_pin
davervw 0:6a500a08c7fd 72 */
davervw 0:6a500a08c7fd 73 SWSPI(PinName mosi_pin, PinName miso_pin, PinName sclk_pin);
davervw 0:6a500a08c7fd 74
davervw 0:6a500a08c7fd 75 /** Destructor */
davervw 0:6a500a08c7fd 76 ~SWSPI();
davervw 0:6a500a08c7fd 77
davervw 0:6a500a08c7fd 78 /** Specify SPI format
davervw 0:6a500a08c7fd 79 *
davervw 0:6a500a08c7fd 80 * @param bits 8 or 16 are typical values
davervw 0:6a500a08c7fd 81 * @param mode 0, 1, 2, or 3 phase (bit1) and idle clock (bit0)
davervw 0:6a500a08c7fd 82 */
davervw 0:6a500a08c7fd 83 void format(int bits, int mode = 0);
davervw 0:6a500a08c7fd 84
davervw 0:6a500a08c7fd 85 /** Specify SPI clock frequency
davervw 0:6a500a08c7fd 86 *
davervw 0:6a500a08c7fd 87 * @param hz frequency (optional, defaults to 10000000)
davervw 0:6a500a08c7fd 88 */
davervw 0:6a500a08c7fd 89 void frequency(int hz = 10000000);
davervw 0:6a500a08c7fd 90
davervw 0:6a500a08c7fd 91 /** Write data and read result
davervw 0:6a500a08c7fd 92 *
davervw 0:6a500a08c7fd 93 * @param value data to write (see format for bit size)
davervw 0:6a500a08c7fd 94 * returns value read from device
davervw 0:6a500a08c7fd 95 */
davervw 0:6a500a08c7fd 96 int write(int value);
davervw 0:6a500a08c7fd 97 };
davervw 0:6a500a08c7fd 98
davervw 0:6a500a08c7fd 99 #endif // SWSPI_H