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