Kontron CP3002 uEFI User Manual

» User Guide «
CP3002/CP3002-RC/CP3002-RA
uEFI BIOS
Doc. ID: 1042-8946, Rev. 3.0
April 28, 2011
P R E L I M I N A R Y
If it’s embedded, it’s Kontron.
Preface CP3002/-RC/-RA

Revision History

Publication Title:
Doc. ID: 1042-8946
Rev. Brief Description of Changes Date of Issue
1.0 Initial issue based on the uEFI BIOS version R10 8-Oct-2010
2.0 Added description for the CP3002 uEFI BIOS, update based on the uEFI BIOS version R13
3.0 General update based on the uEFI BIOS version R13 28-Apr-2011
CP3002/-RC/-RA uEFI BIOS User Guide
8-Apr-2011

Imprint

Kontron Modular Computers GmbH may be contacted via the following:
MAILING ADDRESS TELEPHONE AND E-MAIL
Kontron Modular Computers GmbH +49 (0) 800-SALESKONTRON Sudetenstraße 7 sales@kontron.com D - 87600 Kaufbeuren Germany
P R E L I M I N A R Y
For further information about other Kontron products, please visit our Internet web site: www.kontron.com.

Disclaimer

Copyright © 201 1 Kontron AG. All rights reserved. All data is for information purposes only and not guaranteed for legal purposes. Information has been carefully checked and is believed to be accurate; however, no responsibility is assumed for inaccuracies. Kontron and the Kontron logo and all other trademarks or registered trademarks are the property of their respective own­ers and are recognized. Specifications are subject to change without notice.
CP3002/-RC/-RA uEFI BIOS Preface

Table of Contents

