David Rimer / FastIO

Replacement for regular GPIO (DigitalIn, DigitalOut, DigitalInOut) classes which has superior speed.

Fork of FastIO by Erik -

FastIO.h@18:c95920122b2e, 2015-07-29 (annotated)

Committer:
nameless129
Date:
Wed Jul 29 10:40:07 2015 +0000
Revision:
18:c95920122b2e
Parent:
15:e0c5a5216647
Child:
19:89d6ae484a35
Added LPC11U6x(11U68)

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