MODSERIAL with support for more devices. Added support for LPC4330

Dependents:   HC05_AT_mode GPS_U-blox_NEO-6M_Test_Code GPS_U-blox_NEO-6M_Code UbloxGPSWithThread ... more

Fork of MODSERIAL by Erik -

Committer:
Sissors
Date:
Fri Jul 12 15:56:20 2013 +0000
Revision:
29:9a41078f0488
Parent:
26:91e4dba7ebe2
Child:
30:b04ce87dc424
Added documentation
;

Who changed what in which revision?

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