Manual

ManualsBrandsKontron ManualsHardwareCP6003-RC uEFI BIOS

If it’s embedded, it’s Kontron.

» User Guide «

P R E L I M I N A R Y

CP6003-SA/RA/RC

uEFI BIOS

Doc. ID: 1045-9149, Rev. 2.0

March 13, 2012

Summary of content (66 pages)

PAGE 1
CP6003-SA/RA/RC uEFI BIOS Doc. ID: 1045-9149, Rev. 2.0 March 13, 2012 If it’s embedded, it’s Kontron.
PAGE 2
Preface CP6003-SA/RA/RC Revision History Publication Title: CP6003-SA/RA/RC uEFI BIOS User Guide Doc. ID: 1045-9149 PRELIMINARY Rev. Brief Description of Changes Date of Issue 1.0 Initial issue based on the uEFI BIOS version R11 20-Sep-2011 2.
PAGE 3
CP6003-SA/RA/RC uEFI BIOS Preface Table of Contents 1. Starting uEFI BIOS Setup .............................................................9 1.1 Main Setup Menu ....................................................................................... 10 1.2 Navigation ...................................................................................................11 2. Main Setup ...................................................................................15 2.2 Trusted Computing .............
PAGE 4
Preface CP6003-SA/RA/RC uEFI BIOS 2.3.4.4 Parity ..........................................................................................22 2.3.4.5 Stop Bits .....................................................................................22 2.3.4.6 Flow Control ...............................................................................22 2.3.4.7 Recorder Mode ..........................................................................22 2.3.4.8 Resolution 100x31 .........................
PAGE 5
CP6003-SA/RA/RC uEFI BIOS Preface 5.2 Discard Changes and Exit .......................................................................... 37 5.3 Save Changes and Reset .......................................................................... 37 5.4 Discard Changes and Reset ...................................................................... 38 5.5 Save Changes (Save Options) ................................................................... 38 5.6 Discard Changes (Save Options) ......................
PAGE 6
Preface 7. CP6003-SA/RA/RC uEFI BIOS 6.3.3.4 Enable Watchdog and Control PXE Boot ..................................61 6.3.3.5 Handling the Startup Script in the Flash Bank ...........................62 Updating the uEFI BIOS ............................................................. 65 7.1 uEFI BIOS Fail-Over Mechanism ...............................................................65 7.2 Updating Procedure ....................................................................................65 7.
PAGE 7
Starting uEFI BIOS Setup Chapter 1 Starting uEFI BIOS Setup ID 1045-9149, Rev. 2.
PAGE 8
PRELIMINARY Starting uEFI BIOS Setup CP6003-SA/RA/RC uEFI BIOS This page has been intentionally left blank. Page 8 ID 1045-9149, Rev. 2.
PAGE 9
CP6003-SA/RA/RC uEFI BIOS 1. Starting uEFI BIOS Setup Starting uEFI BIOS Setup The CP6003-SA/RA/RC is provided with a Kontron-customized, pre-installed and configured version of Aptio® (referred to as uEFI BIOS in this manual), AMI’s next generation BIOS firmware based on the Unified Extensible Firmware Interface (uEFI) specification and the Intel® Platform Innovation Framework for EFI.
PAGE 10
Starting uEFI BIOS Setup 1.1 CP6003-SA/RA/RC uEFI BIOS Main Setup Menu The Main setup menu is the first screen that appears after starting the Setup program. At the top of this screen and all of the other major screens, there is a setup menu selection bar, which permits access to all of the other major setup menus. These menus are selected via the left-right arrow keys. All setup menu screens have two main frames. The left frame displays all the functions that can be configured.
PAGE 11
CP6003-SA/RA/RC uEFI BIOS 1.2 Starting uEFI BIOS Setup Navigation The CP6003-SA/RA/RC uEFI BIOS setup program uses a hot key-based navigation system. A hot key legend is located in the right frame on most setup screens.The following table provides information concerning the usage of these hot keys. HOT KEY DESCRIPTION The key is used to invoke the General Help window. The key is used to restore the previous values. The key is used to load the defaults.
PAGE 12
PRELIMINARY Starting uEFI BIOS Setup CP6003-SA/RA/RC uEFI BIOS This page has been intentionally left blank. Page 12 ID 1045-9149, Rev. 2.
PAGE 13
Main Setup Chapter 21 Main Setup ID 1045-9149, Rev. 2.
PAGE 14
PRELIMINARY Main Setup CP6003-SA/RA/RC uEFI BIOS This page has been intentionally left blank. Page 14 ID 1045-9149, Rev. 2.
PAGE 15
CP6003-SA/RA/RC uEFI BIOS 2. Main Setup Main Setup Upon entering the uEFI BIOS Setup program, the Main setup screen is displayed. This screen lists the main setup sub-screens and provides very basic system information as well as functions for setting the system time and date. In addition, the remaining major setup menus can be accessed from this screen. This screen can also be selected from any other major setup screen by using the Main tab.
PAGE 16
Main Setup 2.2 CP6003-SA/RA/RC uEFI BIOS Trusted Computing This screen provides functions for specifying the TPM configuration settings and TPM displaying status information. Aptio Setup Utility - Copyright (C) 2010 American Megatrends, Inc.
PAGE 17
CP6003-SA/RA/RC uEFI BIOS 2.2.1.2 Main Setup TPM State This function is used to select the TPM State command to be issued to the TPM after POST. Note: This function is available only when the function TPM Support is set to Enable. SETTING DESCRIPTION Disabled Use this setting to disable the TPM after POST. If this setting is used, the TPM is present for the OS but its functionality is locked. Enabled Use this setting to enable the TPM after POST.
PAGE 18
Main Setup 2.3 CP6003-SA/RA/RC uEFI BIOS Serial Port Console Redirection This screen provides information about functions for specifying the Serial Port Console Redirection configuration settings. Console redirection can be used to remotely operate system settings and the uEFI console. Aptio Setup Utility - Copyright (C) 2010 American Megatrends, Inc.
PAGE 19
CP6003-SA/RA/RC uEFI BIOS 2.3.2 Main Setup COM1 The COM1 port (serial port 1) corresponds to the RS-422 serial port on the RIO connector (J3) of the CP6003-SA/RA/RC (hardware designation COMB). 2.3.2.1 Console Redirection SETTING DESCRIPTION Disabled Use this setting to disable console redirection for the serial port 1. Enabled Use this setting to enable console redirection for the serial port 1.
PAGE 20
Main Setup 2.3.3.3 CP6003-SA/RA/RC uEFI BIOS Data Bits This is a display-only function providing information about the frame width for the Out-of-Band Management. 2.3.3.4 Parity This is a display-only function providing information about the parity for Out-of-Band Management. 2.3.3.5 Stop Bits This is a display-only function providing information about the number of stop bits for Out-ofBand Management. PRELIMINARY 2.3.3.
PAGE 21
CP6003-SA/RA/RC uEFI BIOS 2.3.4 Main Setup Console Redirection Settings This screen provides information about functions for specifying the Console Redirection configuration settings for the serial ports 0 and1, and a PCI serial port. Each serial port can be independently configured. Aptio Setup Utility - Copyright (C) 2010 American Megatrends, Inc.
PAGE 22
Main Setup 2.3.4.3 CP6003-SA/RA/RC uEFI BIOS Data Bits SETTING DESCRIPTION 7 Use one of these settings to specify the number of data bits per frame. 8 Default setting: 8 2.3.4.4 Parity SETTING DESCRIPTION None Use one of these settings to select the parity for the serial port. PRELIMINARY Even Odd Mark Space Default setting: None 2.3.4.5 Stop Bits SETTING DESCRIPTION 1 Use one of these settings to specify the number of stop bits for the serial port. 2 Default setting: 1 2.3.4.
PAGE 23
CP6003-SA/RA/RC uEFI BIOS 2.3.4.8 Main Setup Resolution 100x31 SETTING DESCRIPTION Disabled Use this setting the disable extended terminal resolution. Enabled Use this setting the enable extended terminal resolution. Default setting: Disabled Legacy OS Redirection SETTING DESCRIPTION 80x24 Use one of these settings to select the number of rows and columns for legacy OS redirection. 80x25 Default setting: 80x24 2.
PAGE 24
Main Setup 2.7 CP6003-SA/RA/RC uEFI BIOS Access Level This function provides display-only information concerning the uEFI BIOS Setup accessibility for the current Setup session. Depending on the type of password protection used, one of the following settings is displayed: SETTING DESCRIPTION Administrator This setting indicates that read/write access to all setup options is available. User This setting indicates that only a limited subset of all setup options is modifiable.
PAGE 25
Boot Setup Chapter 31 Boot Setup ID 1045-9149, Rev. 2.
PAGE 26
PRELIMINARY Boot Setup CP6003-SA/RA/RC uEFI BIOS This page has been intentionally left blank. Page 26 ID 1045-9149, Rev. 2.
PAGE 27
CP6003-SA/RA/RC uEFI BIOS 3. Boot Setup Boot Setup Select the Boot tab to enter the Boot Setup screen. This screen lists the sub-screens for boot configuration and boot device priority. Aptio Setup Utility - Copyright (C) 2010 American Megatrends, Inc. Boot S e c u r it y S a v e & E x it Boot Configuration Setup Prompt Timeout Bootup NumLock State 1 [On] Quiet Boot [Disabled] CSM16 Module Version 07.
PAGE 28
Boot Setup 3.1.2 CP6003-SA/RA/RC uEFI BIOS Bootup NumLock State This function is used to set the state of the keyboard’s numlock function after POST. SETTING DESCRIPTION On Use this setting to switch on the keyboard’s numlock function after POST. Off Use this setting to switch off the keyboard’s numlock function after POST. Default setting: On 3.1.3 Quiet Boot PRELIMINARY This function is used to display either POST output messages or a splash screen during boot-up.
PAGE 29
CP6003-SA/RA/RC uEFI BIOS 3.1.7 Boot Setup Interrupt 19 Capture This function is used to specify if legacy PCI option ROMs are allowed to capture software interrupt 19h. SETTING DESCRIPTION Disabled Use this setting to prevent legacy PCI option ROMs from capturing software interrupt 19h. Enabled Use this setting to allow legacy PCI option ROMs to capture software interrupt 19h. 3.2 Boot Option Priorities 3.2.1 Boot Option #1..
PAGE 30
PRELIMINARY Boot Setup CP6003-SA/RA/RC uEFI BIOS This page has been intentionally left blank. Page 30 ID 1045-9149, Rev. 2.
PAGE 31
Security Setup Chapter 41 Security Setup ID 1045-9149, Rev. 2.
PAGE 32
PRELIMINARY Security Setup CP6003-SA/RA/RC uEFI BIOS This page has been intentionally left blank. Page 32 ID 1045-9149, Rev. 2.
PAGE 33
CP6003-SA/RA/RC uEFI BIOS 4. Security Setup Security Setup Select the Security tab to enter the Security Setup screen. This screen provides information about the passwords and functions for specifying the security settings. Aptio Setup Utility - Copyright (C) 2010 American Megatrends, Inc. Main Boot S e c u r it y S a v e & E x it If ONLY the Administrator’s password is set, then this only limits access to Setup and is only asked for when entering Setup.
PAGE 34
Security Setup 4.1 CP6003-SA/RA/RC uEFI BIOS Administrator Password This function is used to set, change or delete the Administrator password. If there is already a password installed, the system asks for this first. To clear a password, simply enter nothing and acknowledge by pressing Return. To set a password, enter it twice and acknowledge by pressing Return. Note: The password is case-sensitive. 4.2 User Password PRELIMINARY This function is used to set, change or delete the User password.
PAGE 35
Save & Exit Chapter 51 Save & Exit ID 1045-9149, Rev. 2.
PAGE 36
PRELIMINARY Save & Exit CP6003-SA/RA/RC uEFI BIOS This page has been intentionally left blank. Page 36 ID 1045-9149, Rev. 2.
PAGE 37
CP6003-SA/RA/RC uEFI BIOS 5. Save & Exit Save & Exit Select the Save & Exit tab to enter the Save & Exit menu screen. This screen provides functions for handling changes made to the uEFI BIOS settings and the exiting of the Setup program. Aptio Setup Utility - Copyright (C) 2010 American Megatrends, Inc.
PAGE 38
Save & Exit 5.4 CP6003-SA/RA/RC uEFI BIOS Discard Changes and Reset This function is used to discard all changes made within the Setup. This function performs a reboot afterwards. Note: The Setup will ask for confirmation prior to executing this command. 5.5 Save Changes (Save Options) PRELIMINARY This function is used to save all changes made within the Setup to flash. This function returns to Setup. Note: The Setup will ask for confirmation prior to executing this command. 5.
PAGE 39
The uEFI Shell Chapter 61 The uEFI Shell ID 1045-9149, Rev. 2.
PAGE 40
PRELIMINARY The uEFI Shell CP6003-SA/RA/RC uEFI BIOS This page has been intentionally left blank. Page 40 ID 1045-9149, Rev. 2.
PAGE 41
CP6003-SA/RA/RC uEFI BIOS 6. The uEFI Shell The uEFI Shell The Kontron uEFI BIOS features a built-in and enhanced version of the uEFI Shell. For a detailed description of the available standard shell scripting refer to the EFI Shell User’s Guide. For a detailed description of the available standard shell commands, refer to the Shell Command Manual 1.0. Both documents can be downloaded from the EFI and Framework Open Source Community homepage (https://efi-shell.tianocore.
PAGE 42
The uEFI Shell 6.2 CP6003-SA/RA/RC uEFI BIOS Kontron Shell Commands PRELIMINARY The Kontron uEFI implementation provides the following additional commands related to the specific HW features of the Kontron system: • • • • • • • • • • • • kboardconfig kboardinfo kboot kbootnsh kclearnvram kclsp kflash kipmi kmkramdisk kpassword kresetconfig kwdt The following chapters provide information concerning these Kontron-specific commands.
PAGE 43
CP6003-SA/RA/RC uEFI BIOS 6.2.1 The uEFI Shell kboardconfig uEFI Shell Command kboardconfig FUNCTION: SYNTAX: Configure non-volatile board settings kboardconfig kboardconfig [-?||] DESCRIPTION: USAGE: Show online help Specify device from list Select configuration type The kboardconfig command is used to configure non-volatile board settings.
PAGE 44
The uEFI Shell CP6003-SA/RA/RC uEFI BIOS kboardconfig (continued) PRELIMINARY SETTINGS: pxe: Select PXE boot device [disabled]: No PXE boot available all: Try all Ethernet devices round robin for PXE boot gbe_a: CP6003-SA: try only front GbE A port CP6003-RA: try either front GbE B port or rear LPc port CP6003-RC: try only rear LPc port gbe_b: CP6003-SA: try only front GbE B port CP6003-RA: try either front GbE A port or rear LPd port CP6003-RC: try only rear LPd port rear_a: CP6003-SA/RA/RC: try only
PAGE 45
CP6003-SA/RA/RC uEFI BIOS The uEFI Shell kboardconfig (continued) WrProtSata: Enable/Disable onboard SATA flash write protection [disabled]: Do not write protect the onboard SATA flash enabled: The onboard SATA flash is write-protected after POST. OS needs to be prepared to work with write-protected flash. For further information, refer to the operating system’s documentation.
PAGE 46
The uEFI Shell 6.2.2 CP6003-SA/RA/RC uEFI BIOS kboardinfo uEFI Shell Command kboardinfo FUNCTION: SYNTAX: DESCRIPTION: USAGE: Show board identification data kboardinfo The kboardinfo command shows a summary of board-specific identification data. It is especially useful for support queries because it contains this data in a concentrated form. Show board identification data COMMAND / RESPONSE: PRELIMINARY Shell> kboardinfo KOMaOEMF rev.: Board ID: Hardware rev.: Logic rev.
PAGE 47
CP6003-SA/RA/RC uEFI BIOS The uEFI Shell USAGE: KOMaOEMF rev.: Board ID: Hardware rev.: Logic rev.: Boot flash: In system slot: Geographic Address: Material number: Hardware index: Serial number: EFI article name: EFI material number: EFI index: EFI build time: EFI build date: CPU rev.: Chipset rev.: Microcode: CPU ID: CPU Branding: RIO Module: ID 1045-9149, Rev. 2.
PAGE 48
The uEFI Shell 6.2.
PAGE 49
CP6003-SA/RA/RC uEFI BIOS 6.2.4 The uEFI Shell kbootnsh uEFI Shell Command kbootnsh FUNCTION: SYNTAX: Manage the startup script stored in the flash kbootnsh [-b][-?|-g |-p |-d] -b -? -g -p -d DESCRIPTION: USAGE: Display output page by page Show online help Store the current boot script to disk. If there is no physical disk drive present, the kmkramdisk command may be used. Store the shell script pointed to by filename to flash.
PAGE 50
The uEFI Shell 6.2.5 CP6003-SA/RA/RC uEFI BIOS kclearnvram uEFI Shell Command kclearnvram FUNCTION: SYNTAX: Clear the NVRAM to restore the system’s default settings kclearnvram No parameters required. For safety reasons this command must be confirmed by pressing “c”. PRELIMINARY DESCRIPTION: 6.2.6 The kclearnvram command allows to clear the system NVRAM. Since all uEFI settings are stored inside the NVRAM, the default settings are loaded afterwards.
PAGE 51
CP6003-SA/RA/RC uEFI BIOS 6.2.7 The uEFI Shell kflash uEFI Shell Command kflash SYNTAX: Manage uEFI BIOS update kflash [-p|-i|-v|-s|-c|-h|-?] [-f] [-r] [file] Operation mode: -p Program flash -i Show information string and check CRC -v Verify flashed image -s Save current ROM image to file -c Clone flash content to second flash -h Show this help -? Show online help file uEFI BIOS binary file Options: -f Force write Expert options: Not recommended for standard use -r Raw image mode (.bin, .
PAGE 52
The uEFI Shell CP6003-SA/RA/RC uEFI BIOS kipmi uEFI Shell Command 6.2.
PAGE 53
CP6003-SA/RA/RC uEFI BIOS The uEFI Shell kipmi (continued) USAGE: Set IPMI controller mode: COMMAND / RESPONSE: Shell> kipmi mode Set Serial-over-LAN I/O/SOL parameters: COMMAND / RESPONSE: Shell> kipmi net 1 Display system event log: Shell> kipmi sel list Show sensor related information: COMMAND / RESPONSE: Shell> kipmi sensor list Execute raw command. Example: Get self-test results.
PAGE 54
The uEFI Shell CP6003-SA/RA/RC uEFI BIOS kipmi (continued) SETTINGS: mode : Display/Set the IPMI controller operating mode Options: bmc: IPMI controller operates in BMC mode (master) smc: IPMI controller operates in SMC mode (slave) net: Set IPMI-over-LAN (IOL) / Serial-over-LAN (SOL) parameters sel: Display system event log PRELIMINARY sensor list|read: Show board sensor data Options: list: Display an overview of all available board sensors read: Display specific sensor data raw [ <...
PAGE 55
CP6003-SA/RA/RC uEFI BIOS 6.2.9 The uEFI Shell kmkramdisk uEFI Shell Command kmkramdisk FUNCTION: SYNTAX: Create RAMdisk drives kmkramdisk [-?|-s ] where: -? show help DESCRIPTION: Creates a RAMdisk of variable size. Can be very useful to perform file operations when no real filesystem is connected to the system. Note: The RAMdisk loses its mount point name after all drives are remapped by the map -r command.
PAGE 56
The uEFI Shell 6.2.10 CP6003-SA/RA/RC uEFI BIOS kpassword uEFI Shell Command kpassword FUNCTION: SYNTAX: Control uEFI Setup and Shell passwords kpassword [-u|-s] Call without parameters to get current password status PRELIMINARY Parameters: -u Install or change User password -s Install or change Superuser password Note: Old passwords must be verified if set. Entering an empty password disables the password.
PAGE 57
CP6003-SA/RA/RC uEFI BIOS 6.2.11 The uEFI Shell kresetconfig uEFI Shell Command kresetconfig FUNCTION: SYNTAX: Control the board reset behavior kresetconfig [-?|] where: DESCRIPTION: USAGE: Show help pcislave [on|off] Controls if the board shall react on a CPCI backplane reset if it is used as slave board in a peripheral slot. It has no effect if the board is located within a CPCI master slot. Note: This parameter is volatile, and at next start is set to off.
PAGE 58
The uEFI Shell 6.2.12 CP6003-SA/RA/RC uEFI BIOS kwdt uEFI Shell Command kwdt FUNCTION: SYNTAX: Configure the Kontron onboard Watchdog kwdt [-?|-t ] where: -? -t Show help Configure the Watchdog with the time related to timeindex and activate it with reset routing PRELIMINARY Call kwdt -h to obtain a list of time index values and related times DESCRIPTION: USAGE: The kwdt command allows to enable the Kontron onboard Watchdog with reset target before OS boot.
PAGE 59
CP6003-SA/RA/RC uEFI BIOS The uEFI Shell kwdt (continued) USAGE: Set Watchdog to 16 seconds and activate it COMMAND / RESPONSE (none): Shell> kwdt -t 7 Note: Because there is no application which triggers the Watchdog, the system will be reset after 16 seconds in this case. This command should be invoked from a script, followed by an operating system boot, and the OS then has to start triggering the Watchdog.
PAGE 60
The uEFI Shell 6.3 uEFI Shell Scripting 6.3.1 Startup Scripting CP6003-SA/RA/RC uEFI BIOS If the ESC key is not pressed and the timeout is run out, the uEFI Shell tries to execute some startup scripts automatically. It searches for scripts and executes them in the following order: 1. Kontron flash-stored startup script 2. If there is no Kontron flash-stored startup script present, the uEFI-specified startup.nsh script is used.
PAGE 61
CP6003-SA/RA/RC uEFI BIOS 6.3.3.4 The uEFI Shell Enable Watchdog and Control PXE Boot The uEFI Shell provides environment variables used to control the execution flow. echo -off echo “Executing sample startup.nsh...
PAGE 62
The uEFI Shell 6.3.3.5 CP6003-SA/RA/RC uEFI BIOS Handling the Startup Script in the Flash Bank In case there is no mass storage device attached, the startup script can be generated in a RAM disk and stored in the flash bank using the following instructions: 4. Press during power-up to log into the uEFI Shell. 5. Create a RAM disk and set the proper working directory as shown below: Shell> kmkramdisk -s 3 myramdisk Shell> myramdisk: 6.
PAGE 63
Updating the uEFI BIOS Chapter 71 Updating the uEFI BIOS ID 1045-9149, Rev. 2.
PAGE 64
PRELIMINARY Updating the uEFI BIOS CP6003-SA/RA/RC uEFI BIOS This page has been intentionally left blank. Page 64 ID 1045-9149, Rev. 2.
PAGE 65
CP6003-SA/RA/RC uEFI BIOS 7. Updating the uEFI BIOS Updating the uEFI BIOS BIOS updates are typically delivered as an update CD ISO image. This ISO image needs just to be burned to a CD and booted. Follow the menu for updating the uEFI BIOS. For further information refer to the update CD documentation. 7.1 uEFI BIOS Fail-Over Mechanism The CP6003-SA/RA/RC has two SPI boot flashes programmed with the uEFI BIOS, a standard SPI boot flash and a recovery SPI boot flash.
PAGE 66
PRELIMINARY Updating the uEFI BIOS CP6003-SA/RA/RC uEFI BIOS This page has been intentionally left blank. Page 66 ID 1045-9149, Rev. 2.