Fork of the MODSERIAL library by Erik Olieman.

Dependents:   trs_master

Fork of MODSERIAL by Erik -

Committer:
Sissors
Date:
Tue Jan 08 13:08:20 2013 +0000
Revision:
29:a469aa702bab
Parent:
28:3ba4341d74d6
Re-added option to give MODSERIAL a name

Who changed what in which revision?

UserRevisionLine numberNew contents of line
AjK 1:b7e435fbfe8e 1 /* $Id:$
AjK 2:b936b4acbd92 2
Sissors 28:3ba4341d74d6 3 Erik Olieman
Sissors 28:3ba4341d74d6 4 ***********************
Sissors 29:a469aa702bab 5 1.29 1st Januari 2013
Sissors 29:a469aa702bab 6 Version 29 so revisions walk in sync again with numbering
Sissors 29:a469aa702bab 7 Version 54 of the mbed library re-adds option to give a Serial object a name, so this is also re-added the MODSERIAL
Sissors 29:a469aa702bab 8
Sissors 28:3ba4341d74d6 9 1.25 12th December 2012
Sissors 28:3ba4341d74d6 10 Fixed the attach of Serial interrupts (again) with new release
Sissors 28:3ba4341d74d6 11
Sissors 28:3ba4341d74d6 12 1.24 28th November 2012
Sissors 28:3ba4341d74d6 13 Fixed attach of Serial interrupts with new mbed library
Sissors 28:3ba4341d74d6 14 Fixed _uidx being renamed
Sissors 28:3ba4341d74d6 15 Removed *char argument from constructor since it was removed from Serial
Sissors 28:3ba4341d74d6 16
Sissors 28:3ba4341d74d6 17 **********************
Sissors 28:3ba4341d74d6 18
AjK 23:5c45c21f36b7 19 1.23 25th July 2012
AjK 23:5c45c21f36b7 20
AjK 23:5c45c21f36b7 21 * LPC1768 code as was. This release includes "alpha" support for the LPC11U24
AjK 23:5c45c21f36b7 22
AjK 22:c11ea36f17f9 23 1.22 19th April 2012
AjK 22:c11ea36f17f9 24
AjK 22:c11ea36f17f9 25 * http://mbed.org/forum/bugs-suggestions/topic/2936/
AjK 22:c11ea36f17f9 26 * Bug fix, protect important buffer pointers from IRQ corruption.
AjK 22:c11ea36f17f9 27 Credits:
AjK 22:c11ea36f17f9 28 Anthony Wieser http://mbed.org/users/WieserSoftwareLtd/ for the fix.
AjK 22:c11ea36f17f9 29 BlazeX http://mbed.org/users/BlazeX/ for the alert that a fix was needed!
AjK 22:c11ea36f17f9 30
AjK 21:af2af4c61c2f 31 1.21 10 May 2011
AjK 21:af2af4c61c2f 32
AjK 21:af2af4c61c2f 33 * http://mbed.org/forum/mbed/topic/2264
AjK 21:af2af4c61c2f 34
AjK 20:59c74aaedda2 35 1.20 26 April 2011
AjK 20:59c74aaedda2 36
AjK 20:59c74aaedda2 37 * Bug fix, not blocking on transmit
AjK 20:59c74aaedda2 38 by Erik Petrich, http://mbed.org/forum/bugs-suggestions/topic/2200
AjK 20:59c74aaedda2 39
AjK 20:59c74aaedda2 40 1.19 20 April 2011
AjK 20:59c74aaedda2 41
AjK 20:59c74aaedda2 42 * Fixed some doxygen comment bugs.
AjK 20:59c74aaedda2 43
AjK 18:21ef26402365 44 1.18 20 April 2011
AjK 18:21ef26402365 45
AjK 18:21ef26402365 46 * All callbacks now use MODSERIAL_callback (rather than Mbed's FunctionPointer[1] type)
AjK 18:21ef26402365 47 to store and invoke it's callbacks. This allows MODSERIAL to pass a parameter
AjK 18:21ef26402365 48 to callbacks. The function prototype is now void func(MODSERIAL_IRQ_INFO *q).
AjK 18:21ef26402365 49 * Callbacks now pass a pointer to a MODSERIAL_IRQ_INFO class type.
AjK 18:21ef26402365 50 This class holds a pointer to the MODSERIAL object that invoked the callback
AjK 18:21ef26402365 51 thus freeing callbacks need to use the global variable of the original
AjK 18:21ef26402365 52 MODSERIAL instance.
AjK 18:21ef26402365 53 * MODSERIAL_IRQ_INFO also declares public functions that are protected within MODSERIAL
AjK 18:21ef26402365 54 thus allowing certain functions to be restricted to callback context only.
AjK 18:21ef26402365 55 * New function MODSERIAL_IRQ_INFO::rxDiscardLastChar() allows an rxCallback function
AjK 18:21ef26402365 56 to remove the character that was just placed into the RX buffer.
AjK 18:21ef26402365 57
AjK 18:21ef26402365 58 [1] http://mbed.org/users/AjK/libraries/FPointer/latest/docs/
AjK 18:21ef26402365 59
AjK 17:6c9b57c14868 60 1.17 08/Mar/2011
AjK 17:6c9b57c14868 61 Fixed a memory leak in the DMA code.
AjK 17:6c9b57c14868 62
AjK 16:8b1dbf4cce4e 63 1.16 - 12 Feb 2011
AjK 16:8b1dbf4cce4e 64
AjK 16:8b1dbf4cce4e 65 * Missed one, doh!
AjK 16:8b1dbf4cce4e 66
AjK 15:a1d9e745d71e 67 1.15 - 12 Feb 2011
AjK 15:a1d9e745d71e 68
AjK 15:a1d9e745d71e 69 * Fixed some typos.
AjK 15:a1d9e745d71e 70
AjK 14:3c3b87617bfe 71 1.14 - 7 Feb 2011
AjK 14:3c3b87617bfe 72
AjK 14:3c3b87617bfe 73 * Fixed a bug in __putc() that caused the output buffer pointer to
AjK 14:3c3b87617bfe 74 become corrupted.
AjK 14:3c3b87617bfe 75
AjK 13:70bb7c1769fa 76 1.13 - 20/01/2011
AjK 13:70bb7c1769fa 77
AjK 13:70bb7c1769fa 78 * Added extra documentation.
AjK 13:70bb7c1769fa 79 * Fixed some typos.
AjK 13:70bb7c1769fa 80
AjK 12:8c7394e2ae7f 81 1.12 - 20/01/2011
AjK 12:8c7394e2ae7f 82
AjK 12:8c7394e2ae7f 83 * Added new "autoDetectChar()" function. To use:-
AjK 12:8c7394e2ae7f 84 1st: Add a callback to invoke when the char is detected:-
AjK 12:8c7394e2ae7f 85 .attach(&detectedChar, MODSERIAL::RxAutoDetect);
AjK 12:8c7394e2ae7f 86 2nd: Send the char to detect.
AjK 12:8c7394e2ae7f 87 .autoDectectChar('\n');
AjK 12:8c7394e2ae7f 88 Whenever that char goes into the RX buffer your callback will be invoked.
AjK 12:8c7394e2ae7f 89 Added example2.cpp to demo a simple messaging system using this auto feature.
AjK 12:8c7394e2ae7f 90
AjK 12:8c7394e2ae7f 91
AjK 11:a93a62eeeb9d 92 1.11 - 23/11/2010
AjK 11:a93a62eeeb9d 93
AjK 11:a93a62eeeb9d 94 * Fixed a minor issue with 1.10 missed an alteration of name change.
AjK 11:a93a62eeeb9d 95
AjK 10:725fe81aa9ff 96 1.10 - 23/11/2010
AjK 10:725fe81aa9ff 97
AjK 18:21ef26402365 98 * Rename the DMA callback from attach_dma_complete() to attach_dmaSendComplete()
AjK 10:725fe81aa9ff 99
AjK 9:b3cdae80e7a9 100 1.9 - 23/11/2010
AjK 9:b3cdae80e7a9 101
AjK 9:b3cdae80e7a9 102 * Added support for DMA sending of characters. Required is
AjK 9:b3cdae80e7a9 103 the MODDMA library module:-
AjK 9:b3cdae80e7a9 104 http://mbed.org/users/AjK/libraries/MODDMA/latest
AjK 9:b3cdae80e7a9 105 See example_dma.cpp for more information.
AjK 9:b3cdae80e7a9 106
AjK 8:775f860e94d3 107 1.8 - 22/11/2010
AjK 8:775f860e94d3 108
AjK 8:775f860e94d3 109 * Added code so that if a buffer is set to zero length then
AjK 8:775f860e94d3 110 MODSERIAL defaults to just using the FIFO for that stream
AjK 8:775f860e94d3 111 thus making the library "fall back" to teh same operation
AjK 8:775f860e94d3 112 that the Mbed Serial library performs.
AjK 8:775f860e94d3 113 * Removed dmaSend() function that should have been removed
AjK 8:775f860e94d3 114 at 1.7
AjK 8:775f860e94d3 115
AjK 7:ffa4a7cb7f8d 116 1.7 - 21/11/2010
AjK 7:ffa4a7cb7f8d 117
AjK 7:ffa4a7cb7f8d 118 * Remove the DMA enum from MODSERIAL.h as it's not currently
AjK 7:ffa4a7cb7f8d 119 ready for release.
AjK 7:ffa4a7cb7f8d 120 * Added page doxygen comments.
AjK 7:ffa4a7cb7f8d 121
AjK 6:c8f77fe1cc10 122 1.6 - 21/11/2010
AjK 6:c8f77fe1cc10 123
AjK 6:c8f77fe1cc10 124 * Version 1.5 solved a blocking problem on putc() when called
AjK 6:c8f77fe1cc10 125 from another ISR. However, isr_tx() invokes a callback of it's
AjK 6:c8f77fe1cc10 126 own when a byte is tranferred from TX buffer to TX FIFO. User
AjK 6:c8f77fe1cc10 127 programs may interpret that as an IRQ callback. That's an ISR
AjK 6:c8f77fe1cc10 128 call from within an existing ISR which is not good. So the
AjK 6:c8f77fe1cc10 129 TxIrq callback from isr_tx is now conditional. It will only
AjK 6:c8f77fe1cc10 130 be called when isr_tx() is actually within it's own ISR and
AjK 6:c8f77fe1cc10 131 not when called from alternate ISR handlers.
AjK 6:c8f77fe1cc10 132
AjK 5:8365c4cf8f33 133 1.5 - 21/11/2010
AjK 5:8365c4cf8f33 134
AjK 5:8365c4cf8f33 135 * Calling putc() (or any derived function that uses it like
AjK 5:8365c4cf8f33 136 printf()) while inside an interrupt service routine can
AjK 5:8365c4cf8f33 137 cause the system to lock up if the TX buffer is full. This
AjK 5:8365c4cf8f33 138 is because bytes are only transferred from the TX buffer to
AjK 5:8365c4cf8f33 139 the TX FIFO via the TX ISR. If we are, say in an RX ISR already,
AjK 5:8365c4cf8f33 140 then the TX ISR will never trigger. The TX buffer stays full and
AjK 5:8365c4cf8f33 141 there is never space to putc() the byte. So, while putc() blocks
AjK 5:8365c4cf8f33 142 waiting for space it calls isr_tx() to ensure if TX FIFO space
AjK 5:8365c4cf8f33 143 becomes available it will move bytes from the TX buffer to TX
AjK 5:8365c4cf8f33 144 FIFO thus removing the blocking condition within putc().
AjK 5:8365c4cf8f33 145
AjK 4:28de979b77cf 146 1.4 - 21/11/2010
AjK 4:28de979b77cf 147
AjK 4:28de979b77cf 148 * Removed all the new DMA code. I wish mbed.org had proper SVN
AjK 4:28de979b77cf 149 versioning, I'm use to working in HEAD and BRANCHES after I've
AjK 4:28de979b77cf 150 released a project. Getting bug reports in current releases
AjK 4:28de979b77cf 151 while trying to dev new code is hard to manage without source
AjK 4:28de979b77cf 152 control of some type!
AjK 4:28de979b77cf 153
AjK 2:b936b4acbd92 154 1.3 - 21/11/2010
AjK 2:b936b4acbd92 155
AjK 2:b936b4acbd92 156 * Fixed a macro problem with txIsBusy()
AjK 2:b936b4acbd92 157 * Started adding code to use "block data" sending using DMA
AjK 3:0f10f536456e 158 * Removed #include "IOMACROS.h"
AjK 1:b7e435fbfe8e 159
AjK 2:b936b4acbd92 160 1.2 - 21/11/2010
AjK 2:b936b4acbd92 161
AjK 2:b936b4acbd92 162 * Removed unsed variables from flushBuffer()
AjK 2:b936b4acbd92 163 * Fixed a bug where both RX AND TX fifos are cleared/reset
AjK 2:b936b4acbd92 164 when just TX OR RX should be cleared.
AjK 2:b936b4acbd92 165 * Fixed a bug that cleared IIR when in fact it should be left
AjK 2:b936b4acbd92 166 alone so that any pending interrupt after flush is handled.
AjK 2:b936b4acbd92 167 * Merged setBase() into init() as it wasn't required anywhere else.
AjK 2:b936b4acbd92 168 * Changed init() to enforce _uidx is set by Serial to define the _base
AjK 2:b936b4acbd92 169 address of the Uart in use.
AjK 2:b936b4acbd92 170
AjK 1:b7e435fbfe8e 171 1.1 - 20/11/2010
AjK 1:b7e435fbfe8e 172
AjK 1:b7e435fbfe8e 173 * Added this file
AjK 1:b7e435fbfe8e 174 * Removed cruft from GETC.cpp
AjK 1:b7e435fbfe8e 175 * "teh" should be "the", why do my fingers do that?
AjK 1:b7e435fbfe8e 176
AjK 1:b7e435fbfe8e 177 1.0 - 20/11/2010
AjK 1:b7e435fbfe8e 178
AjK 1:b7e435fbfe8e 179 * First release.
AjK 1:b7e435fbfe8e 180
AjK 1:b7e435fbfe8e 181 */