Vlv2TbltDevicePkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / Vlv2TbltDevicePkg / Library / FlashDeviceLib / FlashDeviceLibDxeRuntimeSmm.c

/** @file\r
\r
  Copyright (c) 2004  - 2016, Intel Corporation. All rights reserved.<BR>\r
\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
\r
\r
**/\r
\r
#include <PiDxe.h>\r
\r
#include <Library/FlashDeviceLib.h>\r
#include <Library/DebugLib.h>\r
#include <Library/BaseLib.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
#include <Library/UefiRuntimeServicesTableLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/UefiRuntimeLib.h>\r
#include <Protocol/SmmBase2.h>\r
#include <Guid/EventGroup.h>\r
#include "SpiChipDefinitions.h"\r
\r
extern UINTN FlashDeviceBase;\r
\r
extern EFI_SPI_PROTOCOL *mSpiProtocol;\r
\r
VOID\r
EFIAPI\r
LibFvbFlashDeviceVirtualAddressChangeNotifyEvent (\r
  IN EFI_EVENT        Event,\r
  IN VOID             *Context\r
  )\r
{\r
  gRT->ConvertPointer (0, (VOID **) &mSpiProtocol);\r
  gRT->ConvertPointer (0, (VOID **) &FlashDeviceBase);\r
}\r
\r
\r
/**\r
  The library constructuor.\r
\r
  The function does the necessary initialization work for this library\r
  instance. Please put all initialization works in it.\r
\r
  @param[in]  ImageHandle       The firmware allocated handle for the UEFI image.\r
  @param[in]  SystemTable       A pointer to the EFI system table.\r
\r
  @retval     EFI_SUCCESS       The function always return EFI_SUCCESS for now.\r
                                It will ASSERT on error for debug version.\r
  @retval     EFI_ERROR         Please reference LocateProtocol for error code details.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
LibFvbFlashDeviceSupportInit (\r
  IN EFI_HANDLE         ImageHandle,\r
  IN EFI_SYSTEM_TABLE   *SystemTable\r
  )\r
{\r
  EFI_STATUS Status;\r
  EFI_EVENT  Event;\r
  UINT8                         SfId[3];\r
  UINT8                         FlashIndex;\r
  UINT8                         SpiReadError;\r
  UINT8                         SpiNotMatchError;\r
  EFI_SMM_BASE2_PROTOCOL       *SmmBase;\r
  BOOLEAN                       InSmm;\r
\r
  SpiReadError     = 0x00;\r
  SpiNotMatchError = 0x00;\r
\r
  InSmm = FALSE;\r
  Status = gBS->LocateProtocol (\r
                  &gEfiSmmBase2ProtocolGuid,\r
                  NULL,\r
                  (void **)&SmmBase\r
                  );\r
  if (!EFI_ERROR(Status)) {\r
    Status = SmmBase->InSmm(SmmBase, &InSmm);\r
    if (EFI_ERROR(Status)) {\r
      InSmm = FALSE;\r
    }\r
  }\r
\r
  if (!InSmm) {\r
    Status = gBS->LocateProtocol (\r
                  &gEfiSpiProtocolGuid,\r
                  NULL,\r
                  (VOID **)&mSpiProtocol\r
                  );\r
    ASSERT_EFI_ERROR (Status);\r
\r
    Status = gBS->CreateEventEx (\r
                  EVT_NOTIFY_SIGNAL,\r
                  TPL_NOTIFY,\r
                  LibFvbFlashDeviceVirtualAddressChangeNotifyEvent,\r
                  NULL,\r
                  &gEfiEventVirtualAddressChangeGuid,\r
                  &Event\r
                  );\r
    ASSERT_EFI_ERROR (Status);\r
\r
  } else {\r
    Status = gBS->LocateProtocol (\r
                    &gEfiSmmSpiProtocolGuid,\r
                    NULL,\r
                    (VOID **)&mSpiProtocol\r
                    );\r
    ASSERT_EFI_ERROR (Status);\r
  }\r
\r
\r
  for (FlashIndex = EnumSpiFlashW25Q64; FlashIndex < EnumSpiFlashMax; FlashIndex++) {\r
    Status = mSpiProtocol->Init (mSpiProtocol, &(mInitTable[FlashIndex]));\r
    if (!EFI_ERROR (Status)) {\r
      //\r
      // Read Vendor/Device IDs to check if the driver supports the Serial Flash device.\r
      //\r
      Status = mSpiProtocol->Execute (\r
                               mSpiProtocol,\r
                               SPI_READ_ID,\r
                               SPI_WREN,\r
                               TRUE,\r
                               FALSE,\r
                               FALSE,\r
                               0,\r
                               3,\r
                               SfId,\r
                               EnumSpiRegionAll\r
                               );\r
      if (!EFI_ERROR (Status)) {\r
        if ((SfId[0] == mInitTable[FlashIndex].VendorId)  &&\r
            (SfId[1] == mInitTable[FlashIndex].DeviceId0) &&\r
            (SfId[2] == mInitTable[FlashIndex].DeviceId1)) {\r
            //\r
            // Found a matching SPI device, FlashIndex now contains flash device.\r
            //\r
            DEBUG ((EFI_D_ERROR, "OK - Found SPI Flash Type in SPI Flash Driver, Device Type ID 0 = 0x%02x!\n", mInitTable[FlashIndex].DeviceId0));\r
            DEBUG ((EFI_D_ERROR, "Device Type ID 1 = 0x%02x!\n", mInitTable[FlashIndex].DeviceId1));\r
\r
            if (mInitTable[FlashIndex].BiosStartOffset == (UINTN) (-1)) {\r
              DEBUG ((EFI_D_ERROR, "ERROR - The size of BIOS image is bigger than SPI Flash device!\n"));\r
              CpuDeadLoop ();\r
            }\r
            break;\r
        } else {\r
          SpiNotMatchError++;\r
        }\r
      } else {\r
        SpiReadError++;\r
      }\r
    }\r
  }\r
\r
  DEBUG ((EFI_D_ERROR, "SPI flash chip VID = 0x%X, DID0 = 0x%X, DID1 = 0x%X\n", SfId[0], SfId[1], SfId[2]));\r
\r
  if (FlashIndex < EnumSpiFlashMax)  {\r
    return EFI_SUCCESS;\r
  } else {\r
  if (SpiReadError != 0) {\r
      DEBUG ((EFI_D_ERROR, "ERROR - SPI Read ID execution failed! Error Count = %d\n", SpiReadError));\r
   }\r
    else {\r
      if (SpiNotMatchError != 0) {\r
        DEBUG ((EFI_D_ERROR, "ERROR - No supported SPI flash chip found! Error Count = %d\n", SpiNotMatchError));\r
        DEBUG ((EFI_D_ERROR, "SPI flash chip VID = 0x%X, DID0 = 0x%X, DID1 = 0x%X\n", SfId[0], SfId[1], SfId[2]));\r
      }\r
    }\r
    return EFI_UNSUPPORTED;\r
  }\r
}\r
\r