x86 EApi
Windows version
Installation
First you have to open command prompt as dmin and navigate to the folder containing the installation files. Then start the 'install.batch' from the command prompt.
Before reinstalling you have to uninstall 'TqDriver' from within the Device manager!
Initialisation
EApiLibInitialize | Function must be called at the beginning of every application. It will return Error if TQ driver is not installed. |
EApiLibUnInitialize | Function must be called at the end of every application. |
EApiBoardGetStringA <string id>
Example
> TqApp.exe EApiBoardGetStringA 0
Board Manufacturer Name = TQ-Group
0 | Board Manufacturer Name |
1 | Board Name |
2 | Board Revision |
3 | Serial Number |
4 | Board BIOS Revision |
5 | Board HW Revision |
6 | Platform ID |
EApiBoardGetValue <value id>
Example
> TqApp.exe EApiBoardGetValue 7
CPU Temperature = 30.5
0 | EAPI Specification Version |
1 | Boot Counter |
2 | Running Time Meter |
3 | Board vendor PNPID |
4 | Platform Specification Version |
5 | Vendor Specific Driver Version |
6 | Vendor Specific Library Version |
7 | CPU Temperature in °C |
8 | Chipset Temperature in °C |
9 | System Temperature in °C |
10 | CPU Core Voltage |
11 | 2.5V Voltage |
12 | 3.3V Voltage |
13 | Battery Voltage |
14 | 5V Voltage |
15 | 5V Standby Voltage |
16 | 12V Voltage |
17 | CPU Fan in RPM |
18 | System Fan in RPM |
Backlight
Backlight Functions are available only if suitable display is connected.
Latest Intel(R) HD Graphics driver must be installed on the system.
EApiVgaBacklightEnable | |
EApiVgaGetBacklightBrightness | Backlight Brightness Intervall 0 - 255. |
EApiVgaSetBacklightBrightness | Backlight Brightness Intervall 0 - 255. |
Storage
There are 2 available EEPROMs:
EApiStorageCap
EApiStorageAreaRead
| EApiStorageAreaRead | ID | Offset | Bytecnt |
| Datatype | dec | hex | dec |
Example:
TqApp.exe EApiStorageAreaRead 0 0 32
EApiStorageAreaRead() successfully read data:
| 00 01 02 03 04 05 06 07 08 09 0A 0B 0C 0D 0E 0F
-----|-----------------------------------------------
0000 | 00 01 02 03 04 05 06 07 08 09 0a 0b 0c 0d 0e 0f ................
0010 | 10 11 12 13 14 15 16 17 18 19 1a 1b 1c 1d 1e 1f ................
EApiStorageAreaWrite
| EApiStorageAreaWrite | ID | Offset | Data |
| Datatype | dec | hex | hex …. hex |
Example:
> EApiStorageAreaWrite 0 0x20 " 0 1 2 3 4 5 6 7 8 9 10 11
12 13 14 15 16 17 18 19 20 21 22 23
24 25 26 27 28 29 30 31"
> TqApp.exe EApiStorageAreaWrite 0 0x20 "0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31"
I2C
The current frequency is defined in Windows registry:
HKLM\SYSTEM\CurrentControlSet\Services\TqDrv\Parameters\I2cBusSpeed
Default Frequency is 100KHz, the following frequencies are available on the primary CPLD I2C Bus:
After changing I2C frequency in Windows registry, you need to reset Tq driver in Windows Device Manager:
Open Windows Device Manager and find System Devices/ TqDriver
Right Click on TqDriver and choose “Disable”, then reenable it
EApiI2CWriteReadRawr
| EApiI2CWriteReadRaw | bus_id | i2c_addr | string_to_write | bytes_to_read |
| Datatype | dec | hex | hex … hex | dec |
To ignore write operation: <string_to_write> = “”
To ignore read operation: <bytes_to_read> = 0
Example:
Write 2 bytes: 0x00 0x00; Read 10 bytes
> TqApp.exe EApiI2CWriteReadRaw 0 AE "0 0" 10
EApiI2CWriteReadRaw() completed successfully
WriteData:
| 00 01 02 03 04 05 06 07 08 09 0A 0B 0C 0D 0E 0F
-----|-----------------------------------------------
0000 | 00 00 ..
ReadData:
| 00 01 02 03 04 05 06 07 08 09 0A 0B 0C 0D 0E 0F
-----|-----------------------------------------------
0000 | 00 01 02 03 04 05 06 07 08 09 ..........
Read 5 bytes:
> TqApp EApiI2CWriteReadRaw 0 AE "" 5
EApiI2CWriteReadRaw() completed successfully
ReadData:
| 00 01 02 03 04 05 06 07 08 09 0A 0B 0C 0D 0E 0F
-----|-----------------------------------------------
0000 | 0a 0b 0c 0d 0e .....
Write 6 bytes: 0x00 0x03 0x45 0xA7 0xB8 0x12
> TqApp.exe EApiI2CWriteReadRaw 0 AE "0 3 45 A7 B8 12" 0
EApiI2CWriteReadRaw() completed successfully
WriteData:
| 00 01 02 03 04 05 06 07 08 09 0A 0B 0C 0D 0E 0F
-----|-----------------------------------------------
0000 | 00 03 45 a7 b8 12 ..Eº╕.
EApiI2CReadTransfer | EApiI2CWriteTransfer
| EApiI2CReadTransfer | bus_id | i2c_addr | cmd | type | bytes_to_read |
| EApiI2CWriteTransfer | bus_id | i2c_addr | cmd | type | bytes_to_write |
| Datatype | dec | hex | hex | hex | dec |
where 'type' = 0/1/2 (No Command/ Standard Command/ Extended Command)
Examples
Read 12 bytes with No Command
> TqApp.exe EApiI2CReadTransfer 0 AE 0 0 12
EApiI2CReadTransfer() completed successfully
ReadData:
| 00 01 02 03 04 05 06 07 08 09 0A 0B 0C 0D 0E 0F
-----|-----------------------------------------------
0000 | 07 08 09 0a 0b 0c 0d 0e 0f 10 11 12 ............
Read 3 bytes with Extended Command = 0x10F3
> TqApp.exe EApiI2CReadTransfer 0 AE 1B2 2 3
EApiI2CReadTransfer() completed successfully
ReadData:
| 00 01 02 03 04 05 06 07 08 09 0A 0B 0C 0D 0E 0F
-----|-----------------------------------------------
0000 | f3 f4 f5 ≤⌠⌡
Write 1 byte 0x17 with No Command
> TqApp.exe EApiI2CWriteTransfer 0 AE 0 2 "A B C D E"
EApiI2CWriteTransfer(): completed successfully
WriteData:
| 00 01 02 03 04 05 06 07 08 09 0A 0B 0C 0D 0E 0F
-----|-----------------------------------------------
0000 | 0a 0b 0c 0d 0e .....
Watchdog Functions
EApiWDogStart
Delay mode is not supported. Event mode and Reset mode are supported.
List of possible Watchdog timeout values
0.125s
0.250s
0.500s
1s
2s
4s
8s
16s
32s
64s
128s
256s
512s
1024s
2048s
4096s
If timeout falls between these values, the closest top value will be used: For Example:
For 10 seconds - 16 secnds will be used.
For 683 seconds - 1024 seconds will be used.
Event Mode
Event timeout must be defined, other Timeout values must be 0.
2 interrupt lines are supported: 10 and 11.
Default line is 11.
Interrupt number must be defined in 2 places:
To change IRQ line you need to change it in 2 places. After that you need to reset Tq driver in Windows Device Manager:
Open Windows Device Manager and find System Devices/ TqDriver
Right Click on TqDriver and choose “Disable”, then reenable it
Reset mode
Reset timeout must be defined, other Timeout values must be 0.
Following reset modes are supported:
1 = watchdog reset output triggers hard reset signal
0 = watchdog reset output triggers power-on button
Reset mode is definded in Windows Registry, default value is 1.
HKLM\SYSTEM\CurrentControlSet\Services\TqDrv\Parameters\WdtReset
Dual-Stage Mode
In dual-stage mode (Event + Reset) Event timeout will be used for both stages. Event timeout must be defined, reset timeout must not equal zero.
EApiWDogStart <Delay> <EventTimeout> <ResetTimeout>
Time must be specified in ms.
Example:
EApiWDogStart 0 15200 1000
GPIO
ON TQ Boards, 8 GPIO's are available, all of which can be input or output. The EApi library defines two different mechanisms to address GPIO: pin addressing and bank addressing. EAPI_GPIO_BANK_ID(GPIO_NUM) is used to define the GPIO bank.
EApiGPIOGetDirection
EApiGPIOGetDirection <bank> uses bank addressing, where <bank> is a group of 32 pins addressed simultaneously.
Example:
> TqApp.exe EApiGPIOGetDirection 0
Bank 0: DIRECTION = 0xff
EApiGPIOSetDirection
EApiGPIOSetDirection <Pin> <Direction> uses pin addressing. <Direction> == 0 means Output, otherwise Input
Example:
Setting pin 2 to output
> TqApp.exe EApiGPIOSetDirection 2 0
EApiGPIOSetLevel
EApiGPIOSetLevel <bank> uses bank addressing, where <bank> is a group of 32 pins addressed simultaneously.
Example:
> TqApp.exe EApiGPIOsetLevel 4 1
EApiGPIOGetLevel
EApiGPIOGetLevel <bank> uses bank addressing, where <bank> is a group of 32 pins addressed simultaneously.
Example:
> TqApp.exe EApiGPIOGetLevel 0
Bank 0: LEVEL = 0xfb
TQ Library Functions
TqWdtWaitForInterrupt
This function detects Watchdog interrupts, there is a standalone application for TqWdtWaitForInterrupt because it’s not part of EAPI.
Examples
CMD1:
> WdtWaitForInterrupt.exe
CMD2:
> TqApp.exe EApiWDogStart 0 10000 0
After 16 seconds CMD1 will output “Watchdog interrupt was caught”
Known Issues
Windows
I2C EEPROM may be unstable if I2C bus speed is set to 400KHz. Recommended I2C bus speed is 100KHz.
EEPROM access is unstable, e.g. when some data is written to I2C EERPOM it may get written to wrong offset. Usually it happens after large number (thousands) of successive write operations to the EEPROM, or while reading EEPROM in big chunks. Most likely it is a h/w issue of particular model of EEPROM.