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

#include <uart8250.hh>

Inheritance diagram for gem5::Uart8250:
gem5::Uart gem5::BasicPioDevice gem5::PioDevice gem5::ClockedObject gem5::SimObject gem5::Clocked gem5::EventManager gem5::Serializable gem5::Drainable gem5::statistics::Group gem5::Named

Classes

class  Registers
 

Public Types

using Params = Uart8250Params
 
- Public Types inherited from gem5::Uart
using Params = UartParams
 
- Public Types inherited from gem5::PioDevice
using Params = PioDeviceParams
 
- Public Types inherited from gem5::ClockedObject
using Params = ClockedObjectParams
 Parameters of ClockedObject. More...
 
- Public Types inherited from gem5::SimObject
typedef SimObjectParams Params
 

Public Member Functions

 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 gem5::Uart
 Uart (const Params &p, Addr pio_size)
 
bool intStatus ()
 Return if we have an interrupt pending. More...
 
- Public Member Functions inherited from gem5::BasicPioDevice
 PARAMS (BasicPioDevice)
 
 BasicPioDevice (const Params &p, Addr size)
 
- Public Member Functions inherited from gem5::PioDevice
 PioDevice (const Params &p)
 
virtual ~PioDevice ()
 
void init () override
 init() is called after all C++ SimObjects have been created and all ports are connected. More...
 
PortgetPort (const std::string &if_name, PortID idx=InvalidPortID) override
 Get a port with a given name and index. More...
 
- Public Member Functions inherited from gem5::ClockedObject
 ClockedObject (const ClockedObjectParams &p)
 
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::SimObject
const Paramsparams () const
 
 SimObject (const Params &p)
 
virtual ~SimObject ()
 
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 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
 
- Public Member Functions inherited from gem5::Clocked
void updateClockPeriod ()
 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 Types

using Register8 = Registers::Register8
 
template<class T >
using Register = Registers::Register< T >
 

Protected Member Functions

 BitUnion8 (Ier) Bitfield< 0 > rdi
 
 EndBitUnion (Ier) BitUnion8(Iir) Bitfield< 0 > pending
 
 EndBitUnion (Iir) BitUnion8(Lcr) Bitfield< 1
 
 EndBitUnion (Lcr) BitUnion8(Lsr) Bitfield< 0 > rdr
 
 EndBitUnion (Lsr) enum class InterruptIds
 
uint8_t readRbr (Register8 &reg)
 
void writeThr (Register8 &reg, const uint8_t &data)
 
void writeIer (Register< Ier > &reg, const Ier &ier)
 
Iir readIir (Register< Iir > &reg)
 
void processIntrEvent (int intrBit)
 
void scheduleIntr (Event *event)
 
- 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 Member Functions inherited from gem5::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...
 
virtual void clockPeriodUpdated ()
 A hook subclasses can implement so they can do any extra work that's needed when the clock rate is changed. More...
 

Protected Attributes

Bitfield< 1 > thri
 
Bitfield< 2 > rlsi
 
Bitfield< 3 > msi
 
Bitfield< 2, 1 > id
 
Bitfield< 7, 3 > zeroes
 
 wordSize
 
Bitfield< 2 > stopBits
 
Bitfield< 5, 3 > parity
 
Bitfield< 6 > breakCont
 
Bitfield< 7 > dlab
 
Bitfield< 1 > overrunError
 
Bitfield< 2 > parityError
 
Bitfield< 3 > framingError
 
Bitfield< 4 > breakCond
 
Bitfield< 5 > tbe
 
Bitfield< 6 > txEmpty
 
Bitfield< 7 > unused
 
Registers registers
 
Tick lastTxInt
 
EventFunctionWrapper txIntrEvent
 
EventFunctionWrapper rxIntrEvent
 
- Protected Attributes inherited from gem5::Uart
int status
 
Platformplatform
 
SerialDevicedevice
 
- Protected Attributes inherited from gem5::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 gem5::PioDevice
Systemsys
 
PioPort< PioDevicepioPort
 The pioPort that handles the requests for us and provides us requests that it sees. More...
 
- 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...
 

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...
 
- Public Attributes inherited from gem5::ClockedObject
PowerStatepowerState
 

