ArmPlatformPkg/Include/Library/ArmShellCmdLib.h

   1 /** @file
   2 *
   3 *  Definitions for the Dynamic Shell command library
   4 *
   5 *  Copyright (C) 2014, ARM Ltd
   6 *
   7 *  This program and the accompanying materials are licensed and made available
   8 *  under the terms and conditions of the BSD License which accompanies this
   9 *  distribution. The full text of the license may be found at
  10 *  http://opensource.org/licenses/bsd-license.php
  11 *
  12 *  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT
  13 *  WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  14 *
  15 **/
  16
  17 #ifndef _ARM_SHELL_CMD_LIB_H_
  18 #define _ARM_SHELL_CMD_LIB_H_
  19
  20 /**
  21
  22   Initialize and Install EFI_SHELL_DYNAMIC_COMMAND_PROTOCOL for RunAxf command.
  23
  24   @param[in] ImageHandle        Handle the protocol should be attached to.
  25
  26   @retval EFI_SUCCESS           The command has been installed successfully.
  27
  28   @retval EFI_UNSUPPORTED       Help for the command failed to initialise.
  29
  30   @return                       Status code returned by InstallProtocolInterface
  31                                 Boot Service function.
  32
  33 **/
  34 EFI_STATUS
  35 ShellDynCmdRunAxfInstall (
  36   IN EFI_HANDLE             ImageHandle
  37   );
  38
  39 /**
  40
  41   Uninstall the RunAxf Command
  42
  43   @param[in] ImageHandle  Handle of the device where the protocol should have
  44                           been installed.
  45
  46   @retval EFI_SUCCESS     The device has been un-initialized successfully.
  47
  48   @return                 Status code returned by UninstallProtocolInterface
  49                           Boot Service function.
  50
  51 **/
  52 EFI_STATUS
  53 ShellDynCmdRunAxfUninstall (
  54   IN EFI_HANDLE             ImageHandle
  55   );
  56
  57 #endif // _ARM_SHELL_CMD_LIB_H_