#include <Serial.hh>

Inheritance diagram for Serial:

Collaboration diagram for Serial:

Public Types
enum	{ DATA5 = 0, DATA6 = _BV(UCSZ00), DATA7 = _BV(UCSZ01), DATA8 = _BV(UCSZ01) \| _BV(UCSZ00), NO_PARITY = 0, EVEN_PARITY = _BV(UPM01), ODD_PARITY = _BV(UPM01) \| _BV(UPM00), STOP1 = 0, STOP2 = _BV(USBS0) }

Public Member Functions
	Serial ()

virtual bool	begin (uint32_t baudrate=DEFAULT_BAUDRATE, uint8_t format=DEFAULT_FORMAT)=0

virtual bool	end ()

virtual void	powerup ()

virtual void	powerdown ()

void	non_blocking ()

void	blocking ()

bool	is_blocking () const

void	eol (Mode mode)

Mode	eol () const

virtual int	available ()

virtual int	room ()

virtual int	putchar (char c)

virtual int	puts (const char *s)

virtual int	puts (str_P s)

virtual int	write (const void *buf, size_t size)

virtual int	write (const iovec_t *vec)

virtual int	write_P (const void *buf, size_t size)

virtual int	peekchar ()

virtual int	peekchar (char c)

virtual int	getchar ()

virtual char *	gets (char *s, size_t count)

virtual int	read (void *buf, size_t size)

virtual int	read (iovec_t *vec)

virtual int	flush ()

virtual void	empty ()

Static Public Attributes
static const uint32_t	DEFAULT_BAUDRATE = 9600L

static const uint8_t	DEFAULT_FORMAT = DATA8 + NO_PARITY + STOP2

Protected Attributes
bool	m_blocking

Mode	m_eol

Detailed Description

Abstract Serial IOStream Device class. Common definitions for hardware and software UARTs. Hardware serial format symbols are used.

Definition at line 40 of file Serial.hh.

Member Enumeration Documentation

anonymous enum

Serial formats; DATA + PARITY + STOP.

Enumerator
DATA5
DATA6
DATA7
DATA8
NO_PARITY
EVEN_PARITY
ODD_PARITY
STOP1
STOP2

Definition at line 46 of file Serial.hh.

Constructor & Destructor Documentation

Serial::Serial ( )

inline

Default Serial device driver constructor.

Definition at line 64 of file Serial.hh.

Member Function Documentation

int IOStream::Device::available ( )

virtualinherited

Number of bytes available (possible to read).

Returns: bytes.

Reimplemented in W5200::Driver, W5500::Driver, W5100::Driver, Soft::UART, UART, IOBuffer< SIZE >, and CC3000::Driver.

Definition at line 24 of file IOStream_Device.cpp.

virtual bool Serial::begin	(	uint32_t	baudrate = `DEFAULT_BAUDRATE`,
		uint8_t	format = `DEFAULT_FORMAT`
	)

pure virtual

Start Serial device driver with given serial bitrate and serial format.

Parameters

[in]	baudrate	serial bitrate (default 9600).
[in]	format	serial frame format (default DATA8, NO PARITY, STOP2).

Returns: true(1) if successful otherwise false(0)

Implemented in Soft::UART, UART, and Soft::UAT.

void IOStream::Device::blocking ( )

inlineinherited

Set blocking mode.

Definition at line 85 of file IOStream.hh.

void IOStream::Device::empty ( )

virtualinherited

Empty internal device buffers.

Reimplemented in Soft::UART, UART, and IOBuffer< SIZE >.

Definition at line 175 of file IOStream_Device.cpp.

virtual bool Serial::end ( )

inlinevirtual

Stop Serial device driver.

Returns: true(1) if successful otherwise false(0)

Reimplemented in Soft::UART, and UART.

Definition at line 82 of file Serial.hh.

void IOStream::Device::eol ( Mode mode )

inlineinherited

Set end of line mode.

Parameters

[in] mode for end of line.

Definition at line 103 of file IOStream.hh.

Mode IOStream::Device::eol ( ) const

inlineinherited

Get end of line mode.

Returns: mode.

Definition at line 112 of file IOStream.hh.

int IOStream::Device::flush ( )

virtualinherited

Flush internal device buffers. Wait for device to become idle.

Returns: zero(0) or negative error code.

Reimplemented in W5200::Driver, W5500::Driver, W5100::Driver, UART, IOBuffer< SIZE >, CC3000::Driver, and WIO.

Definition at line 169 of file IOStream_Device.cpp.

int IOStream::Device::getchar ( )

virtualinherited

Read character from device.

Returns: character or EOF(-1).

Reimplemented in FAT16::File, CFFS::File, Soft::UART, UART, IOBuffer< SIZE >, and Socket.

Definition at line 112 of file IOStream_Device.cpp.

char * IOStream::Device::gets	(	char *	s,
		size_t	count
	)

virtualinherited

Read string terminated by new-line or until size into given string buffer. Returns pointer to string or NULL if empty line.

Parameters

[in]	s	string buffer to read into.
[in]	count	max number of bytes to read.

Returns: string pointer or NULL.

Definition at line 118 of file IOStream_Device.cpp.

