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