Dave Lu / FYDP_Final2

Only imu output

Dependencies:   Servo mbed

Fork of FYDP_Final2 by Mark Vandermeulen

mbed/MODSERIAL/MODSERIAL.h@5:d2e955a94940, 2015-03-25 (annotated)

Committer:
tntmarket
Date:
Wed Mar 25 09:58:50 2015 +0000
Revision:
5:d2e955a94940
Parent:
0:21019d94ad33 
only imu output

Who changed what in which revision?

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