Revision History .........................................................................................................ii
Imprint ........................................................................................................................ii
Disclaimer ..................................................................................................................ii
Table of Contents ......................................................................................................iii
1. Starting uEFI BIOS Setup .............................................................3
1.1 Main Setup Menu .........................................................................................4
1.2 Navigation ....................................................................................................5
2. Main Setup .....................................................................................9
2.1 BIOS Information .......................................................................................... 9
2.2 UnCore Information ...................................................................................... 9
2.3 Trusted Computing .....................................................................................10
2.3.1 TPM Configuration .............................................................................10
2.3.1.1 TPM Support .............................................................................10
2.4 S5 RTC Wake Settings ...............................................................................11
2.4.1 S5 RTC Wake Settings .......................................................................11
2.4.2 Wake System with Fixed Time ...........................................................11
2.4.2.1 Wake-Up Hour, Wake-Up Minute, Wake-Up Second .................11
2.4.3 Wake System with Dynamic Time ......................................................11
2.5 Serial Port Console Redirection .................................................................12
2.5.1 COM0 ................................................................................................12
2.5.1.1 Console Redirection .................................................................. 12
2.5.1.2 Console Redirection Settings .................................................... 12
2.5.2 COM1 ................................................................................................13
2.5.2.1 Console Redirection .................................................................. 13
P R E L I M I N A R Y
2.5.2.2 Console Redirection Settings .................................................... 13
2.5.3 COM4 ................................................................................................13
2.5.4 Serial Port for Out-of-Band Management/Windows EMS ................. 13
2.5.4.1 Console Redirection .................................................................. 13
2.5.4.2 Out-of-Band Mgmt Port .............................................................13
2.5.4.3 Data Bits .................................................................................... 14
ID 1042-8946, Rev. 3.0 Page iii
Preface CP3002/-RC/-RA uEFI BIOS
2.5.4.4 Parity ..........................................................................................14
2.5.4.5 Stop Bits .....................................................................................14
2.5.4.6 Terminal Type ............................................................................14
2.5.5 Console Redirection Settings .............................................................15
2.5.5.1 Terminal Type ............................................................................15
2.5.5.2 Bits per second ..........................................................................15
2.5.5.3 Data Bits ....................................................................................16
2.5.5.4 Parity ..........................................................................................16
2.5.5.5 Stop Bits .....................................................................................16
2.5.5.6 Flow Control ...............................................................................16
2.5.5.7 Recorder Mode ..........................................................................16
2.5.5.8 Resolution 100x31 .....................................................................17
2.5.5.9 Legacy OS Redirection ..............................................................17
2.6 System Language .......................................................................................17
2.7 System Date ...............................................................................................17
2.8 System Time ...............................................................................................17
2.9 Access Level ...............................................................................................18
3. Boot Setup ..................................................................................21
3.1 Boot Configuration ......................................................................................21
3.1.1 Quiet Boot ..........................................................................................21
3.1.2 uEFI Boot ...........................................................................................22
3.1.3 Setup Prompt Timeout .......................................................................22
P R E L I M I N A R Y
3.1.4 Bootup NumLock State ......................................................................22
3.1.5 CSM16 Module Version .....................................................................22
3.1.6 GateA20 Active ..................................................................................22
3.1.7 Option ROM Messages ......................................................................23
3.1.8 Interrupt 19 Capture ...........................................................................23
3.2 Boot Option Priorities ..................................................................................24
3.2.1 Boot Option #1..2 ...............................................................................24
3.2.2 Hard Drive/Network Device/CD/DVD ROM Drive/Floppy Drive/ etc..24
3.2.3 Add New Boot Option .........................................................................24
3.2.4 Delete Boot Option .............................................................................24
Page iv ID 1042-8946, Rev. 3.0
CP3002/-RC/-RA uEFI BIOS Preface
4. Security Setup .............................................................................27
4.1 Administrator Password ............................................................................. 28
4.2 User Password ........................................................................................... 28
4.3 HDD Security Configuration .......................................................................28
4.4 Remember the Password ........................................................................... 28
5. Save & Exit ...................................................................................31
5.1 Save Changes and Exit .............................................................................. 31
5.2 Discard Changes and Exit .......................................................................... 31
5.3 Save Changes and Reset .......................................................................... 31
5.4 Discard Changes and Reset ...................................................................... 32
5.5 Save Changes (Save Options) ................................................................... 32
5.6 Discard Changes (Save Options) ...............................................................32
5.7 Restore Defaults (Save Options) ................................................................ 32
5.8 Save as User Defaults (Save Options) .......................................................32
5.9 Restore User Defaults (Save Options) ....................................................... 32
5.10 Boot Override ............................................................................................. 32
6. The uEFI Shell ..............................................................................35
6.1 Introduction, Basic Operation ..................................................................... 35
6.1.1 Shell Startup ......................................................................................35
6.2 Kontron Shell Commands .......................................................................... 36
6.2.1 kboardconfig uEFI Shell Command ................................................... 37
6.2.2 kboardinfo uEFI Shell Command .......................................................40
6.2.3 kboot uEFI Shell Command ...............................................................42
6.2.4 kbootnsh uEFI Shell Command .........................................................44
P R E L I M I N A R Y
6.2.5 kclearnvram uEFI Shell Command .................................................... 45
6.2.6 kclsp uEFI Shell Command ...............................................................45
6.2.7 kflash uEFI Shell Command .............................................................. 46
6.2.8 kmkramdisk uEFI Shell Command .................................................... 47
6.2.9 kpassword uEFI Shell Command ......................................................48
6.2.10 kwdt uEFI Shell Command ................................................................ 49
6.3 uEFI Shell Scripting .................................................................................... 51
ID 1042-8946, Rev. 3.0 Page v
Preface CP3002/-RC/-RA uEFI BIOS
6.3.1 Startup Scripting .................................................................................51
6.3.2 Create a Startup Script .......................................................................51
6.3.3 Examples of St artup Scripts ...............................................................51
6.3.3.1 Automatic Booting from USB Flash Drive ..................................51
6.3.3.2 Switch On Clock Spreading Prior to Booting from Harddrive ....51
6.3.3.3 Execute Shell Script on Other Harddrive ...................................51
6.3.3.4 Enable Watchdog and Control PXE Boot ..................................52
6.3.3.5 Handling the Startup Script in the Flash Bank ...........................53
7. Updating the uEFI BIOS ............................................................. 57
7.1 BIOS Redundancy Strategy ........................................................................57
7.2 Updating Strategy .......................................................................................57
7.3 uEFI BIOS Recovery ..................................................................................57
7.4 Determining the Active Flash ......................................................................57
P R E L I M I N A R Y
Page vi ID 1042-8946, Rev. 3.0
CP3002/-RC/-RA uEFI BIOS Starting uEFI BIOS Setup
Chapter 1
1
Starting uEFI BIOS Setup
ID 1042-8946, Rev. 3.0 Page 1
P R E L I M I N A R Y
Starting uEFI BIOS Setup CP3002/-RC/-RA uEFI BIOS
This page has been intentionally left blank.
P R E L I M I N A R Y
Page 2 ID 1042-8946, Rev. 3.0
CP3002/-RC/-RA uEFI BIOS Starting uEFI BIOS Setup
Enter Password

