2015-07-15 17:39:53 +02:00
|
|
|
/** @file
|
2017-10-31 03:47:31 +01:00
|
|
|
Header file for 'tftp' command functions.
|
2015-07-15 17:39:53 +02:00
|
|
|
|
2017-10-31 03:47:31 +01:00
|
|
|
Copyright (c) 2010 - 2017, Intel Corporation. All rights reserved. <BR>
|
2015-07-15 17:39:53 +02:00
|
|
|
Copyright (c) 2015, ARM Ltd. All rights reserved.<BR>
|
|
|
|
|
|
2019-04-04 01:07:06 +02:00
|
|
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
2015-07-15 17:39:53 +02:00
|
|
|
|
|
|
|
|
**/
|
|
|
|
|
|
2017-10-31 03:47:31 +01:00
|
|
|
#ifndef _TFTP_H_
|
|
|
|
|
#define _TFTP_H_
|
2015-07-15 17:39:53 +02:00
|
|
|
|
|
|
|
|
#include <Uefi.h>
|
|
|
|
|
|
2017-10-31 03:47:31 +01:00
|
|
|
#include <Protocol/HiiPackageList.h>
|
2015-07-15 17:39:53 +02:00
|
|
|
#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/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>
|
2017-10-31 03:47:31 +01:00
|
|
|
#include <Library/UefiHiiServicesLib.h>
|
2015-07-15 17:39:53 +02:00
|
|
|
|
ShellPkg: stop using EFI_HANDLE in place of EFI_HII_HANDLE
The UefiShell*CommandsLib instances have constructor functions that do
something like:
gHiiHandle = HiiAddPackages (...);
...
ShellCommandRegisterCommandName (..., gHiiHandle, ...);
and destructor functions that implement the following pattern:
HiiRemovePackages (gHiiHandle);
The -- semantic, not functional -- problem is that "gHiiHandle" is
declared with type EFI_HANDLE, and not EFI_HII_HANDLE, in all of these
library instances, even though HiiAddPackages() correctly returns
EFI_HII_HANDLE, and HiiRemovePackages() takes EFI_HII_HANDLE.
Once we fix the type of "gHiiHandle", it causes sort of a butterfly
effect, because it is passed around widely. Track down and update all of
those locations.
The DynamicCommand lib instances use a similar pattern, so they are
affected too.
NOTE: in practice, this patch is a no-op, as both EFI_HII_HANDLE and
EFI_HANDLE are typedefs to (VOID*). However, we shouldn't use EFI_HANDLE
where semantically EFI_HII_HANDLE is passed around.
Cc: Jaben Carsey <jaben.carsey@intel.com>
Cc: Ray Ni <ray.ni@intel.com>
Cc: Zhichao Gao <zhichao.gao@intel.com>
Signed-off-by: Laszlo Ersek <lersek@redhat.com>
Reviewed-by: Philippe Mathieu-Daude <philmd@redhat.com>
Reviewed-by: Zhichao Gao <zhichao.gao@intel.com>
2019-09-06 23:15:42 +02:00
|
|
|
extern EFI_HII_HANDLE mTftpHiiHandle;
|
2015-07-15 17:39:53 +02:00
|
|
|
|
|
|
|
|
typedef struct {
|
2015-09-24 22:44:59 +02:00
|
|
|
UINTN FileSize;
|
|
|
|
|
UINTN DownloadedNbOfBytes;
|
|
|
|
|
UINTN LastReportedNbOfBytes;
|
2015-07-15 17:39:53 +02:00
|
|
|
} DOWNLOAD_CONTEXT;
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
Function for 'tftp' command.
|
|
|
|
|
|
2017-10-31 03:47:31 +01:00
|
|
|
@param[in] ImageHandle The image handle.
|
|
|
|
|
@param[in] SystemTable The system table.
|
|
|
|
|
|
|
|
|
|
@retval SHELL_SUCCESS Command completed successfully.
|
|
|
|
|
@retval SHELL_INVALID_PARAMETER Command usage error.
|
|
|
|
|
@retval SHELL_ABORTED The user aborts the operation.
|
|
|
|
|
@retval value Unknown error.
|
2015-07-15 17:39:53 +02:00
|
|
|
**/
|
|
|
|
|
SHELL_STATUS
|
2017-10-31 03:47:31 +01:00
|
|
|
RunTftp (
|
2015-07-15 17:39:53 +02:00
|
|
|
IN EFI_HANDLE ImageHandle,
|
|
|
|
|
IN EFI_SYSTEM_TABLE *SystemTable
|
|
|
|
|
);
|
|
|
|
|
|
2017-10-31 03:47:31 +01:00
|
|
|
/**
|
2020-02-07 02:08:21 +01:00
|
|
|
Retrieve HII package list from ImageHandle and publish to HII database.
|
2017-10-31 03:47:31 +01:00
|
|
|
|
|
|
|
|
@param ImageHandle The image handle of the process.
|
|
|
|
|
|
|
|
|
|
@return HII handle.
|
|
|
|
|
**/
|
ShellPkg: stop using EFI_HANDLE in place of EFI_HII_HANDLE
The UefiShell*CommandsLib instances have constructor functions that do
something like:
gHiiHandle = HiiAddPackages (...);
...
ShellCommandRegisterCommandName (..., gHiiHandle, ...);
and destructor functions that implement the following pattern:
HiiRemovePackages (gHiiHandle);
The -- semantic, not functional -- problem is that "gHiiHandle" is
declared with type EFI_HANDLE, and not EFI_HII_HANDLE, in all of these
library instances, even though HiiAddPackages() correctly returns
EFI_HII_HANDLE, and HiiRemovePackages() takes EFI_HII_HANDLE.
Once we fix the type of "gHiiHandle", it causes sort of a butterfly
effect, because it is passed around widely. Track down and update all of
those locations.
The DynamicCommand lib instances use a similar pattern, so they are
affected too.
NOTE: in practice, this patch is a no-op, as both EFI_HII_HANDLE and
EFI_HANDLE are typedefs to (VOID*). However, we shouldn't use EFI_HANDLE
where semantically EFI_HII_HANDLE is passed around.
Cc: Jaben Carsey <jaben.carsey@intel.com>
Cc: Ray Ni <ray.ni@intel.com>
Cc: Zhichao Gao <zhichao.gao@intel.com>
Signed-off-by: Laszlo Ersek <lersek@redhat.com>
Reviewed-by: Philippe Mathieu-Daude <philmd@redhat.com>
Reviewed-by: Zhichao Gao <zhichao.gao@intel.com>
2019-09-06 23:15:42 +02:00
|
|
|
EFI_HII_HANDLE
|
2017-10-31 03:47:31 +01:00
|
|
|
InitializeHiiPackage (
|
|
|
|
|
EFI_HANDLE ImageHandle
|
|
|
|
|
);
|
|
|
|
|
#endif // _TFTP_H_
|
