Create a Serial port, connected to the specified transmit and receive pins.

Parameters

tx	Transmit pin
rx	Receive pin
name	The name of the stream associated with this serial port (optional)
baud	The baud rate of the serial port (optional, defaults to MBED_CONF_PLATFORM_DEFAULT_SERIAL_BAUD_RATE or 9600)

Note

Either tx or rx may be specified as NC (Not Connected) if unused

Create a Serial port, connected to the specified transmit and receive pins, with the specified baud.

Parameters

tx	Transmit pin
rx	Receive pin
baud	The baud rate of the serial port

Note

Either tx or rx may be specified as NC (Not Connected) if unused

Abort the on-going read transfer.

It is safe to call abort_read() when there is no on-going transaction.

Abort the on-going write transfer.

It is safe to call abort_write() when there is no on-going transaction.

Attach a function to call whenever a serial interrupt is generated.

Parameters

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

Attach a member function to call whenever a serial interrupt is generated.

Parameters

obj	pointer to the object to call the member function on
method	pointer to the member function to be called
type	Which serial interrupt to attach the member function to (Serial::RxIrq for receive, TxIrq for transmit buffer empty)

Deprecated:

The attach function does not support cv-qualifiers. Replaced by attach(callback(obj, method), type).

Definition at line 121 of file SerialBase.h.

Attach a member function to call whenever a serial interrupt is generated.

Parameters

obj	pointer to the object to call the member function on
method	pointer to the member function to be called
type	Which serial interrupt to attach the member function to (Serial::RxIrq for receive, TxIrq for transmit buffer empty)

Deprecated:

The attach function does not support cv-qualifiers. Replaced by attach(callback(obj, method), type).

Definition at line 139 of file SerialBase.h.

Set the baud rate of the serial port.

Parameters

baudrate

The baudrate of the serial port (default = 9600).

Clear a break condition on the serial line NOTE: Should be run at least one frame after set_break is called.

Close a file.

Returns

0 on success, negative error code on failure

Implements FileHandle.

Enable serial input.

If both serial input and serial output are disabled, the peripheral is freed. If either serial input or serial output is re-enabled, the peripheral is reinitialized.

On re-initialization rx interrupts will be enabled if a rx handler is attached. The rx handler is called once during re-initialization.

Enable or disable input.

Control enabling of device for input. This is primarily intended for temporary power-saving; the overall ability of the device to operate for input and/or output may be fixed at creation time, but this call can allow input to be temporarily disabled to permit power saving without losing device state.

Parameters

enabled

true to enable input, false to disable.

Returns

0 on success

Negative error code on failure

Reimplemented in UARTSerial.

Definition at line 236 of file FileHandle.h.

Enable serial output.

If both serial input and serial output are disabled, the peripheral is freed. If either serial input or serial output is re-enabled, the peripheral is reinitialized.

On re-initialization tx interrupts will be enabled if a tx handler is attached. The tx handler is called once during re-initialization.

Enable or disable output.

Control enabling of device for output. This is primarily intended for temporary power-saving; the overall ability of the device to operate for input and/or output may be fixed at creation time, but this call can allow output to be temporarily disabled to permit power saving without losing device state.

Parameters

enabled

true to enable output, false to disable.

Returns

0 on success

Negative error code on failure

Reimplemented in UARTSerial.

Definition at line 254 of file FileHandle.h.

Find the length of the file.

Returns

Length of the file

Deprecated:

Replaced by `off_t FileHandle::size()'

Definition at line 195 of file FileHandle.h.

Set the transmission format used by the serial port.

Parameters

bits	The number of bits in a word (5-8; default = 8)
parity	The parity used (SerialBase::None, SerialBase::Odd, SerialBase::Even, SerialBase::Forced1, SerialBase::Forced0; default = SerialBase::None)
stop_bits	The number of stop bits (1 or 2; default = 1)

Flush any buffers associated with the FileHandle, ensuring it is up to date on disk.

Returns

0 on success or un-needed, -1 on error

Deprecated:

Replaced by `int FileHandle::sync()'

Definition at line 183 of file FileHandle.h.

Check current blocking or nonblocking mode for file operations.

Returns

true for blocking mode, false for nonblocking mode.

Reimplemented in UARTSerial.

Definition at line 218 of file FileHandle.h.

Check if the file in an interactive terminal device.

Returns

True if the file is a terminal

False if the file is not a terminal

Negative error code on failure

Reimplemented from FileHandle.

Acquire exclusive access to this object.

Definition at line 80 of file Stream.h.

Move the file position to a given offset from a given location.

Parameters

offset	The offset from whence to move to
whence	SEEK_SET for the start of the file, SEEK_CUR for the current file position, or SEEK_END for the end of the file.

Returns

new file position on success, -1 on failure or unsupported

Deprecated:

