Kontron CP3003-V uEFI BIOS User Manual

» User Guide «

CP3003-SA/CP3003-V

uEFI BIOS

Doc. ID: 1053-4014, Rev. 2.0

July 29, 2013

If it’s embedded, it’s Kontron.

D R A F T — F O R I N T E R N A L U S E O N L Y

Preface CP3003-SA/CP3003-V uEFI BIOS

Revision History

Publication Title:

Doc. ID: 1053-4014

Rev. Brief Description of Changes Date of Issue

1.0 Initial issue based on the uEFI BIOS version R11 29-Jul-2013

2.0 Added description for the CP3003-V based on the uEFI BIOS ver­sion R11

CP3003-SA/CP3003-V uEFI BIOS User Guide

29-Jul-2013

Imprint

Kontron Europe GmbH may be contacted via the following:

MAILING ADDRESS TELEPHONE AND E-MAIL

Kontron Europe GmbH +49 (0) 800-SALESKONTRON
Sudetenstraße 7 [e-mail]
D - 87600 Kaufbeuren Germany

For further information about other Kontron products, please visit our Internet web site:
www.kontron.com.

Disclaimer

Copyright © 2013 Kontron AG. All rights reserved. All data is for informatio n purposes only and
not guaranteed for legal purposes. Information has been carefully checked and is believed to

D R A F T — F O R I N T E R N A L U S E O N L Y

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.

Page ii ID 1053-4014, Rev. 2.0

CP3003-SA/CP3003-V 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 Memory Information .....................................................................................9

2.3 Trusted Computing ..................................................................................... 10

2.3.1 Configuration .....................................................................................10

2.3.1.1 TPM Support (CP3003-SA) ....................................................... 10

2.3.2 Current Status Information ................................................................. 10

2.4 CPU Configuration ......................................................................................11

2.4.1 CPU Configuration ..............................................................................11

2.4.2 Max Freq Ratio ...................................................................................11

2.5 Firmware Update Configuration .................................................................12

2.5.1 Me FW Image Re-Flash .....................................................................12

2.6 USB Configuration ..................................................................................... 13

2.6.1 USB Configuration ............................................................................. 13

2.6.1.1 USB Devices .............................................................................13

2.6.1.2 Legacy USB Support ................................................................. 13

2.6.1.3 USB3.0 Support ........................................................................14

2.6.1.4 XHCI Hand-Off ..........................................................................14

2.6.1.5 EHCI Hand-Off ..........................................................................14

2.6.2 USB Hardware Delays and Time-outs ............................................... 15

2.6.2.1 USB Transfer Timeout ...............................................................15

2.6.2.2 Device Reset Timeout ............................................................... 15

2.6.2.3 Device Power-up Delay ............................................................. 15

ID 1053-4014, Rev. 2.0 Page iii

Preface CP3003-SA/CP3003-V uEFI BIOS

2.7 Serial Port Console Redirection ..................................................................16

2.7.1 COM0 .................................................................................................16

2.7.1.1 Console Redirection ..................................................................16

2.7.1.2 Console Redirection Settings ....................................................16

2.7.2 COM1 .................................................................................................17

2.7.2.1 Console Redirection ..................................................................17

2.7.2.2 Console Redirection Settings ....................................................17

2.7.3 Serial Port for Out-of-Band Management/Windows EMS ..................20

2.7.3.1 Console Redirection ..................................................................20

2.7.3.2 Console Redirection Settings ....................................................20

2.8 System Language .......................................................................................22

2.9 System Date ...............................................................................................22

2.10 System Time ...............................................................................................22

2.11 Access Level ...............................................................................................22

3. Boot Setup ..................................................................................25

3.1 Boot Configuration ......................................................................................25

3.1.1 Setup Prompt Timeout .......................................................................25

3.1.2 Bootup NumLock State ......................................................................25

3.1.3 Quiet Boot ..........................................................................................26

3.1.4 Fast Boot ............................................................................................26

3.1.5 CSM16 Module Version .....................................................................26

3.1.6 GateA20 Active ..................................................................................26

3.1.7 Option ROM Messages ......................................................................26

3.1.8 Interrupt 19 Capture ...........................................................................27

