Hardware Abstraction Layer (Hal); Api For 13706Hal - Epson S1D13706 Technical Manual

Page 62

10 Hardware Abstraction Layer (HAL)

10.1 API for 13706HAL

Function
seRegisterDevice
seInitReg
seGetHalVersion
seHalTerminate
seGetId
seGetInstalledMemorySize
seGetAvailableMemorySize
seEnableHardwareDisplaySwapping
seGetResolution
seGetMainWinResolution
seGetSubWinResolution
seSetSubWinCoordinates
seGetSubWinCoordinates
seGetBytesPerScanline
seGetMainWinBytesPerScanline
seGetSubWinBytesPerScanline
seSetPowerSaveMode
seGetPowerSaveMode
seSetPowerUpDelay
seSetPowerDownDelay
seCheckEndian
S1D13706
X31B-G-003-03
The HAL is a processor independent programming library designed to help port applica-
tions and utilities from one SED13xx product to another. Epson has provided this library as
a result of developing test utilities for the SED13xx LCD controller products.
The HAL contains functions which are designed to be consistent between SED13xx
products, but as the semiconductor products evolve, so must the HAL; consequently there
are some differences between HAL functions for different SED13xx products.
Note
As the SED13xx line of products changes, the HAL may change significantly or cease
to be a useful tool. Seiko Epson reserves the right to change the functionality of the
HAL or discontinue its use if no longer required.
This section is a description of the HAL library Application Programmers Interface (API).
Updates and revisions to the HAL may include new functions not included in the following
documentation.
Table 10-1: HAL Functions
Registers the S1D13706 parameters with the HAL.
seRegisterDevice MUST be the first HAL function called by an application.
Initializes the registers, LUT, and allocates memory for default surfaces.
Returns HAL library version information.
Frees up memory allocated by the HAL before the application exits.
Identifies the controller by interpreting the revision code register.
General HAL Support:
Returns the total size of the display buffer in bytes.
Determines the last byte of display buffer available to an application.
Enables hardware data swapping for Big-Endian systems.
Returns the width and height of the active display surface.
Sets the sub-window coordinates.
Returns the sub-window coordinates.
Returns the number of bytes in each line of the displayed image. Note that the
displayed image may be larger than the physical size of the LCD.
Enables/disables power save mode.
Returns the current state of power save mode.
Sets the power-on delay for power save mode.
Sets the power-down delay for power save mode.
Returns the Endian mode of the host CPU platform.
Description
Initialization
Epson Research and Development
Vancouver Design Center
Programming Notes and Examples
Issue Date: 01/02/23