2 Mtftp6 support functions implementation.
4 Copyright (c) 2009 - 2015, 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
*) AsciiStrCpyS ((CHAR8
*) Cur
, Len
- 2, (CHAR8
*) Token
->Filename
);
516 Cur
+= AsciiStrLen ((CHAR8
*) Token
->Filename
) + 1;
517 Cur
= (UINT8
*) AsciiStrCpyS ((CHAR8
*) Cur
, Len
- 2 - (AsciiStrLen ((CHAR8
*) Token
->Filename
) + 1), (CHAR8
*) Mode
);
518 Cur
+= AsciiStrLen ((CHAR8
*) Mode
) + 1;
519 Len
-= ((UINT32
) AsciiStrLen ((CHAR8
*) Token
->Filename
) + (UINT32
) AsciiStrLen ((CHAR8
*) Mode
) + 4);
522 // Copy all the extension options into the packet.
524 for (Index
= 0; Index
< Token
->OptionCount
; ++Index
) {
525 Cur
= (UINT8
*) AsciiStrCpyS ((CHAR8
*) Cur
, Len
, (CHAR8
*) Options
[Index
].OptionStr
);
526 Cur
+= AsciiStrLen ((CHAR8
*) Options
[Index
].OptionStr
) + 1;
527 Len
-= (UINT32
)(AsciiStrLen ((CHAR8
*) Options
[Index
].OptionStr
) + 1);
528 Cur
= (UINT8
*) AsciiStrCpyS ((CHAR8
*) Cur
, Len
, (CHAR8
*) Options
[Index
].ValueStr
);
529 Cur
+= AsciiStrLen ((CHAR8
*) (CHAR8
*) Options
[Index
].ValueStr
) + 1;
530 Len
-= (UINT32
)(AsciiStrLen ((CHAR8
*) Options
[Index
].ValueStr
) + 1);
534 // Save the packet buf for retransmit
536 if (Instance
->LastPacket
!= NULL
) {
537 NetbufFree (Instance
->LastPacket
);
540 Instance
->LastPacket
= Nbuf
;
541 Instance
->CurRetry
= 0;
543 return Mtftp6TransmitPacket (Instance
, Nbuf
);
548 Build and send an error packet.
550 @param[in] Instance The pointer to the Mtftp6 instance.
551 @param[in] ErrCode The error code in the packet.
552 @param[in] ErrInfo The error message in the packet.
554 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory for the error packet.
555 @retval EFI_SUCCESS The error packet is transmitted.
556 @retval Others Failed to transmit the packet.
561 IN MTFTP6_INSTANCE
*Instance
,
567 EFI_MTFTP6_PACKET
*TftpError
;
571 // Allocate a packet then copy the data.
573 Len
= (UINT32
) (AsciiStrLen ((CHAR8
*) ErrInfo
) + sizeof (EFI_MTFTP6_ERROR_HEADER
));
574 Nbuf
= NetbufAlloc (Len
);
577 return EFI_OUT_OF_RESOURCES
;
580 TftpError
= (EFI_MTFTP6_PACKET
*) NetbufAllocSpace (Nbuf
, Len
, FALSE
);
582 if (TftpError
== NULL
) {
584 return EFI_OUT_OF_RESOURCES
;
587 TftpError
->OpCode
= HTONS (EFI_MTFTP6_OPCODE_ERROR
);
588 TftpError
->Error
.ErrorCode
= HTONS (ErrCode
);
590 AsciiStrCpyS ((CHAR8
*) TftpError
->Error
.ErrorMessage
, sizeof (TftpError
->Error
.ErrorMessage
) / sizeof (TftpError
->Error
.ErrorMessage
[0]), (CHAR8
*) ErrInfo
);
593 // Save the packet buf for retransmit
595 if (Instance
->LastPacket
!= NULL
) {
596 NetbufFree (Instance
->LastPacket
);
599 Instance
->LastPacket
= Nbuf
;
600 Instance
->CurRetry
= 0;
602 return Mtftp6TransmitPacket (Instance
, Nbuf
);
607 The callback function called when the packet is transmitted.
609 @param[in] Packet The pointer to the packet.
610 @param[in] UdpEpt The pointer to the Udp6 access point.
611 @param[in] IoStatus The result of the transmission.
612 @param[in] Context The pointer to the context.
619 IN UDP_END_POINT
*UdpEpt
,
620 IN EFI_STATUS IoStatus
,
625 *(BOOLEAN
*) Context
= TRUE
;
630 Send the packet for the Mtftp6 instance.
632 @param[in] Instance The pointer to the Mtftp6 instance.
633 @param[in] Packet The pointer to the packet to be sent.
635 @retval EFI_SUCCESS The packet was sent out
636 @retval Others Failed to transmit the packet.
640 Mtftp6TransmitPacket (
641 IN MTFTP6_INSTANCE
*Instance
,
645 EFI_UDP6_PROTOCOL
*Udp6
;
646 EFI_UDP6_CONFIG_DATA Udp6CfgData
;
652 ZeroMem (&Udp6CfgData
, sizeof(EFI_UDP6_CONFIG_DATA
));
653 Udp6
= Instance
->UdpIo
->Protocol
.Udp6
;
656 // Set the live time of the packet.
658 Instance
->PacketToLive
= Instance
->IsMaster
? Instance
->Timeout
: (Instance
->Timeout
* 2);
660 Temp
= (UINT16
*) NetbufGetByte (Packet
, 0, NULL
);
661 ASSERT (Temp
!= NULL
);
664 OpCode
= NTOHS (Value
);
666 if (OpCode
== EFI_MTFTP6_OPCODE_RRQ
|| OpCode
== EFI_MTFTP6_OPCODE_DIR
|| OpCode
== EFI_MTFTP6_OPCODE_WRQ
) {
668 // For the Rrq, Dir, Wrq requests of the operation, configure the Udp6Io as
669 // (serverip, 69, localip, localport) to send.
670 // Usually local address and local port are both default as zero.
672 Status
= Udp6
->Configure (Udp6
, NULL
);
674 if (EFI_ERROR (Status
)) {
678 Status
= Mtftp6ConfigUdpIo (
681 Instance
->ServerCmdPort
,
682 &Instance
->Config
->StationIp
,
683 Instance
->Config
->LocalPort
686 if (EFI_ERROR (Status
)) {
691 // Get the current local address and port by get Udp6 mode data.
693 Status
= Udp6
->GetModeData (Udp6
, &Udp6CfgData
, NULL
, NULL
, NULL
);
694 if (EFI_ERROR (Status
)) {
698 NET_GET_REF (Packet
);
700 Instance
->IsTransmitted
= FALSE
;
702 Status
= UdpIoSendDatagram (
708 &Instance
->IsTransmitted
711 if (EFI_ERROR (Status
)) {
712 NET_PUT_REF (Packet
);
717 // Poll till the packet sent out from the ip6 queue.
719 gBS
->RestoreTPL (Instance
->OldTpl
);
721 while (!Instance
->IsTransmitted
) {
725 Instance
->OldTpl
= gBS
->RaiseTPL (TPL_CALLBACK
);
728 // For the subsequent exchange of such requests, reconfigure the Udp6Io as
729 // (serverip, 0, localip, localport) to receive.
730 // Currently local address and local port are specified by Udp6 mode data.
732 Status
= Udp6
->Configure (Udp6
, NULL
);
734 if (EFI_ERROR (Status
)) {
738 Status
= Mtftp6ConfigUdpIo (
741 Instance
->ServerDataPort
,
742 &Udp6CfgData
.StationAddress
,
743 Udp6CfgData
.StationPort
747 // For the data exchange, configure the Udp6Io as (serverip, dataport,
748 // localip, localport) to send/receive.
749 // Currently local address and local port are specified by Udp6 mode data.
751 Status
= Udp6
->GetModeData (Udp6
, &Udp6CfgData
, NULL
, NULL
, NULL
);
752 if (EFI_ERROR (Status
)) {
756 if (Udp6CfgData
.RemotePort
!= Instance
->ServerDataPort
) {
758 Status
= Udp6
->Configure (Udp6
, NULL
);
760 if (EFI_ERROR (Status
)) {
764 Status
= Mtftp6ConfigUdpIo (
767 Instance
->ServerDataPort
,
768 &Udp6CfgData
.StationAddress
,
769 Udp6CfgData
.StationPort
772 if (EFI_ERROR (Status
)) {
777 NET_GET_REF (Packet
);
779 Instance
->IsTransmitted
= FALSE
;
781 Status
= UdpIoSendDatagram (
787 &Instance
->IsTransmitted
790 if (EFI_ERROR (Status
)) {
791 NET_PUT_REF (Packet
);
795 // Poll till the packet sent out from the ip6 queue.
797 gBS
->RestoreTPL (Instance
->OldTpl
);
799 while (!Instance
->IsTransmitted
) {
803 Instance
->OldTpl
= gBS
->RaiseTPL (TPL_CALLBACK
);
811 Check packet for GetInfo callback routine.
813 GetInfo is implemented with EfiMtftp6ReadFile. It's used to inspect
814 the first packet from server, then abort the session.
816 @param[in] This The pointer to the Mtftp6 protocol.
817 @param[in] Token The pointer to the Mtftp6 token.
818 @param[in] PacketLen The length of the packet.
819 @param[in] Packet The pointer to the received packet.
821 @retval EFI_ABORTED Abort the Mtftp6 operation.
827 IN EFI_MTFTP6_PROTOCOL
*This
,
828 IN EFI_MTFTP6_TOKEN
*Token
,
830 IN EFI_MTFTP6_PACKET
*Packet
833 MTFTP6_GETINFO_CONTEXT
*Context
;
836 Context
= (MTFTP6_GETINFO_CONTEXT
*) Token
->Context
;
837 OpCode
= NTOHS (Packet
->OpCode
);
840 // Set the GetInfo's return status according to the OpCode.
843 case EFI_MTFTP6_OPCODE_ERROR
:
844 Context
->Status
= EFI_TFTP_ERROR
;
847 case EFI_MTFTP6_OPCODE_OACK
:
848 Context
->Status
= EFI_SUCCESS
;
852 Context
->Status
= EFI_PROTOCOL_ERROR
;
856 // Allocate buffer then copy the packet over. Use gBS->AllocatePool
857 // in case NetAllocatePool will implements something tricky.
859 *(Context
->Packet
) = AllocateZeroPool (PacketLen
);
861 if (*(Context
->Packet
) == NULL
) {
862 Context
->Status
= EFI_OUT_OF_RESOURCES
;
866 *(Context
->PacketLen
) = PacketLen
;
867 CopyMem (*(Context
->Packet
), Packet
, PacketLen
);
874 Clean up the current Mtftp6 operation.
876 @param[in] Instance The pointer to the Mtftp6 instance.
877 @param[in] Result The result to be returned to the user.
881 Mtftp6OperationClean (
882 IN MTFTP6_INSTANCE
*Instance
,
888 MTFTP6_BLOCK_RANGE
*Block
;
891 // Clean up the current token and event.
893 if (Instance
->Token
!= NULL
) {
894 Instance
->Token
->Status
= Result
;
895 if (Instance
->Token
->Event
!= NULL
) {
896 gBS
->SignalEvent (Instance
->Token
->Event
);
898 Instance
->Token
= NULL
;
902 // Clean up the corresponding Udp6Io.
904 if (Instance
->UdpIo
!= NULL
) {
905 UdpIoCleanIo (Instance
->UdpIo
);
908 if (Instance
->McastUdpIo
!= NULL
) {
910 Instance
->McastUdpIo
->UdpHandle
,
911 &gEfiUdp6ProtocolGuid
,
912 Instance
->McastUdpIo
->Image
,
915 UdpIoFreeIo (Instance
->McastUdpIo
);
916 Instance
->McastUdpIo
= NULL
;
920 // Clean up the stored last packet.
922 if (Instance
->LastPacket
!= NULL
) {
923 NetbufFree (Instance
->LastPacket
);
924 Instance
->LastPacket
= NULL
;
927 NET_LIST_FOR_EACH_SAFE (Entry
, Next
, &Instance
->BlkList
) {
928 Block
= NET_LIST_USER_STRUCT (Entry
, MTFTP6_BLOCK_RANGE
, Link
);
929 RemoveEntryList (Entry
);
934 // Reinitialize the corresponding fields of the Mtftp6 operation.
936 ZeroMem (&Instance
->ExtInfo
, sizeof (MTFTP6_EXT_OPTION_INFO
));
937 ZeroMem (&Instance
->ServerIp
, sizeof (EFI_IPv6_ADDRESS
));
938 ZeroMem (&Instance
->McastIp
, sizeof (EFI_IPv6_ADDRESS
));
940 Instance
->ServerCmdPort
= 0;
941 Instance
->ServerDataPort
= 0;
942 Instance
->McastPort
= 0;
943 Instance
->BlkSize
= 0;
944 Instance
->LastBlk
= 0;
945 Instance
->PacketToLive
= 0;
946 Instance
->MaxRetry
= 0;
947 Instance
->CurRetry
= 0;
948 Instance
->Timeout
= 0;
949 Instance
->IsMaster
= TRUE
;
954 Start the Mtftp6 instance to perform the operation, such as read file,
955 write file, and read directory.
957 @param[in] This The MTFTP session.
958 @param[in] Token The token than encapsues the user's request.
959 @param[in] OpCode The operation to perform.
961 @retval EFI_INVALID_PARAMETER Some of the parameters are invalid.
962 @retval EFI_NOT_STARTED The MTFTP session hasn't been configured.
963 @retval EFI_ALREADY_STARTED There is pending operation for the session.
964 @retval EFI_SUCCESS The operation is successfully started.
968 Mtftp6OperationStart (
969 IN EFI_MTFTP6_PROTOCOL
*This
,
970 IN EFI_MTFTP6_TOKEN
*Token
,
974 MTFTP6_INSTANCE
*Instance
;
979 Token
->Filename
== NULL
||
980 (Token
->OptionCount
!= 0 && Token
->OptionList
== NULL
) ||
981 (Token
->OverrideData
!= NULL
&& !NetIp6IsValidUnicast (&Token
->OverrideData
->ServerIp
))
983 return EFI_INVALID_PARAMETER
;
987 // At least define one method to collect the data for download.
989 if ((OpCode
== EFI_MTFTP6_OPCODE_RRQ
|| OpCode
== EFI_MTFTP6_OPCODE_DIR
) &&
990 Token
->Buffer
== NULL
&&
991 Token
->CheckPacket
== NULL
993 return EFI_INVALID_PARAMETER
;
997 // At least define one method to provide the data for upload.
999 if (OpCode
== EFI_MTFTP6_OPCODE_WRQ
&& Token
->Buffer
== NULL
&& Token
->PacketNeeded
== NULL
) {
1000 return EFI_INVALID_PARAMETER
;
1003 Instance
= MTFTP6_INSTANCE_FROM_THIS (This
);
1005 if (Instance
->Config
== NULL
) {
1006 return EFI_NOT_STARTED
;
1009 if (Instance
->Token
!= NULL
) {
1010 return EFI_ACCESS_DENIED
;
1013 Status
= EFI_SUCCESS
;
1014 Instance
->OldTpl
= gBS
->RaiseTPL (TPL_CALLBACK
);
1017 // Parse the extension options in the request packet.
1019 if (Token
->OptionCount
!= 0) {
1021 Status
= Mtftp6ParseExtensionOption (
1028 if (EFI_ERROR (Status
)) {
1034 // Initialize runtime data from config data or override data.
1036 Instance
->Token
= Token
;
1037 Instance
->ServerCmdPort
= Instance
->Config
->InitialServerPort
;
1038 Instance
->ServerDataPort
= 0;
1039 Instance
->MaxRetry
= Instance
->Config
->TryCount
;
1040 Instance
->Timeout
= Instance
->Config
->TimeoutValue
;
1041 Instance
->IsMaster
= TRUE
;
1044 &Instance
->ServerIp
,
1045 &Instance
->Config
->ServerIp
,
1046 sizeof (EFI_IPv6_ADDRESS
)
1049 if (Token
->OverrideData
!= NULL
) {
1050 Instance
->ServerCmdPort
= Token
->OverrideData
->ServerPort
;
1051 Instance
->MaxRetry
= Token
->OverrideData
->TryCount
;
1052 Instance
->Timeout
= Token
->OverrideData
->TimeoutValue
;
1055 &Instance
->ServerIp
,
1056 &Token
->OverrideData
->ServerIp
,
1057 sizeof (EFI_IPv6_ADDRESS
)
1062 // Set default value for undefined parameters.
1064 if (Instance
->ServerCmdPort
== 0) {
1065 Instance
->ServerCmdPort
= MTFTP6_DEFAULT_SERVER_CMD_PORT
;
1067 if (Instance
->BlkSize
== 0) {
1068 Instance
->BlkSize
= MTFTP6_DEFAULT_BLK_SIZE
;
1070 if (Instance
->MaxRetry
== 0) {
1071 Instance
->MaxRetry
= MTFTP6_DEFAULT_MAX_RETRY
;
1073 if (Instance
->Timeout
== 0) {
1074 Instance
->Timeout
= MTFTP6_DEFAULT_TIMEOUT
;
1077 Token
->Status
= EFI_NOT_READY
;
1080 // Switch the routines by the operation code.
1083 case EFI_MTFTP6_OPCODE_RRQ
:
1084 Status
= Mtftp6RrqStart (Instance
, OpCode
);
1087 case EFI_MTFTP6_OPCODE_DIR
:
1088 Status
= Mtftp6RrqStart (Instance
, OpCode
);
1091 case EFI_MTFTP6_OPCODE_WRQ
:
1092 Status
= Mtftp6WrqStart (Instance
, OpCode
);
1096 Status
= EFI_DEVICE_ERROR
;
1100 if (EFI_ERROR (Status
)) {
1105 // Return immediately for asynchronous or poll the instance for synchronous.
1107 gBS
->RestoreTPL (Instance
->OldTpl
);
1109 if (Token
->Event
== NULL
) {
1110 while (Token
->Status
== EFI_NOT_READY
) {
1113 return Token
->Status
;
1120 Mtftp6OperationClean (Instance
, Status
);
1121 gBS
->RestoreTPL (Instance
->OldTpl
);
1128 The timer ticking routine for the Mtftp6 instance.
1130 @param[in] Event The pointer to the ticking event.
1131 @param[in] Context The pointer to the context.
1141 MTFTP6_SERVICE
*Service
;
1142 MTFTP6_INSTANCE
*Instance
;
1145 EFI_MTFTP6_TOKEN
*Token
;
1148 Service
= (MTFTP6_SERVICE
*) Context
;
1151 // Iterate through all the children of the Mtftp service instance. Time
1152 // out the packet. If maximum retries reached, clean the session up.
1154 NET_LIST_FOR_EACH_SAFE (Entry
, Next
, &Service
->Children
) {
1156 Instance
= NET_LIST_USER_STRUCT (Entry
, MTFTP6_INSTANCE
, Link
);
1158 if (Instance
->Token
== NULL
) {
1162 if (Instance
->PacketToLive
> 0) {
1163 Instance
->PacketToLive
--;
1167 Instance
->CurRetry
++;
1168 Token
= Instance
->Token
;
1170 if (Token
->TimeoutCallback
!= NULL
) {
1172 // Call the timeout callback routine if has.
1174 Status
= Token
->TimeoutCallback (&Instance
->Mtftp6
, Token
);
1176 if (EFI_ERROR (Status
)) {
1179 EFI_MTFTP6_ERRORCODE_REQUEST_DENIED
,
1180 (UINT8
*) "User aborted the transfer in time out"
1182 Mtftp6OperationClean (Instance
, EFI_ABORTED
);
1188 // Retransmit the packet if haven't reach the maxmium retry count,
1189 // otherwise exit the transfer.
1191 if (Instance
->CurRetry
< Instance
->MaxRetry
) {
1192 Mtftp6TransmitPacket (Instance
, Instance
->LastPacket
);
1194 Mtftp6OperationClean (Instance
, EFI_TIMEOUT
);