Richard Osterloh / MODSERIAL

Bug fix release

Fork of MODSERIAL by Andy K

ChangeLog.c@26:3c3982fbdf18, 2015-02-16 (annotated)

Committer:
rosterloh84
Date:
Mon Feb 16 10:32:36 2015 +0000
Revision:
26:3c3982fbdf18
Parent:
25:ae0408ebdd68 
Changes need to support TARGET_STM

Who changed what in which revision?

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