Mike Panetta / MODSERIAL

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   BeaconAvoid

MODSERIAL.h@0:ef4645a79fca, 2012-09-09 (annotated)

Committer:
mpanetta
Date:
Sun Sep 09 22:28:07 2012 +0000
Revision:
0:ef4645a79fca
[mbed] converted /BeaconAvoid/MODSERIAL

Who changed what in which revision?

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