Paul Griffith / Mbed 2 deprecated CanonicalInputProcessing

This program shows how to use the MODSERIAL library by Andy Kirkham to do canonical input processing. This allows you to enter and edit a command line (in the same way that you do in DOS or Linux) without tying up your main routine.

Dependencies:   mbed

MODSERIAL.h@0:b77c715e027c, 2011-04-21 (annotated)

Committer:
paulg
Date:
Thu Apr 21 21:35:16 2011 +0000
Revision:
0:b77c715e027c
First revision

Who changed what in which revision?

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