/** @file
Mtftp6 Rrq process functions implementation.
Copyright (c) 2009 - 2012, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
#include "Mtftp6Impl.h"
/**
Build and send a ACK packet for download.
@param[in] Instance The pointer to the Mtftp6 instance.
@param[in] BlockNum The block number to be acked.
@retval EFI_OUT_OF_RESOURCES Failed to allocate memory for the packet.
@retval EFI_SUCCESS The ACK has been sent.
@retval Others Failed to send the ACK.
**/
)
{
//
// Allocate net buffer to create ack packet.
//
return EFI_OUT_OF_RESOURCES;
}
sizeof (EFI_MTFTP6_ACK_HEADER),
);
//
// Reset current retry count of the instance.
//
}
/**
Deliver the received data block to the user, which can be saved
in the user provide buffer or through the CheckPacket callback.
@param[in] Instance The pointer to the Mtftp6 instance.
@param[in] Packet The pointer to the received packet.
@param[in] Len The packet length.
@param[out] UdpPacket The net buf of the received packet.
@retval EFI_SUCCESS The data was saved successfully.
@retval EFI_ABORTED The user tells to abort by return an error through
CheckPacket.
@retval EFI_BUFFER_TOO_SMALL The user's buffer is too small, and buffer length is
updated to the actual buffer size needed.
**/
)
{
//
// This is the last block, save the block num
//
}
//
// Remove this block number from the file hole. If Mtftp6RemoveBlockNum
// returns EFI_NOT_FOUND, the block has been saved, don't save it again.
// Note that : For bigger files, allowing the block counter to roll over
// to accept transfers of unlimited size. So TotalBlock is memorised as
// continuous block counter.
//
if (Status == EFI_NOT_FOUND) {
return EFI_SUCCESS;
return Status;
}
//
// Callback to the check packet routine with the received packet.
//
//
// Free the received packet before send new packet in ReceiveNotify,
// since the Udp6Io might need to be reconfigured.
//
NetbufFree (*UdpPacket);
//
// Send the Mtftp6 error message if user aborted the current session.
//
(UINT8 *) "User aborted download"
);
return EFI_ABORTED;
}
}
//
// Update the file size when received the last block
//
}
//
// Don't save the data if the buffer is too small, return
// EFI_BUFFER_TOO_SMALL if received the last packet. This
// will give a accurate file length.
//
//
// Free the received packet before send new packet in ReceiveNotify,
// since the udpio might need to be reconfigured.
//
NetbufFree (*UdpPacket);
//
// Send the Mtftp6 error message if no enough buffer.
//
(UINT8 *) "User provided memory block is too small"
);
return EFI_BUFFER_TOO_SMALL;
}
}
return EFI_SUCCESS;
}
/**
Process the received data packets. It will save the block
then send back an ACK if it is active.
@param[in] Instance The pointer to the Mtftp6 instance.
@param[in] Packet The pointer to the received packet.
@param[in] Len The length of the packet.
@param[out] UdpPacket The net buf of received packet.
@param[out] IsCompleted If TRUE, the download has been completed.
Otherwise, the download has not been completed.
@retval EFI_SUCCESS The data packet was successfully processed.
@retval EFI_ABORTED The download was aborted by the user.
@retval EFI_BUFFER_TOO_SMALL The user-provided buffer is too small.
**/
)
{
*IsCompleted = FALSE;
//
// If we are active and received an unexpected packet, retransmit
// the last ACK then restart receiving. If we are passive, save
// the block.
//
//
// Free the received packet before send new packet in ReceiveNotify,
// since the udpio might need to be reconfigured.
//
NetbufFree (*UdpPacket);
return EFI_SUCCESS;
}
return Status;
}
//
// Reset the passive client's timer whenever it received a valid data packet.
//
}
//
// Check whether we have received all the blocks. Send the ACK if we
// are active (unicast client or master client for multicast download).
// If we have received all the blocks, send an ACK even if we are passive
// to tell the server that we are done.
//
if (Expected < 0) {
//
// If we are passive client, then the just received Block maybe
// isn't the last block. We need to send an ACK to the last block
// to inform the server that we are done. If we are active client,
// the Block == Instance->LastBlock.
//
*IsCompleted = TRUE;
} else {
}
//
// Free the received packet before send new packet in ReceiveNotify,
// since the udpio might need to be reconfigured.
//
NetbufFree (*UdpPacket);
}
return EFI_SUCCESS;
}
/**
Validate whether the options received in the server's OACK packet is valid.
The options are valid only if:
1. The server doesn't include options not requested by us.
2. The server can only use smaller blksize than that is requested.
3. The server can only use the same timeout as requested.
4. The server doesn't change its multicast channel.
@param[in] Instance The pointer to the Mtftp6 instance.
@param[in] ReplyInfo The pointer to options information in reply packet.
@param[in] RequestInfo The pointer to requested options info.
@retval TRUE If the option in the OACK is valid.
@retval FALSE If the option is invalid.
**/
)
{
//
// It is invalid for server to return options we don't request
//
return FALSE;
}
//
// Server can only specify a smaller block size to be used and
// return the timeout matches that requested.
//
if ((((ReplyInfo->BitMap & MTFTP6_OPT_BLKSIZE_BIT) != 0) && (ReplyInfo->BlkSize > RequestInfo->BlkSize)) ||
(((ReplyInfo->BitMap & MTFTP6_OPT_TIMEOUT_BIT) != 0) && (ReplyInfo->Timeout != RequestInfo->Timeout))
) {
return FALSE;
}
//
// The server can send ",,master" to client to change its master
// setting. But if it use the specific multicast channel, it can't
// change the setting.
//
if (((ReplyInfo->BitMap & MTFTP6_OPT_MCAST_BIT) != 0) && !NetIp6IsUnspecifiedAddr (&Instance->McastIp)) {
sizeof (EFI_IPv6_ADDRESS)
) != 0) {
return FALSE;
}
return FALSE;
}
}
return TRUE;
}
/**
Configure Udp6Io to receive a packet from a multicast address.
@param[in] McastIo The pointer to the mcast Udp6Io.
@param[in] Context The pointer to the context.
@retval EFI_SUCCESS The mcast Udp6Io was successfully configured.
@retval Others Failed to configure the Udp6Io.
**/
)
{
//
// Set the configure data for the mcast Udp6Io.
//
Udp6Cfg->TrafficClass = 0;
Udp6Cfg->ReceiveTimeout = 0;
Udp6Cfg->TransmitTimeout = 0;
Udp6Cfg->RemotePort = 0;
CopyMem (
sizeof (EFI_IPv6_ADDRESS)
);
//
// Configure the mcast Udp6Io.
//
return Status;
}
//
// Join the multicast group
//
}
/**
Process the OACK packet for Rrq.
@param[in] Instance The pointer to the Mtftp6 instance.
@param[in] Packet The pointer to the received packet.
@param[in] Len The length of the packet.
@param[out] UdpPacket The net buf of received packet.
@param[out] IsCompleted If TRUE, the download has been completed.
Otherwise, the download has not been completed.
@retval EFI_TFTP_ERROR An error happened during the process.
@retval EFI_SUCCESS The OACK packet successfully processed.
**/
)
{
*IsCompleted = FALSE;
//
// If already started the master download, don't change the
// setting. Master download always succeeds.
//
return EFI_SUCCESS;
}
//
// Parse the options in the packet.
//
return Status;
}
//
// Parse the extensive options in the packet.
//
//
// Don't send an ERROR packet if the error is EFI_OUT_OF_RESOURCES.
//
if (Status != EFI_OUT_OF_RESOURCES) {
//
// Free the received packet before send new packet in ReceiveNotify,
// since the udpio might need to be reconfigured.
//
NetbufFree (*UdpPacket);
//
// Send the Mtftp6 error message if invalid packet.
//
(UINT8 *) "Mal-formated OACK packet"
);
}
return EFI_TFTP_ERROR;
}
//
// Save the multicast info. Always update the Master, only update the
// multicast IP address, block size, timeoute at the first time. If IP
// address is updated, create a UDP child to receive the multicast.
//
//
// Free the received packet before send new packet in ReceiveNotify,
// since the udpio might need to be reconfigured.
//
NetbufFree (*UdpPacket);
//
// Send the Mtftp6 error message if invalid multi-cast setting.
//
(UINT8 *) "Illegal multicast setting"
);
return EFI_TFTP_ERROR;
}
//
// Create a UDP child then start receive the multicast from it.
//
CopyMem (
sizeof (EFI_IP_ADDRESS)
);
);
return EFI_DEVICE_ERROR;
}
0
);
//
// Free the received packet before send new packet in ReceiveNotify,
// since the udpio might need to be reconfigured.
//
NetbufFree (*UdpPacket);
//
// Send the Mtftp6 error message if failed to create Udp6Io to receive.
//
(UINT8 *) "Failed to create socket to receive multicast packet"
);
return Status;
}
//
// Update the parameters used.
//
}
}
}
} else {
}
}
}
//
// Free the received packet before send new packet in ReceiveNotify,
// since the udpio might need to be reconfigured.
//
NetbufFree (*UdpPacket);
//
// Send an ACK to (Expected - 1) which is 0 for unicast download,
// or tell the server we want to receive the Expected block.
//
}
/**
The packet process callback for Mtftp6 download.
@param[in] UdpPacket The pointer to the packet received.
@param[in] UdpEpt The pointer to the Udp6 access point.
@param[in] IoStatus The status from Udp6 instance.
@param[in] Context The pointer to the context.
**/
)
{
IsCompleted = FALSE;
TotalNum = 0;
//
// Return error status if Udp6 instance failed to receive.
//
goto ON_EXIT;
}
goto ON_EXIT;
}
//
// Find the port this packet is from to restart receive correctly.
//
if (CompareMem (
sizeof (EFI_IPv6_ADDRESS)
) == 0) {
} else {
}
//
// Client send initial request to server's listening port. Server
// will select a UDP port to communicate with the client. The server
// is required to use the same port as RemotePort to multicast the
// data.
//
if (Instance->ServerDataPort != 0) {
goto ON_EXIT;
} else {
//
// For the subsequent exchange of requests, reconfigure the udpio as
// (serverip, serverport, localip, localport).
// Ususally, the client set serverport as 0 to receive and reset it
// once the first packet arrives to send ack.
//
}
}
//
// Copy the MTFTP packet to a continuous buffer if it isn't already so.
//
if (TotalNum > 1) {
goto ON_EXIT;
}
} else {
}
//
// Callback to the user's CheckPacket if provided. Abort the transmission
// if CheckPacket returns an EFI_ERROR code.
//
) {
);
//
// Send an error message to the server to inform it
//
if (Opcode != EFI_MTFTP6_OPCODE_ERROR) {
//
// Free the received packet before send new packet in ReceiveNotify,
// since the udpio might need to be reconfigured.
//
//
// Send the Mtftp6 error message if user aborted the current session.
//
(UINT8 *) "User aborted the transfer"
);
}
goto ON_EXIT;
}
}
//
// Switch the process routines by the operation code.
//
switch (Opcode) {
case EFI_MTFTP6_OPCODE_DATA:
if ((Len > (UINT32) (MTFTP6_DATA_HEAD_LEN + Instance->BlkSize)) || (Len < (UINT32) MTFTP6_DATA_HEAD_LEN)) {
goto ON_EXIT;
}
//
// Handle the data packet of Rrq.
//
Len,
);
break;
case EFI_MTFTP6_OPCODE_OACK:
goto ON_EXIT;
}
//
// Handle the Oack packet of Rrq.
//
Len,
);
break;
default:
//
// Drop and return eror if received error message.
//
break;
}
//
// Free the resources, then if !EFI_ERROR (Status), restart the
// receive, otherwise end the session.
//
}
}
if (IsMcast) {
0
);
} else {
0
);
}
}
//
// Clean up the current session if failed to continue.
//
}
}
/**
Start the Mtftp6 instance to download. It first initializes some
of the internal states, then builds and sends an RRQ reqeuest packet.
Finally, it starts receive for the downloading.
@param[in] Instance The pointer to the Mtftp6 instance.
@param[in] Operation The operation code of current packet.
@retval EFI_SUCCESS The Mtftp6 is started to download.
@retval Others Failed to start to download.
**/
)
{
//
// The valid block number range are [1, 0xffff]. For example:
// the client sends an RRQ request to the server, the server
// transfers the DATA1 block. If option negoitation is ongoing,
// the server will send back an OACK, then client will send ACK0.
//
return Status;
}
return Status;
}
return UdpIoRecvDatagram (
0
);
}