bool IOStream::Device::is_blocking ( ) const

inlineinherited

Is blocking mode?

Returns: bool.

Definition at line 94 of file IOStream.hh.

void IOStream::Device::non_blocking ( )

inlineinherited

Set non-blocking mode.

Definition at line 77 of file IOStream.hh.

int IOStream::Device::peekchar ( )

virtualinherited

Peek at the next character from device.

Returns: character or EOF(-1).

Reimplemented in Soft::UART, UART, and IOBuffer< SIZE >.

Definition at line 99 of file IOStream_Device.cpp.

int IOStream::Device::peekchar ( char c )

virtualinherited

Peek for the given character in device buffer. Return number of characters or EOF(-1).

Parameters

[in] c character to peek for.

Returns: available or EOF(-1).

Reimplemented in Soft::UART, UART, and IOBuffer< SIZE >.

Definition at line 105 of file IOStream_Device.cpp.

virtual void Serial::powerdown ( )

inlinevirtual

Powerdown Serial.

Reimplemented in UART.

Definition at line 97 of file Serial.hh.

virtual void Serial::powerup ( )

inlinevirtual

Powerup Serial.

Reimplemented in UART.

Definition at line 91 of file Serial.hh.

int IOStream::Device::putchar ( char c )

virtualinherited

Write character to device.

Parameters

[in] c character to write.

Returns: character written or EOF(-1).

Reimplemented in FAT16::File, HD44780, ST7565, PCD8544, MAX72XX, VLCD, UART, Textbox, IOBuffer< SIZE >, RS485, WIO, and Soft::UAT.

Definition at line 36 of file IOStream_Device.cpp.

int IOStream::Device::puts ( const char * s )

virtualinherited

Write null terminated string to device. Terminating null is not written.

Parameters

[in] s string to write.

Returns: zero(0) or negative error code.

Definition at line 43 of file IOStream_Device.cpp.

int IOStream::Device::puts ( str_P s )

virtualinherited

Write null terminated string from program memory to device. Terminating null is not written.

Parameters

[in] s string in program memory to write.

Returns: zero(0) or negative error code.

Definition at line 54 of file IOStream_Device.cpp.

int IOStream::Device::read	(	void *	buf,
		size_t	size
	)

virtualinherited

Read data to given buffer with given size from device.

Parameters

[in]	buf	buffer to read into.
[in]	size	number of bytes to read.

Returns: number of bytes read or EOF(-1).

Reimplemented in FAT16::File, W5200::Driver, W5500::Driver, W5100::Driver, CFFS::File, Socket, and CC3000::Driver.

Definition at line 144 of file IOStream_Device.cpp.

int IOStream::Device::read ( iovec_t * vec )

virtualinherited

Read data to given buffers in null terminated io vector.

Parameters

[in] vec io vector with buffers to read into.

Returns: number of bytes read or EOF(-1).

Definition at line 157 of file IOStream_Device.cpp.

int IOStream::Device::room ( )

virtualinherited

Number of bytes room (write without blocking).

Returns: bytes.

Reimplemented in W5200::Driver, W5500::Driver, W5100::Driver, UART, IOBuffer< SIZE >, CC3000::Driver, and WIO.

Definition at line 30 of file IOStream_Device.cpp.

int IOStream::Device::write	(	const void *	buf,
		size_t	size
	)

virtualinherited

Write data from buffer with given size to device.

Parameters

[in]	buf	buffer to write.
[in]	size	number of bytes to write.

Returns: number of bytes written or EOF(-1).

Reimplemented in FAT16::File, HD44780, CFFS::File, VLCD, Socket, and CC3000::Driver.

Definition at line 65 of file IOStream_Device.cpp.

int IOStream::Device::write ( const iovec_t * vec )

virtualinherited

Write data from buffers in null terminated io vector.

Parameters

[in] vec io vector with buffers to write.

Returns: number of bytes written or EOF(-1).

Definition at line 87 of file IOStream_Device.cpp.

int IOStream::Device::write_P	(	const void *	buf,
		size_t	size
	)

virtualinherited

Write data from buffer in program memory with given size to device.

Parameters

[in]	buf	buffer to write.
[in]	size	number of bytes to write.

Returns: number of bytes written or EOF(-1).

Reimplemented in CFFS::File, Socket, and CC3000::Driver.

Definition at line 76 of file IOStream_Device.cpp.

Member Data Documentation

const uint32_t Serial::DEFAULT_BAUDRATE = 9600L

static

Default baudrate.

Definition at line 43 of file Serial.hh.

const uint8_t Serial::DEFAULT_FORMAT = DATA8 + NO_PARITY + STOP2

static

Default serial format.

Definition at line 59 of file Serial.hh.

bool IOStream::Device::m_blocking

protectedinherited

Blocking state

Definition at line 248 of file IOStream.hh.

Mode IOStream::Device::m_eol

protectedinherited

End of line mode

Definition at line 251 of file IOStream.hh.

The documentation for this class was generated from the following file:

cores/cosa/Cosa/Serial.hh

Public Types

Public Member Functions

Static Public Attributes

Protected Attributes

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation