#include <terminal.hh>

Inheritance diagram for Terminal:

Classes
class	DataEvent

class	ListenEvent

Public Types
typedef TerminalParams	Params

Public Types inherited from SimObject
typedef SimObjectParams	Params

Public Member Functions
	Terminal (const Params *p)

	~Terminal ()

OutputStream *	terminalDump (const TerminalParams *p)

void	data ()

void	read (uint8_t &c)

size_t	read (uint8_t *buf, size_t len)

void	write (uint8_t c)

size_t	write (const uint8_t *buf, size_t len)

void	detach ()

uint8_t	readData () override
	Read a character from the device. More...

void	writeData (uint8_t c) override
	Transmit a character from the host interface to the device. More...

bool	dataAvailable () const override
	Check if there is pending data from the serial device. More...

uint64_t	console_in ()

Public Member Functions inherited from SerialDevice
	SerialDevice (const SerialDeviceParams *p)

	~SerialDevice ()

void	regInterfaceCallback (const std::function< void()> &callback)
	Register a data available callback into the host interface layer. More...

Public Member Functions inherited from SimObject
const Params *	params () const

	SimObject (const Params *_params)

virtual	~SimObject ()

virtual const std::string	name () const

virtual void	init ()
	init() is called after all C++ SimObjects have been created and all ports are connected. More...

virtual void	loadState (CheckpointIn &cp)
	loadState() is called on each SimObject when restoring from a checkpoint. More...

virtual void	initState ()
	initState() is called on each SimObject when not restoring from a checkpoint. More...

virtual void	regProbePoints ()
	Register probe points for this object. More...

virtual void	regProbeListeners ()
	Register probe listeners for this object. More...

ProbeManager *	getProbeManager ()
	Get the probe manager for this object. More...

virtual Port &	getPort (const std::string &if_name, PortID idx=InvalidPortID)
	Get a port with a given name and index. More...

virtual void	startup ()
	startup() is the final initialization call before simulation. More...

DrainState	drain () override
	Provide a default implementation of the drain interface for objects that don't need draining. More...

virtual void	memWriteback ()
	Write back dirty buffers to memory using functional writes. More...

virtual void	memInvalidate ()
	Invalidate the contents of memory buffers. More...

void	serialize (CheckpointOut &cp) const override
	Serialize an object. More...

void	unserialize (CheckpointIn &cp) override
	Unserialize an object. More...

Public Member Functions inherited from EventManager
EventQueue *	eventQueue () const

void	schedule (Event &event, Tick when)

void	deschedule (Event &event)

void	reschedule (Event &event, Tick when, bool always=false)

void	schedule (Event *event, Tick when)

void	deschedule (Event *event)

void	reschedule (Event *event, Tick when, bool always=false)

void	wakeupEventQueue (Tick when=(Tick) -1)
	This function is not needed by the usual gem5 event loop but may be necessary in derived EventQueues which host gem5 on other schedulers. More...

void	setCurTick (Tick newVal)

	EventManager (EventManager &em)
	Event manger manages events in the event queue. More...

	EventManager (EventManager *em)

	EventManager (EventQueue *eq)

Public Member Functions inherited from Serializable
	Serializable ()

virtual	~Serializable ()

void	serializeSection (CheckpointOut &cp, const char *name) const
	Serialize an object into a new section. More...

void	serializeSection (CheckpointOut &cp, const std::string &name) const

void	unserializeSection (CheckpointIn &cp, const char *name)
	Unserialize an a child object. More...

void	unserializeSection (CheckpointIn &cp, const std::string &name)

Public Member Functions inherited from Drainable
DrainState	drainState () const
	Return the current drain state of an object. More...

virtual void	notifyFork ()
	Notify a child process of a fork. More...

Public Member Functions inherited from Stats::Group
	Group (Group parent, const char name=nullptr)
	Construct a new statistics group. More...

virtual	~Group ()

virtual void	regStats ()
	Callback to set stat parameters. More...

virtual void	resetStats ()
	Callback to reset stats. More...

virtual void	preDumpStats ()
	Callback before stats are dumped. More...

void	addStat (Stats::Info *info)
	Register a stat with this group. More...

const std::map< std::string, Group * > &	getStatGroups () const
	Get all child groups associated with this object. More...

