Fahad Mirza / MODSERIAL

MODSERIAL with support for more devices

Fork of MODSERIAL by Erik -

MODSERIAL.h@46:6571cd7f896e, 2018-07-11 (annotated)

Committer:
fahadmirza
Date:
Wed Jul 11 08:17:03 2018 +0000
Revision:
46:6571cd7f896e
Parent:
44:a3b2bc878529 
Added support for NUCLEO_L053R8

Who changed what in which revision?

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