3.1.9 CSM Support ......................................................................................27

3.2 Boot Option Priorities ..................................................................................27

3.2.1 Boot Option #1..2 ...............................................................................27

3.2.2 Hard Drive BBS Priorities ...................................................................27

4. Security Setup ............................................................................31

4.1 Administrator Password ..............................................................................32

4.2 User Password ...........................................................................................32

Page iv ID 1053-4014, Rev. 2.0

CP3003-SA/CP3003-V uEFI BIOS Preface

4.3 HDD Security Configuration ....................................................................... 32

4.4 Remember the Password ........................................................................... 32

5. Save & Exit ...................................................................................35

5.1 Save Changes and Exit .............................................................................. 35

5.2 Discard Changes and Exit .......................................................................... 35

5.3 Save Changes and Reset ..........................................................................35

5.4 Discard Changes and Reset ......................................................................36

5.5 Save Changes (Save Options) ................................................................... 36

5.6 Discard Changes (Save Options) ...............................................................36

5.7 Restore Defaults (Save Options) ................................................................ 36

5.8 Save as User Defaults (Save Options) .......................................................36

5.9 Restore User Defaults (Save Options) ....................................................... 36

5.10 Boot Override .............................................................................................36

6. The uEFI Shell ..............................................................................39

6.1 Introduction, Basic Operation ..................................................................... 39

6.1.1 Shell Startup ...................................................................................... 39

6.2 Kontron-Specific uEFI Shell Commands .................................................... 40

6.2.1 kBiosRevision uEFI Shell Command .................................................41

6.2.2 kboardconfig uEFI Shell Command ................................................... 42

6.2.3 kboardinfo uEFI Shell Command .......................................................49

6.2.4 kboot uEFI Shell Command ...............................................................51

6.2.5 kbootnsh uEFI Shell Command .........................................................52

6.2.6 kclearnvram uEFI Shell Command .................................................... 53

6.2.7 kflash uEFI Shell Command .............................................................. 54

6.2.8 kmkramdisk uEFI Shell Command .................................................... 55

6.2.9 kpassword uEFI Shell Command ......................................................56

6.2.10 kresetconfig uEFI Shell Command ................................................... 57

6.2.11 kSettings uEFI Shell Command ......................................................... 58

6.2.12 kwdt uEFI Shell Command ................................................................ 59

6.3 uEFI Shell Scripting .................................................................................... 60

6.3.1 Startup Scripting ................................................................................ 60

ID 1053-4014, Rev. 2.0 Page v

Preface CP3003-SA/CP3003-V uEFI BIOS

6.3.2 Create a Startup Script .......................................................................60

6.3.3 Examples of Startup Scripts ...............................................................60

6.3.3.1 Automatic Booting from USB Flash Drive ..................................60

6.3.3.2 Execute Shell Script on Other Harddrive ...................................61

6.3.3.3 Enable Watchdog and Control PXE Boot ..................................61

6.3.3.4 Handling the Startup Script in the Flash Bank ...........................62

7. Updating the uEFI BIOS ............................................................. 65

7.1 uEFI BIOS Fail-Over Mechanism ...............................................................65

7.2 Updating Procedure ....................................................................................65

7.3 uEFI BIOS Recovery ..................................................................................65

7.4 Determining the Active Flash ......................................................................65

Page vi ID 1053-4014, Rev. 2.0

CP3003-SA/CP3003-V uEFI BIOS Starting uEFI BIOS Setup

Chapter 1

1

Starting uEFI BIOS Setup

ID 1053-4014, Rev. 2.0 Page 1

D R A F T — F O R I N T E R N A L U S E O N L Y

Starting uEFI BIOS Setup CP3003-SA/CP3003-V uEFI BIOS

This page has been intentionally left blank.

D R A F T — F O R I N T E R N A L U S E O N L Y

Page 2 ID 1053-4014, Rev. 2.0

CP3003-SA/CP3003-V uEFI BIOS Starting uEFI BIOS Setup

Enter Password

1. Starting uEFI BIOS Setup

