PxeBcBoot.h File Reference

Go to the source code of this file.

Macros
#define	PXEBC_DISPLAY_MAX_LINE   70
#define	PXEBC_DEFAULT_UDP_OVERHEAD_SIZE   8
#define	PXEBC_DEFAULT_TFTP_OVERHEAD_SIZE   4
#define	PXEBC_IS_SIZE_OVERFLOWED(x)   ((sizeof (UINTN) < sizeof (UINT64)) && ((x) > 0xFFFFFFFF))

Functions
EFI_STATUS	PxeBcExtractDiscoverInfo (IN PXEBC_PRIVATE_DATA *Private, IN UINT16 Type, IN OUT EFI_PXE_BASE_CODE_DISCOVER_INFO **DiscoverInfo, OUT PXEBC_BOOT_SVR_ENTRY **BootEntry, OUT EFI_PXE_BASE_CODE_SRVLIST **SrvList)
EFI_STATUS	PxeBcDiscoverBootServer (IN PXEBC_PRIVATE_DATA *Private, IN UINT16 Type, IN UINT16 *Layer, IN BOOLEAN UseBis, IN EFI_IP_ADDRESS *DestIp, IN UINT16 IpCount, IN EFI_PXE_BASE_CODE_SRVLIST *SrvList)
EFI_STATUS	PxeBcLoadBootFile (IN PXEBC_PRIVATE_DATA *Private, IN OUT UINTN *BufferSize, IN VOID *Buffer OPTIONAL)

Detailed Description

Boot functions declaration for UefiPxeBc Driver.

Copyright (c) 2009 - 2012, Intel Corporation. All rights reserved.

SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file PxeBcBoot.h.

Macro Definition Documentation

PXEBC_DEFAULT_TFTP_OVERHEAD_SIZE

#define PXEBC_DEFAULT_TFTP_OVERHEAD_SIZE   4

Definition at line 15 of file PxeBcBoot.h.

PXEBC_DEFAULT_UDP_OVERHEAD_SIZE

#define PXEBC_DEFAULT_UDP_OVERHEAD_SIZE   8

Definition at line 14 of file PxeBcBoot.h.

PXEBC_DISPLAY_MAX_LINE

#define PXEBC_DISPLAY_MAX_LINE   70

Definition at line 13 of file PxeBcBoot.h.

PXEBC_IS_SIZE_OVERFLOWED

#define PXEBC_IS_SIZE_OVERFLOWED

(

x

)

((sizeof (UINTN) < sizeof (UINT64)) && ((x) > 0xFFFFFFFF))

Definition at line 17 of file PxeBcBoot.h.

Function Documentation

PxeBcDiscoverBootServer()

EFI_STATUS PxeBcDiscoverBootServer	(	IN PXEBC_PRIVATE_DATA *	Private,
		IN UINT16	Type,
		IN UINT16 *	Layer,
		IN BOOLEAN	UseBis,
		IN EFI_IP_ADDRESS *	DestIp,
		IN UINT16	IpCount,
		IN EFI_PXE_BASE_CODE_SRVLIST *	SrvList
	)

Build the discover packet and send out for boot.

Parameters

[in]	Private	Pointer to PxeBc private data.
[in]	Type	PxeBc option boot item type.
[in]	Layer	Pointer to option boot item layer.
[in]	UseBis	Use BIS or not.
[in]	DestIp	Pointer to the server address.
[in]	IpCount	The total count of the server address.
[in]	SrvList	Pointer to the server address list.

Return values

EFI_SUCCESS	Successfully discovered boot file.
EFI_OUT_OF_RESOURCES	Failed to allocate resources.
EFI_NOT_FOUND	Can't get the PXE reply packet.
Others	Failed to discover boot file.

Build the discover packet and send out for boot server.

Parameters

[in]	Private	Pointer to PxeBc private data.
[in]	Type	PxeBc option boot item type.
[in]	Layer	Pointer to option boot item layer.
[in]	UseBis	Use BIS or not.
[in]	DestIp	Pointer to the destination address.
[in]	IpCount	The count of the server address.
[in]	SrvList	Pointer to the server address list.

Return values

EFI_SUCCESS	Successfully discovered boot file.
EFI_OUT_OF_RESOURCES	Failed to allocate resource.
EFI_NOT_FOUND	Can't get the PXE reply packet.
Others	Failed to discover boot file.

Definition at line 850 of file PxeBcBoot.c.

PxeBcExtractDiscoverInfo()

EFI_STATUS PxeBcExtractDiscoverInfo	(	IN PXEBC_PRIVATE_DATA *	Private,
		IN UINT16	Type,
		IN OUT EFI_PXE_BASE_CODE_DISCOVER_INFO **	DiscoverInfo,
		OUT PXEBC_BOOT_SVR_ENTRY **	BootEntry,
		OUT EFI_PXE_BASE_CODE_SRVLIST **	SrvList
	)

Extract the discover information and boot server entry from the cached packets if unspecified.

Parameters

[in]	Private	Pointer to PxeBc private data.
[in]	Type	The type of bootstrap to perform.
[in,out]	DiscoverInfo	Pointer to EFI_PXE_BASE_CODE_DISCOVER_INFO.
[out]	BootEntry	Pointer to PXEBC_BOOT_SVR_ENTRY.
[out]	SrvList	Pointer to EFI_PXE_BASE_CODE_SRVLIST.

Return values

EFI_SUCCESS	Successfully extracted the information.
EFI_DEVICE_ERROR	Failed to extract the information.

Definition at line 729 of file PxeBcBoot.c.

PxeBcLoadBootFile()

EFI_STATUS PxeBcLoadBootFile	(	IN PXEBC_PRIVATE_DATA *	Private,
		IN OUT UINTN *	BufferSize,
		IN VOID *Buffer	OPTIONAL
	)

Load boot file into user buffer.

Parameters

[in]	Private	Pointer to PxeBc private data.
[in,out]	BufferSize	Size of user buffer for input; required buffer size for output.
[in]	Buffer	Pointer to user buffer.

Return values

EFI_SUCCESS	Successfully obtained all the boot information.
EFI_BUFFER_TOO_SMALL	The buffer size is not enough for boot file.
EFI_ABORTED	User cancelled the current operation.
Others	Failed to parse out the boot information.

Load boot file into user buffer.

Parameters

[in]	Private	Pointer to PxeBc private data.
[in,out]	BufferSize	Size of user buffer for input; required buffer size for output.
[in]	Buffer	Pointer to user buffer.

Return values

EFI_SUCCESS	Get all the boot information successfully.
EFI_BUFFER_TOO_SMALL	The buffer size is not enough for boot file.
EFI_ABORTED	User cancelled the current operation.
Others	Failed to parse out the boot information.

Definition at line 1142 of file PxeBcBoot.c.