TheRobotStudio ROSA / MODSERIAL

Fork of the MODSERIAL library by Erik Olieman.

Dependents:   trs_master

Fork of MODSERIAL by Erik -

ChangeLog.c@18:21ef26402365, 2011-04-21 (annotated)

Committer:
AjK
Date:
Thu Apr 21 09:20:41 2011 +0000
Revision:
18:21ef26402365
Parent:
17:6c9b57c14868
Child:
20:59c74aaedda2
1.18 See ChangeLog.c

Who changed what in which revision?

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