[mirror_edk2.git] / MdeModulePkg / Universal / Network / Mtftp4Dxe / Mtftp4Rrq.c

/** @file\r
\r
Copyright (c) 2006 - 2007, Intel Corporation\r
All rights reserved. This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution.  The full text of the license may be found at\r
http://opensource.org/licenses/bsd-license.php\r
\r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
Module Name:\r
\r
  Mtftp4Rrq.c\r
\r
Abstract:\r
\r
  Routines to process Rrq (download)\r
\r
\r
**/\r
\r
#include "Mtftp4Impl.h"\r
\r
VOID\r
Mtftp4RrqInput (\r
  IN NET_BUF                *UdpPacket,\r
  IN UDP_POINTS             *Points,\r
  IN EFI_STATUS             IoStatus,\r
  IN VOID                   *Context\r
  );\r
\r
\r
/**\r
  Start the MTFTP session to download. It will first initialize some\r
  of the internal states then build and send a RRQ reqeuest packet, at\r
  last, it will start receive for the downloading.\r
\r
  @param  Instance              The Mtftp session\r
  @param  Operation             The MTFTP opcode, it may be a EFI_MTFTP4_OPCODE_RRQ\r
                                or EFI_MTFTP4_OPCODE_DIR.\r
\r
  @retval EFI_SUCCESS           The mtftp download session is started.\r
  @retval Others                Failed to start downloading.\r
\r
**/\r
EFI_STATUS\r
Mtftp4RrqStart (\r
  IN MTFTP4_PROTOCOL        *Instance,\r
  IN UINT16                 Operation\r
  )\r
{\r
  EFI_STATUS                Status;\r
\r
  //\r
  // The valid block number range are [1, 0xffff]. For example:\r
  // the client sends an RRQ request to the server, the server\r
  // transfers the DATA1 block. If option negoitation is ongoing,\r
  // the server will send back an OACK, then client will send ACK0.\r
  //\r
  Status = Mtftp4InitBlockRange (&Instance->Blocks, 1, 0xffff);\r
\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  Status = Mtftp4SendRequest (Instance);\r
\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  return UdpIoRecvDatagram (Instance->UnicastPort, Mtftp4RrqInput, Instance, 0);\r
}\r
\r
\r
/**\r
  Build and send a ACK packet for the download session.\r
\r
  @param  Instance              The Mtftp session\r
  @param  BlkNo                 The BlkNo to ack.\r
\r
  @retval EFI_OUT_OF_RESOURCES  Failed to allocate memory for the packet\r
  @retval EFI_SUCCESS           The ACK has been sent\r
  @retval Others                Failed to send the ACK.\r
\r
**/\r
EFI_STATUS\r
Mtftp4RrqSendAck (\r
  IN MTFTP4_PROTOCOL        *Instance,\r
  IN UINT16                 BlkNo\r
  )\r
{\r
  EFI_MTFTP4_PACKET         *Ack;\r
  NET_BUF                   *Packet;\r
\r
  Packet = NetbufAlloc (sizeof (EFI_MTFTP4_ACK_HEADER));\r
\r
  if (Packet == NULL) {\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
\r
  Ack = (EFI_MTFTP4_PACKET *) NetbufAllocSpace (\r
                                Packet,\r
                                sizeof (EFI_MTFTP4_ACK_HEADER),\r
                                FALSE\r
                                );\r
\r
  Ack->Ack.OpCode   = HTONS (EFI_MTFTP4_OPCODE_ACK);\r
  Ack->Ack.Block[0] = HTONS (BlkNo);\r
\r
  return Mtftp4SendPacket (Instance, Packet);\r
}\r
\r
\r
/**\r
  Deliver the received data block to the user, which can be saved\r
  in the user provide buffer or through the CheckPacket callback.\r
\r
  @param  Instance              The Mtftp session\r
  @param  Packet                The received data packet\r
  @param  Len                   The packet length\r
\r
  @retval EFI_SUCCESS           The data is saved successfully\r
  @retval EFI_ABORTED           The user tells to abort by return an error  through\r
                                CheckPacket\r
  @retval EFI_BUFFER_TOO_SMALL  The user's buffer is too small and buffer length is\r
                                 updated to the actual buffer size needed.\r
\r
**/\r
EFI_STATUS\r
Mtftp4RrqSaveBlock (\r
  IN MTFTP4_PROTOCOL        *Instance,\r
  IN EFI_MTFTP4_PACKET      *Packet,\r
  IN UINT32                 Len\r
  )\r
{\r
  EFI_MTFTP4_TOKEN          *Token;\r
  EFI_STATUS                Status;\r
  UINT16                    Block;\r
  UINT64                    Start;\r
  UINT32                    DataLen;\r
\r
  Token   = Instance->Token;\r
  Block   = NTOHS (Packet->Data.Block);\r
  DataLen = Len - MTFTP4_DATA_HEAD_LEN;\r
\r
  //\r
  // This is the last block, save the block no\r
  //\r
  if (DataLen < Instance->BlkSize) {\r
    Instance->LastBlock = Block;\r
    Mtftp4SetLastBlockNum (&Instance->Blocks, Block);\r
  }\r
\r
  //\r
  // Remove this block number from the file hole. If Mtftp4RemoveBlockNum\r
  // returns EFI_NOT_FOUND, the block has been saved, don't save it again.\r
  //\r
  Status = Mtftp4RemoveBlockNum (&Instance->Blocks, Block);\r
\r
  if (Status == EFI_NOT_FOUND) {\r
    return EFI_SUCCESS;\r
  } else if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  if (Token->CheckPacket != NULL) {\r
    Status = Token->CheckPacket (&Instance->Mtftp4, Token, (UINT16) Len, Packet);\r
\r
    if (EFI_ERROR (Status)) {\r
      Mtftp4SendError (\r
        Instance,\r
        EFI_MTFTP4_ERRORCODE_ILLEGAL_OPERATION,\r
        (UINT8 *) "User aborted download"\r
        );\r
\r
      return EFI_ABORTED;\r
    }\r
  }\r
\r
  if (Token->Buffer != NULL) {\r
    Start = MultU64x32 (Block - 1, Instance->BlkSize);\r
\r
    if (Start + DataLen <= Token->BufferSize) {\r
      NetCopyMem ((UINT8 *) Token->Buffer + Start, Packet->Data.Data, DataLen);\r
\r
      //\r
      // Update the file size when received the last block\r
      //\r
      if (Instance->LastBlock == Block) {\r
        Token->BufferSize = Start + DataLen;\r
      }\r
\r
    } else if (Instance->LastBlock != 0) {\r
      //\r
      // Don't save the data if the buffer is too small, return\r
      // EFI_BUFFER_TOO_SMALL if received the last packet. This\r
      // will give a accurate file length.\r
      //\r
      Token->BufferSize = Start + DataLen;\r
\r
      Mtftp4SendError (\r
        Instance,\r
        EFI_MTFTP4_ERRORCODE_DISK_FULL,\r
        (UINT8 *) "User provided memory block is too small"\r
        );\r
\r
      return EFI_BUFFER_TOO_SMALL;\r
    }\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r
\r
\r
/**\r
  Function to process the received data packets. It will save the block\r
  then send back an ACK if it is active.\r
\r
  @param  Instance              The downloading MTFTP session\r
  @param  Packet                The packet received\r
  @param  Len                   The length of the packet\r
  @param  Multicast             Whether this packet is multicast or unicast\r
  @param  Completed             Return whether the download has completed\r
\r
  @retval EFI_SUCCESS           The data packet is successfully processed\r
  @retval EFI_ABORTED           The download is aborted by the user\r
  @retval EFI_BUFFER_TOO_SMALL  The user provided buffer is too small\r
\r
**/\r
EFI_STATUS\r
Mtftp4RrqHandleData (\r
  IN  MTFTP4_PROTOCOL       *Instance,\r
  IN  EFI_MTFTP4_PACKET     *Packet,\r
  IN  UINT32                Len,\r
  IN  BOOLEAN               Multicast,\r
  OUT BOOLEAN               *Completed\r
  )\r
{\r
  EFI_STATUS                Status;\r
  UINT16                    BlockNum;\r
  INTN                      Expected;\r
\r
  *Completed  = FALSE;\r
  BlockNum    = NTOHS (Packet->Data.Block);\r
  Expected    = Mtftp4GetNextBlockNum (&Instance->Blocks);\r
\r
  ASSERT (Expected >= 0);\r
\r
  //\r
  // If we are active and received an unexpected packet, retransmit\r
  // the last ACK then restart receiving. If we are passive, save\r
  // the block.\r
  //\r
  if (Instance->Master && (Expected != BlockNum)) {\r
    Mtftp4Retransmit (Instance);\r
    return EFI_SUCCESS;\r
  }\r
\r
  Status = Mtftp4RrqSaveBlock (Instance, Packet, Len);\r
\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  //\r
  // Reset the passive client's timer whenever it received a\r
  // valid data packet.\r
  //\r
  if (!Instance->Master) {\r
    Mtftp4SetTimeout (Instance);\r
  }\r
\r
  //\r
  // Check whether we have received all the blocks. Send the ACK if we\r
  // are active (unicast client or master client for multicast download).\r
  // If we have received all the blocks, send an ACK even if we are passive\r
  // to tell the server that we are done.\r
  //\r
  Expected = Mtftp4GetNextBlockNum (&Instance->Blocks);\r
\r
  if (Instance->Master || (Expected < 0)) {\r
    if (Expected < 0) {\r
      //\r
      // If we are passive client, then the just received Block maybe\r
      // isn't the last block. We need to send an ACK to the last block\r
      // to inform the server that we are done. If we are active client,\r
      // the Block == Instance->LastBlock.\r
      //\r
      BlockNum   = Instance->LastBlock;\r
      *Completed = TRUE;\r
\r
    } else {\r
      BlockNum = (UINT16) (Expected - 1);\r
    }\r
\r
    Mtftp4RrqSendAck (Instance, BlockNum);\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r
\r
\r
/**\r
  Validate whether the options received in the server's OACK packet is valid.\r
  The options are valid only if:\r
  1. The server doesn't include options not requested by us\r
  2. The server can only use smaller blksize than that is requested\r
  3. The server can only use the same timeout as requested\r
  4. The server doesn't change its multicast channel.\r
\r
  @param  This                  The downloading Mtftp session\r
  @param  Reply                 The options in the OACK packet\r
  @param  Request               The requested options\r
\r
  @return TRUE if the options in the OACK is OK, otherwise FALSE.\r
\r
**/\r
BOOLEAN\r
Mtftp4RrqOackValid (\r
  IN MTFTP4_PROTOCOL        *This,\r
  IN MTFTP4_OPTION          *Reply,\r
  IN MTFTP4_OPTION          *Request\r
  )\r
{\r
\r
  //\r
  // It is invalid for server to return options we don't request\r
  //\r
  if ((Reply->Exist &~Request->Exist) != 0) {\r
    return FALSE;\r
  }\r
\r
  //\r
  // Server can only specify a smaller block size to be used and\r
  // return the timeout matches that requested.\r
  //\r
  if (((Reply->Exist & MTFTP4_BLKSIZE_EXIST) && (Reply->BlkSize > Request->BlkSize)) ||\r
      ((Reply->Exist & MTFTP4_TIMEOUT_EXIST) && (Reply->Timeout != Request->Timeout))) {\r
    return FALSE;\r
  }\r
\r
  //\r
  // The server can send ",,master" to client to change its master\r
  // setting. But if it use the specific multicast channel, it can't\r
  // change the setting.\r
  //\r
  if ((Reply->Exist & MTFTP4_MCAST_EXIST) && (This->McastIp != 0)) {\r
    if ((Reply->McastIp != 0) && (Reply->McastIp != This->McastIp)) {\r
      return FALSE;\r
    }\r
\r
    if ((Reply->McastPort != 0) && (Reply->McastPort != This->McastPort)) {\r
      return FALSE;\r
    }\r
  }\r
\r
  return TRUE;\r
}\r
\r
\r
/**\r
  Configure a UDP IO port to receive the multicast.\r
\r
  @param  McastIo               The UDP IO port to configure\r
  @param  Context               The opaque parameter to the function which is the\r
                                MTFTP session.\r
\r
  @retval EFI_SUCCESS           The udp child is successfully configured.\r
  @retval Others                Failed to configure the UDP child.\r
\r
**/\r
STATIC\r
EFI_STATUS\r
Mtftp4RrqConfigMcastPort (\r
  IN UDP_IO_PORT            *McastIo,\r
  IN VOID                   *Context\r
  )\r
{\r
  MTFTP4_PROTOCOL           *Instance;\r
  EFI_MTFTP4_CONFIG_DATA    *Config;\r
  EFI_UDP4_CONFIG_DATA      UdpConfig;\r
  EFI_IPv4_ADDRESS          Group;\r
  EFI_STATUS                Status;\r
  IP4_ADDR                  Ip;\r
\r
  Instance                     = (MTFTP4_PROTOCOL *) Context;\r
  Config                       = &Instance->Config;\r
\r
  UdpConfig.AcceptBroadcast    = FALSE;\r
  UdpConfig.AcceptPromiscuous  = FALSE;\r
  UdpConfig.AcceptAnyPort      = FALSE;\r
  UdpConfig.AllowDuplicatePort = FALSE;\r
  UdpConfig.TypeOfService      = 0;\r
  UdpConfig.TimeToLive         = 64;\r
  UdpConfig.DoNotFragment      = FALSE;\r
  UdpConfig.ReceiveTimeout     = 0;\r
  UdpConfig.TransmitTimeout    = 0;\r
  UdpConfig.UseDefaultAddress  = Config->UseDefaultSetting;\r
  UdpConfig.StationAddress     = Config->StationIp;\r
  UdpConfig.SubnetMask         = Config->SubnetMask;\r
  UdpConfig.StationPort        = Instance->McastPort;\r
  UdpConfig.RemotePort         = 0;\r
\r
  Ip = HTONL (Instance->ServerIp);\r
  NetCopyMem (&UdpConfig.RemoteAddress, &Ip, sizeof (EFI_IPv4_ADDRESS));\r
\r
  Status = McastIo->Udp->Configure (McastIo->Udp, &UdpConfig);\r
\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  //\r
  // join the multicast group\r
  //\r
  Ip = HTONL (Instance->McastIp);\r
  NetCopyMem (&Group, &Ip, sizeof (EFI_IPv4_ADDRESS));\r
\r
  return McastIo->Udp->Groups (McastIo->Udp, TRUE, &Group);\r
}\r
\r
\r
/**\r
  Function to process the OACK. It will first validate the OACK\r
  packet, then update the various negotiated parameters.\r
\r
  @param  Instance              The download MTFTP session\r
  @param  Packet                The packet received\r
  @param  Len                   The packet length\r
  @param  Multicast             Whether this packet is received as a multicast\r
  @param  Completed             Returns whether the download has completed. NOT\r
                                used  by this function.\r
\r
  @retval EFI_DEVICE_ERROR      Failed to create/start a multicast UDP child\r
  @retval EFI_TFTP_ERROR        Some error happened during the process\r
  @retval EFI_SUCCESS           The OACK is successfully processed.\r
\r
**/\r
EFI_STATUS\r
Mtftp4RrqHandleOack (\r
  IN  MTFTP4_PROTOCOL       *Instance,\r
  IN  EFI_MTFTP4_PACKET     *Packet,\r
  IN  UINT32                Len,\r
  IN  BOOLEAN               Multicast,\r
  OUT BOOLEAN               *Completed\r
  )\r
{\r
  MTFTP4_OPTION             Reply;\r
  EFI_STATUS                Status;\r
  INTN                      Expected;\r
\r
  *Completed = FALSE;\r
\r
  //\r
  // If already started the master download, don't change the\r
  // setting. Master download always succeeds.\r
  //\r
  Expected = Mtftp4GetNextBlockNum (&Instance->Blocks);\r
  ASSERT (Expected != -1);\r
\r
  if (Instance->Master && (Expected != 1)) {\r
    return EFI_SUCCESS;\r
  }\r
\r
  //\r
  // Parse and validate the options from server\r
  //\r
  NetZeroMem (&Reply, sizeof (MTFTP4_OPTION));\r
\r
  Status = Mtftp4ParseOptionOack (Packet, Len, &Reply);\r
\r
  if (EFI_ERROR (Status) ||\r
      !Mtftp4RrqOackValid (Instance, &Reply, &Instance->RequestOption)) {\r
    //\r
    // Don't send an ERROR packet if the error is EFI_OUT_OF_RESOURCES.\r
    //\r
    if (Status != EFI_OUT_OF_RESOURCES) {\r
      Mtftp4SendError (\r
        Instance,\r
        EFI_MTFTP4_ERRORCODE_ILLEGAL_OPERATION,\r
        (UINT8 *) "Mal-formated OACK packet"\r
        );\r
    }\r
\r
    return EFI_TFTP_ERROR;\r
  }\r
\r
  if (Reply.Exist & MTFTP4_MCAST_EXIST) {\r
\r
    //\r
    // Save the multicast info. Always update the Master, only update the\r
    // multicast IP address, block size, timeoute at the first time. If IP\r
    // address is updated, create a UDP child to receive the multicast.\r
    //\r
    Instance->Master = Reply.Master;\r
\r
    if (Instance->McastIp == 0) {\r
      if ((Reply.McastIp == 0) || (Reply.McastPort == 0)) {\r
        Mtftp4SendError (\r
          Instance,\r
          EFI_MTFTP4_ERRORCODE_ILLEGAL_OPERATION,\r
          (UINT8 *) "Illegal multicast setting"\r
          );\r
\r
        return EFI_TFTP_ERROR;\r
      }\r
\r
      //\r
      // Create a UDP child then start receive the multicast from it.\r
      //\r
      Instance->McastIp      = Reply.McastIp;\r
      Instance->McastPort    = Reply.McastPort;\r
      Instance->McastUdpPort = UdpIoCreatePort (\r
                                 Instance->Service->Controller,\r
                                 Instance->Service->Image,\r
                                 Mtftp4RrqConfigMcastPort,\r
                                 Instance\r
                                 );\r
\r
      if (Instance->McastUdpPort == NULL) {\r
        return EFI_DEVICE_ERROR;\r
      }\r
\r
      Status = UdpIoRecvDatagram (Instance->McastUdpPort, Mtftp4RrqInput, Instance, 0);\r
\r
      if (EFI_ERROR (Status)) {\r
        Mtftp4SendError (\r
          Instance,\r
          EFI_MTFTP4_ERRORCODE_ACCESS_VIOLATION,\r
          (UINT8 *) "Failed to create socket to receive multicast packet"\r
          );\r
\r
        return Status;\r
      }\r
\r
      //\r
      // Update the parameters used.\r
      //\r
      if (Reply.BlkSize != 0) {\r
        Instance->BlkSize = Reply.BlkSize;\r
      }\r
\r
      if (Reply.Timeout != 0) {\r
        Instance->Timeout = Reply.Timeout;\r
      }\r
    }\r
\r
  } else {\r
    Instance->Master = TRUE;\r
\r
    if (Reply.BlkSize != 0) {\r
      Instance->BlkSize = Reply.BlkSize;\r
    }\r
\r
    if (Reply.Timeout != 0) {\r
      Instance->Timeout = Reply.Timeout;\r
    }\r
  }\r
\r
  //\r
  // Send an ACK to (Expected - 1) which is 0 for unicast download,\r
  // or tell the server we want to receive the Expected block.\r
  //\r
  return Mtftp4RrqSendAck (Instance, (UINT16) (Expected - 1));\r
}\r
\r
\r
/**\r
  The packet process callback for MTFTP download.\r
\r
  @param  UdpPacket             The packet received\r
  @param  Points                The local/remote access point of the packet\r
  @param  IoStatus              The status of the receiving\r
  @param  Context               Opaque parameter, which is the MTFTP session\r
\r
  @return None\r
\r
**/\r
VOID\r
Mtftp4RrqInput (\r
  IN NET_BUF                *UdpPacket,\r
  IN UDP_POINTS             *Points,\r
  IN EFI_STATUS             IoStatus,\r
  IN VOID                   *Context\r
  )\r
{\r
  MTFTP4_PROTOCOL           *Instance;\r
  EFI_MTFTP4_PACKET         *Packet;\r
  BOOLEAN                   Completed;\r
  BOOLEAN                   Multicast;\r
  EFI_STATUS                Status;\r
  UINT16                    Opcode;\r
  UINT32                    Len;\r
\r
  Instance  = (MTFTP4_PROTOCOL *) Context;\r
  NET_CHECK_SIGNATURE (Instance, MTFTP4_PROTOCOL_SIGNATURE);\r
\r
  Status    = EFI_SUCCESS;\r
  Packet    = NULL;\r
  Completed = FALSE;\r
  Multicast = FALSE;\r
\r
  if (EFI_ERROR (IoStatus)) {\r
    Status = IoStatus;\r
    goto ON_EXIT;\r
  }\r
\r
  ASSERT (UdpPacket != NULL);\r
\r
  //\r
  // Find the port this packet is from to restart receive correctly.\r
  //\r
  Multicast = (BOOLEAN) (Points->LocalAddr == Instance->McastIp);\r
\r
  if (UdpPacket->TotalSize < MTFTP4_OPCODE_LEN) {\r
    goto ON_EXIT;\r
  }\r
\r
  //\r
  // Client send initial request to server's listening port. Server\r
  // will select a UDP port to communicate with the client. The server\r
  // is required to use the same port as RemotePort to multicast the\r
  // data.\r
  //\r
  if (Points->RemotePort != Instance->ConnectedPort) {\r
    if (Instance->ConnectedPort != 0) {\r
      goto ON_EXIT;\r
    } else {\r
      Instance->ConnectedPort = Points->RemotePort;\r
    }\r
  }\r
\r
  //\r
  // Copy the MTFTP packet to a continuous buffer if it isn't already so.\r
  //\r
  Len = UdpPacket->TotalSize;\r
\r
  if (UdpPacket->BlockOpNum > 1) {\r
    Packet = NetAllocatePool (Len);\r
\r
    if (Packet == NULL) {\r
      Status = EFI_OUT_OF_RESOURCES;\r
      goto ON_EXIT;\r
    }\r
\r
    NetbufCopy (UdpPacket, 0, Len, (UINT8 *) Packet);\r
\r
  } else {\r
    Packet = (EFI_MTFTP4_PACKET *) NetbufGetByte (UdpPacket, 0, NULL);\r
  }\r
\r
  Opcode = NTOHS (Packet->OpCode);\r
\r
  //\r
  // Call the user's CheckPacket if provided. Abort the transmission\r
  // if CheckPacket returns an EFI_ERROR code.\r
  //\r
  if ((Instance->Token->CheckPacket != NULL) &&\r
      ((Opcode == EFI_MTFTP4_OPCODE_OACK) || (Opcode == EFI_MTFTP4_OPCODE_ERROR))) {\r
\r
    Status = Instance->Token->CheckPacket (\r
                                &Instance->Mtftp4,\r
                                Instance->Token,\r
                                (UINT16) Len,\r
                                Packet\r
                                );\r
\r
    if (EFI_ERROR (Status)) {\r
      //\r
      // Send an error message to the server to inform it\r
      //\r
      if (Opcode != EFI_MTFTP4_OPCODE_ERROR) {\r
        Mtftp4SendError (\r
          Instance,\r
          EFI_MTFTP4_ERRORCODE_REQUEST_DENIED,\r
          (UINT8 *) "User aborted the transfer"\r
          );\r
      }\r
\r
      Status = EFI_ABORTED;\r
      goto ON_EXIT;\r
    }\r
  }\r
\r
  switch (Opcode) {\r
  case EFI_MTFTP4_OPCODE_DATA:\r
    if ((Len > (UINT32) (MTFTP4_DATA_HEAD_LEN + Instance->BlkSize)) ||\r
        (Len < (UINT32) MTFTP4_DATA_HEAD_LEN)) {\r
      goto ON_EXIT;\r
    }\r
\r
    Status = Mtftp4RrqHandleData (Instance, Packet, Len, Multicast, &Completed);\r
    break;\r
\r
  case EFI_MTFTP4_OPCODE_OACK:\r
    if (Multicast || (Len <= MTFTP4_OPCODE_LEN)) {\r
      goto ON_EXIT;\r
    }\r
\r
    Status = Mtftp4RrqHandleOack (Instance, Packet, Len, Multicast, &Completed);\r
    break;\r
\r
  case EFI_MTFTP4_OPCODE_ERROR:\r
    Status = EFI_TFTP_ERROR;\r
    break;\r
  }\r
\r
ON_EXIT:\r
\r
  //\r
  // Free the resources, then if !EFI_ERROR (Status), restart the\r
  // receive, otherwise end the session.\r
  //\r
  if ((Packet != NULL) && (UdpPacket->BlockOpNum > 1)) {\r
    NetFreePool (Packet);\r
  }\r
\r
  if (UdpPacket != NULL) {\r
    NetbufFree (UdpPacket);\r
  }\r
\r
  if (!EFI_ERROR (Status) && !Completed) {\r
    if (Multicast) {\r
      Status = UdpIoRecvDatagram (Instance->McastUdpPort, Mtftp4RrqInput, Instance, 0);\r
    } else {\r
      Status = UdpIoRecvDatagram (Instance->UnicastPort, Mtftp4RrqInput, Instance, 0);\r
    }\r
  }\r
\r
  if (EFI_ERROR (Status) || Completed) {\r
    Mtftp4CleanOperation (Instance, Status);\r
  }\r
}\r
Commit	Line	Data
772db4bb	1	/** @file\r
	2	\r
	3	Copyright (c) 2006 - 2007, Intel Corporation\r
	4	All rights reserved. This program and the accompanying materials\r
	5	are licensed and made available under the terms and conditions of the BSD License\r
	6	which accompanies this distribution. The full text of the license may be found at\r
	7	http://opensource.org/licenses/bsd-license.php\r
	8	\r
	9	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
	10	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
	11	\r
	12	Module Name:\r
	13	\r
	14	Mtftp4Rrq.c\r
	15	\r
	16	Abstract:\r
	17	\r
	18	Routines to process Rrq (download)\r
	19	\r
	20	\r
	21	**/\r
	22	\r
	23	#include "Mtftp4Impl.h"\r
	24	\r
	25	VOID\r
	26	Mtftp4RrqInput (\r
	27	IN NET_BUF *UdpPacket,\r
	28	IN UDP_POINTS *Points,\r
	29	IN EFI_STATUS IoStatus,\r
	30	IN VOID *Context\r
	31	);\r
	32	\r
	33	\r
	34	/**\r
	35	Start the MTFTP session to download. It will first initialize some\r
	36	of the internal states then build and send a RRQ reqeuest packet, at\r
	37	last, it will start receive for the downloading.\r
	38	\r
	39	@param Instance The Mtftp session\r
	40	@param Operation The MTFTP opcode, it may be a EFI_MTFTP4_OPCODE_RRQ\r
	41	or EFI_MTFTP4_OPCODE_DIR.\r
	42	\r
	43	@retval EFI_SUCCESS The mtftp download session is started.\r
	44	@retval Others Failed to start downloading.\r
	45	\r
	46	**/\r
	47	EFI_STATUS\r
	48	Mtftp4RrqStart (\r
	49	IN MTFTP4_PROTOCOL *Instance,\r
	50	IN UINT16 Operation\r
	51	)\r
	52	{\r
	53	EFI_STATUS Status;\r
	54	\r
	55	//\r
	56	// The valid block number range are [1, 0xffff]. For example:\r
	57	// the client sends an RRQ request to the server, the server\r
	58	// transfers the DATA1 block. If option negoitation is ongoing,\r
	59	// the server will send back an OACK, then client will send ACK0.\r
	60	//\r
	61	Status = Mtftp4InitBlockRange (&Instance->Blocks, 1, 0xffff);\r
	62	\r
	63	if (EFI_ERROR (Status)) {\r
	64	return Status;\r
65	}\r
66	\r
67	Status = Mtftp4SendRequest (Instance);\r
68	\r
69	if (EFI_ERROR (Status)) {\r
70	return Status;\r
71	}\r
72	\r
73	return UdpIoRecvDatagram (Instance->UnicastPort, Mtftp4RrqInput, Instance, 0);\r
74	}\r
75	\r
76	\r
77	/**\r
78	Build and send a ACK packet for the download session.\r
79	\r
80	@param Instance The Mtftp session\r
81	@param BlkNo The BlkNo to ack.\r
82	\r
83	@retval EFI_OUT_OF_RESOURCES Failed to allocate memory for the packet\r
84	@retval EFI_SUCCESS The ACK has been sent\r
85	@retval Others Failed to send the ACK.\r
86	\r
87	**/\r
88	EFI_STATUS\r
89	Mtftp4RrqSendAck (\r
90	IN MTFTP4_PROTOCOL *Instance,\r
91	IN UINT16 BlkNo\r
92	)\r
93	{\r
94	EFI_MTFTP4_PACKET *Ack;\r
95	NET_BUF *Packet;\r
96	\r
97	Packet = NetbufAlloc (sizeof (EFI_MTFTP4_ACK_HEADER));\r
98	\r
99	if (Packet == NULL) {\r
100	return EFI_OUT_OF_RESOURCES;\r
101	}\r
102	\r
103	Ack = (EFI_MTFTP4_PACKET *) NetbufAllocSpace (\r
104	Packet,\r
105	sizeof (EFI_MTFTP4_ACK_HEADER),\r
106	FALSE\r
107	);\r
108	\r
109	Ack->Ack.OpCode = HTONS (EFI_MTFTP4_OPCODE_ACK);\r
110	Ack->Ack.Block[0] = HTONS (BlkNo);\r
111	\r
112	return Mtftp4SendPacket (Instance, Packet);\r
113	}\r
114	\r
115	\r
116	/**\r
117	Deliver the received data block to the user, which can be saved\r
118	in the user provide buffer or through the CheckPacket callback.\r
119	\r
120	@param Instance The Mtftp session\r
121	@param Packet The received data packet\r
122	@param Len The packet length\r
123	\r
124	@retval EFI_SUCCESS The data is saved successfully\r
125	@retval EFI_ABORTED The user tells to abort by return an error through\r
126	CheckPacket\r
127	@retval EFI_BUFFER_TOO_SMALL The user's buffer is too small and buffer length is\r
128	updated to the actual buffer size needed.\r
129	\r
130	**/\r
131	EFI_STATUS\r
132	Mtftp4RrqSaveBlock (\r
133	IN MTFTP4_PROTOCOL *Instance,\r
134	IN EFI_MTFTP4_PACKET *Packet,\r
135	IN UINT32 Len\r
136	)\r
137	{\r
138	EFI_MTFTP4_TOKEN *Token;\r
139	EFI_STATUS Status;\r
140	UINT16 Block;\r
141	UINT64 Start;\r
142	UINT32 DataLen;\r
143	\r
144	Token = Instance->Token;\r
145	Block = NTOHS (Packet->Data.Block);\r
146	DataLen = Len - MTFTP4_DATA_HEAD_LEN;\r
147	\r
148	//\r
149	// This is the last block, save the block no\r
150	//\r
151	if (DataLen < Instance->BlkSize) {\r
152	Instance->LastBlock = Block;\r
153	Mtftp4SetLastBlockNum (&Instance->Blocks, Block);\r
154	}\r
155	\r
156	//\r
157	// Remove this block number from the file hole. If Mtftp4RemoveBlockNum\r
158	// returns EFI_NOT_FOUND, the block has been saved, don't save it again.\r
159	//\r
160	Status = Mtftp4RemoveBlockNum (&Instance->Blocks, Block);\r
161	\r
162	if (Status == EFI_NOT_FOUND) {\r
163	return EFI_SUCCESS;\r
164	} else if (EFI_ERROR (Status)) {\r
165	return Status;\r
166	}\r
167	\r
168	if (Token->CheckPacket != NULL) {\r
169	Status = Token->CheckPacket (&Instance->Mtftp4, Token, (UINT16) Len, Packet);\r
170	\r
171	if (EFI_ERROR (Status)) {\r
172	Mtftp4SendError (\r
173	Instance,\r
174	EFI_MTFTP4_ERRORCODE_ILLEGAL_OPERATION,\r
67a58d0f	175	(UINT8 *) "User aborted download"\r
772db4bb	176	);\r
	177	\r
	178	return EFI_ABORTED;\r
	179	}\r
	180	}\r
	181	\r
	182	if (Token->Buffer != NULL) {\r
	183	Start = MultU64x32 (Block - 1, Instance->BlkSize);\r
	184	\r
	185	if (Start + DataLen <= Token->BufferSize) {\r
	186	NetCopyMem ((UINT8 *) Token->Buffer + Start, Packet->Data.Data, DataLen);\r
	187	\r
	188	//\r
	189	// Update the file size when received the last block\r
	190	//\r
	191	if (Instance->LastBlock == Block) {\r
	192	Token->BufferSize = Start + DataLen;\r
	193	}\r
	194	\r
	195	} else if (Instance->LastBlock != 0) {\r
	196	//\r
	197	// Don't save the data if the buffer is too small, return\r
	198	// EFI_BUFFER_TOO_SMALL if received the last packet. This\r
	199	// will give a accurate file length.\r
	200	//\r
	201	Token->BufferSize = Start + DataLen;\r
	202	\r
	203	Mtftp4SendError (\r
	204	Instance,\r
	205	EFI_MTFTP4_ERRORCODE_DISK_FULL,\r
67a58d0f	206	(UINT8 *) "User provided memory block is too small"\r
772db4bb	207	);\r
	208	\r
	209	return EFI_BUFFER_TOO_SMALL;\r
	210	}\r
	211	}\r
	212	\r
	213	return EFI_SUCCESS;\r
	214	}\r
	215	\r
	216	\r
	217	/**\r
	218	Function to process the received data packets. It will save the block\r
	219	then send back an ACK if it is active.\r
	220	\r
	221	@param Instance The downloading MTFTP session\r
	222	@param Packet The packet received\r
	223	@param Len The length of the packet\r
	224	@param Multicast Whether this packet is multicast or unicast\r
	225	@param Completed Return whether the download has completed\r
	226	\r
	227	@retval EFI_SUCCESS The data packet is successfully processed\r
	228	@retval EFI_ABORTED The download is aborted by the user\r
	229	@retval EFI_BUFFER_TOO_SMALL The user provided buffer is too small\r
	230	\r
	231	**/\r
	232	EFI_STATUS\r
	233	Mtftp4RrqHandleData (\r
	234	IN MTFTP4_PROTOCOL *Instance,\r
	235	IN EFI_MTFTP4_PACKET *Packet,\r
	236	IN UINT32 Len,\r
	237	IN BOOLEAN Multicast,\r
	238	OUT BOOLEAN *Completed\r
	239	)\r
	240	{\r
	241	EFI_STATUS Status;\r
	242	UINT16 BlockNum;\r
	243	INTN Expected;\r
	244	\r
	245	*Completed = FALSE;\r
	246	BlockNum = NTOHS (Packet->Data.Block);\r
	247	Expected = Mtftp4GetNextBlockNum (&Instance->Blocks);\r
	248	\r
	249	ASSERT (Expected >= 0);\r
	250	\r
	251	//\r
	252	// If we are active and received an unexpected packet, retransmit\r
	253	// the last ACK then restart receiving. If we are passive, save\r
	254	// the block.\r
	255	//\r
	256	if (Instance->Master && (Expected != BlockNum)) {\r
	257	Mtftp4Retransmit (Instance);\r
	258	return EFI_SUCCESS;\r
	259	}\r
	260	\r
	261	Status = Mtftp4RrqSaveBlock (Instance, Packet, Len);\r
	262	\r
	263	if (EFI_ERROR (Status)) {\r
	264	return Status;\r
	265	}\r
	266	\r
	267	//\r
	268	// Reset the passive client's timer whenever it received a\r
	269	// valid data packet.\r
	270	//\r
271	if (!Instance->Master) {\r
272	Mtftp4SetTimeout (Instance);\r
273	}\r
274	\r
275	//\r
276	// Check whether we have received all the blocks. Send the ACK if we\r
277	// are active (unicast client or master client for multicast download).\r
278	// If we have received all the blocks, send an ACK even if we are passive\r
279	// to tell the server that we are done.\r
280	//\r
281	Expected = Mtftp4GetNextBlockNum (&Instance->Blocks);\r
282	\r
283	if (Instance->Master \|\| (Expected < 0)) {\r
284	if (Expected < 0) {\r
285	//\r
286	// If we are passive client, then the just received Block maybe\r
287	// isn't the last block. We need to send an ACK to the last block\r
288	// to inform the server that we are done. If we are active client,\r
289	// the Block == Instance->LastBlock.\r
290	//\r
291	BlockNum = Instance->LastBlock;\r
292	*Completed = TRUE;\r
293	\r
294	} else {\r
295	BlockNum = (UINT16) (Expected - 1);\r
296	}\r
297	\r
298	Mtftp4RrqSendAck (Instance, BlockNum);\r
299	}\r
300	\r
301	return EFI_SUCCESS;\r
302	}\r
303	\r
304	\r
305	/**\r
306	Validate whether the options received in the server's OACK packet is valid.\r
307	The options are valid only if:\r
308	1. The server doesn't include options not requested by us\r
309	2. The server can only use smaller blksize than that is requested\r
310	3. The server can only use the same timeout as requested\r
311	4. The server doesn't change its multicast channel.\r
312	\r
313	@param This The downloading Mtftp session\r
314	@param Reply The options in the OACK packet\r
315	@param Request The requested options\r
316	\r
317	@return TRUE if the options in the OACK is OK, otherwise FALSE.\r
318	\r
319	**/\r
320	BOOLEAN\r
321	Mtftp4RrqOackValid (\r
322	IN MTFTP4_PROTOCOL *This,\r
323	IN MTFTP4_OPTION *Reply,\r
324	IN MTFTP4_OPTION *Request\r
325	)\r
326	{\r
327	\r
328	//\r
329	// It is invalid for server to return options we don't request\r
330	//\r
331	if ((Reply->Exist &~Request->Exist) != 0) {\r
332	return FALSE;\r
333	}\r
334	\r
335	//\r
336	// Server can only specify a smaller block size to be used and\r
337	// return the timeout matches that requested.\r
338	//\r
339	if (((Reply->Exist & MTFTP4_BLKSIZE_EXIST) && (Reply->BlkSize > Request->BlkSize)) \|\|\r
340	((Reply->Exist & MTFTP4_TIMEOUT_EXIST) && (Reply->Timeout != Request->Timeout))) {\r
341	return FALSE;\r
342	}\r
343	\r
344	//\r
345	// The server can send ",,master" to client to change its master\r
346	// setting. But if it use the specific multicast channel, it can't\r
347	// change the setting.\r
348	//\r
349	if ((Reply->Exist & MTFTP4_MCAST_EXIST) && (This->McastIp != 0)) {\r
350	if ((Reply->McastIp != 0) && (Reply->McastIp != This->McastIp)) {\r
351	return FALSE;\r
352	}\r
353	\r
354	if ((Reply->McastPort != 0) && (Reply->McastPort != This->McastPort)) {\r
355	return FALSE;\r
356	}\r
357	}\r
358	\r
359	return TRUE;\r
360	}\r
361	\r
362	\r
363	/**\r
364	Configure a UDP IO port to receive the multicast.\r
365	\r
366	@param McastIo The UDP IO port to configure\r
367	@param Context The opaque parameter to the function which is the\r
368	MTFTP session.\r
369	\r
370	@retval EFI_SUCCESS The udp child is successfully configured.\r
371	@retval Others Failed to configure the UDP child.\r
372	\r
373	**/\r
374	STATIC\r
375	EFI_STATUS\r
376	Mtftp4RrqConfigMcastPort (\r
377	IN UDP_IO_PORT *McastIo,\r
378	IN VOID *Context\r
379	)\r
380	{\r
381	MTFTP4_PROTOCOL *Instance;\r
382	EFI_MTFTP4_CONFIG_DATA *Config;\r
383	EFI_UDP4_CONFIG_DATA UdpConfig;\r
384	EFI_IPv4_ADDRESS Group;\r
385	EFI_STATUS Status;\r
386	IP4_ADDR Ip;\r
387	\r
388	Instance = (MTFTP4_PROTOCOL *) Context;\r
389	Config = &Instance->Config;\r
390	\r
391	UdpConfig.AcceptBroadcast = FALSE;\r
392	UdpConfig.AcceptPromiscuous = FALSE;\r
393	UdpConfig.AcceptAnyPort = FALSE;\r
394	UdpConfig.AllowDuplicatePort = FALSE;\r
395	UdpConfig.TypeOfService = 0;\r
396	UdpConfig.TimeToLive = 64;\r
397	UdpConfig.DoNotFragment = FALSE;\r
398	UdpConfig.ReceiveTimeout = 0;\r
399	UdpConfig.TransmitTimeout = 0;\r
400	UdpConfig.UseDefaultAddress = Config->UseDefaultSetting;\r
401	UdpConfig.StationAddress = Config->StationIp;\r
402	UdpConfig.SubnetMask = Config->SubnetMask;\r
403	UdpConfig.StationPort = Instance->McastPort;\r
404	UdpConfig.RemotePort = 0;\r
405	\r
406	Ip = HTONL (Instance->ServerIp);\r
407	NetCopyMem (&UdpConfig.RemoteAddress, &Ip, sizeof (EFI_IPv4_ADDRESS));\r
408	\r
409	Status = McastIo->Udp->Configure (McastIo->Udp, &UdpConfig);\r
410	\r
411	if (EFI_ERROR (Status)) {\r
412	return Status;\r
413	}\r
414	\r
415	//\r
416	// join the multicast group\r
417	//\r
418	Ip = HTONL (Instance->McastIp);\r
419	NetCopyMem (&Group, &Ip, sizeof (EFI_IPv4_ADDRESS));\r
420	\r
421	return McastIo->Udp->Groups (McastIo->Udp, TRUE, &Group);\r
422	}\r
423	\r
424	\r
425	/**\r
426	Function to process the OACK. It will first validate the OACK\r
427	packet, then update the various negotiated parameters.\r
428	\r
429	@param Instance The download MTFTP session\r
430	@param Packet The packet received\r
431	@param Len The packet length\r
432	@param Multicast Whether this packet is received as a multicast\r
433	@param Completed Returns whether the download has completed. NOT\r
434	used by this function.\r
435	\r
436	@retval EFI_DEVICE_ERROR Failed to create/start a multicast UDP child\r
437	@retval EFI_TFTP_ERROR Some error happened during the process\r
438	@retval EFI_SUCCESS The OACK is successfully processed.\r
439	\r
440	**/\r
441	EFI_STATUS\r
442	Mtftp4RrqHandleOack (\r
443	IN MTFTP4_PROTOCOL *Instance,\r
444	IN EFI_MTFTP4_PACKET *Packet,\r
445	IN UINT32 Len,\r
446	IN BOOLEAN Multicast,\r
447	OUT BOOLEAN *Completed\r
448	)\r
449	{\r
450	MTFTP4_OPTION Reply;\r
451	EFI_STATUS Status;\r
452	INTN Expected;\r
453	\r
454	*Completed = FALSE;\r
455	\r
456	//\r
457	// If already started the master download, don't change the\r
458	// setting. Master download always succeeds.\r
459	//\r
460	Expected = Mtftp4GetNextBlockNum (&Instance->Blocks);\r
461	ASSERT (Expected != -1);\r
462	\r
463	if (Instance->Master && (Expected != 1)) {\r
464	return EFI_SUCCESS;\r
465	}\r
466	\r
467	//\r
468	// Parse and validate the options from server\r
469	//\r
470	NetZeroMem (&Reply, sizeof (MTFTP4_OPTION));\r
471	\r
472	Status = Mtftp4ParseOptionOack (Packet, Len, &Reply);\r
473	\r
474	if (EFI_ERROR (Status) \|\|\r
475	!Mtftp4RrqOackValid (Instance, &Reply, &Instance->RequestOption)) {\r
476	//\r
477	// Don't send an ERROR packet if the error is EFI_OUT_OF_RESOURCES.\r
478	//\r
479	if (Status != EFI_OUT_OF_RESOURCES) {\r
480	Mtftp4SendError (\r
481	Instance,\r
482	EFI_MTFTP4_ERRORCODE_ILLEGAL_OPERATION,\r
67a58d0f	483	(UINT8 *) "Mal-formated OACK packet"\r
772db4bb	484	);\r
	485	}\r
	486	\r
	487	return EFI_TFTP_ERROR;\r
	488	}\r
	489	\r
	490	if (Reply.Exist & MTFTP4_MCAST_EXIST) {\r
	491	\r
	492	//\r
	493	// Save the multicast info. Always update the Master, only update the\r
	494	// multicast IP address, block size, timeoute at the first time. If IP\r
	495	// address is updated, create a UDP child to receive the multicast.\r
	496	//\r
	497	Instance->Master = Reply.Master;\r
	498	\r
	499	if (Instance->McastIp == 0) {\r
	500	if ((Reply.McastIp == 0) \|\| (Reply.McastPort == 0)) {\r
	501	Mtftp4SendError (\r
	502	Instance,\r
	503	EFI_MTFTP4_ERRORCODE_ILLEGAL_OPERATION,\r
67a58d0f	504	(UINT8 *) "Illegal multicast setting"\r
772db4bb	505	);\r
	506	\r
	507	return EFI_TFTP_ERROR;\r
	508	}\r
	509	\r
	510	//\r
	511	// Create a UDP child then start receive the multicast from it.\r
	512	//\r
	513	Instance->McastIp = Reply.McastIp;\r
	514	Instance->McastPort = Reply.McastPort;\r
	515	Instance->McastUdpPort = UdpIoCreatePort (\r
	516	Instance->Service->Controller,\r
	517	Instance->Service->Image,\r
	518	Mtftp4RrqConfigMcastPort,\r
	519	Instance\r
	520	);\r
	521	\r
	522	if (Instance->McastUdpPort == NULL) {\r
	523	return EFI_DEVICE_ERROR;\r
	524	}\r
	525	\r
	526	Status = UdpIoRecvDatagram (Instance->McastUdpPort, Mtftp4RrqInput, Instance, 0);\r
	527	\r
	528	if (EFI_ERROR (Status)) {\r
	529	Mtftp4SendError (\r
	530	Instance,\r
	531	EFI_MTFTP4_ERRORCODE_ACCESS_VIOLATION,\r
67a58d0f	532	(UINT8 *) "Failed to create socket to receive multicast packet"\r
772db4bb	533	);\r
	534	\r
	535	return Status;\r
	536	}\r
	537	\r
	538	//\r
	539	// Update the parameters used.\r
	540	//\r
	541	if (Reply.BlkSize != 0) {\r
	542	Instance->BlkSize = Reply.BlkSize;\r
	543	}\r
	544	\r
	545	if (Reply.Timeout != 0) {\r
	546	Instance->Timeout = Reply.Timeout;\r
	547	}\r
	548	}\r
	549	\r
	550	} else {\r
	551	Instance->Master = TRUE;\r
	552	\r
	553	if (Reply.BlkSize != 0) {\r
	554	Instance->BlkSize = Reply.BlkSize;\r
	555	}\r
	556	\r
	557	if (Reply.Timeout != 0) {\r
	558	Instance->Timeout = Reply.Timeout;\r
	559	}\r
	560	}\r
	561	\r
	562	//\r
	563	// Send an ACK to (Expected - 1) which is 0 for unicast download,\r
	564	// or tell the server we want to receive the Expected block.\r
	565	//\r
	566	return Mtftp4RrqSendAck (Instance, (UINT16) (Expected - 1));\r
	567	}\r
	568	\r
	569	\r
	570	/**\r
	571	The packet process callback for MTFTP download.\r
	572	\r
	573	@param UdpPacket The packet received\r
	574	@param Points The local/remote access point of the packet\r
	575	@param IoStatus The status of the receiving\r
	576	@param Context Opaque parameter, which is the MTFTP session\r
	577	\r
	578	@return None\r
	579	\r
	580	**/\r
	581	VOID\r
	582	Mtftp4RrqInput (\r
	583	IN NET_BUF *UdpPacket,\r
	584	IN UDP_POINTS *Points,\r
	585	IN EFI_STATUS IoStatus,\r
	586	IN VOID *Context\r
	587	)\r
	588	{\r
	589	MTFTP4_PROTOCOL *Instance;\r
	590	EFI_MTFTP4_PACKET *Packet;\r
	591	BOOLEAN Completed;\r
	592	BOOLEAN Multicast;\r
	593	EFI_STATUS Status;\r
	594	UINT16 Opcode;\r
	595	UINT32 Len;\r
	596	\r
597	Instance = (MTFTP4_PROTOCOL *) Context;\r
598	NET_CHECK_SIGNATURE (Instance, MTFTP4_PROTOCOL_SIGNATURE);\r
599	\r
600	Status = EFI_SUCCESS;\r
601	Packet = NULL;\r
602	Completed = FALSE;\r
603	Multicast = FALSE;\r
604	\r
605	if (EFI_ERROR (IoStatus)) {\r
606	Status = IoStatus;\r
607	goto ON_EXIT;\r
608	}\r
609	\r
610	ASSERT (UdpPacket != NULL);\r
611	\r
612	//\r
613	// Find the port this packet is from to restart receive correctly.\r
614	//\r
615	Multicast = (BOOLEAN) (Points->LocalAddr == Instance->McastIp);\r
616	\r
617	if (UdpPacket->TotalSize < MTFTP4_OPCODE_LEN) {\r
618	goto ON_EXIT;\r
619	}\r
620	\r
621	//\r
622	// Client send initial request to server's listening port. Server\r
623	// will select a UDP port to communicate with the client. The server\r
624	// is required to use the same port as RemotePort to multicast the\r
625	// data.\r
626	//\r
627	if (Points->RemotePort != Instance->ConnectedPort) {\r
628	if (Instance->ConnectedPort != 0) {\r
629	goto ON_EXIT;\r
630	} else {\r
631	Instance->ConnectedPort = Points->RemotePort;\r
632	}\r
633	}\r
634	\r
635	//\r
636	// Copy the MTFTP packet to a continuous buffer if it isn't already so.\r
637	//\r
638	Len = UdpPacket->TotalSize;\r
639	\r
640	if (UdpPacket->BlockOpNum > 1) {\r
641	Packet = NetAllocatePool (Len);\r
642	\r
643	if (Packet == NULL) {\r
644	Status = EFI_OUT_OF_RESOURCES;\r
645	goto ON_EXIT;\r
646	}\r
647	\r
648	NetbufCopy (UdpPacket, 0, Len, (UINT8 *) Packet);\r
649	\r
650	} else {\r
651	Packet = (EFI_MTFTP4_PACKET *) NetbufGetByte (UdpPacket, 0, NULL);\r
652	}\r
653	\r
654	Opcode = NTOHS (Packet->OpCode);\r
655	\r
656	//\r
657	// Call the user's CheckPacket if provided. Abort the transmission\r
658	// if CheckPacket returns an EFI_ERROR code.\r
659	//\r
660	if ((Instance->Token->CheckPacket != NULL) &&\r
661	((Opcode == EFI_MTFTP4_OPCODE_OACK) \|\| (Opcode == EFI_MTFTP4_OPCODE_ERROR))) {\r
662	\r
663	Status = Instance->Token->CheckPacket (\r
664	&Instance->Mtftp4,\r
665	Instance->Token,\r
666	(UINT16) Len,\r
667	Packet\r
668	);\r
669	\r
670	if (EFI_ERROR (Status)) {\r
671	//\r
672	// Send an error message to the server to inform it\r
673	//\r
674	if (Opcode != EFI_MTFTP4_OPCODE_ERROR) {\r
675	Mtftp4SendError (\r
676	Instance,\r
677	EFI_MTFTP4_ERRORCODE_REQUEST_DENIED,\r
67a58d0f	678	(UINT8 *) "User aborted the transfer"\r
772db4bb	679	);\r
	680	}\r
	681	\r
	682	Status = EFI_ABORTED;\r
	683	goto ON_EXIT;\r
	684	}\r
	685	}\r
	686	\r
	687	switch (Opcode) {\r
	688	case EFI_MTFTP4_OPCODE_DATA:\r
	689	if ((Len > (UINT32) (MTFTP4_DATA_HEAD_LEN + Instance->BlkSize)) \|\|\r
	690	(Len < (UINT32) MTFTP4_DATA_HEAD_LEN)) {\r
	691	goto ON_EXIT;\r
	692	}\r
	693	\r
	694	Status = Mtftp4RrqHandleData (Instance, Packet, Len, Multicast, &Completed);\r
	695	break;\r
	696	\r
	697	case EFI_MTFTP4_OPCODE_OACK:\r
	698	if (Multicast \|\| (Len <= MTFTP4_OPCODE_LEN)) {\r
	699	goto ON_EXIT;\r
	700	}\r
	701	\r
	702	Status = Mtftp4RrqHandleOack (Instance, Packet, Len, Multicast, &Completed);\r
	703	break;\r
	704	\r
	705	case EFI_MTFTP4_OPCODE_ERROR:\r
	706	Status = EFI_TFTP_ERROR;\r
	707	break;\r
	708	}\r
	709	\r
	710	ON_EXIT:\r
	711	\r
	712	//\r
	713	// Free the resources, then if !EFI_ERROR (Status), restart the\r
	714	// receive, otherwise end the session.\r
	715	//\r
	716	if ((Packet != NULL) && (UdpPacket->BlockOpNum > 1)) {\r
	717	NetFreePool (Packet);\r
	718	}\r
	719	\r
	720	if (UdpPacket != NULL) {\r
	721	NetbufFree (UdpPacket);\r
	722	}\r
	723	\r
	724	if (!EFI_ERROR (Status) && !Completed) {\r
	725	if (Multicast) {\r
	726	Status = UdpIoRecvDatagram (Instance->McastUdpPort, Mtftp4RrqInput, Instance, 0);\r
	727	} else {\r
	728	Status = UdpIoRecvDatagram (Instance->UnicastPort, Mtftp4RrqInput, Instance, 0);\r
	729	}\r
	730	}\r
	731	\r
	732	if (EFI_ERROR (Status) \|\| Completed) {\r
	733	Mtftp4CleanOperation (Instance, Status);\r
	734	}\r
	735	}\r