Nt32Pkg: Clean up DSC to remove unnecessary build option in SecMain

[mirror_edk2.git] / NetworkPkg / UefiPxeBcDxe / PxeBcBoot.h

/** @file\r
  Boot functions declaration for UefiPxeBc Driver.\r
\r
  Copyright (c) 2009 - 2012, Intel Corporation. All rights reserved.<BR>\r
\r
  This program and the accompanying materials\r
  are licensed and made available under the terms and conditions of the BSD License\r
  which accompanies this distribution.  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
#ifndef __EFI_PXEBC_BOOT_H__\r
#define __EFI_PXEBC_BOOT_H__\r
\r
#define PXEBC_DISPLAY_MAX_LINE             70\r
#define PXEBC_DEFAULT_UDP_OVERHEAD_SIZE    8\r
#define PXEBC_DEFAULT_TFTP_OVERHEAD_SIZE   4\r
\r
#define PXEBC_IS_SIZE_OVERFLOWED(x)   ((sizeof (UINTN) < sizeof (UINT64)) && ((x) > 0xFFFFFFFF))\r
\r
\r
/**\r
  Extract the discover information and boot server entry from the\r
  cached packets if unspecified.\r
\r
  @param[in]      Private      Pointer to PxeBc private data.\r
  @param[in]      Type         The type of bootstrap to perform.\r
  @param[in, out] DiscoverInfo Pointer to EFI_PXE_BASE_CODE_DISCOVER_INFO.\r
  @param[out]     BootEntry    Pointer to PXEBC_BOOT_SVR_ENTRY.\r
  @param[out]     SrvList      Pointer to EFI_PXE_BASE_CODE_SRVLIST.\r
\r
  @retval EFI_SUCCESS       Successfully extracted the information.\r
  @retval EFI_DEVICE_ERROR  Failed to extract the information.\r
\r
**/\r
EFI_STATUS\r
PxeBcExtractDiscoverInfo (\r
  IN     PXEBC_PRIVATE_DATA               *Private,\r
  IN     UINT16                           Type,\r
  IN OUT EFI_PXE_BASE_CODE_DISCOVER_INFO  **DiscoverInfo,\r
     OUT PXEBC_BOOT_SVR_ENTRY             **BootEntry,\r
     OUT EFI_PXE_BASE_CODE_SRVLIST        **SrvList\r
  );\r
\r
\r
/**\r
  Build the discover packet and send out for boot.\r
\r
  @param[in]  Private               Pointer to PxeBc private data.\r
  @param[in]  Type                  PxeBc option boot item type.\r
  @param[in]  Layer                 Pointer to option boot item layer.\r
  @param[in]  UseBis                Use BIS or not.\r
  @param[in]  DestIp                Pointer to the server address.\r
  @param[in]  IpCount               The total count of the server address.\r
  @param[in]  SrvList               Pointer to the server address list.\r
\r
  @retval     EFI_SUCCESS           Successfully discovered boot file.\r
  @retval     EFI_OUT_OF_RESOURCES  Failed to allocate resources.\r
  @retval     EFI_NOT_FOUND         Can't get the PXE reply packet.\r
  @retval     Others                Failed to discover boot file.\r
\r
**/\r
EFI_STATUS\r
PxeBcDiscoverBootServer (\r
  IN  PXEBC_PRIVATE_DATA                *Private,\r
  IN  UINT16                            Type,\r
  IN  UINT16                            *Layer,\r
  IN  BOOLEAN                           UseBis,\r
  IN  EFI_IP_ADDRESS                    *DestIp,\r
  IN  UINT16                            IpCount,\r
  IN  EFI_PXE_BASE_CODE_SRVLIST         *SrvList\r
  );\r
\r
\r
/**\r
  Load boot file into user buffer.\r
\r
  @param[in]      Private           Pointer to PxeBc private data.\r
  @param[in, out] BufferSize        Size of user buffer for input;\r
                                    required buffer size for output.\r
  @param[in]      Buffer            Pointer to user buffer.\r
\r
  @retval EFI_SUCCESS          Successfully obtained all the boot information.\r
  @retval EFI_BUFFER_TOO_SMALL The buffer size is not enough for boot file.\r
  @retval EFI_ABORTED          User cancelled the current operation.\r
  @retval Others               Failed to parse out the boot information.\r
\r
**/\r
EFI_STATUS\r
PxeBcLoadBootFile (\r
  IN     PXEBC_PRIVATE_DATA           *Private,\r
  IN OUT UINTN                        *BufferSize,\r
  IN     VOID                         *Buffer         OPTIONAL\r
  );\r
\r
#endif\r