james kain / Mbed 2 deprecated GPS_Incremental

JEK changes enabling proper recording of IMU/GPS datastrams - 02-APR-2013

Dependencies:   mbed

Fork of GPS_Incremental by Dan Matthews

MODSERIAL/MODSERIAL.h@9:b45feb91ba38, 2013-04-19 (annotated)

Committer:
jekain314
Date:
Fri Apr 19 16:21:27 2013 +0000
Revision:
9:b45feb91ba38
Parent:
0:c746ee34feae 
update to allow better imu gps data collection

Who changed what in which revision?

UserRevisionLine numberNew contents of line
dannyman939 0:c746ee34feae 1 /*
dannyman939 0:c746ee34feae 2 Copyright (c) 2010 Andy Kirkham
dannyman939 0:c746ee34feae 3
dannyman939 0:c746ee34feae 4 Permission is hereby granted, free of charge, to any person obtaining a copy
dannyman939 0:c746ee34feae 5 of this software and associated documentation files (the "Software"), to deal
dannyman939 0:c746ee34feae 6 in the Software without restriction, including without limitation the rights
dannyman939 0:c746ee34feae 7 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
dannyman939 0:c746ee34feae 8 copies of the Software, and to permit persons to whom the Software is
dannyman939 0:c746ee34feae 9 furnished to do so, subject to the following conditions:
dannyman939 0:c746ee34feae 10
dannyman939 0:c746ee34feae 11 The above copyright notice and this permission notice shall be included in
dannyman939 0:c746ee34feae 12 all copies or substantial portions of the Software.
dannyman939 0:c746ee34feae 13
dannyman939 0:c746ee34feae 14 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
dannyman939 0:c746ee34feae 15 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
dannyman939 0:c746ee34feae 16 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
dannyman939 0:c746ee34feae 17 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
dannyman939 0:c746ee34feae 18 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
dannyman939 0:c746ee34feae 19 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
dannyman939 0:c746ee34feae 20 THE SOFTWARE.
dannyman939 0:c746ee34feae 21
dannyman939 0:c746ee34feae 22 @file MODSERIAL.h
dannyman939 0:c746ee34feae 23 @purpose Extends Serial to provide fully buffered IO
dannyman939 0:c746ee34feae 24 @version see ChangeLog.c
dannyman939 0:c746ee34feae 25 @date Nov 2010
dannyman939 0:c746ee34feae 26 @author Andy Kirkham
dannyman939 0:c746ee34feae 27 */
dannyman939 0:c746ee34feae 28
dannyman939 0:c746ee34feae 29 #ifndef MODSERIAL_H
dannyman939 0:c746ee34feae 30 #define MODSERIAL_H
dannyman939 0:c746ee34feae 31
dannyman939 0:c746ee34feae 32 /** @defgroup API The MODSERIAL API */
dannyman939 0:c746ee34feae 33 /** @defgroup MISC Misc MODSERIAL functions */
dannyman939 0:c746ee34feae 34 /** @defgroup INTERNALS MODSERIAL Internals */
dannyman939 0:c746ee34feae 35
dannyman939 0:c746ee34feae 36 #ifndef MODSERIAL_DEFAULT_RX_BUFFER_SIZE
dannyman939 0:c746ee34feae 37 #define MODSERIAL_DEFAULT_RX_BUFFER_SIZE 256
dannyman939 0:c746ee34feae 38 #endif
dannyman939 0:c746ee34feae 39
dannyman939 0:c746ee34feae 40 #ifndef MODSERIAL_DEFAULT_TX_BUFFER_SIZE
dannyman939 0:c746ee34feae 41 #define MODSERIAL_DEFAULT_TX_BUFFER_SIZE 256
dannyman939 0:c746ee34feae 42 #endif
dannyman939 0:c746ee34feae 43
dannyman939 0:c746ee34feae 44 #include "mbed.h"
dannyman939 0:c746ee34feae 45
dannyman939 0:c746ee34feae 46 namespace AjK {
dannyman939 0:c746ee34feae 47
dannyman939 0:c746ee34feae 48 // Forward reference.
dannyman939 0:c746ee34feae 49 class MODSERIAL;
dannyman939 0:c746ee34feae 50
dannyman939 0:c746ee34feae 51 /**
dannyman939 0:c746ee34feae 52 * @author Andy Kirkham
dannyman939 0:c746ee34feae 53 * @see http://mbed.org/cookbook/MODSERIAL
dannyman939 0:c746ee34feae 54 * @see example3a.cpp
dannyman939 0:c746ee34feae 55 * @see example3b.cpp
dannyman939 0:c746ee34feae 56 * @see API
dannyman939 0:c746ee34feae 57 *
dannyman939 0:c746ee34feae 58 * <b>MODSERIAL_IRQ_INFO</b> is a class used to pass information (and access to protected
dannyman939 0:c746ee34feae 59 * MODSERIAL functions) to IRQ callbacks.
dannyman939 0:c746ee34feae 60 */
dannyman939 0:c746ee34feae 61 class MODSERIAL_IRQ_INFO
dannyman939 0:c746ee34feae 62 {
dannyman939 0:c746ee34feae 63 public:
dannyman939 0:c746ee34feae 64 friend class MODSERIAL;
dannyman939 0:c746ee34feae 65
dannyman939 0:c746ee34feae 66 MODSERIAL *serial;
dannyman939 0:c746ee34feae 67
dannyman939 0:c746ee34feae 68 MODSERIAL_IRQ_INFO() { serial = 0; }
dannyman939 0:c746ee34feae 69
dannyman939 0:c746ee34feae 70 /** rxDiscardLastChar()
dannyman939 0:c746ee34feae 71 *
dannyman939 0:c746ee34feae 72 * Remove the last char placed into the rx buffer.
dannyman939 0:c746ee34feae 73 * This is an operation that can only be performed
dannyman939 0:c746ee34feae 74 * by an rxCallback function.
dannyman939 0:c746ee34feae 75 * @ingroup API
dannyman939 0:c746ee34feae 76 * @return The byte removed from the buffer.
dannyman939 0:c746ee34feae 77 */
dannyman939 0:c746ee34feae 78 int rxDiscardLastChar(void);
dannyman939 0:c746ee34feae 79
dannyman939 0:c746ee34feae 80 protected:
dannyman939 0:c746ee34feae 81
dannyman939 0:c746ee34feae 82 /** setSerial()
dannyman939 0:c746ee34feae 83 *
dannyman939 0:c746ee34feae 84 * Used internally by MODSERIAL to set the "this" pointer
dannyman939 0:c746ee34feae 85 * of the MODSERIAL that created this object.
dannyman939 0:c746ee34feae 86 * @ingroup INTERNAL
dannyman939 0:c746ee34feae 87 * @param A pointer to a MODSERIAL object instance.
dannyman939 0:c746ee34feae 88 */
dannyman939 0:c746ee34feae 89 void setSerial(MODSERIAL *s) { serial = s; }
dannyman939 0:c746ee34feae 90 };
dannyman939 0:c746ee34feae 91
dannyman939 0:c746ee34feae 92 // Forward reference dummy class.
dannyman939 0:c746ee34feae 93 class MODSERIAL_callback_dummy;
dannyman939 0:c746ee34feae 94
dannyman939 0:c746ee34feae 95 /**
dannyman939 0:c746ee34feae 96 * @author Andy Kirkham
dannyman939 0:c746ee34feae 97 * @see http://mbed.org/cookbook/MODSERIAL
dannyman939 0:c746ee34feae 98 * @see example3a.cpp
dannyman939 0:c746ee34feae 99 * @see example3b.cpp
dannyman939 0:c746ee34feae 100 * @see API
dannyman939 0:c746ee34feae 101 *
dannyman939 0:c746ee34feae 102 * <b>MODSERIAL_callback</b> is a class used to hold application callbacks that
dannyman939 0:c746ee34feae 103 * MODSERIAL can invoke on certain events.
dannyman939 0:c746ee34feae 104 */
dannyman939 0:c746ee34feae 105 class MODSERIAL_callback
dannyman939 0:c746ee34feae 106 {
dannyman939 0:c746ee34feae 107 protected:
dannyman939 0:c746ee34feae 108
dannyman939 0:c746ee34feae 109 //! C callback function pointer.
dannyman939 0:c746ee34feae 110 void (*c_callback)(MODSERIAL_IRQ_INFO *);
dannyman939 0:c746ee34feae 111
dannyman939 0:c746ee34feae 112 //! C++ callback object/method pointer (the object part).
dannyman939 0:c746ee34feae 113 MODSERIAL_callback_dummy *obj_callback;
dannyman939 0:c746ee34feae 114
dannyman939 0:c746ee34feae 115 //! C++ callback object/method pointer (the method part).
dannyman939 0:c746ee34feae 116 void (MODSERIAL_callback_dummy::*method_callback)(MODSERIAL_IRQ_INFO *);
dannyman939 0:c746ee34feae 117
dannyman939 0:c746ee34feae 118 public:
dannyman939 0:c746ee34feae 119
dannyman939 0:c746ee34feae 120 /** Constructor
dannyman939 0:c746ee34feae 121 */
dannyman939 0:c746ee34feae 122 MODSERIAL_callback() {
dannyman939 0:c746ee34feae 123 c_callback = 0;
dannyman939 0:c746ee34feae 124 obj_callback = 0;
dannyman939 0:c746ee34feae 125 method_callback = 0;
dannyman939 0:c746ee34feae 126 }
dannyman939 0:c746ee34feae 127
dannyman939 0:c746ee34feae 128 /** attach - Overloaded attachment function.
dannyman939 0:c746ee34feae 129 *
dannyman939 0:c746ee34feae 130 * Attach a C type function pointer as the callback.
dannyman939 0:c746ee34feae 131 *
dannyman939 0:c746ee34feae 132 * Note, the callback function prototype must be:-
dannyman939 0:c746ee34feae 133 * @code
dannyman939 0:c746ee34feae 134 * void myCallbackFunction(MODSERIAL_IRQ_INFO *);
dannyman939 0:c746ee34feae 135 * @endcode
dannyman939 0:c746ee34feae 136 * @param A C function pointer to call.
dannyman939 0:c746ee34feae 137 */
dannyman939 0:c746ee34feae 138 void attach(void (*function)(MODSERIAL_IRQ_INFO *) = 0) { c_callback = function; }
dannyman939 0:c746ee34feae 139
dannyman939 0:c746ee34feae 140 /** attach - Overloaded attachment function.
dannyman939 0:c746ee34feae 141 *
dannyman939 0:c746ee34feae 142 * Attach a C++ type object/method pointer as the callback.
dannyman939 0:c746ee34feae 143 *
dannyman939 0:c746ee34feae 144 * Note, the callback method prototype must be:-
dannyman939 0:c746ee34feae 145 * @code
dannyman939 0:c746ee34feae 146 * public:
dannyman939 0:c746ee34feae 147 * void myCallbackFunction(MODSERIAL_IRQ_INFO *);
dannyman939 0:c746ee34feae 148 * @endcode
dannyman939 0:c746ee34feae 149 * @param A C++ object pointer.
dannyman939 0:c746ee34feae 150 * @param A C++ method within the object to call.
dannyman939 0:c746ee34feae 151 */
dannyman939 0:c746ee34feae 152 template<class T>
dannyman939 0:c746ee34feae 153 void attach(T* item, void (T::*method)(MODSERIAL_IRQ_INFO *)) {
dannyman939 0:c746ee34feae 154 obj_callback = (MODSERIAL_callback_dummy *)item;
dannyman939 0:c746ee34feae 155 method_callback = (void (MODSERIAL_callback_dummy::*)(MODSERIAL_IRQ_INFO *))method;
dannyman939 0:c746ee34feae 156 }
dannyman939 0:c746ee34feae 157
dannyman939 0:c746ee34feae 158 /** call - Overloaded callback initiator.
dannyman939 0:c746ee34feae 159 *
dannyman939 0:c746ee34feae 160 * call the callback function.
dannyman939 0:c746ee34feae 161 *
dannyman939 0:c746ee34feae 162 * @param A pointer to a MODSERIAL_IRQ_INFO object.
dannyman939 0:c746ee34feae 163 */
dannyman939 0:c746ee34feae 164 void call(MODSERIAL_IRQ_INFO *arg) {
dannyman939 0:c746ee34feae 165 if (c_callback != 0) {
dannyman939 0:c746ee34feae 166 (*c_callback)(arg);
dannyman939 0:c746ee34feae 167 }
dannyman939 0:c746ee34feae 168 else {
dannyman939 0:c746ee34feae 169 if (obj_callback != 0 && method_callback != 0) {
dannyman939 0:c746ee34feae 170 (obj_callback->*method_callback)(arg);
dannyman939 0:c746ee34feae 171 }
dannyman939 0:c746ee34feae 172 }
dannyman939 0:c746ee34feae 173 }
dannyman939 0:c746ee34feae 174 };
dannyman939 0:c746ee34feae 175
dannyman939 0:c746ee34feae 176 /**
dannyman939 0:c746ee34feae 177 * @author Andy Kirkham
dannyman939 0:c746ee34feae 178 * @see http://mbed.org/cookbook/MODSERIAL
dannyman939 0:c746ee34feae 179 * @see http://mbed.org/handbook/Serial
dannyman939 0:c746ee34feae 180 * @see example1.cpp
dannyman939 0:c746ee34feae 181 * @see example2.cpp
dannyman939 0:c746ee34feae 182 * @see example3a.cpp
dannyman939 0:c746ee34feae 183 * @see example3b.cpp
dannyman939 0:c746ee34feae 184 * @see example_dma.cpp
dannyman939 0:c746ee34feae 185 * @see API
dannyman939 0:c746ee34feae 186 *
dannyman939 0:c746ee34feae 187 * <b>MODSERIAL</b> extends the Mbed library <a href="/handbook/Serial">Serial</a> to provide fully buffered
dannyman939 0:c746ee34feae 188 * TX and RX streams. Buffer length is fully customisable.
dannyman939 0:c746ee34feae 189 *
dannyman939 0:c746ee34feae 190 * Before using MODSERIAL users should be familar with Mbed's standard <a href="/handbook/Serial">Serial</a>
dannyman939 0:c746ee34feae 191 * library object. MODSERIAL is a direct "drop in" replacement for <a href="/handbook/Serial">Serial</a>. Where
dannyman939 0:c746ee34feae 192 * previously Serial was used, MODSERIAL can be used as adirect replacement instantly offering standard
dannyman939 0:c746ee34feae 193 * TX and RX buffering. By default, both TX and RX buffers are 256 bytes in length.
dannyman939 0:c746ee34feae 194 *
dannyman939 0:c746ee34feae 195 * @image html /media/uploads/mbedofficial/serial_interfaces.png
dannyman939 0:c746ee34feae 196 *
dannyman939 0:c746ee34feae 197 * Standard example:
dannyman939 0:c746ee34feae 198 * @code
dannyman939 0:c746ee34feae 199 * #include "mbed.h"
dannyman939 0:c746ee34feae 200 * #include "MODSERIAL.h"
dannyman939 0:c746ee34feae 201 *
dannyman939 0:c746ee34feae 202 * MODSERIAL pc(USBTX, USBRX); // tx, rx
dannyman939 0:c746ee34feae 203 *
dannyman939 0:c746ee34feae 204 * int main() {
dannyman939 0:c746ee34feae 205 * pc.printf("Hello World!");
dannyman939 0:c746ee34feae 206 * while(1) {
dannyman939 0:c746ee34feae 207 * pc.putc(pc.getc() + 1);
dannyman939 0:c746ee34feae 208 * }
dannyman939 0:c746ee34feae 209 * }
dannyman939 0:c746ee34feae 210 * @endcode
dannyman939 0:c746ee34feae 211 *
dannyman939 0:c746ee34feae 212 * Example with alternate buffer length:
dannyman939 0:c746ee34feae 213 * @code
dannyman939 0:c746ee34feae 214 * #include "mbed.h"
dannyman939 0:c746ee34feae 215 * #include "MODSERIAL.h"
dannyman939 0:c746ee34feae 216 *
dannyman939 0:c746ee34feae 217 * // Make TX and RX buffers 512byes in length
dannyman939 0:c746ee34feae 218 * MODSERIAL pc(USBTX, USBRX, 512); // tx, rx
dannyman939 0:c746ee34feae 219 *
dannyman939 0:c746ee34feae 220 * int main() {
dannyman939 0:c746ee34feae 221 * pc.printf("Hello World!");
dannyman939 0:c746ee34feae 222 * while(1) {
dannyman939 0:c746ee34feae 223 * pc.putc(pc.getc() + 1);
dannyman939 0:c746ee34feae 224 * }
dannyman939 0:c746ee34feae 225 * }
dannyman939 0:c746ee34feae 226 * @endcode
dannyman939 0:c746ee34feae 227 *
dannyman939 0:c746ee34feae 228 * Example with alternate buffer length:
dannyman939 0:c746ee34feae 229 * @code
dannyman939 0:c746ee34feae 230 * #include "mbed.h"
dannyman939 0:c746ee34feae 231 * #include "MODSERIAL.h"
dannyman939 0:c746ee34feae 232 *
dannyman939 0:c746ee34feae 233 * // Make TX 1024bytes and RX 512byes in length
dannyman939 0:c746ee34feae 234 * MODSERIAL pc(USBTX, USBRX, 1024, 512); // tx, rx
dannyman939 0:c746ee34feae 235 *
dannyman939 0:c746ee34feae 236 * int main() {
dannyman939 0:c746ee34feae 237 * pc.printf("Hello World!");
dannyman939 0:c746ee34feae 238 * while(1) {
dannyman939 0:c746ee34feae 239 * pc.putc(pc.getc() + 1);
dannyman939 0:c746ee34feae 240 * }
dannyman939 0:c746ee34feae 241 * }
dannyman939 0:c746ee34feae 242 * @endcode
dannyman939 0:c746ee34feae 243 */
dannyman939 0:c746ee34feae 244 class MODSERIAL : public Serial
dannyman939 0:c746ee34feae 245 {
dannyman939 0:c746ee34feae 246 public:
dannyman939 0:c746ee34feae 247
dannyman939 0:c746ee34feae 248 // Allow instances of MODSERIAL_IRQ_INFO to use protected properties and methods.
dannyman939 0:c746ee34feae 249 friend class MODSERIAL_IRQ_INFO;
dannyman939 0:c746ee34feae 250
dannyman939 0:c746ee34feae 251 //! A copy of the Serial parity enum
dannyman939 0:c746ee34feae 252 /** @see http://mbed.org/projects/libraries/api/mbed/trunk/Serial#Serial.format */
dannyman939 0:c746ee34feae 253 enum Parity {
dannyman939 0:c746ee34feae 254 None = 0
dannyman939 0:c746ee34feae 255 , Odd
dannyman939 0:c746ee34feae 256 , Even
dannyman939 0:c746ee34feae 257 , Forced1
dannyman939 0:c746ee34feae 258 , Forced0
dannyman939 0:c746ee34feae 259 };
dannyman939 0:c746ee34feae 260
dannyman939 0:c746ee34feae 261 //! A copy of the Serial IrqType enum
dannyman939 0:c746ee34feae 262 enum IrqType {
dannyman939 0:c746ee34feae 263 RxIrq = 0
dannyman939 0:c746ee34feae 264 , TxIrq
dannyman939 0:c746ee34feae 265 , RxOvIrq
dannyman939 0:c746ee34feae 266 , TxOvIrq
dannyman939 0:c746ee34feae 267 , TxEmpty
dannyman939 0:c746ee34feae 268 , RxAutoDetect
dannyman939 0:c746ee34feae 269 , NumOfIrqTypes
dannyman939 0:c746ee34feae 270 };
dannyman939 0:c746ee34feae 271
dannyman939 0:c746ee34feae 272 //! Non-blocking functions return code.
dannyman939 0:c746ee34feae 273 enum Result {
dannyman939 0:c746ee34feae 274 Ok = 0 /*!< Ok. */
dannyman939 0:c746ee34feae 275 , NoMemory = -1 /*!< Memory allocation failed. */
dannyman939 0:c746ee34feae 276 , NoChar = -1 /*!< No character in buffer. */
dannyman939 0:c746ee34feae 277 , BufferOversize = -2 /*!< Oversized buffer. */
dannyman939 0:c746ee34feae 278 };
dannyman939 0:c746ee34feae 279
dannyman939 0:c746ee34feae 280 /**
dannyman939 0:c746ee34feae 281 * The MODSERIAL constructor is used to initialise the serial object.
dannyman939 0:c746ee34feae 282 *
dannyman939 0:c746ee34feae 283 * @param tx PinName of the TX pin.
dannyman939 0:c746ee34feae 284 * @param rx PinName of the TX pin.
dannyman939 0:c746ee34feae 285 * @param name An option name for RPC usage.
dannyman939 0:c746ee34feae 286 */
dannyman939 0:c746ee34feae 287 MODSERIAL(PinName tx, PinName rx, const char *name = NULL);
dannyman939 0:c746ee34feae 288
dannyman939 0:c746ee34feae 289 /**
dannyman939 0:c746ee34feae 290 * The MODSERIAL constructor is used to initialise the serial object.
dannyman939 0:c746ee34feae 291 *
dannyman939 0:c746ee34feae 292 * @param tx PinName of the TX pin.
dannyman939 0:c746ee34feae 293 * @param rx PinName of the TX pin.
dannyman939 0:c746ee34feae 294 * @param bufferSize Integer of the TX and RX buffer sizes.
dannyman939 0:c746ee34feae 295 * @param name An option name for RPC usage.
dannyman939 0:c746ee34feae 296 */
dannyman939 0:c746ee34feae 297 MODSERIAL(PinName tx, PinName rx, int bufferSize, const char *name = NULL);
dannyman939 0:c746ee34feae 298
dannyman939 0:c746ee34feae 299 /**
dannyman939 0:c746ee34feae 300 * The MODSERIAL constructor is used to initialise the serial object.
dannyman939 0:c746ee34feae 301 *
dannyman939 0:c746ee34feae 302 * @param tx PinName of the TX pin.
dannyman939 0:c746ee34feae 303 * @param rx PinName of the TX pin.
dannyman939 0:c746ee34feae 304 * @param txBufferSize Integer of the TX buffer sizes.
dannyman939 0:c746ee34feae 305 * @param rxBufferSize Integer of the RX buffer sizes.
dannyman939 0:c746ee34feae 306 * @param name An option name for RPC usage.
dannyman939 0:c746ee34feae 307 */
dannyman939 0:c746ee34feae 308 MODSERIAL(PinName tx, PinName rx, int txBufferSize, int rxBufferSize, const char *name = NULL);
dannyman939 0:c746ee34feae 309
dannyman939 0:c746ee34feae 310 virtual ~MODSERIAL();
dannyman939 0:c746ee34feae 311
dannyman939 0:c746ee34feae 312 /**
dannyman939 0:c746ee34feae 313 * Function: attach
dannyman939 0:c746ee34feae 314 *
dannyman939 0:c746ee34feae 315 * The Mbed standard <a href="/handbook/Serial">Serial</a> library object allows an interrupt callback
dannyman939 0:c746ee34feae 316 * to be made when a byte is received by the TX or RX UART hardware. MODSERIAL traps these interrupts
dannyman939 0:c746ee34feae 317 * to enable it's buffering system. However, after the byte has been received/sent under interrupt control,
dannyman939 0:c746ee34feae 318 * MODSERIAL can callback a user function as a notification of the interrupt. Note, user code should not
dannyman939 0:c746ee34feae 319 * directly interact with the Uart hardware, MODSERIAL does that, instead, MODSERIAL API functions should
dannyman939 0:c746ee34feae 320 * be used.
dannyman939 0:c746ee34feae 321 *
dannyman939 0:c746ee34feae 322 * <b>Note</b>, a character is written out then, if there is room in the TX FIFO and the TX buffer is empty,
dannyman939 0:c746ee34feae 323 * putc() will put the character directly into THR (the output holding register). If the TX FIFO is full and
dannyman939 0:c746ee34feae 324 * cannot accept the character, it is placed into the TX output buffer. The TX interrupts are then enabled
dannyman939 0:c746ee34feae 325 * so that when the TX FIFO empties, the TX buffer is then transferred to the THR FIFO. The TxIrq will ONLY
dannyman939 0:c746ee34feae 326 * be activated when this transfer of a character from BUFFER to THR FIFO takes place. If your character
dannyman939 0:c746ee34feae 327 * throughput is not high bandwidth, then the 16 byte TX FIFO may be enough and the TX output buffer may
dannyman939 0:c746ee34feae 328 * never come into play.
dannyman939 0:c746ee34feae 329 *
dannyman939 0:c746ee34feae 330 * @code
dannyman939 0:c746ee34feae 331 * #include "mbed.h"
dannyman939 0:c746ee34feae 332 * #include "MODSERIAL.h"
dannyman939 0:c746ee34feae 333 *
dannyman939 0:c746ee34feae 334 * DigitalOut led1(LED1);
dannyman939 0:c746ee34feae 335 * DigitalOut led2(LED2);
dannyman939 0:c746ee34feae 336 * DigitalOut led3(LED3);
dannyman939 0:c746ee34feae 337 *
dannyman939 0:c746ee34feae 338 * // To test, connect p9 to p10 as a loopback.
dannyman939 0:c746ee34feae 339 * MODSERIAL pc(p9, p10);
dannyman939 0:c746ee34feae 340 *
dannyman939 0:c746ee34feae 341 * // This function is called when a character goes into the TX buffer.
dannyman939 0:c746ee34feae 342 * void txCallback(void) {
dannyman939 0:c746ee34feae 343 * led2 = !led2;
dannyman939 0:c746ee34feae 344 * }
dannyman939 0:c746ee34feae 345 *
dannyman939 0:c746ee34feae 346 * // This function is called when a character goes into the RX buffer.
dannyman939 0:c746ee34feae 347 * void rxCallback(void) {
dannyman939 0:c746ee34feae 348 * led3 = !led3;
dannyman939 0:c746ee34feae 349 * }
dannyman939 0:c746ee34feae 350 *
dannyman939 0:c746ee34feae 351 * int main() {
dannyman939 0:c746ee34feae 352 * pc.baud(115200);
dannyman939 0:c746ee34feae 353 * pc.attach(&txCallback, MODSERIAL::TxIrq);
dannyman939 0:c746ee34feae 354 * pc.attach(&rxCallback, MODSERIAL::RxIrq);
dannyman939 0:c746ee34feae 355 *
dannyman939 0:c746ee34feae 356 * while(1) {
dannyman939 0:c746ee34feae 357 * led1 = !led1;
dannyman939 0:c746ee34feae 358 * wait(0.5);
dannyman939 0:c746ee34feae 359 * pc.putc('A');
dannyman939 0:c746ee34feae 360 * wait(0.5);
dannyman939 0:c746ee34feae 361 * }
dannyman939 0:c746ee34feae 362 * ]
dannyman939 0:c746ee34feae 363 * @endcode
dannyman939 0:c746ee34feae 364 *
dannyman939 0:c746ee34feae 365 * @ingroup API
dannyman939 0:c746ee34feae 366 * @param fptr A pointer to a void function, or 0 to set as none
dannyman939 0:c746ee34feae 367 * @param type Which serial interrupt to attach the member function to (Seriall::RxIrq for receive, TxIrq for transmit buffer empty)
dannyman939 0:c746ee34feae 368 */
dannyman939 0:c746ee34feae 369 void attach(void (*fptr)(MODSERIAL_IRQ_INFO *), IrqType type = RxIrq) { _isr[type].attach(fptr); }
dannyman939 0:c746ee34feae 370
dannyman939 0:c746ee34feae 371 /**
dannyman939 0:c746ee34feae 372 * Function: attach
dannyman939 0:c746ee34feae 373 *
dannyman939 0:c746ee34feae 374 * The Mbed standard <a href="/handbook/Serial">Serial</a> library object allows an interrupt callback
dannyman939 0:c746ee34feae 375 * to be made when a byte is received by the TX or RX UART hardware. MODSERIAL traps these interrupts
dannyman939 0:c746ee34feae 376 * to enable it's buffering system. However, after the byte has been received/sent under interrupt control,
dannyman939 0:c746ee34feae 377 * MODSERIAL can callback a user function as a notification of the interrupt. Note, user code should not
dannyman939 0:c746ee34feae 378 * directly interact with the Uart hardware, MODSERIAL does that, instead, MODSERIAL API functions should
dannyman939 0:c746ee34feae 379 * be used.
dannyman939 0:c746ee34feae 380 *
dannyman939 0:c746ee34feae 381 * <b>Note</b>, a character is written out then, if there is room in the TX FIFO and the TX buffer is empty,
dannyman939 0:c746ee34feae 382 * putc() will put the character directly into THR (the output holding register). If the TX FIFO is full and
dannyman939 0:c746ee34feae 383 * cannot accept the character, it is placed into the TX output buffer. The TX interrupts are then enabled
dannyman939 0:c746ee34feae 384 * so that when the TX FIFO empties, the TX buffer is then transferred to the THR FIFO. The TxIrq will ONLY
dannyman939 0:c746ee34feae 385 * be activated when this transfer of a character from BUFFER to THR FIFO takes place. If your character
dannyman939 0:c746ee34feae 386 * throughput is not high bandwidth, then the 16 byte TX FIFO may be enough and the TX output buffer may
dannyman939 0:c746ee34feae 387 * never come into play.
dannyman939 0:c746ee34feae 388 *
dannyman939 0:c746ee34feae 389 * @code
dannyman939 0:c746ee34feae 390 * #include "mbed.h"
dannyman939 0:c746ee34feae 391 * #include "MODSERIAL.h"
dannyman939 0:c746ee34feae 392 *
dannyman939 0:c746ee34feae 393 * DigitalOut led1(LED1);
dannyman939 0:c746ee34feae 394 * DigitalOut led2(LED2);
dannyman939 0:c746ee34feae 395 * DigitalOut led3(LED3);
dannyman939 0:c746ee34feae 396 *
dannyman939 0:c746ee34feae 397 * // To test, connect p9 to p10 as a loopback.
dannyman939 0:c746ee34feae 398 * MODSERIAL pc(p9, p10);
dannyman939 0:c746ee34feae 399 *
dannyman939 0:c746ee34feae 400 * class Foo {
dannyman939 0:c746ee34feae 401 * public:
dannyman939 0:c746ee34feae 402 * // This method is called when a character goes into the TX buffer.
dannyman939 0:c746ee34feae 403 * void txCallback(void) { led2 = !led2; }
dannyman939 0:c746ee34feae 404 *
dannyman939 0:c746ee34feae 405 * // This method is called when a character goes into the RX buffer.
dannyman939 0:c746ee34feae 406 * void rxCallback(void) { led3 = !led3; }
dannyman939 0:c746ee34feae 407 * };
dannyman939 0:c746ee34feae 408 *
dannyman939 0:c746ee34feae 409 * Foo foo;
dannyman939 0:c746ee34feae 410 *
dannyman939 0:c746ee34feae 411 * int main() {
dannyman939 0:c746ee34feae 412 * pc.baud(115200);
dannyman939 0:c746ee34feae 413 * pc.attach(&foo, &Foo::txCallback, MODSERIAL::TxIrq);
dannyman939 0:c746ee34feae 414 * pc.attach(&foo, &Foo::rxCallback, MODSERIAL::RxIrq);
dannyman939 0:c746ee34feae 415 *
dannyman939 0:c746ee34feae 416 * while(1) {
dannyman939 0:c746ee34feae 417 * led1 = !led1;
dannyman939 0:c746ee34feae 418 * wait(0.5);
dannyman939 0:c746ee34feae 419 * pc.putc('A');
dannyman939 0:c746ee34feae 420 * wait(0.5);
dannyman939 0:c746ee34feae 421 * }
dannyman939 0:c746ee34feae 422 * ]
dannyman939 0:c746ee34feae 423 * @endcode
dannyman939 0:c746ee34feae 424 *
dannyman939 0:c746ee34feae 425 * @ingroup API
dannyman939 0:c746ee34feae 426 * @param tptr A pointer to the object to call the member function on
dannyman939 0:c746ee34feae 427 * @param mptr A pointer to the member function to be called
dannyman939 0:c746ee34feae 428 * @param type Which serial interrupt to attach the member function to (Seriall::RxIrq for receive, TxIrq for transmit buffer empty)
dannyman939 0:c746ee34feae 429 */
dannyman939 0:c746ee34feae 430 template<typename T>
dannyman939 0:c746ee34feae 431 void attach(T* tptr, void (T::*mptr)(MODSERIAL_IRQ_INFO *), IrqType type = RxIrq) {
dannyman939 0:c746ee34feae 432 if((mptr != 0) && (tptr != 0)) {
dannyman939 0:c746ee34feae 433 _isr[type].attach(tptr, mptr);
dannyman939 0:c746ee34feae 434 }
dannyman939 0:c746ee34feae 435 }
dannyman939 0:c746ee34feae 436
dannyman939 0:c746ee34feae 437 /**
dannyman939 0:c746ee34feae 438 * @see attach
dannyman939 0:c746ee34feae 439 * @ingroup API
dannyman939 0:c746ee34feae 440 */
dannyman939 0:c746ee34feae 441 void connect(void (*fptr)(MODSERIAL_IRQ_INFO *), IrqType type = RxIrq) { _isr[RxIrq].attach(fptr); }
dannyman939 0:c746ee34feae 442
dannyman939 0:c746ee34feae 443 /**
dannyman939 0:c746ee34feae 444 * @see attach
dannyman939 0:c746ee34feae 445 * @ingroup API
dannyman939 0:c746ee34feae 446 */
dannyman939 0:c746ee34feae 447 template<typename T>
dannyman939 0:c746ee34feae 448 void connect(T* tptr, void (T::*mptr)(MODSERIAL_IRQ_INFO *), IrqType type = RxIrq) {
dannyman939 0:c746ee34feae 449 if((mptr != 0) && (tptr != 0)) {
dannyman939 0:c746ee34feae 450 _isr[type].attach(tptr, mptr);
dannyman939 0:c746ee34feae 451 }
dannyman939 0:c746ee34feae 452 }
dannyman939 0:c746ee34feae 453
dannyman939 0:c746ee34feae 454 /**
dannyman939 0:c746ee34feae 455 * Function: writeable
dannyman939 0:c746ee34feae 456 *
dannyman939 0:c746ee34feae 457 * Determine if there is space available to write a byte
dannyman939 0:c746ee34feae 458 *
dannyman939 0:c746ee34feae 459 * @ingroup API
dannyman939 0:c746ee34feae 460 * @return 1 if there is space to write a character, else 0
dannyman939 0:c746ee34feae 461 */
dannyman939 0:c746ee34feae 462 int writeable() { return txBufferFull() ? 0 : 1; }
dannyman939 0:c746ee34feae 463
dannyman939 0:c746ee34feae 464 /**
dannyman939 0:c746ee34feae 465 * Function: readable
dannyman939 0:c746ee34feae 466 *
dannyman939 0:c746ee34feae 467 * Determine if there is a byte available to read
dannyman939 0:c746ee34feae 468 *
dannyman939 0:c746ee34feae 469 * @ingroup API
dannyman939 0:c746ee34feae 470 * @return 1 if there is a character available to read, else 0
dannyman939 0:c746ee34feae 471 */
dannyman939 0:c746ee34feae 472 int readable() { return rxBufferEmpty() ? 0 : 1; }
dannyman939 0:c746ee34feae 473
dannyman939 0:c746ee34feae 474 /**
dannyman939 0:c746ee34feae 475 * Function: txBufferSane
dannyman939 0:c746ee34feae 476 *
dannyman939 0:c746ee34feae 477 * Determine if the TX buffer has been initialized.
dannyman939 0:c746ee34feae 478 *
dannyman939 0:c746ee34feae 479 * @ingroup API
dannyman939 0:c746ee34feae 480 * @return true if the buffer is initialized, else false
dannyman939 0:c746ee34feae 481 */
dannyman939 0:c746ee34feae 482 bool txBufferSane(void) { return buffer[TxIrq] != (char *)NULL ? true : false; }
dannyman939 0:c746ee34feae 483
dannyman939 0:c746ee34feae 484 /**
dannyman939 0:c746ee34feae 485 * Function: rxBufferSane
dannyman939 0:c746ee34feae 486 *
dannyman939 0:c746ee34feae 487 * Determine if the RX buffer has been initialized.
dannyman939 0:c746ee34feae 488 *
dannyman939 0:c746ee34feae 489 * @ingroup API
dannyman939 0:c746ee34feae 490 * @return true if the buffer is initialized, else false
dannyman939 0:c746ee34feae 491 */
dannyman939 0:c746ee34feae 492 bool rxBufferSane(void) { return buffer[TxIrq] != (char *)NULL ? true : false; }
dannyman939 0:c746ee34feae 493
dannyman939 0:c746ee34feae 494 /**
dannyman939 0:c746ee34feae 495 * Function: txBufferGetCount
dannyman939 0:c746ee34feae 496 *
dannyman939 0:c746ee34feae 497 * Returns how many bytes are in the TX buffer
dannyman939 0:c746ee34feae 498 *
dannyman939 0:c746ee34feae 499 * @ingroup API
dannyman939 0:c746ee34feae 500 * @return The number of bytes in the TX buffer
dannyman939 0:c746ee34feae 501 */
dannyman939 0:c746ee34feae 502 int txBufferGetCount(void) { return buffer_count[TxIrq]; }
dannyman939 0:c746ee34feae 503
dannyman939 0:c746ee34feae 504 /**
dannyman939 0:c746ee34feae 505 * Function: rxBufferGetCount
dannyman939 0:c746ee34feae 506 *
dannyman939 0:c746ee34feae 507 * Returns how many bytes are in the RX buffer
dannyman939 0:c746ee34feae 508 *
dannyman939 0:c746ee34feae 509 * @ingroup API
dannyman939 0:c746ee34feae 510 * @return The number of bytes in the RX buffer
dannyman939 0:c746ee34feae 511 */
dannyman939 0:c746ee34feae 512 int rxBufferGetCount(void) { return buffer_count[RxIrq]; }
dannyman939 0:c746ee34feae 513
dannyman939 0:c746ee34feae 514 /**
dannyman939 0:c746ee34feae 515 * Function: txBufferGetSize
dannyman939 0:c746ee34feae 516 *
dannyman939 0:c746ee34feae 517 * Returns the current size of the TX buffer
dannyman939 0:c746ee34feae 518 *
dannyman939 0:c746ee34feae 519 * @ingroup API
dannyman939 0:c746ee34feae 520 * @return The length iof the TX buffer in bytes
dannyman939 0:c746ee34feae 521 */
dannyman939 0:c746ee34feae 522 int txBufferGetSize(int size) { return buffer_size[TxIrq]; }
dannyman939 0:c746ee34feae 523
dannyman939 0:c746ee34feae 524 /**
dannyman939 0:c746ee34feae 525 * Function: rxBufferGetSize
dannyman939 0:c746ee34feae 526 *
dannyman939 0:c746ee34feae 527 * Returns the current size of the RX buffer
dannyman939 0:c746ee34feae 528 *
dannyman939 0:c746ee34feae 529 * @ingroup API
dannyman939 0:c746ee34feae 530 * @return The length iof the RX buffer in bytes
dannyman939 0:c746ee34feae 531 */
dannyman939 0:c746ee34feae 532 int rxBufferGetSize(int size) { return buffer_size[RxIrq]; }
dannyman939 0:c746ee34feae 533
dannyman939 0:c746ee34feae 534 /**
dannyman939 0:c746ee34feae 535 * Function: txBufferFull
dannyman939 0:c746ee34feae 536 *
dannyman939 0:c746ee34feae 537 * Is the TX buffer full?
dannyman939 0:c746ee34feae 538 *
dannyman939 0:c746ee34feae 539 * @ingroup API
dannyman939 0:c746ee34feae 540 * @return true if the TX buffer is full, otherwise false
dannyman939 0:c746ee34feae 541 */
dannyman939 0:c746ee34feae 542 bool txBufferFull(void);
dannyman939 0:c746ee34feae 543
dannyman939 0:c746ee34feae 544 /**
dannyman939 0:c746ee34feae 545 * Function: rxBufferFull
dannyman939 0:c746ee34feae 546 *
dannyman939 0:c746ee34feae 547 * Is the RX buffer full?
dannyman939 0:c746ee34feae 548 *
dannyman939 0:c746ee34feae 549 * @ingroup API
dannyman939 0:c746ee34feae 550 * @return true if the RX buffer is full, otherwise false
dannyman939 0:c746ee34feae 551 */
dannyman939 0:c746ee34feae 552 bool rxBufferFull(void);
dannyman939 0:c746ee34feae 553
dannyman939 0:c746ee34feae 554 /**
dannyman939 0:c746ee34feae 555 * Function: txBufferEmpty
dannyman939 0:c746ee34feae 556 *
dannyman939 0:c746ee34feae 557 * Is the TX buffer empty?
dannyman939 0:c746ee34feae 558 *
dannyman939 0:c746ee34feae 559 * @ingroup API
dannyman939 0:c746ee34feae 560 * @return true if the TX buffer is empty, otherwise false
dannyman939 0:c746ee34feae 561 */
dannyman939 0:c746ee34feae 562 bool txBufferEmpty(void);
dannyman939 0:c746ee34feae 563
dannyman939 0:c746ee34feae 564 /**
dannyman939 0:c746ee34feae 565 * Function: rxBufferEmpty
dannyman939 0:c746ee34feae 566 *
dannyman939 0:c746ee34feae 567 * Is the RX buffer empty?
dannyman939 0:c746ee34feae 568 *
dannyman939 0:c746ee34feae 569 * @ingroup API
dannyman939 0:c746ee34feae 570 * @return true if the RX buffer is empty, otherwise false
dannyman939 0:c746ee34feae 571 */
dannyman939 0:c746ee34feae 572 bool rxBufferEmpty(void);
dannyman939 0:c746ee34feae 573
dannyman939 0:c746ee34feae 574 /**
dannyman939 0:c746ee34feae 575 * Function: txBufferSetSize
dannyman939 0:c746ee34feae 576 *
dannyman939 0:c746ee34feae 577 * Change the TX buffer size.
dannyman939 0:c746ee34feae 578 *
dannyman939 0:c746ee34feae 579 * @see Result
dannyman939 0:c746ee34feae 580 * @ingroup API
dannyman939 0:c746ee34feae 581 * @param size The new TX buffer size in bytes.
dannyman939 0:c746ee34feae 582 * @param m Perform a memory sanity check. Errs the Mbed if memory alloc fails.
dannyman939 0:c746ee34feae 583 * @return Result Ok on success.
dannyman939 0:c746ee34feae 584 */
dannyman939 0:c746ee34feae 585 int txBufferSetSize(int size, bool m) { return resizeBuffer(size, TxIrq, m); }
dannyman939 0:c746ee34feae 586
dannyman939 0:c746ee34feae 587 /**
dannyman939 0:c746ee34feae 588 * Function: rxBufferSetSize
dannyman939 0:c746ee34feae 589 *
dannyman939 0:c746ee34feae 590 * Change the RX buffer size.
dannyman939 0:c746ee34feae 591 *
dannyman939 0:c746ee34feae 592 * @see Result
dannyman939 0:c746ee34feae 593 * @ingroup API
dannyman939 0:c746ee34feae 594 * @param size The new RX buffer size in bytes.
dannyman939 0:c746ee34feae 595 * @param m Perform a memory sanity check. Errs the Mbed if memory alloc fails.
dannyman939 0:c746ee34feae 596 * @return Result Ok on success.
dannyman939 0:c746ee34feae 597 */
dannyman939 0:c746ee34feae 598 int rxBufferSetSize(int size, bool m) { return resizeBuffer(size, RxIrq, m); }
dannyman939 0:c746ee34feae 599
dannyman939 0:c746ee34feae 600 /**
dannyman939 0:c746ee34feae 601 * Function: txBufferSetSize
dannyman939 0:c746ee34feae 602 *
dannyman939 0:c746ee34feae 603 * Change the TX buffer size.
dannyman939 0:c746ee34feae 604 * Always performs a memory sanity check, halting the Mbed on failure.
dannyman939 0:c746ee34feae 605 *
dannyman939 0:c746ee34feae 606 * @see Result
dannyman939 0:c746ee34feae 607 * @ingroup API
dannyman939 0:c746ee34feae 608 * @param size The new TX buffer size in bytes.
dannyman939 0:c746ee34feae 609 * @return Result Ok on success.
dannyman939 0:c746ee34feae 610 */
dannyman939 0:c746ee34feae 611 int txBufferSetSize(int size) { return resizeBuffer(size, TxIrq, true); }
dannyman939 0:c746ee34feae 612
dannyman939 0:c746ee34feae 613 /**
dannyman939 0:c746ee34feae 614 * Function: rxBufferSetSize
dannyman939 0:c746ee34feae 615 *
dannyman939 0:c746ee34feae 616 * Change the RX buffer size.
dannyman939 0:c746ee34feae 617 * Always performs a memory sanity check, halting the Mbed on failure.
dannyman939 0:c746ee34feae 618 *
dannyman939 0:c746ee34feae 619 * @see Result
dannyman939 0:c746ee34feae 620 * @ingroup API
dannyman939 0:c746ee34feae 621 * @param size The new RX buffer size in bytes.
dannyman939 0:c746ee34feae 622 * @return Result Ok on success.
dannyman939 0:c746ee34feae 623 */
dannyman939 0:c746ee34feae 624 int rxBufferSetSize(int size) { return resizeBuffer(size, RxIrq, true); }
dannyman939 0:c746ee34feae 625
dannyman939 0:c746ee34feae 626 /**
dannyman939 0:c746ee34feae 627 * Function: txBufferFlush
dannyman939 0:c746ee34feae 628 *
dannyman939 0:c746ee34feae 629 * Remove all bytes from the TX buffer.
dannyman939 0:c746ee34feae 630 * @ingroup API
dannyman939 0:c746ee34feae 631 */
dannyman939 0:c746ee34feae 632 void txBufferFlush(void) { flushBuffer(TxIrq); }
dannyman939 0:c746ee34feae 633
dannyman939 0:c746ee34feae 634 /**
dannyman939 0:c746ee34feae 635 * Function: rxBufferFlush
dannyman939 0:c746ee34feae 636 *
dannyman939 0:c746ee34feae 637 * Remove all bytes from the RX buffer.
dannyman939 0:c746ee34feae 638 * @ingroup API
dannyman939 0:c746ee34feae 639 */
dannyman939 0:c746ee34feae 640 void rxBufferFlush(void) { flushBuffer(RxIrq); }
dannyman939 0:c746ee34feae 641
dannyman939 0:c746ee34feae 642 /**
dannyman939 0:c746ee34feae 643 * Function: getcNb
dannyman939 0:c746ee34feae 644 *
dannyman939 0:c746ee34feae 645 * Like getc() but is non-blocking. If no bytes are in the RX buffer this
dannyman939 0:c746ee34feae 646 * function returns Result::NoChar (-1)
dannyman939 0:c746ee34feae 647 *
dannyman939 0:c746ee34feae 648 * @ingroup API
dannyman939 0:c746ee34feae 649 * @return A byte from the RX buffer or Result::NoChar (-1) if bufer empty.
dannyman939 0:c746ee34feae 650 */
dannyman939 0:c746ee34feae 651 int getcNb() { return __getc(false); }
dannyman939 0:c746ee34feae 652
dannyman939 0:c746ee34feae 653 /**
dannyman939 0:c746ee34feae 654 * Function: getc
dannyman939 0:c746ee34feae 655 *
dannyman939 0:c746ee34feae 656 * Overloaded version of Serial::getc()
dannyman939 0:c746ee34feae 657 *
dannyman939 0:c746ee34feae 658 * This function blocks (if the RX buffer is empty the function will wait for a
dannyman939 0:c746ee34feae 659 * character to arrive and then return that character).
dannyman939 0:c746ee34feae 660 *
dannyman939 0:c746ee34feae 661 * @ingroup API
dannyman939 0:c746ee34feae 662 * @return A byte from the RX buffer
dannyman939 0:c746ee34feae 663 */
dannyman939 0:c746ee34feae 664 int getc() { return __getc(true); }
dannyman939 0:c746ee34feae 665
dannyman939 0:c746ee34feae 666 /**
dannyman939 0:c746ee34feae 667 * Function: txGetLastChar
dannyman939 0:c746ee34feae 668 *
dannyman939 0:c746ee34feae 669 * Rteurn the last byte to pass through the TX interrupt handler.
dannyman939 0:c746ee34feae 670 *
dannyman939 0:c746ee34feae 671 * @ingroup MISC
dannyman939 0:c746ee34feae 672 * @return The byte
dannyman939 0:c746ee34feae 673 */
dannyman939 0:c746ee34feae 674 char txGetLastChar(void) { return txc; }
dannyman939 0:c746ee34feae 675
dannyman939 0:c746ee34feae 676 /**
dannyman939 0:c746ee34feae 677 * Function: rxGetLastChar
dannyman939 0:c746ee34feae 678 *
dannyman939 0:c746ee34feae 679 * Return the last byte to pass through the RX interrupt handler.
dannyman939 0:c746ee34feae 680 *
dannyman939 0:c746ee34feae 681 * @ingroup MISC
dannyman939 0:c746ee34feae 682 * @return The byte
dannyman939 0:c746ee34feae 683 */
dannyman939 0:c746ee34feae 684 char rxGetLastChar(void) { return rxc; }
dannyman939 0:c746ee34feae 685
dannyman939 0:c746ee34feae 686 /**
dannyman939 0:c746ee34feae 687 * Function: txIsBusy
dannyman939 0:c746ee34feae 688 *
dannyman939 0:c746ee34feae 689 * If the Uart is still actively sending characters this
dannyman939 0:c746ee34feae 690 * function will return true.
dannyman939 0:c746ee34feae 691 *
dannyman939 0:c746ee34feae 692 * @ingroup API
dannyman939 0:c746ee34feae 693 * @return bool
dannyman939 0:c746ee34feae 694 */
dannyman939 0:c746ee34feae 695 bool txIsBusy(void);
dannyman939 0:c746ee34feae 696
dannyman939 0:c746ee34feae 697 /**
dannyman939 0:c746ee34feae 698 * Function: autoDetectChar
dannyman939 0:c746ee34feae 699 *
dannyman939 0:c746ee34feae 700 * Set the char that, if seen incoming, invokes the AutoDetectChar callback.
dannyman939 0:c746ee34feae 701 *
dannyman939 0:c746ee34feae 702 * @ingroup API
dannyman939 0:c746ee34feae 703 * @param int c The character to detect.
dannyman939 0:c746ee34feae 704 */
dannyman939 0:c746ee34feae 705 void autoDetectChar(char c) { auto_detect_char = c; }
dannyman939 0:c746ee34feae 706
dannyman939 0:c746ee34feae 707 /**
dannyman939 0:c746ee34feae 708 * Function: move
dannyman939 0:c746ee34feae 709 *
dannyman939 0:c746ee34feae 710 * Move contents of RX buffer to external buffer. Stops if "end" detected.
dannyman939 0:c746ee34feae 711 *
dannyman939 0:c746ee34feae 712 * @ingroup API
dannyman939 0:c746ee34feae 713 * @param char *s The destination buffer address
dannyman939 0:c746ee34feae 714 * @param int max The maximum number of chars to move.
dannyman939 0:c746ee34feae 715 * @param char end If this char is detected stop moving.
dannyman939 0:c746ee34feae 716 */
dannyman939 0:c746ee34feae 717 int move(char *s, int max, char end) {
dannyman939 0:c746ee34feae 718 int counter = 0;
dannyman939 0:c746ee34feae 719 char c;
dannyman939 0:c746ee34feae 720 while(readable()) {
dannyman939 0:c746ee34feae 721 c = getc();
dannyman939 0:c746ee34feae 722 if (c == end) break;
dannyman939 0:c746ee34feae 723 *(s++) = c;
dannyman939 0:c746ee34feae 724 counter++;
dannyman939 0:c746ee34feae 725 if (counter == max) break;
dannyman939 0:c746ee34feae 726 }
dannyman939 0:c746ee34feae 727 return counter;
dannyman939 0:c746ee34feae 728 }
dannyman939 0:c746ee34feae 729
dannyman939 0:c746ee34feae 730 /**
dannyman939 0:c746ee34feae 731 * Function: move (overloaded)
dannyman939 0:c746ee34feae 732 *
dannyman939 0:c746ee34feae 733 * Move contents of RX buffer to external buffer. Stops if auto_detect_char detected.
dannyman939 0:c746ee34feae 734 *
dannyman939 0:c746ee34feae 735 * @ingroup API
dannyman939 0:c746ee34feae 736 * @param int max The maximum number of chars to move.
dannyman939 0:c746ee34feae 737 * @param char *s The destination buffer address
dannyman939 0:c746ee34feae 738 */
dannyman939 0:c746ee34feae 739 int move(char *s, int max) {
dannyman939 0:c746ee34feae 740 return move(s, max, auto_detect_char);
dannyman939 0:c746ee34feae 741 }
dannyman939 0:c746ee34feae 742
dannyman939 0:c746ee34feae 743 #if 0 // Inhereted from Serial/Stream, for documentation only
dannyman939 0:c746ee34feae 744 /**
dannyman939 0:c746ee34feae 745 * Function: putc
dannyman939 0:c746ee34feae 746 *
dannyman939 0:c746ee34feae 747 * Write a character
dannyman939 0:c746ee34feae 748 * Inhereted from Serial/Stream
dannyman939 0:c746ee34feae 749 *
dannyman939 0:c746ee34feae 750 * @see http://mbed.org/projects/libraries/api/mbed/trunk/Serial#Serial.putc
dannyman939 0:c746ee34feae 751 * @ingroup API
dannyman939 0:c746ee34feae 752 * @param c The character to write to the serial port
dannyman939 0:c746ee34feae 753 */
dannyman939 0:c746ee34feae 754 int putc(int c);
dannyman939 0:c746ee34feae 755 #endif
dannyman939 0:c746ee34feae 756
dannyman939 0:c746ee34feae 757 #if 0 // Inhereted from Serial/Stream, for documentation only
dannyman939 0:c746ee34feae 758 /**
dannyman939 0:c746ee34feae 759 * Function: printf
dannyman939 0:c746ee34feae 760 *
dannyman939 0:c746ee34feae 761 * Write a formated string
dannyman939 0:c746ee34feae 762 * Inhereted from Serial/Stream
dannyman939 0:c746ee34feae 763 *
dannyman939 0:c746ee34feae 764 * @see http://mbed.org/projects/libraries/api/mbed/trunk/Serial#Serial.printf
dannyman939 0:c746ee34feae 765 * @ingroup API
dannyman939 0:c746ee34feae 766 * @param format A printf-style format string, followed by the variables to use in formating the string.
dannyman939 0:c746ee34feae 767 */
dannyman939 0:c746ee34feae 768 int printf(const char* format, ...);
dannyman939 0:c746ee34feae 769 #endif
dannyman939 0:c746ee34feae 770
dannyman939 0:c746ee34feae 771 #if 0 // Inhereted from Serial/Stream, for documentation only
dannyman939 0:c746ee34feae 772 /**
dannyman939 0:c746ee34feae 773 * Function: scanf
dannyman939 0:c746ee34feae 774 *
dannyman939 0:c746ee34feae 775 * Read a formated string
dannyman939 0:c746ee34feae 776 * Inhereted from Serial/Stream
dannyman939 0:c746ee34feae 777 *
dannyman939 0:c746ee34feae 778 * @see http://mbed.org/projects/libraries/api/mbed/trunk/Serial#Serial.scanf
dannyman939 0:c746ee34feae 779 * @ingroup API
dannyman939 0:c746ee34feae 780 * @param format - A scanf-style format string, followed by the pointers to variables to store the results.
dannyman939 0:c746ee34feae 781 */
dannyman939 0:c746ee34feae 782 int scanf(const char* format, ...);
dannyman939 0:c746ee34feae 783 #endif
dannyman939 0:c746ee34feae 784
dannyman939 0:c746ee34feae 785 protected:
dannyman939 0:c746ee34feae 786 /**
dannyman939 0:c746ee34feae 787 * Used to pass information to callbacks.
dannyman939 0:c746ee34feae 788 * @ingroup INTERNALS
dannyman939 0:c746ee34feae 789 */
dannyman939 0:c746ee34feae 790 MODSERIAL_IRQ_INFO callbackInfo;
dannyman939 0:c746ee34feae 791
dannyman939 0:c746ee34feae 792 /**
dannyman939 0:c746ee34feae 793 * Remove the last char placed into the rx buffer.
dannyman939 0:c746ee34feae 794 * This is an operation that can only be performed
dannyman939 0:c746ee34feae 795 * by an rxCallback function. To protect the buffers
dannyman939 0:c746ee34feae 796 * this function is defined protected so that a
dannyman939 0:c746ee34feae 797 * regular application cannot call it directly. It
dannyman939 0:c746ee34feae 798 * can only be called by the public version within a
dannyman939 0:c746ee34feae 799 * MODSERIAL_IRQ_INFO class.
dannyman939 0:c746ee34feae 800 * @ingroup INTERNALS
dannyman939 0:c746ee34feae 801 * @return The byte removed from the buffer.
dannyman939 0:c746ee34feae 802 */
dannyman939 0:c746ee34feae 803 int rxDiscardLastChar(void);
dannyman939 0:c746ee34feae 804
dannyman939 0:c746ee34feae 805 private:
dannyman939 0:c746ee34feae 806
dannyman939 0:c746ee34feae 807 /**
dannyman939 0:c746ee34feae 808 * A pointer to the UART peripheral base address being used.
dannyman939 0:c746ee34feae 809 * @ingroup INTERNALS
dannyman939 0:c746ee34feae 810 */
dannyman939 0:c746ee34feae 811 void *_base;
dannyman939 0:c746ee34feae 812
dannyman939 0:c746ee34feae 813 /**
dannyman939 0:c746ee34feae 814 * The last byte to pass through the TX IRQ handler.
dannyman939 0:c746ee34feae 815 * @ingroup INTERNALS
dannyman939 0:c746ee34feae 816 */
dannyman939 0:c746ee34feae 817 volatile char txc;
dannyman939 0:c746ee34feae 818
dannyman939 0:c746ee34feae 819 /**
dannyman939 0:c746ee34feae 820 * The last byte to pass through the RX IRQ handler.
dannyman939 0:c746ee34feae 821 * @ingroup INTERNALS
dannyman939 0:c746ee34feae 822 */
dannyman939 0:c746ee34feae 823 volatile char rxc;
dannyman939 0:c746ee34feae 824
dannyman939 0:c746ee34feae 825 /**
dannyman939 0:c746ee34feae 826 * Pointers to the TX and RX buffers.
dannyman939 0:c746ee34feae 827 * @ingroup INTERNALS
dannyman939 0:c746ee34feae 828 */
dannyman939 0:c746ee34feae 829 volatile char *buffer[2];
dannyman939 0:c746ee34feae 830
dannyman939 0:c746ee34feae 831 /**
dannyman939 0:c746ee34feae 832 * Buffer in pointers.
dannyman939 0:c746ee34feae 833 * @ingroup INTERNALS
dannyman939 0:c746ee34feae 834 */
dannyman939 0:c746ee34feae 835 volatile int buffer_in[2];
dannyman939 0:c746ee34feae 836
dannyman939 0:c746ee34feae 837 /**
dannyman939 0:c746ee34feae 838 * Buffer out pointers.
dannyman939 0:c746ee34feae 839 * @ingroup INTERNALS
dannyman939 0:c746ee34feae 840 */
dannyman939 0:c746ee34feae 841 volatile int buffer_out[2];
dannyman939 0:c746ee34feae 842
dannyman939 0:c746ee34feae 843 /**
dannyman939 0:c746ee34feae 844 * Buffer lengths.
dannyman939 0:c746ee34feae 845 * @ingroup INTERNALS
dannyman939 0:c746ee34feae 846 */
dannyman939 0:c746ee34feae 847 volatile int buffer_size[2];
dannyman939 0:c746ee34feae 848
dannyman939 0:c746ee34feae 849 /**
dannyman939 0:c746ee34feae 850 * Buffer content counters.
dannyman939 0:c746ee34feae 851 * @ingroup INTERNALS
dannyman939 0:c746ee34feae 852 */
dannyman939 0:c746ee34feae 853 volatile int buffer_count[2];
dannyman939 0:c746ee34feae 854
dannyman939 0:c746ee34feae 855 /**
dannyman939 0:c746ee34feae 856 * Buffer overflow.
dannyman939 0:c746ee34feae 857 * @ingroup INTERNALS
dannyman939 0:c746ee34feae 858 */
dannyman939 0:c746ee34feae 859 volatile int buffer_overflow[2];
dannyman939 0:c746ee34feae 860
dannyman939 0:c746ee34feae 861 /**
dannyman939 0:c746ee34feae 862 * Auto-detect character.
dannyman939 0:c746ee34feae 863 * @ingroup INTERNALS
dannyman939 0:c746ee34feae 864 */
dannyman939 0:c746ee34feae 865 volatile char auto_detect_char;
dannyman939 0:c746ee34feae 866
dannyman939 0:c746ee34feae 867 /**
dannyman939 0:c746ee34feae 868 * Callback system.
dannyman939 0:c746ee34feae 869 * @ingroup INTERNALS
dannyman939 0:c746ee34feae 870 */
dannyman939 0:c746ee34feae 871 MODSERIAL_callback _isr[NumOfIrqTypes];
dannyman939 0:c746ee34feae 872
dannyman939 0:c746ee34feae 873 /**
dannyman939 0:c746ee34feae 874 * TX Interrupt Service Routine.
dannyman939 0:c746ee34feae 875 * @ingroup INTERNALS
dannyman939 0:c746ee34feae 876 */
dannyman939 0:c746ee34feae 877 void isr_tx(bool doCallback);
dannyman939 0:c746ee34feae 878
dannyman939 0:c746ee34feae 879 /**
dannyman939 0:c746ee34feae 880 * TX Interrupt Service Routine stub version.
dannyman939 0:c746ee34feae 881 * @ingroup INTERNALS
dannyman939 0:c746ee34feae 882 */
dannyman939 0:c746ee34feae 883 void isr_tx(void) { isr_tx(true); }
dannyman939 0:c746ee34feae 884
dannyman939 0:c746ee34feae 885
dannyman939 0:c746ee34feae 886 /**
dannyman939 0:c746ee34feae 887 * RX Interrupt Service Routine.
dannyman939 0:c746ee34feae 888 * @ingroup INTERNALS
dannyman939 0:c746ee34feae 889 */
dannyman939 0:c746ee34feae 890 void isr_rx(void);
dannyman939 0:c746ee34feae 891
dannyman939 0:c746ee34feae 892 /**
dannyman939 0:c746ee34feae 893 * Disable the interrupts for this Uart.
dannyman939 0:c746ee34feae 894 * @ingroup INTERNALS
dannyman939 0:c746ee34feae 895 */
dannyman939 0:c746ee34feae 896 void disableIrq(void);
dannyman939 0:c746ee34feae 897
dannyman939 0:c746ee34feae 898 /**
dannyman939 0:c746ee34feae 899 * Enable the interrupts for this Uart.
dannyman939 0:c746ee34feae 900 * @ingroup INTERNALS
dannyman939 0:c746ee34feae 901 */
dannyman939 0:c746ee34feae 902 void enableIrq(void);
dannyman939 0:c746ee34feae 903
dannyman939 0:c746ee34feae 904 /**
dannyman939 0:c746ee34feae 905 * Get a character from the RX buffer
dannyman939 0:c746ee34feae 906 * @ingroup INTERNALS
dannyman939 0:c746ee34feae 907 * @param bool True to block (wait for input)
dannyman939 0:c746ee34feae 908 * @return A byte from the buffer.
dannyman939 0:c746ee34feae 909 */
dannyman939 0:c746ee34feae 910 int __getc(bool);
dannyman939 0:c746ee34feae 911
dannyman939 0:c746ee34feae 912 /**
dannyman939 0:c746ee34feae 913 * Put a character from the TX buffer
dannyman939 0:c746ee34feae 914 * @ingroup INTERNALS
dannyman939 0:c746ee34feae 915 * @param bool True to block (wait for space in the TX buffer if full)
dannyman939 0:c746ee34feae 916 * @return 0 on success
dannyman939 0:c746ee34feae 917 */
dannyman939 0:c746ee34feae 918 int __putc(int c, bool);
dannyman939 0:c746ee34feae 919
dannyman939 0:c746ee34feae 920 /**
dannyman939 0:c746ee34feae 921 * Function: _putc
dannyman939 0:c746ee34feae 922 * Overloaded virtual function.
dannyman939 0:c746ee34feae 923 */
dannyman939 0:c746ee34feae 924 virtual int _putc(int c) { return __putc(c, true); }
dannyman939 0:c746ee34feae 925
dannyman939 0:c746ee34feae 926 /**
dannyman939 0:c746ee34feae 927 * Function: _getc
dannyman939 0:c746ee34feae 928 * Overloaded virtual function.
dannyman939 0:c746ee34feae 929 */
dannyman939 0:c746ee34feae 930 virtual int _getc() { return __getc(true); }
dannyman939 0:c746ee34feae 931
dannyman939 0:c746ee34feae 932 /**
dannyman939 0:c746ee34feae 933 * Function: init
dannyman939 0:c746ee34feae 934 * Initialize the MODSERIAL object
dannyman939 0:c746ee34feae 935 * @ingroup INTERNALS
dannyman939 0:c746ee34feae 936 */
dannyman939 0:c746ee34feae 937 void init(int txSize, int rxSize);
dannyman939 0:c746ee34feae 938
dannyman939 0:c746ee34feae 939 /**
dannyman939 0:c746ee34feae 940 * Function: flushBuffer
dannyman939 0:c746ee34feae 941 * @ingroup INTERNALS
dannyman939 0:c746ee34feae 942 */
dannyman939 0:c746ee34feae 943 void flushBuffer(IrqType type);
dannyman939 0:c746ee34feae 944
dannyman939 0:c746ee34feae 945 /**
dannyman939 0:c746ee34feae 946 * Function: resizeBuffer
dannyman939 0:c746ee34feae 947 * @ingroup INTERNALS
dannyman939 0:c746ee34feae 948 */
dannyman939 0:c746ee34feae 949 int resizeBuffer(int size, IrqType type = RxIrq, bool memory_check = true);
dannyman939 0:c746ee34feae 950
dannyman939 0:c746ee34feae 951 /**
dannyman939 0:c746ee34feae 952 * Function: downSizeBuffer
dannyman939 0:c746ee34feae 953 * @ingroup INTERNALS
dannyman939 0:c746ee34feae 954 */
dannyman939 0:c746ee34feae 955 int downSizeBuffer(int size, IrqType type, bool memory_check);
dannyman939 0:c746ee34feae 956
dannyman939 0:c746ee34feae 957 /**
dannyman939 0:c746ee34feae 958 * Function: upSizeBuffer
dannyman939 0:c746ee34feae 959 * @ingroup INTERNALS
dannyman939 0:c746ee34feae 960 */
dannyman939 0:c746ee34feae 961 int upSizeBuffer(int size, IrqType type, bool memory_check);
dannyman939 0:c746ee34feae 962
dannyman939 0:c746ee34feae 963 /*
dannyman939 0:c746ee34feae 964 * If MODDMA is available the compile in code to handle sending
dannyman939 0:c746ee34feae 965 * an arbitary char buffer. Note, the parts before teh #ifdef
dannyman939 0:c746ee34feae 966 * are declared so that MODSERIAL can access then even if MODDMA
dannyman939 0:c746ee34feae 967 * isn't avaiable. Since MODDMA.h is only available at this point
dannyman939 0:c746ee34feae 968 * all DMA functionality must be declared inline in the class
dannyman939 0:c746ee34feae 969 * definition.
dannyman939 0:c746ee34feae 970 */
dannyman939 0:c746ee34feae 971 public:
dannyman939 0:c746ee34feae 972
dannyman939 0:c746ee34feae 973 int dmaSendChannel;
dannyman939 0:c746ee34feae 974 void *moddma_p;
dannyman939 0:c746ee34feae 975
dannyman939 0:c746ee34feae 976 #ifdef MODDMA_H
dannyman939 0:c746ee34feae 977
dannyman939 0:c746ee34feae 978 MODDMA_Config *config;
dannyman939 0:c746ee34feae 979
dannyman939 0:c746ee34feae 980 /**
dannyman939 0:c746ee34feae 981 * Set the "void pointer" moddma_p to be a pointer to a
dannyman939 0:c746ee34feae 982 * MODDMA controller class instance. Used to manage the
dannyman939 0:c746ee34feae 983 * data transfer of DMA configurations.
dannyman939 0:c746ee34feae 984 *
dannyman939 0:c746ee34feae 985 * @ingroup API
dannyman939 0:c746ee34feae 986 * @param p A pointer to "the" instance of MODDMA.
dannyman939 0:c746ee34feae 987 */
dannyman939 0:c746ee34feae 988 void MODDMA(MODDMA *p) { moddma_p = p; }
dannyman939 0:c746ee34feae 989
dannyman939 0:c746ee34feae 990 /**
dannyman939 0:c746ee34feae 991 * Send a char buffer to the Uarts TX system
dannyman939 0:c746ee34feae 992 * using DMA. This blocks regular library
dannyman939 0:c746ee34feae 993 * sending.
dannyman939 0:c746ee34feae 994 *
dannyman939 0:c746ee34feae 995 * @param buffer A char buffer of bytes to send.
dannyman939 0:c746ee34feae 996 * @param len The length of the buffer to send.
dannyman939 0:c746ee34feae 997 * @param dmaChannel The DMA channel to use, defaults to 7
dannyman939 0:c746ee34feae 998 * @return MODDMA::Status MODDMA::ok if all went ok
dannyman939 0:c746ee34feae 999 */
dannyman939 0:c746ee34feae 1000 int dmaSend(char *buffer, int len, int dmaChannel = 7)
dannyman939 0:c746ee34feae 1001 {
dannyman939 0:c746ee34feae 1002 if (moddma_p == (void *)NULL) return -2;
dannyman939 0:c746ee34feae 1003 class MODDMA *dma = (class MODDMA *)moddma_p;
dannyman939 0:c746ee34feae 1004
dannyman939 0:c746ee34feae 1005 dmaSendChannel = dmaChannel & 0x7;
dannyman939 0:c746ee34feae 1006
dannyman939 0:c746ee34feae 1007 uint32_t conn = MODDMA::UART0_Tx;
dannyman939 0:c746ee34feae 1008 switch(_uidx) {
dannyman939 0:c746ee34feae 1009 case 0: conn = MODDMA::UART0_Tx; break;
dannyman939 0:c746ee34feae 1010 case 1: conn = MODDMA::UART1_Tx; break;
dannyman939 0:c746ee34feae 1011 case 2: conn = MODDMA::UART2_Tx; break;
dannyman939 0:c746ee34feae 1012 case 3: conn = MODDMA::UART3_Tx; break;
dannyman939 0:c746ee34feae 1013 }
dannyman939 0:c746ee34feae 1014
dannyman939 0:c746ee34feae 1015 config = new MODDMA_Config;
dannyman939 0:c746ee34feae 1016 config
dannyman939 0:c746ee34feae 1017 ->channelNum ( (MODDMA::CHANNELS)(dmaSendChannel & 0x7) )
dannyman939 0:c746ee34feae 1018 ->srcMemAddr ( (uint32_t) buffer )
dannyman939 0:c746ee34feae 1019 ->transferSize ( len )
dannyman939 0:c746ee34feae 1020 ->transferType ( MODDMA::m2p )
dannyman939 0:c746ee34feae 1021 ->dstConn ( conn )
dannyman939 0:c746ee34feae 1022 ->attach_tc ( this, &MODSERIAL::dmaSendCallback )
dannyman939 0:c746ee34feae 1023 ->attach_err ( this, &MODSERIAL::dmaSendCallback )
dannyman939 0:c746ee34feae 1024 ; // config end
dannyman939 0:c746ee34feae 1025
dannyman939 0:c746ee34feae 1026 // Setup the configuration.
dannyman939 0:c746ee34feae 1027 if (dma->Setup(config) == 0) {
dannyman939 0:c746ee34feae 1028 return -1;
dannyman939 0:c746ee34feae 1029 }
dannyman939 0:c746ee34feae 1030
dannyman939 0:c746ee34feae 1031 //dma.Enable( MODDMA::Channel_0 );
dannyman939 0:c746ee34feae 1032 dma->Enable( config->channelNum() );
dannyman939 0:c746ee34feae 1033 return MODDMA::Ok;
dannyman939 0:c746ee34feae 1034 }
dannyman939 0:c746ee34feae 1035
dannyman939 0:c746ee34feae 1036 /**
dannyman939 0:c746ee34feae 1037 * Attach a callback to the DMA completion.
dannyman939 0:c746ee34feae 1038 *
dannyman939 0:c746ee34feae 1039 * @ingroup API
dannyman939 0:c746ee34feae 1040 * @param fptr A function pointer to call
dannyman939 0:c746ee34feae 1041 * @return this
dannyman939 0:c746ee34feae 1042 */
dannyman939 0:c746ee34feae 1043 void attach_dmaSendComplete(void (*fptr)(MODSERIAL_IRQ_INFO *)) {
dannyman939 0:c746ee34feae 1044 _isrDmaSendComplete.attach(fptr);
dannyman939 0:c746ee34feae 1045 }
dannyman939 0:c746ee34feae 1046
dannyman939 0:c746ee34feae 1047 /**
dannyman939 0:c746ee34feae 1048 * Attach a callback to the DMA completion.
dannyman939 0:c746ee34feae 1049 *
dannyman939 0:c746ee34feae 1050 * @ingroup API
dannyman939 0:c746ee34feae 1051 * @param tptr A template pointer to the calling object
dannyman939 0:c746ee34feae 1052 * @param mptr A method pointer within the object to call.
dannyman939 0:c746ee34feae 1053 * @return this
dannyman939 0:c746ee34feae 1054 */
dannyman939 0:c746ee34feae 1055 template<typename T>
dannyman939 0:c746ee34feae 1056 void attach_dmaSendComplete(T* tptr, void (T::*mptr)(MODSERIAL_IRQ_INFO *)) {
dannyman939 0:c746ee34feae 1057 if((mptr != NULL) && (tptr != NULL)) {
dannyman939 0:c746ee34feae 1058 _isrDmaSendComplete.attach(tptr, mptr);
dannyman939 0:c746ee34feae 1059 }
dannyman939 0:c746ee34feae 1060 }
dannyman939 0:c746ee34feae 1061
dannyman939 0:c746ee34feae 1062 MODSERIAL_callback _isrDmaSendComplete;
dannyman939 0:c746ee34feae 1063
dannyman939 0:c746ee34feae 1064 protected:
dannyman939 0:c746ee34feae 1065 /**
dannyman939 0:c746ee34feae 1066 * Callback for dmaSend().
dannyman939 0:c746ee34feae 1067 */
dannyman939 0:c746ee34feae 1068 void dmaSendCallback(void)
dannyman939 0:c746ee34feae 1069 {
dannyman939 0:c746ee34feae 1070 if (moddma_p == (void *)NULL) return;
dannyman939 0:c746ee34feae 1071 class MODDMA *dma = (class MODDMA *)moddma_p;
dannyman939 0:c746ee34feae 1072
dannyman939 0:c746ee34feae 1073 MODDMA_Config *config = dma->getConfig();
dannyman939 0:c746ee34feae 1074 dma->haltAndWaitChannelComplete( (MODDMA::CHANNELS)config->channelNum());
dannyman939 0:c746ee34feae 1075 dma->Disable( (MODDMA::CHANNELS)config->channelNum() );
dannyman939 0:c746ee34feae 1076 if (dma->irqType() == MODDMA::TcIrq) dma->clearTcIrq();
dannyman939 0:c746ee34feae 1077 if (dma->irqType() == MODDMA::ErrIrq) dma->clearErrIrq();
dannyman939 0:c746ee34feae 1078 dmaSendChannel = -1;
dannyman939 0:c746ee34feae 1079 _isrDmaSendComplete.call(&this->callbackInfo);
dannyman939 0:c746ee34feae 1080 delete(config);
dannyman939 0:c746ee34feae 1081 }
dannyman939 0:c746ee34feae 1082
dannyman939 0:c746ee34feae 1083 #endif // MODDMA_H
dannyman939 0:c746ee34feae 1084
dannyman939 0:c746ee34feae 1085 };
dannyman939 0:c746ee34feae 1086
dannyman939 0:c746ee34feae 1087 }; // namespace AjK ends
dannyman939 0:c746ee34feae 1088
dannyman939 0:c746ee34feae 1089 using namespace AjK;
dannyman939 0:c746ee34feae 1090
dannyman939 0:c746ee34feae 1091 #endif