Class implementation for unbuffered I/O for an interrupt driven application or one that needs to have more control. More...
#include <UnbufferedSerial.h>
Public Member Functions | |
| UnbufferedSerial (PinName tx, PinName rx, int baud=MBED_CONF_PLATFORM_DEFAULT_SERIAL_BAUD_RATE) | |
| Create a serial port instance connected to the specified transmit and receive pins, with the specified baud rate. More... | |
| UnbufferedSerial (const serial_pinmap_t &static_pinmap, int baud=MBED_CONF_PLATFORM_DEFAULT_SERIAL_BAUD_RATE) | |
| Create a UnbufferedSerial port, connected to the specified transmit and receive pins, with a particular baud rate. More... | |
| ssize_t | write (const void *buffer, size_t size) override |
| Write the contents of a buffer to a file. More... | |
| ssize_t | read (void *buffer, size_t size) override |
| Read the contents of a file into a buffer. More... | |
| off_t | seek (off_t offset, int whence=SEEK_SET) override |
| Move the file position to a given offset from from a given location. More... | |
| off_t | size () override |
| Get the size of the file. More... | |
| int | isatty () override |
| Check if the file in an interactive terminal device. More... | |
| int | close () override |
| Close a file. More... | |
| int | enable_input (bool enabled) override |
| Enable or disable input. More... | |
| int | enable_output (bool enabled) override |
| Enable or disable output. More... | |
| short | poll (short events) const override |
| Check for poll event flags Check the events listed in events to see if data can be read or written without blocking. More... | |
| void | set_flow_control (Flow type, PinName flow1=NC, PinName flow2=NC) |
| Set the flow control type on the serial port. More... | |
| virtual int | sync () |
| Flush any buffers associated with the file. More... | |
| virtual off_t | tell () |
| Get the file position of the file. More... | |
| virtual void | rewind () |
| Rewind the file position to the beginning of the file. More... | |
| virtual int | truncate (off_t length) |
| Truncate or extend a file. More... | |
| virtual int | set_blocking (bool blocking) |
| Set blocking or nonblocking mode of the file operation like read/write. More... | |
| virtual bool | is_blocking () const |
| Check current blocking or nonblocking mode for file operations. More... | |
| bool | writable () const |
| Definition depends on the subclass implementing FileHandle. More... | |
| bool | readable () const |
| Definition depends on the subclass implementing FileHandle. More... | |
| virtual void | sigio (Callback< void()> func) |
| Register a callback on state change of the file. More... | |
Private Member Functions | |
| void | baud (int baudrate) |
| Set the baud rate of the serial port. More... | |
| void | format (int bits=8, Parity parity=SerialBase::None, int stop_bits=1) |
| Set the transmission format used by the serial port. More... | |
| int | readable () |
| Determine if there is a character available to read. More... | |
| int | writeable () |
| Determine if there is space available to write a character. More... | |
| void | attach (Callback< void()> func, IrqType type=RxIrq) |
| Attach a function to call whenever a serial interrupt is generated. More... | |
| void | set_break () |
| Generate a break condition on the serial line NOTE: Clear break needs to run at least one frame after set_break is called. More... | |
| void | clear_break () |
| Clear a break condition on the serial line NOTE: Should be run at least one frame after set_break is called. More... | |
| void | send_break () |
| Generate a break condition on the serial line. More... | |
| void | set_flow_control (Flow type, const serial_fc_pinmap_t &static_pinmap) |
| Set the flow control type on the serial port. More... | |
| int | write (const uint8_t *buffer, int length, const event_callback_t &callback, int event=SERIAL_EVENT_TX_COMPLETE) |
| Begin asynchronous write using 8bit buffer. More... | |
| int | write (const uint16_t *buffer, int length, const event_callback_t &callback, int event=SERIAL_EVENT_TX_COMPLETE) |
| Begin asynchronous write using 16bit buffer. More... | |
| void | abort_write () |
| Abort the on-going write transfer. More... | |
| int | read (uint8_t *buffer, int length, const event_callback_t &callback, int event=SERIAL_EVENT_RX_COMPLETE, unsigned char char_match=SERIAL_RESERVED_CHAR_MATCH) |
| Begin asynchronous reading using 8bit buffer. More... | |
| int | read (uint16_t *buffer, int length, const event_callback_t &callback, int event=SERIAL_EVENT_RX_COMPLETE, unsigned char char_match=SERIAL_RESERVED_CHAR_MATCH) |
| Begin asynchronous reading using 16bit buffer. More... | |
| void | abort_read () |
| Abort the on-going read transfer. More... | |
| int | set_dma_usage_tx (DMAUsage usage) |
| Configure DMA usage suggestion for non-blocking TX transfers. More... | |
| int | set_dma_usage_rx (DMAUsage usage) |
| Configure DMA usage suggestion for non-blocking RX transfers. More... | |
Class implementation for unbuffered I/O for an interrupt driven application or one that needs to have more control.
Definition at line 47 of file UnbufferedSerial.h.
|
virtualinherited |
Check current blocking or nonblocking mode for file operations.
Reimplemented in BufferedSerial.
Definition at line 174 of file FileHandle.h.
|
inherited |
Definition depends on the subclass implementing FileHandle.
For example, if the FileHandle is of type Stream, readable() could return true when there is something available to read.
Definition at line 248 of file FileHandle.h.
|
virtualinherited |
Rewind the file position to the beginning of the file.
Reimplemented in File, and Stream.
Definition at line 130 of file FileHandle.h.
|
virtualinherited |
Set blocking or nonblocking mode of the file operation like read/write.
Definition depends on the subclass implementing FileHandle. The default is blocking.
| blocking | true for blocking mode, false for nonblocking mode. |
Reimplemented in BufferedSerial.
Definition at line 165 of file FileHandle.h.
|
virtualinherited |
Register a callback on state change of the file.
The specified callback will be called on state changes such as when the file can be written to or read from.
The callback may be called in an interrupt context and should not perform expensive operations.
Note! This is not intended as an attach-like asynchronous API, but rather as a building block for constructing such functionality.
The exact timing of when the registered function is called is not guaranteed and is susceptible to change. It should be used as a cue to make read/write/poll calls to find the current state.
| func | Function to call on state change |
Reimplemented in BufferedSerial.
Definition at line 270 of file FileHandle.h.
|
virtualinherited |
Flush any buffers associated with the file.
Reimplemented in BufferedSerial, File, and Stream.
Definition at line 99 of file FileHandle.h.
|
virtualinherited |
Get the file position of the file.
Reimplemented in File, and Stream.
Definition at line 121 of file FileHandle.h.
|
virtualinherited |
Truncate or extend a file.
The file's length is set to the specified value. The seek pointer is not changed. If the file is extended, the extended area appears as if it were zero-filled.
| length | The requested new length for the file |
Reimplemented in File, and TestFile< FILE_SIZE >.
Definition at line 151 of file FileHandle.h.
|
inherited |
Definition depends on the subclass implementing FileHandle.
For example, if the FileHandle is of type Stream, writable() could return true when there is ample buffer space available for write() calls.
Definition at line 237 of file FileHandle.h.
