The MODSERIAL API

Function: attach.

The Mbed standard Serial library object allows an interrupt callback to be made when a byte is received by the TX or RX UART hardware. MODSERIAL traps these interrupts to enable it's buffering system. However, after the byte has been received/sent under interrupt control, MODSERIAL can callback a user function as a notification of the interrupt. Note, user code should not directly interact with the Uart hardware, MODSERIAL does that, instead, MODSERIAL API functions should be used.

Note, a character is written out then, if there is room in the TX FIFO and the TX buffer is empty, putc() will put the character directly into THR (the output holding register). If the TX FIFO is full and cannot accept the character, it is placed into the TX output buffer. The TX interrupts are then enabled so that when the TX FIFO empties, the TX buffer is then transferred to the THR FIFO. The TxIrq will ONLY be activated when this transfer of a character from BUFFER to THR FIFO takes place. If your character throughput is not high bandwidth, then the 16 byte TX FIFO may be enough and the TX output buffer may never come into play.

 #include "mbed.h"
 #include "MODSERIAL.h"

 DigitalOut led1(LED1);
 DigitalOut led2(LED2);
 DigitalOut led3(LED3);

 // To test, connect p9 to p10 as a loopback.
 MODSERIAL pc(p9, p10);

 // This function is called when a character goes into the TX buffer.
 void txCallback(void) {
     led2 = !led2;
 }

 // This function is called when a character goes into the RX buffer.
 void rxCallback(void) {
     led3 = !led3;
 }

 int main() {
     pc.baud(115200);
     pc.attach(&txCallback, MODSERIAL::TxIrq);
     pc.attach(&rxCallback, MODSERIAL::RxIrq);

     while(1) {
         led1 = !led1;
         wait(0.5);
         pc.putc('A');
         wait(0.5);
     }
 ]

Parameters:

fptr	A pointer to a void function, or 0 to set as none
type	Which serial interrupt to attach the member function to (Seriall::RxIrq for receive, TxIrq for transmit buffer empty)

Definition at line 367 of file MODSERIAL.h.

Function: attach.

The Mbed standard Serial library object allows an interrupt callback to be made when a byte is received by the TX or RX UART hardware. MODSERIAL traps these interrupts to enable it's buffering system. However, after the byte has been received/sent under interrupt control, MODSERIAL can callback a user function as a notification of the interrupt. Note, user code should not directly interact with the Uart hardware, MODSERIAL does that, instead, MODSERIAL API functions should be used.

Note, a character is written out then, if there is room in the TX FIFO and the TX buffer is empty, putc() will put the character directly into THR (the output holding register). If the TX FIFO is full and cannot accept the character, it is placed into the TX output buffer. The TX interrupts are then enabled so that when the TX FIFO empties, the TX buffer is then transferred to the THR FIFO. The TxIrq will ONLY be activated when this transfer of a character from BUFFER to THR FIFO takes place. If your character throughput is not high bandwidth, then the 16 byte TX FIFO may be enough and the TX output buffer may never come into play.

 #include "mbed.h"
 #include "MODSERIAL.h"

 DigitalOut led1(LED1);
 DigitalOut led2(LED2);
 DigitalOut led3(LED3);

 // To test, connect p9 to p10 as a loopback.
 MODSERIAL pc(p9, p10);

 class Foo {
 public:
     // This method is called when a character goes into the TX buffer.
     void txCallback(void) { led2 = !led2; }

     // This method is called when a character goes into the RX buffer.
     void rxCallback(void) { led3 = !led3; }
 };

 Foo foo;

 int main() {
     pc.baud(115200);
     pc.attach(&foo, &Foo::txCallback, MODSERIAL::TxIrq);
     pc.attach(&foo, &Foo::rxCallback, MODSERIAL::RxIrq);

     while(1) {
         led1 = !led1;
         wait(0.5);
         pc.putc('A');
         wait(0.5);
     }
 ]

Parameters:

tptr	A pointer to the object to call the member function on
mptr	A pointer to the member function to be called
type	Which serial interrupt to attach the member function to (Seriall::RxIrq for receive, TxIrq for transmit buffer empty)

Definition at line 429 of file MODSERIAL.h.

Function: autoDetectChar.

Set the char that, if seen incoming, invokes the AutoDetectChar callback.

Parameters:

int	c The character to detect.

Definition at line 694 of file MODSERIAL.h.

Function: claim.

Redirect a stream to this MODSERIAL object

Important: A name parameter must have been added when creating the MODSERIAL object:

 #include "MODSERIAL.h"
 ...
 MODSERIAL pc(USBTX, USBRX, "modser");
 
 int main() {
   pc.claim()            // capture <stdout>
   pc.printf("Uses the MODSERIAL library\r\n");
   printf("So does this!\r\n");
 }

Parameters:

FILE	*stream The stream to redirect (default = stdout)

Returns:

true if succeeded, else false

Definition at line 96 of file MODSERIAL.cpp.

See also:

attach

Definition at line 439 of file MODSERIAL.h.

See also:

attach

Definition at line 446 of file MODSERIAL.h.

Function: getc.

Overloaded version of Serial::getc()

This function blocks (if the RX buffer is empty the function will wait for a character to arrive and then return that character).

Returns:

A byte from the RX buffer

Definition at line 662 of file MODSERIAL.h.

