Embedded module TQMxE38C Documentation

BIOS Tools

TQ provides tools from Insyde® for the UEFI BIOS which allows the customization of the BIOS.

Please Note: The following Tools are only available on request.
For further Information please contact Support.

H2OFFT™ (Firmware Flash Tool) for performing BIOS Update
H2OUVE™ (UEFI Variable Editor) to customize default BIOS Options
H2OLRT™ (Logo Replacement Tool) for a customized boot logo
H2OSDE™ (SMBIOS Data Editor) to facilitate easy modification of any SMBIOS (DMI) field
H2OEZE™ (Easy Binary Editor) to edit binaries in the BIOS, including Option ROMs, driver binaries, logos, and Setup values

Using BIOS Tools

H2OFFT (Firmware Flash Tool)

H2OFFT (Firmware Flash Tool) to perform BIOS updates under supported OS environment.

Prerequisites

FAT formatted USB stick with at least 32 MB of free storage space
The BIOS-Tools ZIP file

Update BIOS via EFI-Shell

1. Unzip BIOS-Tools ZIP file and copy the following to the USB stick:

Insyde Firmware Flash Tool H2OFFT-Sx64.efi (BIOS-Tools → H2OFFT (Firmware Flash Tool) → UEFI-Shell → InsydeH2OFFT_x86_EFI_Package_* → InsydeH2OFFT_x86_EFI_* → X64 → H2OFFT-Sx64.efi)
Appropriate BIOS file for your TQ module

Example:
<USB-Stick>
    |--- H2OFFT-Sx64.efi
    |--- <label bios_image_name>BIOS_IMAGE_NAME</label>_<label bios_image_version>BIOS_IMAGE_VERSION</label>.bin

2. Insert the prepared USB Stick to a Starterkit USB port
3. Boot up the system and navigate into the EFI Shell (Boot Manager > Internal EFI Shell)
4. After starting the EFI Shell switch path to the USB stick by typing fs0:.This depends on the amount of conected mass storage devices; with command ls you can check the content of the path.
5. The following command examples shows how to use the H2OFFT Tool.

--------------------------------
<label mod_name>MOD_NAME</label>
--------------------------------
Shell> H2OFFT-Sx64.efi <label bios_image_name>BIOS_IMAGE_NAME</label>_<label bios_image_version>BIOS_IMAGE_VERSION</label> <label bios_update_paramenter>BIOS_UPDATE_PARAMETER</label>

Update BIOS on Windows

1. Unzip BIOS-Tools ZIP file and copy the following to the USB stick:

Insyde Firmware Flash Tool folder InsydeH2OFFT_x86_WIN64_* (BIOS-Tools → H2OFFT (Firmware Flash Tool) → Windows → X64 → InsydeH2OFFT_x86_WINx64_*)
Copy appropriate BIOS file for your TQ module to the folder InsydeH2OFFT_x86_WIN64_*

Example:
<USB-Stick>
    |--- InsydeH2OFFT_x86_WINx64_*
          |-- <label bios_image_name>BIOS_IMAGE_NAME</label>_<label bios_image_version>BIOS_IMAGE_VERSION</label>.bin

2. Insert the prepared USB Stick to a Starterkit USB port
3. Boot up the system and run Command Prompt as administrator
4. Switch path to the InsydeH2OFFT_x86_WIN64_* folder.
5. Following generic commands shows how to start the BIOS Update for TQMx86 modules.

--------------------------------
<label mod_name>MOD_NAME</label>
--------------------------------
> H2OFFT-Wx64 <label bios_image_name>BIOS_IMAGE_NAME</label>_<label bios_image_version>BIOS_IMAGE_VERSION</label> <label bios_update_paramenter>BIOS_UPDATE_PARAMETER</label>

Update BIOS on Linux

1. Unzip BIOS-Tools ZIP file and copy the following to the USB stick:

Insyde Firmware Flash Tool folder InsydeH2OFFT_x86_LINUX64_* (BIOS-Tools → H2OFFT (UEFI Variable Editor) → Linux → X64 → InsydeH2OUVE_x86_LINUX64_*)
Copy appropriate BIOS file for your TQ module

Example:
<USB-Stick>
    |--- InsydeH2OFFT_x86_LINUX64_*
    |--  <label bios_image_name>BIOS_IMAGE_NAME</label>_<label bios_image_version>BIOS_IMAGE_VERSION</label>.bin

