Intel Extensible Firmware Interface, Specification

Page: 265 / 494

PXE Base Code Protocol
Version 1.02 12/12/00 247
14.1.1 EFI_PXE_BASE_CODE.Start()
Summary
Enables the use of the PXE Base Code Protocol functions.
Prototype
EFI_STATUS
(EFIAPI *EFI_PXE_BASE_CODE_START) (
IN EFI_PXE_BASE_CODE *This,
IN BOOLEAN UseIpv6
);
Parameters
This
Pointer to the
EFI_PXE_BASE_CODE
instance.
UseIpv6
Specifies the type of IP addresses that are to be used during the session
that is being started. Set to
TRUE
for IPv6 addresses, and
FALSE
for
IPv4 addresses.
Description
This function enables the use of the PXE Base Code Protocol functions. If the
Started
field of
the
PXE_BASE_CODE_MODE
structure is already
TRUE
, then
EFI_ALREADY_STARTED
will be
returned. If
UseIpv6
is
TRUE
, then IPv6 formatted addresses will be used in this session. If
UseIpv6
is
FALSE
, then IPv4 formatted addresses will be used in this session. If
UseIpv6
is
TRUE
, and the
Ipv6Supported
field of the
EFI_BASE_CODE_MODE
structure is
FALSE
, then
EFI_UNSUPPORTED
will be returned. If there is not enough memory or other resources to start
the PXE Base Code Protocol, then
EFI_OUT_OF_RESOURCES
will be returned. Otherwise, the
PXE Base Code Protocol will be started, and all of the fields of the
EFI_PXE_BASE_CODE_MODE
structure will be initialized as follows:
Started
Set to
TRUE
.
Ipv6Supported
Unchanged.
Ipv6Available
Unchanged.
UsingIpv6
Set to
UseIpv6
BisSupported
Unchanged.
BisDetected
Unchanged.
AutoArp
Set to
TRUE
.
SendGUID
Set to
FALSE
.
TTL
Set to
DEFAULT_TTL
.