Epson S1D13706 - 10 Hardware Abstraction Layer (HAL); API for 13706 HAL

Page 62
Epson Research and Development
Vancouver Design Center
S1D13706 Programming Notes and Examples
X31B-G-003-03 Issue Date: 01/02/23
10 Hardware Abstraction Layer (HAL)
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.
10.1 API for 13706HAL
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
Function Description
Initialization
seRegisterDevice
Registers the S1D13706 parameters with the HAL.
seRegisterDevice MUST be the first HAL function called by an application.
seInitReg Initializes the registers, LUT, and allocates memory for default surfaces.
seGetHalVersion Returns HAL library version information.
seHalTerminate Frees up memory allocated by the HAL before the application exits.
seGetId Identifies the controller by interpreting the revision code register.
General HAL Support:
seGetInstalledMemorySize Returns the total size of the display buffer in bytes.
seGetAvailableMemorySize Determines the last byte of display buffer available to an application.
seEnableHardwareDisplaySwapping Enables hardware data swapping for Big-Endian systems.
seGetResolution
seGetMainWinResolution
seGetSubWinResolution
Returns the width and height of the active display surface.
seSetSubWinCoordinates Sets the sub-window coordinates.
seGetSubWinCoordinates Returns the sub-window coordinates.
seGetBytesPerScanline
seGetMainWinBytesPerScanline
seGetSubWinBytesPerScanline
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.
seSetPowerSaveMode Enables/disables power save mode.
seGetPowerSaveMode Returns the current state of power save mode.
seSetPowerUpDelay Sets the power-on delay for power save mode.
seSetPowerDownDelay Sets the power-down delay for power save mode.
seCheckEndian Returns the Endian mode of the host CPU platform.