EfiMpServiceProtocolDynamicCmdUnitTest.c File Reference

#include <Library/UefiBootServicesTableLib.h>
#include <Protocol/ShellDynamicCommand.h>
#include "EfiMpServicesUnitTestCommom.h"

Go to the source code of this file.

Functions
EFI_STATUS EFIAPI	EfiMpServiceProtocolUnitTest (VOID)
SHELL_STATUS EFIAPI	MpProtocolUnitTestCommandHandler (IN EFI_SHELL_DYNAMIC_COMMAND_PROTOCOL *This, IN EFI_SYSTEM_TABLE *SystemTable, IN EFI_SHELL_PARAMETERS_PROTOCOL *ShellParameters, IN EFI_SHELL_PROTOCOL *Shell)
CHAR16 *EFIAPI	MpProtocolUnitTestCommandGetHelp (IN EFI_SHELL_DYNAMIC_COMMAND_PROTOCOL *This, IN CONST CHAR8 *Language)
EFI_STATUS EFIAPI	MpProtocolUnitTestCommandInitialize (IN EFI_HANDLE ImageHandle, IN EFI_SYSTEM_TABLE *SystemTable)
EFI_STATUS EFIAPI	MpProtocolUnitTestUnload (IN EFI_HANDLE ImageHandle)

Variables
CHAR16 *	mMpProtocolUnitTestCommandHelp = L".TH MpProtocolUnitTest 0\r\n.SH NAME\r\nDisplay unit test results of EFI MP services protocol.\r\n"
EFI_SHELL_DYNAMIC_COMMAND_PROTOCOL	mMpProtocolUnitTestDynamicCommand

Detailed Description

Produce "MpProtocolUnitTest" shell dynamic command.

Copyright (c) 2022, Intel Corporation. All rights reserved.

SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file EfiMpServiceProtocolDynamicCmdUnitTest.c.

Function Documentation

EfiMpServiceProtocolUnitTest()

EFI_STATUS EFIAPI EfiMpServiceProtocolUnitTest

(

VOID

)

Initialize the unit test framework, suite and unit tests for the EfiMpServiceProtocol and run the unit tests.

Return values

EFI_SUCCESS	Initialize the unit test framework, suite, unit tests and run the unit tests successfully.
Others	Initialize the unit test framework, suite, unit tests or run the unit tests unsuccessfully.

Definition at line 198 of file EfiMpServiceProtocolUnitTest.c.

MpProtocolUnitTestCommandGetHelp()

CHAR16 *EFIAPI MpProtocolUnitTestCommandGetHelp	(	IN EFI_SHELL_DYNAMIC_COMMAND_PROTOCOL *	This,
		IN CONST CHAR8 *	Language
	)

This is the command help handler function pointer callback type. This function is responsible for displaying help information for the associated command.

Parameters

[in]	This	The instance of the EFI_SHELL_DYNAMIC_COMMAND_PROTOCOL.
[in]	Language	The pointer to the language string to use.

Returns

string Pool allocated help string, must be freed by caller

Definition at line 59 of file EfiMpServiceProtocolDynamicCmdUnitTest.c.

MpProtocolUnitTestCommandHandler()

SHELL_STATUS EFIAPI MpProtocolUnitTestCommandHandler	(	IN EFI_SHELL_DYNAMIC_COMMAND_PROTOCOL *	This,
		IN EFI_SYSTEM_TABLE *	SystemTable,
		IN EFI_SHELL_PARAMETERS_PROTOCOL *	ShellParameters,
		IN EFI_SHELL_PROTOCOL *	Shell
	)

This is the shell command handler function pointer callback type. This function handles the command when it is invoked in the shell.

Parameters

[in]	This	The instance of the EFI_SHELL_DYNAMIC_COMMAND_PROTOCOL.
[in]	SystemTable	The pointer to the system table.
[in]	ShellParameters	The parameters associated with the command.
[in]	Shell	The instance of the shell protocol used in the context of processing this command.

Returns

EFI_SUCCESS the operation was successful

other the operation failed.

Definition at line 37 of file EfiMpServiceProtocolDynamicCmdUnitTest.c.

MpProtocolUnitTestCommandInitialize()

EFI_STATUS EFIAPI MpProtocolUnitTestCommandInitialize	(	IN EFI_HANDLE	ImageHandle,
		IN EFI_SYSTEM_TABLE *	SystemTable
	)

Entry point of MpProtocolUnitTest Dynamic Command.

Produce the DynamicCommand protocol to handle "MpProtocolUnitTest" command.

Parameters

ImageHandle	The image handle of the process.
SystemTable	The EFI System Table pointer.

Return values

EFI_SUCCESS	Tftp command is executed successfully.
EFI_ABORTED	HII package was failed to initialize.
others	Other errors when executing MpProtocolUnitTest command.

Definition at line 87 of file EfiMpServiceProtocolDynamicCmdUnitTest.c.

MpProtocolUnitTestUnload()

EFI_STATUS EFIAPI MpProtocolUnitTestUnload

(

IN EFI_HANDLE

ImageHandle

)

Driver unload handler.

Parameters

ImageHandle

The image handle of the process.

Return values

EFI_SUCCESS	The image is unloaded.
Others	Failed to unload the image.

Definition at line 115 of file EfiMpServiceProtocolDynamicCmdUnitTest.c.

Variable Documentation

mMpProtocolUnitTestCommandHelp

CHAR16* mMpProtocolUnitTestCommandHelp = L".TH MpProtocolUnitTest 0\r\n.SH NAME\r\nDisplay unit test results of EFI MP services protocol.\r\n"

Definition at line 14 of file EfiMpServiceProtocolDynamicCmdUnitTest.c.

mMpProtocolUnitTestDynamicCommand

EFI_SHELL_DYNAMIC_COMMAND_PROTOCOL mMpProtocolUnitTestDynamicCommand

Initial value:

= {
  L"MpProtocolUnitTest",
  MpProtocolUnitTestCommandHandler,
  MpProtocolUnitTestCommandGetHelp
}

Definition at line 67 of file EfiMpServiceProtocolDynamicCmdUnitTest.c.