mirror of https://github.com/acidanthera/audk.git
898 lines
25 KiB
C
898 lines
25 KiB
C
/** @file
|
|
|
|
Copyright (c) 2006 - 2007, Intel Corporation
|
|
All rights reserved. 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
|
|
http://opensource.org/licenses/bsd-license.php
|
|
|
|
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
|
|
|
|
Module Name:
|
|
|
|
Mtftp4Impl.c
|
|
|
|
Abstract:
|
|
|
|
Interface routine for Mtftp4
|
|
|
|
|
|
**/
|
|
|
|
#include "Mtftp4Impl.h"
|
|
|
|
EFI_STATUS
|
|
EFIAPI
|
|
EfiMtftp4ReadFile (
|
|
IN EFI_MTFTP4_PROTOCOL *This,
|
|
IN EFI_MTFTP4_TOKEN *Token
|
|
);
|
|
|
|
|
|
/**
|
|
Get the current operation parameter for the MTFTP session
|
|
|
|
@param This The MTFTP protocol instance
|
|
@param ModeData The MTFTP mode data
|
|
|
|
@retval EFI_INVALID_PARAMETER This or ModeData is NULL
|
|
@retval EFI_SUCCESS The operation parameter is saved in ModeData
|
|
|
|
**/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
EfiMtftp4GetModeData (
|
|
IN EFI_MTFTP4_PROTOCOL *This,
|
|
OUT EFI_MTFTP4_MODE_DATA *ModeData
|
|
)
|
|
{
|
|
MTFTP4_PROTOCOL *Instance;
|
|
EFI_TPL OldTpl;
|
|
|
|
if ((This == NULL) || (ModeData == NULL)) {
|
|
return EFI_INVALID_PARAMETER;
|
|
}
|
|
|
|
OldTpl = gBS->RaiseTPL (TPL_CALLBACK);
|
|
|
|
Instance = MTFTP4_PROTOCOL_FROM_THIS (This);
|
|
CopyMem(&ModeData->ConfigData, &Instance->Config, sizeof (Instance->Config));
|
|
ModeData->SupportedOptionCount = MTFTP4_SUPPORTED_OPTIONS;
|
|
ModeData->SupportedOptoins = (UINT8 **) mMtftp4SupportedOptions;
|
|
ModeData->UnsupportedOptionCount = 0;
|
|
ModeData->UnsupportedOptoins = NULL;
|
|
|
|
gBS->RestoreTPL (OldTpl);
|
|
|
|
return EFI_SUCCESS;
|
|
}
|
|
|
|
|
|
/**
|
|
Clean up the MTFTP session to get ready for new operation.
|
|
|
|
@param Instance The MTFTP session to clean up
|
|
@param Result The result to return to the caller who initiated
|
|
the operation.
|
|
|
|
@return None
|
|
|
|
**/
|
|
VOID
|
|
Mtftp4CleanOperation (
|
|
IN MTFTP4_PROTOCOL *Instance,
|
|
IN EFI_STATUS Result
|
|
)
|
|
{
|
|
LIST_ENTRY *Entry;
|
|
LIST_ENTRY *Next;
|
|
MTFTP4_BLOCK_RANGE *Block;
|
|
EFI_MTFTP4_TOKEN *Token;
|
|
|
|
//
|
|
// Free various resources.
|
|
//
|
|
Token = Instance->Token;
|
|
|
|
if (Token != NULL) {
|
|
Token->Status = Result;
|
|
|
|
if (Token->Event != NULL) {
|
|
gBS->SignalEvent (Token->Event);
|
|
}
|
|
|
|
Instance->Token = NULL;
|
|
}
|
|
|
|
ASSERT (Instance->UnicastPort != NULL);
|
|
UdpIoCleanPort (Instance->UnicastPort);
|
|
|
|
if (Instance->LastPacket != NULL) {
|
|
NetbufFree (Instance->LastPacket);
|
|
Instance->LastPacket = NULL;
|
|
}
|
|
|
|
if (Instance->McastUdpPort != NULL) {
|
|
UdpIoFreePort (Instance->McastUdpPort);
|
|
Instance->McastUdpPort = NULL;
|
|
}
|
|
|
|
NET_LIST_FOR_EACH_SAFE (Entry, Next, &Instance->Blocks) {
|
|
Block = NET_LIST_USER_STRUCT (Entry, MTFTP4_BLOCK_RANGE, Link);
|
|
RemoveEntryList (Entry);
|
|
gBS->FreePool (Block);
|
|
}
|
|
|
|
ZeroMem (&Instance->RequestOption, sizeof (MTFTP4_OPTION));
|
|
|
|
Instance->Operation = 0;
|
|
|
|
Instance->BlkSize = MTFTP4_DEFAULT_BLKSIZE;
|
|
Instance->LastBlock = 0;
|
|
Instance->ServerIp = 0;
|
|
Instance->ListeningPort = 0;
|
|
Instance->ConnectedPort = 0;
|
|
Instance->Gateway = 0;
|
|
Instance->PacketToLive = 0;
|
|
Instance->MaxRetry = 0;
|
|
Instance->CurRetry = 0;
|
|
Instance->Timeout = 0;
|
|
Instance->McastIp = 0;
|
|
Instance->McastPort = 0;
|
|
Instance->Master = TRUE;
|
|
}
|
|
|
|
|
|
/**
|
|
Configure the MTFTP session for new operation or reset the current
|
|
operation if ConfigData is NULL.
|
|
|
|
@param This The MTFTP session to configure
|
|
@param ConfigData The configure parameters
|
|
|
|
@retval EFI_INVALID_PARAMETER Some of the parameter is invalid.
|
|
@retval EFI_ACCESS_DENIED There is pending operation
|
|
@retval EFI_SUCCESS The instance is configured for operation.
|
|
|
|
**/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
EfiMtftp4Configure (
|
|
IN EFI_MTFTP4_PROTOCOL *This,
|
|
IN EFI_MTFTP4_CONFIG_DATA *ConfigData
|
|
)
|
|
{
|
|
MTFTP4_PROTOCOL *Instance;
|
|
EFI_TPL OldTpl;
|
|
IP4_ADDR Ip;
|
|
IP4_ADDR Netmask;
|
|
IP4_ADDR Gateway;
|
|
IP4_ADDR ServerIp;
|
|
|
|
if (This == NULL) {
|
|
return EFI_INVALID_PARAMETER;
|
|
}
|
|
|
|
Instance = MTFTP4_PROTOCOL_FROM_THIS (This);
|
|
|
|
if (ConfigData == NULL) {
|
|
//
|
|
// Reset the operation if ConfigData is NULL
|
|
//
|
|
OldTpl = gBS->RaiseTPL (TPL_CALLBACK);
|
|
|
|
Mtftp4CleanOperation (Instance, EFI_ABORTED);
|
|
ZeroMem (&Instance->Config, sizeof (EFI_MTFTP4_CONFIG_DATA));
|
|
Instance->State = MTFTP4_STATE_UNCONFIGED;
|
|
|
|
gBS->RestoreTPL (OldTpl);
|
|
|
|
} else {
|
|
//
|
|
// Configure the parameters for new operation.
|
|
//
|
|
CopyMem (&Ip, &ConfigData->StationIp, sizeof (IP4_ADDR));
|
|
CopyMem (&Netmask, &ConfigData->SubnetMask, sizeof (IP4_ADDR));
|
|
CopyMem (&Gateway, &ConfigData->GatewayIp, sizeof (IP4_ADDR));
|
|
CopyMem (&ServerIp, &ConfigData->ServerIp, sizeof (IP4_ADDR));
|
|
|
|
Ip = NTOHL (Ip);
|
|
Netmask = NTOHL (Netmask);
|
|
Gateway = NTOHL (Gateway);
|
|
ServerIp = NTOHL (ServerIp);
|
|
|
|
if (!Ip4IsUnicast (ServerIp, 0)) {
|
|
return EFI_INVALID_PARAMETER;
|
|
}
|
|
|
|
if (!ConfigData->UseDefaultSetting &&
|
|
((!IP4_IS_VALID_NETMASK (Netmask) || !Ip4IsUnicast (Ip, Netmask)))) {
|
|
|
|
return EFI_INVALID_PARAMETER;
|
|
}
|
|
|
|
if ((Gateway != 0) &&
|
|
(!IP4_NET_EQUAL (Gateway, Ip, Netmask) || !Ip4IsUnicast (Gateway, Netmask))) {
|
|
|
|
return EFI_INVALID_PARAMETER;
|
|
}
|
|
|
|
OldTpl = gBS->RaiseTPL (TPL_CALLBACK);
|
|
|
|
if ((Instance->State == MTFTP4_STATE_CONFIGED) && (Instance->Operation != 0)) {
|
|
gBS->RestoreTPL (OldTpl);
|
|
return EFI_ACCESS_DENIED;
|
|
}
|
|
|
|
CopyMem(&Instance->Config, ConfigData, sizeof (*ConfigData));;
|
|
Instance->State = MTFTP4_STATE_CONFIGED;
|
|
|
|
gBS->RestoreTPL (OldTpl);
|
|
}
|
|
|
|
return EFI_SUCCESS;
|
|
}
|
|
|
|
|
|
/**
|
|
Check packet for GetInfo. GetInfo is implemented with EfiMtftp4ReadFile.
|
|
It use Mtftp4GetInfoCheckPacket to inspect the first packet from server,
|
|
then abort the session.
|
|
|
|
@param This The MTFTP4 protocol instance
|
|
@param Token The user's token
|
|
@param PacketLen The length of the packet
|
|
@param Packet The received packet.
|
|
|
|
@retval EFI_ABORTED Abort the ReadFile operation and return.
|
|
|
|
**/
|
|
EFI_STATUS
|
|
Mtftp4GetInfoCheckPacket (
|
|
IN EFI_MTFTP4_PROTOCOL *This,
|
|
IN EFI_MTFTP4_TOKEN *Token,
|
|
IN UINT16 PacketLen,
|
|
IN EFI_MTFTP4_PACKET *Packet
|
|
)
|
|
{
|
|
MTFTP4_PROTOCOL *Instance;
|
|
MTFTP4_GETINFO_STATE *State;
|
|
EFI_STATUS Status;
|
|
UINT16 OpCode;
|
|
|
|
Instance = MTFTP4_PROTOCOL_FROM_THIS (This);
|
|
State = &Instance->GetInfoState;
|
|
OpCode = NTOHS (Packet->OpCode);
|
|
|
|
//
|
|
// Set the GetInfo's return status according to the OpCode.
|
|
//
|
|
switch (OpCode) {
|
|
case EFI_MTFTP4_OPCODE_ERROR:
|
|
State->Status = EFI_TFTP_ERROR;
|
|
break;
|
|
|
|
case EFI_MTFTP4_OPCODE_OACK:
|
|
State->Status = EFI_SUCCESS;
|
|
break;
|
|
|
|
default:
|
|
State->Status = EFI_PROTOCOL_ERROR;
|
|
}
|
|
|
|
//
|
|
// Allocate buffer then copy the packet over. Use gBS->AllocatePool
|
|
// in case AllocatePool will implements something tricky.
|
|
//
|
|
Status = gBS->AllocatePool (EfiBootServicesData, PacketLen, (VOID **) State->Packet);
|
|
|
|
if (EFI_ERROR (Status)) {
|
|
State->Status = EFI_OUT_OF_RESOURCES;
|
|
return EFI_ABORTED;
|
|
}
|
|
|
|
*(State->PacketLen) = PacketLen;
|
|
CopyMem (*(State->Packet), Packet, PacketLen);
|
|
|
|
return EFI_ABORTED;
|
|
}
|
|
|
|
|
|
/**
|
|
Get the information of the download from the server. It is implemented
|
|
with EfiMtftp4ReadFile: build a token, then pass it to EfiMtftp4ReadFile.
|
|
In its check packet callback abort the opertions.
|
|
|
|
@param This The MTFTP protocol instance
|
|
@param OverrideData The MTFTP override data
|
|
@param Filename The file to get information
|
|
@param ModeStr The mode to use
|
|
@param OptionCount The number of options to append
|
|
@param OptionList The options to append
|
|
@param PacketLength The variable to receive the packet length
|
|
@param Packet The variable to receive the packet.
|
|
|
|
@retval EFI_INVALID_PARAMETER The parameter is invaid
|
|
@retval EFI_SUCCESS The information is got
|
|
@retval Others Failed to get the information.
|
|
|
|
**/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
EfiMtftp4GetInfo (
|
|
IN EFI_MTFTP4_PROTOCOL *This,
|
|
IN EFI_MTFTP4_OVERRIDE_DATA *OverrideData, OPTIONAL
|
|
IN UINT8 *Filename,
|
|
IN UINT8 *ModeStr, OPTIONAL
|
|
IN UINT8 OptionCount,
|
|
IN EFI_MTFTP4_OPTION *OptionList,
|
|
OUT UINT32 *PacketLength,
|
|
OUT EFI_MTFTP4_PACKET **Packet OPTIONAL
|
|
)
|
|
{
|
|
EFI_MTFTP4_TOKEN Token;
|
|
MTFTP4_PROTOCOL *Instance;
|
|
MTFTP4_GETINFO_STATE *State;
|
|
EFI_STATUS Status;
|
|
|
|
if ((This == NULL) || (Filename == NULL) || (PacketLength == NULL) ||
|
|
(OptionCount && (OptionList == NULL))) {
|
|
return EFI_INVALID_PARAMETER;
|
|
}
|
|
|
|
if (Packet != NULL) {
|
|
*Packet = NULL;
|
|
}
|
|
|
|
*PacketLength = 0;
|
|
Instance = MTFTP4_PROTOCOL_FROM_THIS (This);
|
|
State = &Instance->GetInfoState;
|
|
State->Packet = Packet;
|
|
State->PacketLen = PacketLength;
|
|
State->Status = EFI_SUCCESS;
|
|
|
|
//
|
|
// Fill in the Token to issue an synchronous ReadFile operation
|
|
//
|
|
Token.Status = EFI_SUCCESS;
|
|
Token.Event = NULL;
|
|
Token.OverrideData = OverrideData;
|
|
Token.Filename = Filename;
|
|
Token.ModeStr = ModeStr;
|
|
Token.OptionCount = OptionCount;
|
|
Token.OptionList = OptionList;
|
|
Token.BufferSize = 0;
|
|
Token.Buffer = NULL;
|
|
Token.CheckPacket = Mtftp4GetInfoCheckPacket;
|
|
Token.TimeoutCallback = NULL;
|
|
Token.PacketNeeded = NULL;
|
|
|
|
Status = EfiMtftp4ReadFile (This, &Token);
|
|
|
|
if (EFI_ABORTED == Status) {
|
|
return State->Status;
|
|
}
|
|
|
|
return Status;
|
|
}
|
|
|
|
|
|
/**
|
|
Parse the packet into an array of options. The OptionList is allocated
|
|
by this function, and caller should free it when used.
|
|
|
|
@param This The MTFTP protocol instance
|
|
@param PacketLen The length of the packet
|
|
@param Packet The packet to parse
|
|
@param OptionCount The size of the OptionList array allocated.
|
|
@param OptionList The allocated option array to save the option
|
|
addresses.
|
|
|
|
@retval EFI_INVALID_PARAMETER The parameters are invalid.
|
|
@retval EFI_NOT_FOUND There is no valid option in the packet
|
|
@retval EFI_SUCCESS The packet is parsed.
|
|
|
|
**/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
EfiMtftp4ParseOptions (
|
|
IN EFI_MTFTP4_PROTOCOL *This,
|
|
IN UINT32 PacketLen,
|
|
IN EFI_MTFTP4_PACKET *Packet,
|
|
IN OUT UINT32 *OptionCount,
|
|
OUT EFI_MTFTP4_OPTION **OptionList OPTIONAL
|
|
)
|
|
{
|
|
EFI_STATUS Status;
|
|
|
|
if ((This == NULL) || (PacketLen < MTFTP4_OPCODE_LEN) ||
|
|
(Packet == NULL) || (OptionCount == NULL)) {
|
|
|
|
return EFI_INVALID_PARAMETER;
|
|
}
|
|
|
|
Status = Mtftp4ExtractOptions (Packet, PacketLen, OptionCount, OptionList);
|
|
|
|
if (EFI_ERROR (Status)) {
|
|
return Status;
|
|
}
|
|
|
|
if (*OptionCount == 0) {
|
|
return EFI_NOT_FOUND;
|
|
}
|
|
|
|
return EFI_SUCCESS;
|
|
}
|
|
|
|
|
|
/**
|
|
Check whether the override data is valid. It will first
|
|
validate whether the server is a valid unicast. If a gateway
|
|
is provided in the Override, it also check that it is a
|
|
unicast on the connected network.
|
|
|
|
@param Instance The MTFTP instance
|
|
@param Override The override data to validate.
|
|
|
|
@return TRUE if the override data is valid, otherwise FALSE.
|
|
|
|
**/
|
|
BOOLEAN
|
|
Mtftp4OverrideValid (
|
|
IN MTFTP4_PROTOCOL *Instance,
|
|
IN EFI_MTFTP4_OVERRIDE_DATA *Override
|
|
)
|
|
{
|
|
EFI_MTFTP4_CONFIG_DATA *Config;
|
|
IP4_ADDR Ip;
|
|
IP4_ADDR Netmask;
|
|
IP4_ADDR Gateway;
|
|
|
|
CopyMem (&Ip, &Override->ServerIp, sizeof (IP4_ADDR));
|
|
if (!Ip4IsUnicast (NTOHL (Ip), 0)) {
|
|
return FALSE;
|
|
}
|
|
|
|
Config = &Instance->Config;
|
|
|
|
CopyMem (&Gateway, &Override->GatewayIp, sizeof (IP4_ADDR));
|
|
Gateway = NTOHL (Gateway);
|
|
|
|
if (!Config->UseDefaultSetting && (Gateway != 0)) {
|
|
CopyMem (&Netmask, &Config->SubnetMask, sizeof (IP4_ADDR));
|
|
CopyMem (&Ip, &Config->StationIp, sizeof (IP4_ADDR));
|
|
|
|
Netmask = NTOHL (Netmask);
|
|
Ip = NTOHL (Ip);
|
|
|
|
if (!Ip4IsUnicast (Gateway, Netmask) || !IP4_NET_EQUAL (Gateway, Ip, Netmask)) {
|
|
return FALSE;
|
|
}
|
|
}
|
|
|
|
return TRUE;
|
|
}
|
|
|
|
|
|
/**
|
|
Poll the UDP to get the IP4 default address, which may be retrieved
|
|
by DHCP. The default time out value is 5 seconds. If IP has retrieved
|
|
the default address, the UDP is reconfigured.
|
|
|
|
@param Instance The Mtftp instance
|
|
@param UdpPort The UDP port to poll
|
|
@param UdpCfgData The UDP configure data to reconfigure the UDP
|
|
port.
|
|
|
|
@return TRUE if the default address is retrieved and UDP is reconfigured.
|
|
@return Otherwise FALSE.
|
|
|
|
**/
|
|
BOOLEAN
|
|
Mtftp4GetMapping (
|
|
IN MTFTP4_PROTOCOL *Instance,
|
|
IN UDP_IO_PORT *UdpPort,
|
|
IN EFI_UDP4_CONFIG_DATA *UdpCfgData
|
|
)
|
|
{
|
|
MTFTP4_SERVICE *Service;
|
|
EFI_IP4_MODE_DATA Ip4Mode;
|
|
EFI_UDP4_PROTOCOL *Udp;
|
|
EFI_STATUS Status;
|
|
|
|
ASSERT (Instance->Config.UseDefaultSetting);
|
|
|
|
Service = Instance->Service;
|
|
Udp = UdpPort->Udp;
|
|
|
|
Status = gBS->SetTimer (
|
|
Service->TimerToGetMap,
|
|
TimerRelative,
|
|
MTFTP4_TIME_TO_GETMAP * TICKS_PER_SECOND
|
|
);
|
|
if (EFI_ERROR (Status)) {
|
|
return FALSE;
|
|
}
|
|
|
|
while (!EFI_ERROR (gBS->CheckEvent (Service->TimerToGetMap))) {
|
|
Udp->Poll (Udp);
|
|
|
|
if (!EFI_ERROR (Udp->GetModeData (Udp, NULL, &Ip4Mode, NULL, NULL)) &&
|
|
Ip4Mode.IsConfigured) {
|
|
|
|
Udp->Configure (Udp, NULL);
|
|
return (BOOLEAN) (Udp->Configure (Udp, UdpCfgData) == EFI_SUCCESS);
|
|
}
|
|
}
|
|
|
|
return FALSE;
|
|
}
|
|
|
|
|
|
/**
|
|
Configure the UDP port for unicast receiving.
|
|
|
|
@param UdpIo The UDP port
|
|
@param Instance The MTFTP session
|
|
|
|
@retval EFI_SUCCESS The UDP port is successfully configured for the
|
|
session to unicast receive.
|
|
|
|
**/
|
|
EFI_STATUS
|
|
Mtftp4ConfigUnicastPort (
|
|
IN UDP_IO_PORT *UdpIo,
|
|
IN MTFTP4_PROTOCOL *Instance
|
|
)
|
|
{
|
|
EFI_MTFTP4_CONFIG_DATA *Config;
|
|
EFI_UDP4_CONFIG_DATA UdpConfig;
|
|
EFI_STATUS Status;
|
|
IP4_ADDR Ip;
|
|
|
|
Config = &Instance->Config;
|
|
|
|
UdpConfig.AcceptBroadcast = FALSE;
|
|
UdpConfig.AcceptPromiscuous = FALSE;
|
|
UdpConfig.AcceptAnyPort = FALSE;
|
|
UdpConfig.AllowDuplicatePort = FALSE;
|
|
UdpConfig.TypeOfService = 0;
|
|
UdpConfig.TimeToLive = 64;
|
|
UdpConfig.DoNotFragment = FALSE;
|
|
UdpConfig.ReceiveTimeout = 0;
|
|
UdpConfig.TransmitTimeout = 0;
|
|
UdpConfig.UseDefaultAddress = Config->UseDefaultSetting;
|
|
UdpConfig.StationAddress = Config->StationIp;
|
|
UdpConfig.SubnetMask = Config->SubnetMask;
|
|
UdpConfig.StationPort = 0;
|
|
UdpConfig.RemotePort = 0;
|
|
|
|
Ip = HTONL (Instance->ServerIp);
|
|
CopyMem (&UdpConfig.RemoteAddress, &Ip, sizeof (EFI_IPv4_ADDRESS));
|
|
|
|
Status = UdpIo->Udp->Configure (UdpIo->Udp, &UdpConfig);
|
|
|
|
if ((Status == EFI_NO_MAPPING) && Mtftp4GetMapping (Instance, UdpIo, &UdpConfig)) {
|
|
return EFI_SUCCESS;
|
|
}
|
|
|
|
if (!Config->UseDefaultSetting && !EFI_IP4_EQUAL (&mZeroIp4Addr, &Config->GatewayIp)) {
|
|
//
|
|
// The station IP address is manually configured and the Gateway IP is not 0.
|
|
// Add the default route for this UDP instance.
|
|
//
|
|
Status = UdpIo->Udp->Routes (UdpIo->Udp, FALSE, &mZeroIp4Addr, &mZeroIp4Addr, &Config->GatewayIp);
|
|
if (EFI_ERROR (Status)) {
|
|
UdpIo->Udp->Configure (UdpIo->Udp, NULL);
|
|
}
|
|
}
|
|
return Status;
|
|
}
|
|
|
|
|
|
/**
|
|
Start the MTFTP session to do the operation, such as read file,
|
|
write file, and read directory.
|
|
|
|
@param This The MTFTP session
|
|
@param Token The token than encapsues the user's request.
|
|
@param Operation The operation to do
|
|
|
|
@retval EFI_INVALID_PARAMETER Some of the parameters are invalid.
|
|
@retval EFI_NOT_STARTED The MTFTP session hasn't been configured.
|
|
@retval EFI_ALREADY_STARTED There is pending operation for the session.
|
|
@retval EFI_SUCCESS The operation is successfully started.
|
|
|
|
**/
|
|
EFI_STATUS
|
|
Mtftp4Start (
|
|
IN EFI_MTFTP4_PROTOCOL *This,
|
|
IN EFI_MTFTP4_TOKEN *Token,
|
|
IN UINT16 Operation
|
|
)
|
|
{
|
|
MTFTP4_PROTOCOL *Instance;
|
|
EFI_MTFTP4_OVERRIDE_DATA *Override;
|
|
EFI_MTFTP4_CONFIG_DATA *Config;
|
|
EFI_TPL OldTpl;
|
|
EFI_STATUS Status;
|
|
|
|
//
|
|
// Validate the parameters
|
|
//
|
|
if ((This == NULL) || (Token == NULL) || (Token->Filename == NULL) ||
|
|
((Token->OptionCount != 0) && (Token->OptionList == NULL))) {
|
|
return EFI_INVALID_PARAMETER;
|
|
}
|
|
|
|
//
|
|
// User must provide at least one method to collect the data for download.
|
|
//
|
|
if (((Operation == EFI_MTFTP4_OPCODE_RRQ) || (Operation == EFI_MTFTP4_OPCODE_DIR)) &&
|
|
((Token->Buffer == NULL) && (Token->CheckPacket == NULL))) {
|
|
return EFI_INVALID_PARAMETER;
|
|
}
|
|
|
|
//
|
|
// User must provide at least one method to provide the data for upload.
|
|
//
|
|
if ((Operation == EFI_MTFTP4_OPCODE_WRQ) &&
|
|
((Token->Buffer == NULL) && (Token->PacketNeeded == NULL))) {
|
|
return EFI_INVALID_PARAMETER;
|
|
}
|
|
|
|
Instance = MTFTP4_PROTOCOL_FROM_THIS (This);
|
|
|
|
Status = EFI_SUCCESS;
|
|
OldTpl = gBS->RaiseTPL (TPL_CALLBACK);
|
|
|
|
if (Instance->State != MTFTP4_STATE_CONFIGED) {
|
|
Status = EFI_NOT_STARTED;
|
|
}
|
|
|
|
if (Instance->Operation != 0) {
|
|
Status = EFI_ACCESS_DENIED;
|
|
}
|
|
|
|
if (EFI_ERROR (Status)) {
|
|
gBS->RestoreTPL (OldTpl);
|
|
return Status;
|
|
}
|
|
|
|
//
|
|
// Set the Operation now to prevent the application start other
|
|
// operations.
|
|
//
|
|
Instance->Operation = Operation;
|
|
Override = Token->OverrideData;
|
|
|
|
if ((Override != NULL) && !Mtftp4OverrideValid (Instance, Override)) {
|
|
Status = EFI_INVALID_PARAMETER;
|
|
goto ON_ERROR;
|
|
}
|
|
|
|
if (Token->OptionCount != 0) {
|
|
Status = Mtftp4ParseOption (
|
|
Token->OptionList,
|
|
Token->OptionCount,
|
|
TRUE,
|
|
&Instance->RequestOption
|
|
);
|
|
|
|
if (EFI_ERROR (Status)) {
|
|
goto ON_ERROR;
|
|
}
|
|
}
|
|
|
|
//
|
|
// Set the operation parameters from the configuration or override data.
|
|
//
|
|
Config = &Instance->Config;
|
|
Instance->Token = Token;
|
|
Instance->BlkSize = MTFTP4_DEFAULT_BLKSIZE;
|
|
|
|
CopyMem (&Instance->ServerIp, &Config->ServerIp, sizeof (IP4_ADDR));
|
|
Instance->ServerIp = NTOHL (Instance->ServerIp);
|
|
|
|
Instance->ListeningPort = Config->InitialServerPort;
|
|
Instance->ConnectedPort = 0;
|
|
|
|
CopyMem (&Instance->Gateway, &Config->GatewayIp, sizeof (IP4_ADDR));
|
|
Instance->Gateway = NTOHL (Instance->Gateway);
|
|
|
|
Instance->MaxRetry = Config->TryCount;
|
|
Instance->Timeout = Config->TimeoutValue;
|
|
Instance->Master = TRUE;
|
|
|
|
if (Override != NULL) {
|
|
CopyMem (&Instance->ServerIp, &Override->ServerIp, sizeof (IP4_ADDR));
|
|
CopyMem (&Instance->Gateway, &Override->GatewayIp, sizeof (IP4_ADDR));
|
|
|
|
Instance->ServerIp = NTOHL (Instance->ServerIp);
|
|
Instance->Gateway = NTOHL (Instance->Gateway);
|
|
|
|
Instance->ListeningPort = Override->ServerPort;
|
|
Instance->MaxRetry = Override->TryCount;
|
|
Instance->Timeout = Override->TimeoutValue;
|
|
}
|
|
|
|
if (Instance->ListeningPort == 0) {
|
|
Instance->ListeningPort = MTFTP4_DEFAULT_SERVER_PORT;
|
|
}
|
|
|
|
if (Instance->MaxRetry == 0) {
|
|
Instance->MaxRetry = MTFTP4_DEFAULT_RETRY;
|
|
}
|
|
|
|
if (Instance->Timeout == 0) {
|
|
Instance->Timeout = MTFTP4_DEFAULT_TIMEOUT;
|
|
}
|
|
|
|
//
|
|
// Config the unicast UDP child to send initial request
|
|
//
|
|
Status = Mtftp4ConfigUnicastPort (Instance->UnicastPort, Instance);
|
|
|
|
if (EFI_ERROR (Status)) {
|
|
goto ON_ERROR;
|
|
}
|
|
|
|
//
|
|
// Set initial status.
|
|
//
|
|
Token->Status = EFI_NOT_READY;
|
|
|
|
//
|
|
// Build and send an initial requests
|
|
//
|
|
if (Operation == EFI_MTFTP4_OPCODE_WRQ) {
|
|
Status = Mtftp4WrqStart (Instance, Operation);
|
|
} else {
|
|
Status = Mtftp4RrqStart (Instance, Operation);
|
|
}
|
|
|
|
gBS->RestoreTPL (OldTpl);
|
|
|
|
if (EFI_ERROR (Status)) {
|
|
goto ON_ERROR;
|
|
}
|
|
|
|
if (Token->Event != NULL) {
|
|
return EFI_SUCCESS;
|
|
}
|
|
|
|
//
|
|
// Return immediately for asynchronous operation or poll the
|
|
// instance for synchronous operation.
|
|
//
|
|
while (Token->Status == EFI_NOT_READY) {
|
|
This->Poll (This);
|
|
}
|
|
|
|
return Token->Status;
|
|
|
|
ON_ERROR:
|
|
Mtftp4CleanOperation (Instance, Status);
|
|
gBS->RestoreTPL (OldTpl);
|
|
|
|
return Status;
|
|
}
|
|
|
|
|
|
/**
|
|
Read a file from the server.
|
|
|
|
@param This The Mtftp protocol instance.
|
|
@param Token The user's request wrap token.
|
|
|
|
@retval EFI_SUCCESS The ReadFile has finished, the file has been
|
|
downloaded if it is synchronous operation,
|
|
otherwise it has been initated.
|
|
@retval Others Some error happened.
|
|
|
|
**/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
EfiMtftp4ReadFile (
|
|
IN EFI_MTFTP4_PROTOCOL *This,
|
|
IN EFI_MTFTP4_TOKEN *Token
|
|
)
|
|
{
|
|
return Mtftp4Start (This, Token, EFI_MTFTP4_OPCODE_RRQ);
|
|
}
|
|
|
|
|
|
/**
|
|
Upload a file to the server.
|
|
|
|
@param This The MTFTP protocol session
|
|
@param Token The user's request wrap token.
|
|
|
|
@retval EFI_SUCCESS The WriteFile has finished, the file has been
|
|
uploaded if it is synchronous operation, otherwise
|
|
it has been initated.
|
|
@retval Others Some error happened.
|
|
|
|
**/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
EfiMtftp4WriteFile (
|
|
IN EFI_MTFTP4_PROTOCOL *This,
|
|
IN EFI_MTFTP4_TOKEN *Token
|
|
)
|
|
{
|
|
return Mtftp4Start (This, Token, EFI_MTFTP4_OPCODE_WRQ);
|
|
}
|
|
|
|
|
|
/**
|
|
Read a directory from the server. The only difference
|
|
between ReadFile and ReadDirectory is the opcode used.
|
|
|
|
@param This The MTFTP protocol session
|
|
@param Token The user's request wrap token.
|
|
|
|
@retval EFI_SUCCESS The ReadDirectory has finished, the directory has
|
|
been downloaded as a file if it is synchronous
|
|
operation, otherwise it has been initated.
|
|
@retval Others Some error happened.
|
|
|
|
**/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
EfiMtftp4ReadDirectory (
|
|
IN EFI_MTFTP4_PROTOCOL *This,
|
|
IN EFI_MTFTP4_TOKEN *Token
|
|
)
|
|
{
|
|
return Mtftp4Start (This, Token, EFI_MTFTP4_OPCODE_DIR);
|
|
}
|
|
|
|
|
|
/**
|
|
Poll the network stack to accelerate the packet process.
|
|
|
|
@param This The MTFTP protocol instance.
|
|
|
|
@retval EFI_INVALID_PARAMETER This is NULL.
|
|
@retval EFI_NOT_STARTED The MTFTP session hasn't been configured.
|
|
@retval EFI_DEVICE_ERROR The MTFTP session has been destoried.
|
|
|
|
**/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
EfiMtftp4Poll (
|
|
IN EFI_MTFTP4_PROTOCOL *This
|
|
)
|
|
{
|
|
MTFTP4_PROTOCOL *Instance;
|
|
EFI_UDP4_PROTOCOL *Udp;
|
|
|
|
if (This == NULL) {
|
|
return EFI_INVALID_PARAMETER;
|
|
}
|
|
|
|
Instance = MTFTP4_PROTOCOL_FROM_THIS (This);
|
|
|
|
if (Instance->State == MTFTP4_STATE_UNCONFIGED) {
|
|
return EFI_NOT_STARTED;
|
|
} else if (Instance->State == MTFTP4_STATE_DESTORY) {
|
|
return EFI_DEVICE_ERROR;
|
|
}
|
|
|
|
Udp = Instance->UnicastPort->Udp;
|
|
return Udp->Poll (Udp);
|
|
}
|
|
|
|
EFI_MTFTP4_PROTOCOL gMtftp4ProtocolTemplate = {
|
|
EfiMtftp4GetModeData,
|
|
EfiMtftp4Configure,
|
|
EfiMtftp4GetInfo,
|
|
EfiMtftp4ParseOptions,
|
|
EfiMtftp4ReadFile,
|
|
EfiMtftp4WriteFile,
|
|
EfiMtftp4ReadDirectory,
|
|
EfiMtftp4Poll
|
|
};
|