ShellPkg/Library/UefiShellLevel3CommandsLib/UefiShellLevel3CommandsLib.c

   1 /** @file
   2   Main file for NULL named library for level 3 shell command functions.
   3
   4   Copyright (c) 2009 - 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 #include "UefiShellLevel3CommandsLib.h"
  15
  16 CONST CHAR16 gShellLevel3FileName[] = L"ShellCommands";
  17 EFI_HANDLE gShellLevel3HiiHandle = NULL;
  18 STATIC CONST EFI_GUID gShellLevel3HiiGuid = \
  19   { \
  20     0x4344558d, 0x4ef9, 0x4725, { 0xb1, 0xe4, 0x33, 0x76, 0xe8, 0xd6, 0x97, 0x4f } \
  21   };
  22
  23 /**
  24   return the filename to get help from is not using HII.
  25
  26   @retval The filename.
  27 **/
  28 CONST CHAR16*
  29 EFIAPI
  30 ShellCommandGetManFileNameLevel3 (
  31   VOID
  32   )
  33 {
  34   return (gShellLevel3FileName);
  35 }
  36
  37 /**
  38   Constructor for the Shell Level 3 Commands library.
  39
  40   Install the handlers for level 3 UEFI Shell 2.0 commands.
  41
  42   @param ImageHandle    the image handle of the process
  43   @param SystemTable    the EFI System Table pointer
  44
  45   @retval EFI_SUCCESS        the shell command handlers were installed sucessfully
  46   @retval EFI_UNSUPPORTED    the shell level required was not found.
  47 **/
  48 EFI_STATUS
  49 EFIAPI
  50 ShellLevel3CommandsLibConstructor (
  51   IN EFI_HANDLE        ImageHandle,
  52   IN EFI_SYSTEM_TABLE  *SystemTable
  53   )
  54 {
  55   gShellLevel3HiiHandle = NULL;
  56   //
  57   // if shell level is less than 3 do nothing
  58   //
  59   if (PcdGet8(PcdShellSupportLevel) < 3) {
  60     return (EFI_UNSUPPORTED);
  61   }
  62
  63   gShellLevel3HiiHandle = HiiAddPackages (&gShellLevel3HiiGuid, gImageHandle, UefiShellLevel3CommandsLibStrings, NULL);
  64   if (gShellLevel3HiiHandle == NULL) {
  65     return (EFI_DEVICE_ERROR);
  66   }
  67   //
  68   // install our shell command handlers that are always installed
  69   //
  70   // Note: that Time, Timezone, and Date are part of level 2 library
  71   //
  72   ShellCommandRegisterCommandName(L"type",    ShellCommandRunType   , ShellCommandGetManFileNameLevel3, 3, L"", TRUE , gShellLevel3HiiHandle, STRING_TOKEN(STR_GET_HELP_TYPE));
  73   ShellCommandRegisterCommandName(L"touch",   ShellCommandRunTouch  , ShellCommandGetManFileNameLevel3, 3, L"", TRUE , gShellLevel3HiiHandle, STRING_TOKEN(STR_GET_HELP_TOUCH));
  74   ShellCommandRegisterCommandName(L"ver",     ShellCommandRunVer    , ShellCommandGetManFileNameLevel3, 3, L"", TRUE , gShellLevel3HiiHandle, STRING_TOKEN(STR_GET_HELP_VER));
  75   ShellCommandRegisterCommandName(L"alias",   ShellCommandRunAlias  , ShellCommandGetManFileNameLevel3, 3, L"", TRUE , gShellLevel3HiiHandle, STRING_TOKEN(STR_GET_HELP_ALIAS));
  76   ShellCommandRegisterCommandName(L"cls",     ShellCommandRunCls    , ShellCommandGetManFileNameLevel3, 3, L"", TRUE , gShellLevel3HiiHandle, STRING_TOKEN(STR_GET_HELP_CLS));
  77   ShellCommandRegisterCommandName(L"echo",    ShellCommandRunEcho   , ShellCommandGetManFileNameLevel3, 3, L"", FALSE, gShellLevel3HiiHandle, STRING_TOKEN(STR_GET_HELP_ECHO));
  78   ShellCommandRegisterCommandName(L"pause",   ShellCommandRunPause  , ShellCommandGetManFileNameLevel3, 3, L"", TRUE , gShellLevel3HiiHandle, STRING_TOKEN(STR_GET_HELP_PAUSE));
  79   ShellCommandRegisterCommandName(L"getmtc",  ShellCommandRunGetMtc , ShellCommandGetManFileNameLevel3, 3, L"", TRUE , gShellLevel3HiiHandle, STRING_TOKEN(STR_GET_HELP_GETMTC));
  80   ShellCommandRegisterCommandName(L"help",    ShellCommandRunHelp   , ShellCommandGetManFileNameLevel3, 3, L"", TRUE , gShellLevel3HiiHandle, STRING_TOKEN(STR_GET_HELP_HELP));
  81
  82   return (EFI_SUCCESS);
  83 }
  84
  85 /**
  86   Destructor for the library.  free any resources.
  87
  88   @param ImageHandle            The image handle of the process.
  89   @param SystemTable            The EFI System Table pointer.
  90 **/
  91 EFI_STATUS
  92 EFIAPI
  93 ShellLevel3CommandsLibDestructor (
  94   IN EFI_HANDLE        ImageHandle,
  95   IN EFI_SYSTEM_TABLE  *SystemTable
  96   )
  97 {
  98   if (gShellLevel3HiiHandle != NULL) {
  99     HiiRemovePackages(gShellLevel3HiiHandle);
 100   }
 101   return (EFI_SUCCESS);
 102 }