ShellPkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / ShellPkg / Library / UefiShellCEntryLib / UefiShellCEntryLib.c

/** @file\r
  Provides application point extension for "C" style main function\r
\r
  Copyright (c) 2009 - 2016, Intel Corporation. All rights reserved.<BR>\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include <Base.h>\r
\r
#include <Protocol/SimpleFileSystem.h>\r
#include <Protocol/LoadedImage.h>\r
#include <Protocol/EfiShellInterface.h>\r
#include <Protocol/ShellParameters.h>\r
\r
#include <Library/ShellCEntryLib.h>\r
#include <Library/DebugLib.h>\r
\r
/**\r
  UEFI entry point for an application that will in turn call the\r
  ShellAppMain function which has parameters similar to a standard C\r
  main function.\r
\r
  An application that uses UefiShellCEntryLib must have a ShellAppMain\r
  function as prototyped in Include/Library/ShellCEntryLib.h.\r
\r
  Note that the Shell uses POSITIVE integers for error values, while UEFI\r
  uses NEGATIVE values.  If the application is to be used within a script,\r
  it needs to return one of the SHELL_STATUS values defined in Protocol/Shell.h.\r
\r
  @param  ImageHandle  The image handle of the UEFI Application.\r
  @param  SystemTable  A pointer to the EFI System Table.\r
\r
  @retval  EFI_SUCCESS               The application exited normally.\r
  @retval  Other                     An error occurred.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
ShellCEntryLib (\r
  IN EFI_HANDLE        ImageHandle,\r
  IN EFI_SYSTEM_TABLE  *SystemTable\r
  )\r
{\r
  INTN                           ReturnFromMain;\r
  EFI_SHELL_PARAMETERS_PROTOCOL *EfiShellParametersProtocol;\r
  EFI_SHELL_INTERFACE           *EfiShellInterface;\r
  EFI_STATUS                    Status;\r
\r
  ReturnFromMain = -1;\r
  EfiShellParametersProtocol = NULL;\r
  EfiShellInterface = NULL;\r
\r
  Status = SystemTable->BootServices->OpenProtocol(ImageHandle,\r
                             &gEfiShellParametersProtocolGuid,\r
                             (VOID **)&EfiShellParametersProtocol,\r
                             ImageHandle,\r
                             NULL,\r
                             EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
                            );\r
  if (!EFI_ERROR(Status)) {\r
    //\r
    // use shell 2.0 interface\r
    //\r
    ReturnFromMain = ShellAppMain (\r
                       EfiShellParametersProtocol->Argc,\r
                       EfiShellParametersProtocol->Argv\r
                      );\r
  } else {\r
    //\r
    // try to get shell 1.0 interface instead.\r
    //\r
    Status = SystemTable->BootServices->OpenProtocol(ImageHandle,\r
                               &gEfiShellInterfaceGuid,\r
                               (VOID **)&EfiShellInterface,\r
                               ImageHandle,\r
                               NULL,\r
                               EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
                              );\r
    if (!EFI_ERROR(Status)) {\r
      //\r
      // use shell 1.0 interface\r
      //\r
      ReturnFromMain = ShellAppMain (\r
                         EfiShellInterface->Argc,\r
                         EfiShellInterface->Argv\r
                        );\r
    } else {\r
      ASSERT(FALSE);\r
    }\r
  }\r
  return ReturnFromMain;\r
}\r