1. Starting uEFI BIOS Setup

The CP3002/CP3002-RC/CP3002-RA is provided with a Kontron-customized, pre-installed and configured version of Aptio® (referred to as uEFI BIOS in this manual), AMI’s next gener­ation BIOS firmware based on the Unified Extensible Firmware Interface (uEFI) specification and the Intel® Platform Innovation Framework for EFI. This uEFI BIOS provides a variety of new and enhanced functions specifically tailored to the hardware features of the CP3002/ CP3002-RC/CP3002-RA. This user guide reflects the uEFI BIOS version R13.
To take advantage of these functions, the uEFI BIOS comes with a Setup program which pro­vides quick and easy access to the individual function settings for control or modification of the uEFI BIOS configuration.
The Setup program allows the accessing of various menus which provide functions or access to sub-menus with more specific functions of their own. The individual menus and the configu­rable functions are described in this guide.
To start the uEFI BIOS Setup program, follow the steps below:
1. Power on the board.
2. Wait until the first characters appear on the screen (POST messages or splash screen).
3. Press the <F2> key.
4. If the uEFI BIOS is password-protected, a window such as the one below will appear:
Enter either the User password or the Administrator p assword (refer to Chap ter 4, Secu­rity Setup, for further information), press <RETURN>, and proceed with step 2.
5. A Setup menu with the following token attributes will appear. The currently active menu and the currently active uEFI BIOS Setup item a re highlighted in white.
P R E L I M I N A R Y
ID 1042-8946, Rev. 3.0 Page 3
Starting uEFI BIOS Setup CP3002/-RC/-RA uEFI BIOS

1.1 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 menu s are selected via t he left-right arrow keys.
All setup menu screens have two main frames. The left frame displays all the functions that can be configured. They are displayed in blue. Functions displayed in gray provide information about the status or the operational configuration.
The right frame displays the key legend. Above the key legend there is an area reserved for a text message. When a function is selected in the left frame, it is displayed in white. Often a text message will accompany it.
Aptio Setup Utility - Copyright (C) 2009 American Megatrends, Inc.
Main Boot Security Save & Exit
Tit l e (b lac k )
Read only field (grey) value
Setup item (blue) [value]
Pointer to a subordinate menu
Version 2.00.1201. Copyright (C) 2009 American Megatrends, Inc.
P R E L I M I N A R Y
: Select Screen : Select Item
Enter: Select +/-: Change Opt. F1: General Help F2: Previous Values F3 Optimized Defaults F4: Save ESC: Exit
Page 4 ID 1042-8946, Rev. 3.0
CP3002/-RC/-RA uEFI BIOS Starting uEFI BIOS Setup

1.2 Navigation

The CP3002/CP3002-RC/CP3002-RA uEFI BIOS setup program uses a hot key-based navi­gation system. A hot key legend is located in the right frame on most setup screens.The follow­ing table provides information concerning the usage of these hot keys.
HOT KEY DESCRIPTION
<F1> The <F1> key is used to invoke the General Help window. <F2> The <F2> key is used to restore the previous values. <F3> The <F3> key is used to load the defaults. <F4> The <F4> key is used to save the current settings and exit the uEFI BIOS Setup.
 Left/Right The Left and Right <Arrow> keys are used to select a major Setup screen.
For example: Main Screen, Advanced Screen, Chipset Screen, etc.
 Up/Down The Up and Down <Arrow> keys are used to select a Setup function or a sub-screen. + - Plus/Minus The Plus and Minus <Arrow> keys are used to change the field value of a particular Setup
function, for example, system date and time.
<ESC> The <ESC> key is used to exit a menu or the uEFI BIOS Setup.
Pressing the <ESC> key in a sub-menu causes the next higher menu level to be displayed. When the <ESC> key is pressed in a major Setup menu, the uEFI BIOS Setup is terminated
without saving any changes made.
<Enter> The <Enter> key is used to execute a command or select a menu.
P R E L I M I N A R Y
ID 1042-8946, Rev. 3.0 Page 5
Starting uEFI BIOS Setup CP3002/-RC/-RA uEFI BIOS
This page has been intentionally left blank.
P R E L I M I N A R Y
Page 6 ID 1042-8946, Rev. 3.0
CP3002/-RC/-RA uEFI BIOS Main Setup
Chapter 1
2
Main Setup
ID 1042-8946, Rev. 3.0 Page 7
P R E L I M I N A R Y
Main Setup CP3002/-RC/-RA uEFI BIOS
This page has been intentionally left blank.
P R E L I M I N A R Y
Page 8 ID 1042-8946, Rev. 3.0
CP3002/-RC/-RA uEFI BIOS Main Setup