The CP3003-SA/CP3003-V is provided with a Kontron-customized, pre-installed and config­ured 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 In­tel® Platform Innovation Framework for EFI. This uEFI BIOS provides a variety of new and en­hanced functions specifically tailored to the hardware features of the CP3003-SA/CP3003-V.

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 <DEL> or <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 5.

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.

D R A F T — F O R I N T E R N A L U S E O N L Y

ID 1053-4014, Rev. 2.0 Page 3

Starting uEFI BIOS Setup CP3003-SA/CP3003-V 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) 2011 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

: Select Screen
: Select Item

Enter: Select
+/-: Change Opt.
F1: General Help
F2: Previous Values
F3 Optimized Defaults
F4: Save & Exit
ESC: Exit

Version 2.14.1219. Copyright (C) 2011 American Megatrends, Inc.

D R A F T — F O R I N T E R N A L U S E O N L Y

Page 4 ID 1053-4014, Rev. 2.0

CP3003-SA/CP3003-V uEFI BIOS Starting uEFI BIOS Setup

1.2 Navigation

The CP3003-SA/CP3003-V uEFI BIOS setup program uses a hot key-based navigation sys­tem. 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

<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.

 Right/Left The Right and Left <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.

ID 1053-4014, Rev. 2.0 Page 5

D R A F T — F O R I N T E R N A L U S E O N L Y

Starting uEFI BIOS Setup CP3003-SA/CP3003-V uEFI BIOS

This page has been intentionally left blank.

D R A F T — F O R I N T E R N A L U S E O N L Y

Page 6 ID 1053-4014, Rev. 2.0

CP3003-SA/CP3003-V uEFI BIOS Main Setup

Chapter 1

2

Main Setup

ID 1053-4014, Rev. 2.0 Page 7

D R A F T — F O R I N T E R N A L U S E O N L Y

Main Setup CP3003-SA/CP3003-V uEFI BIOS

This page has been intentionally left blank.

D R A F T — F O R I N T E R N A L U S E O N L Y

Page 8 ID 1053-4014, Rev. 2.0

CP3003-SA/CP3003-V 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) 2011 American Megatrends, Inc.

Main Boot Security Save & Exit

BIOS Information

BIOS Vendor American Megatrends
Core Version 4.6.5.1
Compliancy UEFI 2.3; PI 1.2
Project Version B3E01 11.00 x64
Build Date and Time 11/05/2012 15:34:19

Memory Information

Memory Frequency 1600 Mhz
Total Memory 4096 MB (DDR3)

 Trusted Computing
 CPU Configuration
 Firmware Update Configuration
 USB Configuration
 Serial Port Console Redirection

System Language [English]
System Date [Thu 11/22/2012]

System Time [14:15:37]

Access Level Administrator

Version 2.14.1219. Copyright (C) 2011 American Megatrends, Inc.

: Select Screen
: Select Item

Enter: Select
+/-: Change Opt.
F1: General Help
F2: Previous Values
F3 Optimized Defaults
F4: Save & Exit
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 “11.00” indicates Rev. 11).

2.2 Memory Information

This function provides display-only information concerning the system memory.

ID 1053-4014, Rev. 2.0 Page 9

D R A F T — F O R I N T E R N A L U S E O N L Y

Main Setup CP3003-SA/CP3003-V 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) 2011 American Megatrends, Inc.

Main Boot Security Save & Exit

Configuration

TPM Support [Disable]

Current Status Information
NO Security Device Found

: Select Screen
: Select Item

Enter: Select
+/-: Change Opt.
F1: General Help
F2: Previous Values
F3 Optimized Defaults
F4: Save ESC: Exit

Version 2.14.1219. Copyright (C) 2011 American Megatrends, Inc.

2.3.1 Configuration

2.3.1.1 TPM Support (CP3003-SA)

This function is used to provide the Trusted Platform Module (TPM) functionality to the OS.

SETTING DESCRIPTION

Disable Use this setting to disable TPM support.

If this setting is used, TPM is not present for the OS, regardless whether the function TPM
State is enabled or not.

Enable Use this setting to enable TPM support.

Default setting: Disable

2.3.2 Current Status Information

This is a display-only function which provides status information.

D R A F T — F O R I N T E R N A L U S E O N L Y

