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

#include <SerialBase.h>

Inherits NonCopyable< SerialBase >, and NonCopyable< SerialBase >.

Inherited by RawSerial, RawSerial, Serial, Serial, UARTSerial [private], and UARTSerial [private].

Public Member Functions
void	baud (int baudrate)
	Set the baud rate of the serial port.
void	format (int bits=8, Parity parity=SerialBase::None, int stop_bits=1)
	Set the transmission format used by the serial port.
int	readable ()
	Determine if there is a character available to read.
int	writeable ()
	Determine if there is space available to write a character.
void	attach (Callback< void()> func, IrqType type=RxIrq)
	Attach a function to call whenever a serial interrupt is generated.
template<typename T >
	MBED_DEPRECATED_SINCE ("mbed-os-5.1","The attach function does not support cv-qualifiers. Replaced by ""attach(callback(obj, method), type).") void attach(T *obj
	Attach a member function to call whenever a serial interrupt is generated.
void	clear_break ()
	Clear a break condition on the serial line NOTE: Should be run at least one frame after set_break is called.
void	send_break ()
	Generate a break condition on the serial line.
void	set_flow_control (Flow type, PinName flow1=NC, PinName flow2=NC)
	Set the flow control type on the serial port.
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.
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.
void	abort_write ()
	Abort the on-going write transfer.
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.
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.
void	abort_read ()
	Abort the on-going read transfer.
int	set_dma_usage_tx (DMAUsage usage)
	Configure DMA usage suggestion for non-blocking TX transfers.
int	set_dma_usage_rx (DMAUsage usage)
	Configure DMA usage suggestion for non-blocking RX transfers.
void	baud (int baudrate)
	Set the baud rate of the serial port.
void	format (int bits=8, Parity parity=SerialBase::None, int stop_bits=1)
	Set the transmission format used by the serial port.
int	readable ()
	Determine if there is a character available to read.
int	writeable ()
	Determine if there is space available to write a character.
void	attach (Callback< void()> func, IrqType type=RxIrq)
	Attach a function to call whenever a serial interrupt is generated.
template<typename T >
	MBED_DEPRECATED_SINCE ("mbed-os-5.1","The attach function does not support cv-qualifiers. Replaced by ""attach(callback(obj, method), type).") void attach(T *obj
	Attach a member function to call whenever a serial interrupt is generated.
void	clear_break ()
	Clear a break condition on the serial line NOTE: Should be run at least one frame after set_break is called.
void	send_break ()
	Generate a break condition on the serial line.
void	set_flow_control (Flow type, PinName flow1=NC, PinName flow2=NC)
	Set the flow control type on the serial port.
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.
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.
void	abort_write ()
	Abort the on-going write transfer.
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.
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.
void	abort_read ()
	Abort the on-going read transfer.
int	set_dma_usage_tx (DMAUsage usage)
	Configure DMA usage suggestion for non-blocking TX transfers.
int	set_dma_usage_rx (DMAUsage usage)
	Configure DMA usage suggestion for non-blocking RX transfers.
Protected Member Functions
virtual void	lock (void)
	Acquire exclusive access to this serial port.
virtual void	unlock (void)
	Release exclusive access to this serial port.
virtual void	lock (void)
	Acquire exclusive access to this serial port.
virtual void	unlock (void)
	Release exclusive access to this serial port.
Private Member Functions
	MBED_DEPRECATED ("Invalid copy construction of a NonCopyable resource.") NonCopyable(const NonCopyable &)
	NonCopyable copy constructor.
	MBED_DEPRECATED ("Invalid copy assignment of a NonCopyable resource.") NonCopyable &operator
	NonCopyable copy assignment operator.
	MBED_DEPRECATED ("Invalid copy construction of a NonCopyable resource.") NonCopyable(const NonCopyable &)
	NonCopyable copy constructor.
	MBED_DEPRECATED ("Invalid copy assignment of a NonCopyable resource.") NonCopyable &operator
	NonCopyable copy assignment operator.

Detailed Description

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

Note:: Synchronization level: Set by subclass

Definition at line 43 of file cmsis/BUILD/mbed/drivers/SerialBase.h.

Member Function Documentation

void abort_read ( void )

Abort the on-going read transfer.

Definition at line 238 of file SerialBase.cpp.

void abort_read ( )

Abort the on-going read transfer.

void abort_write ( )

Abort the on-going write transfer.

void abort_write ( void )

Abort the on-going write transfer.

Definition at line 228 of file SerialBase.cpp.

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)

Definition at line 77 of file SerialBase.cpp.

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)

