ShellPkg/Library/UefiShellDriver1CommandsLib/UefiShellDriver1CommandsLib.h

   1 /** @file
   2   Main file for NULL named library for Profile1 shell command functions.
   3
   4   Copyright (c) 2010 - 2011, 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 #include <ShellBase.h>
  20
  21 #include <Guid/GlobalVariable.h>
  22 #include <Guid/ConsoleInDevice.h>
  23 #include <Guid/ConsoleOutDevice.h>
  24 #include <Guid/ShellLibHiiGuid.h>
  25
  26 #include <Protocol/EfiShell.h>
  27 #include <Protocol/EfiShellParameters.h>
  28 #include <Protocol/DevicePath.h>
  29 #include <Protocol/LoadedImage.h>
  30 #include <Protocol/UnicodeCollation.h>
  31 #include <Protocol/DevicePathToText.h>
  32 #include <Protocol/DriverDiagnostics2.h>
  33 #include <Protocol/DriverDiagnostics.h>
  34 #include <Protocol/PlatformDriverOverride.h>
  35 #include <Protocol/BusSpecificDriverOverride.h>
  36 #include <Protocol/PlatformToDriverConfiguration.h>
  37 #include <Protocol/DriverSupportedEfiVersion.h>
  38 #include <Protocol/DriverFamilyOverride.h>
  39 #include <Protocol/DriverHealth.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
  59
  60 extern        EFI_HANDLE                        gShellDriver1HiiHandle;
  61 extern        BOOLEAN                           gInReconnect;
  62
  63 /**
  64   Function for 'connect' command.
  65
  66   @param[in] ImageHandle  Handle to the Image (NULL if Internal).
  67   @param[in] SystemTable  Pointer to the System Table (NULL if Internal).
  68 **/
  69 SHELL_STATUS
  70 EFIAPI
  71 ShellCommandRunConnect (
  72   IN EFI_HANDLE        ImageHandle,
  73   IN EFI_SYSTEM_TABLE  *SystemTable
  74   );
  75
  76 /**
  77   Function for 'devices' command.
  78
  79   @param[in] ImageHandle  Handle to the Image (NULL if Internal).
  80   @param[in] SystemTable  Pointer to the System Table (NULL if Internal).
  81 **/
  82 SHELL_STATUS
  83 EFIAPI
  84 ShellCommandRunDevices (
  85   IN EFI_HANDLE        ImageHandle,
  86   IN EFI_SYSTEM_TABLE  *SystemTable
  87   );
  88
  89 /**
  90   Function for 'openinfo' command.
  91
  92   @param[in] ImageHandle  Handle to the Image (NULL if Internal).
  93   @param[in] SystemTable  Pointer to the System Table (NULL if Internal).
  94 **/
  95 SHELL_STATUS
  96 EFIAPI
  97 ShellCommandRunOpenInfo (
  98   IN EFI_HANDLE        ImageHandle,
  99   IN EFI_SYSTEM_TABLE  *SystemTable
 100   );
 101
 102 /**
 103   Function for 'devtree' command.
 104
 105   @param[in] ImageHandle  Handle to the Image (NULL if Internal).
 106   @param[in] SystemTable  Pointer to the System Table (NULL if Internal).
 107 **/
 108 SHELL_STATUS
 109 EFIAPI
 110 ShellCommandRunDevTree (
 111   IN EFI_HANDLE        ImageHandle,
 112   IN EFI_SYSTEM_TABLE  *SystemTable
 113   );
 114
 115 /**
 116   Function for 'dh' command.
 117
 118   @param[in] ImageHandle  Handle to the Image (NULL if Internal).
 119   @param[in] SystemTable  Pointer to the System Table (NULL if Internal).
 120 **/
 121 SHELL_STATUS
 122 EFIAPI
 123 ShellCommandRunDh (
 124   IN EFI_HANDLE        ImageHandle,
 125   IN EFI_SYSTEM_TABLE  *SystemTable
 126   );
 127
 128 /**
 129   Function for 'disconnect' command.
 130
 131   @param[in] ImageHandle  Handle to the Image (NULL if Internal).
 132   @param[in] SystemTable  Pointer to the System Table (NULL if Internal).
 133 **/
 134 SHELL_STATUS
 135 EFIAPI
 136 ShellCommandRunDisconnect (
 137   IN EFI_HANDLE        ImageHandle,
 138   IN EFI_SYSTEM_TABLE  *SystemTable
 139   );
 140
 141 /**
 142   Function for 'drivers' command.
 143
 144   @param[in] ImageHandle  Handle to the Image (NULL if Internal).
 145   @param[in] SystemTable  Pointer to the System Table (NULL if Internal).
 146 **/
 147 SHELL_STATUS
 148 EFIAPI
 149 ShellCommandRunDrivers (
 150   IN EFI_HANDLE        ImageHandle,
 151   IN EFI_SYSTEM_TABLE  *SystemTable
 152   );
 153
 154 /**
 155   Function for 'drvcfg' command.
 156
 157   @param[in] ImageHandle  Handle to the Image (NULL if Internal).
 158   @param[in] SystemTable  Pointer to the System Table (NULL if Internal).
 159 **/
 160 SHELL_STATUS
 161 EFIAPI
 162 ShellCommandRunDrvCfg (
 163   IN EFI_HANDLE        ImageHandle,
 164   IN EFI_SYSTEM_TABLE  *SystemTable
 165   );
 166
 167 /**
 168   Function for 'drvdiag' command.
 169
 170   @param[in] ImageHandle  Handle to the Image (NULL if Internal).
 171   @param[in] SystemTable  Pointer to the System Table (NULL if Internal).
 172 **/
 173 SHELL_STATUS
 174 EFIAPI
 175 ShellCommandRunDrvDiag (
 176   IN EFI_HANDLE        ImageHandle,
 177   IN EFI_SYSTEM_TABLE  *SystemTable
 178   );
 179
 180 /**
 181   Function for 'reconnect' command.
 182
 183   @param[in] ImageHandle  Handle to the Image (NULL if Internal).
 184   @param[in] SystemTable  Pointer to the System Table (NULL if Internal).
 185 **/
 186 SHELL_STATUS
 187 EFIAPI
 188 ShellCommandRunReconnect (
 189   IN EFI_HANDLE        ImageHandle,
 190   IN EFI_SYSTEM_TABLE  *SystemTable
 191   );
 192
 193 /**
 194   Function for 'unload' command.
 195
 196   @param[in] ImageHandle  Handle to the Image (NULL if Internal).
 197   @param[in] SystemTable  Pointer to the System Table (NULL if Internal).
 198 **/
 199 SHELL_STATUS
 200 EFIAPI
 201 ShellCommandRunUnload (
 202   IN EFI_HANDLE        ImageHandle,
 203   IN EFI_SYSTEM_TABLE  *SystemTable
 204   );
 205
 206 #endif
 207