AM5020 uEFI BIOS Doc. ID: 1045-0247, Rev. 1.0 April 21, 2011 If it’s embedded, it’s Kontron.
Preface AM5020 Revision History Publication Title: AM5020 uEFI BIOS User Guide Doc. ID: 1045-0247 Rev. PRELIMINARY 1.0 Brief Description of Changes Date of Issue Initial issue based on the uEFI BIOS version R13 21-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.
AM5020 uEFI BIOS Preface Table of Contents Revision History .........................................................................................................ii Imprint ........................................................................................................................ii Disclaimer ..................................................................................................................ii Table of Contents .................................................................
Preface 2.5.3.4 Parity ..........................................................................................15 2.5.3.5 Stop Bits .....................................................................................15 2.5.3.6 Terminal Type ............................................................................15 2.5.4 PRELIMINARY AM5020 uEFI BIOS Console Redirection Settings .............................................................16 2.5.4.1 Terminal Type ...........................
AM5020 uEFI BIOS 4. Preface Security Setup .............................................................................27 4.1 Administrator Password ............................................................................. 28 4.2 User Password ........................................................................................... 28 4.3 Remember the Password ........................................................................... 28 5. Save & Exit ...........................................
Preface AM5020 uEFI BIOS PRELIMINARY 6.3 uEFI Shell Scripting ....................................................................................54 7. 6.3.1 Startup Scripting .................................................................................54 6.3.2 Create a Startup Script .......................................................................54 6.3.3 Examples of Startup Scripts ...............................................................54 6.3.3.
Starting uEFI BIOS Setup Chapter 1 Starting uEFI BIOS Setup ID 1045-0247, Rev. 1.
PRELIMINARY Starting uEFI BIOS Setup AM5020 uEFI BIOS This page has been intentionally left blank. Page 2 ID 1045-0247, Rev. 1.
AM5020 uEFI BIOS 1. Starting uEFI BIOS Setup Starting uEFI BIOS Setup The AM5020 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 AM5020.
Starting uEFI BIOS Setup 1.1 AM5020 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. They are displayed in blue.
AM5020 uEFI BIOS 1.2 Starting uEFI BIOS Setup Navigation The AM5020 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 AM5020 uEFI BIOS This page has been intentionally left blank. Page 6 ID 1045-0247, Rev. 1.
Main Setup Chapter 21 Main Setup ID 1045-0247, Rev. 1.
PRELIMINARY Main Setup AM5020 uEFI BIOS This page has been intentionally left blank. Page 8 ID 1045-0247, Rev. 1.
AM5020 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. Aptio Setup Utility - Copyright (C) 2009 American Megatrends, Inc.
Main Setup 2.3 AM5020 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.
AM5020 uEFI BIOS 2.4 Main Setup USB Configuration This screen provides information about support for USB devices as well as functions for specifying the USB configuration settings. Aptio Setup Utility - Copyright (C) 2009 American Megatrends, Inc.
Main Setup 2.4.3 AM5020 uEFI BIOS 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. Note: It is recommended to leave this function at the default setting. For operating systems without USB2.0 support this function must be left at the default setting. SETTING DESCRIPTION Disabled Use this setting to disable EHCI Hand-Off support.
AM5020 uEFI BIOS 2.5 Main Setup 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.
Main Setup 2.5.2 AM5020 uEFI BIOS COM4 COM4 is available only if the MicroTCA system provides a serial port via PCI Express. 2.5.2.1 Console Redirection SETTING DESCRIPTION Disabled Use this setting to disable console redirection for a PCIe serial port. Enabled Use this setting to enable console redirection for a PCIe serial port. Default setting: Enabled 2.5.2.2 Console Redirection Settings PRELIMINARY For information about this function, refer to Chapter 2.5.4 in this manual. 2.5.
AM5020 uEFI BIOS 2.5.3.4 Main Setup Parity This is a display-only function providing information about the parity for Out-of-Band Management. 2.5.3.5 Stop Bits This is a display-only function providing information about the number of stop bits for Out-ofBand Management. 2.5.3.6 Terminal Type SETTING DESCRIPTION VT100 Use one of these settings to select the terminal type for out-of-band management. VT100+ PRELIMINARY VT-UTF8 ANSI Default setting: VT-UTF8 ID 1045-0247, Rev. 1.
Main Setup 2.5.4 AM5020 uEFI BIOS 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.
AM5020 uEFI BIOS 2.5.4.3 Main Setup 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.4.4 Parity SETTING DESCRIPTION None Use one of these settings to select the parity for the serial port. Odd Mark Space Default setting: None 2.5.4.5 Stop Bits SETTING DESCRIPTION 1 Use one of these settings to specify the number of stop bits for the serial port. 2 Default setting: 1 2.5.4.
Main Setup 2.5.4.8 AM5020 uEFI BIOS Legacy OS Redirection SETTING DESCRIPTION 80x24 Use one of these settings to select the number of rows and columns for legacy OS redirection. 80x25 Default setting: 80x24 PRELIMINARY 2.6 System Language SETTING DESCRIPTION English Use this function to select the system language. Currently, only English is supported. 2.7 System Date SETTING DESCRIPTION Use this function to change the system date.
Boot Setup Chapter 31 Boot Setup ID 1045-0247, Rev. 1.
PRELIMINARY Boot Setup AM5020 uEFI BIOS This page has been intentionally left blank. Page 20 ID 1045-0247, Rev. 1.
AM5020 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 Fast Boot UEFI Boot Setup Prompt Timeout [Disabled] [Disabled] [Enabled] 2 Bootup NumLock State [On] CSM16 Module Version 07.
Boot Setup 3.1.2 AM5020 uEFI BIOS Fast Boot This function is used to enable or disable boot with initialization of a minimal set of devices required to launch active boot option.. SETTING DESCRIPTION Disabled Use this setting to disable fast boot. Enabled Use this setting to enable fast boot. Default setting: Disabled 3.1.3 uEFI Boot PRELIMINARY This function is used to enable or disable uEFI boot from disks.
AM5020 uEFI BIOS 3.1.7 Boot Setup GateA20 Active This function is used to enable or disable GateA20. SETTING DESCRIPTION Upon Request Use this setting to disable GateA20 in the uEFI BIOS. Always Use this setting to prevent the system from disabling GateA20. Default setting: Upon Request 3.1.8 Option ROM Messages SETTING DESCRIPTION Force BIOS Use this setting to force to a BIOS-compatible output. This will show the option ROM messages.
Boot Setup 3.2 Boot Option Priorities 3.2.1 Boot Option #1..2 AM5020 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 1045-0247, Rev. 1.
PRELIMINARY Security Setup AM5020 uEFI BIOS This page has been intentionally left blank. Page 26 ID 1045-0247, Rev. 1.
AM5020 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 AM5020 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 1045-0247, Rev. 1.
PRELIMINARY Save & Exit AM5020 uEFI BIOS This page has been intentionally left blank. Page 30 ID 1045-0247, Rev. 1.
AM5020 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 AM5020 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 1045-0247, Rev. 1.
PRELIMINARY The uEFI Shell AM5020 uEFI BIOS This page has been intentionally left blank. Page 34 ID 1045-0247, Rev. 1.
AM5020 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 AM5020 uEFI BIOS Kontron-Specific uEFI Shell Commands PRELIMINARY The Kontron uEFI implementation provides the following additional commands related to the specific HW features of the Kontron system: • • • • • • • • • • • • kboardconfig kboardinfo kboot kbootnsh kclearnvram kclsp kflash kipmi kmkramdisk kpassword kpci kwdt The following tables provide information concerning these Kontron-specific commands.
AM5020 uEFI BIOS 6.2.1 The uEFI Shell kboardconfig uEFI Shell Command kboardconfig FUNCTION: SYNTAX: Configure the 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 AM5020 uEFI BIOS kboardconfig (continued) SETTINGS StorageOrom: Launch Storage PCI Option ROMs disabled: Do not launch storage PCI option ROMs. This includes the onboard RAID option ROM.
AM5020 uEFI BIOS 6.2.2 The uEFI Shell 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 Shell> kboardinfo KOMaOEMF rev.: Board ID: Hardware rev.: Logic rev.
The uEFI Shell AM5020 uEFI BIOS kboardinfo (continued) KOMaOEMF rev.: Board ID: Hardware rev.: Logic rev.: Boot flash: In system slot: Geographic Address: PRELIMINARY Material number: Hardware index: Serial number: EFI article name: EFI material number: EFI index: EFI build time: EFI build date: NorthBridge rev.: SouthBridge rev.
AM5020 uEFI BIOS 6.2.
The uEFI Shell AM5020 uEFI BIOS 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.
AM5020 uEFI BIOS 6.2.4 The uEFI Shell kbootnsh uEFI Shell Command kbootnsh FUNCTION: SYNTAX: Manage the startup script stored in the flash kbootnsh [-b][-?|-g |-p |-d] -b -? -g -p -d DESCRIPTION: USAGE: Display output page by page Show online help Store the current boot script to disk. If there is no physical disk drive present, the kmkramdisk command may be used. Store the shell script pointed to by filename to flash.
The uEFI Shell 6.2.5 AM5020 uEFI BIOS kclearnvram uEFI Shell Command kclearnvram FUNCTION: SYNTAX: Clear the NVRAM to restore the system’s default settings kclearnvram No parameters required. For safety reasons this command must be confirmed by pressing “c”. PRELIMINARY DESCRIPTION: 6.2.6 The kclearnvram command allows to clear the system NVRAM. Since all EFI settings are stored inside the NVRAM, the default settings are loaded afterwards.
AM5020 uEFI BIOS 6.2.7 The uEFI Shell kflash uEFI Shell Command kflash SYNTAX: Manage uEFI BIOS update kflash [-p|-i|-v|-s|-c|-h|-?] [-f] [-r] [file] Operation mode: -p Program flash -i Show information string and check CRC -v Verify flashed image -s Save current ROM image to file -c Clone flash content to second flash -h Show this help -? Show online help file uEFI BIOS binary file Options: -f Force write (option) Expert options: Not recommended for standard use -r Raw image mode (.bin, .
The uEFI Shell 6.2.
AM5020 uEFI BIOS The uEFI Shell kipmi (continued) Set IPMI controller mode: COMMAND / RESPONSE: Shell> kipmi mode USAGE: Set Serial-over-LAN I/O/SOL parameters: COMMAND / RESPONSE: Shell> kipmi net 1 Display system event log: Shell> kipmi sel list Show sensor related information: COMMAND / RESPONSE: Shell> kipmi sensor list Execute raw command. Example: Get self-test results.
The uEFI Shell AM5020 uEFI BIOS kipmi (continued) SETTINGS: mode : Display/Set the IPMI controller (MMC) operating mode Options: bmc: IPMI controller (MMC) operates in BMC mode (master) smc: IPMI controller (MMC) operates in SMC mode (slave) Note: The BMC mode is not available on the AM5020. Please leave this function at SMC mode. net: Set IPMI-over-LAN (IOL) / Serial-over-LAN (SOL) parameters sel: Display system event log Note: The AM5020 does not have a system event log.
AM5020 uEFI BIOS 6.2.9 The uEFI Shell kmkramdisk uEFI Shell Command kmkramdisk FUNCTION: SYNTAX: Create RAMdisk drives kmkramdisk [-?|-s ] where: -? show help DESCRIPTION: Creates a RAMdisk of variable size. Can be very useful to perform file operations when no real filesystem is connected to the system. Note: The RAMdisk loses its mount point name after all drives are remapped by the map -r command.
The uEFI Shell 6.2.10 AM5020 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. DESCRIPTION: USAGE: The kpassword command is used to get and set the EFI shell and setup passwords.
AM5020 uEFI BIOS 6.2.
The uEFI Shell 6.2.12 AM5020 uEFI BIOS kwdt uEFI Shell Command kwdt FUNCTION: SYNTAX: Configure the Kontron onboard Watchdog kwdt [-?|-t ] where: -? -t Show help Configure the Watchdog with the time related to timeindex and activate it with reset routing PRELIMINARY Call kwdt -h to obtain a list of time index values and related times DESCRIPTION: USAGE: The kwdt command allows to enable the Kontron onboard Watchdog with reset target before OS boot.
AM5020 uEFI BIOS The uEFI Shell kwdt (continued) 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.
The uEFI Shell 6.3 uEFI Shell Scripting 6.3.1 Startup Scripting AM5020 uEFI BIOS If the ESC key is not pressed and the timeout is run out, the uEFI Shell tries to execute some startup scripts automatically. It searches for scripts and executes them in the following order: 1. Kontron flash-stored startup script 2. If there is no Kontron flash-stored startup script present, the uEFI-specified startup.nsh script is used.
AM5020 uEFI BIOS 6.3.3.4 The uEFI Shell Enable Watchdog and Control PXE Boot The uEFI Shell provides environment variables used to control the execution flow. echo -off echo “Executing sample startup.nsh...
The uEFI Shell 6.3.3.5 AM5020 uEFI BIOS Handling the Startup Script in the Flash Bank In case there is no mass storage device attached, the startup script can be generated in a RAM disk and stored in the flash bank using the following instructions: 4. Press during power-up to log into the uEFI Shell. 5. Create a RAM disk and set the proper working directory as shown below: Shell> kmkramdisk -s 3 myramdisk Shell> myramdisk: 6.
Updating the uEFI BIOS Chapter 71 Updating the uEFI BIOS ID 1045-0247, Rev. 1.
PRELIMINARY Updating the uEFI BIOS AM5020 uEFI BIOS This page has been intentionally left blank. Page 58 ID 1045-0247, Rev. 1.
AM5020 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 AM5020 has two sets of uEFI flash banks to form a redundancy strategy.
Updating the uEFI BIOS 7.5 AM5020 uEFI BIOS Manual Flash Selection Usually the active flash is selected by the MMC controller. The manual selection of the redundant flash bank can be done either via the Set Control State IPMI OEM command or using the DIP Switch SW4, switch 2. The Set Control State IPMI OEM command can be issued without having payload power applied.
