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 | #
|
| 3 | # This Package provides all definitions for EFI and UEFI Shell
|
| 4 | #
|
Chris Phillips | 284e034 | 2013-10-18 15:49:23 +0000 | [diff] [blame] | 5 | # Copyright (c) 2013, Hewlett-Packard Development Company, L.P.
|
Jaben Carsey | e66e86e | 2014-07-31 18:07:43 +0000 | [diff] [blame^] | 6 | # Copyright (c) 2009 - 2014, Intel Corporation. All rights reserved.<BR>
|
jcarsey | 94b17fa | 2009-05-07 18:46:18 +0000 | [diff] [blame] | 7 | #
|
jcarsey | 94b17fa | 2009-05-07 18:46:18 +0000 | [diff] [blame] | 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 |
|
jcarsey | 94b17fa | 2009-05-07 18:46:18 +0000 | [diff] [blame] | 18 | [Defines]
|
| 19 | DEC_SPECIFICATION = 0x00010005
|
| 20 | PACKAGE_NAME = ShellPkg
|
| 21 | PACKAGE_GUID = 9FB7587C-93F7-40a7-9C04-FD7BA94EE646
|
geekboy15a | b714ecb | 2011-12-13 18:45:44 +0000 | [diff] [blame] | 22 | PACKAGE_VERSION = 0.50
|
jcarsey | 94b17fa | 2009-05-07 18:46:18 +0000 | [diff] [blame] | 23 |
|
mdkinney | edd88d5 | 2011-05-09 17:51:58 +0000 | [diff] [blame] | 24 | [Includes]
|
jcarsey | 94b17fa | 2009-05-07 18:46:18 +0000 | [diff] [blame] | 25 | Include
|
| 26 |
|
mdkinney | edd88d5 | 2011-05-09 17:51:58 +0000 | [diff] [blame] | 27 | [LibraryClasses]
|
jcarsey | a405b86 | 2010-09-14 05:18:09 +0000 | [diff] [blame] | 28 | ## @libraryclass Provides most Shell APIs. Only available for Shell applications
|
jcarsey | 94b17fa | 2009-05-07 18:46:18 +0000 | [diff] [blame] | 29 | ShellLib|Include/Library/ShellLib.h
|
| 30 |
|
jcarsey | a405b86 | 2010-09-14 05:18:09 +0000 | [diff] [blame] | 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
|
jcarsey | d2b4564 | 2009-05-11 18:02:16 +0000 | [diff] [blame] | 35 | FileHandleLib|Include/Library/FileHandleLib.h
|
jcarsey | a405b86 | 2010-09-14 05:18:09 +0000 | [diff] [blame] | 36 |
|
jcarsey | 4983ca9 | 2009-07-13 19:33:35 +0000 | [diff] [blame] | 37 | ## @libraryclass Allows for a shell application to have a C style entry point
|
jcarsey | b1f95a0 | 2009-06-16 00:23:19 +0000 | [diff] [blame] | 38 | ShellCEntryLib|Include/Library/ShellCEntryLib.h
|
jcarsey | d2b4564 | 2009-05-11 18:02:16 +0000 | [diff] [blame] | 39 |
|
jcarsey | 4983ca9 | 2009-07-13 19:33:35 +0000 | [diff] [blame] | 40 | ## @libraryclass Provides sorting functions
|
jcarsey | a405b86 | 2010-09-14 05:18:09 +0000 | [diff] [blame] | 41 | SortLib|Include/Library/SortLib.h
|
jcarsey | 4983ca9 | 2009-07-13 19:33:35 +0000 | [diff] [blame] | 42 |
|
jcarsey | a405b86 | 2010-09-14 05:18:09 +0000 | [diff] [blame] | 43 | ## @libraryclass Provides advanced parsing functions
|
| 44 | HandleParsingLib|Include/Library/HandleParsingLib.h
|
geekboy15a | b714ecb | 2011-12-13 18:45:44 +0000 | [diff] [blame] | 45 |
|
jcarsey | ab94587 | 2011-06-30 22:58:53 +0000 | [diff] [blame] | 46 | ## @libraryclass Provides path manipulation functions
|
| 47 | PathLib|Include/Library/PathLib.h
|
jcarsey | d2b4564 | 2009-05-11 18:02:16 +0000 | [diff] [blame] | 48 |
|
mdkinney | edd88d5 | 2011-05-09 17:51:58 +0000 | [diff] [blame] | 49 | [Guids]
|
jcarsey | 94b17fa | 2009-05-07 18:46:18 +0000 | [diff] [blame] | 50 | gEfiShellEnvironment2ExtGuid = {0xd2c18636, 0x40e5, 0x4eb5, {0xa3, 0x1b, 0x36, 0x69, 0x5f, 0xd4, 0x2c, 0x87}}
|
Chris Phillips | 284e034 | 2013-10-18 15:49:23 +0000 | [diff] [blame] | 51 | gEfiShellPkgTokenSpaceGuid = {0x171e9188, 0x31d3, 0x40f5, {0xb1, 0x0c, 0x53, 0x9b, 0x2d, 0xb9, 0x40, 0xcd}}
|
jcarsey | a405b86 | 2010-09-14 05:18:09 +0000 | [diff] [blame] | 52 | gShellVariableGuid = {0x158def5a, 0xf656, 0x419c, {0xb0, 0x27, 0x7a, 0x31, 0x92, 0xc0, 0x79, 0xd2}}
|
| 53 | gShellMapGuid = {0x51271e13, 0x7de3, 0x43af, {0x8b, 0xc2, 0x71, 0xad, 0x3b, 0x82, 0x43, 0x25}}
|
| 54 | gShellAliasGuid = {0x0053d9d6, 0x2659, 0x4599, {0xa2, 0x6b, 0xef, 0x45, 0x36, 0xe6, 0x31, 0xa9}}
|
lgao4 | bca163f | 2011-09-21 01:56:00 +0000 | [diff] [blame] | 55 | gHandleParsingHiiGuid = {0xb8969637, 0x81de, 0x43af, {0xbc, 0x9a, 0x24, 0xd9, 0x89, 0x13, 0xf2, 0xf6}}
|
| 56 | gShellDebug1HiiGuid = {0x25f200aa, 0xd3cb, 0x470a, {0xbf, 0x51, 0xe7, 0xd1, 0x62, 0xd2, 0x2e, 0x6f}}
|
| 57 | gShellDriver1HiiGuid = {0xaf0b742, 0x63ec, 0x45bd, {0x8d, 0xb6, 0x71, 0xad, 0x7f, 0x2f, 0xe8, 0xe8}}
|
| 58 | gShellInstall1HiiGuid = {0x7d574d54, 0xd364, 0x4d4a, {0x95, 0xe3, 0x49, 0x45, 0xdb, 0x7a, 0xd3, 0xee}}
|
| 59 | gShellLevel1HiiGuid = {0xdec5daa4, 0x6781, 0x4820, {0x9c, 0x63, 0xa7, 0xb0, 0xe4, 0xf1, 0xdb, 0x31}}
|
| 60 | gShellLevel2HiiGuid = {0xf95a7ccc, 0x4c55, 0x4426, {0xa7, 0xb4, 0xdc, 0x89, 0x61, 0x95, 0xb, 0xae}}
|
| 61 | gShellLevel3HiiGuid = {0x4344558d, 0x4ef9, 0x4725, {0xb1, 0xe4, 0x33, 0x76, 0xe8, 0xd6, 0x97, 0x4f}}
|
| 62 | gShellNetwork1HiiGuid = {0xf3d301bb, 0xf4a5, 0x45a8, {0xb0, 0xb7, 0xfa, 0x99, 0x9c, 0x62, 0x37, 0xae}}
|
geekboy15a | b714ecb | 2011-12-13 18:45:44 +0000 | [diff] [blame] | 63 |
|
mdkinney | edd88d5 | 2011-05-09 17:51:58 +0000 | [diff] [blame] | 64 | [Protocols]
|
Jaben Carsey | e66e86e | 2014-07-31 18:07:43 +0000 | [diff] [blame^] | 65 | gEfiShellProtocolGuid = {0x6302d008, 0x7f9b, 0x4f30, {0x87, 0xac, 0x60, 0xc9, 0xfe, 0xf5, 0xda, 0x4e}}
|
| 66 | gEfiShellParametersProtocolGuid = {0x752f3136, 0x4e16, 0x4fdc, {0xa2, 0x2a, 0xe5, 0xf4, 0x68, 0x12, 0xf4, 0xca}}
|
| 67 | gEfiShellEnvironment2Guid = {0x47c7b221, 0xc42a, 0x11d2, {0x8e, 0x57, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b}}
|
| 68 | gEfiShellInterfaceGuid = {0x47c7b223, 0xc42a, 0x11d2, {0x8e, 0x57, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b}}
|
| 69 | gEfiShellDynamicCommandProtocolGuid = {0xcd3258c, 0xd677, 0x4fcc, { 0xb3, 0x43, 0x93, 0x4d, 0x30, 0x98, 0x38, 0x88}}
|
jcarsey | 94b17fa | 2009-05-07 18:46:18 +0000 | [diff] [blame] | 70 |
|
mdkinney | edd88d5 | 2011-05-09 17:51:58 +0000 | [diff] [blame] | 71 | [PcdsFeatureFlag]
|
| 72 | ## This flag is used to control whether the shell includes NT32 platform Guids
|
| 73 | # and thereby prevents dependancy on that Pkg
|
| 74 | gEfiShellPkgTokenSpaceGuid.PcdShellIncludeNtGuids|TRUE|BOOLEAN|0x0000000E
|
| 75 |
|
| 76 | ## This flag is used to control HII required by the shell
|
| 77 | gEfiShellPkgTokenSpaceGuid.PcdShellRequireHiiPlatform|TRUE|BOOLEAN|0x00000003
|
| 78 |
|
| 79 | ## This flag is used to control HII required by the shell
|
| 80 | gEfiShellPkgTokenSpaceGuid.PcdShellSupportFrameworkHii|FALSE|BOOLEAN|0x00000004
|
geekboy15a | b714ecb | 2011-12-13 18:45:44 +0000 | [diff] [blame] | 81 |
|
mdkinney | edd88d5 | 2011-05-09 17:51:58 +0000 | [diff] [blame] | 82 | ## This flag forces the shell to present a user console. Allows for earlier debugging of platforms.
|
| 83 | gEfiShellPkgTokenSpaceGuid.PcdShellForceConsole|FALSE|BOOLEAN|0x0000000F
|
| 84 |
|
jcarsey | b1f95a0 | 2009-06-16 00:23:19 +0000 | [diff] [blame] | 85 | [PcdsFixedAtBuild]
|
jcarsey | d2b4564 | 2009-05-11 18:02:16 +0000 | [diff] [blame] | 86 | ## This flag is used to control initialization of the shell library
|
jcarsey | a405b86 | 2010-09-14 05:18:09 +0000 | [diff] [blame] | 87 | # This should be FALSE for compiling the shell application itself only.
|
jcarsey | 02864f5 | 2009-12-01 05:45:51 +0000 | [diff] [blame] | 88 | gEfiShellPkgTokenSpaceGuid.PcdShellLibAutoInitialize|TRUE|BOOLEAN|0x00000005
|
| 89 |
|
jcarsey | a405b86 | 2010-09-14 05:18:09 +0000 | [diff] [blame] | 90 | ## This is the max buffer for ShellLib, FileHandleLib, and internal Shell printings.
|
| 91 | gEfiShellPkgTokenSpaceGuid.PcdShellPrintBufferSize|16000|UINT16|0x0000000C
|
jcarsey | 02864f5 | 2009-12-01 05:45:51 +0000 | [diff] [blame] | 92 |
|
jcarsey | a405b86 | 2010-09-14 05:18:09 +0000 | [diff] [blame] | 93 | ## This flag is used to control the commands available in the shell
|
| 94 | gEfiShellPkgTokenSpaceGuid.PcdShellSupportLevel|3|UINT8|0x00000001
|
jcarsey | 02864f5 | 2009-12-01 05:45:51 +0000 | [diff] [blame] | 95 |
|
jcarsey | a405b86 | 2010-09-14 05:18:09 +0000 | [diff] [blame] | 96 | ## This flag is used to control the profiles available in the shell
|
| 97 | # don't forget to update the text file if you change this.
|
| 98 | # bit 0 = Drivers1
|
| 99 | # bit 1 = Debug1
|
| 100 | # bit 2 = Install1
|
| 101 | # bit 3 = Network1
|
| 102 | gEfiShellPkgTokenSpaceGuid.PcdShellProfileMask|0xFF|UINT8|0x0000000D
|
| 103 |
|
| 104 | ## This is the character count for allocation for consistent mappings
|
| 105 | gEfiShellPkgTokenSpaceGuid.PcdShellMapNameLength|50|UINT8|0x00000009
|
| 106 |
|
| 107 | ## This determins how many bytes are read out of files at a time for file operations (type, copy, etc...)
|
Eugene Cohen | 433a21c | 2013-08-08 22:31:54 +0000 | [diff] [blame] | 108 | gEfiShellPkgTokenSpaceGuid.PcdShellFileOperationSize|1000|UINT32|0x0000000A
|
jcarsey | a405b86 | 2010-09-14 05:18:09 +0000 | [diff] [blame] | 109 |
|
mdkinney | 53b1c0c | 2011-05-04 21:43:25 +0000 | [diff] [blame] | 110 | [PcdsFixedAtBuild, PcdsPatchableInModule, PcdsDynamic, PcdsDynamicEx]
|
jcarsey | a405b86 | 2010-09-14 05:18:09 +0000 | [diff] [blame] | 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 determins whether Page Break (-b) defaults to on or off in the shell
|
| 116 | gEfiShellPkgTokenSpaceGuid.PcdShellPageBreakDefault|FALSE|BOOLEAN|0x00000006
|
| 117 |
|
| 118 | ## this flag determins whether insert mode for typing is default (FALSE means typeover)
|
| 119 | gEfiShellPkgTokenSpaceGuid.PcdShellInsertModeDefault|TRUE|BOOLEAN|0x00000007
|
| 120 |
|
| 121 | ## this flag determins the default number of screens kept for history log.
|
| 122 | # the spec defines 3 as the minimum
|
Chris Phillips | 284e034 | 2013-10-18 15:49:23 +0000 | [diff] [blame] | 123 | gEfiShellPkgTokenSpaceGuid.PcdShellScreenLogCount|3|UINT8|0x00000008
|
| 124 |
|
| 125 | ## Unicode string of the shell supplier
|
| 126 | gEfiShellPkgTokenSpaceGuid.PcdShellSupplier|L"EDK II"|VOID*|0x00000010
|