ShellPkg/Library/UefiShellDriver1CommandsLib/UefiShellDriver1CommandsLib.h

   1 /** @file
   2   Main file for NULL named library for Profile1 shell command functions.
   3
   4   Copyright (c) 2010 - 2016, Intel Corporation. All rights reserved.<BR>
   5   This program and the accompanying materials
   6   are licensed and made available under the terms and conditions of the BSD License
   7   which accompanies this distribution.  The full text of the license may be found at
   8   http://opensource.org/licenses/bsd-license.php
   9
  10   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12
  13 **/
  14
  15 #ifndef _UEFI_SHELL_DRIVER1_COMMANDS_LIB_H_
  16 #define _UEFI_SHELL_DRIVER1_COMMANDS_LIB_H_
  17
  18 #include <Uefi.h>
  19
  20 #include <Guid/GlobalVariable.h>
  21 #include <Guid/ConsoleInDevice.h>
  22 #include <Guid/ConsoleOutDevice.h>
  23 #include <Guid/ShellLibHiiGuid.h>
  24
  25 #include <IndustryStandard/Pci.h>
  26
  27 #include <Pi/PiFirmwareVolume.h>
  28 #include <Pi/PiFirmwareFile.h>
  29 #include <Protocol/FirmwareVolume2.h>
  30
  31 #include <Protocol/Shell.h>
  32 #include <Protocol/ShellParameters.h>
  33 #include <Protocol/DevicePath.h>
  34 #include <Protocol/LoadedImage.h>
  35 #include <Protocol/UnicodeCollation.h>
  36 #include <Protocol/DriverDiagnostics2.h>
  37 #include <Protocol/DriverDiagnostics.h>
  38 #include <Protocol/PlatformDriverOverride.h>
  39 #include <Protocol/BusSpecificDriverOverride.h>
  40 #include <Protocol/PlatformToDriverConfiguration.h>
  41 #include <Protocol/DriverSupportedEfiVersion.h>
  42 #include <Protocol/DriverFamilyOverride.h>
  43 #include <Protocol/DriverHealth.h>
  44 #include <Protocol/PciIo.h>
  45 #include <Protocol/PciRootBridgeIo.h>
  46
  47 #include <Library/BaseLib.h>
  48 #include <Library/BaseMemoryLib.h>
  49 #include <Library/DebugLib.h>
  50 #include <Library/MemoryAllocationLib.h>
  51 #include <Library/PcdLib.h>
  52 #include <Library/ShellCommandLib.h>
  53 #include <Library/ShellLib.h>
  54 #include <Library/SortLib.h>
  55 #include <Library/UefiLib.h>
  56 #include <Library/UefiRuntimeServicesTableLib.h>
  57 #include <Library/UefiBootServicesTableLib.h>
  58 #include <Library/HiiLib.h>
  59 #include <Library/FileHandleLib.h>
  60 #include <Library/DevicePathLib.h>
  61 #include <Library/PrintLib.h>
  62 #include <Library/HandleParsingLib.h>
  63 #include <Library/PeCoffGetEntryPointLib.h>
  64 #include <Library/HandleParsingLib.h>
  65
  66
  67 extern        EFI_HANDLE                        gShellDriver1HiiHandle;
  68 extern        BOOLEAN                           gInReconnect;
  69
  70 /**
  71   Function for 'connect' command.
  72
  73   @param[in] ImageHandle  Handle to the Image (NULL if Internal).
  74   @param[in] SystemTable  Pointer to the System Table (NULL if Internal).
  75 **/
  76 SHELL_STATUS
  77 EFIAPI
  78 ShellCommandRunConnect (
  79   IN EFI_HANDLE        ImageHandle,
  80   IN EFI_SYSTEM_TABLE  *SystemTable
  81   );
  82
  83 /**
  84   Function for 'devices' command.
  85
  86   @param[in] ImageHandle  Handle to the Image (NULL if Internal).
  87   @param[in] SystemTable  Pointer to the System Table (NULL if Internal).
  88 **/
  89 SHELL_STATUS
  90 EFIAPI
  91 ShellCommandRunDevices (
  92   IN EFI_HANDLE        ImageHandle,
  93   IN EFI_SYSTEM_TABLE  *SystemTable
  94   );
  95
  96 /**
  97   Function for 'openinfo' command.
  98
  99   @param[in] ImageHandle  Handle to the Image (NULL if Internal).
 100   @param[in] SystemTable  Pointer to the System Table (NULL if Internal).
 101 **/
 102 SHELL_STATUS
 103 EFIAPI
 104 ShellCommandRunOpenInfo (
 105   IN EFI_HANDLE        ImageHandle,
 106   IN EFI_SYSTEM_TABLE  *SystemTable
 107   );
 108
 109 /**
 110   Function for 'devtree' command.
 111
 112   @param[in] ImageHandle  Handle to the Image (NULL if Internal).
 113   @param[in] SystemTable  Pointer to the System Table (NULL if Internal).
 114 **/
 115 SHELL_STATUS
 116 EFIAPI
 117 ShellCommandRunDevTree (
 118   IN EFI_HANDLE        ImageHandle,
 119   IN EFI_SYSTEM_TABLE  *SystemTable
 120   );
 121
 122 /**
 123   Function for 'dh' command.
 124
 125   @param[in] ImageHandle  Handle to the Image (NULL if Internal).
 126   @param[in] SystemTable  Pointer to the System Table (NULL if Internal).
 127 **/
 128 SHELL_STATUS
 129 EFIAPI
 130 ShellCommandRunDh (
 131   IN EFI_HANDLE        ImageHandle,
 132   IN EFI_SYSTEM_TABLE  *SystemTable
 133   );
 134
 135 /**
 136   Function for 'disconnect' command.
 137
 138   @param[in] ImageHandle  Handle to the Image (NULL if Internal).
 139   @param[in] SystemTable  Pointer to the System Table (NULL if Internal).
 140 **/
 141 SHELL_STATUS
 142 EFIAPI
 143 ShellCommandRunDisconnect (
 144   IN EFI_HANDLE        ImageHandle,
 145   IN EFI_SYSTEM_TABLE  *SystemTable
 146   );
 147
 148 /**
 149   Function for 'drivers' command.
 150
 151   @param[in] ImageHandle  Handle to the Image (NULL if Internal).
 152   @param[in] SystemTable  Pointer to the System Table (NULL if Internal).
 153 **/
 154 SHELL_STATUS
 155 EFIAPI
 156 ShellCommandRunDrivers (
 157   IN EFI_HANDLE        ImageHandle,
 158   IN EFI_SYSTEM_TABLE  *SystemTable
 159   );
 160
 161 /**
 162   Function for 'drvcfg' command.
 163
 164   @param[in] ImageHandle  Handle to the Image (NULL if Internal).
 165   @param[in] SystemTable  Pointer to the System Table (NULL if Internal).
 166 **/
 167 SHELL_STATUS
 168 EFIAPI
 169 ShellCommandRunDrvCfg (
 170   IN EFI_HANDLE        ImageHandle,
 171   IN EFI_SYSTEM_TABLE  *SystemTable
 172   );
 173
 174 /**
 175   Function for 'drvdiag' command.
 176
 177   @param[in] ImageHandle  Handle to the Image (NULL if Internal).
 178   @param[in] SystemTable  Pointer to the System Table (NULL if Internal).
 179 **/
 180 SHELL_STATUS
 181 EFIAPI
 182 ShellCommandRunDrvDiag (
 183   IN EFI_HANDLE        ImageHandle,
 184   IN EFI_SYSTEM_TABLE  *SystemTable
 185   );
 186
 187 /**
 188   Function for 'reconnect' command.
 189
 190   @param[in] ImageHandle  Handle to the Image (NULL if Internal).
 191   @param[in] SystemTable  Pointer to the System Table (NULL if Internal).
 192 **/
 193 SHELL_STATUS
 194 EFIAPI
 195 ShellCommandRunReconnect (
 196   IN EFI_HANDLE        ImageHandle,
 197   IN EFI_SYSTEM_TABLE  *SystemTable
 198   );
 199
 200 /**
 201   Function for 'unload' command.
 202
 203   @param[in] ImageHandle  Handle to the Image (NULL if Internal).
 204   @param[in] SystemTable  Pointer to the System Table (NULL if Internal).
 205 **/
 206 SHELL_STATUS
 207 EFIAPI
 208 ShellCommandRunUnload (
 209   IN EFI_HANDLE        ImageHandle,
 210   IN EFI_SYSTEM_TABLE  *SystemTable
 211   );
 212
 213 /**
 214   Do a connect from an EFI variable via it's key name.
 215
 216   @param[in] Key      The name of the EFI Variable.
 217
 218   @retval EFI_SUCCESS   The operation was successful.
 219 **/
 220 EFI_STATUS
 221 ShellConnectFromDevPaths (
 222   IN CONST CHAR16 *Key
 223   );
 224
 225
 226
 227 #endif
 228