Getting Started with the Intel® DQ57TM UEFI 2.3.1 Development Kit Getting Started with the Intel® DQ57TM UEFI 2.3.1 Development Kit 2 Before You Begin 1 Before You Begin You need the following skills, components, and tools: PC assembly skills. Host PC with Microsoft Windows XP* or another appropriate Windows* operating system. (This system supports the optional Dediprog* software tool.) Intel® DQ57TM UEFI 2.3.1 Development Kit target PC, assembled with components from the supported hardware component list. USB FAT-formatted flash drive. SPI flash programmer with test clip and software utility (optional). Figure 1-1. Overview of the SPI Flash Programming Environment You can download the developer kit firmware & documentation from the Intel® UEFI Community Resource Center: http://uefidk.com/develop/development-kit CAUTION: You must use one of the supported firmware images included with the development kit. Installing unsupported firmware on the motherboard may render the motherboard Getting Started Guide 3 Getting Started with the Intel® DQ57TM UEFI 2.3.1 Development Kit unusable until it is re-flashed with a backup copy of the motherboard's original firmware. Use only supported components with the Intel® DQ57TM UEFI 2.3.1 Development Kit. SDV_TM_B13_release.rom/.cap The release version of the firmware, with debugging features disabled. This is the recommended, default image for development. SDV_TM_B13_debug.rom/.cap The debug version of the firmware, with debug output redirected to the serial port (COM1). This is the image recommended for general debugging. SDV_TM_B13_srcdbg.rom/.cap The source level debug version of the firmware, which supports the Intel® UEFI Development Kit Debugger Tool using the serial port (COM1). This image is recommended only for advanced debugging. FVMAIN.fv The USB Recovery version of the firmware, based on the release firmware image. The development kit also includes: 1.1 Intel DQ57TM Firmware Update (for .rom files): FirmwareUpdate.efi Intel UEFI Capsule Update Utility (for .cap files): CapsuleApp.efi User documentation, including this getting started guide and the release notes. Supported and recommended hardware components Table 1-1 describes the supported and recommended PC hardware components for the Intel® DQ57TM UEFI 2.3.1 Development Kit. You must use the motherboard and processor listed in the table below in order to upgrade or install a UEFI 2.3.1compliant firmware image on the development kit. CAUTION: Installing the firmware image on an unsupported motherboard may render the motherboard unusable until it is re-flashed with a backup copy of the motherboard's original firmware. Use only supported components with the Intel® DQ57TM UEFI 2.3.1 Development Kit. 4 Before You Begin Table 1-1. Supported and recommended hardware components Supported hardware and firmware Intel® DQ57TM Desktop Board You must use the commercially available Intel DQ57TM Desktop Board. 2nd generation Intel® Core™ i5650 Processor with heat sink You must use a 2nd gen Intel Core i5-650 processor with heat sink. This processor is available commercially. Intel® DQ57TM UEFI 2.3.1 Development Kit firmware image You must use one of the firmware images from the Intel® DQ57TM UEFI 2.3.1 Development Kit. The firmware replaces the Intel® DQ57TM Desktop Board BIOS and enables UEFI 2.3.1c support. The firmware images in the developer's kit have been validated to work only with the specific processor and motherboard listed above. Serial cable You must use a DB-9 male to 10-pin IDC socket serial cable for the serial port on the Intel DQ57TM Desktop Board. Recommended hardware 1.2 Notes Notes 4GB (2 x 2GB) DDR3 1333 memory The Intel DQ57TM Desktop Board supports up to 16 GB RAM. You should use at least 2 GB of DDR3 memory in your development build. 500 W Power supply A power supply that meets the requirements of the Intel DQ57TM Desktop Board is adequate. We recommend Installing a minimum 500W power supply. SATA HDD 500GB Install a hard drive that has at least 500 GB. Testing hard drives over 2.2TB requires the use of UEFI. SATA DVD-RW Optical Disk Drive or other install media Most developers use a DVD drive to perform this type of UEFI build. Make sure you have an appropriate DVD drive or other media (such as a network connection or USB drive) appropriate for installing the operating system. Micro-ATX Chassis A chassis is not required. However, if you want the build to be portable, consider using a micro-ATX or similar chassis. USB keyboard and USB mouse Including a USB keyboard and mouse with the developer's platform allows you to input UEFI shell commands and navigate firmware menus. Monitor A monitor is recommended in order to view console output. Using an SPI flash programmer The SPI flash programmer is optional but may be needed to reflash the firmware image. This is because the development and testing of pre-production products can Getting Started Guide 5 Getting Started with the Intel® DQ57TM UEFI 2.3.1 Development Kit corrupt the flash image. If the flash image becomes corrupted, you may need to perform a hardware-based reprogramming of the SPI flash part. To reprogram the SPI flash part, you will need a third-party SPI flash programmer, test clip, and corresponding software application. These elements allow you to transfer the firmware image from the host PC to the flash device on the firmware developer platform (the target PC). SPI reflash instructions in this document are based on products from Dediprog Technology Co, Ltd.*, which have been verified to work with the supported hardware. 6 Firmware Upgrade or Installation 2 Firmware Upgrade or Installation If you have a system running properly on an older version of the Intel® DQ57TM UEFI 2.3.1 Development Kit firmware, just upgrade the firmware image. If your system isn’t running properly, or this is the first time you are flashing the development kit firmware onto a retail motherboard, you should follow the complete firmware installation procedure. The full installation procedure takes between five and thirty minutes, depending on your experience level. CAUTION: You must be able to identify key elements on the Intel® DQ57TM Desktop Board in order to update or install the firmware. Figure 2-1 shows these elements. Figure 2-1 2.1 Location of BIOS CFG jumper, LEDs, SPI device, and MAC address. Firmware upgrade The FirmwareUpdate.efi utility lets you update the firmware from the UEFI Shell. You do not need a hardware-based SPI programmer for this update. Here are the general steps you would follow: Getting Started Guide 7 Getting Started with the Intel® DQ57TM UEFI 2.3.1 Development Kit 1. Set motherboard in configuration mode. 2. Power up the target PC and boot to the UEFI shell. 3. Use the UEFI shell firmware update utility (FirmwareUpdate.efi) to patch the firmware with the motherboard’s MAC address. Your command line will look similar to the following, with the ROM name and MAC address fields replaced with your system’s specific information: FirmwareUpdate –f SDV_TM_B13_xxxx.rom –m 0011AA33CC55 NOTE: The system will reset after the update has been applied. NOTE: Upgrading the flash will restore Setup and Boot Manager settings to their default values. Any previous changes to Setup or Boot Manager values will be cleared in the upgrade process. 4. After the platform resets, verify the firmware functions correctly by entering setup, verifying the version string matches the expected value for the new firmware version, and booting to the UEFI shell. 5. Set the motherboard back to normal mode. The Intel® DQ57TM UEFI 2.3.1 Development Kit is ready for use in UEFI development after a firmware update is verified. Detailed steps for this procedure are explained in the Intel® DQ57TM UEFI 2.3.1 Development Kit Firmware Installation Guide. 2.2 Capsule update The capsule update procedure uses a software utility to update the system firmware via the UEFI UpdateCapsule() function. This method is similar to the Firmware Upgrade method, except that UEFI NVRAM Variables are not modified. This process uses the .CAP firmware file instead of the .ROM file. 2.2.1 General Steps for Capsule Update: 1. Download the development kit firmware images, update tool, and user documentation from http://uefidk.com/develop/development-kit. 2. Power up the target PC and boot to the UEFI shell. 3. Use the UEFI shell firmware update utility (CapsuleApp.efi) to start the capsule update process: CapsuleApp.efi SDV_TM_B13_release.cap 4. The system will start the capsule update process, which resets the system, displays the boot logo during the update process, and then resets the system again after the update has been applied. 8 Firmware Upgrade or Installation TIP: [CAUTION] Do not shut down or reset the platform during the capsule update process. Interrupting the capsule update may corrupt the system firmware. 2.3 USB Firmware Recovery The firmware recovery procedure allows recovery of partially corrupted system firmware. The firmware is loaded from a FAT32 formatted USB drive by a built-in recovery routine. We recommend this procedure for recovering systems that have failed to boot after an attempted firmware upgrade or capsule update. TIP: 2.3.1 This procedure is supported only in version SDV_TM_B13 or higher. General Steps for USB Recovery: 1. Download the development kit firmware images, update tool, and user documentation from http://uefidk.com/develop/development-kit. 2. Power off the target PC and disconnect the power cord. 3. Open the case of the target PC and locate the recovery jumper (near the SATA connectors). Move the jumper from the “normal mode” position (pins 1-2) to “recovery mode” (none). 4. Copy the following files to the root folder of a FAT32 formatted USB drive: FVMAIN.FV FirmwareUpdate.efi FirmwareUpdate SDV_TM_B13_release.rom 5. Insert the USB drive into an open USB port on the target PC. 6. Connect the power cord on the target PC and turn the system on. The system will automatically enter recovery mode, which attempts to load firmware from FVMAIN.FV on the USB drive. This may take several minutes to complete. 7. Once the boot screen appears, enter setup and launch the UEFI Shell. 8. Use the UEFI shell firmware update utility (FirmwareUpdate.efi) to apply the release firmware image to the motherboard’s SPI memory device: FirmwareUpdate SDV_TM_B13_release.rom 9. When the screen shows a message that the system will reboot, power off the target PC and disconnect the power cord. Remove the USB drive and return the recovery jumper to its original position. 10. Power on the target PC. Verify that the firmware functions correctly by entering setup, verifying the version string matches the expected value for the new firmware version, and booting to the UEFI shell. TIP: The system will reset after the update has been applied, and then performs one boot cycle for configuration. Wait for this cycle to complete before entering setup or booting to an operating system. Getting Started Guide 9 Getting Started with the Intel® DQ57TM UEFI 2.3.1 Development Kit TIP: Upgrading the flash will restore Setup and Boot Manager settings to default values. Any previous changes to Setup or Boot Manager values will be cleared in the upgrade process. This includes any boot entries created by a UEFI OS. 2.4 Firmware installation (hardware based) The complete firmware installation procedure requires the hardware-based SPI flash programmer. Here are the general steps for a complete firmware installation: 1. Set the motherboard in configuration mode. 2. Download the development kit firmware images, firmware update tool, and user documentation. 3. Install the Dediprog software utility on the host PC. 4. Prepare the development kit (target PC) for the BIOS update. 5. Create a backup copy of the original BIOS image on the target PC’s motherboard. 6. Erase the existing firmware from the target PC’s motherboard. 7. Write the development kit BIOS image to the target PC. 8. Reassemble the target PC. 9. Power up the target PC and boot to the UEFI shell. 10. Use the UEFI shell firmware update utility (FirmwareUpdate.efi) to patch the firmware with the motherboard’s MAC address. Your command line will look similar to the following, with the MAC address field replaced with your motherboard’s MAC address: FirmwareUpdate –m 0011AA33CC55 11. After the platform resets, verify that the firmware functions correctly by entering setup and booting to the UEFI shell. 12. Set motherboard back to normal mode. 2.5 Legacy BIOS support Enable or disable the Compatibility Support Module (CSM) using the Device Manager -> Boot setup menu. You can do this without reflashing the firmware. This permits management of legacy BIOS support for UEFI Class 2 and Class 3 systems. It also permits management of legacy issues with pre-boot video for the primary display output. 10 Firmware Upgrade or Installation Figure 2-2. Legacy support field in the Boot setup menu Getting Started Guide 11 Getting Started with the Intel® DQ57TM UEFI 2.3.1 Development Kit 12 User and Reference Documentation 3 User and Reference Documentation The development kit includes several types of user documentation to help you: Intel® DQ57TM UEFI 2.3.1 Development Kit Getting Started Guide (this document): UEFIDevKit_DQ57TM_Getting_Started_Guide.pdf Intel® DQ57TM UEFI 2.3.1 Development Kit Firmware Installation Guide. UEFIDevKit_DQ57TM_Firmware_Installation_Guide.pdf Intel® DQ57TM UEFI 2.3.1 Development Kit Release Notes: ReleaseNotes.txt Instructions for the Firmware Update tool: ReadMe.txt Instructions for enabling source debug support using the Intel® UEFI Development Kit Debugger Tool: SourceLevelDebug.txt Software Tools License Agreement: EULA.pdf For information about ordering third-party Dediprog hardware and software tools, visit the Dediprog website. For information related to UEFI software development, visit the Develop section of the Intel UEFI Community Web site at http://intel.com/udk For information about the UEFI specification, visit the UEFI home page at www.uefi.org/home Getting Started Guide 13 Getting Started with the Intel® DQ57TM UEFI 2.3.1 Development Kit Legal Information INFORMATION IN THIS DOCUMENT IS PROVIDED IN CONNECTION WITH INTEL PRODUCTS. NO LICENSE, EXPRESS OR IMPLIED, BY ESTOPPEL OR OTHERWISE, TO ANY INTELLECTUAL PROPERTY RIGHTS IS GRANTED BY THIS DOCUMENT. EXCEPT AS PROVIDED IN INTEL’S TERMS AND CONDITIONS OF SALE FOR SUCH PRODUCTS, INTEL ASSUMES NO LIABILITY WHATSOEVER, AND INTEL DISCLAIMS ANY EXPRESS OR IMPLIED WARRANTY, RELATING TO SALE AND/OR USE OF INTEL PRODUCTS INCLUDING LIABILITY OR WARRANTIES RELATING TO FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABILITY, OR INFRINGEMENT OF ANY PATENT, COPYRIGHT OR OTHER INTELLECTUAL PROPERTY RIGHT. Intel products are not intended for use in medical, life saving, or life sustaining applications. Intel may make changes to specifications and product descriptions at any time, without notice. Designers must not rely on the absence or characteristics of any features or instructions marked “reserved” or “undefined.” Intel reserves these for future definition and shall have no responsibility whatsoever for conflicts or incompatibilities arising from future changes to them. This product may contain design defects or errors known as errata which may cause the product to deviate from published specifications. Current characterized errata are available on request. Code Names are only for use by Intel to identify products, platforms, programs, services, etc. (“products”) in development by Intel that have not been made commercially available to the public, i.e., announced, launched or shipped. They are never to be used as “commercial” names for products. Also, they are not intended to function as trademarks. Contact your local Intel sales office or your distributor to obtain the latest specifications and before placing your product order. Intel, Intel Core, and the Intel logo are trademarks or registered trademarks of Intel Corporation or its subsidiaries in the United States and other countries. *Other names and brands may be claimed as the property of others. Copyright © 2013, Intel Corporation. All rights reserved. 14