ShellPkg/ShellPkg.dec

   1 ## @file ShellPkg.dec
   2 # This Package provides all definitions for EFI and UEFI Shell
   3 #
   4 # (C) Copyright 2013-2014 Hewlett-Packard Development Company, L.P.<BR>
   5 # Copyright (c) 2009 - 2018, Intel Corporation. All rights reserved.<BR>
   6 # Copyright (c) 2016 - 2018, ARM Limited. All rights reserved.<BR>
   7 #
   8 # SPDX-License-Identifier: BSD-2-Clause-Patent
   9 #
  10 ##
  11
  12 [Defines]
  13   DEC_SPECIFICATION              = 0x00010005
  14   PACKAGE_NAME                   = ShellPkg
  15   PACKAGE_GUID                   = C1014BB7-4092-43D4-984F-0738EB424DBF
  16   PACKAGE_VERSION                = 1.02
  17
  18 [Includes]
  19   Include
  20
  21 [LibraryClasses]
  22   ##  @libraryclass  Provides most Shell APIs. Only available for Shell applications
  23   ShellLib|Include/Library/ShellLib.h
  24
  25   ##  @libraryclass  Provides shell internal support Only available for shell internal commands
  26   ShellCommandLib|Include/Library/ShellCommandLib.h
  27
  28   ## @libraryclass   Allows for a shell application to have a C style entry point
  29   ShellCEntryLib|Include/Library/ShellCEntryLib.h
  30
  31   ## @libraryclass   Provides advanced parsing functions
  32   HandleParsingLib|Include/Library/HandleParsingLib.h
  33
  34   ## @libraryclass   provides BCFG command
  35   BcfgCommandLib|Include/Library/BcfgCommandLib.h
  36
  37   ## @libraryclass   provides the AcpiView command
  38   AcpiViewCommandLib|Include/Library/AcpiViewCommandLib.h
  39
  40 [Guids]
  41   gEfiShellEnvironment2ExtGuid    = {0xd2c18636, 0x40e5, 0x4eb5, {0xa3, 0x1b, 0x36, 0x69, 0x5f, 0xd4, 0x2c, 0x87}}
  42   gEfiShellPkgTokenSpaceGuid      = {0x171e9188, 0x31d3, 0x40f5, {0xb1, 0x0c, 0x53, 0x9b, 0x2d, 0xb9, 0x40, 0xcd}}
  43   gShellVariableGuid              = {0x158def5a, 0xf656, 0x419c, {0xb0, 0x27, 0x7a, 0x31, 0x92, 0xc0, 0x79, 0xd2}}
  44   gShellMapGuid                   = {0x51271e13, 0x7de3, 0x43af, {0x8b, 0xc2, 0x71, 0xad, 0x3b, 0x82, 0x43, 0x25}}
  45   gShellAliasGuid                 = {0x0053d9d6, 0x2659, 0x4599, {0xa2, 0x6b, 0xef, 0x45, 0x36, 0xe6, 0x31, 0xa9}}
  46   gHandleParsingHiiGuid           = {0xb8969637, 0x81de, 0x43af, {0xbc, 0x9a, 0x24, 0xd9, 0x89, 0x13, 0xf2, 0xf6}}
  47   gShellDebug1HiiGuid             = {0x25f200aa, 0xd3cb, 0x470a, {0xbf, 0x51, 0xe7, 0xd1, 0x62, 0xd2, 0x2e, 0x6f}}
  48   gShellDriver1HiiGuid            = {0xaf0b742, 0x63ec, 0x45bd, {0x8d, 0xb6, 0x71, 0xad, 0x7f, 0x2f, 0xe8, 0xe8}}
  49   gShellInstall1HiiGuid           = {0x7d574d54, 0xd364, 0x4d4a, {0x95, 0xe3, 0x49, 0x45, 0xdb, 0x7a, 0xd3, 0xee}}
  50   gShellLevel1HiiGuid             = {0xdec5daa4, 0x6781, 0x4820, {0x9c, 0x63, 0xa7, 0xb0, 0xe4, 0xf1, 0xdb, 0x31}}
  51   gShellLevel2HiiGuid             = {0xf95a7ccc, 0x4c55, 0x4426, {0xa7, 0xb4, 0xdc, 0x89, 0x61, 0x95, 0xb, 0xae}}
  52   gShellLevel3HiiGuid             = {0x4344558d, 0x4ef9, 0x4725, {0xb1, 0xe4, 0x33, 0x76, 0xe8, 0xd6, 0x97, 0x4f}}
  53   gShellNetwork1HiiGuid           = {0xf3d301bb, 0xf4a5, 0x45a8, {0xb0, 0xb7, 0xfa, 0x99, 0x9c, 0x62, 0x37, 0xae}}
  54   gShellNetwork2HiiGuid           = {0x174b2b5, 0xf505, 0x4b12, {0xaa, 0x60, 0x59, 0xdf, 0xf8, 0xd6, 0xea, 0x37}}
  55   gShellTftpHiiGuid               = {0x738a9314, 0x82c1, 0x4592, {0x8f, 0xf7, 0xc1, 0xbd, 0xf1, 0xb2, 0x0e, 0xd4}}
  56   gShellHttpHiiGuid               = {0x390f84b3, 0x221c, 0x4d9e, {0xb5, 0x06, 0x6d, 0xb9, 0x42, 0x3e, 0x0a, 0x7e}}
  57   gShellBcfgHiiGuid               = {0x5f5f605d, 0x1583, 0x4a2d, {0xa6, 0xb2, 0xeb, 0x12, 0xda, 0xb4, 0xa2, 0xb6}}
  58   gShellAcpiViewHiiGuid           = {0xda8ccdf4, 0xed8f, 0x4ffc, {0xb5, 0xef, 0x2e, 0xf5, 0x5e, 0x24, 0x93, 0x2a}}
  59   # FILE_GUID as defined in ShellPkg/Application/Shell/Shell.inf
  60   gUefiShellFileGuid              = {0x7c04a583, 0x9e3e, 0x4f1c, {0xad, 0x65, 0xe0, 0x52, 0x68, 0xd0, 0xb4, 0xd1}}
  61
  62 [Protocols]
  63   gEfiShellEnvironment2Guid           = {0x47c7b221, 0xc42a, 0x11d2, {0x8e, 0x57, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b}}
  64   gEfiShellInterfaceGuid              = {0x47c7b223, 0xc42a, 0x11d2, {0x8e, 0x57, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b}}
  65
  66 [PcdsFeatureFlag]
  67   ## This flag is used to control whether the shell includes NT32 platform Guids
  68   #  and thereby prevents dependancy on that Pkg
  69   gEfiShellPkgTokenSpaceGuid.PcdShellIncludeNtGuids|TRUE|BOOLEAN|0x0000000E
  70
  71   ## This flag is used to control HII required by the shell
  72   gEfiShellPkgTokenSpaceGuid.PcdShellRequireHiiPlatform|TRUE|BOOLEAN|0x00000003
  73
  74   ## This flag is used to control HII required by the shell
  75   gEfiShellPkgTokenSpaceGuid.PcdShellSupportFrameworkHii|FALSE|BOOLEAN|0x00000004
  76
  77   ## This flag forces the shell to present a user console.  Allows for earlier debugging of platforms.
  78   gEfiShellPkgTokenSpaceGuid.PcdShellForceConsole|FALSE|BOOLEAN|0x0000000F
  79
  80 [PcdsFixedAtBuild]
  81   ## This flag is used to control initialization of the shell library
  82   #  This should be FALSE for compiling the shell application itself only.
  83   #  This should be FALSE for compiling the dynamic command drivers.
  84   gEfiShellPkgTokenSpaceGuid.PcdShellLibAutoInitialize|TRUE|BOOLEAN|0x00000005
  85
  86   ## This is the max buffer for ShellLib and internal Shell printings.
  87   gEfiShellPkgTokenSpaceGuid.PcdShellPrintBufferSize|16000|UINT16|0x0000000C
  88
  89   ## This flag is used to control the commands available in the shell
  90   gEfiShellPkgTokenSpaceGuid.PcdShellSupportLevel|3|UINT8|0x00000001
  91
  92   ## This flag is used to control the profiles available in the shell
  93   #  don't forget to update the text file if you change this.
  94   #  bit 0 = Drivers1
  95   #  bit 1 = Debug1
  96   #  bit 2 = Install1
  97   #  bit 3 = Network1
  98   #  bit 4 = Network2
  99   gEfiShellPkgTokenSpaceGuid.PcdShellProfileMask|0xFF|UINT8|0x0000000D
 100
 101   ## This is the character count for allocation for consistent mappings
 102   gEfiShellPkgTokenSpaceGuid.PcdShellMapNameLength|50|UINT8|0x00000009
 103
 104   ## This determines how many bytes are read out of files at a time for file operations (type, copy, etc...)
 105   gEfiShellPkgTokenSpaceGuid.PcdShellFileOperationSize|0x1000|UINT32|0x0000000A
 106
 107   ## This determines the max count of history commands
 108   gEfiShellPkgTokenSpaceGuid.PcdShellMaxHistoryCommandCount|0x0020|UINT16|0x00000014
 109
 110 [PcdsFixedAtBuild, PcdsPatchableInModule, PcdsDynamic, PcdsDynamicEx]
 111   ## This flag is used to control the protocols produced by the shell
 112   #  If TRUE the shell will produce EFI_SHELL_ENVIRONMENT2 and EFI_SHELL_INTERFACE
 113   gEfiShellPkgTokenSpaceGuid.PcdShellSupportOldProtocols|FALSE|BOOLEAN|0x00000002
 114
 115   ## this flag determines whether Page Break (-b) defaults to on or off in the shell
 116   gEfiShellPkgTokenSpaceGuid.PcdShellPageBreakDefault|FALSE|BOOLEAN|0x00000006
 117
 118   ## this flag determines whether insert mode for typing is default (FALSE means typeover)
 119   gEfiShellPkgTokenSpaceGuid.PcdShellInsertModeDefault|TRUE|BOOLEAN|0x00000007
 120
 121   ## this flag determines the default number of screens kept for history log.
 122   #  the spec defines 3 as the minimum
 123   gEfiShellPkgTokenSpaceGuid.PcdShellScreenLogCount|3|UINT8|0x00000008
 124
 125   ## Unicode string of the shell supplier
 126   gEfiShellPkgTokenSpaceGuid.PcdShellSupplier|L"EDK II"|VOID*|0x00000010
 127
 128   ## Do extended decode of USB for determining media type
 129   gEfiShellPkgTokenSpaceGuid.PcdUsbExtendedDecode|TRUE|BOOLEAN|0x00000011
 130
 131   ## Do iSCSI decode for map names.
 132   # This is disabled by default due to the length of generated strings
 133   gEfiShellPkgTokenSpaceGuid.PcdShellDecodeIScsiMapNames|FALSE|BOOLEAN|0x00000012
 134
 135   ## Controls Extended decode for Vendor device path nodes for map names.
 136   # Up to this many bytes of vendor specific data will be used. Default is 0
 137   # (disabled).
 138   gEfiShellPkgTokenSpaceGuid.PcdShellVendorExtendedDecode|0|UINT32|0x00000013
 139
 140   ## Controls the default delay the shell will offer to the user at the
 141   # start to check if the user wishes to cancel the script autostart
 142   gEfiShellPkgTokenSpaceGuid.PcdShellDefaultDelay|5|UINT32|0x00000015