2 Mtftp6 support functions implementation.
4 Copyright (c) 2009 - 2010, Intel Corporation. All rights reserved.<BR>
6 This program and the accompanying materials
7 are licensed and made available under the terms and conditions of the BSD License
8 which accompanies this distribution. The full text of the license may be found at
9 http://opensource.org/licenses/bsd-license.php.
11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
16 #include "Mtftp6Impl.h"
20 Allocate a MTFTP block range, then init it to the range of [Start, End].
22 @param[in] Start The start block number.
23 @param[in] End The last block number in the range.
25 @return Range The range of the allocated block buffer.
34 MTFTP6_BLOCK_RANGE
*Range
;
36 Range
= AllocateZeroPool (sizeof (MTFTP6_BLOCK_RANGE
));
42 InitializeListHead (&Range
->Link
);
52 Initialize the block range for either RRQ or WRQ. RRQ and WRQ have
53 different requirements for Start and End. For example, during startup,
54 WRQ initializes its whole valid block range to [0, 0xffff]. This
55 is bacause the server will send an ACK0 to inform the user to start the
56 upload. When the client receives an ACK0, it will remove 0 from the range,
57 get the next block number, which is 1, then upload the BLOCK1. For RRQ
58 without option negotiation, the server will directly send the BLOCK1
59 in response to the client's RRQ. When received BLOCK1, the client will
60 remove it from the block range and send an ACK. It also works if there
61 is option negotiation.
63 @param[in] Head The block range head to initialize.
64 @param[in] Start The Start block number.
65 @param[in] End The last block number.
67 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory for initial block range.
68 @retval EFI_SUCCESS The initial block range is created.
72 Mtftp6InitBlockRange (
78 MTFTP6_BLOCK_RANGE
*Range
;
80 Range
= Mtftp6AllocateRange (Start
, End
);
83 return EFI_OUT_OF_RESOURCES
;
86 InsertTailList (Head
, &Range
->Link
);
92 Get the first valid block number on the range list.
94 @param[in] Head The block range head.
96 @retval ==-1 If the block range is empty.
97 @retval >-1 The first valid block number.
101 Mtftp6GetNextBlockNum (
105 MTFTP6_BLOCK_RANGE
*Range
;
107 if (IsListEmpty (Head
)) {
111 Range
= NET_LIST_HEAD (Head
, MTFTP6_BLOCK_RANGE
, Link
);
117 Set the last block number of the block range list. It
118 removes all the blocks after the Last. MTFTP initialize the
119 block range to the maximum possible range, such as [0, 0xffff]
120 for WRQ. When it gets the last block number, it calls
121 this function to set the last block number.
123 @param[in] Head The block range list.
124 @param[in] Last The last block number.
128 Mtftp6SetLastBlockNum (
133 MTFTP6_BLOCK_RANGE
*Range
;
136 // Iterate from the tail to head to remove the block number
139 while (!IsListEmpty (Head
)) {
140 Range
= NET_LIST_TAIL (Head
, MTFTP6_BLOCK_RANGE
, Link
);
142 if (Range
->Start
> Last
) {
143 RemoveEntryList (&Range
->Link
);
148 if (Range
->End
> Last
) {
157 Remove the block number from the block range list.
159 @param[in] Head The block range list to remove from.
160 @param[in] Num The block number to remove.
161 @param[in] Completed Whether Num is the last block number
162 @param[out] TotalBlock The continuous block number in all
164 @retval EFI_NOT_FOUND The block number isn't in the block range list.
165 @retval EFI_SUCCESS The block number has been removed from the list.
166 @retval EFI_OUT_OF_RESOURCES Failed to allocate resources.
170 Mtftp6RemoveBlockNum (
173 IN BOOLEAN Completed
,
174 OUT UINT64
*TotalBlock
177 MTFTP6_BLOCK_RANGE
*Range
;
178 MTFTP6_BLOCK_RANGE
*NewRange
;
181 NET_LIST_FOR_EACH (Entry
, Head
) {
184 // Each block represents a hole [Start, End] in the file,
185 // skip to the first range with End >= Num
187 Range
= NET_LIST_USER_STRUCT (Entry
, MTFTP6_BLOCK_RANGE
, Link
);
189 if (Range
->End
< Num
) {
194 // There are three different cases for Start
195 // 1. (Start > Num) && (End >= Num):
196 // because all the holes before this one has the condition of
197 // End < Num, so this block number has been removed.
199 // 2. (Start == Num) && (End >= Num):
200 // Need to increase the Start by one, and if End == Num, this
201 // hole has been removed completely, remove it.
203 // 3. (Start < Num) && (End >= Num):
204 // if End == Num, only need to decrease the End by one because
205 // we have (Start < Num) && (Num == End), so (Start <= End - 1).
206 // if (End > Num), the hold is splited into two holes, with
207 // [Start, Num - 1] and [Num + 1, End].
209 if (Range
->Start
> Num
) {
210 return EFI_NOT_FOUND
;
212 } else if (Range
->Start
== Num
) {
216 // Note that: RFC 1350 does not mention block counter roll-over,
217 // but several TFTP hosts implement the roll-over be able to accept
218 // transfers of unlimited size. There is no consensus, however, whether
219 // the counter should wrap around to zero or to one. Many implementations
220 // wrap to zero, because this is the simplest to implement. Here we choose
225 if (Range
->Round
> 0) {
226 *TotalBlock
+= Range
->Bound
+ MultU64x32 ((UINT64
) (Range
->Round
-1), (UINT32
)(Range
->Bound
+ 1)) + 1;
229 if (Range
->Start
> Range
->Bound
) {
234 if ((Range
->Start
> Range
->End
) || Completed
) {
235 RemoveEntryList (&Range
->Link
);
242 if (Range
->End
== Num
) {
245 NewRange
= Mtftp6AllocateRange ((UINT16
) (Num
+ 1), (UINT16
) Range
->End
);
247 if (NewRange
== NULL
) {
248 return EFI_OUT_OF_RESOURCES
;
251 Range
->End
= Num
- 1;
252 NetListInsertAfter (&Range
->Link
, &NewRange
->Link
);
259 return EFI_NOT_FOUND
;
264 Configure the opened Udp6 instance until the corresponding Ip6 instance
267 @param[in] UdpIo The pointer to the Udp6 Io.
268 @param[in] UdpCfgData The pointer to the Udp6 configure data.
270 @retval EFI_SUCCESS Configure the Udp6 instance successfully.
271 @retval EFI_NO_MAPPING The corresponding Ip6 instance has not
278 IN EFI_UDP6_CONFIG_DATA
*UdpCfgData
281 EFI_IP6_MODE_DATA Ip6Mode
;
282 EFI_UDP6_PROTOCOL
*Udp6
;
287 Udp6
= UdpIo
->Protocol
.Udp6
;
290 // Create a timer to check whether the Ip6 instance configured or not.
292 Status
= gBS
->CreateEvent (
299 if (EFI_ERROR (Status
)) {
303 Status
= gBS
->SetTimer (
306 MTFTP6_GET_MAPPING_TIMEOUT
* MTFTP6_TICK_PER_SECOND
308 if (EFI_ERROR (Status
)) {
313 // Check the Ip6 mode data till timeout.
315 while (EFI_ERROR (gBS
->CheckEvent (Event
))) {
319 Status
= Udp6
->GetModeData (Udp6
, NULL
, &Ip6Mode
, NULL
, NULL
);
321 if (!EFI_ERROR (Status
)) {
323 if (Ip6Mode
.IsConfigured
) {
325 // Continue to configure the Udp6 instance.
327 Status
= Udp6
->Configure (Udp6
, UdpCfgData
);
329 Status
= EFI_NO_MAPPING
;
337 gBS
->CloseEvent (Event
);
345 The dummy configure routine for create a new Udp6 Io.
347 @param[in] UdpIo The pointer to the Udp6 Io.
348 @param[in] Context The pointer to the context.
350 @retval EFI_SUCCESS This value is always returned.
355 Mtftp6ConfigDummyUdpIo (
365 The configure routine for Mtftp6 instance to transmit/receive.
367 @param[in] UdpIo The pointer to the Udp6 Io.
368 @param[in] ServerIp The pointer to the server address.
369 @param[in] ServerPort The pointer to the server port.
370 @param[in] LocalIp The pointer to the local address.
371 @param[in] LocalPort The pointer to the local port.
373 @retval EFI_SUCCESS Configured the Udp6 Io for Mtftp6 successfully.
374 @retval EFI_NO_MAPPING The corresponding Ip6 instance has not been
381 IN EFI_IPv6_ADDRESS
*ServerIp
,
382 IN UINT16 ServerPort
,
383 IN EFI_IPv6_ADDRESS
*LocalIp
,
388 EFI_UDP6_PROTOCOL
*Udp6
;
389 EFI_UDP6_CONFIG_DATA
*Udp6Cfg
;
391 Udp6
= UdpIo
->Protocol
.Udp6
;
392 Udp6Cfg
= &(UdpIo
->Config
.Udp6
);
394 ZeroMem (Udp6Cfg
, sizeof (EFI_UDP6_CONFIG_DATA
));
397 // Set the Udp6 Io configure data.
399 Udp6Cfg
->AcceptPromiscuous
= FALSE
;
400 Udp6Cfg
->AcceptAnyPort
= FALSE
;
401 Udp6Cfg
->AllowDuplicatePort
= FALSE
;
402 Udp6Cfg
->TrafficClass
= 0;
403 Udp6Cfg
->HopLimit
= 128;
404 Udp6Cfg
->ReceiveTimeout
= 0;
405 Udp6Cfg
->TransmitTimeout
= 0;
406 Udp6Cfg
->StationPort
= LocalPort
;
407 Udp6Cfg
->RemotePort
= ServerPort
;
410 &Udp6Cfg
->StationAddress
,
412 sizeof (EFI_IPv6_ADDRESS
)
416 &Udp6Cfg
->RemoteAddress
,
418 sizeof (EFI_IPv6_ADDRESS
)
422 // Configure the Udp6 instance with current configure data.
424 Status
= Udp6
->Configure (Udp6
, Udp6Cfg
);
426 if (Status
== EFI_NO_MAPPING
) {
428 return Mtftp6GetMapping (UdpIo
, Udp6Cfg
);
436 Build and transmit the request packet for the Mtftp6 instance.
438 @param[in] Instance The pointer to the Mtftp6 instance.
439 @param[in] Operation The operation code of this packet.
441 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory for the request.
442 @retval EFI_SUCCESS The request is built and sent.
443 @retval Others Failed to transmit the packet.
448 IN MTFTP6_INSTANCE
*Instance
,
452 EFI_MTFTP6_PACKET
*Packet
;
453 EFI_MTFTP6_OPTION
*Options
;
454 EFI_MTFTP6_TOKEN
*Token
;
463 Token
= Instance
->Token
;
464 Options
= Token
->OptionList
;
465 Mode
= Token
->ModeStr
;
468 Mode
= (UINT8
*) "octet";
472 // The header format of RRQ/WRQ packet is:
474 // 2 bytes string 1 byte string 1 byte
475 // ------------------------------------------------
476 // | Opcode | Filename | 0 | Mode | 0 |
477 // ------------------------------------------------
479 // The common option format is:
481 // string 1 byte string 1 byte
482 // ---------------------------------------
483 // | OptionStr | 0 | ValueStr | 0 |
484 // ---------------------------------------
488 // Compute the size of new Mtftp6 packet.
490 Len1
= (UINT32
) AsciiStrLen ((CHAR8
*) Token
->Filename
);
491 Len2
= (UINT32
) AsciiStrLen ((CHAR8
*) Mode
);
492 Len
= Len1
+ Len2
+ 4;
494 for (Index
= 0; Index
< Token
->OptionCount
; Index
++) {
495 Len1
= (UINT32
) AsciiStrLen ((CHAR8
*) Options
[Index
].OptionStr
);
496 Len2
= (UINT32
) AsciiStrLen ((CHAR8
*) Options
[Index
].ValueStr
);
497 Len
+= Len1
+ Len2
+ 2;
501 // Allocate a packet then copy the data.
503 if ((Nbuf
= NetbufAlloc (Len
)) == NULL
) {
504 return EFI_OUT_OF_RESOURCES
;
508 // Copy the opcode, filename and mode into packet.
510 Packet
= (EFI_MTFTP6_PACKET
*) NetbufAllocSpace (Nbuf
, Len
, FALSE
);
511 ASSERT (Packet
!= NULL
);
513 Packet
->OpCode
= HTONS (Operation
);
514 Cur
= Packet
->Rrq
.Filename
;
515 Cur
= (UINT8
*) AsciiStrCpy ((CHAR8
*) Cur
, (CHAR8
*) Token
->Filename
);
516 Cur
+= AsciiStrLen ((CHAR8
*) Token
->Filename
) + 1;
517 Cur
= (UINT8
*) AsciiStrCpy ((CHAR8
*) Cur
, (CHAR8
*) Mode
);
518 Cur
+= AsciiStrLen ((CHAR8
*) Mode
) + 1;
521 // Copy all the extension options into the packet.
523 for (Index
= 0; Index
< Token
->OptionCount
; ++Index
) {
524 Cur
= (UINT8
*) AsciiStrCpy ((CHAR8
*) Cur
, (CHAR8
*) Options
[Index
].OptionStr
);
525 Cur
+= AsciiStrLen ((CHAR8
*) Options
[Index
].OptionStr
) + 1;
526 Cur
= (UINT8
*) AsciiStrCpy ((CHAR8
*) Cur
, (CHAR8
*) Options
[Index
].ValueStr
);
527 Cur
+= AsciiStrLen ((CHAR8
*) (CHAR8
*) Options
[Index
].ValueStr
) + 1;
531 // Save the packet buf for retransmit
533 if (Instance
->LastPacket
!= NULL
) {
534 NetbufFree (Instance
->LastPacket
);
537 Instance
->LastPacket
= Nbuf
;
538 Instance
->CurRetry
= 0;
540 return Mtftp6TransmitPacket (Instance
, Nbuf
);
545 Build and send an error packet.
547 @param[in] Instance The pointer to the Mtftp6 instance.
548 @param[in] ErrCode The error code in the packet.
549 @param[in] ErrInfo The error message in the packet.
551 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory for the error packet.
552 @retval EFI_SUCCESS The error packet is transmitted.
553 @retval Others Failed to transmit the packet.
558 IN MTFTP6_INSTANCE
*Instance
,
564 EFI_MTFTP6_PACKET
*TftpError
;
568 // Allocate a packet then copy the data.
570 Len
= (UINT32
) (AsciiStrLen ((CHAR8
*) ErrInfo
) + sizeof (EFI_MTFTP6_ERROR_HEADER
));
571 Nbuf
= NetbufAlloc (Len
);
574 return EFI_OUT_OF_RESOURCES
;
577 TftpError
= (EFI_MTFTP6_PACKET
*) NetbufAllocSpace (Nbuf
, Len
, FALSE
);
579 if (TftpError
== NULL
) {
581 return EFI_OUT_OF_RESOURCES
;
584 TftpError
->OpCode
= HTONS (EFI_MTFTP6_OPCODE_ERROR
);
585 TftpError
->Error
.ErrorCode
= HTONS (ErrCode
);
587 AsciiStrCpy ((CHAR8
*) TftpError
->Error
.ErrorMessage
, (CHAR8
*) ErrInfo
);
590 // Save the packet buf for retransmit
592 if (Instance
->LastPacket
!= NULL
) {
593 NetbufFree (Instance
->LastPacket
);
596 Instance
->LastPacket
= Nbuf
;
597 Instance
->CurRetry
= 0;
599 return Mtftp6TransmitPacket (Instance
, Nbuf
);
604 The callback function called when the packet is transmitted.
606 @param[in] Packet The pointer to the packet.
607 @param[in] UdpEpt The pointer to the Udp6 access point.
608 @param[in] IoStatus The result of the transmission.
609 @param[in] Context The pointer to the context.
616 IN UDP_END_POINT
*UdpEpt
,
617 IN EFI_STATUS IoStatus
,
622 *(BOOLEAN
*) Context
= TRUE
;
627 Send the packet for the Mtftp6 instance.
629 @param[in] Instance The pointer to the Mtftp6 instance.
630 @param[in] Packet The pointer to the packet to be sent.
632 @retval EFI_SUCCESS The packet was sent out
633 @retval Others Failed to transmit the packet.
637 Mtftp6TransmitPacket (
638 IN MTFTP6_INSTANCE
*Instance
,
642 EFI_UDP6_PROTOCOL
*Udp6
;
643 EFI_UDP6_CONFIG_DATA Udp6CfgData
;
649 ZeroMem (&Udp6CfgData
, sizeof(EFI_UDP6_CONFIG_DATA
));
650 Udp6
= Instance
->UdpIo
->Protocol
.Udp6
;
653 // Set the live time of the packet.
655 Instance
->PacketToLive
= Instance
->IsMaster
? Instance
->Timeout
: (Instance
->Timeout
* 2);
657 Temp
= (UINT16
*) NetbufGetByte (Packet
, 0, NULL
);
658 ASSERT (Temp
!= NULL
);
661 OpCode
= NTOHS (Value
);
663 if (OpCode
== EFI_MTFTP6_OPCODE_RRQ
|| OpCode
== EFI_MTFTP6_OPCODE_DIR
|| OpCode
== EFI_MTFTP6_OPCODE_WRQ
) {
665 // For the Rrq, Dir, Wrq requests of the operation, configure the Udp6Io as
666 // (serverip, 69, localip, localport) to send.
667 // Usually local address and local port are both default as zero.
669 Status
= Udp6
->Configure (Udp6
, NULL
);
671 if (EFI_ERROR (Status
)) {
675 Status
= Mtftp6ConfigUdpIo (
678 Instance
->ServerCmdPort
,
679 &Instance
->Config
->StationIp
,
680 Instance
->Config
->LocalPort
683 if (EFI_ERROR (Status
)) {
688 // Get the current local address and port by get Udp6 mode data.
690 Status
= Udp6
->GetModeData (Udp6
, &Udp6CfgData
, NULL
, NULL
, NULL
);
691 if (EFI_ERROR (Status
)) {
695 NET_GET_REF (Packet
);
697 Instance
->IsTransmitted
= FALSE
;
699 Status
= UdpIoSendDatagram (
705 &Instance
->IsTransmitted
708 if (EFI_ERROR (Status
)) {
709 NET_PUT_REF (Packet
);
714 // Poll till the packet sent out from the ip6 queue.
716 gBS
->RestoreTPL (Instance
->OldTpl
);
718 while (!Instance
->IsTransmitted
) {
722 Instance
->OldTpl
= gBS
->RaiseTPL (TPL_CALLBACK
);
725 // For the subsequent exchange of such requests, reconfigure the Udp6Io as
726 // (serverip, 0, localip, localport) to receive.
727 // Currently local address and local port are specified by Udp6 mode data.
729 Status
= Udp6
->Configure (Udp6
, NULL
);
731 if (EFI_ERROR (Status
)) {
735 Status
= Mtftp6ConfigUdpIo (
738 Instance
->ServerDataPort
,
739 &Udp6CfgData
.StationAddress
,
740 Udp6CfgData
.StationPort
744 // For the data exchange, configure the Udp6Io as (serverip, dataport,
745 // localip, localport) to send/receive.
746 // Currently local address and local port are specified by Udp6 mode data.
748 Status
= Udp6
->GetModeData (Udp6
, &Udp6CfgData
, NULL
, NULL
, NULL
);
749 if (EFI_ERROR (Status
)) {
753 if (Udp6CfgData
.RemotePort
!= Instance
->ServerDataPort
) {
755 Status
= Udp6
->Configure (Udp6
, NULL
);
757 if (EFI_ERROR (Status
)) {
761 Status
= Mtftp6ConfigUdpIo (
764 Instance
->ServerDataPort
,
765 &Udp6CfgData
.StationAddress
,
766 Udp6CfgData
.StationPort
769 if (EFI_ERROR (Status
)) {
774 NET_GET_REF (Packet
);
776 Instance
->IsTransmitted
= FALSE
;
778 Status
= UdpIoSendDatagram (
784 &Instance
->IsTransmitted
787 if (EFI_ERROR (Status
)) {
788 NET_PUT_REF (Packet
);
792 // Poll till the packet sent out from the ip6 queue.
794 gBS
->RestoreTPL (Instance
->OldTpl
);
796 while (!Instance
->IsTransmitted
) {
800 Instance
->OldTpl
= gBS
->RaiseTPL (TPL_CALLBACK
);
808 Check packet for GetInfo callback routine.
810 GetInfo is implemented with EfiMtftp6ReadFile. It's used to inspect
811 the first packet from server, then abort the session.
813 @param[in] This The pointer to the Mtftp6 protocol.
814 @param[in] Token The pointer to the Mtftp6 token.
815 @param[in] PacketLen The length of the packet.
816 @param[in] Packet The pointer to the received packet.
818 @retval EFI_ABORTED Abort the Mtftp6 operation.
824 IN EFI_MTFTP6_PROTOCOL
*This
,
825 IN EFI_MTFTP6_TOKEN
*Token
,
827 IN EFI_MTFTP6_PACKET
*Packet
830 MTFTP6_GETINFO_CONTEXT
*Context
;
833 Context
= (MTFTP6_GETINFO_CONTEXT
*) Token
->Context
;
834 OpCode
= NTOHS (Packet
->OpCode
);
837 // Set the GetInfo's return status according to the OpCode.
840 case EFI_MTFTP6_OPCODE_ERROR
:
841 Context
->Status
= EFI_TFTP_ERROR
;
844 case EFI_MTFTP6_OPCODE_OACK
:
845 Context
->Status
= EFI_SUCCESS
;
849 Context
->Status
= EFI_PROTOCOL_ERROR
;
853 // Allocate buffer then copy the packet over. Use gBS->AllocatePool
854 // in case NetAllocatePool will implements something tricky.
856 *(Context
->Packet
) = AllocateZeroPool (PacketLen
);
858 if (*(Context
->Packet
) == NULL
) {
859 Context
->Status
= EFI_OUT_OF_RESOURCES
;
863 *(Context
->PacketLen
) = PacketLen
;
864 CopyMem (*(Context
->Packet
), Packet
, PacketLen
);
871 Clean up the current Mtftp6 operation.
873 @param[in] Instance The pointer to the Mtftp6 instance.
874 @param[in] Result The result to be returned to the user.
878 Mtftp6OperationClean (
879 IN MTFTP6_INSTANCE
*Instance
,
885 MTFTP6_BLOCK_RANGE
*Block
;
888 // Clean up the current token and event.
890 if (Instance
->Token
!= NULL
) {
891 Instance
->Token
->Status
= Result
;
892 if (Instance
->Token
->Event
!= NULL
) {
893 gBS
->SignalEvent (Instance
->Token
->Event
);
895 Instance
->Token
= NULL
;
899 // Clean up the corresponding Udp6Io.
901 if (Instance
->UdpIo
!= NULL
) {
902 UdpIoCleanIo (Instance
->UdpIo
);
905 if (Instance
->McastUdpIo
!= NULL
) {
906 UdpIoFreeIo (Instance
->McastUdpIo
);
907 Instance
->McastUdpIo
= NULL
;
911 // Clean up the stored last packet.
913 if (Instance
->LastPacket
!= NULL
) {
914 NetbufFree (Instance
->LastPacket
);
915 Instance
->LastPacket
= NULL
;
918 NET_LIST_FOR_EACH_SAFE (Entry
, Next
, &Instance
->BlkList
) {
919 Block
= NET_LIST_USER_STRUCT (Entry
, MTFTP6_BLOCK_RANGE
, Link
);
920 RemoveEntryList (Entry
);
925 // Reinitialize the corresponding fields of the Mtftp6 operation.
927 ZeroMem (&Instance
->ExtInfo
, sizeof (MTFTP6_EXT_OPTION_INFO
));
928 ZeroMem (&Instance
->ServerIp
, sizeof (EFI_IPv6_ADDRESS
));
929 ZeroMem (&Instance
->McastIp
, sizeof (EFI_IPv6_ADDRESS
));
931 Instance
->ServerCmdPort
= 0;
932 Instance
->ServerDataPort
= 0;
933 Instance
->McastPort
= 0;
934 Instance
->BlkSize
= 0;
935 Instance
->LastBlk
= 0;
936 Instance
->PacketToLive
= 0;
937 Instance
->MaxRetry
= 0;
938 Instance
->CurRetry
= 0;
939 Instance
->Timeout
= 0;
940 Instance
->IsMaster
= TRUE
;
945 Start the Mtftp6 instance to perform the operation, such as read file,
946 write file, and read directory.
948 @param[in] This The MTFTP session.
949 @param[in] Token The token than encapsues the user's request.
950 @param[in] OpCode The operation to perform.
952 @retval EFI_INVALID_PARAMETER Some of the parameters are invalid.
953 @retval EFI_NOT_STARTED The MTFTP session hasn't been configured.
954 @retval EFI_ALREADY_STARTED There is pending operation for the session.
955 @retval EFI_SUCCESS The operation is successfully started.
959 Mtftp6OperationStart (
960 IN EFI_MTFTP6_PROTOCOL
*This
,
961 IN EFI_MTFTP6_TOKEN
*Token
,
965 MTFTP6_INSTANCE
*Instance
;
970 Token
->Filename
== NULL
||
971 (Token
->OptionCount
!= 0 && Token
->OptionList
== NULL
) ||
972 (Token
->OverrideData
!= NULL
&& !NetIp6IsValidUnicast (&Token
->OverrideData
->ServerIp
))
974 return EFI_INVALID_PARAMETER
;
978 // At least define one method to collect the data for download.
980 if ((OpCode
== EFI_MTFTP6_OPCODE_RRQ
|| OpCode
== EFI_MTFTP6_OPCODE_DIR
) &&
981 Token
->Buffer
== NULL
&&
982 Token
->CheckPacket
== NULL
984 return EFI_INVALID_PARAMETER
;
988 // At least define one method to provide the data for upload.
990 if (OpCode
== EFI_MTFTP6_OPCODE_WRQ
&& Token
->Buffer
== NULL
&& Token
->PacketNeeded
== NULL
) {
991 return EFI_INVALID_PARAMETER
;
994 Instance
= MTFTP6_INSTANCE_FROM_THIS (This
);
996 if (Instance
->Config
== NULL
) {
997 return EFI_NOT_STARTED
;
1000 if (Instance
->Token
!= NULL
) {
1001 return EFI_ACCESS_DENIED
;
1004 Status
= EFI_SUCCESS
;
1005 Instance
->OldTpl
= gBS
->RaiseTPL (TPL_CALLBACK
);
1008 // Parse the extension options in the request packet.
1010 if (Token
->OptionCount
!= 0) {
1012 Status
= Mtftp6ParseExtensionOption (
1019 if (EFI_ERROR (Status
)) {
1025 // Initialize runtime data from config data or override data.
1027 Instance
->Token
= Token
;
1028 Instance
->ServerCmdPort
= Instance
->Config
->InitialServerPort
;
1029 Instance
->ServerDataPort
= 0;
1030 Instance
->MaxRetry
= Instance
->Config
->TryCount
;
1031 Instance
->Timeout
= Instance
->Config
->TimeoutValue
;
1032 Instance
->IsMaster
= TRUE
;
1035 &Instance
->ServerIp
,
1036 &Instance
->Config
->ServerIp
,
1037 sizeof (EFI_IPv6_ADDRESS
)
1040 if (Token
->OverrideData
!= NULL
) {
1041 Instance
->ServerCmdPort
= Token
->OverrideData
->ServerPort
;
1042 Instance
->MaxRetry
= Token
->OverrideData
->TryCount
;
1043 Instance
->Timeout
= Token
->OverrideData
->TimeoutValue
;
1046 &Instance
->ServerIp
,
1047 &Token
->OverrideData
->ServerIp
,
1048 sizeof (EFI_IPv6_ADDRESS
)
1053 // Set default value for undefined parameters.
1055 if (Instance
->ServerCmdPort
== 0) {
1056 Instance
->ServerCmdPort
= MTFTP6_DEFAULT_SERVER_CMD_PORT
;
1058 if (Instance
->BlkSize
== 0) {
1059 Instance
->BlkSize
= MTFTP6_DEFAULT_BLK_SIZE
;
1061 if (Instance
->MaxRetry
== 0) {
1062 Instance
->MaxRetry
= MTFTP6_DEFAULT_MAX_RETRY
;
1064 if (Instance
->Timeout
== 0) {
1065 Instance
->Timeout
= MTFTP6_DEFAULT_TIMEOUT
;
1068 Token
->Status
= EFI_NOT_READY
;
1071 // Switch the routines by the operation code.
1074 case EFI_MTFTP6_OPCODE_RRQ
:
1075 Status
= Mtftp6RrqStart (Instance
, OpCode
);
1078 case EFI_MTFTP6_OPCODE_DIR
:
1079 Status
= Mtftp6RrqStart (Instance
, OpCode
);
1082 case EFI_MTFTP6_OPCODE_WRQ
:
1083 Status
= Mtftp6WrqStart (Instance
, OpCode
);
1087 Status
= EFI_DEVICE_ERROR
;
1091 if (EFI_ERROR (Status
)) {
1096 // Return immediately for asynchronous or poll the instance for synchronous.
1098 gBS
->RestoreTPL (Instance
->OldTpl
);
1100 if (Token
->Event
== NULL
) {
1101 while (Token
->Status
== EFI_NOT_READY
) {
1104 return Token
->Status
;
1111 Mtftp6OperationClean (Instance
, Status
);
1112 gBS
->RestoreTPL (Instance
->OldTpl
);
1119 The timer ticking routine for the Mtftp6 instance.
1121 @param[in] Event The pointer to the ticking event.
1122 @param[in] Context The pointer to the context.
1132 MTFTP6_SERVICE
*Service
;
1133 MTFTP6_INSTANCE
*Instance
;
1136 EFI_MTFTP6_TOKEN
*Token
;
1139 Service
= (MTFTP6_SERVICE
*) Context
;
1142 // Iterate through all the children of the Mtftp service instance. Time
1143 // out the packet. If maximum retries reached, clean the session up.
1145 NET_LIST_FOR_EACH_SAFE (Entry
, Next
, &Service
->Children
) {
1147 Instance
= NET_LIST_USER_STRUCT (Entry
, MTFTP6_INSTANCE
, Link
);
1149 if (Instance
->Token
== NULL
) {
1153 if (Instance
->PacketToLive
> 0) {
1154 Instance
->PacketToLive
--;
1158 Instance
->CurRetry
++;
1159 Token
= Instance
->Token
;
1161 if (Token
->TimeoutCallback
!= NULL
) {
1163 // Call the timeout callback routine if has.
1165 Status
= Token
->TimeoutCallback (&Instance
->Mtftp6
, Token
);
1167 if (EFI_ERROR (Status
)) {
1170 EFI_MTFTP6_ERRORCODE_REQUEST_DENIED
,
1171 (UINT8
*) "User aborted the transfer in time out"
1173 Mtftp6OperationClean (Instance
, EFI_ABORTED
);
1179 // Retransmit the packet if haven't reach the maxmium retry count,
1180 // otherwise exit the transfer.
1182 if (Instance
->CurRetry
< Instance
->MaxRetry
) {
1183 Mtftp6TransmitPacket (Instance
, Instance
->LastPacket
);
1185 Mtftp6OperationClean (Instance
, EFI_TIMEOUT
);