Initial import.

[mirror_edk2.git] / EdkModulePkg / Library / EdkFvbServiceLib / Ia32 / Fvb.c

/*++\r
\r
Copyright (c) 2006, Intel Corporation                                                         \r
All rights reserved. This program and the accompanying materials                          \r
are licensed and made available under the terms and conditions of the BSD License         \r
which accompanies this distribution.  The full text of the license may be found at        \r
http://opensource.org/licenses/bsd-license.php                                            \r
                                                                                          \r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
\r
Module Name:\r
\r
    Fvb.c \r
\r
Abstract:\r
\r
  Firmware Volume Block Protocol Runtime Abstraction\r
\r
  mFvbEntry is an array of Handle Fvb pairs. The Fvb Lib Instance matches the \r
  index in the mFvbEntry array. This should be the same sequence as the FVB's\r
  were described in the HOB. We have to remember the handle so we can tell if \r
  the protocol has been reinstalled and it needs updateing.\r
\r
  If you are using any of these lib functions.you must first call FvbInitialize ().\r
\r
Key:\r
  FVB - Firmware Volume Block\r
\r
--*/\r
\r
#include "Fvb.h"\r
\r
//\r
// Lib will ASSERT if more FVB devices than this are added to the system.\r
//\r
STATIC FVB_ENTRY          *mFvbEntry;\r
STATIC EFI_EVENT          mFvbRegistration;\r
STATIC BOOLEAN            mEfiFvbInitialized        = FALSE;\r
STATIC UINTN              mFvbCount;\r
\r
STATIC\r
VOID\r
EFIAPI\r
FvbNotificationEvent (\r
  IN  EFI_EVENT       Event,\r
  IN  VOID            *Context\r
  )\r
