A base class for serial port implementations Can't be instantiated directly (use UnbufferedSerial or BufferedSerial) More...

#include <SerialBase.h>

Inheritance diagram for SerialBase:

Public 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	enable_input (bool enable=true)
	Enable serial input. More...

void	enable_output (bool enable=true)
	Enable serial output. More...

void	set_flow_control (Flow type, PinName flow1=NC, PinName flow2=NC)
	Set the flow control type on the serial port. 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...

Detailed Description

A base class for serial port implementations Can't be instantiated directly (use UnbufferedSerial or BufferedSerial)

Note: Synchronization level: Set by subclass

Definition at line 46 of file SerialBase.h.

Member Function Documentation

◆ baud()

void baud ( int baudrate )

Set the baud rate of the serial port.

Parameters

baudrate The baudrate of the serial port (default = platform.default-serial-baud-rate).

◆ format()

void format	(	int	bits = `8`,
		Parity	parity = `SerialBase::None`,
		int	stop_bits = `1`
	)

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)

◆ readable()

int readable ( )

Determine if there is a character available to read.

Returns: 1 if there is a character available to read, 0 otherwise

◆ writeable()

int writeable ( )

Determine if there is space available to write a character.

Returns: 1 if there is space to write a character, 0 otherwise

◆ attach()

void attach	(	Callback< void()>	func,
		IrqType	type = `RxIrq`
	)

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)

◆ set_break()

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.

◆ clear_break()

void clear_break ( )

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

◆ send_break()

void send_break ( )

Generate a break condition on the serial line.

◆ enable_input()

void enable_input ( bool enable = true )

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_output()

void enable_output ( bool enable = true )

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.

◆ set_flow_control() [1/2]

void set_flow_control	(	Flow	type,
		PinName	flow1 = `NC`,
		PinName	flow2 = `NC`
	)

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)

◆ set_flow_control() [2/2]

void set_flow_control	(	Flow	type,
		const serial_fc_pinmap_t &	static_pinmap
	)

Set the flow control type on the serial port.

Parameters

type	the flow control type (Disabled, RTS, CTS, RTSCTS)
static_pinmap	reference to structure which holds static pinmap

◆ write() [1/2]

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.

The write operation ends with any of the enabled events and invokes registered callback function (which can be empty 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

◆ write() [2/2]

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.

The write operation ends with any of the enabled events and invokes registered callback function (which can be empty 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

◆ abort_write()

void abort_write ( )

Abort the on-going write transfer.

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

◆ read() [1/2]

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.

The read operation ends with any of the enabled events and invokes registered callback function (which can be empty 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

◆ read() [2/2]

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.

The read operation ends with any of the enabled events and invokes registered callback function (which can be empty 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

◆ abort_read()

void abort_read ( )

Abort the on-going read transfer.

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

◆ set_dma_usage_tx()

int set_dma_usage_tx ( DMAUsage usage )

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_dma_usage_rx()

int set_dma_usage_rx ( DMAUsage usage )

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

Public Member Functions

Detailed Description

Member Function Documentation

◆ baud()

◆ format()

◆ readable()

◆ writeable()

◆ attach()

◆ set_break()

◆ clear_break()

◆ send_break()

◆ enable_input()

◆ enable_output()

◆ set_flow_control() [1/2]

◆ set_flow_control() [2/2]

◆ write() [1/2]

◆ write() [2/2]

◆ abort_write()

◆ read() [1/2]

◆ read() [2/2]

◆ abort_read()

◆ set_dma_usage_tx()

◆ set_dma_usage_rx()