Timing generator for a pixel-based display. More...

#include <pixelpump.hh>

Inheritance diagram for gem5::BasePixelPump:

Classes
class	PixelEvent
	Callback helper class with suspend support. More...

Public Member Functions
	BasePixelPump (EventManager &em, ClockDomain &pxl_clk, unsigned pixel_chunk)

virtual	~BasePixelPump ()

void	serialize (CheckpointOut &cp) const override
	Serialize an object.

void	unserialize (CheckpointIn &cp) override
	Unserialize an object.

void	updateTimings (const DisplayTimings &timings)
	Update frame size using display timing.

void	renderFrame ()
	Render an entire frame in non-caching mode.

void	start ()
	Starting pushing pixels in timing mode.

void	stop ()
	Immediately stop pushing pixels.

const DisplayTimings &	timings () const
	Get a constant reference of the current display timings.

bool	active () const
	Is the pixel pump active and refreshing the display?

bool	underrun () const
	Did a buffer underrun occur within this refresh interval?

bool	visibleLine () const
	Is the current line within the visible range?

unsigned	posX () const
	Current pixel position within the visible area.

unsigned	posY () const
	Current pixel position within the visible area.

Public Member Functions inherited from gem5::EventManager
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)
	This function is not needed by the usual gem5 event loop but may be necessary in derived EventQueues which host gem5 on other schedulers.

void	setCurTick (Tick newVal)

	EventManager (EventManager &em)
	Event manger manages events in the event queue.

	EventManager (EventManager *em)

	EventManager (EventQueue *eq)

Public Member Functions inherited from gem5::Clocked
void	updateClockPeriod ()
	Update the tick to the current tick.

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.

Cycles	curCycle () const
	Determine the current cycle, corresponding to a tick aligned to a clock edge.

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.

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 gem5::Serializable
	Serializable ()

virtual	~Serializable ()

void	serializeSection (CheckpointOut &cp, const char *name) const
	Serialize an object into a new section.

void	serializeSection (CheckpointOut &cp, const std::string &name) const

void	unserializeSection (CheckpointIn &cp, const char *name)
	Unserialize an a child object.

void	unserializeSection (CheckpointIn &cp, const std::string &name)

Public Attributes
FrameBuffer	fb
	Output frame buffer.

Protected Member Functions
virtual bool	nextPixel (Pixel &p)=0
	Get the next pixel from the scan line buffer.

virtual size_t	nextLine (std::vector< Pixel >::iterator ps, size_t line_length)
	Get the next line of pixels directly from memory.

virtual void	onVSyncBegin ()
	First pixel clock of the first VSync line.

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

virtual void	onHSyncBegin ()
	Start of the HSync region.

virtual void	onHSyncEnd ()
	Start of the first pixel after the HSync region.

virtual void	onUnderrun (unsigned x, unsigned y)
	Buffer underrun occurred on a frame.

virtual void	onFrameDone ()
	Finished displaying the visible region of a frame.

Protected Member Functions inherited from gem5::Clocked
	Clocked (ClockDomain &clk_domain)
	Create a clocked object and set the clock domain based on the parameters.

	Clocked (Clocked &)=delete

Clocked &	operator= (Clocked &)=delete

virtual	~Clocked ()
	Virtual destructor due to inheritance.

void	resetClock () const
	Reset the object's clock using the current global tick value.

virtual void	clockPeriodUpdated ()
	A hook subclasses can implement so they can do any extra work that's needed when the clock rate is changed.

Private Member Functions
void	beginLine ()

void	renderPixels ()

void	renderLine ()
	Fast and event-free line rendering function.

Private Attributes
const unsigned	pixelChunk
	Maximum number of pixels to handle per render callback.

std::vector< PixelEvent * >	pixelEvents
	Convenience vector when doing operations on all events.

PixelEvent	evVSyncBegin

PixelEvent	evVSyncEnd

PixelEvent	evHSyncBegin

PixelEvent	evHSyncEnd

PixelEvent	evBeginLine

PixelEvent	evRenderPixels

DisplayTimings	_timings

unsigned	line
	Current line (including back porch, front porch, and vsync) within a frame.

unsigned	_posX
	X-coordinate within the visible region of a frame.

bool	_underrun
	Did a buffer underrun occur within this refresh interval?

Additional Inherited Members
Static Public Member Functions inherited from gem5::Serializable
static const std::string &	currentSection ()
	Gets the fully-qualified name of the active section.

static void	generateCheckpointOut (const std::string &cpt_dir, std::ofstream &outstream)
	Generate a checkpoint file so that the serialization can be routed to it.

