Terminal Class Reference

#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
void	regDataAvailCallback (Callback *c)
	Register a data available callback into the transport layer. More...
	Terminal (const Params *p)
	~Terminal ()
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	in ()
uint64_t	console_in ()
void	out (char c)
bool	dataAvailable ()
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	regStats ()
	Register statistics for this object. More...
virtual void	resetStats ()
	Reset statistics associated with this object. 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 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
	EventManager (EventManager &em)
	EventManager (EventManager *em)
	EventManager (EventQueue *eq)
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)
void	setCurTick (Tick newVal)
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...

Protected Member Functions
void	listen (int port)
void	accept ()
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
Callback *	termDataAvail
	Currently registered transport layer callbacks. More...
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 ()
	Get the fully-qualified name of the active section. More...
static void	serializeAll (const std::string &cpt_dir)
static void	unserializeGlobals (CheckpointIn &cp)
Static Public Attributes inherited from Serializable
static int	ckptCount = 0
static int	ckptMaxCount = 0
static int	ckptPrevCount = -1

Detailed Description

Definition at line 52 of file terminal.hh.

Member Typedef Documentation

typedef TerminalParams Terminal::Params

Definition at line 102 of file terminal.hh.

Constructor & Destructor Documentation

Terminal::Terminal

(

const Params *

p

)

Definition at line 109 of file terminal.cc.

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

Terminal::~Terminal

(

)

Definition at line 124 of file terminal.cc.

References data_fd, dataEvent, and listenEvent.

Member Function Documentation

void Terminal::accept ( )

protected

Definition at line 177 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(), CircleBuf< T >::size(), txbuf, and write().

uint64_t Terminal::console_in

(

)

Definition at line 299 of file terminal.cc.

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

Referenced by AlphaBackdoor::read().

void Terminal::data

(

)

Definition at line 228 of file terminal.cc.

References ArmISA::len, Callback::process(), read(), rxbuf, termDataAvail, and CircleBuf< T >::write().

bool Terminal::dataAvailable ( )

inline

Definition at line 157 of file terminal.hh.

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

Referenced by console_in(), Pl011::read(), Uart8250::read(), VirtIOConsole::TermRecvQueue::trySend(), Pl011::write(), and Uart8250::write().

void Terminal::detach

(

)

Definition at line 213 of file terminal.cc.

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

Referenced by read(), and write().

uint8_t Terminal::in

(

)

Definition at line 285 of file terminal.cc.

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

Referenced by console_in(), Pl011::read(), Uart8250::read(), and VirtIOConsole::TermRecvQueue::trySend().

void Terminal::listen ( int  port )

protected

Definition at line 152 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().

void Terminal::out

(

char

c

)

Definition at line 317 of file terminal.cc.

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

Referenced by Pl011::write(), Uart8250::write(), and AlphaBackdoor::write().

void Terminal::read ( uint8_t &  c )

inline

Definition at line 126 of file terminal.hh.

References read().

Referenced by data(), and read().

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

Definition at line 243 of file terminal.cc.

References data_fd, detach(), DPRINTFN, panic, and read().

void Terminal::regDataAvailCallback

(

Callback *

c

)

Register a data available callback into the transport layer.

The terminal needs to call the underlying transport layer to inform it of available data. The transport layer uses this method to register a callback that informs it of pending data.

Parameters

c	Callback instance from transport layer.

Definition at line 137 of file terminal.cc.

References ArmISA::c, fatal, and termDataAvail.

Referenced by Uart::Uart(), and VirtIOConsole::VirtIOConsole().

void Terminal::write ( uint8_t  c )

inline

Definition at line 128 of file terminal.hh.

References write().

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

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

Definition at line 267 of file terminal.cc.

References atomic_write(), data_fd, detach(), and panic.

Friends And Related Function Documentation

friend class DataEvent

friend

Definition at line 94 of file terminal.hh.

Referenced by accept().

friend class ListenEvent

friend

Definition at line 81 of file terminal.hh.

Referenced by listen().

Member Data Documentation

int Terminal::data_fd

protected

Definition at line 99 of file terminal.hh.

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

DataEvent* Terminal::dataEvent

protected

Definition at line 95 of file terminal.hh.

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

ListenSocket Terminal::listener

protected

Definition at line 107 of file terminal.hh.

Referenced by accept(), and listen().

ListenEvent* Terminal::listenEvent

protected

Definition at line 82 of file terminal.hh.

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

int Terminal::number

protected

Definition at line 98 of file terminal.hh.

Referenced by accept(), and detach().

OutputStream* Terminal::outfile

protected

Definition at line 115 of file terminal.hh.

Referenced by out(), and Terminal().

CircleBuf<char> Terminal::rxbuf

protected

Definition at line 114 of file terminal.hh.

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

Callback* Terminal::termDataAvail

protected

Currently registered transport layer callbacks.

Definition at line 68 of file terminal.hh.

Referenced by data(), and regDataAvailCallback().

CircleBuf<char> Terminal::txbuf

protected

Definition at line 113 of file terminal.hh.

Referenced by accept(), and out().

---

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

• dev/terminal.hh
• dev/terminal.cc