2. 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 func­tions 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.
Aptio Setup Utility - Copyright (C) 2009 American Megatrends, Inc.
Main Boot Security Save & Exit
BIOS Information
BIOS Vendor American Megatrends Core Version 4.6.3.5 Project Version B3201 13.00 x64 Build Date 02/18/2011 13:35:52
UnCore Information
IGD VBIOS Version 1930 GMCH Version 18 [C2 Stepping] Total Memory 4096 MB (DDR3: 1067 MHz)
Memory Slot0 2048 MB (DDR3) Memory Slot2 2048 MB (DDR3)
Trusted ComputingS5 RTC Wake SettingsSerial Port Console Redirection
System Language [English] System Date [Thu 03/24/2011]
System Time [11:47:30]
Access Level Administrator
Version 2.00.1201. Copyright (C) 2009 American Megatrends, Inc.
: Select Screen : Select Item
Enter: Select +/-: Change Opt. F1: General Help F2: Previous Values F3 Optimized Defaults F4: Save ESC: Exit

2.1 BIOS Information

This function provides display-only information concerning the uEFI BIOS. Information about the running uEFI BIOS version is reflected in the display-only function Project
Version (parameter “13.00” indicates Rev. 13).

2.2 UnCore Information

P R E L I M I N A R Y
This function provides display-only information concerning the NorthBridge (GMCH die of the Intel® Core™ i7 processor) features and the system memory.
ID 1042-8946, Rev. 3.0 Page 9
Main Setup CP3002/-RC/-RA uEFI BIOS

2.3 Trusted Computing

This screen provides functions for specifying the TPM configuration settings and TPM display­ing status information.
Aptio Setup Utility - Copyright (C) 2009 American Megatrends, Inc.
Main Boot Security Save & Exit
TPM Configuration
TPM Support [Disable]
Current TPM Status Information
TPM SUPPORT OFF
: Select Screen : Select Item
Enter: Select +/-: Change Opt. F1: General Help F2: Previous Values F3 Optimized Defaults F4: Save ESC: Exit
Version 2.00.1201. Copyright (C) 2009 American Megatrends, Inc.

2.3.1 TPM Configuration

2.3.1.1 TPM Support
This function is used to provide the Trusted Platform Module (TPM) functionality to the OS. Note: Trusted Platform Module support is available on request.
SETTING DESCRIPTION
P R E L I M I N A R Y
Disable Use this setting to disable the TPM support.
If this setting is used, the TPM is not present for the OS, regardless whether the function TPM State is enabled or not.
Enable Use this setting to enable the TPM support.
Default setting: Disable
Page 10 ID 1042-8946, Rev. 3.0
CP3002/-RC/-RA uEFI BIOS Main Setup

2.4 S5 RTC Wake Settings

This screen provides functions for specifying the S5 RTC Wake Settings.
Aptio Setup Utility - Copyright (C) 2009 American Megatrends, Inc.
Main Boot Security Save & Exit
Wake system with Fixed Time [Enabled]
Wake up hour 0 Wake up minute 0 Wake up second 0
Wake system with Dynamic Time [Disabled]
: Select Screen : Select Item
Enter: Select +/-: Change Opt. F1: General Help F2: Previous Values F3 Optimized Defaults F4: Save ESC: Exit
Version 2.00.1201. Copyright (C) 2009 American Megatrends, Inc.

2.4.1 S5 RTC Wake Settings

This function defines the RTC wake-up settings to allow the system to wake up from the S5 (soft off) state.

2.4.2 Wake System with Fixed Time

This function allows the system to wake up from S5 state at a specified time.
SETTING DESCRIPTION
Disabled Use this setting to disable Wake System with Fixed Time. Enabled Use this setting to enable Wake System with Fixed Time.
Default setting: Disabled
2.4.2.1 Wake-Up Hour, Wake-Up Minute, Wake-Up Second
This function is used to specify the hour (0-23), the minute (0-59) and the second (0-59) when the system is to wake up from S5 state.
Note: This function is available only when the function “W ake System with Fixed Time” is
set to Enabled.
P R E L I M I N A R Y

2.4.3 Wake System with Dynamic Time

