paolo della vedova / FastIO

Replacement for regular GPIO (DigitalIn, DigitalOut, DigitalInOut) classes which has superior speed. (modified for use opendrain in stm32)

Dependents:   hctl2032_encoder

Fork of FastIO by Erik -

FastIO.h@2:1a6ed4b84590, 2014-07-04 (annotated)

Committer:
Sissors
Date:
Fri Jul 04 17:28:45 2014 +0000
Revision:
2:1a6ed4b84590
Parent:
1:85a4a54f15e3
Child:
3:3dd9466e73fc
Added support for unsupported targets :P

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Sissors 0:d394ebd01052 1 #ifndef __FAST_IO_H
Sissors 0:d394ebd01052 2 #define __FAST_IO_H
Sissors 0:d394ebd01052 3
Sissors 0:d394ebd01052 4 #include "FastIO_LPC1768.h"
Sissors 0:d394ebd01052 5 #include "FastIO_LPC11UXX.h"
Sissors 1:85a4a54f15e3 6 #include "FastIO_LPC81X.h"
Sissors 0:d394ebd01052 7 #include "FastIO_KLXX.h"
Sissors 0:d394ebd01052 8
Sissors 0:d394ebd01052 9 #ifndef INIT_PIN
Sissors 2:1a6ed4b84590 10 #warning Target is not supported by FastIO
Sissors 2:1a6ed4b84590 11 #warning Reverting to regular DigitalInOut
Sissors 2:1a6ed4b84590 12 #include "FastIO_Unsupported.h"
Sissors 0:d394ebd01052 13 #endif
Sissors 0:d394ebd01052 14
Sissors 0:d394ebd01052 15 #include "mbed.h"
Sissors 0:d394ebd01052 16
Sissors 0:d394ebd01052 17 /**
Sissors 0:d394ebd01052 18 * Faster alternative compared to regular DigitalInOut
Sissors 0:d394ebd01052 19 *
Sissors 0:d394ebd01052 20 * Except the constructor it is compatible with regular DigitalInOut.
Sissors 0:d394ebd01052 21 * Code is based on Igor Skochinsky's code (http://mbed.org/users/igorsk/code/FastIO/)
Sissors 0:d394ebd01052 22 */
Sissors 0:d394ebd01052 23 template <PinName pin> class FastInOut
Sissors 0:d394ebd01052 24 {
Sissors 0:d394ebd01052 25 public:
Sissors 0:d394ebd01052 26 /**
Sissors 0:d394ebd01052 27 * Construct new FastInOut object
Sissors 0:d394ebd01052 28 *
Sissors 0:d394ebd01052 29 * @code
Sissors 0:d394ebd01052 30 * FastInOut<LED1> led1;
Sissors 0:d394ebd01052 31 * @endcode
Sissors 0:d394ebd01052 32 *
Sissors 0:d394ebd01052 33 * No initialization is done regarding input/output mode,
Sissors 0:d394ebd01052 34 * FastIn/FastOut can be used if that is required
Sissors 0:d394ebd01052 35 *
Sissors 0:d394ebd01052 36 * @param pin pin the FastOut object should be used for
Sissors 0:d394ebd01052 37 */
Sissors 0:d394ebd01052 38 FastInOut() {
Sissors 0:d394ebd01052 39 INIT_PIN;
Sissors 0:d394ebd01052 40 }
Sissors 2:1a6ed4b84590 41
Sissors 2:1a6ed4b84590 42 ~FastInOut() {
Sissors 2:1a6ed4b84590 43 DESTROY_PIN;
Sissors 2:1a6ed4b84590 44 }
Sissors 0:d394ebd01052 45
Sissors 0:d394ebd01052 46 void write(int value) {
Sissors 0:d394ebd01052 47 if ( value )
Sissors 0:d394ebd01052 48 WRITE_PIN_SET;
Sissors 0:d394ebd01052 49 else
Sissors 0:d394ebd01052 50 WRITE_PIN_CLR;
Sissors 0:d394ebd01052 51 }
Sissors 0:d394ebd01052 52 int read() {
Sissors 0:d394ebd01052 53 return READ_PIN;
Sissors 0:d394ebd01052 54 }
Sissors 0:d394ebd01052 55
Sissors 0:d394ebd01052 56 void mode(PinMode pull) {
Sissors 0:d394ebd01052 57 SET_MODE(pull);
Sissors 0:d394ebd01052 58 }
Sissors 0:d394ebd01052 59
Sissors 0:d394ebd01052 60 void output() {
Sissors 0:d394ebd01052 61 SET_DIR_OUTPUT;
Sissors 0:d394ebd01052 62 }
Sissors 0:d394ebd01052 63
Sissors 0:d394ebd01052 64 void input() {
Sissors 0:d394ebd01052 65 SET_DIR_INPUT;
Sissors 0:d394ebd01052 66 }
Sissors 0:d394ebd01052 67
Sissors 0:d394ebd01052 68 FastInOut& operator= (int value) {
Sissors 0:d394ebd01052 69 write(value);
Sissors 0:d394ebd01052 70 return *this;
Sissors 0:d394ebd01052 71 };
Sissors 0:d394ebd01052 72 FastInOut& operator= (FastInOut& rhs) {
Sissors 0:d394ebd01052 73 return write(rhs.read());
Sissors 0:d394ebd01052 74 };
Sissors 0:d394ebd01052 75 operator int() {
Sissors 0:d394ebd01052 76 return read();
Sissors 0:d394ebd01052 77 };
Sissors 0:d394ebd01052 78
Sissors 0:d394ebd01052 79 private:
Sissors 0:d394ebd01052 80 fastio_vars container;
Sissors 0:d394ebd01052 81 };
Sissors 0:d394ebd01052 82
Sissors 0:d394ebd01052 83 /**
Sissors 0:d394ebd01052 84 * Faster alternative compared to regular DigitalOut
Sissors 0:d394ebd01052 85 *
Sissors 0:d394ebd01052 86 * Except the constructor it is compatible with regular DigitalOut. Aditionally all
Sissors 0:d394ebd01052 87 * functions from DigitalInOut are also available (only initialization is different)
Sissors 0:d394ebd01052 88 * Code is based on Igor Skochinsky's code (http://mbed.org/users/igorsk/code/FastIO/)
Sissors 0:d394ebd01052 89 */
Sissors 0:d394ebd01052 90 template <PinName pin, int initial = 0> class FastOut : public FastInOut<pin>
Sissors 0:d394ebd01052 91 {
Sissors 0:d394ebd01052 92 public:
Sissors 0:d394ebd01052 93 /**
Sissors 0:d394ebd01052 94 * Construct new FastOut object
Sissors 0:d394ebd01052 95 *
Sissors 0:d394ebd01052 96 * @code
Sissors 0:d394ebd01052 97 * FastOut<LED1> led1;
Sissors 0:d394ebd01052 98 * @endcode
Sissors 0:d394ebd01052 99 *
Sissors 0:d394ebd01052 100 * @param pin pin the FastOut object should be used for
Sissors 0:d394ebd01052 101 * @param initial (optional) initial state of the pin after construction: default is 0 (low)
Sissors 0:d394ebd01052 102 */
Sissors 0:d394ebd01052 103 FastOut() {
Sissors 0:d394ebd01052 104 FastInOut<pin>::FastInOut();
Sissors 0:d394ebd01052 105 write(initial);
Sissors 0:d394ebd01052 106 SET_DIR_OUTPUT;
Sissors 0:d394ebd01052 107 }
Sissors 0:d394ebd01052 108
Sissors 0:d394ebd01052 109 FastOut& operator= (int value) {
Sissors 0:d394ebd01052 110 this->write(value);
Sissors 0:d394ebd01052 111 return *this;
Sissors 0:d394ebd01052 112 };
Sissors 0:d394ebd01052 113 FastOut& operator= (FastOut& rhs) {
Sissors 0:d394ebd01052 114 return this->write(rhs.read());
Sissors 0:d394ebd01052 115 };
Sissors 0:d394ebd01052 116 operator int() {
Sissors 0:d394ebd01052 117 return this->read();
Sissors 0:d394ebd01052 118 };
Sissors 0:d394ebd01052 119 };
Sissors 0:d394ebd01052 120
Sissors 0:d394ebd01052 121 /**
Sissors 0:d394ebd01052 122 * Faster alternative compared to regular DigitalIn
Sissors 0:d394ebd01052 123 *
Sissors 0:d394ebd01052 124 * Except the constructor it is compatible with regular DigitalIn. Aditionally all
Sissors 0:d394ebd01052 125 * functions from DigitalInOut are also available (only initialization is different)
Sissors 0:d394ebd01052 126 * Code is based on Igor Skochinsky's code (http://mbed.org/users/igorsk/code/FastIO/)
Sissors 0:d394ebd01052 127 */
Sissors 0:d394ebd01052 128 template <PinName pin, PinMode mode = PullDefault> class FastIn : public FastInOut<pin>
Sissors 0:d394ebd01052 129 {
Sissors 0:d394ebd01052 130 public:
Sissors 0:d394ebd01052 131 /**
Sissors 0:d394ebd01052 132 * Construct new FastIn object
Sissors 0:d394ebd01052 133 *
Sissors 0:d394ebd01052 134 * @code
Sissors 0:d394ebd01052 135 * FastIn<LED1> led1;
Sissors 0:d394ebd01052 136 * @endcode
Sissors 0:d394ebd01052 137 *
Sissors 0:d394ebd01052 138 * @param pin pin the FastIn object should be used for
Sissors 0:d394ebd01052 139 * @param mode (optional) initial mode of the pin after construction: default is PullDefault
Sissors 0:d394ebd01052 140 */
Sissors 0:d394ebd01052 141 FastIn() {
Sissors 0:d394ebd01052 142 FastInOut::FastInOut();
Sissors 0:d394ebd01052 143 SET_MODE(mode);
Sissors 0:d394ebd01052 144 SET_DIR_INPUT;
Sissors 0:d394ebd01052 145 }
Sissors 0:d394ebd01052 146
Sissors 0:d394ebd01052 147 FastIn& operator= (int value) {
Sissors 0:d394ebd01052 148 this->write(value);
Sissors 0:d394ebd01052 149 return *this;
Sissors 0:d394ebd01052 150 };
Sissors 0:d394ebd01052 151 FastIn& operator= (FastIn& rhs) {
Sissors 0:d394ebd01052 152 return this->write(rhs.read());
Sissors 0:d394ebd01052 153 };
Sissors 0:d394ebd01052 154 operator int() {
Sissors 0:d394ebd01052 155 return this->read();
Sissors 0:d394ebd01052 156 };
Sissors 0:d394ebd01052 157 };
Sissors 0:d394ebd01052 158
Sissors 0:d394ebd01052 159 #endif