ShellPkg/UDK2010.UP2.Shell.txt

   1 ============================================================================
   2 UEFI Shell 2.0 implementation release notes.
   3 September 13, 2010
   4 ============================================================================
   5 ============================================================================
   6                                    DISCLAIMER
   7 ============================================================================
   8 This release note as well as the software described in it is furnished under
   9 license and may only be used or copied in accordance with the terms of the
  10 license. The information in this manual is furnished for informational use
  11 only, is subject to change without notice, and should not be construed as a
  12 commitment by Intel Corporation.
  13
  14 Intel Corporation assumes no responsibility or liability for any errors or
  15 inaccuracies that may appear in this document or any software that may be
  16 provided in association with this document.
  17
  18 Except as permitted by such license, no part of this document may be
  19 reproduced, stored in a retrieval system, or transmitted in any form or by
  20 any means without the express written consent of Intel Corporation.
  21
  22 ============================================================================
  23                               ADDITIONAL DISCLAIMER
  24 ============================================================================
  25 This code is based upon the EDK II code base as found on the UEFI Open
  26 Source Community Website at http://www.tianocore.org.
  27
  28 ============================================================================
  29                                   CONTENTS
  30 ============================================================================
  31 * Overview
  32 * How to build shell
  33 * Known limitations
  34 * Incorporation
  35
  36 ============================================================================
  37                                   OVERVIEW
  38 ============================================================================
  39 The UEFI 2.0 shell provides a standard pre-boot command line processor.
  40 It is similar to the EDK EFI Shell or a *nix command line parser.
  41
  42 ============================================================================
  43                                HOW TO BUILD SHELL
  44 ============================================================================
  45 1. Tools preparation
  46   1). *Visual Studio 2005* or Intel(r) Compiler 9.1
  47
  48
  49 2. Source preparation
  50   1). Extract .zip (or later) to root of EDK II workspace
  51
  52 3. Build steps
  53   1) run edksetup script
  54   2) run build -p ShellPlg\ShellPkg.dsc
  55
  56 ============================================================================
  57                             KNOWN LIMITATIONS
  58 ============================================================================
  59 1. Redirecting StdErr is not completely functional.
  60
  61 2. This uses errata approved by the USHT/USWG, but not yet published by UEFI.
  62
  63 3. Online help may be incomplete and examples may be slightly out of date.
  64
  65 4. CTRL-C is not functional.
  66
  67 ============================================================================
  68          HOW TO INCORPORATE THIS SHELL INTO NT32
  69 ============================================================================
  70 The instructions below are included as a sample and template on how a
  71 developer may integrate this code into An existing platform:
  72
  73 1. Add this shell build to the NT32 build:
  74 Add the shell.inf to the [components] section as it is in the ShellPkg.dsc.
  75
  76 1) Update system PCDs to support this new module
  77 Update the PCD as follows using the Shell's PCD:
  78
  79   gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdShellFile|{ 0x83, 0xA5, 0x04, 0x7C, 0x3E, 0x9E, 0x1C, 0x4F, 0xAD, 0x65, 0xE0, 0x52, 0x68, 0xD0, 0xB4, 0xD1 }
  80
  81 2) Remove the old shell from the NT32 Firmware list
  82 Remove the FILE APPLICATION section for the old shell.
  83
  84 3) Add this shell to the NT32 firmware list
  85 Add the Shell.INF to the end of the list of DXE modules.
  86
  87 4) Build NT32 (per instructions provided with EDK II/UDK2010)
  88
  89 ============================================================================