gem5  v21.1.0.2
Classes | Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
gem5::Terminal Class Reference

#include <terminal.hh>

Inheritance diagram for gem5::Terminal:
gem5::SerialDevice gem5::SimObject gem5::EventManager gem5::Serializable gem5::Drainable gem5::statistics::Group gem5::Named

Classes

class  DataEvent
 
class  ListenEvent
 

Public Types

typedef TerminalParams Params
 
- Public Types inherited from gem5::SimObject
typedef SimObjectParams Params
 

Public Member Functions

 Terminal (const Params &p)
 
 ~Terminal ()
 
OutputStreamterminalDump (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 gem5::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 gem5::SimObject
const Paramsparams () const
 
 SimObject (const Params &p)
 
virtual ~SimObject ()
 
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...
 
ProbeManagergetProbeManager ()
 Get the probe manager for this object. More...
 
virtual PortgetPort (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 gem5::EventManager
EventQueueeventQueue () 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 gem5::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 gem5::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 gem5::statistics::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 (statistics::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 InforesolveStat (std::string name) const
 Resolve a stat by its name within this group. More...
 
void mergeStatGroup (Group *block)
 Merge the contents (stats & children) of a block to this block. More...
 
 Group ()=delete
 
 Group (const Group &)=delete
 
Groupoperator= (const Group &)=delete
 
- Public Member Functions inherited from gem5::Named
 Named (const std::string &name_)
 
virtual ~Named ()=default
 
virtual std::string name () const
 

Protected Member Functions

void listen (int port)
 
void accept ()
 
- Protected Member Functions inherited from gem5::SerialDevice
void notifyInterface ()
 Notify the host interface of pending data. More...
 
- Protected Member Functions inherited from gem5::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

ListenEventlistenEvent
 
DataEventdataEvent
 
int number
 
int data_fd
 
ListenSocket listener
 
CircleBuf< char > txbuf
 
CircleBuf< char > rxbuf
 
OutputStreamoutfile
 
- Protected Attributes inherited from gem5::SimObject
const SimObjectParams & _params
 Cached copy of the object parameters. More...
 
- Protected Attributes inherited from gem5::EventManager
EventQueueeventq
 A pointer to this object's event queue. More...
 

Friends

class ListenEvent
 
class DataEvent
 

Additional Inherited Members

- Static Public Member Functions inherited from gem5::SimObject
static void serializeAll (const std::string &cpt_dir)
 Create a checkpoint by serializing all SimObjects in the system. More...
 
static SimObjectfind (const char *name)
 Find the SimObject with the given name and return a pointer to it. More...
 
static void setSimObjectResolver (SimObjectResolver *resolver)
 There is a single object name resolver, and it is only set when simulation is restoring from checkpoints. More...
 
static SimObjectResolvergetSimObjectResolver ()
 There is a single object name resolver, and it is only set when simulation is restoring from checkpoints. More...
 
- Static Public Member Functions inherited from gem5::Serializable
static const std::string & currentSection ()
 Gets the fully-qualified name of the active section. More...
 
static void generateCheckpointOut (const std::string &cpt_dir, std::ofstream &outstream)
 Generate a checkpoint file so that the serialization can be routed to it. More...
 

Detailed Description

Definition at line 64 of file terminal.hh.

Member Typedef Documentation

◆ Params

typedef TerminalParams gem5::Terminal::Params

Definition at line 98 of file terminal.hh.

Constructor & Destructor Documentation

◆ Terminal()

gem5::Terminal::Terminal ( const Params p)

Definition at line 118 of file terminal.cc.

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

◆ ~Terminal()

gem5::Terminal::~Terminal ( )

Definition at line 133 of file terminal.cc.

References data_fd, dataEvent, and listenEvent.

Member Function Documentation

◆ accept()

void gem5::Terminal::accept ( )
protected

◆ console_in()

uint64_t gem5::Terminal::console_in ( )

◆ data()

void gem5::Terminal::data ( )

◆ dataAvailable()

bool gem5::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 gem5::SerialDevice.

Definition at line 132 of file terminal.hh.

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

Referenced by console_in().

◆ detach()

void gem5::Terminal::detach ( )

Definition at line 225 of file terminal.cc.

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

Referenced by read(), and write().

◆ listen()

void gem5::Terminal::listen ( int  port)
protected

◆ read() [1/2]

void gem5::Terminal::read ( uint8_t &  c)
inline

Definition at line 123 of file terminal.hh.

References gem5::ArmISA::c, and read().

Referenced by data(), and read().

◆ read() [2/2]

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

Definition at line 253 of file terminal.cc.

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

◆ readData()

uint8_t gem5::Terminal::readData ( )
overridevirtual

Read a character from the device.

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

Implements gem5::SerialDevice.

Definition at line 295 of file terminal.cc.

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

Referenced by console_in().

◆ terminalDump()

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

◆ write() [1/2]

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

Definition at line 277 of file terminal.cc.

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

◆ write() [2/2]

void gem5::Terminal::write ( uint8_t  c)
inline

Definition at line 125 of file terminal.hh.

References gem5::ArmISA::c, and write().

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

◆ writeData()

void gem5::Terminal::writeData ( uint8_t  c)
overridevirtual

Transmit a character from the host interface to the device.

Parameters
cReceived data.

Implements gem5::SerialDevice.

Definition at line 327 of file terminal.cc.

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

Friends And Related Function Documentation

◆ DataEvent

friend class DataEvent
friend

Definition at line 90 of file terminal.hh.

Referenced by accept().

◆ ListenEvent

friend class ListenEvent
friend

Definition at line 77 of file terminal.hh.

Referenced by listen().

Member Data Documentation

◆ data_fd

int gem5::Terminal::data_fd
protected

Definition at line 95 of file terminal.hh.

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

◆ dataEvent

DataEvent* gem5::Terminal::dataEvent
protected

Definition at line 91 of file terminal.hh.

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

◆ listener

ListenSocket gem5::Terminal::listener
protected

Definition at line 104 of file terminal.hh.

Referenced by accept(), and listen().

◆ listenEvent

ListenEvent* gem5::Terminal::listenEvent
protected

Definition at line 78 of file terminal.hh.

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

◆ number

int gem5::Terminal::number
protected

Definition at line 94 of file terminal.hh.

Referenced by accept(), and detach().

◆ outfile

OutputStream* gem5::Terminal::outfile
protected

Definition at line 112 of file terminal.hh.

Referenced by Terminal(), and writeData().

◆ rxbuf

CircleBuf<char> gem5::Terminal::rxbuf
protected

Definition at line 111 of file terminal.hh.

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

◆ txbuf

CircleBuf<char> gem5::Terminal::txbuf
protected

Definition at line 110 of file terminal.hh.

Referenced by accept(), and writeData().


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

Generated on Tue Sep 21 2021 12:28:15 for gem5 by doxygen 1.8.17