Home | History | Annotate | Download | only in ShellPkg
      1 ## @file ShellPkg.dec

      2 # This Package provides all definitions for EFI and UEFI Shell

      3 #

      4 # (C) Copyright 2013-2014 Hewlett-Packard Development Company, L.P.<BR>

      5 # Copyright (c) 2009 - 2015, Intel Corporation. All rights reserved.<BR>

      6 #

      7 # This program and the accompanying materials are licensed and made available under

      8 # the terms and conditions of the BSD License which accompanies this distribution.

      9 # The full text of the license may be found at

     10 # http://opensource.org/licenses/bsd-license.php

     11 #

     12 # THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,

     13 # WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

     14 #

     15 ##

     16 
     17 [Defines]
     18   DEC_SPECIFICATION              = 0x00010005
     19   PACKAGE_NAME                   = ShellPkg
     20   PACKAGE_GUID                   = C1014BB7-4092-43D4-984F-0738EB424DBF
     21   PACKAGE_VERSION                = 1.0
     22 
     23 [Includes]
     24   Include
     25 
     26 [LibraryClasses]
     27   ##  @libraryclass  Provides most Shell APIs. Only available for Shell applications

     28   ShellLib|Include/Library/ShellLib.h
     29 
     30   ##  @libraryclass  Provides shell internal support Only available for shell internal commands

     31   ShellCommandLib|Include/Library/ShellCommandLib.h
     32 
     33   ## @libraryclass   Allows for a shell application to have a C style entry point

     34   ShellCEntryLib|Include/Library/ShellCEntryLib.h
     35 
     36   ## @libraryclass   Provides advanced parsing functions

     37   HandleParsingLib|Include/Library/HandleParsingLib.h
     38 
     39   ## @libraryclass   provides BCFG command

     40   BcfgCommandLib|Include/Library/BcfgCommandLib.h
     41 
     42 [Guids]
     43   gEfiShellEnvironment2ExtGuid    = {0xd2c18636, 0x40e5, 0x4eb5, {0xa3, 0x1b, 0x36, 0x69, 0x5f, 0xd4, 0x2c, 0x87}}
     44   gEfiShellPkgTokenSpaceGuid      = {0x171e9188, 0x31d3, 0x40f5, {0xb1, 0x0c, 0x53, 0x9b, 0x2d, 0xb9, 0x40, 0xcd}}
     45   gShellVariableGuid              = {0x158def5a, 0xf656, 0x419c, {0xb0, 0x27, 0x7a, 0x31, 0x92, 0xc0, 0x79, 0xd2}}
     46   gShellMapGuid                   = {0x51271e13, 0x7de3, 0x43af, {0x8b, 0xc2, 0x71, 0xad, 0x3b, 0x82, 0x43, 0x25}}
     47   gShellAliasGuid                 = {0x0053d9d6, 0x2659, 0x4599, {0xa2, 0x6b, 0xef, 0x45, 0x36, 0xe6, 0x31, 0xa9}}
     48   gHandleParsingHiiGuid           = {0xb8969637, 0x81de, 0x43af, {0xbc, 0x9a, 0x24, 0xd9, 0x89, 0x13, 0xf2, 0xf6}}
     49   gShellDebug1HiiGuid             = {0x25f200aa, 0xd3cb, 0x470a, {0xbf, 0x51, 0xe7, 0xd1, 0x62, 0xd2, 0x2e, 0x6f}}
     50   gShellDriver1HiiGuid            = {0xaf0b742, 0x63ec, 0x45bd, {0x8d, 0xb6, 0x71, 0xad, 0x7f, 0x2f, 0xe8, 0xe8}}
     51   gShellInstall1HiiGuid           = {0x7d574d54, 0xd364, 0x4d4a, {0x95, 0xe3, 0x49, 0x45, 0xdb, 0x7a, 0xd3, 0xee}}
     52   gShellLevel1HiiGuid             = {0xdec5daa4, 0x6781, 0x4820, {0x9c, 0x63, 0xa7, 0xb0, 0xe4, 0xf1, 0xdb, 0x31}}
     53   gShellLevel2HiiGuid             = {0xf95a7ccc, 0x4c55, 0x4426, {0xa7, 0xb4, 0xdc, 0x89, 0x61, 0x95, 0xb, 0xae}}
     54   gShellLevel3HiiGuid             = {0x4344558d, 0x4ef9, 0x4725, {0xb1, 0xe4, 0x33, 0x76, 0xe8, 0xd6, 0x97, 0x4f}}
     55   gShellNetwork1HiiGuid           = {0xf3d301bb, 0xf4a5, 0x45a8, {0xb0, 0xb7, 0xfa, 0x99, 0x9c, 0x62, 0x37, 0xae}}
     56   gShellTftpHiiGuid               = {0x738a9314, 0x82c1, 0x4592, {0x8f, 0xf7, 0xc1, 0xbd, 0xf1, 0xb2, 0x0e, 0xd4}}
     57   gShellBcfgHiiGuid               = {0x5f5f605d, 0x1583, 0x4a2d, {0xa6, 0xb2, 0xeb, 0x12, 0xda, 0xb4, 0xa2, 0xb6}}
     58 
     59 [Protocols]
     60   gEfiShellProtocolGuid               = {0x6302d008, 0x7f9b, 0x4f30, {0x87, 0xac, 0x60, 0xc9, 0xfe, 0xf5, 0xda, 0x4e}}
     61   gEfiShellParametersProtocolGuid     = {0x752f3136, 0x4e16, 0x4fdc, {0xa2, 0x2a, 0xe5, 0xf4, 0x68, 0x12, 0xf4, 0xca}}
     62   gEfiShellEnvironment2Guid           = {0x47c7b221, 0xc42a, 0x11d2, {0x8e, 0x57, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b}}
     63   gEfiShellInterfaceGuid              = {0x47c7b223, 0xc42a, 0x11d2, {0x8e, 0x57, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b}}
     64   gEfiShellDynamicCommandProtocolGuid = {0x3c7200e9, 0x005f, 0x4ea4, {0x87, 0xde, 0xa3, 0xdf, 0xac, 0x8a, 0x27, 0xc3}}
     65 
     66 [PcdsFeatureFlag]
     67   ## This flag is used to control whether the shell includes NT32 platform Guids

     68   #  and thereby prevents dependancy on that Pkg

     69   gEfiShellPkgTokenSpaceGuid.PcdShellIncludeNtGuids|TRUE|BOOLEAN|0x0000000E
     70 
     71   ## This flag is used to control HII required by the shell

     72   gEfiShellPkgTokenSpaceGuid.PcdShellRequireHiiPlatform|TRUE|BOOLEAN|0x00000003
     73 
     74   ## This flag is used to control HII required by the shell

     75   gEfiShellPkgTokenSpaceGuid.PcdShellSupportFrameworkHii|FALSE|BOOLEAN|0x00000004
     76 
     77   ## This flag forces the shell to present a user console.  Allows for earlier debugging of platforms.

     78   gEfiShellPkgTokenSpaceGuid.PcdShellForceConsole|FALSE|BOOLEAN|0x0000000F
     79 
     80 [PcdsFixedAtBuild]
     81   ## This flag is used to control initialization of the shell library

     82   #  This should be FALSE for compiling the shell application itself only.

     83   gEfiShellPkgTokenSpaceGuid.PcdShellLibAutoInitialize|TRUE|BOOLEAN|0x00000005
     84 
     85   ## This is the max buffer for ShellLib and internal Shell printings.

     86   gEfiShellPkgTokenSpaceGuid.PcdShellPrintBufferSize|16000|UINT16|0x0000000C
     87 
     88   ## This flag is used to control the commands available in the shell

     89   gEfiShellPkgTokenSpaceGuid.PcdShellSupportLevel|3|UINT8|0x00000001
     90 
     91   ## This flag is used to control the profiles available in the shell

     92   #  don't forget to update the text file if you change this.

     93   #  bit 0 = Drivers1

     94   #  bit 1 = Debug1

     95   #  bit 2 = Install1

     96   #  bit 3 = Network1

     97   gEfiShellPkgTokenSpaceGuid.PcdShellProfileMask|0xFF|UINT8|0x0000000D
     98 
     99   ## This is the character count for allocation for consistent mappings

    100   gEfiShellPkgTokenSpaceGuid.PcdShellMapNameLength|50|UINT8|0x00000009
    101 
    102   ## This determines how many bytes are read out of files at a time for file operations (type, copy, etc...)

    103   gEfiShellPkgTokenSpaceGuid.PcdShellFileOperationSize|0x1000|UINT32|0x0000000A
    104   
    105   ## This determines the max count of history commands

    106   gEfiShellPkgTokenSpaceGuid.PcdShellMaxHistoryCommandCount|0x0020|UINT16|0x00000014
    107 
    108 [PcdsFixedAtBuild, PcdsPatchableInModule, PcdsDynamic, PcdsDynamicEx]
    109   ## This flag is used to control the protocols produced by the shell

    110   #  If TRUE the shell will produce EFI_SHELL_ENVIRONMENT2 and EFI_SHELL_INTERFACE

    111   gEfiShellPkgTokenSpaceGuid.PcdShellSupportOldProtocols|FALSE|BOOLEAN|0x00000002
    112 
    113   ## this flag determines whether Page Break (-b) defaults to on or off in the shell

    114   gEfiShellPkgTokenSpaceGuid.PcdShellPageBreakDefault|FALSE|BOOLEAN|0x00000006
    115 
    116   ## this flag determines whether insert mode for typing is default (FALSE means typeover)

    117   gEfiShellPkgTokenSpaceGuid.PcdShellInsertModeDefault|TRUE|BOOLEAN|0x00000007
    118 
    119   ## this flag determines the default number of screens kept for history log.

    120   #  the spec defines 3 as the minimum

    121   gEfiShellPkgTokenSpaceGuid.PcdShellScreenLogCount|3|UINT8|0x00000008
    122 
    123   ## Unicode string of the shell supplier

    124   gEfiShellPkgTokenSpaceGuid.PcdShellSupplier|L"EDK II"|VOID*|0x00000010
    125 
    126   ## Do extended decode of USB for determining media type

    127   gEfiShellPkgTokenSpaceGuid.PcdUsbExtendedDecode|TRUE|BOOLEAN|0x00000011
    128 
    129   ## Do iSCSI decode for map names.

    130   # This is disabled by default due to the length of generated strings

    131   gEfiShellPkgTokenSpaceGuid.PcdShellDecodeIScsiMapNames|FALSE|BOOLEAN|0x00000012
    132 
    133   ## Controls Extended decode for Vendor device path nodes for map names.

    134   # Up to this many bytes of vendor specific data will be used. Default is 0

    135   # (disabled).

    136   gEfiShellPkgTokenSpaceGuid.PcdShellVendorExtendedDecode|0|UINT32|0x00000013
    137