ShellPkg/ShellPkg.dec

   1 ## @file ShellPkg.dec
   2 #
   3 # This Package provides all definitions for EFI and UEFI Shell
   4 #
   5 # (C) Copyright 2013-2014, Hewlett-Packard Development Company, L.P.
   6 # Copyright (c) 2009 - 2014, Intel Corporation. All rights reserved.<BR>
   7 #
   8 # This program and the accompanying materials are licensed and made available under
   9 # the terms and conditions of the BSD License which accompanies this distribution.
  10 # The full text of the license may be found at
  11 # http://opensource.org/licenses/bsd-license.php
  12 #
  13 # THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  14 # WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  15 #
  16 ##
  17
  18 [Defines]
  19   DEC_SPECIFICATION              = 0x00010005
  20   PACKAGE_NAME                   = ShellPkg
  21   PACKAGE_GUID                   = 9FB7587C-93F7-40a7-9C04-FD7BA94EE646
  22   PACKAGE_VERSION                = 0.50
  23
  24 [Includes]
  25   Include
  26
  27 [LibraryClasses]
  28   ##  @libraryclass  Provides most Shell APIs. Only available for Shell applications
  29   ShellLib|Include/Library/ShellLib.h
  30
  31   ##  @libraryclass  Provides shell internal support Only available for shell internal commands
  32   ShellCommandLib|Include/Library/ShellCommandLib.h
  33
  34   ##  @libraryclass  provides EFI_FILE_HANDLE services used by Shell and ShellLib
  35   FileHandleLib|Include/Library/FileHandleLib.h
  36
  37   ## @libraryclass   Allows for a shell application to have a C style entry point
  38   ShellCEntryLib|Include/Library/ShellCEntryLib.h
  39
  40   ## @libraryclass   Provides sorting functions
  41   SortLib|Include/Library/SortLib.h
  42
  43   ## @libraryclass   Provides advanced parsing functions
  44   HandleParsingLib|Include/Library/HandleParsingLib.h
  45
  46   ## @libraryclass   Provides path manipulation functions
  47   PathLib|Include/Library/PathLib.h
  48
  49   ## @libraryclass   provides BCFG command
  50   BcfgCommandLib|Include/Library/BcfgCommandLib.h
  51
  52 [Guids]
  53   gEfiShellEnvironment2ExtGuid    = {0xd2c18636, 0x40e5, 0x4eb5, {0xa3, 0x1b, 0x36, 0x69, 0x5f, 0xd4, 0x2c, 0x87}}
  54   gEfiShellPkgTokenSpaceGuid      = {0x171e9188, 0x31d3, 0x40f5, {0xb1, 0x0c, 0x53, 0x9b, 0x2d, 0xb9, 0x40, 0xcd}}
  55   gShellVariableGuid              = {0x158def5a, 0xf656, 0x419c, {0xb0, 0x27, 0x7a, 0x31, 0x92, 0xc0, 0x79, 0xd2}}
  56   gShellMapGuid                   = {0x51271e13, 0x7de3, 0x43af, {0x8b, 0xc2, 0x71, 0xad, 0x3b, 0x82, 0x43, 0x25}}
  57   gShellAliasGuid                 = {0x0053d9d6, 0x2659, 0x4599, {0xa2, 0x6b, 0xef, 0x45, 0x36, 0xe6, 0x31, 0xa9}}
  58   gHandleParsingHiiGuid           = {0xb8969637, 0x81de, 0x43af, {0xbc, 0x9a, 0x24, 0xd9, 0x89, 0x13, 0xf2, 0xf6}}
  59   gShellDebug1HiiGuid             = {0x25f200aa, 0xd3cb, 0x470a, {0xbf, 0x51, 0xe7, 0xd1, 0x62, 0xd2, 0x2e, 0x6f}}
  60   gShellDriver1HiiGuid            = {0xaf0b742, 0x63ec, 0x45bd, {0x8d, 0xb6, 0x71, 0xad, 0x7f, 0x2f, 0xe8, 0xe8}}
  61   gShellInstall1HiiGuid           = {0x7d574d54, 0xd364, 0x4d4a, {0x95, 0xe3, 0x49, 0x45, 0xdb, 0x7a, 0xd3, 0xee}}
  62   gShellLevel1HiiGuid             = {0xdec5daa4, 0x6781, 0x4820, {0x9c, 0x63, 0xa7, 0xb0, 0xe4, 0xf1, 0xdb, 0x31}}
  63   gShellLevel2HiiGuid             = {0xf95a7ccc, 0x4c55, 0x4426, {0xa7, 0xb4, 0xdc, 0x89, 0x61, 0x95, 0xb, 0xae}}
  64   gShellLevel3HiiGuid             = {0x4344558d, 0x4ef9, 0x4725, {0xb1, 0xe4, 0x33, 0x76, 0xe8, 0xd6, 0x97, 0x4f}}
  65   gShellNetwork1HiiGuid           = {0xf3d301bb, 0xf4a5, 0x45a8, {0xb0, 0xb7, 0xfa, 0x99, 0x9c, 0x62, 0x37, 0xae}}
  66   gShellBcfgHiiGuid               = {0x5f5f605d, 0x1583, 0x4a2d, {0xa6, 0xb2, 0xeb, 0x12, 0xda, 0xb4, 0xa2, 0xb6}}
  67
  68 [Protocols]
  69   gEfiShellProtocolGuid               = {0x6302d008, 0x7f9b, 0x4f30, {0x87, 0xac, 0x60, 0xc9, 0xfe, 0xf5, 0xda, 0x4e}}
  70   gEfiShellParametersProtocolGuid     = {0x752f3136, 0x4e16, 0x4fdc, {0xa2, 0x2a, 0xe5, 0xf4, 0x68, 0x12, 0xf4, 0xca}}
  71   gEfiShellEnvironment2Guid           = {0x47c7b221, 0xc42a, 0x11d2, {0x8e, 0x57, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b}}
  72   gEfiShellInterfaceGuid              = {0x47c7b223, 0xc42a, 0x11d2, {0x8e, 0x57, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b}}
  73   gEfiShellDynamicCommandProtocolGuid = {0x3c7200e9, 0x005f, 0x4ea4, {0x87, 0xde, 0xa3, 0xdf, 0xac, 0x8a, 0x27, 0xc3}}
  74
  75 [PcdsFeatureFlag]
  76   ## This flag is used to control whether the shell includes NT32 platform Guids
  77   #  and thereby prevents dependancy on that Pkg
  78   gEfiShellPkgTokenSpaceGuid.PcdShellIncludeNtGuids|TRUE|BOOLEAN|0x0000000E
  79
  80   ## This flag is used to control HII required by the shell
  81   gEfiShellPkgTokenSpaceGuid.PcdShellRequireHiiPlatform|TRUE|BOOLEAN|0x00000003
  82
  83   ## This flag is used to control HII required by the shell
  84   gEfiShellPkgTokenSpaceGuid.PcdShellSupportFrameworkHii|FALSE|BOOLEAN|0x00000004
  85
  86   ## This flag forces the shell to present a user console.  Allows for earlier debugging of platforms.
  87   gEfiShellPkgTokenSpaceGuid.PcdShellForceConsole|FALSE|BOOLEAN|0x0000000F
  88
  89 [PcdsFixedAtBuild]
  90   ## This flag is used to control initialization of the shell library
  91   #  This should be FALSE for compiling the shell application itself only.
  92   gEfiShellPkgTokenSpaceGuid.PcdShellLibAutoInitialize|TRUE|BOOLEAN|0x00000005
  93
  94   ## This is the max buffer for ShellLib, FileHandleLib, and internal Shell printings.
  95   gEfiShellPkgTokenSpaceGuid.PcdShellPrintBufferSize|16000|UINT16|0x0000000C
  96
  97   ## This flag is used to control the commands available in the shell
  98   gEfiShellPkgTokenSpaceGuid.PcdShellSupportLevel|3|UINT8|0x00000001
  99
 100   ## This flag is used to control the profiles available in the shell
 101   #  don't forget to update the text file if you change this.
 102   #  bit 0 = Drivers1
 103   #  bit 1 = Debug1
 104   #  bit 2 = Install1
 105   #  bit 3 = Network1
 106   gEfiShellPkgTokenSpaceGuid.PcdShellProfileMask|0xFF|UINT8|0x0000000D
 107
 108   ## This is the character count for allocation for consistent mappings
 109   gEfiShellPkgTokenSpaceGuid.PcdShellMapNameLength|50|UINT8|0x00000009
 110
 111   ## This determins how many bytes are read out of files at a time for file operations (type, copy, etc...)
 112   gEfiShellPkgTokenSpaceGuid.PcdShellFileOperationSize|1000|UINT32|0x0000000A
 113
 114 [PcdsFixedAtBuild, PcdsPatchableInModule, PcdsDynamic, PcdsDynamicEx]
 115   ## This flag is used to control the protocols produced by the shell
 116   #  If TRUE the shell will produce EFI_SHELL_ENVIRONMENT2 and EFI_SHELL_INTERFACE
 117   gEfiShellPkgTokenSpaceGuid.PcdShellSupportOldProtocols|FALSE|BOOLEAN|0x00000002
 118
 119   ## this flag determins whether Page Break (-b) defaults to on or off in the shell
 120   gEfiShellPkgTokenSpaceGuid.PcdShellPageBreakDefault|FALSE|BOOLEAN|0x00000006
 121
 122   ## this flag determins whether insert mode for typing is default (FALSE means typeover)
 123   gEfiShellPkgTokenSpaceGuid.PcdShellInsertModeDefault|TRUE|BOOLEAN|0x00000007
 124
 125   ## this flag determins the default number of screens kept for history log.
 126   #  the spec defines 3 as the minimum
 127   gEfiShellPkgTokenSpaceGuid.PcdShellScreenLogCount|3|UINT8|0x00000008
 128
 129   ## Unicode string of the shell supplier
 130   gEfiShellPkgTokenSpaceGuid.PcdShellSupplier|L"EDK II"|VOID*|0x00000010
 131
 132   ## Do extended decode of USB for determining media type
 133   gEfiShellPkgTokenSpaceGuid.PcdUsbExtendedDecode|TRUE|BOOLEAN|0x00000011
 134
 135   ## Do iSCSI decode for map names.
 136   # This is disabled by default due to the length of generated strings
 137   gEfiShellPkgTokenSpaceGuid.PcdShellDecodeIScsiMapNames|FALSE|BOOLEAN|0x00000012
 138
 139   ## Controls Extended decode for Vendor device path nodes for map names.
 140   # Up to this many bytes of vendor specific data will be used. Default is 0
 141   # (disabled).
 142   gEfiShellPkgTokenSpaceGuid.PcdShellVendorExtendedDecode|0|UINT32|0x00000013