Bug fix release

Dependents:   esp8266test

Fork of MODSERIAL by Andy K

Committer:
AjK
Date:
Thu Dec 06 13:06:10 2012 +0000
Revision:
24:9c456e647a8f
Parent:
23:5c45c21f36b7
Child:
25:ae0408ebdd68
1.24RC for new Mbed libraries

Who changed what in which revision?

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