[mirror_edk2.git] / ShellPkg / ShellPkg.dec

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