pw_stream_uart_linux

Overview

UART stream implementation for Linux.

Main docs: Home

Classes
class	pw::stream::UartStreamLinux
	pw::stream::NonSeekableReaderWriter implementation for UARTs on Linux. More...
struct	pw::stream::UartStreamLinux::Config

Functions
UartStreamLinux &	pw::stream::UartStreamLinux::operator= (UartStreamLinux &&other)
	pw::stream::UartStreamLinux::UartStreamLinux (UartStreamLinux &&other) noexcept
	pw::stream::UartStreamLinux::UartStreamLinux (const UartStreamLinux &)=delete
UartStreamLinux &	pw::stream::UartStreamLinux::operator= (const UartStreamLinux &)=delete
Status	pw::stream::UartStreamLinux::Open (const char *path, uint32_t baud_rate)
Status	pw::stream::UartStreamLinux::Open (const char *path, Config config)
void	pw::stream::UartStreamLinux::Close ()
Status	pw::stream::UartStreamLinux::DoWrite (ConstByteSpan data) override
	Virtual Write() function implemented by derived classes.
StatusWithSize	pw::stream::UartStreamLinux::DoRead (ByteSpan dest) override
	Virtual Read() function implemented by derived classes.

Variables
std::optional< uint32_t >	pw::stream::UartStreamLinux::Config::baud_rate
std::optional< bool >	pw::stream::UartStreamLinux::Config::flow_control

Function Documentation

DoRead()

StatusWithSize pw::stream::UartStreamLinux::DoRead ( ByteSpan  destination )

overrideprivatevirtual

Virtual Read() function implemented by derived classes.

Implements pw::stream::Stream.

DoWrite()

Status pw::stream::UartStreamLinux::DoWrite ( ConstByteSpan  data )

overrideprivatevirtual

Virtual Write() function implemented by derived classes.

Implements pw::stream::Stream.

Open() [1/2]

Status pw::stream::UartStreamLinux::Open	(	const char *	path,
		Config	config
	)

Open a UART device using the specified Config struct.

Parameters

[in]	path	Path to the TTY device.
[in]	config	UartStreamLinux configuration structure.

Returns

• OK: The device was successfully opened and configured.
• INVALID_ARGUMENT: Invalid config, for e.g. unsupported baud rate.
• FAILED_PRECONDITION: A device was already open.
• UNKNOWN: An error was returned by the operating system.

Open() [2/2]

Status pw::stream::UartStreamLinux::Open ( const char *  path, uint32_t  baud_rate  )

inline

Open a UART device using the specified baud rate.

Parameters

[in]	path	Path to the TTY device.
[in]	baud_rate	Baud rate to use for the device.

Returns

• OK: The device was successfully opened and configured.
• INVALID_ARGUMENT: An unsupported baud rate was supplied.
• FAILED_PRECONDITION: A device was already open.
• UNKNOWN: An error was returned by the operating system.