CP3002 / CP3002-RC / CP3002-RA uEFI BIOS Doc. ID: 1042-8946, Rev. 3.0 April 28, 2011 If it’s embedded, it’s Kontron.
Preface CP3002/-RC/-RA Revision History Publication Title: CP3002/-RC/-RA uEFI BIOS User Guide Doc. ID: 1042-8946 PRELIMINARY 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 8-Apr-2011 3.
CP3002/-RC/-RA uEFI BIOS Preface Table of Contents Revision History .........................................................................................................ii Imprint ........................................................................................................................ii Disclaimer ..................................................................................................................ii Table of Contents .........................................................
Preface 2.5.4.4 Parity ..........................................................................................14 2.5.4.5 Stop Bits .....................................................................................14 2.5.4.6 Terminal Type ............................................................................14 2.5.5 PRELIMINARY CP3002/-RC/-RA uEFI BIOS Console Redirection Settings .............................................................15 2.5.5.1 Terminal Type ...................
CP3002/-RC/-RA uEFI BIOS 4. Preface Security Setup .............................................................................27 4.1 Administrator Password ............................................................................. 28 4.2 User Password ........................................................................................... 28 4.3 HDD Security Configuration ....................................................................... 28 4.4 Remember the Password .........................
PRELIMINARY Preface 7. CP3002/-RC/-RA uEFI BIOS 6.3.1 Startup Scripting .................................................................................51 6.3.2 Create a Startup Script .......................................................................51 6.3.3 Examples of Startup Scripts ...............................................................51 6.3.3.1 Automatic Booting from USB Flash Drive ..................................51 6.3.3.
Starting uEFI BIOS Setup Chapter 1 Starting uEFI BIOS Setup ID 1042-8946, Rev. 3.
PRELIMINARY Starting uEFI BIOS Setup CP3002/-RC/-RA uEFI BIOS This page has been intentionally left blank. Page 2 ID 1042-8946, Rev. 3.
CP3002/-RC/-RA uEFI BIOS 1. Starting uEFI BIOS Setup 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 generation BIOS firmware based on the Unified Extensible Firmware Interface (uEFI) specification and the Intel® Platform Innovation Framework for EFI.
Starting uEFI BIOS Setup 1.1 CP3002/-RC/-RA 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.
CP3002/-RC/-RA uEFI BIOS 1.2 Starting uEFI BIOS Setup Navigation The CP3002/CP3002-RC/CP3002-RA 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.
PRELIMINARY Starting uEFI BIOS Setup CP3002/-RC/-RA uEFI BIOS This page has been intentionally left blank. Page 6 ID 1042-8946, Rev. 3.
Main Setup Chapter 21 Main Setup ID 1042-8946, Rev. 3.
PRELIMINARY Main Setup CP3002/-RC/-RA uEFI BIOS This page has been intentionally left blank. Page 8 ID 1042-8946, Rev. 3.
CP3002/-RC/-RA 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.
Main Setup 2.3 CP3002/-RC/-RA uEFI BIOS Trusted Computing This screen provides functions for specifying the TPM configuration settings and TPM displaying status information. Aptio Setup Utility - Copyright (C) 2009 American Megatrends, Inc. Ma in Bo ot Security TPM Configuration TPM Support S a ve & E x i t [Disable] PRELIMINARY Current TPM Status Information TPM SUPPORT OFF : Select Screen : Select Item Enter: +/-: F1: F2: F3 F4: Select Change Opt.
CP3002/-RC/-RA uEFI BIOS 2.4 Main Setup S5 RTC Wake Settings This screen provides functions for specifying the S5 RTC Wake Settings. Wake Wake Wake Wake Aptio Setup Utility - Copyright (C) 2009 American Megatrends, Inc. Boot S e c u r it y S a v e & E x it system with Fixed Time up hour up minute up second Wake system with Dynamic Time [Enabled] 0 0 0 [Disabled] : Select Screen : Select Item Enter: +/-: F1: F2: F3 F4: Select Change Opt.
Main Setup 2.5 CP3002/-RC/-RA 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 EFI console. Aptio Setup Utility - Copyright (C) 2009 American Megatrends, Inc.
CP3002/-RC/-RA uEFI BIOS 2.5.2 Main Setup 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 2.5.
Main Setup 2.5.4.3 CP3002/-RC/-RA uEFI BIOS 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 Management. 2.5.4.5 Stop Bits This is a display-only function providing information about the number of stop bits for Out-ofBand Management. PRELIMINARY 2.5.4.
CP3002/-RC/-RA uEFI BIOS 2.5.5 Main Setup Console Redirection Settings This screen provides information about functions for specifying the Console Redirection configuration settings for the serial port 0 and a PCIe serial port. Each serial port can be independently configured. Aptio Setup Utility - Copyright (C) 2009 American Megatrends, Inc.
Main Setup 2.5.5.3 CP3002/-RC/-RA 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.5.5.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.5.5.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.5.5.
CP3002/-RC/-RA uEFI BIOS 2.5.5.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 OSredirection. 80x25 Default setting: 80x24 2.
Main Setup 2.9 CP3002/-RC/-RA 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.
Boot Setup Chapter 31 Boot Setup ID 1042-8946, Rev. 3.
PRELIMINARY Boot Setup CP3002/-RC/-RA uEFI BIOS This page has been intentionally left blank. Page 20 ID 1042-8946, Rev. 3.
CP3002/-RC/-RA 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) 2009 American Megatrends, Inc. Boot S e c u r it y S a v e & E x it Boot Configuration Quiet Boot UEFI Boot Setup Prompt Timeout [Disabled] [Enabled] 2 Bootup NumLock State [On] CSM16 Module Version 07.
Boot Setup 3.1.2 CP3002/-RC/-RA uEFI BIOS uEFI Boot This function is used to enable or disable uEFI boot from disks. SETTING DESCRIPTION Disabled Use this setting to prevent the system from booting native uEFI-aware operating systems from disks. Enabled Use this setting to enable booting of native uEFI-aware operating systems from disks, if present, and in boot order. Default setting: Enabled PRELIMINARY 3.1.
CP3002/-RC/-RA uEFI BIOS 3.1.7 Boot Setup Option ROM Messages This function is used to control the messages of the loaded PCI option ROMs. SETTING DESCRIPTION Force BIOS Use this setting to force to a BIOS-compatible output. This will show the option ROM messages. Keep Current Use this setting to keep the current video mode. This will suppress option ROM messages. Option ROMs requiring interactive inputs may not work properly in this mode.
Boot Setup 3.2 Boot Option Priorities 3.2.1 Boot Option #1..2 CP3002/-RC/-RA uEFI BIOS These functions are used to form the boot order and are dynamically generated. They represent either a legacy BBS (BIOS Boot Specification) class of devices or a native EFI boot entry. Press Return on each option to select the BBS class / EFI boot entry desired. 3.2.
Security Setup Chapter 41 Security Setup ID 1042-8946, Rev. 3.
PRELIMINARY Security Setup CP3002/-RC/-RA uEFI BIOS This page has been intentionally left blank. Page 26 ID 1042-8946, Rev. 3.
CP3002/-RC/-RA 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) 2009 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.
Security Setup 4.1 CP3002/-RC/-RA 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.
Save & Exit Chapter 51 Save & Exit ID 1042-8946, Rev. 3.
PRELIMINARY Save & Exit CP3002/-RC/-RA uEFI BIOS This page has been intentionally left blank. Page 30 ID 1042-8946, Rev. 3.
CP3002/-RC/-RA 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) 2009 American Megatrends, Inc.
Save & Exit 5.4 CP3002/-RC/-RA 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.
The uEFI Shell Chapter 61 The uEFI Shell ID 1042-8946, Rev. 3.
PRELIMINARY The uEFI Shell CP3002/-RC/-RA uEFI BIOS This page has been intentionally left blank. Page 34 ID 1042-8946, Rev. 3.
CP3002/-RC/-RA 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.
The uEFI Shell 6.2 CP3002/-RC/-RA uEFI BIOS Kontron Shell Commands The Kontron uEFI implementation provides the following additional commands related to the specific HW features of the Kontron system: PRELIMINARY • • • • • • • • • • kboardconfig kboardinfo kboot kbootnsh kclearnvram kclsp kflash kmkramdisk kpassword kwdt The following tables provide information concerning these Kontron-specific commands.
CP3002/-RC/-RA 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.
The uEFI Shell CP3002/-RC/-RA uEFI BIOS kboardconfig (continued) PRELIMINARY SETTINGS: pxe: Select PXE boot network adapter disabled: No PXE boot available [all]: Try all Ethernet devices round robin for PXE boot eth_a: Try only Ethernet port A for PXE boot eth_b: Try only Ethernet port B for PXE boot eth_c: Try only Ethernet port C for PXE boot (CP3002-RC/-RA only) eth_d: Try only Ethernet port D for PXE boot (CP3002-RC/-RA only) Note: On the CP3002, both eth_a and eth_b ports are available either on
CP3002/-RC/-RA uEFI BIOS The uEFI Shell kboardconfig (continued) com_b: COM B port configuration rs232: com_b port signal level follows the RS-232 standard [rs422]: com_b port signal level follows the RS-422 standard Note: The serial port COM B is available only on the rear I/O. This option is present only on the CP3002-RC/-RA as the com_b port signal is fixed to RS-232 on the CP3002.
The uEFI Shell 6.2.2 CP3002/-RC/-RA 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.
CP3002/-RC/-RA 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: NorthBridge rev.: SouthBridge rev.: Microcode: CPU ID: CPU Branding: RIO Module: ID 1042-8946, Rev. 3.
The uEFI Shell 6.2.
CP3002/-RC/-RA uEFI BIOS The uEFI Shell kboot (continued) USAGE: Show all connected devices: COMMAND / RESPONSE: PRELIMINARY fs0:\> kboot ____BBS_TABLE____ 00002 network “IBA GE Slot 0100 v1300” 00003 network “IBA GE Slot 0101 v1300” 00004 network “IBA GE Slot 0200 v1300” 00005 network “IBA GE Slot 0201 v1300” 00002 usb-harddrive “SanDisk uSSD 5000 0.1” Device path: Acpi(PNP0A03,0)/Pci(1A|7)/Usb(1,0) 0001 usb-harddrive “KingstonDataTraveler 2.04.
The uEFI Shell 6.2.4 CP3002/-RC/-RA uEFI BIOS kbootnsh uEFI Shell Command kbootnsh FUNCTION: SYNTAX: Manage the startup script stored in the flash kbootnsh [-b][-?|-g |-p |-d] where: PRELIMINARY -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.
CP3002/-RC/-RA uEFI BIOS 6.2.5 The uEFI Shell 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”. 6.2.6 The kclearnvram command allows to clear the system NVRAM. Since all EFI settings are stored inside the NVRAM, the default settings are loaded afterwards.
The uEFI Shell 6.2.
CP3002/-RC/-RA uEFI BIOS 6.2.8 The uEFI Shell kmkramdisk uEFI Shell Command kmkramdisk FUNCTION: SYNTAX: Create RAMdisk drives kmkramdisk [-?|-s ] where: -? show help -s create a RAMdisk of given size in Megabytes with the mount point name 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.
The uEFI Shell 6.2.9 CP3002/-RC/-RA uEFI BIOS kpassword uEFI Shell Command kpassword FUNCTION: SYNTAX: Control EFI setup and shell passwords kpassword [-u|-s] Call without parameters to get current password status Parameters: -u -s Install or change user password Install or change superuser password PRELIMINARY Note: Old passwords must be verified if set. Entering an empty password disables the password.
CP3002/-RC/-RA uEFI BIOS 6.2.10 The uEFI Shell 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 DESCRIPTION: USAGE: The kwdt command allows to enable the Kontron onboard Watchdog with reset target before OS boot. This can be used to detect if the OS fails to boot and react by reset.
The uEFI Shell CP3002/-RC/-RA uEFI BIOS 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.
CP3002/-RC/-RA uEFI BIOS 6.3 uEFI Shell Scripting 6.3.1 Startup Scripting The uEFI Shell 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.
The uEFI Shell 6.3.3.4 CP3002/-RC/-RA uEFI BIOS Enable Watchdog and Control PXE Boot The uEFI Shell provides environment variables used to control the execution flow. PRELIMINARY The following sample start-up script shows two uEFI Shell environment variables, wdt_enable and pxe_first, used to control the boot process and the Watchdog. echo -off echo “Executing sample startup.nsh...
CP3002/-RC/-RA uEFI BIOS 6.3.3.5 The uEFI Shell 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.
PRELIMINARY The uEFI Shell CP3002/-RC/-RA uEFI BIOS This page has been intentionally left blank. Page 54 ID 1042-8946, Rev. 3.
Updating the uEFI BIOS Chapter 71 Updating the uEFI BIOS ID 1042-8946, Rev. 3.
PRELIMINARY Updating the uEFI BIOS CP3002/-RC/-RA uEFI BIOS This page has been intentionally left blank. Page 56 ID 1042-8946, Rev. 3.
CP3002/-RC/-RA 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 BIOS Redundancy Strategy The CP3002/CP3002-RC/CP3002-RA has two sets of uEFI flash banks to form a redundancy strategy.
PRELIMINARY Updating the uEFI BIOS CP3002/-RC/-RA uEFI BIOS This page has been intentionally left blank. Page 58 ID 1042-8946, Rev. 3.