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