Protected Attributes inherited from gem5::EventManager
EventQueue *	eventq
	A pointer to this object's event queue.

Detailed Description

Timing generator for a pixel-based display.

Pixels are ordered relative to the top left corner of the display. Scan lines appear in the following order:

Vertical Sync (starting at line 0)
Vertical back porch
Visible lines
Vertical front porch

Pixel order within a scan line:

Horizontal Sync
Horizontal Back Porch
Visible pixels
Horizontal Front Porch

Definition at line 163 of file pixelpump.hh.

Constructor & Destructor Documentation

◆ BasePixelPump()

gem5::BasePixelPump::BasePixelPump	(	EventManager &	em,
		ClockDomain &	pxl_clk,
		unsigned	pixel_chunk )

Definition at line 91 of file pixelpump.cc.

References _posX, _timings, _underrun, BasePixelPump(), beginLine(), gem5::Clocked::Clocked(), gem5::X86ISA::em, evBeginLine, gem5::EventManager::EventManager(), evHSyncBegin, evHSyncEnd, evRenderPixels, evVSyncBegin, evVSyncEnd, line, onHSyncBegin(), onHSyncEnd(), onVSyncBegin(), onVSyncEnd(), pixelChunk, pixelEvents, renderPixels(), and gem5::Serializable::Serializable().

Referenced by BasePixelPump(), gem5::BasePixelPump::PixelEvent::PixelEvent(), and gem5::HDLcd::PixelPump::PixelPump().

◆ ~BasePixelPump()

gem5::BasePixelPump::~BasePixelPump ( )

virtual

Definition at line 107 of file pixelpump.cc.

Member Function Documentation

◆ active()

bool gem5::BasePixelPump::active ( ) const

inline

Is the pixel pump active and refreshing the display?

Definition at line 192 of file pixelpump.hh.

References evBeginLine.

Referenced by updateTimings().

◆ beginLine()

void gem5::BasePixelPump::beginLine ( )

private

Definition at line 185 of file pixelpump.cc.

References _posX, _timings, _underrun, gem5::Clocked::clockEdge(), evBeginLine, evHSyncBegin, evHSyncEnd, evRenderPixels, line, onVSyncBegin(), onVSyncEnd(), and gem5::EventManager::schedule().

Referenced by BasePixelPump().

◆ nextLine()

virtual size_t gem5::BasePixelPump::nextLine	(	std::vector< Pixel >::iterator	ps,
		size_t	line_length )

inlineprotectedvirtual

Get the next line of pixels directly from memory.

This is for use from the renderFrame which is called in non-caching mode.

The default implementation falls back to calling nextPixel over and over, but a more efficient implementation could retrieve the entire line of pixels all at once using fewer access to memory which bypass any intermediate structures like an incoming FIFO.

Parameters

ps	A vector iterator to store retrieved pixels into.
line_length	The number of pixels being requested.

Returns: The number of pixels actually retrieved.

Reimplemented in gem5::HDLcd::PixelPump.

Definition at line 241 of file pixelpump.hh.

References gem5::X86ISA::count, nextPixel(), and gem5::ArmISA::ps.

Referenced by renderLine().

◆ nextPixel()

virtual bool gem5::BasePixelPump::nextPixel ( Pixel & p )

protectedpure virtual

Get the next pixel from the scan line buffer.

Parameters

p	Output pixel value, undefined on underrun

Returns: true on success, false on buffer underrun

Implemented in gem5::HDLcd::PixelPump.

References gem5::MipsISA::p.

Referenced by nextLine(), and renderPixels().

◆ onFrameDone()

virtual void gem5::BasePixelPump::onFrameDone ( )

inlineprotectedvirtual

Finished displaying the visible region of a frame.

Reimplemented in gem5::HDLcd::PixelPump.

Definition at line 287 of file pixelpump.hh.

Referenced by renderFrame(), and renderPixels().

◆ onHSyncBegin()

virtual void gem5::BasePixelPump::onHSyncBegin ( )

inlineprotectedvirtual

Start of the HSync region.

Note: This is called even for scan lines outside of the visible region.

Definition at line 264 of file pixelpump.hh.

Referenced by BasePixelPump(), and renderFrame().

◆ onHSyncEnd()

virtual void gem5::BasePixelPump::onHSyncEnd ( )

inlineprotectedvirtual

Start of the first pixel after the HSync region.

Note: This is called even for scan lines outside of the visible region.

Definition at line 272 of file pixelpump.hh.

Referenced by BasePixelPump(), and renderFrame().

◆ onUnderrun()

