wimbeaumont Project / SWSPI

sw SPI interface specific for the SOLID Slow control beta!!

Dependents:   sscm SPItest sscm

Fork of SWSPI by Dave Van Wagner

SWSPI.h@3:9c5ae1507a81, 2014-10-05 (annotated)

Committer:
wbeaumont
Date:
Sun Oct 05 17:12:11 2014 +0000
Revision:
3:9c5ae1507a81
Parent:
2:598d0028d5d2
Child:
4:2a23c789bd1c
version class added

Who changed what in which revision?

UserRevisionLine numberNew contents of line
wbeaumont 1:02327a96a5e2 1
wbeaumont 1:02327a96a5e2 2 #ifndef SWSPI_H
wbeaumont 1:02327a96a5e2 3 #define SWSPI_H
wbeaumont 1:02327a96a5e2 4
davervw 0:6a500a08c7fd 5 /* SWSPI, Software SPI library
davervw 0:6a500a08c7fd 6 * Copyright (c) 2012-2014, David R. Van Wagner, http://techwithdave.blogspot.com
davervw 0:6a500a08c7fd 7 *
davervw 0:6a500a08c7fd 8 * Permission is hereby granted, free of charge, to any person obtaining a copy
davervw 0:6a500a08c7fd 9 * of this software and associated documentation files (the "Software"), to deal
davervw 0:6a500a08c7fd 10 * in the Software without restriction, including without limitation the rights
davervw 0:6a500a08c7fd 11 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
davervw 0:6a500a08c7fd 12 * copies of the Software, and to permit persons to whom the Software is
davervw 0:6a500a08c7fd 13 * furnished to do so, subject to the following conditions:
davervw 0:6a500a08c7fd 14 *
davervw 0:6a500a08c7fd 15 * The above copyright notice and this permission notice shall be included in
davervw 0:6a500a08c7fd 16 * all copies or substantial portions of the Software.
davervw 0:6a500a08c7fd 17 *
davervw 0:6a500a08c7fd 18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
davervw 0:6a500a08c7fd 19 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
davervw 0:6a500a08c7fd 20 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
davervw 0:6a500a08c7fd 21 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
davervw 0:6a500a08c7fd 22 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
davervw 0:6a500a08c7fd 23 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
davervw 0:6a500a08c7fd 24 * THE SOFTWARE.
davervw 0:6a500a08c7fd 25 */
davervw 0:6a500a08c7fd 26
davervw 0:6a500a08c7fd 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 */
wbeaumont 1:02327a96a5e2 51 #include "mbed.h"
wbeaumont 1:02327a96a5e2 52
wbeaumont 3:9c5ae1507a81 53 #define SWSPI_HDR_VER "1.21"
wbeaumont 1:02327a96a5e2 54
davervw 0:6a500a08c7fd 55 class SWSPI
davervw 0:6a500a08c7fd 56 {
davervw 0:6a500a08c7fd 57 private:
davervw 0:6a500a08c7fd 58 DigitalOut* mosi;
davervw 0:6a500a08c7fd 59 DigitalIn* miso;
davervw 0:6a500a08c7fd 60 DigitalOut* sclk;
davervw 0:6a500a08c7fd 61 int port;
davervw 0:6a500a08c7fd 62 int bits;
davervw 0:6a500a08c7fd 63 int mode;
davervw 0:6a500a08c7fd 64 int polarity; // idle clock value
davervw 0:6a500a08c7fd 65 int phase; // 0=sample on leading (first) clock edge, 1=trailing (second)
davervw 0:6a500a08c7fd 66 int freq;
davervw 0:6a500a08c7fd 67
davervw 0:6a500a08c7fd 68 public:
davervw 0:6a500a08c7fd 69 /** Create SWSPI object
davervw 0:6a500a08c7fd 70 *
davervw 0:6a500a08c7fd 71 * @param mosi_pin
davervw 0:6a500a08c7fd 72 * @param miso_pin
davervw 0:6a500a08c7fd 73 * @param sclk_pin
davervw 0:6a500a08c7fd 74 */
wbeaumont 1:02327a96a5e2 75 SWSPI(DigitalOut *mosi_pin, DigitalIn *miso_pin, DigitalOut *sclk_pin);
davervw 0:6a500a08c7fd 76
davervw 0:6a500a08c7fd 77 /** Destructor */
davervw 0:6a500a08c7fd 78 ~SWSPI();
davervw 0:6a500a08c7fd 79
davervw 0:6a500a08c7fd 80 /** Specify SPI format
davervw 0:6a500a08c7fd 81 *
davervw 0:6a500a08c7fd 82 * @param bits 8 or 16 are typical values
davervw 0:6a500a08c7fd 83 * @param mode 0, 1, 2, or 3 phase (bit1) and idle clock (bit0)
davervw 0:6a500a08c7fd 84 */
davervw 0:6a500a08c7fd 85 void format(int bits, int mode = 0);
davervw 0:6a500a08c7fd 86
davervw 0:6a500a08c7fd 87 /** Specify SPI clock frequency
davervw 0:6a500a08c7fd 88 *
davervw 0:6a500a08c7fd 89 * @param hz frequency (optional, defaults to 10000000)
davervw 0:6a500a08c7fd 90 */
davervw 0:6a500a08c7fd 91 void frequency(int hz = 10000000);
davervw 0:6a500a08c7fd 92
davervw 0:6a500a08c7fd 93 /** Write data and read result
davervw 0:6a500a08c7fd 94 *
davervw 0:6a500a08c7fd 95 * @param value data to write (see format for bit size)
davervw 0:6a500a08c7fd 96 * returns value read from device
davervw 0:6a500a08c7fd 97 */
wbeaumont 2:598d0028d5d2 98 unsigned int write(unsigned int value);
wbeaumont 3:9c5ae1507a81 99
wbeaumont 3:9c5ae1507a81 100 static unsigned short get_hdr_version_nr();
wbeaumont 3:9c5ae1507a81 101 static unsigned short get_src_version_nr();
davervw 0:6a500a08c7fd 102 };
davervw 0:6a500a08c7fd 103
davervw 0:6a500a08c7fd 104 #endif // SWSPI_H