NetworkPkg/NetworkPkg.dec

   1 ## @file
   2 # Network Package.
   3 #
   4 # This package provides network modules that conform to UEFI 2.4 specification.
   5 #
   6 # Copyright (c) 2009 - 2021, Intel Corporation. All rights reserved.<BR>
   7 # (C) Copyright 2015-2020 Hewlett Packard Enterprise Development LP<BR>
   8 #
   9 # SPDX-License-Identifier: BSD-2-Clause-Patent
  10 #
  11 ##
  12
  13 [Defines]
  14   DEC_SPECIFICATION              = 0x00010005
  15   PACKAGE_NAME                   = NetworkPkg
  16   PACKAGE_GUID                   = 947988BE-8D5C-471a-893D-AD181C46BEBB
  17   PACKAGE_VERSION                = 0.98
  18   PACKAGE_UNI_FILE               = NetworkPkg.uni
  19
  20 [Includes]
  21   Include
  22
  23 [LibraryClasses]
  24   ##  @libraryclass  IpIo layer upon EFI IP4 Protocol.
  25   #   This library is only intended to be used by UEFI network stack modules.
  26   IpIoLib|Include/Library/IpIoLib.h
  27
  28   ##  @libraryclass  Basic function for UEFI network stack.
  29   #   This library is only intended to be used by UEFI network stack modules.
  30   NetLib|Include/Library/NetLib.h
  31
  32   ##  @libraryclass  The helper routines to access UDP service.
  33   #   This library is only intended to be used by UEFI network stack modules.
  34   UdpIoLib|Include/Library/UdpIoLib.h
  35
  36   ##  @libraryclass  The helper routines to access TCP service.
  37   #   This library is only intended to be used by UEFI network stack modules.
  38   TcpIoLib|Include/Library/TcpIoLib.h
  39
  40   ##  @libraryclass  The helper routines to access HTTP service.
  41   #   This library is only intended to be used by UEFI network stack modules.
  42   HttpLib|Include/Library/HttpLib.h
  43
  44   ##  @libraryclass  Http IO helper routines for HTTP transfer.
  45   #   This library is only intended to be used by UEFI network stack modules.
  46   HttpIoLib|Include/Library/HttpIoLib.h
  47
  48   ##  @libraryclass  Library for Deferred Procedure Calls.
  49   DpcLib|Include/Library/DpcLib.h
  50
  51 [Guids]
  52   ## Network package token space guid.
  53   # Include/Guid/NetworkPkgTokenSpace.h
  54   gEfiNetworkPkgTokenSpaceGuid  = { 0x40e064b2, 0x0ae0, 0x48b1, { 0xa0, 0x7d, 0xf8, 0xcf, 0x1e, 0x1a, 0x23, 0x10}}
  55
  56   # Include/Guid/Ip6ConfigHii.h
  57   gIp6ConfigNvDataGuid          = { 0x2eea107, 0x98db, 0x400e, { 0x98, 0x30, 0x46, 0xa, 0x15, 0x42, 0xd7, 0x99}}
  58
  59   # Include/Guid/IscsiConfigHii.h
  60   gIScsiConfigGuid              = { 0x4b47d616, 0xa8d6, 0x4552, { 0x9d, 0x44, 0xcc, 0xad, 0x2e, 0xf, 0x4c, 0xf9}}
  61
  62   # Include/Guid/HttpBootConfigHii.h
  63   gHttpBootConfigGuid           = { 0x4d20583a, 0x7765, 0x4e7a, { 0x8a, 0x67, 0xdc, 0xde, 0x74, 0xee, 0x3e, 0xc5 }}
  64
  65   # Include/Guid/TlsAuthConfigHii.h
  66   gTlsAuthConfigGuid            = { 0xb0eae4f8, 0x9a04, 0x4c6d, { 0xa7, 0x48, 0x79, 0x3d, 0xaa, 0xf, 0x65, 0xdf }}
  67
  68   # Include/Guid/TlsAuthentication.h
  69   gEfiTlsCaCertificateGuid      = { 0xfd2340D0, 0x3dab, 0x4349, { 0xa6, 0xc7, 0x3b, 0x4f, 0x12, 0xb4, 0x8e, 0xae }}
  70
  71   # Include/Guid/HttpTlsCipherList.h
  72   gEdkiiHttpTlsCipherListGuid   = { 0x46ddb415, 0x5244, 0x49c7, { 0x93, 0x74, 0xf0, 0xe2, 0x98, 0xe7, 0xd3, 0x86 }}
  73
  74   # Include/Guid/WifiConnectionManagerConfigHii.h
  75   gWifiConfigGuid               = { 0x9f94d327, 0x0b18, 0x4245, { 0x8f, 0xf2, 0x83, 0x2e, 0x30, 0xd, 0x2c, 0xef }}
  76
  77   ## Include/Guid/Ip4Config2Hii.h
  78   gIp4Config2NvDataGuid              = { 0x9b942747, 0x154e, 0x4d29, { 0xa4, 0x36, 0xbf, 0x71, 0x0, 0xc8, 0xb5, 0x3b }}
  79
  80   ## Include/Guid/VlanConfigHii.h
  81   gVlanConfigFormSetGuid             = { 0xd79df6b0, 0xef44, 0x43bd, { 0x97, 0x97, 0x43, 0xe9, 0x3b, 0xcf, 0x5f, 0xa8 }}
  82
  83   ## Include/Guid/Ip4IScsiConfigHii.h
  84   gIp4IScsiConfigGuid                = { 0x6456ed61, 0x3579, 0x41c9, { 0x8a, 0x26, 0x0a, 0x0b, 0xd6, 0x2b, 0x78, 0xfc }}
  85   gIScsiCHAPAuthInfoGuid             = { 0x786ec0ac, 0x65ae, 0x4d1b, { 0xb1, 0x37, 0xd, 0x11, 0xa, 0x48, 0x37, 0x97 }}
  86
  87 [Protocols]
  88   ## Include/Protocol/Dpc.h
  89   gEfiDpcProtocolGuid           = {0x480f8ae9, 0xc46, 0x4aa9,  { 0xbc, 0x89, 0xdb, 0x9f, 0xba, 0x61, 0x98, 0x6 }}
  90
  91   ## Include/Protocol/HttpCallback.h
  92   gEdkiiHttpCallbackProtocolGuid  = {0x611114f1, 0xa37b, 0x4468, {0xa4, 0x36, 0x5b, 0xdd, 0xa1, 0x6a, 0xa2, 0x40}}
  93
  94 [PcdsFixedAtBuild]
  95   ## The max attempt number will be created by iSCSI driver.
  96   # @Prompt Max attempt number.
  97   gEfiNetworkPkgTokenSpaceGuid.PcdMaxIScsiAttemptNumber|0x08|UINT8|0x0000000D
  98
  99   ## The maximum size of total HTTP chunk transfer.
 100   # @Prompt Max size of total HTTP chunk transfer. the default value is 12MB.
 101   gEfiNetworkPkgTokenSpaceGuid.PcdMaxHttpChunkTransfer|0x0C00000|UINT32|0x0000000E
 102
 103 [PcdsFixedAtBuild, PcdsPatchableInModule]
 104   ## Indicates whether HTTP connections (i.e., unsecured) are permitted or not.
 105   # TRUE  - HTTP connections are allowed. Both the "https://" and "http://" URI schemes are permitted.
 106   # FALSE - HTTP connections are denied. Only the "https://" URI scheme is permitted.
 107   # @Prompt Indicates whether HTTP connections are permitted or not.
 108   gEfiNetworkPkgTokenSpaceGuid.PcdAllowHttpConnections|FALSE|BOOLEAN|0x00000008
 109
 110   ## This setting is to specify the MTFTP windowsize used by UEFI PXE driver.
 111   # A value of 0 indicates the default value of windowsize(1).
 112   # A non-zero value will be used as windowsize.
 113   # @Prompt PXE TFTP windowsize.
 114   gEfiNetworkPkgTokenSpaceGuid.PcdPxeTftpWindowSize|0x4|UINT64|0x10000008
 115
 116
 117   ## This setting can override the default TFTP block size. A value of 0 computes
 118   # the default from MTU information. A non-zero value will be used as block size
 119   # in bytes.
 120   # @Prompt TFTP block size.
 121   gEfiNetworkPkgTokenSpaceGuid.PcdTftpBlockSize|0x0|UINT64|0x1000000B
 122
 123   ## Indicates whether SnpDxe driver will create an event that will be notified
 124   # upon gBS->ExitBootServices() call.
 125   # TRUE - Event being triggered upon ExitBootServices call will be created
 126   # FALSE - Event being triggered upon ExitBootServices call will NOT be created
 127   # @Prompt Indicates whether SnpDxe creates event for ExitBootServices() call.
 128   gEfiNetworkPkgTokenSpaceGuid.PcdSnpCreateExitBootServicesEvent|TRUE|BOOLEAN|0x1000000C
 129
 130 [PcdsFixedAtBuild, PcdsPatchableInModule, PcdsDynamic, PcdsDynamicEx]
 131   ## IPv6 DHCP Unique Identifier (DUID) Type configuration (From RFCs 3315 and 6355).
 132   # 01 = DUID Based on Link-layer Address Plus Time [DUID-LLT]
 133   # 04 = UUID-Based DHCPv6 Unique Identifier (DUID-UUID)
 134   # 02 = DUID Assigned by Vendor Based on Enterprise Number [DUID-EN] (not supported)
 135   # 03 = DUID Based on Link-layer Address [DUID-LL] (not supported)
 136   # @Prompt Type Value of Dhcp6 Unique Identifier (DUID).
 137   gEfiNetworkPkgTokenSpaceGuid.PcdDhcp6UidType|4|UINT8|0x10000001
 138
 139   ## Network boot policy to stop UEFI iSCSI if applicable.
 140   # 0x00 = Always use UEFI iSCSI and ignore iSCSI HBA.
 141   # 0x01 = Stop UEFI iSCSI if iSCSI HBA adapter produces AIP protocol with Network Boot.
 142   # 0x02 = Stop UEFI iSCSI if iSCSI HBA adapter supports booting from iSCSI IPv4 targets.
 143   # 0x04 = Stop UEFI iSCSI if iSCSI HBA adapter supports booting from iSCSI IPv6 targets.
 144   # 0x08 = Stop UEFI iSCSI if iSCSI HBA adapter supports an offload engine for iSCSI boot.
 145   # 0x10 = Stop UEFI iSCSI if iSCSI HBA adapter supports multipath I/O for iSCSI boot.
 146   # 0x20 = Stop UEFI iSCSI if iSCSI HBA adapter is currently configured to boot from iSCSI IPv4 targets.
 147   # 0x40 = Stop UEFI iSCSI if iSCSI HBA adapter is currently configured to boot from iSCSI IPv6 targets.
 148   # 0xFF = Always use iSCSI HBA and ignore UEFI iSCSI.
 149   # @Prompt Type Value of network boot policy used in iSCSI.
 150   gEfiNetworkPkgTokenSpaceGuid.PcdIScsiAIPNetworkBootPolicy|0x08|UINT8|0x10000007
 151
 152   ## IPv4 PXE support
 153   # 0x01 = PXE Enabled
 154   # 0x00 = PXE Disabled
 155   gEfiNetworkPkgTokenSpaceGuid.PcdIPv4PXESupport|0x01|UINT8|0x10000009
 156
 157   ## IPv6 PXE support
 158   # 0x01 = PXE Enabled
 159   # 0x00 = PXE Disabled
 160   gEfiNetworkPkgTokenSpaceGuid.PcdIPv6PXESupport|0x01|UINT8|0x1000000a
 161
 162   ## The Timeout value of HTTP IO.
 163   # @Prompt The Timeout value of HTTP Io. Default value is 5000.
 164   gEfiNetworkPkgTokenSpaceGuid.PcdHttpIoTimeout|5000|UINT32|0x0000000F
 165
 166   ## The Retry Interval of HTTP DNS in seconds. If the Retry Interval is less than
 167   # DNS_DEFAULT_TIMEOUT, then use the DNS_DEFAULT_TIMEOUT.
 168   # @Prompt The value of Retry Interval. Default value is 0
 169   gEfiNetworkPkgTokenSpaceGuid.PcdHttpDnsRetryInterval|0|UINT32|0x00000010
 170
 171   ## The Retry Count of HTTP DNS if no DNS response received after Retry Interval.
 172   # @Prompt The value of Retry Count,  Default value is 0.
 173   gEfiNetworkPkgTokenSpaceGuid.PcdHttpDnsRetryCount|0|UINT32|0x00000011
 174
 175 [UserExtensions.TianoCore."ExtraFiles"]
 176   NetworkPkgExtra.uni