NetworkPkg: Add NETWORK_HTTP_ENABLE macro

[mirror_edk2.git] / NetworkPkg / NetworkDefines.dsc.inc

## @file\r
# Network DSC include file for [Defines] section of all Architectures.\r
#\r
# This file can be included to the [Defines] section of a platform DSC file by\r
# using "!include NetworkPkg/NetworkDefines.dsc.inc" to set default value of\r
# flags if they are not defined somewhere else, and also check the value to see\r
# if there is any conflict.\r
#\r
# These flags can be defined before the !include line, or changed on the command\r
# line to enable or disable related feature support.\r
#   -D FLAG=VALUE\r
# The default value of these flags are:\r
#   DEFINE NETWORK_ENABLE                 = TRUE\r
#   DEFINE NETWORK_SNP_ENABLE             = TRUE\r
#   DEFINE NETWORK_IP4_ENABLE             = TRUE\r
#   DEFINE NETWORK_IP6_ENABLE             = TRUE\r
#   DEFINE NETWORK_TLS_ENABLE             = TRUE\r
#   DEFINE NETWORK_HTTP_ENABLE            = FALSE\r
#   DEFINE NETWORK_HTTP_BOOT_ENABLE       = TRUE\r
#   DEFINE NETWORK_ALLOW_HTTP_CONNECTIONS = FALSE\r
#   DEFINE NETWORK_ISCSI_ENABLE           = FALSE\r
#   DEFINE NETWORK_VLAN_ENABLE            = TRUE\r
#\r
# Copyright (c) 2019, Intel Corporation. All rights reserved.<BR>\r
# (C) Copyright 2020 Hewlett Packard Enterprise Development LP<BR>\r
#\r
#    SPDX-License-Identifier: BSD-2-Clause-Patent\r
#\r
##\r
\r
!ifndef NETWORK_ENABLE\r
  #\r
  # This flag is to enable or disable the whole network stack.\r
  #\r
  DEFINE NETWORK_ENABLE = TRUE\r
!endif\r
\r
!ifndef NETWORK_SNP_ENABLE\r
  #\r
  # This flag is to include the common SNP driver or not.\r
  #\r
  DEFINE NETWORK_SNP_ENABLE = TRUE\r
!endif\r
\r
!ifndef NETWORK_VLAN_ENABLE\r
  #\r
  # This flag is to enable or disable VLAN feature.\r
  #\r
  DEFINE NETWORK_VLAN_ENABLE = TRUE\r
!endif\r
\r
!ifndef NETWORK_IP4_ENABLE\r
  #\r
  # This flag is to enable or disable IPv4 network stack.\r
  #\r
  DEFINE NETWORK_IP4_ENABLE = TRUE\r
!endif\r
\r
!ifndef NETWORK_IP6_ENABLE\r
  #\r
  # This flag is to enable or disable IPv6 network stack.\r
  #\r
  DEFINE NETWORK_IP6_ENABLE = TRUE\r
!endif\r
\r
!ifndef NETWORK_TLS_ENABLE\r
  #\r
  # This flag is to enable or disable TLS feature.\r
  #\r
  # Note: This feature depends on the OpenSSL building. To enable this feature, please\r
  #       follow the instructions found in the file "OpenSSL-HOWTO.txt" located in\r
  #       CryptoPkg\Library\OpensslLib to enable the OpenSSL building first.\r
  #       The OpensslLib.inf library instance should be used since libssl is required.\r
  #\r
  DEFINE NETWORK_TLS_ENABLE = TRUE\r
!endif\r
\r
!ifndef NETWORK_HTTP_ENABLE\r
  #\r
  # This flag is to enable or disable HTTP(S) feature.\r
  # The default is set to FALSE to not affecting the existing\r
  # platforms.\r
  # NETWORK_HTTP_ENABLE set to FALSE is not affecting NETWORK_HTTP_BOOT_ENABLE\r
  # when NETWORK_HTTP_BOOT_ENABLE is TRUE.\r
  DEFINE NETWORK_HTTP_ENABLE = FALSE\r
!endif\r
\r
!ifndef NETWORK_HTTP_BOOT_ENABLE\r
  #\r
  # This flag is to enable or disable HTTP(S) boot feature.\r
  #\r
  #\r
  DEFINE NETWORK_HTTP_BOOT_ENABLE = TRUE\r
!endif\r
\r
!ifndef NETWORK_ALLOW_HTTP_CONNECTIONS\r
  #\r
  # Indicates whether HTTP connections (i.e., unsecured) are permitted or not.\r
  #\r
  # Note: If NETWORK_ALLOW_HTTP_CONNECTIONS is TRUE, HTTP connections are allowed.\r
  #       Both the "https://" and "http://" URI schemes are permitted. Otherwise, HTTP\r
  #       connections are denied. Only the "https://" URI scheme is permitted.\r
  #\r
  DEFINE NETWORK_ALLOW_HTTP_CONNECTIONS = FALSE\r
!endif\r
\r
!ifndef NETWORK_ISCSI_ENABLE\r
  #\r
  # This flag is to enable or disable iSCSI feature.\r
  #\r
  # Note: This feature depends on the OpenSSL building. To enable this feature, please\r
  #       follow the instructions found in the file "OpenSSL-HOWTO.txt" located in\r
  #       CryptoPkg\Library\OpensslLib to enable the OpenSSL building first.\r
  #       Both OpensslLib.inf and OpensslLibCrypto.inf library instance can be used\r
  #       since libssl is not required for iSCSI.\r
  #\r
  DEFINE NETWORK_ISCSI_ENABLE = FALSE\r
!endif\r
\r
!if $(NETWORK_ENABLE) == TRUE\r
  #\r
  # Check the flags to see if there is any conflict.\r
  #\r
  !if ($(NETWORK_IP4_ENABLE) == FALSE) AND ($(NETWORK_IP6_ENABLE) == FALSE)\r
    !error "Must enable at least IP4 or IP6 stack if NETWORK_ENABLE is set to TRUE!"\r
  !endif\r
\r
  !if ($(NETWORK_HTTP_BOOT_ENABLE) == TRUE) OR ($(NETWORK_HTTP_ENABLE) == TRUE)\r
    !if ($(NETWORK_TLS_ENABLE) == FALSE) AND ($(NETWORK_ALLOW_HTTP_CONNECTIONS) == FALSE)\r
      !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!"\r
    !endif\r
  !endif\r
!endif\r