const std::vector< Info * > &	getStats () const
	Get all stats associated with this object. More...

void	addStatGroup (const char name, Group block)
	Add a stat block as a child of this block. More...

const Info *	resolveStat (std::string name) const
	Resolve a stat by its name within this group. More...

	Group ()=delete

	Group (const Group &)=delete

Group &	operator= (const Group &)=delete

Protected Member Functions
void	listen (int port)

void	accept ()

Protected Member Functions inherited from SerialDevice
void	notifyInterface ()
	Notify the host interface of pending data. More...

Protected Member Functions inherited from Drainable
	Drainable ()

virtual	~Drainable ()

virtual void	drainResume ()
	Resume execution after a successful drain. More...

void	signalDrainDone () const
	Signal that an object is drained. More...

Protected Attributes
ListenEvent *	listenEvent

DataEvent *	dataEvent

int	number

int	data_fd

ListenSocket	listener

CircleBuf< char >	txbuf

CircleBuf< char >	rxbuf

OutputStream *	outfile

Protected Attributes inherited from SimObject
const SimObjectParams *	_params
	Cached copy of the object parameters. More...

Protected Attributes inherited from EventManager
EventQueue *	eventq
	A pointer to this object's event queue. More...

Friends
class	ListenEvent

class	DataEvent

Additional Inherited Members
Static Public Member Functions inherited from SimObject
static void	serializeAll (CheckpointOut &cp)
	Serialize all SimObjects in the system. More...

static SimObject *	find (const char *name)
	Find the SimObject with the given name and return a pointer to it. More...

Static Public Member Functions inherited from Serializable
static const std::string &	currentSection ()
	Gets the fully-qualified name of the active section. More...

static void	serializeAll (const std::string &cpt_dir)
	Serializes all the SimObjects. More...

static void	unserializeGlobals (CheckpointIn &cp)

Detailed Description

Definition at line 61 of file terminal.hh.

Member Typedef Documentation

◆ Params

typedef TerminalParams Terminal::Params

Definition at line 95 of file terminal.hh.

Constructor & Destructor Documentation

◆ Terminal()

Terminal::Terminal ( const Params * p )

Definition at line 118 of file terminal.cc.

References listen(), outfile, MipsISA::p, and OutputStream::stream().

◆ ~Terminal()

Terminal::~Terminal ( )

Definition at line 133 of file terminal.cc.

References data_fd, dataEvent, and listenEvent.

Member Function Documentation

◆ accept()

void Terminal::accept ( )

protected

Definition at line 189 of file terminal.cc.

References ListenSocket::accept(), atomic_write(), ccprintf(), data_fd, DataEvent, dataEvent, DPRINTFN, ArmISA::fd, ArmISA::i, ListenSocket::islistening(), listener, SimObject::name(), number, panic, CircleBuf< T >::peek(), pollQueue, PollQueue::schedule(), CircularQueue< T >::size(), txbuf, and write().

◆ console_in()

uint64_t Terminal::console_in ( )

Definition at line 309 of file terminal.cc.

References dataAvailable(), DPRINTF, CircularQueue< T >::empty(), MORE_PENDING, readData(), RECEIVE_NONE, RECEIVE_SUCCESS, and rxbuf.

◆ data()

void Terminal::data ( )

Definition at line 240 of file terminal.cc.

References ArmISA::len, SerialDevice::notifyInterface(), read(), rxbuf, and CircleBuf< T >::write().

◆ dataAvailable()

bool Terminal::dataAvailable ( ) const

inlineoverridevirtual

Check if there is pending data from the serial device.

Returns: true if there is data pending that can be read using the readData() method.

Implements SerialDevice.

Definition at line 129 of file terminal.hh.

References CircularQueue< T >::empty(), and rxbuf.

Referenced by console_in().

◆ detach()

void Terminal::detach ( )

Definition at line 225 of file terminal.cc.

References data_fd, dataEvent, DPRINTFN, number, pollQueue, and PollQueue::remove().

Referenced by read(), and write().

◆ listen()

void Terminal::listen ( int port )

protected

Definition at line 167 of file terminal.cc.

References ListenSocket::allDisabled(), ccprintf(), DPRINTF, ListenSocket::getfd(), ListenSocket::listen(), listener, ListenEvent, listenEvent, SimObject::name(), pollQueue, PollQueue::schedule(), and warn_once.

