====== 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@tq-group.com|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 \\ Further Tools are only available from Insyde®: * H2ODDT™ (Developer Debug Tool) for source code level Diagnostic and Debugging * H2OPCM™ (Power Cycle Manager) for assisting in power-cycling the system while watching for initialization failures * H2ORTE™ (Register and Table Editor) * H2OELV™ (Event Log Viewer) \\ ===== Using BIOS Tools ===== ==== H2OFFT (Firmware Flash Tool) ==== H2OFFT (**F**irmware **F**lash **T**ool) 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: |--- H2OFFT-Sx64.efi |--- @bios_image_name@_@bios_image_version@.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. -------------------------------- @mod_name@ -------------------------------- Shell> H2OFFT-Sx64.efi @bios_image_name@_@bios_image_version@ @bios_update_paramenter@ ++++ ++++ 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: |--- InsydeH2OFFT_x86_WINx64_* |-- @bios_image_name@_@bios_image_version@.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. -------------------------------- @mod_name@ -------------------------------- > H2OFFT-Wx64 @bios_image_name@_@bios_image_version@ @bios_update_paramenter@ ++++ ++++ 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: |--- InsydeH2OFFT_x86_LINUX64_* |-- @bios_image_name@_@bios_image_version@.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. -------------------------------- @mod_name@ -------------------------------- $ sudo h2offt-lx64 @bios_image_name@_@bios_image_version@ @bios_update_paramenter@ ++++ ---- ==== H2OUVE (UEFI Variable Editor) ==== The H2OUVE (**U**EFI **V**ariable **E**ditor) 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: |--- H2OUVE-Sx64.efi |--- @bios_image_name@_@bios_image_version@.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 H2OUVE Tool. 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: |--- InsydeH2OUVE_x86_WINx64_* |-- @bios_image_name@_@bios_image_version@.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: |--- InsydeH2OUVE_x86_LINUX64_* |-- @bios_image_name@_@bios_image_version@.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 (**L**ogo **R**eplacement **T**ool) 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: |--- H2OLRT-Sx64.efi |--- @bios_image_name@_@bios_image_version@.bin |--- example_picture.jpg 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. Retrieve logoindex of the module H2OLRT-Sx64.efi -D –replogo: In the output of the tool, the index can be located using the following GUID:\\ **771F77D1-13AF-XXX** (image Size W:201 H:196)\\ ++++ Output example | FS0:\> H2OLRT-Sx64.efi -replogo: @bios_image_name@_@bios_image_version@.bin Replace Logo: BIOS src path: @bios_image_name@_@bios_image_version@.bin Available indices of "-logoindex": Index 0 -> FvNum: 0, Image format: BMP, Size: 270056 Bytes, W: 300, H: 300 Guid: 931F77D1-10FE-48BF-AB72-773D389E3FAA Index 1 -> FvNum: 0, Image format: JPG, Size: 10529 Bytes, W: 201, H: 196 Guid: 771F77D1-13AF-48BF-2584-773D389E33CA Index 2 -> FvNum: 0, Image format: TGA, Size: 42178 Bytes, W: 155, H: 68 Guid: 96DCE314-3628-4256-A02E-3B10C61D85FD ... in this example it is located at logoindex 1 ++++ 6. The following shows how to start the Logo Replacement.\\ H2OLRT-Sx64.efi –replogo: –logopath: -logoindex: –logoconvert: –out: ++++ H2OLRT-Sx64.efi Variable description | ^ **Variable** ^ **Description** ^ | | BIOS file in which the logo should be replaced | | | Path and name of the replacement picture | | | Default index, where the picture must be stored.\\ | | | **0** = keep original image's format and dimension. \\ **1** [default] = auto convert the image's format and dimension. | | | path and name of the generated BIOS file |\\ ++++ ++++ Command example | H2OLRT-Sx64.efi –replogo:@bios_image_name@_@bios_image_version@.bin –logopath:example_picture.jpg -logoindex:@bios_logo_index@ –logoconvert:1 –out:@bios_image_name@_@bios_image_version@_new.bin ++++ \\ ---- ==== 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// 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 H2OSDE Tool. 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 ++++ \\ ---- Work in Progress ==== H2OEZE (Easy Binary Editor) ==== The EzE program is designed to provide functions that allow users to edit binaries in the BIOS, including Option ROMs, driver binaries, logos, and Setup values.\\ Functions: * Replace a module * logo replacement * Specify BIOS version * Specify the firmware volume file path * Specify the GUID * Change BIOS default settings * Specify the EDK type or version * Specify the Factory Copy file path * Replace an Option ROM * Replace firmware volume Examples: ++++ CMD| 1. open program directory in CMD: cd "PATH TO PROGRAM" 2. Run program with the argument **-h** to get a list of all available arguments: H2OEZE-x64.exe -h ++++ ++++ Windows GUI| Just click on the program **H2OEZE-x64.exe** to open the graphical interface ++++