ShellPkg/Library/UefiShellDriver1CommandsLib/UefiShellDriver1CommandsLib.c

   1 /** @file
   2   Main file for NULL named library for level 1 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 #include "UefiShellDriver1CommandsLib.h"
  16
  17 STATIC CONST CHAR16 mFileName[] = L"Driver1Commands";
  18 EFI_HANDLE gShellDriver1HiiHandle = NULL;
  19 CONST EFI_GUID gShellDriver1HiiGuid = \
  20   { \
  21   0xaf0b742, 0x63ec, 0x45bd, {0x8d, 0xb6, 0x71, 0xad, 0x7f, 0x2f, 0xe8, 0xe8} \
  22   };
  23
  24 /**
  25   Function to return the name of the file containing help if HII will not be used.
  26
  27   @return The filename.
  28 **/
  29 CONST CHAR16*
  30 EFIAPI
  31 ShellCommandGetManFileNameDriver1 (
  32   VOID
  33   )
  34 {
  35   return (mFileName);
  36 }
  37
  38 /**
  39   Constructor for the Shell Driver1 Commands library.
  40
  41   @param ImageHandle    the image handle of the process
  42   @param SystemTable    the EFI System Table pointer
  43
  44   @retval EFI_SUCCESS        the shell command handlers were installed sucessfully
  45   @retval EFI_UNSUPPORTED    the shell level required was not found.
  46 **/
  47 EFI_STATUS
  48 EFIAPI
  49 UefiShellDriver1CommandsLibConstructor (
  50   IN EFI_HANDLE        ImageHandle,
  51   IN EFI_SYSTEM_TABLE  *SystemTable
  52   )
  53 {
  54   //
  55   // check our bit of the profiles mask
  56   //
  57   if ((PcdGet8(PcdShellProfileMask) & BIT0) == 0) {
  58     return (EFI_UNSUPPORTED);
  59   }
  60
  61   //
  62   // install the HII stuff.
  63   //
  64   gShellDriver1HiiHandle = HiiAddPackages (&gShellDriver1HiiGuid, gImageHandle, UefiShellDriver1CommandsLibStrings, NULL);
  65   if (gShellDriver1HiiHandle == NULL) {
  66     return (EFI_DEVICE_ERROR);
  67   }
  68
  69   //
  70   // install our shell command handlers that are always installed
  71   //
  72   ShellCommandRegisterCommandName(L"connect",    ShellCommandRunConnect               , ShellCommandGetManFileNameDriver1, 0, L"Driver1", TRUE, gShellDriver1HiiHandle, STRING_TOKEN(STR_GET_HELP_CONNECT)   );
  73   ShellCommandRegisterCommandName(L"devices",    ShellCommandRunDevices               , ShellCommandGetManFileNameDriver1, 0, L"Driver1", TRUE, gShellDriver1HiiHandle, STRING_TOKEN(STR_GET_HELP_DEVICES)   );
  74   ShellCommandRegisterCommandName(L"openinfo",   ShellCommandRunOpenInfo              , ShellCommandGetManFileNameDriver1, 0, L"Driver1", TRUE, gShellDriver1HiiHandle, STRING_TOKEN(STR_GET_HELP_OPENINFO)  );
  75   ShellCommandRegisterCommandName(L"disconnect", ShellCommandRunDisconnect            , ShellCommandGetManFileNameDriver1, 0, L"Driver1", TRUE, gShellDriver1HiiHandle, STRING_TOKEN(STR_GET_HELP_DISCONNECT));
  76   ShellCommandRegisterCommandName(L"reconnect",  ShellCommandRunReconnect             , ShellCommandGetManFileNameDriver1, 0, L"Driver1", TRUE, gShellDriver1HiiHandle, STRING_TOKEN(STR_GET_HELP_RECONNECT) );
  77   ShellCommandRegisterCommandName(L"unload",     ShellCommandRunUnload                , ShellCommandGetManFileNameDriver1, 0, L"Driver1", TRUE, gShellDriver1HiiHandle, STRING_TOKEN(STR_GET_HELP_UNLOAD)    );
  78   ShellCommandRegisterCommandName(L"drvdiag",    ShellCommandRunDrvDiag               , ShellCommandGetManFileNameDriver1, 0, L"Driver1", TRUE, gShellDriver1HiiHandle, STRING_TOKEN(STR_GET_HELP_DRVDIAG)   );
  79   ShellCommandRegisterCommandName(L"dh",         ShellCommandRunDh                    , ShellCommandGetManFileNameDriver1, 0, L"Driver1", TRUE, gShellDriver1HiiHandle, STRING_TOKEN(STR_GET_HELP_DH)        );
  80   ShellCommandRegisterCommandName(L"drivers",    ShellCommandRunDrivers               , ShellCommandGetManFileNameDriver1, 0, L"Driver1", TRUE, gShellDriver1HiiHandle, STRING_TOKEN(STR_GET_HELP_DRIVERS)   );
  81   ShellCommandRegisterCommandName(L"devtree",    ShellCommandRunDevTree               , ShellCommandGetManFileNameDriver1, 0, L"Driver1", TRUE, gShellDriver1HiiHandle, STRING_TOKEN(STR_GET_HELP_DEVTREE)   );
  82   ShellCommandRegisterCommandName(L"drvcfg",     ShellCommandRunDrvCfg                , ShellCommandGetManFileNameDriver1, 0, L"Driver1", TRUE, gShellDriver1HiiHandle, STRING_TOKEN(STR_GET_HELP_DRVCFG)    );
  83
  84   return (EFI_SUCCESS);
  85 }
  86
  87 /**
  88   Destructor for the library.  free any resources.
  89
  90   @param ImageHandle            The image handle of the process.
  91   @param SystemTable            The EFI System Table pointer.
  92 **/
  93 EFI_STATUS
  94 EFIAPI
  95 UefiShellDriver1CommandsLibDestructor (
  96   IN EFI_HANDLE        ImageHandle,
  97   IN EFI_SYSTEM_TABLE  *SystemTable
  98   )
  99 {
 100   if (gShellDriver1HiiHandle != NULL) {
 101     HiiRemovePackages(gShellDriver1HiiHandle);
 102   }
 103   return (EFI_SUCCESS);
 104 }
 105
 106
 107