[mirror_edk2.git] / ShellPkg / ShellPkg.dec

## @file ShellPkg.dec\r
#\r
# This Package provides all definitions for EFI and UEFI Shell\r
#\r
# Copyright (c) 2009 - 2011, 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.40\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
[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
  \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
\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|UINT16|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
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
53b1c0c1	5	# Copyright (c) 2009 - 2011, Intel Corporation. All rights reserved.<BR>\r
94b17fa1	6	#\r
94b17fa1	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
94b17fa1	17	[Defines]\r
	18	DEC_SPECIFICATION = 0x00010005\r
	19	PACKAGE_NAME = ShellPkg\r
	20	PACKAGE_GUID = 9FB7587C-93F7-40a7-9C04-FD7BA94EE646\r
a405b86d	21	PACKAGE_VERSION = 0.40\r
94b17fa1	22	\r
edd88d5a	23	[Includes]\r
94b17fa1	24	Include\r
94b17fa1	25	\r
edd88d5a	26	[LibraryClasses]\r
a405b86d	27	## @libraryclass Provides most Shell APIs. Only available for Shell applications\r
94b17fa1	28	ShellLib\|Include/Library/ShellLib.h\r
94b17fa1	29	\r
a405b86d	30	## @libraryclass Provides shell internal support Only available for shell internal commands\r
	31	ShellCommandLib\|Include/Library/ShellCommandLib.h\r
	32	\r
	33	## @libraryclass provides EFI_FILE_HANDLE services used by Shell and ShellLib\r
d2b4564b	34	FileHandleLib\|Include/Library/FileHandleLib.h\r
a405b86d	35	\r
4983ca93	36	## @libraryclass Allows for a shell application to have a C style entry point\r
b1f95a06	37	ShellCEntryLib\|Include/Library/ShellCEntryLib.h\r
d2b4564b	38	\r
4983ca93	39	## @libraryclass Provides sorting functions\r
a405b86d	40	SortLib\|Include/Library/SortLib.h\r
4983ca93	41	\r
a405b86d	42	## @libraryclass Provides advanced parsing functions\r
a405b86d	43	HandleParsingLib\|Include/Library/HandleParsingLib.h\r
ab94587a	44	\r
	45	## @libraryclass Provides path manipulation functions\r
	46	PathLib\|Include/Library/PathLib.h\r
d2b4564b	47	\r
edd88d5a	48	[Guids]\r
94b17fa1	49	gEfiShellEnvironment2ExtGuid = {0xd2c18636, 0x40e5, 0x4eb5, {0xa3, 0x1b, 0x36, 0x69, 0x5f, 0xd4, 0x2c, 0x87}}\r
a405b86d	50	gEfiShellPkgTokenSpaceGuid = {0x171e9188, 0x31d3, 0x40f5, {0xb1, 0x0c, 0x53, 0x9b, 0x2d, 0xb9, 0x40, 0xcd}}\r
	51	gShellVariableGuid = {0x158def5a, 0xf656, 0x419c, {0xb0, 0x27, 0x7a, 0x31, 0x92, 0xc0, 0x79, 0xd2}}\r
	52	gShellMapGuid = {0x51271e13, 0x7de3, 0x43af, {0x8b, 0xc2, 0x71, 0xad, 0x3b, 0x82, 0x43, 0x25}}\r
	53	gShellAliasGuid = {0x0053d9d6, 0x2659, 0x4599, {0xa2, 0x6b, 0xef, 0x45, 0x36, 0xe6, 0x31, 0xa9}}\r
bca163ff LG	54	gHandleParsingHiiGuid = {0xb8969637, 0x81de, 0x43af, {0xbc, 0x9a, 0x24, 0xd9, 0x89, 0x13, 0xf2, 0xf6}}\r
	55	gShellDebug1HiiGuid = {0x25f200aa, 0xd3cb, 0x470a, {0xbf, 0x51, 0xe7, 0xd1, 0x62, 0xd2, 0x2e, 0x6f}}\r
	56	gShellDriver1HiiGuid = {0xaf0b742, 0x63ec, 0x45bd, {0x8d, 0xb6, 0x71, 0xad, 0x7f, 0x2f, 0xe8, 0xe8}}\r
	57	gShellInstall1HiiGuid = {0x7d574d54, 0xd364, 0x4d4a, {0x95, 0xe3, 0x49, 0x45, 0xdb, 0x7a, 0xd3, 0xee}}\r
	58	gShellLevel1HiiGuid = {0xdec5daa4, 0x6781, 0x4820, {0x9c, 0x63, 0xa7, 0xb0, 0xe4, 0xf1, 0xdb, 0x31}}\r
	59	gShellLevel2HiiGuid = {0xf95a7ccc, 0x4c55, 0x4426, {0xa7, 0xb4, 0xdc, 0x89, 0x61, 0x95, 0xb, 0xae}}\r
	60	gShellLevel3HiiGuid = {0x4344558d, 0x4ef9, 0x4725, {0xb1, 0xe4, 0x33, 0x76, 0xe8, 0xd6, 0x97, 0x4f}}\r
	61	gShellNetwork1HiiGuid = {0xf3d301bb, 0xf4a5, 0x45a8, {0xb0, 0xb7, 0xfa, 0x99, 0x9c, 0x62, 0x37, 0xae}}\r
	62	\r
edd88d5a	63	[Protocols]\r
94b17fa1	64	gEfiShellProtocolGuid = {0x6302d008, 0x7f9b, 0x4f30, {0x87, 0xac, 0x60, 0xc9, 0xfe, 0xf5, 0xda, 0x4e}}\r
	65	gEfiShellParametersProtocolGuid = {0x752f3136, 0x4e16, 0x4fdc, {0xa2, 0x2a, 0xe5, 0xf4, 0x68, 0x12, 0xf4, 0xca}}\r
	66	gEfiShellEnvironment2Guid = {0x47c7b221, 0xc42a, 0x11d2, {0x8e, 0x57, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b}}\r
	67	gEfiShellInterfaceGuid = {0x47c7b223, 0xc42a, 0x11d2, {0x8e, 0x57, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b}}\r
	68	\r
edd88d5a	69	[PcdsFeatureFlag]\r
	70	## This flag is used to control whether the shell includes NT32 platform Guids\r
	71	# and thereby prevents dependancy on that Pkg\r
	72	gEfiShellPkgTokenSpaceGuid.PcdShellIncludeNtGuids\|TRUE\|BOOLEAN\|0x0000000E\r
	73	\r
	74	## This flag is used to control HII required by the shell\r
	75	gEfiShellPkgTokenSpaceGuid.PcdShellRequireHiiPlatform\|TRUE\|BOOLEAN\|0x00000003\r
	76	\r
	77	## This flag is used to control HII required by the shell\r
	78	gEfiShellPkgTokenSpaceGuid.PcdShellSupportFrameworkHii\|FALSE\|BOOLEAN\|0x00000004\r
	79	\r
	80	## This flag forces the shell to present a user console. Allows for earlier debugging of platforms.\r
	81	gEfiShellPkgTokenSpaceGuid.PcdShellForceConsole\|FALSE\|BOOLEAN\|0x0000000F\r
	82	\r
b1f95a06	83	[PcdsFixedAtBuild]\r
d2b4564b	84	## This flag is used to control initialization of the shell library\r
a405b86d	85	# This should be FALSE for compiling the shell application itself only.\r
02864f59	86	gEfiShellPkgTokenSpaceGuid.PcdShellLibAutoInitialize\|TRUE\|BOOLEAN\|0x00000005\r
02864f59	87	\r
a405b86d	88	## This is the max buffer for ShellLib, FileHandleLib, and internal Shell printings.\r
	89	gEfiShellPkgTokenSpaceGuid.PcdShellPrintBufferSize\|16000\|UINT16\|0x0000000C\r
	90	\r
	91	## This flag is used to control the commands available in the shell\r
	92	gEfiShellPkgTokenSpaceGuid.PcdShellSupportLevel\|3\|UINT8\|0x00000001\r
	93	\r
	94	## This flag is used to control the profiles available in the shell\r
	95	# don't forget to update the text file if you change this.\r
	96	# bit 0 = Drivers1\r
	97	# bit 1 = Debug1\r
	98	# bit 2 = Install1\r
	99	# bit 3 = Network1\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 determins how many bytes are read out of files at a time for file operations (type, copy, etc...)\r
	106	gEfiShellPkgTokenSpaceGuid.PcdShellFileOperationSize\|1000\|UINT16\|0x0000000A\r
	107	\r
53b1c0c1	108	[PcdsFixedAtBuild, PcdsPatchableInModule, PcdsDynamic, PcdsDynamicEx]\r
a405b86d	109	## This flag is used to control the protocols produced by the shell\r
	110	# If TRUE the shell will produce EFI_SHELL_ENVIRONMENT2 and EFI_SHELL_INTERFACE\r
	111	gEfiShellPkgTokenSpaceGuid.PcdShellSupportOldProtocols\|FALSE\|BOOLEAN\|0x00000002\r
	112	\r
	113	## this flag determins whether Page Break (-b) defaults to on or off in the shell\r
	114	gEfiShellPkgTokenSpaceGuid.PcdShellPageBreakDefault\|FALSE\|BOOLEAN\|0x00000006\r
02864f59	115	\r
a405b86d	116	## this flag determins whether insert mode for typing is default (FALSE means typeover)\r
a405b86d	117	gEfiShellPkgTokenSpaceGuid.PcdShellInsertModeDefault\|TRUE\|BOOLEAN\|0x00000007\r
02864f59	118	\r
a405b86d	119	## this flag determins the default number of screens kept for history log.\r
	120	# the spec defines 3 as the minimum\r
	121	gEfiShellPkgTokenSpaceGuid.PcdShellScreenLogCount\|3\|UINT8\|0x00000008