Detailed Description

Definition at line 51 of file uart8250.hh.

Member Typedef Documentation

◆ Params

using gem5::Uart8250::Params = Uart8250Params

Definition at line 216 of file uart8250.hh.

◆ Register

template<class T >
using gem5::Uart8250::Register = Registers::Register<T>
protected

Definition at line 198 of file uart8250.hh.

◆ Register8

Definition at line 196 of file uart8250.hh.

Constructor & Destructor Documentation

◆ Uart8250()

gem5::Uart8250::Uart8250 ( const Params p)

Definition at line 88 of file uart8250.cc.

References processIntrEvent(), and gem5::TX_INT.

Member Function Documentation

◆ BitUnion8()

gem5::Uart8250::BitUnion8 ( Ier  )
protected

◆ dataAvailable()

void gem5::Uart8250::dataAvailable ( )
overridevirtual

Inform the uart that there is data available.

Implements gem5::Uart.

Definition at line 244 of file uart8250.cc.

References gem5::Uart8250::Registers::ier, gem5::Uart::platform, registers, gem5::RX_INT, and gem5::Uart::status.

◆ EndBitUnion() [1/4]

gem5::Uart8250::EndBitUnion ( Ier  )
protected

◆ EndBitUnion() [2/4]

gem5::Uart8250::EndBitUnion ( Iir  )
protected

◆ EndBitUnion() [3/4]

gem5::Uart8250::EndBitUnion ( Lcr  )
protected

◆ EndBitUnion() [4/4]

gem5::Uart8250::EndBitUnion ( Lsr  )
inlineprotected

Definition at line 84 of file uart8250.hh.

◆ getAddrRanges()

AddrRangeList gem5::Uart8250::getAddrRanges ( ) const
overridevirtual

Determine the address ranges that this device responds to.

Returns
a list of non-overlapping address ranges

Reimplemented from gem5::BasicPioDevice.

Definition at line 255 of file uart8250.cc.

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

◆ intStatus()

virtual bool gem5::Uart8250::intStatus ( )
inlinevirtual

Return if we have an interrupt pending.

Returns
interrupt status

Definition at line 233 of file uart8250.hh.

References gem5::Uart::status.

◆ processIntrEvent()

void gem5::Uart8250::processIntrEvent ( int  intrBit)
protected

◆ read()

Tick gem5::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 gem5::PioDevice.

Definition at line 217 of file uart8250.cc.

References DPRINTF, gem5::Packet::getAddr(), gem5::Packet::getPtr(), gem5::Packet::getSize(), gem5::Packet::makeAtomicResponse(), gem5::BasicPioDevice::pioAddr, gem5::BasicPioDevice::pioDelay, gem5::RegisterBank< BankByteOrder >::read(), and registers.

◆ readIir()

Uart8250::Iir gem5::Uart8250::readIir ( Register< Iir > &  reg)
protected

Definition at line 160 of file uart8250.cc.

References DPRINTF, gem5::RX_INT, gem5::Uart::status, and gem5::TX_INT.

Referenced by gem5::Uart8250::Registers::Registers().

◆ readRbr()

uint8_t gem5::Uart8250::readRbr ( Register8 reg)
protected

◆ scheduleIntr()

void gem5::Uart8250::scheduleIntr ( Event event)
protected

◆ serialize()

void gem5::Uart8250::serialize ( CheckpointOut cp) const
overridevirtual

Serialize an object.

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

Parameters
cpCheckpoint state

Implements gem5::Serializable.

Definition at line 263 of file uart8250.cc.

References gem5::Uart8250::Registers::ier, gem5::Uart8250::Registers::lcr, gem5::Uart8250::Registers::mcr, gem5::paramOut(), registers, rxIntrEvent, gem5::Event::scheduled(), SERIALIZE_SCALAR, gem5::Uart::status, txIntrEvent, and gem5::Event::when().

◆ unserialize()

void gem5::Uart8250::unserialize ( CheckpointIn cp)
overridevirtual

Unserialize an object.

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

Parameters
cpCheckpoint state

Implements gem5::Serializable.

Definition at line 284 of file uart8250.cc.

