NetworkPkg/NetworkDefines.dsc.inc

   1 ## @file
   2 # Network DSC include file for [Defines] section of all Architectures.
   3 #
   4 # This file can be included to the [Defines] section of a platform DSC file by
   5 # using "!include NetworkPkg/NetworkDefines.dsc.inc" to set default value of
   6 # flags if they are not defined somewhere else, and also check the value to see
   7 # if there is any conflict.
   8 #
   9 # These flags can be defined before the !include line, or changed on the command
  10 # line to enable or disable related feature support.
  11 #   -D FLAG=VALUE
  12 # The default value of these flags are:
  13 #   DEFINE NETWORK_ENABLE                 = TRUE
  14 #   DEFINE NETWORK_SNP_ENABLE             = TRUE
  15 #   DEFINE NETWORK_IP4_ENABLE             = TRUE
  16 #   DEFINE NETWORK_IP6_ENABLE             = TRUE
  17 #   DEFINE NETWORK_TLS_ENABLE             = TRUE
  18 #   DEFINE NETWORK_HTTP_ENABLE            = FALSE
  19 #   DEFINE NETWORK_HTTP_BOOT_ENABLE       = TRUE
  20 #   DEFINE NETWORK_ALLOW_HTTP_CONNECTIONS = FALSE
  21 #   DEFINE NETWORK_ISCSI_ENABLE           = FALSE
  22 #   DEFINE NETWORK_VLAN_ENABLE            = TRUE
  23 #
  24 # Copyright (c) 2019, Intel Corporation. All rights reserved.<BR>
  25 # (C) Copyright 2020 Hewlett Packard Enterprise Development LP<BR>
  26 #
  27 #    SPDX-License-Identifier: BSD-2-Clause-Patent
  28 #
  29 ##
  30
  31 !ifndef NETWORK_ENABLE
  32   #
  33   # This flag is to enable or disable the whole network stack.
  34   #
  35   DEFINE NETWORK_ENABLE = TRUE
  36 !endif
  37
  38 !ifndef NETWORK_SNP_ENABLE
  39   #
  40   # This flag is to include the common SNP driver or not.
  41   #
  42   DEFINE NETWORK_SNP_ENABLE = TRUE
  43 !endif
  44
  45 !ifndef NETWORK_VLAN_ENABLE
  46   #
  47   # This flag is to enable or disable VLAN feature.
  48   #
  49   DEFINE NETWORK_VLAN_ENABLE = TRUE
  50 !endif
  51
  52 !ifndef NETWORK_IP4_ENABLE
  53   #
  54   # This flag is to enable or disable IPv4 network stack.
  55   #
  56   DEFINE NETWORK_IP4_ENABLE = TRUE
  57 !endif
  58
  59 !ifndef NETWORK_IP6_ENABLE
  60   #
  61   # This flag is to enable or disable IPv6 network stack.
  62   #
  63   DEFINE NETWORK_IP6_ENABLE = TRUE
  64 !endif
  65
  66 !ifndef NETWORK_TLS_ENABLE
  67   #
  68   # This flag is to enable or disable TLS feature.
  69   #
  70   # Note: This feature depends on the OpenSSL building. To enable this feature, please
  71   #       follow the instructions found in the file "OpenSSL-HOWTO.txt" located in
  72   #       CryptoPkg\Library\OpensslLib to enable the OpenSSL building first.
  73   #       The OpensslLib.inf library instance should be used since libssl is required.
  74   #
  75   DEFINE NETWORK_TLS_ENABLE = TRUE
  76 !endif
  77
  78 !ifndef NETWORK_HTTP_ENABLE
  79   #
  80   # This flag is to enable or disable HTTP(S) feature.
  81   # The default is set to FALSE to not affecting the existing
  82   # platforms.
  83   # NETWORK_HTTP_ENABLE set to FALSE is not affecting NETWORK_HTTP_BOOT_ENABLE
  84   # when NETWORK_HTTP_BOOT_ENABLE is TRUE.
  85   DEFINE NETWORK_HTTP_ENABLE = FALSE
  86 !endif
  87
  88 !ifndef NETWORK_HTTP_BOOT_ENABLE
  89   #
  90   # This flag is to enable or disable HTTP(S) boot feature.
  91   #
  92   #
  93   DEFINE NETWORK_HTTP_BOOT_ENABLE = TRUE
  94 !endif
  95
  96 !ifndef NETWORK_ALLOW_HTTP_CONNECTIONS
  97   #
  98   # Indicates whether HTTP connections (i.e., unsecured) are permitted or not.
  99   #
 100   # Note: If NETWORK_ALLOW_HTTP_CONNECTIONS is TRUE, HTTP connections are allowed.
 101   #       Both the "https://" and "http://" URI schemes are permitted. Otherwise, HTTP
 102   #       connections are denied. Only the "https://" URI scheme is permitted.
 103   #
 104   DEFINE NETWORK_ALLOW_HTTP_CONNECTIONS = FALSE
 105 !endif
 106
 107 !ifndef NETWORK_ISCSI_ENABLE
 108   #
 109   # This flag is to enable or disable iSCSI feature.
 110   #
 111   # Note: This feature depends on the OpenSSL building. To enable this feature, please
 112   #       follow the instructions found in the file "OpenSSL-HOWTO.txt" located in
 113   #       CryptoPkg\Library\OpensslLib to enable the OpenSSL building first.
 114   #       Both OpensslLib.inf and OpensslLibCrypto.inf library instance can be used
 115   #       since libssl is not required for iSCSI.
 116   #
 117   DEFINE NETWORK_ISCSI_ENABLE = FALSE
 118 !endif
 119
 120 !if $(NETWORK_ENABLE) == TRUE
 121   #
 122   # Check the flags to see if there is any conflict.
 123   #
 124   !if ($(NETWORK_IP4_ENABLE) == FALSE) AND ($(NETWORK_IP6_ENABLE) == FALSE)
 125     !error "Must enable at least IP4 or IP6 stack if NETWORK_ENABLE is set to TRUE!"
 126   !endif
 127
 128   !if ($(NETWORK_HTTP_BOOT_ENABLE) == TRUE) OR ($(NETWORK_HTTP_ENABLE) == TRUE)
 129     !if ($(NETWORK_TLS_ENABLE) == FALSE) AND ($(NETWORK_ALLOW_HTTP_CONNECTIONS) == FALSE)
 130       !error "Must enable TLS to support HTTPS, or allow unsecured HTTP connection, if NETWORK_HTTP_BOOT_ENABLE or NETWORK_HTTP_ENABLE is set to TRUE!"
 131     !endif
 132   !endif
 133 !endif