CP3003-SA/CP3003-V uEFI BIOS Doc. ID: 1053-4014, Rev. 2.0 July 29, 2013 If it’s embedded, it’s Kontron.
Preface CP3003-SA/CP3003-V uEFI BIOS Revision History DRAFT — FOR INTERNAL USE ONLY Publication Title: CP3003-SA/CP3003-V uEFI BIOS User Guide 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.
CP3003-SA/CP3003-V uEFI BIOS Preface Table of Contents Revision History .........................................................................................................ii Imprint ........................................................................................................................ii Disclaimer ..................................................................................................................ii Table of Contents .....................................................
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 ..................................................
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 ......................
Preface 7. 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.
Starting uEFI BIOS Setup Chapter 1 Starting uEFI BIOS Setup ID 1053-4014, Rev. 2.
DRAFT — FOR INTERNAL USE ONLY Starting uEFI BIOS Setup CP3003-SA/CP3003-V uEFI BIOS This page has been intentionally left blank. Page 2 ID 1053-4014, Rev. 2.
CP3003-SA/CP3003-V uEFI BIOS Starting uEFI BIOS Setup The CP3003-SA/CP3003-V 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. This uEFI BIOS provides a variety of new and enhanced functions specifically tailored to the hardware features of the CP3003-SA/CP3003-V.
Starting uEFI BIOS Setup 1.1 CP3003-SA/CP3003-V uEFI BIOS Main Setup Menu DRAFT — FOR INTERNAL USE ONLY 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.
CP3003-SA/CP3003-V uEFI BIOS 1.2 Starting uEFI BIOS Setup Navigation 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. The key is used to save the current settings and exit the uEFI BIOS Setup. Right/Left The Right and Left keys are used to select a major Setup screen. For example: Main Screen, Advanced Screen, Chipset Screen, etc.
DRAFT — FOR INTERNAL USE ONLY Starting uEFI BIOS Setup CP3003-SA/CP3003-V uEFI BIOS This page has been intentionally left blank. Page 6 ID 1053-4014, Rev. 2.
Main Setup Chapter 21 Main Setup ID 1053-4014, Rev. 2.
DRAFT — FOR INTERNAL USE ONLY Main Setup CP3003-SA/CP3003-V uEFI BIOS This page has been intentionally left blank. Page 8 ID 1053-4014, Rev. 2.
CP3003-SA/CP3003-V uEFI BIOS 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 CP3003-SA/CP3003-V uEFI BIOS Trusted Computing DRAFT — FOR INTERNAL USE ONLY This screen provides functions for specifying the TPM configuration settings and TPM displaying status information. A p t i o S e t u p U ti l i t y - C o p y r i g h t ( C ) 2 0 11 A m e r i c a n M e g a t r e n d s , I n c .
CP3003-SA/CP3003-V uEFI BIOS 2.4 Main Setup CPU Configuration A p t i o S e t u p U t i l i t y - C o p y r i g h t ( C ) 2 0 11 A m e r i c a n M e g a t r e n d s , I n c . Main Boot S e c u r it y S a v e & E x it 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: +/-: F1: F2: F3 F4: ESC: Select Change Opt.
Main Setup 2.5 CP3003-SA/CP3003-V uEFI BIOS Firmware Update Configuration DRAFT — FOR INTERNAL USE ONLY This screen provides functions for specifying the firmware update configuration settings. Ma in A p t i o S e t u p U ti l i t y - C o p y r i g h t ( C ) 2 0 11 A m e r i c a n M e g a t r e n d s , I n c . Bo ot S e c u r i t y S a ve & E x i t Me FW Image Re-Flash [Disabled] : Select Screen : Select Item Enter: +/-: F1: F2: F3 F4: ESC: Select Change Opt.
CP3003-SA/CP3003-V uEFI BIOS 2.6 Main Setup USB Configuration A p t i o S e t u p U t i l i t y - C o p y r i g h t ( C ) 2 0 11 A m e r i c a n M e g a t r e n d s , I n c . Main Boot S e c u r it y S a v e & E x it USB Configuration USB Devices: 1 Keyboard, 1 Mouse, 4 Hubs Legacy USB Support USB3.
Main Setup 2.6.1.3 CP3003-SA/CP3003-V uEFI BIOS USB3.0 Support DRAFT — FOR INTERNAL USE ONLY 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.
2.6.2 USB Hardware Delays and Time-outs 2.6.2.1 USB Transfer Timeout Main Setup This function selects the timeout in seconds that the USB core will wait for Control, Bulk, and Interrupt transfers. SETTING DESCRIPTION 01 sec Use one of these settings to specify how long the USB core is to wait for Control, Bulk, and Interrupt transfers. 05 sec 10 sec 20 sec Default setting: 20 sec 2.6.2.
Main Setup 2.7 CP3003-SA/CP3003-V uEFI BIOS Serial Port Console Redirection DRAFT — FOR INTERNAL USE ONLY 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. A p t i o S e t u p U ti l i t y - C o p y r i g h t ( C ) 2 0 11 A m e r i c a n M e g a t r e n d s , I n c .
CP3003-SA/CP3003-V uEFI BIOS 2.7.2 Main Setup COM1 2.7.2.1 Console Redirection SETTING DESCRIPTION Disabled Use this setting to disable console redirection for COMB (RS-232). Enabled Use this setting to enable console redirection for COMB (RS-232). Default setting: Disabled 2.7.2.2 Console Redirection Settings This screen provides information about functions for specifying the Console Redirection configuration settings for the serial port 0 (COM0) and serial port 1 (COM1).
Main Setup CP3003-SA/CP3003-V uEFI BIOS DRAFT — FOR INTERNAL USE ONLY 2.7.2.2.1 Terminal Type SETTING DESCRIPTION VT100 Use one of these settings to select the terminal type to be emulated. VT100+ VT-UTF8 ANSI Default setting: ANSI 2.7.2.2.2 Bits per second SETTING DESCRIPTION 9600 Use one of these settings to select the baud rate of the serial port. 19200 38400 57600 115200 Default setting: 115200 2.7.2.2.
CP3003-SA/CP3003-V uEFI BIOS Main Setup SETTING DESCRIPTION None Use one of these settings to specify the type of flow control to be used for this serial port. Hardware RTS/CTS Default setting: None 2.7.2.2.7 VT-UTF8 Combo Key Support Use this function to enable or disable VT-UTF8 Combination Key Support for ANSI/ VT100 terminals. SETTING DESCRIPTION Disabled Use this setting the disable combination key support. Enabled Use this setting the enable combination key support.
Main Setup DRAFT — FOR INTERNAL USE ONLY 2.7.3 CP3003-SA/CP3003-V uEFI BIOS 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 table (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.7.3.
CP3003-SA/CP3003-V uEFI BIOS Main Setup 2.7.3.2.1 Out-of-Band Mgmt Port This function is used to select the serial port intended for use with Out-of-Band Management. This function is available only when the respective serial port is enabled. SETTING DESCRIPTION COM0 Use this setting to specify that the serial port 0 is to be used with Out-of-Band Management COM1 Use this setting to specify that the serial port 1 is to be used with Out-of-Band Management Default setting: COM0 2.7.3.2.
Main Setup CP3003-SA/CP3003-V uEFI BIOS 2.7.3.2.6 Parity DRAFT — FOR INTERNAL USE ONLY This is a display-only function providing information about the parity for Out-of-Band Management. 2.7.3.2.7 Stop Bits This is a display-only function providing information about the number of stop bits for Out-ofBand Management. 2.8 System Language SETTING DESCRIPTION English Use this function to select the system language. Currently, only English is supported. 2.
Boot Setup Chapter 31 Boot Setup ID 1053-4014, Rev. 2.
DRAFT — FOR INTERNAL USE ONLY Boot Setup CP3003-SA/CP3003-V uEFI BIOS This page has been intentionally left blank. Page 24 ID 1053-4014, Rev. 2.
CP3003-SA/CP3003-V uEFI BIOS 3. Boot Setup Boot Setup A p t i o S e t u p U t i l i t y - C o p y r i g h t ( C ) 2 0 11 A m e r i c a n M e g a t r e n d s , I n c . Main 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 Fast Boot [Disabled] [Disabled] CSM16 Module Version 07.
Boot Setup 3.1.3 CP3003-SA/CP3003-V uEFI BIOS Quiet Boot DRAFT — FOR INTERNAL USE ONLY This function is used to display either POST output messages or a splash screen during boot-up. SETTING DESCRIPTION Disabled Use this setting to display POST output messages during boot-up. Enabled Use this setting to display a splash screen during boot-up. Default setting: Disabled 3.1.
CP3003-SA/CP3003-V uEFI BIOS 3.1.8 Boot Setup Interrupt 19 Capture 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. Default setting: Enabled 3.1.9 CSM Support This function is used to enable or disable CSM support. SETTING DESCRIPTION Disabled Use this setting to disable CSM support. Enabled Use this setting to enable CSM support.
DRAFT — FOR INTERNAL USE ONLY Boot Setup CP3003-SA/CP3003-V uEFI BIOS This page has been intentionally left blank. Page 28 ID 1053-4014, Rev. 2.
CP3003-SA/CP3003-V uEFI BIOS Security Setup Chapter 41 Security Setup ID 1053-4014, Rev. 2.
Security Setup CP3003-SA/CP3003-V uEFI BIOS This page has been intentionally left blank. Page 30 ID 1053-4014, Rev. 2.
CP3003-SA/CP3003-V 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. A p t i o S e t u p U t i l i t y - C o p y r i g h t ( C ) 2 0 11 A m e r i c a n M e g a t r e n d s , I n c .
Security Setup 4.1 CP3003-SA/CP3003-V 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 This function is used to set, change or delete the User password.
Save & Exit Chapter 51 Save & Exit ID 1053-4014, Rev. 2.
DRAFT — FOR INTERNAL USE ONLY Save & Exit CP3003-SA/CP3003-V uEFI BIOS This page has been intentionally left blank. Page 34 ID 1053-4014, Rev. 2.
CP3003-SA/CP3003-V uEFI BIOS 5. Save & Exit Save & Exit A p t i o S e t u p U t i l i t y - C o p y r i g h t ( C ) 2 0 11 A m e r i c a n M e g a t r e n d s , I n c .
Save & Exit 5.4 CP3003-SA/CP3003-V uEFI BIOS Discard Changes and Reset DRAFT — FOR INTERNAL USE ONLY 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) 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.
The uEFI Shell Chapter 61 The uEFI Shell ID 1053-4014, Rev. 2.
DRAFT — FOR INTERNAL USE ONLY The uEFI Shell CP3003-SA/CP3003-V uEFI BIOS This page has been intentionally left blank. Page 38 ID 1053-4014, Rev. 2.
CP3003-SA/CP3003-V uEFI BIOS 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.org) under the “Documents and Files” section.
The uEFI Shell 6.2 CP3003-SA/CP3003-V uEFI BIOS Kontron-Specific uEFI Shell Commands DRAFT — FOR INTERNAL USE ONLY The Kontron uEFI implementation provides the following additional commands related to the specific HW features of the Kontron system: • • • • • • • • • • • • kBiosRevision kboardconfig kboardinfo kboot kbootnsh kclearnvram kflash kmkramdisk kpassword kresetconfig kSettings kwdt The following tables provide information concerning these Kontron-specific commands.
CP3003-SA/CP3003-V uEFI BIOS 6.2.
The uEFI Shell 6.2.
CP3003-SA/CP3003-V uEFI BIOS The uEFI Shell kboardconfig (continued) USAGE: Command: kboardconfig DRAFT — FOR INTERNAL USE ONLY Shows all options and their current parameter setting.
The uEFI Shell CP3003-SA/CP3003-V uEFI BIOS kboardconfig (continued) DRAFT — FOR INTERNAL USE ONLY USAGE: (continued) Command: kboardconfig -? Shows HELP information for the kboardconfig command.
CP3003-SA/CP3003-V uEFI BIOS The uEFI Shell kboardconfig (continued) Command: kboardconfig
The uEFI Shell CP3003-SA/CP3003-V uEFI BIOS kboardconfig (continued) DRAFT — FOR INTERNAL USE ONLY OPTIONS: (continued) Sata0Speed Indicates maximum speed supported by SATA port 0 (SATA cable connector J3 on the CP3003-SA/ CP3003-V main board) Available parameters for SATA0Speed and SATA1Speed: noLimit, gen1 (SATA 1.5 Gb/s), gen2 (SATA 3.0 Gb/s), gen3 (SATA 6.
CP3003-SA/CP3003-V uEFI BIOS The uEFI Shell OPTIONS: (continued) WrProtSata: Used to select onboard SATA flash write protection If 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. Note: Please contact Kontron before using this function.
The uEFI Shell CP3003-SA/CP3003-V uEFI BIOS kboardconfig (continued) DRAFT — FOR INTERNAL USE ONLY OPTIONS: (continued) GbeA Used to select the routing of the GbeA port GbeB Used to select the routing of the GbeB port ComA Used to select the routing of the serial port 0 Note: This option is only valid for CP3003-SA/ CP3003-V rear /O versions.
CP3003-SA/CP3003-V uEFI BIOS 6.2.3 The uEFI Shell kboardinfo uEFI Shell Command kboardinfo 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 EXAMPLE: Shell> kboardinfo KOMaOEMF rev.: Board ID: Hardware rev.: Logic rev.
The uEFI Shell CP3003-SA/CP3003-V uEFI BIOS kboardinfo (continued) DRAFT — FOR INTERNAL USE ONLY USAGE: (continued) 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.
CP3003-SA/CP3003-V uEFI BIOS 6.2.
The uEFI Shell CP3003-SA/CP3003-V uEFI BIOS kboot DRAFT — FOR INTERNAL USE ONLY USAGE: (continued) Boot from device containing the string "SanDisk": Shell> kboot -n SanDisk Boot from first device found that is of type harddrive: Shell> kboot -t harddrive Boot from device using the path to the device: Shell> kboot -p "PciRoot(0x0)/Pci(0x1f,0x2/Sata(0x1,0x0)" 6.2.
CP3003-SA/CP3003-V uEFI BIOS 6.2.6 The uEFI Shell kclearnvram uEFI Shell Command kclearnvram SYNTAX: Clear the NVRAM to restore the system’s default settings kclearnvram [-?] [-q] where: -? -q DESCRIPTION: Show online help Silent mode operation (for use of this command in shell scripts) Invoking the kclearnvram command clears the system NVRAM. Since all uEFI settings are stored inside the NVRAM, the default settings are loaded afterwards.
The uEFI Shell 6.2.
CP3003-SA/CP3003-V uEFI BIOS The uEFI Shell kflash (continued) Copy the currently running uEFI BIOS into the inactive SPI boot flash: COMMAND / RESPONSE EXAMPLE: Shell> kflash -c Note: Using this function will overwrite the inactive SPI boot flash. Failures during the process will make the inactive SPI boot flash invalid. In such cases, it will be necessary to execute the function again until the process completes successfully. 6.2.
The uEFI Shell 6.2.
CP3003-SA/CP3003-V uEFI BIOS 6.2.10 The uEFI Shell kresetconfig uEFI Shell Command 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.
The uEFI Shell 6.2.11 CP3003-SA/CP3003-V uEFI BIOS kSettings uEFI Shell Command kSettings DRAFT — FOR INTERNAL USE ONLY FUNCTION: SYNTAX: Verify the validity of the setup settings kSettings [-?] [[-s] [-c] ] where: -? show help -s Save current setup settings to “file” -c Compare current setup settings to “file” DESCRIPTION: “file” to be used for saving or comparison The kSettings command is used to create a binary file of the current setup settings.
CP3003-SA/CP3003-V uEFI BIOS 6.2.12 The uEFI Shell kwdt uEFI Shell Command kwdt SYNTAX: Configure the Kontron onboard Watchdog kwdt [-?] [-t ] where: -? Show help Call kwdt -? to obtain a list of time index values and related times -t DESCRIPTION: USAGE: Configure the Watchdog with the time related to timeindex and activate it with reset routing The kwdt command allows to enable the Kontron onboard Watchdog with reset target before OS boot.
The uEFI Shell CP3003-SA/CP3003-V uEFI BIOS kwdt (continued) DRAFT — FOR INTERNAL USE ONLY USAGE: (continued) Display Watchdog configuration: COMMAND / RESPONSE EXAMPLE: Shell> kwdt Kontron Board Watchdog Configuration: Watchdog Configuration Register (0x28C): 6.3 uEFI Shell Scripting 6.3.1 Startup Scripting 0x00 If the ESC key is not pressed and the timeout is run out, the uEFI Shell tries to execute some startup scripts automatically.
CP3003-SA/CP3003-V uEFI BIOS 6.3.3.2 The uEFI Shell Execute Shell Script on Other Harddrive fs0: bootme.nsh 6.3.3.3 Enable Watchdog and Control PXE Boot The uEFI Shell provides environment variables used to control the execution flow. 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...
The uEFI Shell 6.3.3.4 CP3003-SA/CP3003-V 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: DRAFT — FOR INTERNAL USE ONLY 1. Press during power-up to log into the uEFI Shell. 2. Create a RAM disk and set the proper working directory as shown below: Shell> kmkramdisk -s 3 myramdisk Shell> myramdisk: 3.
Updating the uEFI BIOS Chapter 71 Updating the uEFI BIOS ID 1053-4014, Rev. 2.
DRAFT — FOR INTERNAL USE ONLY Updating the uEFI BIOS CP3003-SA/CP3003-V uEFI BIOS This page has been intentionally left blank. Page 64 ID 1053-4014, Rev. 2.
CP3003-SA/CP3003-V uEFI BIOS 7. Updating the uEFI BIOS Updating the uEFI BIOS 7.1 uEFI BIOS Fail-Over Mechanism The CP3003-SA/CP3003-V has two SPI boot flashes programmed with the uEFI BIOS, a standard SPI boot flash and a recovery SPI boot flash. The basic idea behind that is to always have at least one working uEFI BIOS flash available regardless if there have been any flashing errors or not. 7.
DRAFT — FOR INTERNAL USE ONLY Updating the uEFI BIOS CP3003-SA/CP3003-V uEFI BIOS This page has been intentionally left blank. Page 66 ID 1053-4014, Rev. 2.