void baud ( int baudrate )

Set the baud rate of the serial port.

Parameters:

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

Definition at line 45 of file SerialBase.cpp.

void baud ( int baudrate )

Set the baud rate of the serial port.

Parameters:

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

void clear_break ( )

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

void clear_break ( )

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

Definition at line 129 of file SerialBase.cpp.

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)

Definition at line 53 of file SerialBase.cpp.

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)

virtual void lock ( void ) [protected, virtual]

Acquire exclusive access to this serial port.

Reimplemented in RawSerial, Serial, RawSerial, and Serial.

void lock ( void ) [protected, virtual]

Acquire exclusive access to this serial port.

Reimplemented in RawSerial, Serial, RawSerial, and Serial.

Definition at line 153 of file SerialBase.cpp.

MBED_DEPRECATED_SINCE	(	"mbed-os-5.1"	,
		"The attach function does not support cv-qualifiers. Replaced by ""attach(callback(obj, method), type)."
	)

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)

MBED_DEPRECATED_SINCE	(	"mbed-os-5.1"	,
		"The attach function does not support cv-qualifiers. Replaced by ""attach(callback(obj, method), type)."
	)

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)

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 completion invokes registered RX event callback.

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
char_match	The matching character

Definition at line 266 of file SerialBase.cpp.

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 completion invokes registered RX event callback.

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
char_match	The matching character

Definition at line 276 of file SerialBase.cpp.

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 completion invokes registered RX event callback.

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
char_match	The matching character

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 completion invokes registered RX event callback.

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
char_match	The matching character

int readable ( )

Determine if there is a character available to read.

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

Reimplemented in Serial, and Serial.

Definition at line 60 of file SerialBase.cpp.

int readable ( )

Determine if there is a character available to read.

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

Reimplemented in Serial, and Serial.

void send_break ( )

Generate a break condition on the serial line.

void send_break ( )

Generate a break condition on the serial line.

Definition at line 136 of file SerialBase.cpp.

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

Definition at line 257 of file SerialBase.cpp.

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

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

Definition at line 248 of file SerialBase.cpp.

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

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)

Reimplemented in UARTSerial, and UARTSerial.

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)

Reimplemented in UARTSerial, and UARTSerial.

Definition at line 174 of file SerialBase.cpp.

void unlock ( void ) [protected, virtual]

Release exclusive access to this serial port.

Reimplemented in RawSerial, Serial, RawSerial, and Serial.

Definition at line 158 of file SerialBase.cpp.

virtual void unlock ( void ) [protected, virtual]

Release exclusive access to this serial port.

Reimplemented in RawSerial, Serial, RawSerial, and Serial.

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 completion invokes registered TX event callback

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

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 completion invokes registered TX event callback

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

Definition at line 201 of file SerialBase.cpp.

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 completion invokes registered TX event callback

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

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 completion invokes registered TX event callback

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

Definition at line 210 of file SerialBase.cpp.

int writeable ( )

Determine if there is space available to write a character.

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

Reimplemented in Serial, and Serial.

Definition at line 69 of file SerialBase.cpp.

int writeable ( )

Determine if there is space available to write a character.

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

Reimplemented in Serial, and Serial.

Type:	Library
Created:	23 Jun 2015
Imports:	10846
Forks:	45
Commits:	190
Dependents:	95
Dependencies:	0
Followers:	596

SerialBase Class Reference
[Drivers]

Public Member Functions

Protected Member Functions

Private Member Functions

Detailed Description

Member Function Documentation

Repository toolbox

Repository details

Important Information for this Arm website

SerialBase Class Reference [Drivers]

Public Member Functions

Protected Member Functions

Private Member Functions

Detailed Description

Member Function Documentation

Repository toolbox

Repository details

Important Information for this Arm website

Access Warning

SerialBase Class Reference
[Drivers]