]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdeModulePkg/Universal/EbcDxe/EbcDebugger/EdbCommand.h
UefiCpuPkg: Move AsmRelocateApLoopStart from Mpfuncs.nasm to AmdSev.nasm
[mirror_edk2.git] / MdeModulePkg / Universal / EbcDxe / EbcDebugger / EdbCommand.h
index 7acf4deb86751191c7761700b00bf51fd7722452..071d5c59b7625b42273614dde646a652bd45a399 100644 (file)
@@ -1,22 +1,10 @@
-/*++\r
+/** @file\r
 \r
-Copyright (c) 2007, Intel Corporation\r
-All rights reserved. This program and the accompanying materials\r
-are licensed and made available under the terms and conditions of the BSD License\r
-which accompanies this distribution.  The full text of the license may be found at\r
-http://opensource.org/licenses/bsd-license.php\r
+Copyright (c) 2007, Intel Corporation. All rights reserved.<BR>\r
+SPDX-License-Identifier: BSD-2-Clause-Patent\r
 \r
-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
-WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
 \r
-Module Name:\r
-\r
-  EdbCommand.h\r
-\r
-Abstract:\r
-\r
-\r
---*/\r
+**/\r
 \r
 #ifndef _EFI_EDB_COMMAND_H_\r
 #define _EFI_EDB_COMMAND_H_\r
@@ -29,15 +17,36 @@ typedef enum {
   EdbWidthMax\r
 } EDB_DATA_WIDTH;\r
 \r
+/**\r
+\r
+  Find the command according to name.\r
+\r
+  @param  CommandName   - Command Name\r
+  @param  CommandArg    - Command Argument\r
+\r
+  @return Not NULL        - The DebuggerCommand is found successfully\r
+  @return NULL            - not found\r
+\r
+**/\r
 EFI_DEBUGGER_COMMAND\r
 MatchDebuggerCommand (\r
-  IN CHAR16    *CommandName,\r
-  IN CHAR16    **CommandArg\r
+  IN CHAR16  *CommandName,\r
+  IN CHAR16  **CommandArg\r
   );\r
 \r
+/**\r
+\r
+  Find the command name according to the function key.\r
+\r
+  @param  CommandKey    - Command Function Key\r
+\r
+  @return Not NULL        - The DebuggerName is found successfully\r
+  @return NULL            - not found\r
+\r
+**/\r
 CHAR16 *\r
 GetCommandNameByKey (\r
-  IN EFI_INPUT_KEY CommandKey\r
+  IN EFI_INPUT_KEY  CommandKey\r
   );\r
 \r
 //\r