This function is intended for debugging purposes only and is therefore locked.
ID 1042-8946, Rev. 3.0 Page 11
Main Setup CP3002/-RC/-RA uEFI BIOS

2.5 Serial Port Console Redirection

This screen provides information about functions for specifying the Serial Port Console Redi­rection configuration settings. Console redirection can be used to remotely operate system set­tings and the EFI console.
Aptio Setup Utility - Copyright (C) 2009 American Megatrends, Inc.
Main Boot Security Save & Exit
COM0
Console Redirection [Disabled]
Console Redirection Settings
COM1
Console Redirection [Disabled]
Console Redirection Settings
COM4
Console Redirection Port Is Disabled
Serial Port for Out-of-Band Management/ Windows Emergency Management Services (EMS)
Console Redirection [Disabled] Out-of-Band Mgmt Port [COM0]
Data Bits 8 Parity None Stop Bits 1 Terminal Type [VT-UTF8]
Version 2.00.1201. Copyright (C) 2009 American Megatrends, Inc.
: Select Screen : Select Item
Enter: Select +/-: Change Opt. F1: General Help F2: Previous Values F3 Optimized Defaults F4: Save ESC: Exit

2.5.1 COM0

On the CP3002 the COM0 port corresponds to the COMA port (RS-232) and is available either on the 8HP extension module or on the rear I/O.
P R E L I M I N A R Y
On the CP3002-RA/-RC the COM0 port corresponds to the COMA port (RS-232) and is avail­able only on the rear I/O.
2.5.1.1 Console Redirection
SETTING DESCRIPTION
Disabled Use this setting to disable console redirection for COM A (RS-232). Enabled Use this setting to enable console redirection for COM A (RS-232).
Default setting: Disabled
2.5.1.2 Console Redirection Settings
For information about this function, refer to Chapter 2.5.5 in this manual.
Page 12 ID 1042-8946, Rev. 3.0
CP3002/-RC/-RA uEFI BIOS Main Setup

2.5.2 COM1

The COM1 port corresponds to the COMB port (RS-422/RS- 232) and is available on the rear I/O.
2.5.2.1 Console Redirection
SETTING DESCRIPTION
Disabled Use this setting to disable console redirection for COM B (RS-422/RS-232). Enabled Use this setting to enable console redirection for COM B (RS-422/RS-232).
Default setting: Disabled
2.5.2.2 Console Redirection Settings
For information about this function, refer to Chapter 2.5.5 in this manual.

2.5.3 COM4

On the CP3002/CP3002-RC/CP3002-RA, the COM4 port is not available and is therefore disabled.

2.5.4 Serial Port for Out-of-Band Management/Windows Emergency Management Services (EMS)

The following functions control the presence and content of the ACPI serial port redirection ta­ble (SPCR). This table is mainly used by the Windows server variants to provide Windows Emergency Management Services (EMS). This functionality is totally independent from serial redirection of other console output.
2.5.4.1 Console Redirection
SETTING DESCRIPTION
Disabled Use this setting to prevent the system from adding the SPCR table to the ACPI tables. Enabled Use this setting to add the SPCR table to the ACPI tables. The OS can further use the infor-
mation provided for serial redirection services.
Default setting: Disabled
2.5.4.2 Out-of-Band Mgmt Port
This function is used to select the serial port intended for use with Out-of-Band Management. This functionality is independent from serial redirection of other console output.
SETTING DESCRIPTION
P R E L I M I N A R Y
COM0 Use this setting to specify that the serial port 0 is to be used with Out-of-Band Management. COM4 Use this setting to specify that a PCIe serial port is to be used with Out-of-Band Manage-
ment.
Default setting: COM0
ID 1042-8946, Rev. 3.0 Page 13
Main Setup CP3002/-RC/-RA uEFI BIOS
2.5.4.3 Data Bits
This is a display-only function providing information about the frame width for the Out-of-Band Management.
2.5.4.4 Parity
This is a display-only function providing information about the parity for Out-of-Band Manage­ment.
2.5.4.5 Stop Bits
This is a display-only function providing information about the number of stop bits for Out-of­Band Management.
2.5.4.6 Terminal Type
SETTING DESCRIPTION
VT100 Use one of these settings to select the terminal type for out-of-band management. VT100+ VT-UTF8 ANSI
Default setting: VT-UTF8
P R E L I M I N A R Y
Page 14 ID 1042-8946, Rev. 3.0
Loading...
+ 44 hidden pages