Page 10 ID 1053-4014, Rev. 2.0

CP3003-SA/CP3003-V uEFI BIOS Main Setup

2.4 CPU Configuration

This screen provides information concerning the CPU operating frequencies and the ability to
set the frequency ratio.

Aptio Setup Utility - Copyright (C) 2011 American Megatrends, Inc.

Main Boot Security Save & Exit

CPU Configuration

Inter (R) Core(TM) i7-3517UE CPU @ 1.70GHz
Max CPU Speed 1700 MHz
Min CPU Speed 800 MHz
CPU Speed 1600 MHz

Max Freq Ratio 255

: Select Screen
: Select Item

Enter: Select
+/-: Change Opt.
F1: General Help
F2: Previous Values
F3 Optimized Defaults
F4: Save & Exit
ESC: Exit

Version 2.14.1219. Copyright (C) 2011 American Megatrends, Inc.

2.4.1 CPU Configuration

This is a display-only function indicating general information about the installed CPU.

2.4.2 Max Freq Ratio

This function is used to permit the CPU frequency to be adjusted so as to make a reduction in
power consumption possible when higher performance is not required.

To ensure that the maximum desired frequency is not exceeded, the CPU turbo mode must be
disabled using the uEFI shell command:

“kboardconfig CpuTurbo disabled”

D R A F T — F O R I N T E R N A L U S E O N L Y

ID 1053-4014, Rev. 2.0 Page 11

Main Setup CP3003-SA/CP3003-V uEFI BIOS

2.5 Firmware Update Configuration

This screen provides functions for specifying the firmware update configuration settings.

Aptio Setup Utility - Copyright (C) 2011 American Megatrends, Inc.

Main Boot Security Save & Exit

Me FW Image Re-Flash [Disabled]

: Select Screen
: Select Item

Enter: Select
+/-: Change Opt.
F1: General Help
F2: Previous Values
F3 Optimized Defaults
F4: Save & Exit
ESC: Exit

Version 2.14.1219. Copyright (C) 2011 American Megatrends, Inc.

2.5.1 Me FW Image Re-Flash

This function is used to enable or disable Intel® Management Engine (ME) firmware re-flashing.

SETTING DESCRIPTION

Disable Use this setting to disable ME firmware re-flashing.
Enable Use this setting to enable ME firmware re-flashing.

Default setting: Disable

D R A F T — F O R I N T E R N A L U S E O N L Y

Page 12 ID 1053-4014, Rev. 2.0

CP3003-SA/CP3003-V uEFI BIOS Main Setup

2.6 USB Configuration

This screen provides information about support for USB devices as well as functions for spec­ifying the USB configuration settings.

Aptio Setup Utility - Copyright (C) 2011 American Megatrends, Inc.

Main Boot Security Save & Exit

USB Configuration
USB Devices:

1 Keyboard, 1 Mouse, 4 Hubs

Legacy USB Support [Enabled]
USB3.0 Support [Enabled]
XHCI Hand-Off [Enabled]
EHCI Hand-Off [Disabled]

: Select Screen

USB hardware delays and time-outs:

USB transfer time-out [20 sec]
Device reset time-out: [20 sec]
Device power-up delay: [Auto]

: Select Item

Enter: Select
+/-: Change Opt.
F1: General Help
F2: Previous Values
F3 Optimized Defaults
F4: Save & Exit
ESC: Exit

Version 2.14.1219. Copyright (C) 2011 American Megatrends, Inc.

2.6.1 USB Configuration

2.6.1.1 USB Devices

This is a display-only function providing general information about the USB devices detected.

2.6.1.2 Legacy USB Support

This function is required for booting from USB devices and for operating systems which do not
support USB themselves (mainly DOS and some BootLoaders).

SETTING DESCRIPTION

Disabled Use this setting to disable legacy USB support.
Enabled Use this setting to enable legacy USB support.
Auto Use this setting to enable legacy USB support if there are USB devices present.

Default setting: Enabled

D R A F T — F O R I N T E R N A L U S E O N L Y

ID 1053-4014, Rev. 2.0 Page 13

Main Setup CP3003-SA/CP3003-V uEFI BIOS