2. Insert the prepared USB Stick to a Starterkit USB port
3. Boot up the system and open terminal
4. Switch path to the InsydeH2OFFT_x86_LINUX64_* folder
5. Extract tar package tar -xvf InsydeH2OFFT_x86_LINUX64_portable_*.tar.bz2
6. Install H2OFFT Tool sudo dpkg -i InsydeH2OFFT_x86_LINUX64_*.deb

If errors occur during driver installation, build driver manually:

$ cd /var/local/insyde/H2OFFT/driver/
$ sudo -E make
$ sudo -E make install
$ sudo apt-get install

7. Run following generic commands shows how to start the BIOS Update for TQMx86 modules.

--------------------------------
<label mod_name>MOD_NAME</label>
--------------------------------
$ sudo h2offt-lx64 <label bios_image_name>BIOS_IMAGE_NAME</label>_<label bios_image_version>BIOS_IMAGE_VERSION</label> <label bios_update_paramenter>BIOS_UPDATE_PARAMETER</label>

H2OUVE (UEFI Variable Editor)

The H2OUVE (UEFI Variable Editor) allows to edit setup settings and variable data of the BIOS Image.

Prerequisites

FAT formatted USB stick with at least 32 MB of free storage space
The BIOS-Tools ZIP file

Using H2OUVE in the EFI-Shell

1. Unzip BIOS-Tools ZIP file and copy the following to the USB stick:

Insyde UEFI Variable Editor H2OUVE-Sx64.efi (BIOS-Tools → H2OUVE (UEFI Variable Editor) → UEFI-Shell → InsydeH2OUVE_x86_EFI_* → H2OUVE-Sx64.efi)
Appropriate BIOS file for your TQ module

Example:
<USB-Stick>
    |--- H2OUVE-Sx64.efi
    |--- <label bios_image_name>BIOS_IMAGE_NAME</label>_<label bios_image_version>BIOS_IMAGE_VERSION</label>.bin

Examples:
Print out help message:
Shell> H2OUVE-Sx64.efi -h

Print out BIOS supported functionalities:
Shell> H2OUVE-Sx64.efi -fea

Remove a variable by name:
Shell> H2OUVE-Sx64.efi -re -vn SioTqmx86Setup00

Dump variable information to a variable record file:
Shell> H2OUVE-Wx64.efi -gv testfile

Update variables from specified variable record file:
Shell> H2OUVE-Wx64.efi -sv testfile

Using H2OUVE on Windows

1. Unzip BIOS-Tools ZIP file and copy the following to the USB stick:

Insyde UEFI Variable Editor folder InsydeH2OUVE_x86_WINx64_* (BIOS-Tools → H2OUVE (UEFI Variable Editor) → Windows → X64 → InsydeH2OUVE_x86_WINx64_*)
Copy appropriate BIOS file for your TQ module to the folder InsydeH2OUVE_x86_WINx64_*

Example:
<USB-Stick>
    |--- InsydeH2OUVE_x86_WINx64_*
          |-- <label bios_image_name>BIOS_IMAGE_NAME</label>_<label bios_image_version>BIOS_IMAGE_VERSION</label>.bin

2. Insert the prepared USB Stick to a Starterkit USB port
3. Boot up the system and run Command Prompt as administrator
4. Switch path to the InsydeH2OUVE_x86_WINx64_* folder.
5. Following command examples shows how to use the H2OUVE Tool.

Examples:
Print out help message:
> H2OUVE-Wx64 -h

Print out BIOS supported functionalities:
> H2OUVE-Wx64 -fea

Remove a variable by name:
> H2OUVE-Wx64 -re -vn SioTqmx86Setup00

Dump variable information to a variable record file:
> H2OUVE-Wx64 -gv testfile

Update variables from specified variable record file:
> H2OUVE-Wx64 -sv testfile

Using H2OUVE on Linux

1. Unzip BIOS-Tools ZIP file and copy the following to the USB stick:

Insyde UEFI Variable Editor folder InsydeH2OUVE_x86_LINUX64_* (BIOS-Tools → H2OUVE (UEFI Variable Editor) → Linux → X64 → InsydeH2OUVE_x86_LINUX64_*)
Copy appropriate BIOS file for your TQ module

Example:
<USB-Stick>
    |--- InsydeH2OUVE_x86_LINUX64_*
    |--  <label bios_image_name>BIOS_IMAGE_NAME</label>_<label bios_image_version>BIOS_IMAGE_VERSION</label>.bin

2. Insert the prepared USB Stick to a Starterkit USB port
3. Boot up the system and open terminal
4. Switch path to the InsydeH2OUVE_x86_LINUX64_* folder
5.Extract package tar -xvf InsydeH2OUVE_x86_LINUX64_portable_.tar.bz2
6. Install H2OUVE Tool sudo dpkg -i InsydeH2OUVE_x86_LINUX64_*.deb

