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

#include <SerialBase.h>

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 (void(*fptr)(void), IrqType type=RxIrq)
	Attach a function to call whenever a serial interrupt is generated.
template<typename T >
void	attach (T tptr, void(T::mptr)(void), IrqType type=RxIrq)
	Attach a member function to call whenever a serial interrupt is generated.
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.

Detailed Description

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

Definition at line 37 of file SerialBase.h.

Member Function Documentation

void abort_read ( void )

Abort the on-going read transfer.

Definition at line 144 of file SerialBase.cpp.

void abort_write ( void )

Abort the on-going write transfer.

Definition at line 139 of file SerialBase.cpp.

void attach	(	void(*)(void)	fptr,
		IrqType	type = `RxIrq`
	)

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

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 51 of file SerialBase.cpp.

void attach	(	T *	tptr,
		void(T::*)(void)	mptr,
		IrqType	type = `RxIrq`
	)

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

Parameters:

tptr	pointer to the object to call the member function on
mptr	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 104 of file SerialBase.h.

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 33 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	The number of stop bits (1 or 2; default = 1)

Definition at line 38 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 completition invokes registred RX event callback.

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 167 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 completition invokes registred RX event callback.

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 177 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

Definition at line 42 of file SerialBase.cpp.

void send_break ( )

Generate a break condition on the serial line.

Definition at line 74 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 158 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

Definition at line 149 of file SerialBase.cpp.

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)

Definition at line 89 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 completition invokes registered TX event callback

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 113 of file SerialBase.cpp.

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

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 122 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

Definition at line 47 of file SerialBase.cpp.

Type:	Library
Created:	16 Aug 2015
Imports:	4
Forks:	0
Commits:	612
Dependents:	0
Dependencies:	0
Followers:	1

SerialBase Class Reference

Public Member Functions

Detailed Description

Member Function Documentation

Repository toolbox

Repository details

Important Information for this Arm website

SerialBase Class Reference

Public Member Functions

Detailed Description

Member Function Documentation

Repository toolbox

Repository details

Important Information for this Arm website

Access Warning