ArmPlatformPkg/ArmShellCmdRunAxf: Added 'runaxf' cmd to shell

[mirror_edk2.git] / ArmPlatformPkg / Include / Library / ArmShellCmdLib.h

diff --git a/ArmPlatformPkg/Include/Library/ArmShellCmdLib.h b/ArmPlatformPkg/Include/Library/ArmShellCmdLib.h
new file mode 100644 (file)
index 0000000..eb31cd4
--- /dev/null
+++ b/ArmPlatformPkg/Include/Library/ArmShellCmdLib.h
@@ -0,0 +1,57 @@
+/** @file\r
+*\r
+*  Definitions for the Dynamic Shell command library\r
+*\r
+*  Copyright (C) 2014, ARM Ltd\r
+*\r
+*  This program and the accompanying materials are licensed and made available\r
+*  under the terms and conditions of the BSD License which accompanies this\r
+*  distribution. The full text of the license may be found at\r
+*  http://opensource.org/licenses/bsd-license.php\r
+*\r
+*  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT\r
+*  WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
+*\r
+**/\r
+\r
+#ifndef _ARM_SHELL_CMD_LIB_H_\r
+#define _ARM_SHELL_CMD_LIB_H_\r
+\r
+/**\r
+\r
+  Initialize and Install EFI_SHELL_DYNAMIC_COMMAND_PROTOCOL for RunAxf command.\r
+\r
+  @param[in] ImageHandle        Handle the protocol should be attached to.\r
+\r
+  @retval EFI_SUCCESS           The command has been installed successfully.\r
+\r
+  @retval EFI_UNSUPPORTED       Help for the command failed to initialise.\r
+\r
+  @return                       Status code returned by InstallProtocolInterface\r
+                                Boot Service function.\r
+\r
+**/\r
+EFI_STATUS\r
+ShellDynCmdRunAxfInstall (\r
+  IN EFI_HANDLE             ImageHandle\r
+  );\r
+\r
+/**\r
+\r
+  Uninstall the RunAxf Command\r
+\r
+  @param[in] ImageHandle  Handle of the device where the protocol should have\r
+                          been installed.\r
+\r
+  @retval EFI_SUCCESS     The device has been un-initialized successfully.\r
+\r
+  @return                 Status code returned by UninstallProtocolInterface\r
+                          Boot Service function.\r
+\r
+**/\r
+EFI_STATUS\r
+ShellDynCmdRunAxfUninstall (\r
+  IN EFI_HANDLE             ImageHandle\r
+  );\r
+\r
+#endif // _ARM_SHELL_CMD_LIB_H_\r