sravan/system76-edk2
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

ShellPkg/tftp: Convert from NULL class library to Dynamic Command

Browse Source 
UEFI Shell spec defines Shell Dynamic Command protocol which is just
for the purpose to extend internal command.
So tftp command is changed from NULL class library to be a driver
producing DynamicCommand protocol.

The guideline is:
1. Only use NULL class library for Shell spec defined commands.
2. New commands can be provided as not only a standalone application
   but also a dynamic command. So it can be used either as an
   internal command, but also as a standalone application.

TftpApp.inf is to provide a standalone application.
TftpDynamicCommand.inf is to provide a standalone driver producing
Dynamic Command protocol.

Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Ruiyu Ni <ruiyu.ni@intel.com>
Reviewed-by: Jaben Carsey <jaben.carsey@intel.com>
Cc: Michael D Kinney <michael.d.kinney@intel.com>
This commit is contained in:
Ruiyu Ni
2017-10-31 10:47:31 +08:00
parent 3d29f8c5e3
commit 0961002352
9 changed files with 368 additions and 155 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1054
ShellPkg/Library/UefiShellTftpCommandLib/Tftp.c
View File

File diff suppressed because it is too large Load Diff

97
ShellPkg/Library/UefiShellTftpCommandLib/UefiShellTftpCommandLib.c
View File

@@ -1,97 +0,0 @@
/** @file
Main file for NULL named library for 'tftp' Shell command functions.
Copyright (c) 2010 - 2011, Intel Corporation. All rights reserved. <BR>
Copyright (c) 2015, ARM Ltd. All rights reserved.<BR>
This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
#include "UefiShellTftpCommandLib.h"
CONST CHAR16 gShellTftpFileName[] = L"ShellCommand";
EFI_HANDLE gShellTftpHiiHandle = NULL;
/**
Return the file name of the help text file if not using HII.
@return The string pointer to the file name.
**/
CONST CHAR16*
EFIAPI
ShellCommandGetManFileNameTftp (
VOID
)
{
return gShellTftpFileName;
}
/**
Constructor for the Shell Tftp Command library.
Install the handlers for Tftp UEFI Shell command.
@param ImageHandle The image handle of the process.
@param SystemTable The EFI System Table pointer.
@retval EFI_SUCCESS The Shell command handlers were installed sucessfully.
@retval EFI_UNSUPPORTED The Shell level required was not found.
**/
EFI_STATUS
EFIAPI
ShellTftpCommandLibConstructor (
IN EFI_HANDLE ImageHandle,
IN EFI_SYSTEM_TABLE *SystemTable
)
{
gShellTftpHiiHandle = NULL;
//
// check our bit of the profiles mask
//
if ((PcdGet8 (PcdShellProfileMask) & BIT3) == 0) {
return EFI_SUCCESS;
}
gShellTftpHiiHandle = HiiAddPackages (
&gShellTftpHiiGuid, gImageHandle,
UefiShellTftpCommandLibStrings, NULL
);
if (gShellTftpHiiHandle == NULL) {
return EFI_DEVICE_ERROR;
}
//
// Install our Shell command handler
//
ShellCommandRegisterCommandName (
L"tftp", ShellCommandRunTftp, ShellCommandGetManFileNameTftp, 0,
L"tftp", TRUE , gShellTftpHiiHandle, STRING_TOKEN (STR_GET_HELP_TFTP)
);
return EFI_SUCCESS;
}
/**
Destructor for the library. free any resources.
@param ImageHandle The image handle of the process.
@param SystemTable The EFI System Table pointer.
**/
EFI_STATUS
EFIAPI
ShellTftpCommandLibDestructor (
IN EFI_HANDLE ImageHandle,
IN EFI_SYSTEM_TABLE *SystemTable
)
{
if (gShellTftpHiiHandle != NULL) {
HiiRemovePackages (gShellTftpHiiHandle);
}
return EFI_SUCCESS;
}

61
ShellPkg/Library/UefiShellTftpCommandLib/UefiShellTftpCommandLib.h
View File