Replaced by `off_t FileHandle::seek(off_t offset, int whence = SEEK_SET)'

Definition at line 169 of file FileHandle.h.

Check for poll event flags You can use or ignore the input parameter.

You can return all events or check just the events listed in events. Call is nonblocking - returns instantaneous state of events. Whenever an event occurs, the derived class should call the sigio() callback).

Parameters

events

bitmask of poll events we're interested in - POLLIN/POLLOUT etc.

Returns

bitmask of poll events that have occurred.

Reimplemented in UARTSerial.

Definition at line 269 of file FileHandle.h.

Read the contents of a file into a buffer.

Devices acting as FileHandles should follow POSIX semantics:

• if no data is available, and nonblocking set, return -EAGAIN
• if no data is available, and blocking set, wait until some data is available
• If any data is available, call returns immediately

Parameters

buffer	The buffer to read in to
size	The number of bytes to read

Returns

The number of bytes read, 0 at end of file, negative error on failure

Implements FileHandle.

Begin asynchronous reading using 8bit buffer.

The read operation ends with any of the enabled events and invokes registered callback function (which can be NULL to not receive callback at all). Events that are not enabled by event argument are simply ignored. Operation has to be ended explicitly by calling abort_read() when no events are enabled. This function locks the deep sleep until any event has occurred.

Parameters

buffer	The buffer where received data will be stored
length	The buffer length in bytes
callback	The event callback function
event	The logical OR of RX events that should end operation
char_match	The matching character

Returns

Zero if new transaction was started, -1 if transaction is already on-going

Begin asynchronous reading using 16bit buffer.

The read operation ends with any of the enabled events and invokes registered callback function (which can be NULL to not receive callback at all). Events that are not enabled by event argument are simply ignored. Operation has to be ended explicitly by calling abort_read() when no events are enabled. This function locks the deep sleep until any event has occurred.

Parameters

buffer	The buffer where received data will be stored
length	The buffer length in bytes
callback	The event callback function
event	The logical OR of RX events that should end operation
char_match	The matching character

Returns

Zero if new transaction was started, -1 if transaction is already on-going

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.

Returns

true when there is something available to read.

Definition at line 292 of file FileHandle.h.

Rewind the file position to the beginning of the file.

Note

This is equivalent to seek(0, SEEK_SET)

Reimplemented from FileHandle.

Move the file position to a given offset from from a given location.

Parameters

offset	The offset from whence to move to
whence	The start of where to seek SEEK_SET to start from beginning of file, SEEK_CUR to start from current position in file, SEEK_END to start from end of file

Returns

The new offset of the file, negative error code on failure

Implements FileHandle.

Generate a break condition on the serial line.

Set blocking or nonblocking mode of the file operation like read/write.

Definition depends on the subclass implementing FileHandle. The default is blocking.

Parameters

blocking

true for blocking mode, false for nonblocking mode.

Returns

0 on success

Negative error code on failure

Reimplemented in UARTSerial.

Definition at line 209 of file FileHandle.h.

Generate a break condition on the serial line NOTE: Clear break needs to run at least one frame after set_break is called.

Configure DMA usage suggestion for non-blocking RX transfers.

Parameters

usage

The usage DMA hint for peripheral

Returns

Zero if the usage was set, -1 if a transaction is on-going

Configure DMA usage suggestion for non-blocking TX transfers.

Parameters

usage

The usage DMA hint for peripheral

Returns

Zero if the usage was set, -1 if a transaction is on-going

Set the flow control type on the serial port.

Parameters

type	the flow control type (Disabled, RTS, CTS, RTSCTS)
flow1	the first flow control pin (RTS for RTS or RTSCTS, CTS for CTS)
flow2	the second flow control pin (CTS for RTSCTS)

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.

Parameters

func	Function to call on state change

Reimplemented in UARTSerial.

Definition at line 314 of file FileHandle.h.

Get the size of the file.

Returns

Size of the file in bytes

Reimplemented from FileHandle.

Flush any buffers associated with the file.

Returns

0 on success, negative error code on failure

Reimplemented from FileHandle.

Get the file position of the file.

Note

This is equivalent to seek(0, SEEK_CUR)

Returns

The current offset in the file, negative error code on failure

Reimplemented from FileHandle.

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.

Parameters

length

The requested new length for the file

Returns

Zero on success, negative error code on failure

Reimplemented in File, and TestFile< FILE_SIZE >.

Definition at line 151 of file FileHandle.h.

Release exclusive access to this object.

Definition at line 87 of file Stream.h.

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.

Returns

true if the FileHandle is writable.

Definition at line 281 of file FileHandle.h.

Write the contents of a buffer to a file.

Devices acting as FileHandles should follow POSIX semantics:

• if blocking, block until all data is written
• if no data can be written, and nonblocking set, return -EAGAIN

• if some data can be written, and nonblocking set, write partial

  Parameters

  buffer	The buffer to write from
  size	The number of bytes to write

  Returns

  The number of bytes written, negative error on failure

Implements FileHandle.

Begin asynchronous write using 8bit buffer.

The write operation ends with any of the enabled events and invokes registered callback function (which can be NULL to not receive callback at all). Events that are not enabled by event argument are simply ignored. Operation has to be ended explicitly by calling abort_write() when no events are enabled. This function locks the deep sleep until any event has occurred.

Parameters

buffer	The buffer where received data will be stored
length	The buffer length in bytes
callback	The event callback function
event	The logical OR of TX events that should end operation

Returns

Zero if new transaction was started, -1 if transaction is already on-going

Begin asynchronous write using 16bit buffer.

The write operation ends with any of the enabled events and invokes registered callback function (which can be NULL to not receive callback at all). Events that are not enabled by event argument are simply ignored. Operation has to be ended explicitly by calling abort_write() when no events are enabled. This function locks the deep sleep until any event has occurred.

Parameters

buffer	The buffer where received data will be stored
length	The buffer length in bytes
callback	The event callback function
event	The logical OR of TX events that should end operation

Returns

Zero if new transaction was started, -1 if transaction is already on-going