2.6.1.3 USB3.0 Support

This function is used to enable USB3.0 support.

SETTING DESCRIPTION

Disabled Use this setting to disable USB3.0 support.
Enabled Use this setting to enable USB3.0 support.

Default setting: Enabled

2.6.1.4 XHCI Hand-Off

This function is used to enable a workaround for operating systems without XHCI Hand-Off
support. The XHCI ownership change should be claimed by the XHCI driver.

SETTING DESCRIPTION

Disabled Use this setting to disable XHCI Hand-Off support.
Enabled Use this setting to enable XHCI Hand-Off support.

Default setting: Enabled

2.6.1.5 EHCI Hand-Off

This function is used to enable a workaround for operating systems without EHCI Hand-Off
support. The EHCI ownership change should be claimed by the EHCI driver.

SETTING DESCRIPTION

Disabled Use this setting to disable EHCI Hand-Off support.
Enabled Use this setting to enable EHCI Hand-Off support.

Default setting: Disabled

D R A F T — F O R I N T E R N A L U S E O N L Y

Page 14 ID 1053-4014, Rev. 2.0

CP3003-SA/CP3003-V uEFI BIOS Main Setup

2.6.2 USB Hardware Delays and Time-outs

2.6.2.1 USB Transfer Timeout

This function selects the timeout in seconds that the USB core will wait for Control, Bulk, and
Interrupt transfers.

SETTING DESCRIPTION

01 sec
05 sec

10 sec
20 sec

Use one of these settings to specify how long the USB core is to wait for Control, Bulk, and
Interrupt transfers.

Default setting: 20 sec

2.6.2.2 Device Reset Timeout

This function selects the timeout in seconds that the POST will wait for a USB mass storage
device to become ready after start unit command.

SETTING DESCRIPTION

10 sec
20 sec
30 sec
40 sec

Use one of these settings to specify how long the POST will wait for a USB mass storage
device to become ready after the start unit command.

Default setting: 20 sec

2.6.2.3 Device Power-up Delay

This function determines the maximum time the device will take before it properly reports itself
to the Host Controller. “Auto” uses a default value: for a Root port it is 100 ms, for a Hub port
the delay is taken from Hub descriptor.

If the “Manual” option is chosen, the device power up delay in seconds field will be enabled to
accept a delay ranging from 1 to 40 seconds.

SETTING DESCRIPTION

Auto Use this setting to specify a default delay time for a Root or Hub port.

(root port = 100ms; hub port = value in hub descriptor)

Manual Use this setting to specify a delay time from 1 to 40 seconds.

(contents of seconds field)

Default setting: Auto

ID 1053-4014, Rev. 2.0 Page 15

D R A F T — F O R I N T E R N A L U S E O N L Y

Main Setup CP3003-SA/CP3003-V uEFI BIOS

2.7 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 uEFI console.

Aptio Setup Utility - Copyright (C) 2011 American Megatrends, Inc.

Main Boot Security Save & Exit

COM0

Console Redirection [Disabled]

 Console Redirection Settings

COM1

Console Redirection [Disabled]

 Console Redirection Settings

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

Console Redirection [Disabled]

Console Redirection Settings

: Select Screen
: Select Item

Enter: Select
+/-: Change Opt.
F1: General Help
F2: Previous Values
F3 Optimized Defaults
F4: Save & Exit
ESC: Exit

Version 2.14.1219. Copyright (C) 2011 American Megatrends, Inc.

2.7.1 COM0

The COM0 port (serial port 0) corresponds to the COMA port (RS-232) and is available either
on the front panel of the 8HP CP3003-SA/CP3003-V equipped with a CP3003-HDD extension
module or on the rear I/O.

2.7.1.1 Console Redirection

SETTING DESCRIPTION

Disabled Use this setting to disable console redirection for COMA (RS-232).
Enabled Use this setting to enable console redirection for COMA (RS-232).

Default setting: Disabled

2.7.1.2 Console Redirection Settings

D R A F T — F O R I N T E R N A L U S E O N L Y

For information about this function, refer to Chapter 2.7.2.2 in this manual.

Page 16 ID 1053-4014, Rev. 2.0