2 The implementation for the 'tftp' Shell command.
4 Copyright (c) 2015, ARM Ltd. All rights reserved.<BR>
5 Copyright (c) 2015 - 2018, Intel Corporation. All rights reserved. <BR>
6 (C) Copyright 2015 Hewlett Packard Enterprise Development LP<BR>
8 This program and the accompanying materials
9 are licensed and made available under the terms and conditions of the BSD License
10 which accompanies this distribution. The full text of the license may be found at
11 http://opensource.org/licenses/bsd-license.php.
13 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
14 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
19 #define IP4_CONFIG2_INTERFACE_INFO_NAME_LENGTH 32
20 EFI_HANDLE mTftpHiiHandle
;
23 Constant strings and definitions related to the message indicating the amount of
24 progress in the dowloading of a TFTP file.
27 // Frame for the progression slider
28 STATIC CONST CHAR16 mTftpProgressFrame
[] = L
"[ ]";
30 // Number of steps in the progression slider
31 #define TFTP_PROGRESS_SLIDER_STEPS ((sizeof (mTftpProgressFrame) / sizeof (CHAR16)) - 3)
33 // Size in number of characters plus one (final zero) of the message to
34 // indicate the progress of a TFTP download. The format is "[(progress slider:
35 // 40 characters)] (nb of KBytes downloaded so far: 7 characters) Kb". There
36 // are thus the number of characters in mTftpProgressFrame[] plus 11 characters
37 // (2 // spaces, "Kb" and seven characters for the number of KBytes).
38 #define TFTP_PROGRESS_MESSAGE_SIZE ((sizeof (mTftpProgressFrame) / sizeof (CHAR16)) + 12)
40 // String to delete the TFTP progress message to be able to update it :
41 // (TFTP_PROGRESS_MESSAGE_SIZE-1) '\b'
42 STATIC CONST CHAR16 mTftpProgressDelete
[] = L
"\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b\b";
45 SHELL_FILE_HANDLE mFileHandle
;
47 // Path of the local file, Unicode encoded
48 CONST CHAR16
*mLocalFilePath
;
51 Check and convert the UINT16 option values of the 'tftp' command
53 @param[in] ValueStr Value as an Unicode encoded string
54 @param[out] Value UINT16 value
56 @return TRUE The value was returned.
57 @return FALSE A parsing error occured.
62 IN CONST CHAR16
*ValueStr
,
67 Get the name of the NIC.
69 @param[in] ControllerHandle The network physical device handle.
70 @param[in] NicNumber The network physical device number.
71 @param[out] NicName Address where to store the NIC name.
72 The memory area has to be at least
73 IP4_CONFIG2_INTERFACE_INFO_NAME_LENGTH
76 @return EFI_SUCCESS The name of the NIC was returned.
77 @return Others The creation of the child for the Managed
78 Network Service failed or the opening of
79 the Managed Network Protocol failed or
80 the operational parameters for the
81 Managed Network Protocol could not be
87 IN EFI_HANDLE ControllerHandle
,
93 Create a child for the service identified by its service binding protocol GUID
94 and get from the child the interface of the protocol identified by its GUID.
96 @param[in] ControllerHandle Controller handle.
97 @param[in] ServiceBindingProtocolGuid Service binding protocol GUID of the
98 service to be created.
99 @param[in] ProtocolGuid GUID of the protocol to be open.
100 @param[out] ChildHandle Address where the handler of the
101 created child is returned. NULL is
102 returned in case of error.
103 @param[out] Interface Address where a pointer to the
104 protocol interface is returned in
107 @return EFI_SUCCESS The child was created and the protocol opened.
108 @return Others Either the creation of the child or the opening
109 of the protocol failed.
113 CreateServiceChildAndOpenProtocol (
114 IN EFI_HANDLE ControllerHandle
,
115 IN EFI_GUID
*ServiceBindingProtocolGuid
,
116 IN EFI_GUID
*ProtocolGuid
,
117 OUT EFI_HANDLE
*ChildHandle
,
122 Close the protocol identified by its GUID on the child handle of the service
123 identified by its service binding protocol GUID, then destroy the child
126 @param[in] ControllerHandle Controller handle.
127 @param[in] ServiceBindingProtocolGuid Service binding protocol GUID of the
128 service to be destroyed.
129 @param[in] ProtocolGuid GUID of the protocol to be closed.
130 @param[in] ChildHandle Handle of the child to be destroyed.
135 CloseProtocolAndDestroyServiceChild (
136 IN EFI_HANDLE ControllerHandle
,
137 IN EFI_GUID
*ServiceBindingProtocolGuid
,
138 IN EFI_GUID
*ProtocolGuid
,
139 IN EFI_HANDLE ChildHandle
143 Worker function that gets the size in numbers of bytes of a file from a TFTP
144 server before to download the file.
146 @param[in] Mtftp4 MTFTP4 protocol interface
147 @param[in] FilePath Path of the file, ASCII encoded
148 @param[out] FileSize Address where to store the file size in number of
151 @retval EFI_SUCCESS The size of the file was returned.
152 @retval EFI_UNSUPPORTED The server does not support the "tsize" option.
153 @retval Others Error when retrieving the information from the server
154 (see EFI_MTFTP4_PROTOCOL.GetInfo() status codes)
155 or error when parsing the response of the server.
160 IN EFI_MTFTP4_PROTOCOL
*Mtftp4
,
161 IN CONST CHAR8
*FilePath
,
166 Worker function that download the data of a file from a TFTP server given
167 the path of the file and its size.
169 @param[in] Mtftp4 MTFTP4 protocol interface
170 @param[in] FilePath Path of the file, Unicode encoded
171 @param[in] AsciiFilePath Path of the file, ASCII encoded
172 @param[in] FileSize Size of the file in number of bytes
173 @param[in] BlockSize Value of the TFTP blksize option
174 @param[in] WindowSize Value of the TFTP window size option
176 @retval EFI_SUCCESS The file was downloaded.
177 @retval EFI_OUT_OF_RESOURCES A memory allocation failed.
178 @retval Others The downloading of the file from the server failed
179 (see EFI_MTFTP4_PROTOCOL.ReadFile() status codes).
185 IN EFI_MTFTP4_PROTOCOL
*Mtftp4
,
186 IN CONST CHAR16
*FilePath
,
187 IN CONST CHAR8
*AsciiFilePath
,
194 Update the progress of a file download
195 This procedure is called each time a new TFTP packet is received.
197 @param[in] This MTFTP4 protocol interface
198 @param[in] Token Parameters for the download of the file
199 @param[in] PacketLen Length of the packet
200 @param[in] Packet Address of the packet
202 @retval EFI_SUCCESS All packets are accepted.
209 IN EFI_MTFTP4_PROTOCOL
*This
,
210 IN EFI_MTFTP4_TOKEN
*Token
,
212 IN EFI_MTFTP4_PACKET
*Packet
215 EFI_MTFTP4_CONFIG_DATA DefaultMtftp4ConfigData
= {
216 TRUE
, // Use default setting
217 { { 0, 0, 0, 0 } }, // StationIp - Not relevant as UseDefaultSetting=TRUE
218 { { 0, 0, 0, 0 } }, // SubnetMask - Not relevant as UseDefaultSetting=TRUE
219 0, // LocalPort - Automatically assigned port number.
220 { { 0, 0, 0, 0 } }, // GatewayIp - Not relevant as UseDefaultSetting=TRUE
221 { { 0, 0, 0, 0 } }, // ServerIp - Not known yet
222 69, // InitialServerPort - Standard TFTP server port
223 6, // TryCount - The number of times to transmit request packets and wait for a response.
224 4 // TimeoutValue - Retransmission timeout in seconds.
227 STATIC CONST SHELL_PARAM_ITEM ParamList
[] = {
239 /// The default block size (512) of tftp is defined in the RFC1350.
241 #define MTFTP_DEFAULT_BLKSIZE 512
243 /// The valid range of block size option is defined in the RFC2348.
245 #define MTFTP_MIN_BLKSIZE 8
246 #define MTFTP_MAX_BLKSIZE 65464
248 /// The default windowsize (1) of tftp.
250 #define MTFTP_DEFAULT_WINDOWSIZE 1
252 /// The valid range of window size option.
253 /// Note that: RFC 7440 does not mention max window size value, but for the
254 /// stability reason, the value is limited to 64.
256 #define MTFTP_MIN_WINDOWSIZE 1
257 #define MTFTP_MAX_WINDOWSIZE 64
260 Function for 'tftp' command.
262 @param[in] ImageHandle Handle to the Image (NULL if Internal).
263 @param[in] SystemTable Pointer to the System Table (NULL if Internal).
265 @return SHELL_SUCCESS The 'tftp' command completed successfully.
266 @return SHELL_ABORTED The Shell Library initialization failed.
267 @return SHELL_INVALID_PARAMETER At least one of the command's arguments is
269 @return SHELL_OUT_OF_RESOURCES A memory allocation failed.
270 @return SHELL_NOT_FOUND Network Interface Card not found or server
276 IN EFI_HANDLE ImageHandle
,
277 IN EFI_SYSTEM_TABLE
*SystemTable
280 SHELL_STATUS ShellStatus
;
282 LIST_ENTRY
*CheckPackage
;
283 CHAR16
*ProblemParam
;
285 CONST CHAR16
*UserNicName
;
287 CONST CHAR16
*ValueStr
;
288 CONST CHAR16
*RemoteFilePath
;
289 CHAR8
*AsciiRemoteFilePath
;
291 CONST CHAR16
*Walker
;
292 EFI_MTFTP4_CONFIG_DATA Mtftp4ConfigData
;
296 CHAR16 NicName
[IP4_CONFIG2_INTERFACE_INFO_NAME_LENGTH
];
297 EFI_HANDLE ControllerHandle
;
298 EFI_HANDLE Mtftp4ChildHandle
;
299 EFI_MTFTP4_PROTOCOL
*Mtftp4
;
304 ShellStatus
= SHELL_INVALID_PARAMETER
;
307 AsciiRemoteFilePath
= NULL
;
310 BlockSize
= MTFTP_DEFAULT_BLKSIZE
;
311 WindowSize
= MTFTP_DEFAULT_WINDOWSIZE
;
314 // Initialize the Shell library (we must be in non-auto-init...)
316 Status
= ShellInitialize ();
317 if (EFI_ERROR (Status
)) {
318 ASSERT_EFI_ERROR (Status
);
319 return SHELL_ABORTED
;
323 // Parse the command line.
325 Status
= ShellCommandLineParse (ParamList
, &CheckPackage
, &ProblemParam
, TRUE
);
326 if (EFI_ERROR (Status
)) {
327 if ((Status
== EFI_VOLUME_CORRUPTED
) &&
328 (ProblemParam
!= NULL
) ) {
330 -1, -1, NULL
, STRING_TOKEN (STR_GEN_PROBLEM
), mTftpHiiHandle
,
331 L
"tftp", ProblemParam
333 FreePool (ProblemParam
);
341 // Check the number of parameters
343 ParamCount
= ShellCommandLineGetCount (CheckPackage
);
344 if (ParamCount
> 4) {
346 -1, -1, NULL
, STRING_TOKEN (STR_GEN_TOO_MANY
),
347 mTftpHiiHandle
, L
"tftp"
351 if (ParamCount
< 3) {
353 -1, -1, NULL
, STRING_TOKEN (STR_GEN_TOO_FEW
),
354 mTftpHiiHandle
, L
"tftp"
359 CopyMem (&Mtftp4ConfigData
, &DefaultMtftp4ConfigData
, sizeof (EFI_MTFTP4_CONFIG_DATA
));
362 // Check the host IPv4 address
364 ValueStr
= ShellCommandLineGetRawValue (CheckPackage
, 1);
365 Status
= NetLibStrToIp4 (ValueStr
, &Mtftp4ConfigData
.ServerIp
);
366 if (EFI_ERROR (Status
)) {
368 -1, -1, NULL
, STRING_TOKEN (STR_GEN_PARAM_INV
),
369 mTftpHiiHandle
, L
"tftp", ValueStr
374 RemoteFilePath
= ShellCommandLineGetRawValue (CheckPackage
, 2);
375 ASSERT(RemoteFilePath
!= NULL
);
376 FilePathSize
= StrLen (RemoteFilePath
) + 1;
377 AsciiRemoteFilePath
= AllocatePool (FilePathSize
);
378 if (AsciiRemoteFilePath
== NULL
) {
379 ShellStatus
= SHELL_OUT_OF_RESOURCES
;
382 UnicodeStrToAsciiStrS (RemoteFilePath
, AsciiRemoteFilePath
, FilePathSize
);
384 if (ParamCount
== 4) {
385 mLocalFilePath
= ShellCommandLineGetRawValue (CheckPackage
, 3);
387 Walker
= RemoteFilePath
+ StrLen (RemoteFilePath
);
388 while ((--Walker
) >= RemoteFilePath
) {
389 if ((*Walker
== L
'\\') ||
390 (*Walker
== L
'/' ) ) {
394 mLocalFilePath
= Walker
+ 1;
398 // Get the name of the Network Interface Card to be used if any.
400 UserNicName
= ShellCommandLineGetValue (CheckPackage
, L
"-i");
402 ValueStr
= ShellCommandLineGetValue (CheckPackage
, L
"-l");
403 if (ValueStr
!= NULL
) {
404 if (!StringToUint16 (ValueStr
, &Mtftp4ConfigData
.LocalPort
)) {
409 ValueStr
= ShellCommandLineGetValue (CheckPackage
, L
"-r");
410 if (ValueStr
!= NULL
) {
411 if (!StringToUint16 (ValueStr
, &Mtftp4ConfigData
.InitialServerPort
)) {
416 ValueStr
= ShellCommandLineGetValue (CheckPackage
, L
"-c");
417 if (ValueStr
!= NULL
) {
418 if (!StringToUint16 (ValueStr
, &Mtftp4ConfigData
.TryCount
)) {
422 if (Mtftp4ConfigData
.TryCount
== 0) {
423 Mtftp4ConfigData
.TryCount
= 6;
427 ValueStr
= ShellCommandLineGetValue (CheckPackage
, L
"-t");
428 if (ValueStr
!= NULL
) {
429 if (!StringToUint16 (ValueStr
, &Mtftp4ConfigData
.TimeoutValue
)) {
432 if (Mtftp4ConfigData
.TimeoutValue
== 0) {
434 -1, -1, NULL
, STRING_TOKEN (STR_GEN_PARAM_INV
),
435 mTftpHiiHandle
, L
"tftp", ValueStr
441 ValueStr
= ShellCommandLineGetValue (CheckPackage
, L
"-s");
442 if (ValueStr
!= NULL
) {
443 if (!StringToUint16 (ValueStr
, &BlockSize
)) {
446 if (BlockSize
< MTFTP_MIN_BLKSIZE
|| BlockSize
> MTFTP_MAX_BLKSIZE
) {
448 -1, -1, NULL
, STRING_TOKEN (STR_GEN_PARAM_INV
),
449 mTftpHiiHandle
, L
"tftp", ValueStr
455 ValueStr
= ShellCommandLineGetValue (CheckPackage
, L
"-w");
456 if (ValueStr
!= NULL
) {
457 if (!StringToUint16 (ValueStr
, &WindowSize
)) {
460 if (WindowSize
< MTFTP_MIN_WINDOWSIZE
|| WindowSize
> MTFTP_MAX_WINDOWSIZE
) {
462 -1, -1, NULL
, STRING_TOKEN (STR_GEN_PARAM_INV
),
463 mTftpHiiHandle
, L
"tftp", ValueStr
470 // Locate all MTFTP4 Service Binding protocols
472 ShellStatus
= SHELL_NOT_FOUND
;
473 Status
= gBS
->LocateHandleBuffer (
475 &gEfiManagedNetworkServiceBindingProtocolGuid
,
480 if (EFI_ERROR (Status
) || (HandleCount
== 0)) {
482 -1, -1, NULL
, STRING_TOKEN (STR_TFTP_ERR_NO_NIC
),
489 (NicNumber
< HandleCount
) && (ShellStatus
!= SHELL_SUCCESS
);
491 ControllerHandle
= Handles
[NicNumber
];
493 Status
= GetNicName (ControllerHandle
, NicNumber
, NicName
);
494 if (EFI_ERROR (Status
)) {
496 -1, -1, NULL
, STRING_TOKEN (STR_TFTP_ERR_NIC_NAME
),
497 mTftpHiiHandle
, NicNumber
, Status
502 if (UserNicName
!= NULL
) {
503 if (StrCmp (NicName
, UserNicName
) != 0) {
509 Status
= CreateServiceChildAndOpenProtocol (
511 &gEfiMtftp4ServiceBindingProtocolGuid
,
512 &gEfiMtftp4ProtocolGuid
,
516 if (EFI_ERROR (Status
)) {
518 -1, -1, NULL
, STRING_TOKEN (STR_TFTP_ERR_OPEN_PROTOCOL
),
519 mTftpHiiHandle
, NicName
, Status
524 Status
= Mtftp4
->Configure (Mtftp4
, &Mtftp4ConfigData
);
525 if (EFI_ERROR (Status
)) {
527 -1, -1, NULL
, STRING_TOKEN (STR_TFTP_ERR_CONFIGURE
),
528 mTftpHiiHandle
, NicName
, Status
533 Status
= GetFileSize (Mtftp4
, AsciiRemoteFilePath
, &FileSize
);
534 if (EFI_ERROR (Status
)) {
536 -1, -1, NULL
, STRING_TOKEN (STR_TFTP_ERR_FILE_SIZE
),
537 mTftpHiiHandle
, RemoteFilePath
, NicName
, Status
542 Status
= DownloadFile (Mtftp4
, RemoteFilePath
, AsciiRemoteFilePath
, FileSize
, BlockSize
, WindowSize
);
543 if (EFI_ERROR (Status
)) {
545 -1, -1, NULL
, STRING_TOKEN (STR_TFTP_ERR_DOWNLOAD
),
546 mTftpHiiHandle
, RemoteFilePath
, NicName
, Status
551 ShellStatus
= SHELL_SUCCESS
;
555 CloseProtocolAndDestroyServiceChild (
557 &gEfiMtftp4ServiceBindingProtocolGuid
,
558 &gEfiMtftp4ProtocolGuid
,
563 if ((UserNicName
!= NULL
) && (!NicFound
)) {
565 -1, -1, NULL
, STRING_TOKEN (STR_TFTP_ERR_NIC_NOT_FOUND
),
566 mTftpHiiHandle
, UserNicName
572 ShellCommandLineFreeVarList (CheckPackage
);
573 if (AsciiRemoteFilePath
!= NULL
) {
574 FreePool (AsciiRemoteFilePath
);
576 if (Handles
!= NULL
) {
580 if ((ShellStatus
!= SHELL_SUCCESS
) && (EFI_ERROR(Status
))) {
581 ShellStatus
= Status
& ~MAX_BIT
;
588 Check and convert the UINT16 option values of the 'tftp' command
590 @param[in] ValueStr Value as an Unicode encoded string
591 @param[out] Value UINT16 value
593 @return TRUE The value was returned.
594 @return FALSE A parsing error occured.
599 IN CONST CHAR16
*ValueStr
,
605 Val
= ShellStrToUintn (ValueStr
);
606 if (Val
> MAX_UINT16
) {
608 -1, -1, NULL
, STRING_TOKEN (STR_GEN_PARAM_INV
),
609 mTftpHiiHandle
, L
"tftp", ValueStr
614 *Value
= (UINT16
)Val
;
619 Get the name of the NIC.
621 @param[in] ControllerHandle The network physical device handle.
622 @param[in] NicNumber The network physical device number.
623 @param[out] NicName Address where to store the NIC name.
624 The memory area has to be at least
625 IP4_CONFIG2_INTERFACE_INFO_NAME_LENGTH
628 @return EFI_SUCCESS The name of the NIC was returned.
629 @return Others The creation of the child for the Managed
630 Network Service failed or the opening of
631 the Managed Network Protocol failed or
632 the operational parameters for the
633 Managed Network Protocol could not be
639 IN EFI_HANDLE ControllerHandle
,
645 EFI_HANDLE MnpHandle
;
646 EFI_MANAGED_NETWORK_PROTOCOL
*Mnp
;
647 EFI_SIMPLE_NETWORK_MODE SnpMode
;
649 Status
= CreateServiceChildAndOpenProtocol (
651 &gEfiManagedNetworkServiceBindingProtocolGuid
,
652 &gEfiManagedNetworkProtocolGuid
,
656 if (EFI_ERROR (Status
)) {
660 Status
= Mnp
->GetModeData (Mnp
, NULL
, &SnpMode
);
661 if (EFI_ERROR (Status
) && (Status
!= EFI_NOT_STARTED
)) {
667 IP4_CONFIG2_INTERFACE_INFO_NAME_LENGTH
,
668 SnpMode
.IfType
== NET_IFTYPE_ETHERNET
?
674 Status
= EFI_SUCCESS
;
678 if (MnpHandle
!= NULL
) {
679 CloseProtocolAndDestroyServiceChild (
681 &gEfiManagedNetworkServiceBindingProtocolGuid
,
682 &gEfiManagedNetworkProtocolGuid
,
691 Create a child for the service identified by its service binding protocol GUID
692 and get from the child the interface of the protocol identified by its GUID.
694 @param[in] ControllerHandle Controller handle.
695 @param[in] ServiceBindingProtocolGuid Service binding protocol GUID of the
696 service to be created.
697 @param[in] ProtocolGuid GUID of the protocol to be open.
698 @param[out] ChildHandle Address where the handler of the
699 created child is returned. NULL is
700 returned in case of error.
701 @param[out] Interface Address where a pointer to the
702 protocol interface is returned in
705 @return EFI_SUCCESS The child was created and the protocol opened.
706 @return Others Either the creation of the child or the opening
707 of the protocol failed.
711 CreateServiceChildAndOpenProtocol (
712 IN EFI_HANDLE ControllerHandle
,
713 IN EFI_GUID
*ServiceBindingProtocolGuid
,
714 IN EFI_GUID
*ProtocolGuid
,
715 OUT EFI_HANDLE
*ChildHandle
,
722 Status
= NetLibCreateServiceChild (
725 ServiceBindingProtocolGuid
,
728 if (!EFI_ERROR (Status
)) {
729 Status
= gBS
->OpenProtocol (
735 EFI_OPEN_PROTOCOL_GET_PROTOCOL
737 if (EFI_ERROR (Status
)) {
738 NetLibDestroyServiceChild (
741 ServiceBindingProtocolGuid
,
752 Close the protocol identified by its GUID on the child handle of the service
753 identified by its service binding protocol GUID, then destroy the child
756 @param[in] ControllerHandle Controller handle.
757 @param[in] ServiceBindingProtocolGuid Service binding protocol GUID of the
758 service to be destroyed.
759 @param[in] ProtocolGuid GUID of the protocol to be closed.
760 @param[in] ChildHandle Handle of the child to be destroyed.
765 CloseProtocolAndDestroyServiceChild (
766 IN EFI_HANDLE ControllerHandle
,
767 IN EFI_GUID
*ServiceBindingProtocolGuid
,
768 IN EFI_GUID
*ProtocolGuid
,
769 IN EFI_HANDLE ChildHandle
779 NetLibDestroyServiceChild (
782 ServiceBindingProtocolGuid
,
788 Worker function that gets the size in numbers of bytes of a file from a TFTP
789 server before to download the file.
791 @param[in] Mtftp4 MTFTP4 protocol interface
792 @param[in] FilePath Path of the file, ASCII encoded
793 @param[out] FileSize Address where to store the file size in number of
796 @retval EFI_SUCCESS The size of the file was returned.
797 @retval EFI_UNSUPPORTED The server does not support the "tsize" option.
798 @retval Others Error when retrieving the information from the server
799 (see EFI_MTFTP4_PROTOCOL.GetInfo() status codes)
800 or error when parsing the response of the server.
805 IN EFI_MTFTP4_PROTOCOL
*Mtftp4
,
806 IN CONST CHAR8
*FilePath
,
811 EFI_MTFTP4_OPTION ReqOpt
[1];
812 EFI_MTFTP4_PACKET
*Packet
;
814 EFI_MTFTP4_OPTION
*TableOfOptions
;
815 EFI_MTFTP4_OPTION
*Option
;
819 ReqOpt
[0].OptionStr
= (UINT8
*)"tsize";
822 ReqOpt
[0].ValueStr
= OptBuf
;
824 Status
= Mtftp4
->GetInfo (
835 if (EFI_ERROR (Status
)) {
839 Status
= Mtftp4
->ParseOptions (
846 if (EFI_ERROR (Status
)) {
850 Option
= TableOfOptions
;
851 while (OptCnt
!= 0) {
852 if (AsciiStrnCmp ((CHAR8
*)Option
->OptionStr
, "tsize", 5) == 0) {
853 *FileSize
= AsciiStrDecimalToUintn ((CHAR8
*)Option
->ValueStr
);
859 FreePool (TableOfOptions
);
862 Status
= EFI_UNSUPPORTED
;
871 Worker function that download the data of a file from a TFTP server given
872 the path of the file and its size.
874 @param[in] Mtftp4 MTFTP4 protocol interface
875 @param[in] FilePath Path of the file, Unicode encoded
876 @param[in] AsciiFilePath Path of the file, ASCII encoded
877 @param[in] FileSize Size of the file in number of bytes
878 @param[in] BlockSize Value of the TFTP blksize option
879 @param[in] WindowSize Value of the TFTP window size option
881 @retval EFI_SUCCESS The file was downloaded.
882 @retval EFI_OUT_OF_RESOURCES A memory allocation failed.
883 @retval Others The downloading of the file from the server failed
884 (see EFI_MTFTP4_PROTOCOL.ReadFile() status codes).
890 IN EFI_MTFTP4_PROTOCOL
*Mtftp4
,
891 IN CONST CHAR16
*FilePath
,
892 IN CONST CHAR8
*AsciiFilePath
,
899 DOWNLOAD_CONTEXT
*TftpContext
;
900 EFI_MTFTP4_TOKEN Mtftp4Token
;
901 UINT8 BlksizeBuf
[10];
902 UINT8 WindowsizeBuf
[10];
904 ZeroMem (&Mtftp4Token
, sizeof (EFI_MTFTP4_TOKEN
));
906 TftpContext
= AllocatePool (sizeof (DOWNLOAD_CONTEXT
));
907 if (TftpContext
== NULL
) {
908 Status
= EFI_OUT_OF_RESOURCES
;
911 TftpContext
->FileSize
= FileSize
;
912 TftpContext
->DownloadedNbOfBytes
= 0;
913 TftpContext
->LastReportedNbOfBytes
= 0;
915 Mtftp4Token
.Filename
= (UINT8
*)AsciiFilePath
;
916 Mtftp4Token
.CheckPacket
= CheckPacket
;
917 Mtftp4Token
.Context
= (VOID
*)TftpContext
;
918 Mtftp4Token
.OptionCount
= 0;
919 Mtftp4Token
.OptionList
= AllocatePool (sizeof (EFI_MTFTP4_OPTION
) * 2);
920 if (Mtftp4Token
.OptionList
== NULL
) {
921 Status
= EFI_OUT_OF_RESOURCES
;
925 if (BlockSize
!= MTFTP_DEFAULT_BLKSIZE
) {
926 Mtftp4Token
.OptionList
[Mtftp4Token
.OptionCount
].OptionStr
= (UINT8
*) "blksize";
927 AsciiSPrint ((CHAR8
*) BlksizeBuf
, sizeof (BlksizeBuf
), "%d", BlockSize
);
928 Mtftp4Token
.OptionList
[Mtftp4Token
.OptionCount
].ValueStr
= BlksizeBuf
;
929 Mtftp4Token
.OptionCount
++;
932 if (WindowSize
!= MTFTP_DEFAULT_WINDOWSIZE
) {
933 Mtftp4Token
.OptionList
[Mtftp4Token
.OptionCount
].OptionStr
= (UINT8
*) "windowsize";
934 AsciiSPrint ((CHAR8
*) WindowsizeBuf
, sizeof (WindowsizeBuf
), "%d", WindowSize
);
935 Mtftp4Token
.OptionList
[Mtftp4Token
.OptionCount
].ValueStr
= WindowsizeBuf
;
936 Mtftp4Token
.OptionCount
++;
940 -1, -1, NULL
, STRING_TOKEN (STR_TFTP_DOWNLOADING
),
941 mTftpHiiHandle
, FilePath
947 if (!EFI_ERROR (ShellFileExists (mLocalFilePath
))) {
948 ShellDeleteFileByName (mLocalFilePath
);
951 Status
= ShellOpenFileByName (
954 EFI_FILE_MODE_CREATE
|
955 EFI_FILE_MODE_WRITE
|
959 if (EFI_ERROR (Status
)) {
961 -1, -1, NULL
, STRING_TOKEN (STR_GEN_FILE_OPEN_FAIL
),
962 mTftpHiiHandle
, L
"tftp", mLocalFilePath
967 Status
= Mtftp4
->ReadFile (Mtftp4
, &Mtftp4Token
);
969 -1, -1, NULL
, STRING_TOKEN (STR_GEN_CRLF
),
976 ShellCloseFile (&mFileHandle
);
979 if (TftpContext
!= NULL
) {
980 FreePool (TftpContext
);
983 if (Mtftp4Token
.OptionList
!= NULL
) {
984 FreePool (Mtftp4Token
.OptionList
);
991 Update the progress of a file download
992 This procedure is called each time a new TFTP packet is received.
994 @param[in] This MTFTP4 protocol interface
995 @param[in] Token Parameters for the download of the file
996 @param[in] PacketLen Length of the packet
997 @param[in] Packet Address of the packet
999 @retval EFI_SUCCESS All packets are accepted.
1006 IN EFI_MTFTP4_PROTOCOL
*This
,
1007 IN EFI_MTFTP4_TOKEN
*Token
,
1008 IN UINT16 PacketLen
,
1009 IN EFI_MTFTP4_PACKET
*Packet
1012 DOWNLOAD_CONTEXT
*Context
;
1013 CHAR16 Progress
[TFTP_PROGRESS_MESSAGE_SIZE
];
1021 if ((NTOHS (Packet
->OpCode
)) != EFI_MTFTP4_OPCODE_DATA
) {
1025 Context
= (DOWNLOAD_CONTEXT
*)Token
->Context
;
1028 // The data in the packet are prepended with two UINT16 :
1029 // . OpCode = EFI_MTFTP4_OPCODE_DATA
1030 // . Block = the number of this block of data
1032 DownloadLen
= (UINTN
)PacketLen
- sizeof (Packet
->OpCode
) - sizeof (Packet
->Data
.Block
);
1034 ShellSetFilePosition(mFileHandle
, Context
->DownloadedNbOfBytes
);
1035 Status
= ShellWriteFile (mFileHandle
, &DownloadLen
, Packet
->Data
.Data
);
1036 if (EFI_ERROR (Status
)) {
1037 if (Context
->DownloadedNbOfBytes
> 0) {
1039 -1, -1, NULL
, STRING_TOKEN (STR_GEN_CRLF
),
1044 -1, -1, NULL
, STRING_TOKEN (STR_TFTP_ERR_WRITE
),
1045 mTftpHiiHandle
, mLocalFilePath
, Status
1050 if (Context
->DownloadedNbOfBytes
== 0) {
1051 ShellPrintEx (-1, -1, L
"%s 0 Kb", mTftpProgressFrame
);
1054 Context
->DownloadedNbOfBytes
+= DownloadLen
;
1055 NbOfKb
= Context
->DownloadedNbOfBytes
/ 1024;
1057 Progress
[0] = L
'\0';
1058 LastStep
= (Context
->LastReportedNbOfBytes
* TFTP_PROGRESS_SLIDER_STEPS
) / Context
->FileSize
;
1059 Step
= (Context
->DownloadedNbOfBytes
* TFTP_PROGRESS_SLIDER_STEPS
) / Context
->FileSize
;
1061 if (Step
<= LastStep
) {
1065 ShellPrintEx (-1, -1, L
"%s", mTftpProgressDelete
);
1067 Status
= StrCpyS (Progress
, TFTP_PROGRESS_MESSAGE_SIZE
, mTftpProgressFrame
);
1068 if (EFI_ERROR(Status
)) {
1071 for (Index
= 1; Index
< Step
; Index
++) {
1072 Progress
[Index
] = L
'=';
1074 Progress
[Step
] = L
'>';
1077 Progress
+ (sizeof (mTftpProgressFrame
) / sizeof (CHAR16
)) - 1,
1078 sizeof (Progress
) - sizeof (mTftpProgressFrame
),
1082 Context
->LastReportedNbOfBytes
= Context
->DownloadedNbOfBytes
;
1084 ShellPrintEx (-1, -1, L
"%s", Progress
);
1090 Retrive HII package list from ImageHandle and publish to HII database.
1092 @param ImageHandle The image handle of the process.
1097 InitializeHiiPackage (
1098 EFI_HANDLE ImageHandle
1102 EFI_HII_PACKAGE_LIST_HEADER
*PackageList
;
1103 EFI_HANDLE HiiHandle
;
1106 // Retrieve HII package list from ImageHandle
1108 Status
= gBS
->OpenProtocol (
1110 &gEfiHiiPackageListProtocolGuid
,
1111 (VOID
**)&PackageList
,
1114 EFI_OPEN_PROTOCOL_GET_PROTOCOL
1116 ASSERT_EFI_ERROR (Status
);
1117 if (EFI_ERROR (Status
)) {
1122 // Publish HII package list to HII Database.
1124 Status
= gHiiDatabase
->NewPackageList (
1130 ASSERT_EFI_ERROR (Status
);
1131 if (EFI_ERROR (Status
)) {