gem5
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Classes | Public Types | Public Member Functions | Protected Attributes | List of all members
Uart8250 Class Reference

#include <uart8250.hh>

Inheritance diagram for Uart8250:
Uart BasicPioDevice PioDevice MemObject ClockedObject SimObject Clocked EventManager Serializable Drainable

Classes

class  IntrEvent
 

Public Types

typedef Uart8250Params Params
 
- Public Types inherited from Uart
typedef UartParams Params
 
- Public Types inherited from BasicPioDevice
typedef BasicPioDeviceParams Params
 
- Public Types inherited from PioDevice
typedef PioDeviceParams Params
 
- Public Types inherited from MemObject
typedef MemObjectParams Params
 
- Public Types inherited from ClockedObject
typedef ClockedObjectParams Params
 Parameters of ClockedObject. More...
 
- Public Types inherited from SimObject
typedef SimObjectParams Params
 

Public Member Functions

const Paramsparams () const
 
 Uart8250 (const Params *p)
 
Tick read (PacketPtr pkt) override
 Pure virtual function that the device must implement. More...
 
Tick write (PacketPtr pkt) override
 Pure virtual function that the device must implement. More...
 
AddrRangeList getAddrRanges () const override
 Determine the address ranges that this device responds to. More...
 
void dataAvailable () override
 Inform the uart that there is data available. More...
 
virtual bool intStatus ()
 Return if we have an interrupt pending. 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 Uart
 Uart (const Params *p, Addr pio_size)
 
const Paramsparams () const
 
bool intStatus ()
 Return if we have an interrupt pending. More...
 
- Public Member Functions inherited from BasicPioDevice
 BasicPioDevice (const Params *p, Addr size)
 
const Paramsparams () const
 
- Public Member Functions inherited from PioDevice
 PioDevice (const Params *p)
 
virtual ~PioDevice ()
 
const Paramsparams () const
 
virtual void init ()
 init() is called after all C++ SimObjects have been created and all ports are connected. More...
 
virtual BaseSlavePortgetSlavePort (const std::string &if_name, PortID idx=InvalidPortID)
 Get a slave port with a given name and index. More...
 
- Public Member Functions inherited from MemObject
const Paramsparams () const
 
 MemObject (const Params *params)
 
virtual BaseMasterPortgetMasterPort (const std::string &if_name, PortID idx=InvalidPortID)
 Get a master port with a given name and index. More...
 
- Public Member Functions inherited from ClockedObject
 ClockedObject (const ClockedObjectParams *p)
 
const Paramsparams () const
 
void serialize (CheckpointOut &cp) const override
 Serialize an object. More...
 
void unserialize (CheckpointIn &cp) override
 Unserialize an object. More...
 
Enums::PwrState pwrState () const
 
std::string pwrStateName () const
 
std::vector< double > pwrStateWeights () const
 Returns the percentage residency for each power state. More...
 
void computeStats ()
 Record stats values like state residency by computing the time difference from previous update. More...
 
void pwrState (Enums::PwrState)
 
void regStats () override
 Register statistics for this object. More...
 
- Public Member Functions inherited from SimObject
const Paramsparams () const
 
 SimObject (const Params *_params)
 
virtual ~SimObject ()
 
virtual const std::string name () const
 
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 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...
 
ProbeManagergetProbeManager ()
 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)
 
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)
 
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...
 
- Public Member Functions inherited from Clocked
void updateClockPeriod () const
 Update the tick to the current tick. More...
 
Tick clockEdge (Cycles cycles=Cycles(0)) const
 Determine the tick when a cycle begins, by default the current one, but the argument also enables the caller to determine a future cycle. More...
 
Cycles curCycle () const
 Determine the current cycle, corresponding to a tick aligned to a clock edge. More...
 
Tick nextCycle () const
 Based on the clock of the object, determine the start tick of the first cycle that is at least one cycle in the future. More...
 
uint64_t frequency () const
 
Tick clockPeriod () const
 
double voltage () const
 
Cycles ticksToCycles (Tick t) const
 
Tick cyclesToTicks (Cycles c) const
 

Protected Attributes

uint8_t IER
 
uint8_t DLAB
 
uint8_t LCR
 
uint8_t MCR
 
Tick lastTxInt
 
IntrEvent txIntrEvent
 
IntrEvent rxIntrEvent
 
- Protected Attributes inherited from Uart
int status
 
Platformplatform
 
Terminalterm
 
MakeCallback< Uart,&Uart::dataAvailablecallbackDataAvail
 
- Protected Attributes inherited from BasicPioDevice
Addr pioAddr
 Address that the device listens to. More...
 
Addr pioSize
 Size that the device's address range. More...
 
Tick pioDelay
 Delay that the device experinces on an access. More...
 
- Protected Attributes inherited from PioDevice
Systemsys
 
PioPort pioPort
 The pioPort that handles the requests for us and provides us requests that it sees. More...
 
- Protected Attributes inherited from ClockedObject
Enums::PwrState _currPwrState
 To keep track of the current power state. More...
 
Tick prvEvalTick
 
Stats::Scalar numPwrStateTransitions
 
Stats::Distribution pwrStateClkGateDist
 
