The tcDspLcd class provides general access to an LCD 5-6-5 Display device. More...

#include <core/DspLcd.h>

Inheritance diagram for MityDSP::tcDspLcd:

Classes
struct	tsLCDConfig
	LCD timing configuration structure. More...

Public Member Functions
	tcDspLcd (void apAddress, bool abPortrait, tsLCDConfig apConfig, float anBacklightPercent=50.0)
	This constructor is used to open a tcDspLcd 16-bit display interface.
virtual	~tcDspLcd ()
	Default destructor.
virtual bool	SetFrameBuffer (void *apBuffer)
	Updates the current frame buffer, and initiates DMA transfer from the provided buffer.
virtual void	SetBacklight (float anPercent)
	This method sets the backlighting to the specified level.
virtual float	GetBacklight (void)
	This method retrieves the current QVGA backlighting level.
virtual void	SetScreenEnabled (bool apEnable)
	Enables/Disables the screen.
virtual void	GenTestPattern (int anPatternNo)
	Generate a test pattern on the current FrameBuffer.
Public Member Functions inherited from MityDSP::tcDspDisplayDriver
	tcDspDisplayDriver (tcDspFpgaDma *apDma=NULL, int anDmaChannel=0)
	This constructor is used to open a tcDspDisplayDriver interface via the specified instance of tcDspFpgaDma and channel.
virtual	~tcDspDisplayDriver ()
	This destructor is used to close up and free the resources tied to the display driver.
virtual int	GetWidthPixels (void)
	Retrieves display width in pixels.
virtual int	GetHeightPixels (void)
	Retrieves display height in pixels.
virtual int	GetDepthBits (void)
	Retrieves display color depth in bits per pixel.
virtual int	GetFrameBufferBytes (void)
	Returns the required size of the frame buffer (in bytes).
virtual void *	GetFrameBuffer (void)
	Retrieves the current frame buffer in use.
virtual bool	GetScreenEnabled ()
	Returns true if the screen is enabled.

Protected Attributes
unsigned int	mnTicksPerMsec
	Number of clocks per millisecond.
volatile unsigned int *	mpBaseAddr
	Display Base address.
float	mnBacklightDutyPercent
	Current backlight duty cycle (percent)
unsigned int	mnBacklightDutyCounts
	Current backlight duty cycle (counts)
float	mnOnBacklightDutyPercent
	backlight duty cycle (percent) for screen enables
tsLCDConfig	msConfig
Protected Attributes inherited from MityDSP::tcDspDisplayDriver
LCK_Handle	mhMutex
	Used to serialize access.
int	mnWidthPixels
	Pixel width of display.
int	mnHeightPixels
	Pixel height of display.
int	mnDepthBits
	Color depth of display.
tcDspFpgaDma *	mpDma
	Pointer to instance of tcDspFpgaDma.
int	mnDmaChannel
	DMA channel to use.
void *	mpFrameBuffer
	Current frame buffer address.
int	mnFrameBufferBytes
	Bytes required in frame buffer.
CACHE_L2Mode	msL2Mode
	Cache mode.
bool	mbScreenEnabled
	Screen enable.

Static Protected Attributes
static const int	gnBacklightMinValue = 0
	minimum backlight duty cycle value
static const int	gnBacklightMaxValue = 255
	maximum backlight duty cycle value

Detailed Description

The tcDspLcd class provides general access to an LCD 5-6-5 Display device.

It is derived from the tcDspDisplayDriver base class to provide a consistent interface to the underlying frame buffer. Additional functions to set and get the display backlighting are provided. This driver in turn may be used to setup direct access to the device's frame buffer, or may be used in conjunction with the tcDisplay class.

Note:: This Core deprecates the tcDspQvga16 class.

See also:: tcDspLcd Page

Constructor & Destructor Documentation

tcDspLcd::tcDspLcd	(	void *	apAddress,
		bool	abPortrait,
		tsLCDConfig *	apConfig,
		float	anBacklightPercent = `50.0`
	)

This constructor is used to open a tcDspLcd 16-bit display interface.

Parameters:

[in]	apAddress	Base Address of the 16-bit LCD core
[in]	abPortrait	True if the display is scanned in portrait mode, false if in landscape (default: false).
[in]	apConfig	User customized LCD timing/configuration, defaults to nominal Quarter VGA settings.
[in]	anBacklightPercent	The backlight level initially and also used when set_screen_enable(true) is called.

Returns:: None.

See also:: DspLcd.h; DspDisplayDriver.h

tcDspLcd::~tcDspLcd ( )

virtual

Default destructor.

Returns:: None.

Member Function Documentation

bool tcDspLcd::SetFrameBuffer ( void * apBuffer )

virtual

Updates the current frame buffer, and initiates DMA transfer from the provided buffer.

If NULL, DMA is disabled. In addition, if the frame buffer is transitioning from NULL, the LCD startup procedure is performed. Similarly, if transitioning to NULL, the shutdown procedure is performed.

Parameters:

[in] apBuffer Pointer to the new frame buffer.

Returns:: True if DMA scheduled (or disabled), false otherwise.

See also:: tcDspLcd.h; DspDisplayDriver.h

Reimplemented from MityDSP::tcDspDisplayDriver.

void tcDspLcd::SetBacklight ( float anPercent )

virtual

This method sets the backlighting to the specified level.

The level is given as a percentage, where 0% is off, and 100% is full brightness. This will only work with LCD supporting variable backlight levels.

Parameters:

[in] anPercent LCD backlight brightness percentage.

Returns:: None.

See also:: DspLcd.h

float tcDspLcd::GetBacklight ( void )

virtual

This method retrieves the current QVGA backlighting level.

Returns:: Current LCD backlight brightness percentage..

See also:: DspQvga16.h

void tcDspLcd::SetScreenEnabled ( bool abEnable )

virtual

Enables/Disables the screen.

Parameters:

[in] abEnable True to turn on the screen, false to turn it off

See also:: DspDisplayDriver.h

Reimplemented from MityDSP::tcDspDisplayDriver.

void tcDspLcd::GenTestPattern ( int anPatternNo )

virtual

Generate a test pattern on the current FrameBuffer.

Note, this routine does not flush the caches...

Parameters:

[in] anPatternNo Not Used

See also:: DspDisplayDriver.h

Member Data Documentation

const int MityDSP::tcDspLcd::gnBacklightMinValue = 0

staticprotected

minimum backlight duty cycle value

const int MityDSP::tcDspLcd::gnBacklightMaxValue = 255

staticprotected

maximum backlight duty cycle value

unsigned int MityDSP::tcDspLcd::mnTicksPerMsec

protected

Number of clocks per millisecond.

volatile unsigned int* MityDSP::tcDspLcd::mpBaseAddr

protected

Display Base address.

float MityDSP::tcDspLcd::mnBacklightDutyPercent

protected

Current backlight duty cycle (percent)

unsigned int MityDSP::tcDspLcd::mnBacklightDutyCounts

protected

Current backlight duty cycle (counts)

float MityDSP::tcDspLcd::mnOnBacklightDutyPercent

protected

backlight duty cycle (percent) for screen enables

tsLCDConfig MityDSP::tcDspLcd::msConfig

protected

Classes

Public Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation