[mirror_edk2.git] / ShellPkg / ShellPkg.dec

## @file ShellPkg.dec\r
#\r
# This Package provides all definitions for EFI and UEFI Shell\r
#\r
# (C) Copyright 2013-2014, Hewlett-Packard Development Company, L.P.\r
# Copyright (c) 2009 - 2014, Intel Corporation. All rights reserved.<BR>\r
#\r
# This program and the accompanying materials are licensed and made available under\r
# the terms and conditions of the BSD License which accompanies this distribution.\r
# The full text of the license may be found at\r
# http://opensource.org/licenses/bsd-license.php\r
#\r
# THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
# WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
#\r
##\r
\r
[Defines]\r
  DEC_SPECIFICATION              = 0x00010005\r
  PACKAGE_NAME                   = ShellPkg\r
  PACKAGE_GUID                   = 9FB7587C-93F7-40a7-9C04-FD7BA94EE646\r
  PACKAGE_VERSION                = 0.50\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  provides EFI_FILE_HANDLE services used by Shell and ShellLib\r
  FileHandleLib|Include/Library/FileHandleLib.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 sorting functions\r
  SortLib|Include/Library/SortLib.h\r
\r
  ## @libraryclass   Provides advanced parsing functions\r
  HandleParsingLib|Include/Library/HandleParsingLib.h\r
\r
  ## @libraryclass   Provides path manipulation functions\r
  PathLib|Include/Library/PathLib.h\r
\r
  ## @libraryclass   provides BCFG command\r
  BcfgCommandLib|Include/Library/BcfgCommandLib.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
  gShellBcfgHiiGuid               = {0x5f5f605d, 0x1583, 0x4a2d, {0xa6, 0xb2, 0xeb, 0x12, 0xda, 0xb4, 0xa2, 0xb6}}\r
\r
[Protocols]\r
  gEfiShellProtocolGuid               = {0x6302d008, 0x7f9b, 0x4f30, {0x87, 0xac, 0x60, 0xc9, 0xfe, 0xf5, 0xda, 0x4e}}\r
  gEfiShellParametersProtocolGuid     = {0x752f3136, 0x4e16, 0x4fdc, {0xa2, 0x2a, 0xe5, 0xf4, 0x68, 0x12, 0xf4, 0xca}}\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
  gEfiShellDynamicCommandProtocolGuid = {0x3c7200e9, 0x005f, 0x4ea4, {0x87, 0xde, 0xa3, 0xdf, 0xac, 0x8a, 0x27, 0xc3}}\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
  gEfiShellPkgTokenSpaceGuid.PcdShellLibAutoInitialize|TRUE|BOOLEAN|0x00000005\r
\r
  ## This is the max buffer for ShellLib, FileHandleLib, 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
  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 determins how many bytes are read out of files at a time for file operations (type, copy, etc...)\r
  gEfiShellPkgTokenSpaceGuid.PcdShellFileOperationSize|1000|UINT32|0x0000000A\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 determins whether Page Break (-b) defaults to on or off in the shell\r
  gEfiShellPkgTokenSpaceGuid.PcdShellPageBreakDefault|FALSE|BOOLEAN|0x00000006\r
\r
  ## this flag determins whether insert mode for typing is default (FALSE means typeover)\r
  gEfiShellPkgTokenSpaceGuid.PcdShellInsertModeDefault|TRUE|BOOLEAN|0x00000007\r
\r
  ## this flag determins 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 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
Commit	Line	Data
a405b86d	1	## @file ShellPkg.dec\r
94b17fa1	2	#\r
	3	# This Package provides all definitions for EFI and UEFI Shell\r
	4	#\r
b8a13d73	5	# (C) Copyright 2013-2014, Hewlett-Packard Development Company, L.P.\r
e66e86ee	6	# Copyright (c) 2009 - 2014, Intel Corporation. All rights reserved.<BR>\r
94b17fa1	7	#\r
94b17fa1	8	# This program and the accompanying materials are licensed and made available under\r
	9	# the terms and conditions of the BSD License which accompanies this distribution.\r
	10	# The full text of the license may be found at\r
	11	# http://opensource.org/licenses/bsd-license.php\r
	12	#\r
	13	# THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
	14	# WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
	15	#\r
	16	##\r
	17	\r
94b17fa1	18	[Defines]\r
	19	DEC_SPECIFICATION = 0x00010005\r
	20	PACKAGE_NAME = ShellPkg\r
	21	PACKAGE_GUID = 9FB7587C-93F7-40a7-9C04-FD7BA94EE646\r
b714ecb8	22	PACKAGE_VERSION = 0.50\r
94b17fa1	23	\r
edd88d5a	24	[Includes]\r
94b17fa1	25	Include\r
94b17fa1	26	\r
edd88d5a	27	[LibraryClasses]\r
a405b86d	28	## @libraryclass Provides most Shell APIs. Only available for Shell applications\r
94b17fa1	29	ShellLib\|Include/Library/ShellLib.h\r
94b17fa1	30	\r
a405b86d	31	## @libraryclass Provides shell internal support Only available for shell internal commands\r
	32	ShellCommandLib\|Include/Library/ShellCommandLib.h\r
	33	\r
	34	## @libraryclass provides EFI_FILE_HANDLE services used by Shell and ShellLib\r
d2b4564b	35	FileHandleLib\|Include/Library/FileHandleLib.h\r
a405b86d	36	\r
4983ca93	37	## @libraryclass Allows for a shell application to have a C style entry point\r
b1f95a06	38	ShellCEntryLib\|Include/Library/ShellCEntryLib.h\r
d2b4564b	39	\r
4983ca93	40	## @libraryclass Provides sorting functions\r
a405b86d	41	SortLib\|Include/Library/SortLib.h\r
4983ca93	42	\r
a405b86d	43	## @libraryclass Provides advanced parsing functions\r
a405b86d	44	HandleParsingLib\|Include/Library/HandleParsingLib.h\r
b714ecb8	45	\r
ab94587a	46	## @libraryclass Provides path manipulation functions\r
ab94587a	47	PathLib\|Include/Library/PathLib.h\r
d2b4564b	48	\r
7b01f0f3 JC	49	## @libraryclass provides BCFG command\r
	50	BcfgCommandLib\|Include/Library/BcfgCommandLib.h\r
	51	\r
edd88d5a	52	[Guids]\r
94b17fa1	53	gEfiShellEnvironment2ExtGuid = {0xd2c18636, 0x40e5, 0x4eb5, {0xa3, 0x1b, 0x36, 0x69, 0x5f, 0xd4, 0x2c, 0x87}}\r
284e034f	54	gEfiShellPkgTokenSpaceGuid = {0x171e9188, 0x31d3, 0x40f5, {0xb1, 0x0c, 0x53, 0x9b, 0x2d, 0xb9, 0x40, 0xcd}}\r
a405b86d	55	gShellVariableGuid = {0x158def5a, 0xf656, 0x419c, {0xb0, 0x27, 0x7a, 0x31, 0x92, 0xc0, 0x79, 0xd2}}\r
	56	gShellMapGuid = {0x51271e13, 0x7de3, 0x43af, {0x8b, 0xc2, 0x71, 0xad, 0x3b, 0x82, 0x43, 0x25}}\r
	57	gShellAliasGuid = {0x0053d9d6, 0x2659, 0x4599, {0xa2, 0x6b, 0xef, 0x45, 0x36, 0xe6, 0x31, 0xa9}}\r
bca163ff LG	58	gHandleParsingHiiGuid = {0xb8969637, 0x81de, 0x43af, {0xbc, 0x9a, 0x24, 0xd9, 0x89, 0x13, 0xf2, 0xf6}}\r
	59	gShellDebug1HiiGuid = {0x25f200aa, 0xd3cb, 0x470a, {0xbf, 0x51, 0xe7, 0xd1, 0x62, 0xd2, 0x2e, 0x6f}}\r
	60	gShellDriver1HiiGuid = {0xaf0b742, 0x63ec, 0x45bd, {0x8d, 0xb6, 0x71, 0xad, 0x7f, 0x2f, 0xe8, 0xe8}}\r
	61	gShellInstall1HiiGuid = {0x7d574d54, 0xd364, 0x4d4a, {0x95, 0xe3, 0x49, 0x45, 0xdb, 0x7a, 0xd3, 0xee}}\r
	62	gShellLevel1HiiGuid = {0xdec5daa4, 0x6781, 0x4820, {0x9c, 0x63, 0xa7, 0xb0, 0xe4, 0xf1, 0xdb, 0x31}}\r
	63	gShellLevel2HiiGuid = {0xf95a7ccc, 0x4c55, 0x4426, {0xa7, 0xb4, 0xdc, 0x89, 0x61, 0x95, 0xb, 0xae}}\r
	64	gShellLevel3HiiGuid = {0x4344558d, 0x4ef9, 0x4725, {0xb1, 0xe4, 0x33, 0x76, 0xe8, 0xd6, 0x97, 0x4f}}\r
	65	gShellNetwork1HiiGuid = {0xf3d301bb, 0xf4a5, 0x45a8, {0xb0, 0xb7, 0xfa, 0x99, 0x9c, 0x62, 0x37, 0xae}}\r
7b01f0f3	66	gShellBcfgHiiGuid = {0x5f5f605d, 0x1583, 0x4a2d, {0xa6, 0xb2, 0xeb, 0x12, 0xda, 0xb4, 0xa2, 0xb6}}\r
b714ecb8	67	\r
edd88d5a	68	[Protocols]\r
e66e86ee JC	69	gEfiShellProtocolGuid = {0x6302d008, 0x7f9b, 0x4f30, {0x87, 0xac, 0x60, 0xc9, 0xfe, 0xf5, 0xda, 0x4e}}\r
	70	gEfiShellParametersProtocolGuid = {0x752f3136, 0x4e16, 0x4fdc, {0xa2, 0x2a, 0xe5, 0xf4, 0x68, 0x12, 0xf4, 0xca}}\r
	71	gEfiShellEnvironment2Guid = {0x47c7b221, 0xc42a, 0x11d2, {0x8e, 0x57, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b}}\r
	72	gEfiShellInterfaceGuid = {0x47c7b223, 0xc42a, 0x11d2, {0x8e, 0x57, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b}}\r