@@ -1,61 +0,0 @@
/** @file
header file for NULL named library for 'tftp' Shell command functions.
Copyright (c) 2010 - 2016, Intel Corporation. All rights reserved. <BR>
Copyright (c) 2015, ARM Ltd. All rights reserved.<BR>
This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
#ifndef _UEFI_SHELL_TFTP_COMMAND_LIB_H_
#define _UEFI_SHELL_TFTP_COMMAND_LIB_H_
#include <Uefi.h>
#include <Guid/ShellLibHiiGuid.h>
#include <Protocol/ServiceBinding.h>
#include <Protocol/Mtftp4.h>
#include <Library/BaseLib.h>
#include <Library/BaseMemoryLib.h>
#include <Library/DebugLib.h>
#include <Library/MemoryAllocationLib.h>
#include <Library/ShellCommandLib.h>
#include <Library/ShellLib.h>
#include <Library/UefiLib.h>
#include <Library/UefiRuntimeServicesTableLib.h>
#include <Library/UefiBootServicesTableLib.h>
#include <Library/HiiLib.h>
#include <Library/NetLib.h>
#include <Library/PrintLib.h>
extern EFI_HANDLE gShellTftpHiiHandle;
typedef struct {
UINTN FileSize;
UINTN DownloadedNbOfBytes;
UINTN LastReportedNbOfBytes;
} DOWNLOAD_CONTEXT;
/**
Function for 'tftp' command.
@param[in] ImageHandle Handle to the Image (NULL if Internal).
@param[in] SystemTable Pointer to the System Table (NULL if Internal).
**/
SHELL_STATUS
EFIAPI
ShellCommandRunTftp (
IN EFI_HANDLE ImageHandle,
IN EFI_SYSTEM_TABLE *SystemTable
);
#endif /* _UEFI_SHELL_TFTP_COMMAND_LIB_H_ */

61
ShellPkg/Library/UefiShellTftpCommandLib/UefiShellTftpCommandLib.inf
View File

@@ -1,61 +0,0 @@
## @file
# Provides Shell 'tftp' command functions
#
# Copyright (c) 2010 - 2015, Intel Corporation. All rights reserved. <BR>
# Copyright (c) 2015, ARM Ltd. All rights reserved.<BR>
#
# This program and the accompanying materials
# are licensed and made available under the terms and conditions of the BSD License
# which accompanies this distribution. The full text of the license may be found at
# http://opensource.org/licenses/bsd-license.php
# THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
# WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
#
#
##
[Defines]
INF_VERSION = 0x00010006
BASE_NAME = UefiShellTftpCommandLib
FILE_GUID = D2B61A25-9835-4E5D-906A-15615E1FF668
MODULE_TYPE = UEFI_APPLICATION
VERSION_STRING = 1.0
LIBRARY_CLASS = NULL|UEFI_APPLICATION UEFI_DRIVER
CONSTRUCTOR = ShellTftpCommandLibConstructor
DESTRUCTOR = ShellTftpCommandLibDestructor
[Sources.common]
UefiShellTftpCommandLib.uni
UefiShellTftpCommandLib.c
UefiShellTftpCommandLib.h
Tftp.c
[Packages]
MdePkg/MdePkg.dec
ShellPkg/ShellPkg.dec
MdeModulePkg/MdeModulePkg.dec
[LibraryClasses]
MemoryAllocationLib
BaseLib
BaseMemoryLib
DebugLib
ShellCommandLib
ShellLib
UefiLib
UefiRuntimeServicesTableLib
UefiBootServicesTableLib
PcdLib
HiiLib
FileHandleLib
NetLib
[Pcd]
gEfiShellPkgTokenSpaceGuid.PcdShellProfileMask ## CONSUMES
[Protocols]
gEfiManagedNetworkServiceBindingProtocolGuid ## CONSUMES
gEfiMtftp4ServiceBindingProtocolGuid ## CONSUMES
[Guids]
gShellTftpHiiGuid ## CONSUMES ## HII

97
ShellPkg/Library/UefiShellTftpCommandLib/UefiShellTftpCommandLib.uni
View File