Referenced by Terminal().

◆ read() [1/2]

void Terminal::read ( uint8_t & c )

inline

Definition at line 120 of file terminal.hh.

References ArmISA::c, and read().

Referenced by data(), and read().

◆ read() [2/2]

size_t Terminal::read	(	uint8_t *	buf,
		size_t	len
	)

Definition at line 253 of file terminal.cc.

References data_fd, detach(), DPRINTFN, ArmISA::len, panic, and read().

◆ readData()

uint8_t Terminal::readData ( )

overridevirtual

Read a character from the device.

Returns: Character from the device's output buffer, undefined if no data is pending.

Implements SerialDevice.

Definition at line 295 of file terminal.cc.

References ArmISA::c, DPRINTF, CircularQueue< T >::empty(), CircleBuf< T >::read(), and rxbuf.

Referenced by console_in().

◆ terminalDump()

OutputStream * Terminal::terminalDump ( const TerminalParams * p )

Definition at line 146 of file terminal.cc.

References OutputDirectory::findOrCreate(), Stats::none, MipsISA::p, panic, and simout.

◆ write() [1/2]

size_t Terminal::write	(	const uint8_t *	buf,
		size_t	len
	)

Definition at line 277 of file terminal.cc.

References atomic_write(), data_fd, detach(), ArmISA::len, and panic.

◆ write() [2/2]

void Terminal::write ( uint8_t c )

inline

Definition at line 122 of file terminal.hh.

References ArmISA::c, and write().

Referenced by accept(), write(), and writeData().

◆ writeData()

void Terminal::writeData ( uint8_t c )

overridevirtual

Transmit a character from the host interface to the device.

Parameters

c	Received data.

Implements SerialDevice.

Definition at line 327 of file terminal.cc.

References ArmISA::c, data_fd, DPRINTF, DTRACE, outfile, OutputStream::stream(), txbuf, CircleBuf< T >::write(), and write().

Friends And Related Function Documentation

◆ DataEvent

friend class DataEvent

friend

Definition at line 87 of file terminal.hh.

Referenced by accept().

◆ ListenEvent

friend class ListenEvent

friend

Definition at line 74 of file terminal.hh.

Referenced by listen().

Member Data Documentation

◆ data_fd

int Terminal::data_fd

protected

Definition at line 92 of file terminal.hh.

Referenced by accept(), detach(), read(), write(), writeData(), and ~Terminal().

◆ dataEvent

DataEvent* Terminal::dataEvent

protected

Definition at line 88 of file terminal.hh.

Referenced by accept(), detach(), and ~Terminal().

◆ listener

ListenSocket Terminal::listener

protected

Definition at line 101 of file terminal.hh.

Referenced by accept(), and listen().

◆ listenEvent

ListenEvent* Terminal::listenEvent

protected

Definition at line 75 of file terminal.hh.

Referenced by listen(), and ~Terminal().

◆ number

int Terminal::number

protected

Definition at line 91 of file terminal.hh.

Referenced by accept(), and detach().

◆ outfile

OutputStream* Terminal::outfile

protected

Definition at line 109 of file terminal.hh.

Referenced by Terminal(), and writeData().

◆ rxbuf

CircleBuf<char> Terminal::rxbuf

protected

Definition at line 108 of file terminal.hh.

Referenced by console_in(), data(), dataAvailable(), and readData().

◆ txbuf

CircleBuf<char> Terminal::txbuf

protected

Definition at line 107 of file terminal.hh.

Referenced by accept(), and writeData().

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

dev/serial/terminal.hh
dev/serial/terminal.cc

Classes

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Params

Constructor & Destructor Documentation

◆ Terminal()

◆ ~Terminal()

Member Function Documentation

◆ accept()

◆ console_in()

◆ data()

◆ dataAvailable()

◆ detach()

◆ listen()

◆ read() [1/2]

◆ read() [2/2]

◆ readData()

◆ terminalDump()

◆ write() [1/2]

◆ write() [2/2]

◆ writeData()

Friends And Related Function Documentation

◆ DataEvent

◆ ListenEvent

Member Data Documentation

◆ data_fd

◆ dataEvent

◆ listener

◆ listenEvent

◆ number

◆ outfile

◆ rxbuf

◆ txbuf