Intel Extensible Firmware Interface - Manual (Page 661)

Protocols — Network Support
Version 1.10 12/01/02 15-55
HeaderPtr If HeaderSize is not NULL , a pointer to a header to be prepended to
the data at BufferPtr .
BufferSize A pointer to the size of the data at BufferPtr .
BufferPtr A pointer to the data to be written.
Description
This function writes a UDP packet specified by the (optional HeaderPtr and) BufferPtr
parameters to the network interface. The UDP header is automatically built by this routine. It uses
the parameters
OpFlags , DestIp , DestPort , GatewayIp , SrcIp , and SrcPort to build
this header. If the packet is successfully built and transmitted through the network interface, then
EFI_SUCCESS will be returned. If a timeout occurs during the transmission of the packet, then
EFI_TIMEOUT will be returned. If an ICMP error occurs during the transmission of the packet,
then the IcmpErrorReceived field is set to TRUE , the IcmpError field is filled in and
EFI_ICMP_ERROR will be returned. If the Callback Protocol does not return
EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE , then EFI_ABORTED will be
returned.
Status Codes Returned
EFI_SUCCESS The UDP Write operation was completed.
EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.
EFI_INVALID_PARAMETER One of the parameters is not valid.
EFI_DEVICE_ERROR The network device encountered an error during this operation.
EFI_BAD_BUFFER_SIZE The buffer is too long to be transmitted.
EFI_ABORTED The callback function aborted the UDP Write operation.
EFI_TIMEOUT The UDP Write operation timed out.
EFI_ICMP_ERROR The UDP Write operation generated an error.