Inheritance diagram for TinyUsbCdc:

Classes
class	UsbDeviceThread
	Thread for running the tiny usb device stack. More...

Public Member Functions
	TinyUsbCdc (const char *name)

void	hw_postinit ()

void	rx_available ()

void	tx_complete ()

Public Member Functions inherited from Device
	Device (const char *name)
	Constructor.

virtual	~Device ()
	Destructor.

Private Member Functions
void	enable () override
	This will be called once when reference-count goes from 0 to positive.

void	disable () override
	This will be called when reference count goes from non-zero to 0.

void	flush_buffers () override
	Instructs the device driver to drop all TX and RX queues.

bool	select (File *file, int mode) override
	Device select method.

ssize_t	read (File file, void buf, size_t count) override
	Read from a file or device.

ssize_t	write (File file, const void buf, size_t count) override
	Write to a file or device.

Private Attributes
TinyUsbCdc::UsbDeviceThread	usbdThread_

Device::SelectInfo	selectInfoRead_
	Handles the select for incoming data (read).

Device::SelectInfo	selectInfoWrite_
	Handles the select for outgoing data (write).

Additional Inherited Members
Static Public Member Functions inherited from Device
static int	open (struct _reent reent, const char path, int flags, int mode)
	Open a file or device.

static int	close (struct _reent *reent, int fd)
	Close a file or device.

static int	stat (struct _reent reent, const char path, struct stat *stat)
	Get the status information of a file or device.

static int	select (int nfds, fd_set readfds, fd_set writefds, fd_set *exceptfds, long long timeout)
	POSIX select().

static void	select_clear ()
	Clears the current thread's select bits.

Static Public Member Functions inherited from FileIO
static ssize_t	read (struct _reent reent, int fd, void buf, size_t count)
	Read from a file or device.

static ssize_t	write (struct _reent reent, int fd, const void buf, size_t count)
	Write to a file or device.

static _off_t	lseek (struct _reent *reent, int fd, _off_t offset, int whence)
	Change the offset index of a file or device.

static int	fstat (struct _reent reent, int fd, struct stat stat)
	Get the status information of a file or device.

static int	ioctl (int fd, unsigned long int key, unsigned long data)
	Request and ioctl transaction.

static int	fcntl (int fd, int cmd, unsigned long data)
	Manipulate a file descriptor.

static bool	is_device (int fd)
	Test if the file descriptor belongs to a device.

Static Public Member Functions inherited from Singleton< TinyUsbCdc >
static TinyUsbCdc *	instance ()

static bool	exists ()

Protected Member Functions inherited from Node
	Node (const char *name)
	Constructor.

virtual	~Node ()
	Destructor.

int	open (File , const char , int, int) OVERRIDE
	Open method.

int	close (File *) OVERRIDE
	Close method.

virtual int	fstat (File file, struct stat stat) override
	Get the status information of a file or device.

Protected Member Functions inherited from FileIO
	FileIO (const char *name)
	Constructor.

virtual	~FileIO ()
	Destructor.

virtual off_t	lseek (File *f, off_t offset, int whence)
	Seek method.

virtual int	ioctl (File *file, unsigned long int key, unsigned long data)
	Request an ioctl transaction.

virtual int	fcntl (File *file, int cmd, unsigned long data)
	Manipulate a file descriptor.

Static Protected Member Functions inherited from Device
static void	select_insert (SelectInfo *info)
	Add client to list of clients needing woken.

static void	select_wakeup (SelectInfo *info)
	Wakeup the list of clients needing woken.

static void	select_wakeup_from_isr (SelectInfo info, int woken)
	Wakeup the list of clients needing woken.

Static Protected Member Functions inherited from FileIO
static int	fd_alloc (void)
	Allocate a free file descriptor.

static void	fd_free (int fd)
	Free up a file descriptor.

static File *	file_lookup (int fd)
	Looks up a reference to a File corresponding to a given file descriptor.

static int	fd_lookup (File *file)
	Looks up a file descriptor corresponding to a given File reference.

Protected Attributes inherited from Node
OSMutex	lock_
	protects internal structures.

mode_t	mode_
	File open mode, such as O_NONBLOCK.