@@ -1,97 +0,0 @@
// /**
//
// (C) Copyright 2015-2016 Hewlett Packard Enterprise Development LP<BR>
// Copyright (c) 2010 - 2016, Intel Corporation. All rights reserved. <BR>
// This program and the accompanying materials
// are licensed and made available under the terms and conditions of the BSD License
// which accompanies this distribution. The full text of the license may be found at
// http://opensource.org/licenses/bsd-license.php
//
// THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
// WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
//
// Module Name:
//
// UefiShellTftpCommandLib.uni
//
// Abstract:
//
// String definitions for UEFI Shell TFTP command
//
//
// **/
/=#
#langdef en-US "english"
#string STR_GEN_TOO_MANY #language en-US "%H%s%N: Too many arguments\r\n"
#string STR_GEN_TOO_FEW #language en-US "%H%s%N: Too few arguments\r\n"
#string STR_GEN_PARAM_INV #language en-US "%H%s%N: Invalid argument - '%H%s%N'\r\n"
#string STR_GEN_PROBLEM #language en-US "%H%s%N: Unknown flag - '%H%s%N'\r\n"
#string STR_GEN_FILE_OPEN_FAIL #language en-US "%H%s%N: Cannot open file - '%H%s%N'\r\n"
#string STR_GEN_CRLF #language en-US "\r\n"
#string STR_TFTP_ERR_NO_NIC #language en-US "No network interface card found.\r\n"
#string STR_TFTP_ERR_NIC_NAME #language en-US "Failed to get the name of the network interface card number %d - %r\r\n"
#string STR_TFTP_ERR_OPEN_PROTOCOL #language en-US "Unable to open MTFTP4 protocol on '%H%s%N' - %r\r\n"
#string STR_TFTP_ERR_CONFIGURE #language en-US "Unable to configure MTFTP4 protocol on '%H%s%N' - %r\r\n"
#string STR_TFTP_ERR_FILE_SIZE #language en-US "Unable to get the size of the file '%H%s%N' on '%H%s%N' - %r\r\n"
#string STR_TFTP_ERR_DOWNLOAD #language en-US "Unable to download the file '%H%s%N' on '%H%s%N' - %r\r\n"
#string STR_TFTP_ERR_WRITE #language en-US "Unable to write into file '%H%s%N' - %r\r\n"
#string STR_TFTP_ERR_NIC_NOT_FOUND #language en-US "Network Interface Card '%H%s%N' not found.\r\n"
#string STR_TFTP_DOWNLOADING #language en-US "Downloading the file '%H%s%N'\r\n"
#string STR_TFTP_STRING #language en-US "%s"
#string STR_GET_HELP_TFTP #language en-US ""
".TH tftp 0 "Download a file from TFTP server."\r\n"
".SH NAME\r\n"
"Download a file from TFTP server.\r\n"
".SH SYNOPSIS\r\n"
" \r\n"
"TFTP [-i interface] [-l <port>] [-r <port>] [-c <retry count>] [-t <timeout>]\r\n"
" [-s <block size>] host remotefilepath [localfilepath]\r\n"
".SH OPTIONS\r\n"
" \r\n"
" -i interface - Specifies an adapter name, i.e., eth0.\r\n"
" -l port - Specifies the local port number. Default value is 0\r\n"
" and the port number is automatically assigned.\r\n"
" -r port - Specifies the remote port number. Default value is 69.\r\n"
" -c <retry count> - The number of times to transmit request packets and\r\n"
" wait for a response. The default value is 6.\r\n"
" -t <timeout> - The number of seconds to wait for a response after\r\n"
" sending a request packet. Default value is 4s.\r\n"
" -s <block size> - Specifies the TFTP blksize option as defined in RFC 2348.\r\n"
" Valid range is between 8 and 65464, default value is 512.\r\n"
" host - Specify TFTP Server IPv4 address.\r\n"
" remotefilepath - TFTP server file path to download the file.\r\n"
" localfilepath - Local destination file path.\r\n"
".SH DESCRIPTION\r\n"
" \r\n"
"NOTES:\r\n"
" 1. The TFTP command allows to get the file specified by its 'remotefilepath'\r\n"
" path from the TFTP server specified by its 'host' IPv4 address. If the\r\n"
" optional 'localfilepath' parameter is provided, the downloaded file is\r\n"
" stored locally using the provided file path. If the local file path is\r\n"
" not specified, the file is stored in the current directory using the file\r\n"
" server's name.\r\n"
" 2. Before using the TFTP command, the network interface intended to be\r\n"
" used to retrieve the file must be configured. This configuration may be\r\n"
" done by means of the 'ifconfig' command.\r\n"
" 3. If a network interface is defined with the '-i' option then only this\r\n"
" interface will be used to retrieve the remote file. Otherwise, all network\r\n"
" interfaces are tried in the order they have been discovered during the\r\n"
" DXE phase.\r\n"
".SH EXAMPLES\r\n"
" \r\n"
"EXAMPLES:\r\n"
" * To get the file "dir1/file1.dat" from the TFTP server 192.168.1.1 and\r\n"
" store it as file2.dat in the current directory :\r\n"
" fs0:\> tftp 192.168.1.1 dir1/file1.dat file2.dat\r\n"
".SH RETURNVALUES\r\n"
" \r\n"
"RETURN VALUES:\r\n"
" SHELL_SUCCESS The action was completed as requested.\r\n"
" SHELL_INVALID_PARAMETER One of the passed-in parameters was incorrectly\r\n"
" formatted or its value was out of bounds.\r\n"