/*++\r
\r
Routine Description:\r
  Update mFvbEntry. Add new entry, or update existing entry if Fvb protocol is\r
  reinstalled.\r
\r
Arguments:\r
\r
  Event   - The Event that is being processed\r
  \r
  Context - Event Context\r
\r
Returns: \r
  None\r
\r
--*/\r
{\r
  EFI_STATUS  Status;\r
  UINTN       BufferSize;\r
  EFI_HANDLE  Handle;\r
  UINTN       Index;\r
  UINTN       UpdateIndex;\r
\r
  while (TRUE) {\r
    BufferSize = sizeof (Handle);\r
    Status = gBS->LocateHandle (\r
                    ByRegisterNotify,\r
                    &gEfiFirmwareVolumeBlockProtocolGuid,\r
                    mFvbRegistration,\r
                    &BufferSize,\r
                    &Handle\r
                    );\r
    if (EFI_ERROR (Status)) {\r
      //\r
      // Exit Path of While Loop....\r
      //\r
      break;\r
    }\r
\r
    UpdateIndex = MAX_FVB_COUNT;\r
    for (Index = 0; Index < mFvbCount; Index++) {\r
      if (mFvbEntry[Index].Handle == Handle) {\r
        //\r
        //  If the handle is already in the table just update the protocol\r
        //\r
        UpdateIndex = Index;\r
        break;\r
      }\r
    }\r
\r
    if (UpdateIndex == MAX_FVB_COUNT) {\r
      //\r
      // Use the next free slot for a new entry\r
      //\r
      UpdateIndex                   = mFvbCount++;;\r
      mFvbEntry[UpdateIndex].Handle = Handle;\r
    }\r
    //\r
    // The array does not have enough entries\r
    //\r
    ASSERT (UpdateIndex < MAX_FVB_COUNT);\r
\r
    //\r
    //  Get the interface pointer and if it's ours, skip it\r
    //\r
    Status = gBS->HandleProtocol (Handle, &gEfiFirmwareVolumeBlockProtocolGuid, (VOID **) &mFvbEntry[UpdateIndex].Fvb);\r
    ASSERT_EFI_ERROR (Status);\r
\r
    Status = gBS->HandleProtocol (Handle, &gEfiFvbExtensionProtocolGuid, (VOID **) &mFvbEntry[UpdateIndex].FvbExtension);\r
    if (Status != EFI_SUCCESS) {\r
      mFvbEntry[UpdateIndex].FvbExtension = NULL;\r
    }\r
  }\r
}\r
\r
VOID\r
EFIAPI\r
FvbVirtualAddressChangeNotifyEvent (\r
  IN EFI_EVENT        Event,\r
  IN VOID             *Context\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Convert all pointers in mFvbEntry after ExitBootServices.\r
\r
Arguments:\r
\r
  Event   - The Event that is being processed\r
  \r
  Context - Event Context\r
\r
Returns:\r
\r
  None\r
\r
--*/\r
{\r
  UINTN Index;\r
  if (mFvbEntry != NULL) {\r
    for (Index = 0; Index < MAX_FVB_COUNT; Index++) {\r
      if (NULL != mFvbEntry[Index].Fvb) {\r
        EfiConvertPointer (0x0, (VOID **) &mFvbEntry[Index].Fvb->GetBlockSize);\r
        EfiConvertPointer (0x0, (VOID **) &mFvbEntry[Index].Fvb->GetPhysicalAddress);\r
        EfiConvertPointer (0x0, (VOID **) &mFvbEntry[Index].Fvb->GetVolumeAttributes);\r
        EfiConvertPointer (0x0, (VOID **) &mFvbEntry[Index].Fvb->SetVolumeAttributes);\r
        EfiConvertPointer (0x0, (VOID **) &mFvbEntry[Index].Fvb->Read);\r
        EfiConvertPointer (0x0, (VOID **) &mFvbEntry[Index].Fvb->Write);\r
        EfiConvertPointer (0x0, (VOID **) &mFvbEntry[Index].Fvb->EraseBlocks);\r
        EfiConvertPointer (0x0, (VOID **) &mFvbEntry[Index].Fvb);\r
      }\r
\r
      if (NULL != mFvbEntry[Index].FvbExtension) {\r
        EfiConvertPointer (0x0, (VOID **) &mFvbEntry[Index].FvbExtension->EraseFvbCustomBlock);\r
        EfiConvertPointer (0x0, (VOID **) &mFvbEntry[Index].FvbExtension);\r
      }\r
    }\r
\r
    EfiConvertPointer (0x0, (VOID **) &mFvbEntry);\r
  }\r
}\r
\r
EFI_STATUS\r
EFIAPI\r
FvbLibInitialize (\r
  IN EFI_HANDLE         ImageHandle,\r
  IN EFI_SYSTEM_TABLE   *SystemTable\r
  )\r
/*++\r
\r
Routine Description:\r
  Initialize globals and register Fvb Protocol notification function.\r
\r
Arguments:\r
  None \r
\r
Returns: \r
  EFI_SUCCESS\r
\r
--*/\r
{\r
  UINTN Status;\r
  mFvbCount = 0;\r
\r
  Status = gBS->AllocatePool (\r
                  EfiRuntimeServicesData,\r
                  (UINTN) sizeof (FVB_ENTRY) * MAX_FVB_COUNT,\r
                  (VOID *) &mFvbEntry\r
                  );\r
\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  ZeroMem (mFvbEntry, sizeof (FVB_ENTRY) * MAX_FVB_COUNT);\r
\r
  EfiCreateProtocolNotifyEvent (\r
    &gEfiFirmwareVolumeBlockProtocolGuid,\r
    EFI_TPL_CALLBACK,\r
    FvbNotificationEvent,\r
    NULL,\r
    &mFvbRegistration\r
    );\r
\r
  //\r
  // Register SetVirtualAddressMap () notify function\r
  //\r
  //  Status = gBS->CreateEvent (\r
  //                EFI_EVENT_SIGNAL_VIRTUAL_ADDRESS_CHANGE,\r
  //                EFI_TPL_NOTIFY,\r
  //                EfiRuntimeLibFvbVirtualNotifyEvent,\r
  //                NULL,\r
  //                &mEfiFvbVirtualNotifyEvent\r
  //                );\r
  //  ASSERT_EFI_ERROR (Status);\r
  //\r
\r
  //\r
  // Register SetVirtualAddressMap () notify function\r
  //\r
\r
  ASSERT_EFI_ERROR (Status);\r
\r
  mEfiFvbInitialized = TRUE;\r
\r
  return EFI_SUCCESS;\r
}\r
//\r
// The following functions wrap Fvb protocol in the Runtime Lib functions.\r
// The Instance translates into Fvb instance. The Fvb order defined by HOBs and\r
// thus the sequence of FVB protocol addition define Instance.\r
//\r
// EfiFvbInitialize () must be called before any of the following functions\r
// must be called.\r
//\r
\r
EFI_STATUS\r
EfiFvbReadBlock (\r
  IN UINTN                                        Instance,\r
  IN EFI_LBA                                      Lba,\r
  IN UINTN                                        Offset,\r
  IN OUT UINTN                                    *NumBytes,\r
  IN UINT8                                        *Buffer\r
  )\r
/*++\r
\r
Routine Description:\r
  Reads specified number of bytes into a buffer from the specified block\r
\r
Arguments:\r
  Instance              - The FV instance to be read from\r
  Lba                   - The logical block address to be read from\r
  Offset                - Offset into the block at which to begin reading\r
  NumBytes              - Pointer that on input contains the total size of\r
                          the buffer. On output, it contains the total number\r
                          of bytes read\r
  Buffer                - Pointer to a caller allocated buffer that will be\r
                          used to hold the data read\r
\r
Returns: \r
\r
  Status code\r
  \r
  EFI_INVALID_PARAMETER - invalid parameter\r
\r
--*/\r
{\r
  if (Instance >= mFvbCount) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  return mFvbEntry[Instance].Fvb->Read (mFvbEntry[Instance].Fvb, Lba, Offset, NumBytes, Buffer);\r
}\r
\r
EFI_STATUS\r
EfiFvbWriteBlock (\r
  IN UINTN                                        Instance,\r
  IN EFI_LBA                                      Lba,\r
  IN UINTN                                        Offset,\r
  IN OUT UINTN                                    *NumBytes,\r
  IN UINT8                                        *Buffer\r
  )\r
/*++\r
\r
Routine Description:\r
  Writes specified number of bytes from the input buffer to the block\r
\r
Arguments:\r
  Instance              - The FV instance to be written to\r
  Lba                   - The starting logical block index to write to\r
  Offset                - Offset into the block at which to begin writing\r
  NumBytes              - Pointer that on input contains the total size of\r
                          the buffer. On output, it contains the total number\r
                          of bytes actually written\r
  Buffer                - Pointer to a caller allocated buffer that contains\r
                          the source for the write\r
\r
Returns: \r
\r
  Status code\r
  \r
  EFI_INVALID_PARAMETER - invalid parameter\r
\r
--*/\r
{\r
  if (Instance >= mFvbCount) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  return mFvbEntry[Instance].Fvb->Write (mFvbEntry[Instance].Fvb, Lba, Offset, NumBytes, Buffer);\r
}\r
\r
EFI_STATUS\r
EfiFvbEraseBlock (\r
  IN UINTN                                Instance,\r
  IN EFI_LBA                              Lba\r
  )\r
/*++\r
\r
Routine Description:\r
  Erases and initializes a firmware volume block\r
\r
Arguments:\r
  Instance              - The FV instance to be erased\r
  Lba                   - The logical block index to be erased\r
  \r
Returns: \r
\r
  Status code\r
  \r
  EFI_INVALID_PARAMETER - invalid parameter\r
\r
--*/\r
{\r
  if (Instance >= mFvbCount) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  return mFvbEntry[Instance].Fvb->EraseBlocks (mFvbEntry[Instance].Fvb, Lba, -1);\r
}\r
\r
EFI_STATUS\r
EfiFvbGetVolumeAttributes (\r
  IN UINTN                                Instance,\r
  OUT EFI_FVB_ATTRIBUTES                  *Attributes\r
  )\r
/*++\r
\r
Routine Description:\r
  Retrieves attributes, insures positive polarity of attribute bits, returns\r
  resulting attributes in output parameter\r
\r
Arguments:\r
  Instance              - The FV instance whose attributes is going to be \r
                          returned\r
  Attributes            - Output buffer which contains attributes\r
\r
Returns: \r
  Status code\r
  \r
  EFI_INVALID_PARAMETER - invalid parameter\r
\r
--*/\r
{\r
  if (Instance >= mFvbCount) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  return mFvbEntry[Instance].Fvb->GetVolumeAttributes (mFvbEntry[Instance].Fvb, Attributes);\r
}\r
\r
EFI_STATUS\r
EfiFvbSetVolumeAttributes (\r
  IN UINTN                                Instance,\r
  IN EFI_FVB_ATTRIBUTES                   Attributes\r
  )\r
/*++\r
\r
Routine Description:\r
  Modifies the current settings of the firmware volume according to the \r
  input parameter, and returns the new setting of the volume\r
\r
Arguments:\r
  Instance              - The FV instance whose attributes is going to be \r
                          modified\r
  Attributes            - On input, it is a pointer to EFI_FVB_ATTRIBUTES \r
                          containing the desired firmware volume settings.\r
                          On successful return, it contains the new settings\r
                          of the firmware volume\r
\r
Returns: \r
  Status code\r
  \r
  EFI_INVALID_PARAMETER - invalid parameter\r
\r
--*/\r
{\r
  if (Instance >= mFvbCount) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  return mFvbEntry[Instance].Fvb->SetVolumeAttributes (mFvbEntry[Instance].Fvb, &Attributes);\r
}\r
\r
EFI_STATUS\r
EfiFvbGetPhysicalAddress (\r
  IN UINTN                                Instance,\r
  OUT EFI_PHYSICAL_ADDRESS                *BaseAddress\r
  )\r
/*++\r
\r
Routine Description:\r
  Retrieves the physical address of a memory mapped FV\r
\r
Arguments:\r
  Instance              - The FV instance whose base address is going to be\r
                          returned\r
  BaseAddress           - Pointer to a caller allocated EFI_PHYSICAL_ADDRESS \r
                          that on successful return, contains the base address\r
                          of the firmware volume. \r
\r
Returns: \r
\r
  Status code\r
  \r
  EFI_INVALID_PARAMETER - invalid parameter\r
\r
--*/\r
{\r
  if (Instance >= mFvbCount) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  return mFvbEntry[Instance].Fvb->GetPhysicalAddress (mFvbEntry[Instance].Fvb, BaseAddress);\r
}\r
\r
EFI_STATUS\r
EfiFvbGetBlockSize (\r
  IN UINTN                                        Instance,\r
  IN EFI_LBA                                      Lba,\r
  OUT UINTN                                       *BlockSize,\r
  OUT UINTN                                       *NumOfBlocks\r
  )\r
/*++\r
\r
Routine Description:\r
  Retrieve the size of a logical block\r
\r
Arguments:\r
  Instance              - The FV instance whose block size is going to be\r
                          returned\r
  Lba                   - Indicates which block to return the size for.\r
  BlockSize             - A pointer to a caller allocated UINTN in which\r
                          the size of the block is returned\r
  NumOfBlocks           - a pointer to a caller allocated UINTN in which the\r
                          number of consecutive blocks starting with Lba is\r
                          returned. All blocks in this range have a size of\r
                          BlockSize\r
\r
Returns: \r
  EFI_SUCCESS           - The firmware volume was read successfully and \r
                          contents are in Buffer\r
                          \r
  EFI_INVALID_PARAMETER - invalid parameter\r
\r
--*/\r
{\r
  if (Instance >= mFvbCount) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  return mFvbEntry[Instance].Fvb->GetBlockSize (mFvbEntry[Instance].Fvb, Lba, BlockSize, NumOfBlocks);\r
}\r
\r
EFI_STATUS\r
EfiFvbEraseCustomBlockRange (\r
  IN UINTN                                Instance,\r
  IN EFI_LBA                              StartLba,\r
  IN UINTN                                OffsetStartLba,\r
  IN EFI_LBA                              LastLba,\r
  IN UINTN                                OffsetLastLba\r
  )\r
/*++\r
\r
Routine Description:\r
  Erases and initializes a specified range of a firmware volume\r
\r
Arguments:\r
  Instance              - The FV instance to be erased\r
  StartLba              - The starting logical block index to be erased\r
  OffsetStartLba        - Offset into the starting block at which to \r
                          begin erasing\r
  LastLba               - The last logical block index to be erased\r
  OffsetLastLba         - Offset into the last block at which to end erasing\r
\r
Returns: \r
\r
  Status code\r
  \r
  EFI_INVALID_PARAMETER - invalid parameter\r
  \r
  EFI_UNSUPPORTED       - not support\r
  \r
--*/\r
{\r
  if (Instance >= mFvbCount) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  if (!(mFvbEntry[Instance].FvbExtension)) {\r
    return EFI_UNSUPPORTED;\r
  }\r
\r
  if (!(mFvbEntry[Instance].FvbExtension->EraseFvbCustomBlock)) {\r
    return EFI_UNSUPPORTED;\r
  }\r
\r
  return mFvbEntry[Instance].FvbExtension->EraseFvbCustomBlock (\r
                                            mFvbEntry[Instance].FvbExtension,\r
                                            StartLba,\r
                                            OffsetStartLba,\r
                                            LastLba,\r
                                            OffsetLastLba\r
                                            );\r
}\r