Function: getcNb.

Like getc() but is non-blocking. If no bytes are in the RX buffer this function returns Result::NoChar (-1)

Returns:

A byte from the RX buffer or Result::NoChar (-1) if bufer empty.

Definition at line 649 of file MODSERIAL.h.

Function: move.

Move contents of RX buffer to external buffer. Stops if "end" detected.

Parameters:

char	*s The destination buffer address
int	max The maximum number of chars to move.
char	end If this char is detected stop moving.

Definition at line 706 of file MODSERIAL.h.

Function: move (overloaded)

Move contents of RX buffer to external buffer. Stops if auto_detect_char detected.

Parameters:

int	max The maximum number of chars to move.
char	*s The destination buffer address

Definition at line 728 of file MODSERIAL.h.

Function: printf.

Write a formated string Inhereted from Serial/Stream

See also:

http://mbed.org/projects/libraries/api/mbed/trunk/Serial#Serial.printf

Parameters:

format

A printf-style format string, followed by the variables to use in formating the string.

Function: putc.

Write a character Inhereted from Serial/Stream

See also:

http://mbed.org/projects/libraries/api/mbed/trunk/Serial#Serial.putc

Parameters:

c	The character to write to the serial port

Function: readable.

Determine if there is a byte available to read

Returns:

1 if there is a character available to read, else 0

Definition at line 470 of file MODSERIAL.h.

Function: rxBufferEmpty.

Is the RX buffer empty?

Returns:

true if the RX buffer is empty, otherwise false

Definition at line 71 of file MODSERIAL.cpp.

Function: rxBufferFlush.

Remove all bytes from the RX buffer.

Definition at line 638 of file MODSERIAL.h.

Function: rxBufferFull.

Is the RX buffer full?

Returns:

true if the RX buffer is full, otherwise false

Definition at line 61 of file MODSERIAL.cpp.

Function: rxBufferGetCount.

Returns how many bytes are in the RX buffer

Returns:

The number of bytes in the RX buffer

Definition at line 510 of file MODSERIAL.h.

Function: rxBufferGetSize.

Returns the current size of the RX buffer

Returns:

The length iof the RX buffer in bytes

Definition at line 530 of file MODSERIAL.h.

Function: rxBufferSane.

Determine if the RX buffer has been initialized.

Returns:

true if the buffer is initialized, else false

Definition at line 490 of file MODSERIAL.h.

Function: rxBufferSetSize.

Change the RX buffer size.

See also:

Result

Parameters:

size	The new RX buffer size in bytes.
m	Perform a memory sanity check. Errs the Mbed if memory alloc fails.

Returns:

Result Ok on success.

Definition at line 596 of file MODSERIAL.h.

Function: rxBufferSetSize.

Change the RX buffer size. Always performs a memory sanity check, halting the Mbed on failure.

See also:

Result

Parameters:

size	The new RX buffer size in bytes.

Returns:

Result Ok on success.

Definition at line 622 of file MODSERIAL.h.

rxDiscardLastChar()

Remove the last char placed into the rx buffer. This is an operation that can only be performed by an rxCallback function.

Returns:

The byte removed from the buffer.

Definition at line 31 of file MODSERIAL_IRQ_INFO.cpp.

Function: scanf.

Read a formated string Inhereted from Serial/Stream

See also:

http://mbed.org/projects/libraries/api/mbed/trunk/Serial#Serial.scanf

Parameters:

format

- A scanf-style format string, followed by the pointers to variables to store the results.

Function: txBufferEmpty.

Is the TX buffer empty?

Returns:

true if the TX buffer is empty, otherwise false

Definition at line 66 of file MODSERIAL.cpp.

Function: txBufferFlush.

Remove all bytes from the TX buffer.

Definition at line 630 of file MODSERIAL.h.

Function: txBufferFull.

Is the TX buffer full?

Returns:

true if the TX buffer is full, otherwise false

Definition at line 56 of file MODSERIAL.cpp.

Function: txBufferGetCount.

Returns how many bytes are in the TX buffer

Returns:

The number of bytes in the TX buffer

Definition at line 500 of file MODSERIAL.h.

Function: txBufferGetSize.

Returns the current size of the TX buffer

Returns:

The length iof the TX buffer in bytes

Definition at line 520 of file MODSERIAL.h.

Function: txBufferSane.

Determine if the TX buffer has been initialized.

Returns:

true if the buffer is initialized, else false

Definition at line 480 of file MODSERIAL.h.

Function: txBufferSetSize.

Change the TX buffer size. Always performs a memory sanity check, halting the Mbed on failure.

See also:

Result

Parameters:

size	The new TX buffer size in bytes.

Returns:

Result Ok on success.

Definition at line 609 of file MODSERIAL.h.

Function: txBufferSetSize.

Change the TX buffer size.

See also:

Result

Parameters:

size	The new TX buffer size in bytes.
m	Perform a memory sanity check. Errs the Mbed if memory alloc fails.

Returns:

Result Ok on success.

Definition at line 583 of file MODSERIAL.h.

Function: txIsBusy.

If the Uart is still actively sending characters this function will return true.

Returns:

bool

Function: writeable.

Determine if there is space available to write a byte

Returns:

1 if there is space to write a character, else 0

Definition at line 460 of file MODSERIAL.h.