virtual void gem5::BasePixelPump::onUnderrun	(	unsigned	x,
		unsigned	y )

inlineprotectedvirtual

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

x	Coordinate within the visible region.
y	Coordinate within the visible region.

Reimplemented in gem5::HDLcd::PixelPump.

Definition at line 284 of file pixelpump.hh.

References gem5::RiscvISA::x.

Referenced by renderPixels().

◆ onVSyncBegin()

virtual void gem5::BasePixelPump::onVSyncBegin ( )

inlineprotectedvirtual

First pixel clock of the first VSync line.

Reimplemented in gem5::HDLcd::PixelPump.

Definition at line 250 of file pixelpump.hh.

Referenced by BasePixelPump(), beginLine(), and renderFrame().

◆ onVSyncEnd()

virtual void gem5::BasePixelPump::onVSyncEnd ( )

inlineprotectedvirtual

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

Reimplemented in gem5::HDLcd::PixelPump.

Definition at line 256 of file pixelpump.hh.

Referenced by BasePixelPump(), beginLine(), and renderFrame().

◆ posX()

unsigned gem5::BasePixelPump::posX ( ) const

inline

Current pixel position within the visible area.

Definition at line 206 of file pixelpump.hh.

References _posX.

◆ posY()

unsigned gem5::BasePixelPump::posY ( ) const

inline

Current pixel position within the visible area.

Definition at line 210 of file pixelpump.hh.

References _timings, line, and visibleLine().

Referenced by renderLine(), and renderPixels().

◆ renderFrame()

void gem5::BasePixelPump::renderFrame ( )

Render an entire frame in non-caching mode.

Definition at line 255 of file pixelpump.cc.

References _posX, _timings, _underrun, line, onFrameDone(), onHSyncBegin(), onHSyncEnd(), onVSyncBegin(), onVSyncEnd(), and renderLine().

◆ renderLine()

void gem5::BasePixelPump::renderLine ( )

private

Fast and event-free line rendering function.

Definition at line 287 of file pixelpump.cc.

References fb, nextLine(), panic_if, and posY().

Referenced by renderFrame().

◆ renderPixels()

void gem5::BasePixelPump::renderPixels ( )

private

Definition at line 218 of file pixelpump.cc.

References _posX, _timings, _underrun, gem5::Clocked::clockEdge(), evRenderPixels, fb, nextPixel(), onFrameDone(), onUnderrun(), pixelChunk, posY(), gem5::EventManager::schedule(), and warn.

Referenced by BasePixelPump().

◆ serialize()

void gem5::BasePixelPump::serialize ( CheckpointOut & cp ) const

overridevirtual

Serialize an object.

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

Parameters

cp	Checkpoint state

Implements gem5::Serializable.

Definition at line 112 of file pixelpump.cc.

References _posX, _timings, _underrun, gem5::MipsISA::event, fb, line, pixelEvents, SERIALIZE_OBJ, and SERIALIZE_SCALAR.

◆ start()

void gem5::BasePixelPump::start ( )

Starting pushing pixels in timing mode.

Definition at line 159 of file pixelpump.cc.

References gem5::Clocked::clockEdge(), evBeginLine, and gem5::EventManager::schedule().

◆ stop()

void gem5::BasePixelPump::stop ( )

Immediately stop pushing pixels.

Definition at line 166 of file pixelpump.cc.

References gem5::EventManager::deschedule(), evBeginLine, evHSyncBegin, evHSyncEnd, evRenderPixels, and evVSyncEnd.

◆ timings()

const DisplayTimings & gem5::BasePixelPump::timings ( ) const

inline

Get a constant reference of the current display timings.

Definition at line 189 of file pixelpump.hh.

References _timings.

Referenced by gem5::HDLcd::PixelPump::dumpSettings(), and updateTimings().

◆ underrun()

bool gem5::BasePixelPump::underrun ( ) const

inline

Did a buffer underrun occur within this refresh interval?

Definition at line 195 of file pixelpump.hh.

References _underrun.

◆ unserialize()

void gem5::BasePixelPump::unserialize ( CheckpointIn & cp )

overridevirtual

Unserialize an object.

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

Parameters

cp	Checkpoint state

Implements gem5::Serializable.

Definition at line 126 of file pixelpump.cc.

References _posX, _timings, _underrun, gem5::MipsISA::event, fb, line, pixelEvents, UNSERIALIZE_OBJ, and UNSERIALIZE_SCALAR.

◆ updateTimings()

void gem5::BasePixelPump::updateTimings ( const DisplayTimings & timings )

Update frame size using display timing.