Stats::Vector pwrStateResidencyTicks
 
- Protected Attributes inherited from SimObject
const SimObjectParams * _params
 Cached copy of the object parameters. More...
 
- Protected Attributes inherited from EventManager
EventQueueeventq
 A pointer to this object's event queue. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from SimObject
static void serializeAll (CheckpointOut &cp)
 Serialize 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 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
 
- 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 Member Functions inherited from Clocked
 Clocked (ClockDomain &clk_domain)
 Create a clocked object and set the clock domain based on the parameters. More...
 
 Clocked (Clocked &)=delete
 
Clockedoperator= (Clocked &)=delete
 
virtual ~Clocked ()
 Virtual destructor due to inheritance. More...
 
void resetClock () const
 Reset the object's clock using the current global tick value. More...
 

Detailed Description

Definition at line 70 of file uart8250.hh.

Member Typedef Documentation

typedef Uart8250Params Uart8250::Params

Definition at line 92 of file uart8250.hh.

Constructor & Destructor Documentation

Uart8250::Uart8250 ( const Params p)

Definition at line 104 of file uart8250.cc.

Member Function Documentation

void Uart8250::dataAvailable ( )
overridevirtual

Inform the uart that there is data available.

Implements Uart.

Definition at line 276 of file uart8250.cc.

References IER, Uart::platform, Platform::postConsoleInt(), RX_INT, Uart::status, and UART_IER_RDI.

AddrRangeList Uart8250::getAddrRanges ( ) const
overridevirtual

Determine the address ranges that this device responds to.

Returns
a list of non-overlapping address ranges

Reimplemented from BasicPioDevice.

Definition at line 288 of file uart8250.cc.

References BasicPioDevice::pioAddr, BasicPioDevice::pioSize, and RangeSize().

virtual bool Uart8250::intStatus ( )
inlinevirtual

Return if we have an interrupt pending.

Returns
interrupt status

Definition at line 114 of file uart8250.hh.

References Uart::status.

const Params* Uart8250::params ( ) const
inline

Definition at line 94 of file uart8250.hh.

References SimObject::_params.

Tick Uart8250::read ( PacketPtr  pkt)
overridevirtual

Pure virtual function that the device must implement.

Called when a read command is recieved by the port.

Parameters
pktPacket describing this request
Returns
number of ticks it took to complete

Implements PioDevice.

Definition at line 111 of file uart8250.cc.

References Platform::clearConsoleInt(), Terminal::dataAvailable(), DPRINTF, Packet::getAddr(), Packet::getSize(), IER, IIR_NOPEND, IIR_RXID, IIR_TXID, Terminal::in(), LCR, Packet::makeAtomicResponse(), MCR, panic, BasicPioDevice::pioAddr, BasicPioDevice::pioDelay, BasicPioDevice::pioSize, Uart::platform, RX_INT, rxIntrEvent, Uart8250::IntrEvent::scheduleIntr(), Packet::set(), Uart::status, Uart::term, TX_INT, UART_IER_RDI, UART_LSR_DR, UART_LSR_TEMT, and UART_LSR_THRE.

void Uart8250::serialize ( CheckpointOut cp) const
overridevirtual

Serialize an object.

Output an object's state into the current checkpoint section.

Parameters
cpCheckpoint state

Implements Serializable.

Definition at line 296 of file uart8250.cc.

References DLAB, IER, LCR, MCR, rxIntrEvent, Event::scheduled(), SERIALIZE_SCALAR, Uart::status, txIntrEvent, and Event::when().

void Uart8250::unserialize ( CheckpointIn cp)
overridevirtual

Unserialize an object.

Read an object's state from the current checkpoint section.

Parameters
cpCheckpoint state

Implements Serializable.

Definition at line 318 of file uart8250.cc.

References DLAB, IER, LCR, MCR, rxIntrEvent, EventManager::schedule(), Uart::status, txIntrEvent, and UNSERIALIZE_SCALAR.

Tick Uart8250::write ( PacketPtr  pkt)
overridevirtual

Member Data Documentation

uint8_t Uart8250::DLAB
protected

Definition at line 73 of file uart8250.hh.

Referenced by serialize(), and unserialize().

uint8_t Uart8250::IER
protected

Definition at line 73 of file uart8250.hh.

Referenced by dataAvailable(), read(), serialize(), unserialize(), and write().

Tick Uart8250::lastTxInt
protected

Definition at line 74 of file uart8250.hh.

Referenced by write().

uint8_t Uart8250::LCR
protected

Definition at line 73 of file uart8250.hh.

Referenced by read(), serialize(), unserialize(), and write().

uint8_t Uart8250::MCR
protected

Definition at line 73 of file uart8250.hh.

Referenced by read(), serialize(), unserialize(), and write().

IntrEvent Uart8250::rxIntrEvent
protected

Definition at line 89 of file uart8250.hh.

Referenced by read(), serialize(), unserialize(), and write().

IntrEvent Uart8250::txIntrEvent
protected

Definition at line 88 of file uart8250.hh.

Referenced by serialize(), unserialize(), and write().


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

Generated on Fri Jun 9 2017 13:04:22 for gem5 by doxygen 1.8.6