b8a13d73	73	gEfiShellDynamicCommandProtocolGuid = {0x3c7200e9, 0x005f, 0x4ea4, {0x87, 0xde, 0xa3, 0xdf, 0xac, 0x8a, 0x27, 0xc3}}\r
94b17fa1	74	\r
edd88d5a	75	[PcdsFeatureFlag]\r
	76	## This flag is used to control whether the shell includes NT32 platform Guids\r
	77	# and thereby prevents dependancy on that Pkg\r
	78	gEfiShellPkgTokenSpaceGuid.PcdShellIncludeNtGuids\|TRUE\|BOOLEAN\|0x0000000E\r
	79	\r
	80	## This flag is used to control HII required by the shell\r
	81	gEfiShellPkgTokenSpaceGuid.PcdShellRequireHiiPlatform\|TRUE\|BOOLEAN\|0x00000003\r
	82	\r
	83	## This flag is used to control HII required by the shell\r
	84	gEfiShellPkgTokenSpaceGuid.PcdShellSupportFrameworkHii\|FALSE\|BOOLEAN\|0x00000004\r
b714ecb8	85	\r
edd88d5a	86	## This flag forces the shell to present a user console. Allows for earlier debugging of platforms.\r
	87	gEfiShellPkgTokenSpaceGuid.PcdShellForceConsole\|FALSE\|BOOLEAN\|0x0000000F\r
	88	\r
b1f95a06	89	[PcdsFixedAtBuild]\r
d2b4564b	90	## This flag is used to control initialization of the shell library\r
a405b86d	91	# This should be FALSE for compiling the shell application itself only.\r
02864f59	92	gEfiShellPkgTokenSpaceGuid.PcdShellLibAutoInitialize\|TRUE\|BOOLEAN\|0x00000005\r
02864f59	93	\r
a405b86d	94	## This is the max buffer for ShellLib, FileHandleLib, and internal Shell printings.\r
	95	gEfiShellPkgTokenSpaceGuid.PcdShellPrintBufferSize\|16000\|UINT16\|0x0000000C\r
	96	\r
	97	## This flag is used to control the commands available in the shell\r
	98	gEfiShellPkgTokenSpaceGuid.PcdShellSupportLevel\|3\|UINT8\|0x00000001\r
	99	\r
	100	## This flag is used to control the profiles available in the shell\r
	101	# don't forget to update the text file if you change this.\r
	102	# bit 0 = Drivers1\r
	103	# bit 1 = Debug1\r
	104	# bit 2 = Install1\r
	105	# bit 3 = Network1\r
	106	gEfiShellPkgTokenSpaceGuid.PcdShellProfileMask\|0xFF\|UINT8\|0x0000000D\r
	107	\r
	108	## This is the character count for allocation for consistent mappings\r
	109	gEfiShellPkgTokenSpaceGuid.PcdShellMapNameLength\|50\|UINT8\|0x00000009\r
	110	\r
	111	## This determins how many bytes are read out of files at a time for file operations (type, copy, etc...)\r
433a21cb	112	gEfiShellPkgTokenSpaceGuid.PcdShellFileOperationSize\|1000\|UINT32\|0x0000000A\r
a405b86d	113	\r
53b1c0c1	114	[PcdsFixedAtBuild, PcdsPatchableInModule, PcdsDynamic, PcdsDynamicEx]\r
a405b86d	115	## This flag is used to control the protocols produced by the shell\r
	116	# If TRUE the shell will produce EFI_SHELL_ENVIRONMENT2 and EFI_SHELL_INTERFACE\r
	117	gEfiShellPkgTokenSpaceGuid.PcdShellSupportOldProtocols\|FALSE\|BOOLEAN\|0x00000002\r
	118	\r
	119	## this flag determins whether Page Break (-b) defaults to on or off in the shell\r
	120	gEfiShellPkgTokenSpaceGuid.PcdShellPageBreakDefault\|FALSE\|BOOLEAN\|0x00000006\r
02864f59	121	\r
a405b86d	122	## this flag determins whether insert mode for typing is default (FALSE means typeover)\r
a405b86d	123	gEfiShellPkgTokenSpaceGuid.PcdShellInsertModeDefault\|TRUE\|BOOLEAN\|0x00000007\r
02864f59	124	\r
a405b86d	125	## this flag determins the default number of screens kept for history log.\r
a405b86d	126	# the spec defines 3 as the minimum\r
284e034f CP	127	gEfiShellPkgTokenSpaceGuid.PcdShellScreenLogCount\|3\|UINT8\|0x00000008\r
	128	\r
	129	## Unicode string of the shell supplier\r
	130	gEfiShellPkgTokenSpaceGuid.PcdShellSupplier\|L"EDK II"\|VOID*\|0x00000010\r
9b589522 JC	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