Mike Panetta / Mbed 2 deprecated BeaconAvoid

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.

Dependencies:   MODSERIAL PiSlingers m3pi mbed

MODSERIAL/MODSERIAL.h@0:9ac4a91b71fa, 2012-04-04 (annotated)

Committer:
mpanetta
Date:
Wed Apr 04 17:07:49 2012 +0000
Revision:
0:9ac4a91b71fa
Initial commit.  Avoidance code complete, beacon code still needs to be added.

Who changed what in which revision?

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