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:
- BIOS Update Module Allows updating the system BIOS on a congatec board.
- Firmware Update Module Enables firmware updates for the congatec board controller.
- Panel Configuration Module Simplifies configuration of local flat panel displays.
- 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
- BIOS/Board Information Module Provides access to congatec-specific BIOS and hardware information.
- 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:
- congatec System Utility Main Module
- BIOS Update Module
- Firmware Update Module
- Panel Configuration Module
- Windows GUI Version
- BIOS Modification Module
- BIOS Module Types
- Board and BIOS Information Module
- 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:\> CGUTLCMDOutput:
- 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 BFLASHUsage 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.
2. BIOS Update Module
This module allows you to update the BIOS of a congatec board. The respective BIOS file is checked for consistency and compatibility (i.e. whether it may or may not be used with the respective target board). The BIOS will not be programmed if the BIOS file is not a valid BIOS or it has not been created for the target system.
Note
The BIOS Update Module is only supported when the congatec System Utility is in ‘Board’ mode.
2.1 Windows GUI Version
Available functions:
| [Select BIOS File] | Select the BIOS file that should be programmed. |
| [Update BIOS] | Start flash programming (can only be selected after the BIOS file has been chosen). |
| [Deactivate BIOS Update Protection] | This function is only available and required if the ‘BIOS Update And Write Protection’ feature is available and activated in the current BIOS. In this case, write and erase accesses to the target’s Flash Memory chip are only possible after temporarily deactivating the protection. This can be done by passing the correct deactivation password using the dialog started with this button. |
Additional control flags:
| [Invalidate CMOS] | Invalidate the contents of the CMOS RAM in the Real Time Clock after BIOS programming (usually not necessary anymore). |
During the BIOS update process, the central display section shows progress or error messages.
Note
The ‘Current Standard BIOS Version’ and ‘Current OEM BIOS Version’ displayed on the window always refer to the BIOS currently stored in the flash part. After a BIOS update, the new BIOS in the flash part will become active only after rebooting the board.
2.2 Command Line Version
Function module selector:
BFLASH
Syntax:
CGUTLCMD BFLASH <BIOS file> [options / commands]
Syntax description:
| <BIOS file> | Name of the BIOS file to be programmed. |
Options:
| /E | Perform extended/full flash update instead of BIOS content only (standard) flash update. |
| /EF | Force extended/full flash update instead of BIOS content only (standard) flash update. |
| /EM | Perform extended/full flash update instead of BIOS content only (standard) flash update. Manufacturing mode. No automatic reboot after BIOS update. |
| /EFM | Force extended/full flash update instead of BIOS content only (standard) flash update. Manufacturing mode. No automatic reboot after BIOS update. |
| /D | Defer BIOS update. If this parameter is passed, the BIOS update process will stop after preprocessing and allow you to switch to a different Flash Memory chip. |
| /C | Invalidate the contents of the CMOS RAM in the Real Time Clock after BIOS programming. This option is obsolete and only maintained for backwards compatibility. |
| /NOC | Do not invalidate the contents of the CMOS RAM in the Real Time Clock after BIOS programming. This option is obsolete and only maintained for backwards compatibility. |
| /AOO | Perform immediate/automatic off-on cycle to unlock extended BIOS Flash Memory area if necessary. Default for UEFI Shell versions. Use to override OS dependent default unlock behavior of /E, /EM, /EF, /EFM BIOS update options. |
| /NAOO | Do NOT perform immediate/automatic off-on cycle to unlock extended BIOS Flash Memory area. Requires manual off-on cycle to make unlock effective. Default for all other OS versions. Use to override OS dependent default unlock behavior of /E, /EM, /EF, /EFM BIOS update options. |
| BP:xxx | Specify password to deactivate the ‘BIOS Update And Write Protection’. This option can also be used without the ‘BIOS File’ parameter (i.e. CGUTLCMD BFLASH /BP:password) to deactivate the ‘BIOS Update & Write Protection’ without updating the BIOS. This is required in order to allow other functions of the utility to perform necessary flash write accesses. |
Commands:
The commands /EIL, /EU, /EUM, /EL, /ELM do not require a <BIOS file> parameter, as none of them start an actual BIOS update.
| /EIL | Check whether extended BIOS area is locked. |
| /EU | Unlock extended BIOS area for update and execute automatic off-on cycle to make unlock effective. |
| /EUM | Unlock extended BIOS area for update without automatic off-on. Requires manual off-on cycle to make unlock effective. |
| /EL | Lock extended BIOS area and execute automatic off-on cycle to make lock effective. |
| /ELM | Lock extended BIOS area without automatic off-on cycle. Requires manual off-on cycle to make lock effective. |
The extended/full flash update is necessary to perform an update of the complete flash contents on systems that contain additional data in the BIOS Flash Memory chip besides the actual system BIOS. This is the case for most newer congatec products based on Intel technology. The BIOS Flash Memory chip areas that contain this additional data are write‑locked by default and have to be unlocked before being updated. This unlock typically requires an automatic or manual board off‑on cycle, which is (if necessary) initiated by the first call of the BIOS update command. After the automatic or manual off‑on cycle the board should start in unlocked mode. The BIOS update command has to be called again then, this time resulting in an actual BIOS update.
All /E… options and commands as well as /AOO and /NAOO options are related to this extended/full flash update and lock/unlock handling. With options /E and /EM the extended flash update is only performed if the extended flash content has changed. If not, the utility automatically switches to the standard, faster BIOS content‑only update. With options /EF and /EFM the extended update is performed, even if not mandatory. For systems that do not support or require an extended flash update at all, the options /E and /EF are simply ignored. A standard BIOS content only update is performed instead.
When starting a BIOS update with /E, /EM, /EF and /EFM options, the UEFI Shell version of CGUTLCMD by default performs an immediate (forced) off‑on cycle to unlock extended BIOS Flash Memory areas if necessary. For other OSes, CGUTLCMD does not perform such an automatic (forced) off‑on cycle to avoid OS / file system corruption. The necessary off‑on cycle has to be initiated by other means (software controlled or manually). The options /AOO and /NAOO may be used to override the default unlock off‑on cycle behaviour for each CGUTLCMD version. The standalone commands /EIL, /EU, /EUM, /EL, /ELM can be used to check and control the extended BIOS Flash Memory area lock state without actually starting a BIOS update.
Recommended usage:
CGUTLCMD BFLASH BIOSFILE.BIN /E
The following exit codes may be returned by the BIOS update module:
| 0x00 | Success. |
| 0x01 | General error. |
| 0x02 | Interface access or initialisation error. |
| 0x03 | BIOS incompatibility error. |
| 0x04 | The specified file is not a valid BIOS file. |
| 0x05 | BIOS size mismatch. |
| 0x06 | Error processing file. |
| 0x07 | Extended flash update not possible. |
| 0x08 | This platform/BIOS requires an extended/full flash update. Use parameter /E to update. |
| 0x09 | Failed to unlock flash for extended update. |
| 0x0A | Failed to lock flash after extended update. |
| 0x0B | Extended update initiated but not (yet) completed. Perform manual soft off-on cycle and relaunch the process to complete the update. |
2.3 Booting from one Flash Memory chip and flashing the other
If you have two BIOS Flash Memory chips (one on the module and one on the baseboard) you can boot from either and flash the other. This feature is most helpful if one BIOS becomes corrupted and unable to boot the system. You can restore it using the other BIOS. The procedure for GUI and command line versions is explained below.
GUI Version:
After booting from the current Flash Memory chip, the BIOS Update Module of the congatec System Utility must be launched before switching to a different flash part. Once the BIOS Update Module window is started, it is safe to switch to another flash part and the BIOS update process can be performed as usual.
Command Line Versions:
Before switching to another flash part, launch the utility with the following parameters:
CGUTLCMD BFLASH BIOSFILE /D
The utility will start as usual, perform the required preprocessing and will then stop and inform you that it is now safe to switch to another flash part. After doing this and pressing a key to confirm, the BIOS update process will be performed as usual.
Note
Keep in mind that an extended / full flash update (initiated using /EF option) is mandatory when writing a BIOS to a Flash Memory chip that has not been programmed before with a BIOS valid for the board in use. This option can be combined with the /D option:
CGUTLCMD BFLASH BIOSFILE /EF /D
3. Firmware Update Module
All congatec boards are equipped with an onboard microcontroller. Together with the respective firmware, this microcontroller provides a common set of dedicated add‑on functions found on all congatec boards.
Use the Firmware Update Module of the congatec System Utility to update the firmware of the congatec board controller. Integrated check and validation routines ensure that only valid and compatible firmware files are programmed.
Although the board controller performs an internal restart after firmware updates, it is recommended to shut down and restart the system once a new firmware has been programmed.
Note
The Firmware Update Module is only supported when the congatec System Utility is in ‘Board’ mode.
3.1 Windows GUI Version
Available functions:
| [Select Firmware File] | Select the board controller firmware file that should be programmed. |
| [Program Firmware] | Start programming of the board controller (can only be selected after the firmware file has been chosen). |
During the firmware update process, the central display section of the window will show progress or error messages.
The ‘Current Firmware Version’ displayed on the window always refers to the firmware that is currently used by the board controller. As the board controller performs an internal restart after programming, this information is immediately updated when the firmware has been programmed.
3.2 Command Line Version
Function module selector:
BCPROG
Syntax:
CGUTLCMD BCPROG <firmware file> [options]
Syntax description:
| <Firmware file> | Name of the firmware file to be programmed. |
Options:
| /B | Batch mode. No user queries are performed. |
| /F | Fast mode. Verification of the update process is skipped. |
| /Q | Quick mode. Verification of unused space is skipped. |
| /S | Silent mode. All screen outputs except for error messages are suppressed. |
| /V | Verbose mode. Enables additional diagnostic output. |
Recommended usage:
CGUTLCMD BCPROG FIRMWARE.DAT
Caution
Do not update the board controller unless it is explicitly recommended by congatec.
Do not update the 4th Gen board controller firmware (CGBCP4xy.DAT) while console redirection is enabled on a board controller UART.
The additional parameters offered by the command line versions are meant for congatec internal purposes only. They are listed here for completeness but should not be used by congatec customers.
4. Panel Configuration Module
All congatec boards support the EDID™ 1.3 based EPI (Embedded Panel Interface) specification for configuration of local flat panels.
The congatec system BIOS includes a table of predefined and validated EPI data sets for standard panels (called the EPI Panel Data module or simply the EPI module) as well as placeholders for up to three (depends on the actual BIOS) OEM EPI data sets for custom panels within the standard EPI module. The standard and OEM panel data sets of this module can be selected via the BIOS setup menu and will be used for panel configuration during startup. Furthermore, an auto panel detection mechanism can be selected in the setup. In this case, the BIOS tries to find and use an EPI or EDID™ 1.3 data set in an off‑board EEPROM connected to the EPI I2C bus (referred to as EPI EEPROM from now on).
The congatec System Utility allows you to save and update the whole EPI module, save and update the OEM specific EPI data sets within the standard EPI module, as well as reading, writing and clearing the EPI EEPROM. Standard EPI data sets included in the EPI module can be extracted and saved to a file. This file can then be programmed to an EPI EEPROM or used as a base to create a new EPI data set for an OEM panel.
The utility verifies the validity of all data written to any of the locations. The standard EPI BIOS module can only be replaced by a valid congatec EPI BIOS module. The OEM panel data set must be a valid EPI or standard EDID™ 1.3 data set. The EPI EEPROM can be programmed with EPI or EDID™ 1.3 data sets.
In addition to panel data set handling, the command line versions of the ‘Panel Configuration Module’ also include functions to block and unblock the backlight enable signal of the video controller as well as functions to control the backlight intensity using the method or device selected in BIOS setup. The GUI version also offers a sub module to check, create or modify EPI data sets.
Refer to the EPI specification and further congatec documentation for detailed information about the EPI standard and the congatec EPI implementation, as well as for detailed information about the panel configuration data set formats mentioned above.
Note
EPI BIOS module handling and OEM EPI data set handling are supported in ‘Board’ and BIOS File’ mode. Access to the EPI EEPROM requires the respective hardware and is therefore supported in ‘Board’ mode only. EPI data set creation and modification is supported in all modes, including the special ‘EPI File Only’ mode but only by the GUI version of the utility.
Since the EPI BIOS module is part of the system BIOS, updating this module or updating the OEM EPI data set within this module means that the original system BIOS must be modified and therefore obviously is no longer the exact same BIOS. This fact is tracked and indicated later on when using the modified BIOS. To do this in a defined way, it is recommended to assign an OEM version to the BIOS when updating the EPI module or the OEM EPI data set. Please refer to the description of the BIOS Module Modification Module in section 3.4 of this user’s guide for more information about how to do this.
4.1 Windows GUI Version
4.1.1 Panel Configuration Main Window
The ‘Data Set Entries In BIOS EPI Module’ window shows a list of all EPI panel data sets included in the EPI module of the current BIOS. Entries marked as ‘OEM’ represent the placeholders for OEM panel data sets that can be ‘filled’ with own data sets. The other data set entries are standard congatec data sets that can only be read but not updated.
The output window below the function buttons is used to display additional information, error and operation progress messages.
Available functions:
| [Save Selected Data Set] | Save the data set selected in the ‘Data Set Entries In BIOS EPI Module’ window to a file. |
| [Update Selected Data Set] | This function becomes available if you select one of the OEM entries in the ‘Data Set Entries In BIOS EPI Module’ window. It allows the addition of an OEM defined EPI or standard EDID™ 1.3 panel data set to the standard EPI module of the system BIOS or replace an already existing OEM panel data set entry. Standard congatec EPI data sets cannot be updated. |
| [Delete Selected Data Set] | This function becomes available if you select one of the OEM entries in the ‘Data Set Entries In BIOS EPI Module’ window. It allows the deletion of OEM defined EPI or standard EDID™ 1.3 panel data sets from the standard EPI module. Standard congatec EPI data sets cannot be deleted. |
| [Update/Add Complete EPI Module] | Add or replace the complete congatec EPI BIOS module. This module can only be provided by congatec and includes the OEM panel data sets. |
| [Save Complete EPI Module To File] | Save the complete congatec EPI module included in the BIOS to a file. |
| [Deactivate BIOS Write Protection] | This function is only available and required in ‘Board’ mode and only if the ‘BIOS Update And Write Protection’ feature is available and activated in the current BIOS. In this case write and erase accesses to the target’s Flash Memory chip and therefore all BIOS modifications in ‘Board’ mode are only possible after temporarily deactivating the protection. This can be done by passing the correct deactivation password using the dialog started with this button. |
| [Edit/Create EPI Data Set File] | Opens the ‘EPI Data Set Generator’ sub module, which allows the creation of a new EPI data set file. If a data set entry has been selected from the BIOS data set list the corresponding data will be used as a base for further modifications. If no entry has been selected then data set creation must be done from scratch. |
| [Update/Add EPI EEPROM Data] | Write one of the above described panel data sets to the EPI EEPROM. This function is only available in ‘Board’ mode. |
| [Save EPI EEPROM Data To File] | Read a panel data set from the EPI EEPROM and save it to a file. This function is only available in ‘Board’ mode. |
| [Clear EPI EEPROM] | Clear the EEPROM connected to the EPI I2C bus. This function is only available in ‘Board’ mode. |
4.1.2 EPI Data Set Generator
The ‘EPI Data Set Generator’ module allows the creation of new EPI panel data sets for OEM panels either from scratch or based on one of the congatec standard EPI data sets.
- Define the product data as desired (format and field size limitations apply). Helps to organize and identify different data sets. congatec uses the ‘Product/Data Set ID’ field to identify a certain released EPI data set. Use IDs above 0FFh to avoid confusion with data set IDs defined by congatec.
- Define the resolution and the timing parameters for a certain panel. These values can be derived from the respective panel datasheet.
- Define the synchronization signal polarities. The respective values are either defined in the panel’s datasheet or must be selected according to the actual hardware design.
- Define basic technology parameters of the selected panel.
- Define backlight and contrast control values within the EPI data set as well as the desired image orientation.
- Define power on/off sequencing delay values in the EPI data set. For more information on this module, refer to congatec application note AN12_Modify_EPI_Files
4.2 Commando Line Version
Function module selector:
CPANEL
Syntax:
CGUTLCMD CPANEL /OT:[target] /[command] [parm]
Syntax description:
| /OT: | Specify the operating target.
BOARD: All actions result in direct hardware accesses to the respective congatec board. All other strings are interpreted as name of the BIOS file to be modified. |
| parm | Command parameter, if required (e.g. filename of data file). |
Commands:
| /SEPI | Find congatec EPI module and save it to a file specified by PARM. |
| /LEPI | Add or replace the complete congatec EPI module. PARM must specify the name of a valid congatec EPI module file. |
| /SSTD:xxx | Find standard EPI data set number xxx (hexadecimal) in the BIOS and save it to a file specified by PARM. |
| /SOEM:xxx | Find OEM EPI data set number xxx (hexadecimal) in the BIOS and save it to a file specified by PARM. |
| /LOEM:xxx | Add or replace OEM EPI or EDID™ 1.3 panel data set number xxx (hexadecimal). PARM must be set to the name of a valid EPI or EDID™ 1.3 panel data file. |
| /DOEM:xxx | Delete OEM EPI or 1.3 panel data set number xxx (hexadecimal). |
| /SEEP | Read panel data set stored in the EPI EEPROM and save it to a file specified by PARM. This function is only available in ‘Board’ mode. |
| /LEEP | Write data to congatec EPI EEPROM. PARM must be set to the name of a valid panel data set file. This function is only available in ‘Board’ mode. |
| /CEEP | Clear the EPI EEPROM. This function is only available in ‘Board’ mode. |
| /SBLV | Set control value of a backlight intensity control device. (PARM: 0-100; value in percent of maximum value). This function is only available in ‘Board’ mode. |
| /GBLV | Get current value of backlight intensity control device. (Value returned in percent of maximum value). This function is only available in ‘Board’ mode. |
| /SBLS | Set backlight enable state (PARM:0=OFF 1=ON). This function is only available in ‘Board’ mode. |
| /GBLS | Get backlight enable state (0: OFF 1: ON). This function is only available in ‘Board’ mode. |
| /DPL | Display list of EPI data sets included in the BIOS. |
Note
When the ‘BIOS Update And Write Protection’ feature is enabled in BIOS setup, commands that try to write to the BIOS Flash Memory chip will fail. In order to deactivate the BIOS write protection until next boot use: ‘CGUTLCMD BFLASH /BP:[password]’
5. BIOS Module Modification Module
The congatec system BIOS offers support for several OEM defined add‑on BIOS modules. Each congatec BIOS includes a flash storage area, called the Multi Purpose Flash Area (MPFA), where these add‑on modules, along with predefined congatec standard modules, can be stored. Modules located in this area consist of a MPFA header for organization purposes and the actual module data defined and provided by the OEM or predefined by congatec.
The standard system BIOS includes routines to handle different MPFA module types. The BIOS identifies the respective module by evaluating the module type field in the MPFA header of the module and executes the appropriate function for this module type during POST. All modules use at least the module type, module ID and module revision fields of the MPFA module header. If different modules of a certain type are to be added to the BIOS, these modules must have different module IDs in order to be differentiated. The module revision field is for information purposes only, in order to keep track of module versions. Depending on the module type, additional information put into the module header might be required to handle the respective module. If this is the case, it will be noted in the following module descriptions.
The congatec System Utility provides functions to create, add, replace, save and delete the BIOS add‑on modules, extract module data and generate a report of all currently included modules. Adding or deleting BIOS modules obviously means that the standard congatec BIOS is modified -- either a BIOS file if working in BIOS File mode, or the BIOS stored in the onboard Flash Memory chip if working in Board mode. In order to distinguish an OEM modified BIOS from the standard congatec BIOS version that it is based on, the utility also allows you to assign an OEM BIOS version to the modified BIOS. This OEM version will be displayed during POST and in the setup menu in addition to the standard BIOS version.
BIOS Module Types are:
- 5.1.1 Current Setup Settings Module (old: CMOS Backup Map)
- 5.1.2 Default Setup Settings Module (old: CMOS Default Map)
- 5.1.3 Fixed Setup Settings Module (old: Fixed CMOS Settings Map)
- 5.1.4 OEM Code / Data Module (obsolete / deprecated for UEFI based systems)
- 5.1.5 EPI Panel Data Module
- 5.1.6 BIOS Boot Logo Module
- 5.1.7 POST Logo Left Module
- 5.1.8 POST Logo Right Module
- 5.1.9 OEM Setup BIOS Module (Core8 BIOS only; obsolete otherwise)
- 5.1.10 OEM Video Mode Module
- 5.1.11 OEM HDA Verb Table Module
- 5.1.12 OEM SLP 1.0 Module / OEM SLIC Table Module / OA 3.0 Module
- 5.1.13 Standard VBIOS Module
- 5.1.14 OEM VBIOS Module
- 5.1.15 UEFI FW Volume Module
- 5.1.16 OEM Setup Menu Control Module
- 5.1.17 OEM SMBIOS Data Module
Note
All functions of the BIOS Module Modification Module are supported when the congatec System Utility is in Board and BIOS-File mode.