+++ /dev/null
-/** @file\r
- Routines to process Wrq (upload).\r
-\r
-Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
-SPDX-License-Identifier: BSD-2-Clause-Patent\r
-\r
-**/\r
-\r
-#include "Mtftp4Impl.h"\r
-\r
-\r
-\r
-/**\r
- Build then send a MTFTP data packet for the MTFTP upload session.\r
-\r
- @param Instance The MTFTP upload session.\r
- @param BlockNum The block number to send.\r
-\r
- @retval EFI_OUT_OF_RESOURCES Failed to build the packet.\r
- @retval EFI_ABORTED The consumer of this child directs to abort the\r
- transmission by return an error through PacketNeeded.\r
- @retval EFI_SUCCESS The data is sent.\r
-\r
-**/\r
-EFI_STATUS\r
-Mtftp4WrqSendBlock (\r
- IN OUT MTFTP4_PROTOCOL *Instance,\r
- IN UINT16 BlockNum\r
- )\r
-{\r
- EFI_MTFTP4_PACKET *Packet;\r
- EFI_MTFTP4_TOKEN *Token;\r
- NET_BUF *UdpPacket;\r
- EFI_STATUS Status;\r
- UINT16 DataLen;\r
- UINT8 *DataBuf;\r
- UINT64 Start;\r
-\r
- //\r
- // Allocate a buffer to hold the user data\r
- //\r
- UdpPacket = NetbufAlloc (Instance->BlkSize + MTFTP4_DATA_HEAD_LEN);\r
-\r
- if (UdpPacket == NULL) {\r
- return EFI_OUT_OF_RESOURCES;\r
- }\r
-\r
- Packet = (EFI_MTFTP4_PACKET *) NetbufAllocSpace (UdpPacket, MTFTP4_DATA_HEAD_LEN, FALSE);\r
- ASSERT (Packet != NULL);\r
-\r
- Packet->Data.OpCode = HTONS (EFI_MTFTP4_OPCODE_DATA);\r
- Packet->Data.Block = HTONS (BlockNum);\r
-\r
- //\r
- // Read the block from either the buffer or PacketNeeded callback\r
- //\r
- Token = Instance->Token;\r
- DataLen = Instance->BlkSize;\r
-\r
- if (Token->Buffer != NULL) {\r
- Start = MultU64x32 (BlockNum - 1, Instance->BlkSize);\r
-\r
- if (Token->BufferSize < Start + Instance->BlkSize) {\r
- DataLen = (UINT16) (Token->BufferSize - Start);\r
- Instance->LastBlock = BlockNum;\r
- Mtftp4SetLastBlockNum (&Instance->Blocks, BlockNum);\r
- }\r
-\r
- if (DataLen > 0) {\r
- NetbufAllocSpace (UdpPacket, DataLen, FALSE);\r
- CopyMem (Packet->Data.Data, (UINT8 *) Token->Buffer + Start, DataLen);\r
- }\r
-\r
- } else {\r
- //\r
- // Get data from PacketNeeded\r
- //\r
- DataBuf = NULL;\r
- Status = Token->PacketNeeded (\r
- &Instance->Mtftp4,\r
- Token,\r
- &DataLen,\r
- (VOID **) &DataBuf\r
- );\r
-\r
- if (EFI_ERROR (Status) || (DataLen > Instance->BlkSize)) {\r
- if (DataBuf != NULL) {\r
- FreePool (DataBuf);\r
- }\r
-\r
- if (UdpPacket != NULL) {\r
- NetbufFree (UdpPacket);\r
- }\r
-\r
- Mtftp4SendError (\r
- Instance,\r
- EFI_MTFTP4_ERRORCODE_REQUEST_DENIED,\r
- (UINT8 *) "User aborted the transfer"\r
- );\r
-\r
- return EFI_ABORTED;\r
- }\r
-\r
- if (DataLen < Instance->BlkSize) {\r
- Instance->LastBlock = BlockNum;\r
- Mtftp4SetLastBlockNum (&Instance->Blocks, BlockNum);\r
- }\r
-\r
- if (DataLen > 0) {\r
- NetbufAllocSpace (UdpPacket, DataLen, FALSE);\r
- CopyMem (Packet->Data.Data, DataBuf, DataLen);\r
- FreePool (DataBuf);\r
- }\r
- }\r
-\r
- return Mtftp4SendPacket (Instance, UdpPacket);\r
-}\r
-\r
-\r
-/**\r
- Function to handle received ACK packet.\r
-\r
- If the ACK number matches the expected block number, and there are more\r
- data pending, send the next block. Otherwise tell the caller that we are done.\r
-\r
- @param Instance The MTFTP upload session\r
- @param Packet The MTFTP packet received\r
- @param Len The packet length\r
- @param Completed Return whether the upload has finished.\r
-\r
- @retval EFI_SUCCESS The ACK is successfully processed.\r
- @retval EFI_TFTP_ERROR The block number loops back.\r
- @retval Others Failed to transmit the next data packet.\r
-\r
-**/\r
-EFI_STATUS\r
-Mtftp4WrqHandleAck (\r
- IN MTFTP4_PROTOCOL *Instance,\r
- IN EFI_MTFTP4_PACKET *Packet,\r
- IN UINT32 Len,\r
- OUT BOOLEAN *Completed\r
- )\r
-{\r
- UINT16 AckNum;\r
- INTN Expected;\r
- UINT64 BlockCounter;\r
-\r
- *Completed = FALSE;\r
- AckNum = NTOHS (Packet->Ack.Block[0]);\r
- Expected = Mtftp4GetNextBlockNum (&Instance->Blocks);\r
-\r
- ASSERT (Expected >= 0);\r
-\r
- //\r
- // Get an unwanted ACK, return EFI_SUCCESS to let Mtftp4WrqInput\r
- // restart receive.\r
- //\r
- if (Expected != AckNum) {\r
- return EFI_SUCCESS;\r
- }\r
-\r
- //\r
- // Remove the acked block number, if this is the last block number,\r
- // tell the Mtftp4WrqInput to finish the transfer. This is the last\r
- // block number if the block range are empty.\r
- //\r
- Mtftp4RemoveBlockNum (&Instance->Blocks, AckNum, *Completed, &BlockCounter);\r
-\r
- Expected = Mtftp4GetNextBlockNum (&Instance->Blocks);\r
-\r
- if (Expected < 0) {\r
-\r
- //\r
- // The block range is empty. It may either because the the last\r
- // block has been ACKed, or the sequence number just looped back,\r
- // that is, there is more than 0xffff blocks.\r
- //\r
- if (Instance->LastBlock == AckNum) {\r
- ASSERT (Instance->LastBlock >= 1);\r
- *Completed = TRUE;\r
- return EFI_SUCCESS;\r
-\r
- } else {\r
- Mtftp4SendError (\r
- Instance,\r
- EFI_MTFTP4_ERRORCODE_REQUEST_DENIED,\r
- (UINT8 *) "Block number rolls back, not supported, try blksize option"\r
- );\r
-\r
- return EFI_TFTP_ERROR;\r
- }\r
- }\r
-\r
- return Mtftp4WrqSendBlock (Instance, (UINT16) Expected);\r
-}\r
-\r
-\r
-/**\r
- Check whether the received OACK is valid.\r
-\r
- The OACK is valid only if:\r
- 1. It only include options requested by us\r
- 2. It can only include a smaller block size\r
- 3. It can't change the proposed time out value.\r
- 4. Other requirements of the individal MTFTP options as required.\r
-\r
- @param Reply The options included in the OACK\r
- @param Request The options we requested\r
-\r
- @retval TRUE The options included in OACK is valid.\r
- @retval FALSE The options included in OACK is invalid.\r
-\r
-**/\r
-BOOLEAN\r
-Mtftp4WrqOackValid (\r
- IN MTFTP4_OPTION *Reply,\r
- IN MTFTP4_OPTION *Request\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) != 0) && (Reply->BlkSize > Request->BlkSize)) ||\r
- (((Reply->Exist & MTFTP4_TIMEOUT_EXIST) != 0) && (Reply->Timeout != Request->Timeout))) {\r
- return FALSE;\r
- }\r
-\r
- return TRUE;\r
-}\r
-\r
-\r
-/**\r
- Function to handle the MTFTP OACK packet.\r
-\r
- It parses the packet's options, and update the internal states of the session.\r
-\r
- @param Instance The MTFTP session\r
- @param Packet The received OACK packet\r
- @param Len The length of the packet\r
- @param Completed Whether the transmisson has completed. NOT used by\r
- this function.\r
-\r
- @retval EFI_SUCCESS The OACK process is OK\r
- @retval EFI_TFTP_ERROR Some error occured, and the session reset.\r
-\r
-**/\r
-EFI_STATUS\r
-Mtftp4WrqHandleOack (\r
- IN OUT MTFTP4_PROTOCOL *Instance,\r
- IN EFI_MTFTP4_PACKET *Packet,\r
- IN UINT32 Len,\r
- OUT BOOLEAN *Completed\r
- )\r
-{\r
- MTFTP4_OPTION Reply;\r
- EFI_MTFTP4_PACKET Bogus;\r
- EFI_STATUS Status;\r
- INTN Expected;\r
-\r
- *Completed = FALSE;\r
-\r
- //\r
- // Ignore the OACK if already started the upload\r
- //\r
- Expected = Mtftp4GetNextBlockNum (&Instance->Blocks);\r
-\r
- if (Expected != 0) {\r
- return EFI_SUCCESS;\r
- }\r
-\r
- //\r
- // Parse and validate the options from server\r
- //\r
- ZeroMem (&Reply, sizeof (MTFTP4_OPTION));\r
- Status = Mtftp4ParseOptionOack (Packet, Len, Instance->Operation, &Reply);\r
-\r
- if (EFI_ERROR (Status) || !Mtftp4WrqOackValid (&Reply, &Instance->RequestOption)) {\r
- //\r
- // Don't send a MTFTP error packet when out of resource, it can\r
- // only make it worse.\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.BlkSize != 0) {\r
- Instance->BlkSize = Reply.BlkSize;\r
- }\r
-\r
- if (Reply.Timeout != 0) {\r
- Instance->Timeout = Reply.Timeout;\r
- }\r
-\r
- //\r
- // Build a bogus ACK0 packet then pass it to the Mtftp4WrqHandleAck,\r
- // which will start the transmission of the first data block.\r
- //\r
- Bogus.Ack.OpCode = HTONS (EFI_MTFTP4_OPCODE_ACK);\r
- Bogus.Ack.Block[0] = 0;\r
-\r
- Status = Mtftp4WrqHandleAck (\r
- Instance,\r
- &Bogus,\r
- sizeof (EFI_MTFTP4_ACK_HEADER),\r
- Completed\r
- );\r
-\r
- return Status;\r
-}\r
-\r
-\r
-/**\r
- The input process routine for MTFTP upload.\r
-\r
- @param UdpPacket The received MTFTP packet.\r
- @param EndPoint The local/remote access point\r
- @param IoStatus The result of the packet receiving\r
- @param Context Opaque parameter for the callback, which is the\r
- MTFTP session.\r
-**/\r
-VOID\r
-EFIAPI\r
-Mtftp4WrqInput (\r
- IN NET_BUF *UdpPacket,\r
- IN UDP_END_POINT *EndPoint,\r
- IN EFI_STATUS IoStatus,\r
- IN VOID *Context\r
- )\r
-{\r
- MTFTP4_PROTOCOL *Instance;\r
- EFI_MTFTP4_PACKET *Packet;\r
- BOOLEAN Completed;\r
- EFI_STATUS Status;\r
- UINT32 Len;\r
- UINT16 Opcode;\r
-\r
- Instance = (MTFTP4_PROTOCOL *) Context;\r
- NET_CHECK_SIGNATURE (Instance, MTFTP4_PROTOCOL_SIGNATURE);\r
-\r
- Completed = FALSE;\r
- Packet = NULL;\r
- Status = EFI_SUCCESS;\r
-\r
- if (EFI_ERROR (IoStatus)) {\r
- Status = IoStatus;\r
- goto ON_EXIT;\r
- }\r
-\r
- ASSERT (UdpPacket != NULL);\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.\r
- //\r
- if (EndPoint->RemotePort != Instance->ConnectedPort) {\r
- if (Instance->ConnectedPort != 0) {\r
- goto ON_EXIT;\r
- } else {\r
- Instance->ConnectedPort = EndPoint->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 = AllocatePool (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
- ASSERT (Packet != 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_ACK:\r
- if (Len != MTFTP4_OPCODE_LEN + MTFTP4_BLKNO_LEN) {\r
- goto ON_EXIT;\r
- }\r
-\r
- Status = Mtftp4WrqHandleAck (Instance, Packet, Len, &Completed);\r
- break;\r
-\r
- case EFI_MTFTP4_OPCODE_OACK:\r
- if (Len <= MTFTP4_OPCODE_LEN) {\r
- goto ON_EXIT;\r
- }\r
-\r
- Status = Mtftp4WrqHandleOack (Instance, Packet, Len, &Completed);\r
- break;\r
-\r
- case EFI_MTFTP4_OPCODE_ERROR:\r
- Status = EFI_TFTP_ERROR;\r
- break;\r
-\r
- default:\r
- break;\r
- }\r
-\r
-ON_EXIT:\r
- //\r
- // Free the resources, then if !EFI_ERROR (Status) and not completed,\r
- // restart the receive, otherwise end the session.\r
- //\r
- if ((Packet != NULL) && (UdpPacket->BlockOpNum > 1)) {\r
- FreePool (Packet);\r
- }\r
-\r
- if (UdpPacket != NULL) {\r
- NetbufFree (UdpPacket);\r
- }\r
-\r
- if (!EFI_ERROR (Status) && !Completed) {\r
- Status = UdpIoRecvDatagram (Instance->UnicastPort, Mtftp4WrqInput, Instance, 0);\r
- }\r
-\r
- //\r
- // Status may have been updated by UdpIoRecvDatagram\r
- //\r
- if (EFI_ERROR (Status) || Completed) {\r
- Mtftp4CleanOperation (Instance, Status);\r
- }\r
-}\r
-\r
-\r
-\r
-/**\r
- Start the MTFTP session for upload.\r
-\r
- It will first init some states, then send the WRQ request packet,\r
- and start receiving the packet.\r
-\r
- @param Instance The MTFTP session\r
- @param Operation Redundant parameter, which is always\r
- EFI_MTFTP4_OPCODE_WRQ here.\r
-\r
- @retval EFI_SUCCESS The upload process has been started.\r
- @retval Others Failed to start the upload.\r
-\r
-**/\r
-EFI_STATUS\r
-Mtftp4WrqStart (\r
- IN MTFTP4_PROTOCOL *Instance,\r
- IN UINT16 Operation\r
- )\r
-{\r
- EFI_STATUS Status;\r
-\r
- //\r
- // The valid block number range are [0, 0xffff]. For example:\r
- // the client sends an WRQ request to the server, the server\r
- // ACK with an ACK0 to let client start transfer the first\r
- // packet.\r
- //\r
- Status = Mtftp4InitBlockRange (&Instance->Blocks, 0, 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, Mtftp4WrqInput, Instance, 0);\r
-}\r
-\r
projects / mirror_edk2.git / blobdiff