ProtocolSupport.c

Go to the documentation of this file.

 
#include <Uefi.h>
 
#include <Library/DebugLib.h>
#include <Library/MemoryAllocationLib.h>
#include <Library/UefiLib.h>
#include <Library/UefiBootServicesTableLib.h>
#include <Protocol/LoadedImage.h>
#include <Protocol/ShellParameters.h>
 
EFI_STATUS
GetArguments (
  OUT UINTN   *Argc,
  OUT CHAR16  ***Argv
  )
{
  STATIC CHAR16  *StArgv[2] = { L"Self", NULL };
 
  EFI_STATUS                     Status;
  EFI_SHELL_PARAMETERS_PROTOCOL  *ShellParameters;
  EFI_LOADED_IMAGE_PROTOCOL      *LoadedImage;
 
  Status = gBS->HandleProtocol (
                  gImageHandle,
                  &gEfiShellParametersProtocolGuid,
                  (VOID **)&ShellParameters
                  );
  if (!EFI_ERROR (Status)) {
    *Argc = ShellParameters->Argc;
    *Argv = ShellParameters->Argv;
    return EFI_SUCCESS;
  }
 
  Status = gBS->HandleProtocol (
                  gImageHandle,
                  &gEfiLoadedImageProtocolGuid,
                  (VOID **)&LoadedImage
                  );
 
  if (EFI_ERROR (Status)) {
    DEBUG ((DEBUG_WARN, "OCM: LoadedImage cannot be located - %r\n", Status));
  }
 
  if (EFI_ERROR (Status) || (LoadedImage->LoadOptions == NULL)) {
    *Argc = 1;
    *Argv = StArgv;
    return EFI_SUCCESS;
  }
 
  StArgv[1] = LoadedImage->LoadOptions;
  *Argc     = ARRAY_SIZE (StArgv);
  *Argv     = StArgv;
  return EFI_SUCCESS;
}
 
EFI_STATUS
OcUninstallAllProtocolInstances (
  EFI_GUID  *Protocol
  )
{
  EFI_STATUS  Status;
  EFI_HANDLE  *Handles;
  UINTN       Index;
  UINTN       NoHandles;
  VOID        *OriginalProto;
 
  Status = gBS->LocateHandleBuffer (
                  ByProtocol,
                  Protocol,
                  NULL,
                  &NoHandles,
                  &Handles
                  );
 
  if (Status == EFI_NOT_FOUND) {
    return EFI_SUCCESS;
  }
 
  if (EFI_ERROR (Status)) {
    return Status;
  }
 
  for (Index = 0; Index < NoHandles; ++Index) {
    Status = gBS->HandleProtocol (
                    Handles[Index],
                    Protocol,
                    &OriginalProto
                    );
 
    if (EFI_ERROR (Status)) {
      break;
    }
 
    Status = gBS->UninstallProtocolInterface (
                    Handles[Index],
                    Protocol,
                    OriginalProto
                    );
 
    if (EFI_ERROR (Status)) {
      break;
    }
  }
 
  FreePool (Handles);
 
  return Status;
}
 
EFI_STATUS
OcHandleProtocolFallback (
  IN  EFI_HANDLE  Handle,
  IN  EFI_GUID    *Protocol,
  OUT VOID        **Interface
  )
{
  EFI_STATUS  Status;
 
  Status = gBS->HandleProtocol (
                  Handle,
                  Protocol,
                  Interface
                  );
  if (EFI_ERROR (Status)) {
    Status = gBS->LocateProtocol (
                    Protocol,
                    NULL,
                    Interface
                    );
  }
 
  return Status;
}
 
UINTN
OcCountProtocolInstances (
  IN EFI_GUID  *Protocol
  )
{
  EFI_STATUS  Status;
  UINTN       HandleCount;
  EFI_HANDLE  *HandleBuffer;
 
  HandleCount = 0;
 
  Status = gBS->LocateHandleBuffer (
                  ByProtocol,
                  Protocol,
                  NULL,
                  &HandleCount,
                  &HandleBuffer
                  );
  if (EFI_ERROR (Status)) {
    //
    // No instance can be found on error.
    //
    return 0;
  }
 
  FreePool (HandleBuffer);
 
  return HandleCount;
}
 
VOID *
OcGetProtocol (
  IN  EFI_GUID     *Protocol,
  IN  UINTN        ErrorLevel,
  IN  CONST CHAR8  *CallerName     OPTIONAL,
  IN  CONST CHAR8  *ProtocolName   OPTIONAL
  )
{
  EFI_STATUS  Status;
  VOID        *Instance;
 
  Status = gBS->LocateProtocol (
                  Protocol,
                  NULL,
                  (VOID **)&Instance
                  );
 
  if (EFI_ERROR (Status)) {
    Instance = NULL;
    if (ErrorLevel != 0) {
      if (ProtocolName != NULL) {
        DEBUG ((ErrorLevel, "OCM: %a cannot get protocol %s - %r\n", CallerName, ProtocolName, Status));
      } else {
        DEBUG ((ErrorLevel, "OCM: %a cannot get protocol %g - %r\n", CallerName, Protocol, Status));
      }
    }
  }
 
  return Instance;
}