Definition at line 143 of file pixelpump.cc.

References _timings, active(), fb, line, panic_if, and timings().

◆ visibleLine()

bool gem5::BasePixelPump::visibleLine ( ) const

inline

Is the current line within the visible range?

Definition at line 199 of file pixelpump.hh.

References _timings, and line.

Referenced by posY().

Member Data Documentation

◆ _posX

unsigned gem5::BasePixelPump::_posX

private

X-coordinate within the visible region of a frame.

Definition at line 362 of file pixelpump.hh.

Referenced by BasePixelPump(), beginLine(), posX(), renderFrame(), renderPixels(), serialize(), and unserialize().

◆ _timings

DisplayTimings gem5::BasePixelPump::_timings

private

Definition at line 354 of file pixelpump.hh.

Referenced by BasePixelPump(), beginLine(), posY(), renderFrame(), renderPixels(), serialize(), timings(), unserialize(), updateTimings(), and visibleLine().

◆ _underrun

bool gem5::BasePixelPump::_underrun

private

Did a buffer underrun occur within this refresh interval?

Definition at line 365 of file pixelpump.hh.

Referenced by BasePixelPump(), beginLine(), renderFrame(), renderPixels(), serialize(), underrun(), and unserialize().

◆ evBeginLine

PixelEvent gem5::BasePixelPump::evBeginLine

private

Definition at line 351 of file pixelpump.hh.

Referenced by active(), BasePixelPump(), beginLine(), start(), and stop().

◆ evHSyncBegin

PixelEvent gem5::BasePixelPump::evHSyncBegin

private

Definition at line 349 of file pixelpump.hh.

Referenced by BasePixelPump(), beginLine(), and stop().

◆ evHSyncEnd

PixelEvent gem5::BasePixelPump::evHSyncEnd

private

Definition at line 350 of file pixelpump.hh.

Referenced by BasePixelPump(), beginLine(), and stop().

◆ evRenderPixels

PixelEvent gem5::BasePixelPump::evRenderPixels

private

Definition at line 352 of file pixelpump.hh.

Referenced by BasePixelPump(), beginLine(), renderPixels(), and stop().

◆ evVSyncBegin

PixelEvent gem5::BasePixelPump::evVSyncBegin

private

Definition at line 347 of file pixelpump.hh.

Referenced by BasePixelPump().

◆ evVSyncEnd

PixelEvent gem5::BasePixelPump::evVSyncEnd

private

Definition at line 348 of file pixelpump.hh.

Referenced by BasePixelPump(), and stop().

◆ fb

FrameBuffer gem5::BasePixelPump::fb

Output frame buffer.

Definition at line 216 of file pixelpump.hh.

Referenced by renderLine(), renderPixels(), serialize(), unserialize(), and updateTimings().

◆ line

unsigned gem5::BasePixelPump::line

private

Current line (including back porch, front porch, and vsync) within a frame.

Definition at line 360 of file pixelpump.hh.

Referenced by BasePixelPump(), beginLine(), posY(), renderFrame(), serialize(), unserialize(), updateTimings(), and visibleLine().

◆ pixelChunk

const unsigned gem5::BasePixelPump::pixelChunk

private

Maximum number of pixels to handle per render callback.

Definition at line 291 of file pixelpump.hh.

Referenced by BasePixelPump(), and renderPixels().

◆ pixelEvents

std::vector<PixelEvent *> gem5::BasePixelPump::pixelEvents

private

Convenience vector when doing operations on all events.

Definition at line 345 of file pixelpump.hh.

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

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

dev/pixelpump.hh
dev/pixelpump.cc

Classes

Public Member Functions

Public Attributes

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ BasePixelPump()

◆ ~BasePixelPump()

Member Function Documentation

◆ active()

◆ beginLine()

◆ nextLine()

◆ nextPixel()

◆ onFrameDone()

◆ onHSyncBegin()

◆ onHSyncEnd()

◆ onUnderrun()

◆ onVSyncBegin()

◆ onVSyncEnd()

◆ posX()

◆ posY()

◆ renderFrame()

◆ renderLine()

◆ renderPixels()

◆ serialize()

◆ start()

◆ stop()

◆ timings()

◆ underrun()

◆ unserialize()

◆ updateTimings()

◆ visibleLine()

Member Data Documentation

◆ _posX

◆ _timings

◆ _underrun

◆ evBeginLine

◆ evHSyncBegin

◆ evHSyncEnd

◆ evRenderPixels

◆ evVSyncBegin

◆ evVSyncEnd

◆ fb

◆ line

◆ pixelChunk

◆ pixelEvents