MODSERIAL with support for more devices

Dependents:   1D-Pong BMT-K9_encoder BMT-K9-Regelaar programma_filter ... more

Check the cookbook page for more information: https://mbed.org/cookbook/MODSERIAL

Did you add a device? Please send a pull request so we can keep everything in one library instead of many copies. In that case also send a PM, since currently mbed does not inform of new pull requests. I will then also add you to the developers of this library so you can do other changes directly.

Committer:
Sissors
Date:
Mon Jun 10 19:06:21 2013 +0000
Revision:
26:91e4dba7ebe2
Parent:
25:ae0408ebdd68
Child:
29:9a41078f0488
_uidx reference in DMA code replaced by _serial.index

Who changed what in which revision?

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