mirror of
https://github.com/acidanthera/audk.git
synced 2025-04-08 17:05:09 +02:00
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>
85 lines
2.4 KiB
C
85 lines
2.4 KiB
C
/** @file
|
|
Main file for NULL named library for network1 shell command functions.
|
|
|
|
Copyright (c) 2010 - 2011, Intel Corporation. All rights reserved. <BR>
|
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
|
|
|
**/
|
|
#include "UefiShellNetwork1CommandsLib.h"
|
|
|
|
CONST CHAR16 gShellNetwork1FileName[] = L"ShellCommands";
|
|
EFI_HII_HANDLE gShellNetwork1HiiHandle = 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
|
|
ShellCommandGetManFileNameNetwork1 (
|
|
VOID
|
|
)
|
|
{
|
|
return (gShellNetwork1FileName);
|
|
}
|
|
|
|
/**
|
|
Constructor for the Shell Network1 Commands library.
|
|
|
|
Install the handlers for Network1 UEFI Shell 2.0 profile commands.
|
|
|
|
@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
|
|
ShellNetwork1CommandsLibConstructor (
|
|
IN EFI_HANDLE ImageHandle,
|
|
IN EFI_SYSTEM_TABLE *SystemTable
|
|
)
|
|
{
|
|
gShellNetwork1HiiHandle = NULL;
|
|
|
|
//
|
|
// check our bit of the profiles mask
|
|
//
|
|
if ((PcdGet8(PcdShellProfileMask) & BIT3) == 0) {
|
|
return (EFI_SUCCESS);
|
|
}
|
|
|
|
gShellNetwork1HiiHandle = HiiAddPackages (&gShellNetwork1HiiGuid, gImageHandle, UefiShellNetwork1CommandsLibStrings, NULL);
|
|
if (gShellNetwork1HiiHandle == NULL) {
|
|
return (EFI_DEVICE_ERROR);
|
|
}
|
|
//
|
|
// install our shell command handlers
|
|
//
|
|
ShellCommandRegisterCommandName(L"ping", ShellCommandRunPing , ShellCommandGetManFileNameNetwork1, 0, L"network1", TRUE , gShellNetwork1HiiHandle, STRING_TOKEN(STR_GET_HELP_PING));
|
|
ShellCommandRegisterCommandName(L"ifconfig",ShellCommandRunIfconfig , ShellCommandGetManFileNameNetwork1, 0, L"network1", TRUE , gShellNetwork1HiiHandle, STRING_TOKEN(STR_GET_HELP_IFCONFIG));
|
|
|
|
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
|
|
ShellNetwork1CommandsLibDestructor (
|
|
IN EFI_HANDLE ImageHandle,
|
|
IN EFI_SYSTEM_TABLE *SystemTable
|
|
)
|
|
{
|
|
if (gShellNetwork1HiiHandle != NULL) {
|
|
HiiRemovePackages(gShellNetwork1HiiHandle);
|
|
}
|
|
return (EFI_SUCCESS);
|
|
}
|