unsigned int	references_
	number of open references

Protected Attributes inherited from FileIO
const char *	name
	device name

Static Protected Attributes inherited from FileIO
static const unsigned int	numOpenFiles = 20

static File	files []
	File descriptor pool.

static OSMutex	mutex
	mutual exclusion for fileio

Detailed Description

Definition at line 41 of file TinyUsbCdc.hxx.

Constructor & Destructor Documentation

◆ TinyUsbCdc()

TinyUsbCdc::TinyUsbCdc ( const char * name )

inline

Definition at line 44 of file TinyUsbCdc.hxx.

◆ ~TinyUsbCdc()

TinyUsbCdc::~TinyUsbCdc ( )

Definition at line 55 of file TinyUsbCdcImpl.hxx.

Member Function Documentation

◆ disable()

void TinyUsbCdc::disable ( )

inlineoverrideprivatevirtual

This will be called when reference count goes from non-zero to 0.

Called with lock_ held.

Implements Node.

Definition at line 61 of file TinyUsbCdc.hxx.

◆ enable()

void TinyUsbCdc::enable ( )

inlineoverrideprivatevirtual

This will be called once when reference-count goes from 0 to positive.

Called with lock_ held.

Implements Node.

Definition at line 58 of file TinyUsbCdc.hxx.

◆ flush_buffers()

void TinyUsbCdc::flush_buffers ( )

inlineoverrideprivatevirtual

Instructs the device driver to drop all TX and RX queues.

This is called after disable() still under the device lock.

Implements Node.

Definition at line 64 of file TinyUsbCdc.hxx.

◆ hw_postinit()

void TinyUsbCdc::hw_postinit ( )

Definition at line 59 of file TinyUsbCdcImpl.hxx.

◆ read()

ssize_t TinyUsbCdc::read	(	File *	file,
		void *	buf,
		size_t	count
	)

overrideprivatevirtual

Read from a file or device.

Parameters

file	file reference for this device
buf	location to place read data
count	number of bytes to read

Returns: number of bytes read upon success, -1 upon failure with errno containing the cause

Implements FileIO.

Definition at line 83 of file TinyUsbCdcImpl.hxx.

◆ rx_available()

void TinyUsbCdc::rx_available ( )

inline

Definition at line 219 of file TinyUsbCdcImpl.hxx.

◆ select()

bool TinyUsbCdc::select	(	File *	file,
		int	mode
	)

overrideprivatevirtual

Device select method.

Default impementation returns true.

Parameters

file	reference to the file
mode	FREAD for read active, FWRITE for write active, 0 for exceptions

Returns: true if active, false if inactive

Reimplemented from FileIO.

Definition at line 182 of file TinyUsbCdcImpl.hxx.

◆ tx_complete()

void TinyUsbCdc::tx_complete ( )

inline

Definition at line 224 of file TinyUsbCdcImpl.hxx.

◆ write()

ssize_t TinyUsbCdc::write	(	File *	file,
		const void *	buf,
		size_t	count
	)

overrideprivatevirtual

Write to a file or device.

Parameters

file	file reference for this device
buf	location to find write data
count	number of bytes to write

Returns: number of bytes written upon success, -1 upon failure with errno containing the cause

Implements FileIO.

Definition at line 127 of file TinyUsbCdcImpl.hxx.

Member Data Documentation

◆ selectInfoRead_

Device::SelectInfo TinyUsbCdc::selectInfoRead_

private

Handles the select for incoming data (read).

Definition at line 102 of file TinyUsbCdc.hxx.

◆ selectInfoWrite_

Device::SelectInfo TinyUsbCdc::selectInfoWrite_

private

Handles the select for outgoing data (write).

Definition at line 105 of file TinyUsbCdc.hxx.

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

Classes

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ TinyUsbCdc()

◆ ~TinyUsbCdc()

Member Function Documentation

◆ disable()

◆ enable()

◆ flush_buffers()

◆ hw_postinit()

◆ read()

◆ rx_available()

◆ select()

◆ tx_complete()

◆ write()

Member Data Documentation

◆ selectInfoRead_

◆ selectInfoWrite_