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

#include <hdlcd.hh>

Inheritance diagram for HDLcd::PixelPump:
BasePixelPump EventManager Clocked Serializable

Public Member Functions

 PixelPump (HDLcd &p, ClockDomain &pxl_clk, unsigned pixel_chunk)
 
void dumpSettings ()
 
- Public Member Functions inherited from BasePixelPump
 BasePixelPump (EventManager &em, ClockDomain &pxl_clk, unsigned pixel_chunk)
 
virtual ~BasePixelPump ()
 
void serialize (CheckpointOut &cp) const override
 Serialize an object. More...
 
void unserialize (CheckpointIn &cp) override
 Unserialize an object. More...
 
void updateTimings (const DisplayTimings &timings)
 Update frame size using display timing. More...
 
void renderFrame ()
 Render an entire frame in KVM execution mode. More...
 
void start ()
 Starting pushing pixels in timing mode. More...
 
void stop ()
 Immediately stop pushing pixels. More...
 
const DisplayTimingstimings () const
 Get a constant reference of the current display timings. More...
 
bool active () const
 Is the pixel pump active and refreshing the display? More...
 
bool underrun () const
 Did a buffer underrun occur within this refresh interval? More...
 
bool visibleLine () const
 Is the current line within the visible range? More...
 
unsigned posX () const
 Current pixel position within the visible area. More...
 
unsigned posY () const
 Current pixel position within the visible area. 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 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
 
- 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)
 

Protected Member Functions

bool nextPixel (Pixel &p) override
 Get the next pixel from the scan line buffer. More...
 
void onVSyncBegin () override
 First pixel clock of the first VSync line. More...
 
void onVSyncEnd () override
 Callback on the first pixel of the line after the end VSync region (typically the first pixel of the vertical back porch). More...
 
void onUnderrun (unsigned x, unsigned y) override
 Buffer underrun occurred on a frame. More...
 
void onFrameDone () override
 Finished displaying the visible region of a frame. More...
 
- Protected Member Functions inherited from BasePixelPump
virtual void onHSyncBegin ()
 Start of the HSync region. More...
 
virtual void onHSyncEnd ()
 Start of the first pixel after the HSync region. 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...
 

Protected Attributes

HDLcdparent
 
- Protected Attributes inherited from EventManager
EventQueueeventq
 A pointer to this object's event queue. More...
 

Additional Inherited Members

- 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)
 
- Public Attributes inherited from BasePixelPump
FrameBuffer fb
 Output frame buffer. More...
 
- Static Public Attributes inherited from Serializable
static int ckptCount = 0
 
static int ckptMaxCount = 0
 
static int ckptPrevCount = -1
 

Detailed Description

Definition at line 324 of file hdlcd.hh.

Constructor & Destructor Documentation

HDLcd::PixelPump::PixelPump ( HDLcd p,
ClockDomain pxl_clk,
unsigned  pixel_chunk 
)
inline

Definition at line 327 of file hdlcd.hh.

Member Function Documentation

void HDLcd::PixelPump::dumpSettings ( )
bool HDLcd::PixelPump::nextPixel ( Pixel p)
inlineoverrideprotectedvirtual

Get the next pixel from the scan line buffer.

Parameters
pOutput pixel value, undefined on underrun
Returns
true on success, false on buffer underrun

Implements BasePixelPump.

Definition at line 333 of file hdlcd.hh.

References parent, and HDLcd::pxlNext().

void HDLcd::PixelPump::onFrameDone ( )
inlineoverrideprotectedvirtual

Finished displaying the visible region of a frame.

Reimplemented from BasePixelPump.

Definition at line 342 of file hdlcd.hh.

References parent, and HDLcd::pxlFrameDone().

void HDLcd::PixelPump::onUnderrun ( unsigned  x,
unsigned  y 
)
inlineoverrideprotectedvirtual

Buffer underrun occurred on a frame.

This method is called once if there is buffer underrun while refreshing the display. The underrun state is reset on the next refresh.

Parameters
xCoordinate within the visible region.
yCoordinate within the visible region.

Reimplemented from BasePixelPump.

Definition at line 338 of file hdlcd.hh.

References parent, and HDLcd::pxlUnderrun().

void HDLcd::PixelPump::onVSyncBegin ( )
inlineoverrideprotectedvirtual

First pixel clock of the first VSync line.

Reimplemented from BasePixelPump.

Definition at line 335 of file hdlcd.hh.

References parent, and HDLcd::pxlVSyncBegin().

void HDLcd::PixelPump::onVSyncEnd ( )
inlineoverrideprotectedvirtual

Callback on the first pixel of the line after the end VSync region (typically the first pixel of the vertical back porch).

Reimplemented from BasePixelPump.

Definition at line 336 of file hdlcd.hh.

References parent, and HDLcd::pxlVSyncEnd().

Member Data Documentation

HDLcd& HDLcd::PixelPump::parent
protected

Definition at line 345 of file hdlcd.hh.

Referenced by nextPixel(), onFrameDone(), onUnderrun(), onVSyncBegin(), and onVSyncEnd().


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

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