Derek Fukumori / 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.

Fork of MODSERIAL by Andy K

MODSERIAL.h@23:1236d0b64e71, 2012-07-13 (annotated)

Committer:
dfukumori
Date:
Fri Jul 13 01:09:23 2012 +0000
Revision:
23:1236d0b64e71
Parent:
21:af2af4c61c2f 
Required commit -- no changes

Who changed what in which revision?

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