If errors occur during driver installation, build driver manually:

$ cd /var/local/insyde/H2OUVE/driver/
$ sudo -E make
$ sudo -E make install
$ sudo apt-get install

7. Run following generic commands shows how to start the BIOS Update for TQMx86 modules.

Examples:
Print out help message:
$ sudo h2ouve-lx64 -h

Print out BIOS supported functionalities:
$ sudo h2ouve-lx64 -fea

Remove a variable by name:
$ sudo h2ouve-lx64 -re -vn SioTqmx86Setup00

Dump variable information to a variable record file:
$ sudo h2ouve-lx64 -gv testfile

Update variables from specified variable record file:
$ sudo h2ouve-lx64 -sv testfile

H2OLRT (Logo Replacement Tool)

This instructions guide you through the procedure of replacing the Bootlogo in EFI-Shell, Windows and Linux.
The H2OLRT (Logo Replacement Tool) generates a BIOS file that contains the desired Boot Logo instead of the TQ Logo.

Prerequisites

FAT formatted USB stick with at least 32 MB of free storage space
The BIOS-Tools ZIP file

Replace Boot Logo via EFI Shell

1. Unzip BIOS-Tools ZIP file and copy the following to the USB stick:

Insyde Boot Logo Replacement Tool H2OLRT-Sx64.efi (BIOS-Tools → H2OLRT (Logo Replacement Tool) → UEFI-Shell → InsydeH2OLRT_x86_EFI_* → H2OLRT-Sx64.efi)
The new Boot Logo Picture formated as *.jpg (e.g. picture.jpg)
Appropriate BIOS file for your TQ module

Example:
<USB-Stick>
    |--- H2OLRT-Sx64.efi
    |--- <label bios_image_name>BIOS_IMAGE_NAME</label>_<label bios_image_version>BIOS_IMAGE_VERSION</label>.bin
    |--- example_picture.jpg

H2OLRT-Sx64.efi –replogo:<label bios_image_name>BIOS_IMAGE_NAME</label>_<label bios_image_version>BIOS_IMAGE_VERSION</label>.bin –logopath:example_picture.jpg -logoindex:<label bios_logo_index>LOGO_INDEX</label> –logoconvert:1 –out:<label bios_image_name>BIOS_IMAGE_NAME</label>_<label bios_image_version>BIOS_IMAGE_VERSION</label>_new.bin

H2OLRT-Sx64.efi Variable description

Variable	Description
<SrcBIOSImageName>	BIOS file in which the logo should be replaced
<LogoImagePathName>	Path and name of the replacement picture
<IndexNum>	Default index, where the picture must be stored. MOD_NAME = LOGO_INDEX
<ConvertNum>	0 = keep original image's format and dimension. 1 [default] = auto convert the image's format and dimension.
<OutBIOSImageName>	path and name of the generated BIOS file

H2OSDE (SMBIOS Data Editor)

The tool H2OSDE (SMBIOS Data Editor) facilitates easy modifications of any SMBIOS (DMI) field.

Prerequisites

FAT formatted USB stick with at least 32 MB of free storage space
The BIOS-Tools ZIP file

Using H2OSDE in the EFI-Shell

1. Unzip BIOS-Tools ZIP file and copy the following to the USB stick:

Insyde SMBIOS Data Editor H2OSDE-Sx64.efi

Examples:
Use User Interface: 
Shell> H2OSDE-Sx64

Print out help message:
Shell> H2OSDE-Sx64 -h

Print out system manufacturer:
Shell> H2OSDE-Sx64 -SM

Write system manufacturer:
Shell> H2OSDE-Sx64 -SM "manufacturer-name"

Replace UUID:
Shell> H2OSDE-Sx64 -SU 12345678-1234-1234-1234-123456789012

Auto generate UUID:
Shell> H2OSDE-S64 -SU AUTO

Using H2OSDE in Windows

Unzip BIOS-Tools ZIP file:
navigate to the H2OSDE program path and open the program GUI.exe

Alternatively, the program can also be executed in the windows command prompt:

C:\> cd "Path_to_H2OSDE-Wx64_directory"
C:\> H2OSDE-Wx64.exe -h

Using H2OSDE in Linux

Unzip BIOS-Tools ZIP file
navigate to the H2OSDE program path and run following command:

$ cd "Path_to_H2OSDE-File"
$ sudo ./gui

Alternatively, the program can also be executed in the terminal:

$ sudo ./h2osde-lx64