Intel Extensible Firmware Interface, Specification

Page: 279 / 494

PXE Base Code Protocol
Version 1.02 12/12/00 261
14.1.6 EFI_PXE_BASE_CODE.UdpWrite()
Summary
Writes a UDP packet to the network interface.
Prototype
EFI_STATUS
(EFIAPI *EFI_PXE_BASE_CODE_UDP_WRITE) (
IN EFI_PXE_BASE_CODE *This,
IN UINT16 OpFlags,
IN EFI_IP_ADDRESS *DestIp,
IN EFI_PXE_BASE_CODE_UDP_PORT *DestPort,
IN EFI_IP_ADDRESS *GatewayIp, OPTIONAL
IN EFI_IP_ADDRESS *SrcIp, OPTIONAL
IN OUT EFI_PXE_BASE_CODE_UDP_PORT *SrcPort, OPTIONAL
IN UINTN *HeaderSize, OPTIONAL
IN VOID *HeaderPtr, OPTIONAL
IN UINTN *BufferSize,
IN VOID *BufferPtr
);
Parameters
This
Pointer to the
EFI_PXE_BASE_CODE
instance.
OpFlags
The UDP operation flags. If
MAY_FRAGMENT
is set, then if required,
this UDP write operation may be broken up across multiple packets.
DestIp
The destination IP address.
DestPort
The destination UDP port number.
GatewayIp
The gateway IP address. If
DestIp
is not in the same subnet as
StationIp
, then this gateway IP address will be used. If this field is
NULL
, and the
DestIp
is not in the same subnet as
StationIp
, then
the
RouteTable
will be used.
SrcIp
The source IP address. If this field is
NULL
, then
StationIp
will be
used as the source IP address.
SrcPort
The source UDP port number. If
OpFlags
has
ANY_SRC_PORT
set
or
SrcPort
is
NULL
, then a source UDP port will be automatically
selected. If a source UDP port was automatically selected, and
SrcPort
is not
NULL
, then it will be returned in
SrcPort
.
HeaderSize
An optional field which may be set to the length of a header at
HeaderPtr
to be prepended to the data at
BufferPtr
.