References gem5::Uart8250::Registers::ier, gem5::Uart8250::Registers::lcr, gem5::Uart8250::Registers::mcr, gem5::paramIn(), registers, rxIntrEvent, gem5::EventManager::schedule(), gem5::Uart::status, txIntrEvent, and UNSERIALIZE_SCALAR.

◆ write()

Tick gem5::Uart8250::write ( PacketPtr  pkt)
overridevirtual

Pure virtual function that the device must implement.

Called when a write command is recieved by the port.

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

Implements gem5::PioDevice.

Definition at line 230 of file uart8250.cc.

References DPRINTF, gem5::Packet::getAddr(), gem5::Packet::getPtr(), gem5::Packet::getRaw(), gem5::Packet::getSize(), gem5::Packet::makeAtomicResponse(), gem5::BasicPioDevice::pioAddr, gem5::BasicPioDevice::pioDelay, registers, and gem5::RegisterBank< BankByteOrder >::write().

◆ writeIer()

void gem5::Uart8250::writeIer ( Register< Ier > &  reg,
const Ier &  ier 
)
protected

◆ writeThr()

void gem5::Uart8250::writeThr ( Register8 reg,
const uint8_t &  data 
)
protected

Member Data Documentation

◆ breakCond

Bitfield<4> gem5::Uart8250::breakCond
protected

Definition at line 80 of file uart8250.hh.

◆ breakCont

Bitfield<6> gem5::Uart8250::breakCont
protected

Definition at line 71 of file uart8250.hh.

◆ dlab

Bitfield<7> gem5::Uart8250::dlab
protected

Definition at line 72 of file uart8250.hh.

◆ framingError

Bitfield<3> gem5::Uart8250::framingError
protected

Definition at line 79 of file uart8250.hh.

◆ id

Bitfield<2, 1> gem5::Uart8250::id
protected

Definition at line 63 of file uart8250.hh.

◆ lastTxInt

Tick gem5::Uart8250::lastTxInt
protected

Definition at line 207 of file uart8250.hh.

Referenced by processIntrEvent(), and writeIer().

◆ msi

Bitfield<3> gem5::Uart8250::msi
protected

Definition at line 58 of file uart8250.hh.

◆ overrunError

Bitfield<1> gem5::Uart8250::overrunError
protected

Definition at line 77 of file uart8250.hh.

◆ parity

Bitfield<5, 3> gem5::Uart8250::parity
protected

Definition at line 70 of file uart8250.hh.

◆ parityError

Bitfield<2> gem5::Uart8250::parityError
protected

Definition at line 78 of file uart8250.hh.

◆ registers

Registers gem5::Uart8250::registers
protected

◆ rlsi

Bitfield<2> gem5::Uart8250::rlsi
protected

Definition at line 57 of file uart8250.hh.

◆ rxIntrEvent

EventFunctionWrapper gem5::Uart8250::rxIntrEvent
protected

Definition at line 213 of file uart8250.hh.

Referenced by readRbr(), serialize(), unserialize(), and writeIer().

◆ stopBits

Bitfield<2> gem5::Uart8250::stopBits
protected

Definition at line 69 of file uart8250.hh.

◆ tbe

Bitfield<5> gem5::Uart8250::tbe
protected

Definition at line 81 of file uart8250.hh.

◆ thri

Bitfield<1> gem5::Uart8250::thri
protected

Definition at line 56 of file uart8250.hh.

◆ txEmpty

Bitfield<6> gem5::Uart8250::txEmpty
protected

Definition at line 82 of file uart8250.hh.

◆ txIntrEvent

EventFunctionWrapper gem5::Uart8250::txIntrEvent
protected

Definition at line 212 of file uart8250.hh.

Referenced by serialize(), unserialize(), writeIer(), and writeThr().

◆ unused

Bitfield<7> gem5::Uart8250::unused
protected

Definition at line 83 of file uart8250.hh.

◆ wordSize

gem5::Uart8250::wordSize
protected

Definition at line 68 of file uart8250.hh.

◆ zeroes

Bitfield<7, 3> gem5::Uart8250::zeroes
protected

Definition at line 64 of file uart8250.hh.


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

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