Congatec System Utility - CGUTIL

congatec System Utility - cgutil

by Arthur Besler

Introduction

The congatec System Utility is a unified tool for all congatec COM (Computer-on-Module) and SBC (Single Board Computer) products.

It includes six main modules:

1. BIOS Update Module Allows updating the system BIOS on a congatec board.
2. Firmware Update Module Enables firmware updates for the congatec board controller.
3. Panel Configuration Module Simplifies configuration of local flat panel displays.
4. BIOS Module Modification Module Offers functions to customize a standard congatec system BIOS by adding OEM defined BIOS modules, such as:
   • Boot logos
   • BIOS setup defaults and settings
   • OEM code or data modules
5. BIOS/Board Information Module Provides access to congatec-specific BIOS and hardware information.
6. BIOS Setup Configuration Module Allows modification of the BIOS setup menu.

Operating Modes

The utility supports two modes:

• Board Mode Run the utility directly on a congatec system. It uses the CGOS API and drivers to access hardware directly. BIOS modifications are written straight to the onboard BIOS Flash memory.
• BIOS File Mode Perform changes on a BIOS file, which can later be flashed to the target board. This mode can run on a standard host PC but is limited to BIOS module modifications and some panel configuration functions that alter the BIOS.

Important Notice

Modifying the BIOS can lead to corruption. To prevent permanent damage:

• Always test modifications using a congatec evaluation baseboard.
• Make sure to back up the original BIOS to the external Flash memory on the baseboard.
• If the onboard BIOS becomes corrupted, you can recover the system by booting from the external Flash and restoring the original BIOS.

For a copy of the original BIOS file to store on your baseboard, please contact congatec support.

Installation

The congatec System Utility package is available on the congatec website at www.congatec.com. The package includes the following utility

versions in a single ZIP file:

• Windows command line and GUI (Graphical User Interface)
• Linux command line
• UEFI Shell

Note

The Windows and Linux versions require the CGOS driver set, which can be found in the driver section of each product on the congatec website.

Windows command line and GUI

The folder CGUTIL\WIN32 of the utility package contains the Windows command line (CGUTLCMD.EXE) and GUI version (CGUTLGUI.EXE)

of the congatec System Utility. The executables may be placed in any directory. However, both versions need additional files from the CGOS

driver package.

In order to use the utility in BIOS File Mode (modification of congatec BIOS file only) on a host or target system, extract the Windows version

of the file CGOS.DLL from the CGOS driver package. Copy this file into the same directory as the utility executable or into the WINDOWS\

SYSTEM32 folder. Installation is not required.

In order to use the utility in Board Mode (direct target system modification) on a congatec board, install the complete CGOS driver package

on the system. Ensure that you have ‘Administrative Rights’ on the system and follow the installation instructions in the CGOS driver package.

Linux command line

In order to build the Linux command line version of the congatec System Utility (cgutlcmd), run ‘make’ in the folder cgutillx/cgutlcmd. Installation

is not required. It may be placed in any directory. However, additional files from the CGOS driver package for Linux are required.

In order to use the utility in BIOS File Mode (modification of congatec BIOS file only) on a host or target system, extract the Linux version of

the CGOS interface library (libcgos.so) from the CGOS driver package. Copy this file into the same directory as the utility executable or into

the standard system library directory. Installation is not required.

In order to use the utility in Board Mode (direct target system modification) on a congatec board, install the CGOS interface library and

kernel driver on the system. For detailed information about CGOS driver setup on a Linux system, refer to the documentation included in the

respective CGOS driver package.

UEFI Shell

The UEFI Shell version of the congatec System Utility is located in the folder cgutil/uefi/X64 of the package. In order to use cgutlcmd from the

UEFI Shell, copy the file cgutlcmd.efi to an UEFI Shell accessible medium. Installation and additional files are not required.

Note

All of these packages contain readme.txt and/or version.txt files. These files contain detailed information about installation and use.

System Utility Usage

The congatec System Utility offers multiple function modules, accessible via command line or Windows GUI. Since the Linux, Windows, and UEFI Shell command line versions share the same syntax, they are collectively referred to as the command line version.

Each module description may include a brief reference to related BIOS features; detailed BIOS documentation is provided separately by congatec.

The utility supports two main modes:

• Board Mode (requires a target system; enables all functions)
• BIOS File Mode (functions limited to file operations)

Additionally, the GUI version supports EPI File Only mode, which is restricted to creating and modifying EPI panel data set files without requiring a board or BIOS file.

In the Windows GUI (CGUTLGUI), the main window allows target selection and access to modules. Functions unavailable in the chosen mode are disabled. When using BIOS File mode, an input BIOS file must be selected. An output file is then specified for modifications. If the original BIOS file is reused as output, changes are saved directly to it. To preserve the original, define a separate output file. For read-only use, skip the output file selection.

The following functions are explained:

1. congatec System Utility Main Module
2. BIOS Update Module
3. Firmware Update Module
4. Panel Configuration Module
5. Windows GUI Version
6. BIOS Modification Module
7. BIOS Module Types
8. Board and BIOS Information Module
9. BIOS Setup Configuration Module

1. congatec System Utility Main Module

1.1. Windows GUI Version

Execute CGUTLGUI.exe. The following window will appear:

After selecting the input BIOS file, the following dialog appears:

1.2 Command Line Versions

When using the command line versions of the congatec System Utility (CGUTLCMD), the desired function module must be selected by passing a module selection parameter. If a module can be used in ‘Board’ and ‘BIOS File’ mode, the operating target must also be selected by passing the respective parameter.

Calling CGUTLCMD without any parameters provides an overview of the available function module selection parameters. Invoking CGUTLCMD with a function module selector as the only parameter displays the module’s usage description. All parameters are accepted in lower and upper case letters, although all descriptions use upper case.

To support batch file operations, CGUTLCMD sets an error level of one or higher, to indicate an execution error. Error level zero indicates success.

Example:

c:\> CGUTLCMD

Output:

• BCPROG: Board Controller Firmware Update Module
• BFLASH: System BIOS Update Module
• CPANEL: Panel Configuration Module MODULE BIOS Module Modification Module
• CGINFO: Board/BIOS Information Module

Example:

c:\> CGUTLCMD BFLASH

Usage description for the BIOS update module.

BIOS Update And Write Protection

Most congatec boards support the ‘BIOS Update And Write Protection’ feature. If this feature is enabled in the BIOS setup menu, all write and erase accesses to the target system’s Flash Memory chip are blocked. This would also block all functions of the congatec System Utility that require flash write or erase accesses (e.g. BIOS update or any BIOS modifications in ‘Board’ mode). In order to allow BIOS updates or BIOS modifications in ‘Board’ mode even if the protection is enabled, the utility includes functions to temporarily deactivate the ‘BIOS Update And Write Protection’ by passing the correct deactivation password to the system.

For more information about the ‘BIOS Update And Write Protection’ feature and the handling of the protection by the congatec System Utility, refer to the congatec application note AN5_BIOS_Update_And_Write_Protection.