]> git.proxmox.com Git - mirror_edk2.git/blobdiff - ArmPlatformPkg/Drivers/NorFlashDxe/NorFlashFvbDxe.c
ArmPlatformPkg/NorFlashDxe: Optimise FVB protocol
[mirror_edk2.git] / ArmPlatformPkg / Drivers / NorFlashDxe / NorFlashFvbDxe.c
index b9230c1ee007c8f147bbb86b565e1b5b8a40b65e..9ad0e14668289baabd6f135d18c106bef3ba8622 100644 (file)
@@ -20,6 +20,7 @@
 #include <Library/UefiLib.h>\r
 #include <Library/BaseMemoryLib.h>\r
 #include <Library/MemoryAllocationLib.h>\r
+#include <Library/DxeServicesTableLib.h>\r
 #include <Library/UefiBootServicesTableLib.h>\r
 \r
 #include <Guid/VariableFormat.h>\r
@@ -27,6 +28,8 @@
 \r
 #include "NorFlashDxe.h"\r
 \r
+STATIC EFI_EVENT mFvbVirtualAddrChangeEvent;\r
+STATIC UINTN     mFlashNvStorageVariableBase;\r
 \r
 ///\r
 /// The Firmware Volume Block Protocol is the low-level interface\r
@@ -301,7 +304,7 @@ FvbGetPhysicalAddress (
 \r
   ASSERT(Address != NULL);\r
 \r
-  *Address = PcdGet32 (PcdFlashNvStorageVariableBase);\r
+  *Address = mFlashNvStorageVariableBase;\r
   return EFI_SUCCESS;\r
 }\r
 \r
@@ -414,7 +417,6 @@ FvbRead (
   IN OUT    UINT8                                 *Buffer\r
   )\r
 {\r
-  EFI_STATUS    Status;\r
   EFI_STATUS    TempStatus;\r
   UINTN         BlockSize;\r
   NOR_FLASH_INSTANCE *Instance;\r
@@ -427,8 +429,7 @@ FvbRead (
     Instance->Initialize(Instance);\r
   }\r
 \r
-  Status = EFI_SUCCESS;\r
-  TempStatus = Status;\r
+  TempStatus = EFI_SUCCESS;\r
 \r
   // Cache the block size to avoid de-referencing pointers all the time\r
   BlockSize = Instance->Media.BlockSize;\r
@@ -449,25 +450,21 @@ FvbRead (
     return EFI_BAD_BUFFER_SIZE;\r
   }\r
 \r
-  // Check we did get some memory\r
-  if (Instance->FvbBuffer == NULL) {\r
-    DEBUG ((EFI_D_ERROR, "FvbRead: ERROR - Buffer not ready\n"));\r
-    return EFI_DEVICE_ERROR;\r
-  }\r
-\r
-  // Read NOR Flash data into shadow buffer\r
-  TempStatus = NorFlashReadBlocks (Instance, Instance->StartLba + Lba, BlockSize, Instance->FvbBuffer);\r
-  if (EFI_ERROR (TempStatus)) {\r
-    // Return one of the pre-approved error statuses\r
-    return EFI_DEVICE_ERROR;\r
+  // Decide if we are doing full block reads or not.\r
+  if (*NumBytes % BlockSize != 0) {\r
+    TempStatus = NorFlashRead (Instance, Instance->StartLba + Lba, Offset, *NumBytes, Buffer);\r
+    if (EFI_ERROR (TempStatus)) {\r
+      return EFI_DEVICE_ERROR;\r
+    }\r
+  } else {\r
+    // Read NOR Flash data into shadow buffer\r
+    TempStatus = NorFlashReadBlocks (Instance, Instance->StartLba + Lba, BlockSize, Buffer);\r
+    if (EFI_ERROR (TempStatus)) {\r
+      // Return one of the pre-approved error statuses\r
+      return EFI_DEVICE_ERROR;\r
+    }\r
   }\r
-\r
-  // Put the data at the appropriate location inside the buffer area\r
-  DEBUG ((DEBUG_BLKIO, "FvbRead: CopyMem( Dst=0x%08x, Src=0x%08x, Size=0x%x ).\n", Buffer, (UINTN)Instance->FvbBuffer + Offset, *NumBytes));\r
-\r
-  CopyMem (Buffer, (VOID*)((UINTN)Instance->FvbBuffer + Offset), *NumBytes);\r
-\r
-  return Status;\r
+  return EFI_SUCCESS;\r
 }\r
 \r
 /**\r
@@ -534,10 +531,21 @@ FvbWrite (
   IN        UINT8                                 *Buffer\r
   )\r
 {\r
-  EFI_STATUS  Status;\r
   EFI_STATUS  TempStatus;\r
+  UINT32      Tmp;\r
+  UINT32      TmpBuf;\r
+  UINT32      WordToWrite;\r
+  UINT32      Mask;\r
+  UINTN       DoErase;\r
+  UINTN       BytesToWrite;\r
+  UINTN       CurOffset;\r
+  UINTN       WordAddr;\r
   UINTN       BlockSize;\r
   NOR_FLASH_INSTANCE *Instance;\r
+  UINTN       BlockAddress;\r
+  UINTN       PrevBlockAddress;\r
+\r
+  PrevBlockAddress = 0;\r
 \r
   Instance = INSTANCE_FROM_FVB_THIS(This);\r
 \r
@@ -547,9 +555,6 @@ FvbWrite (
 \r
   DEBUG ((DEBUG_BLKIO, "FvbWrite(Parameters: Lba=%ld, Offset=0x%x, *NumBytes=0x%x, Buffer @ 0x%08x)\n", Instance->StartLba + Lba, Offset, *NumBytes, Buffer));\r
 \r
-  Status = EFI_SUCCESS;\r
-  TempStatus = Status;\r
-\r
   // Detect WriteDisabled state\r
   if (Instance->Media.ReadOnly == TRUE) {\r
     DEBUG ((EFI_D_ERROR, "FvbWrite: ERROR - Can not write: Device is in WriteDisabled state.\n"));\r
@@ -575,7 +580,129 @@ FvbWrite (
     return EFI_BAD_BUFFER_SIZE;\r
   }\r
 \r
-  // Check we did get some memory\r
+  // Pick 128bytes as a good start for word operations as opposed to erasing the\r
+  // block and writing the data regardless if an erase is really needed.\r
+  // It looks like most individual NV variable writes are smaller than 128bytes.\r
+  if (*NumBytes <= 128) {\r
+    // Check to see if we need to erase before programming the data into NOR.\r
+    // If the destination bits are only changing from 1s to 0s we can just write.\r
+    // After a block is erased all bits in the block is set to 1.\r
+    // If any byte requires us to erase we just give up and rewrite all of it.\r
+    DoErase = 0;\r
+    BytesToWrite = *NumBytes;\r
+    CurOffset = Offset;\r
+\r
+    while (BytesToWrite > 0) {\r
+      // Read full word from NOR, splice as required. A word is the smallest\r
+      // unit we can write.\r
+      TempStatus = NorFlashRead (Instance, Instance->StartLba + Lba,\r
+                                 CurOffset & ~(0x3), sizeof(Tmp), &Tmp);\r
+      if (EFI_ERROR (TempStatus)) {\r
+        return EFI_DEVICE_ERROR;\r
+      }\r
+\r
+      // Physical address of word in NOR to write.\r
+      WordAddr = (CurOffset & ~(0x3)) + GET_NOR_BLOCK_ADDRESS (Instance->RegionBaseAddress,\r
+                                                               Lba, BlockSize);\r
+      // The word of data that is to be written.\r
+      TmpBuf = *((UINT32*)(Buffer + (*NumBytes - BytesToWrite)));\r
+\r
+      // First do word aligned chunks.\r
+      if ((CurOffset & 0x3) == 0) {\r
+        if (BytesToWrite >= 4) {\r
+          // Is the destination still in 'erased' state?\r
+          if (~Tmp != 0) {\r
+            // Check to see if we are only changing bits to zero.\r
+            if ((Tmp ^ TmpBuf) & TmpBuf) {\r
+              DoErase = 1;\r
+              break;\r
+            }\r
+          }\r
+          // Write this word to NOR\r
+          WordToWrite = TmpBuf;\r
+          CurOffset += sizeof(TmpBuf);\r
+          BytesToWrite -= sizeof(TmpBuf);\r
+        } else {\r
+          // BytesToWrite < 4. Do small writes and left-overs\r
+          Mask = ~((~0) << (BytesToWrite * 8));\r
+          // Mask out the bytes we want.\r
+          TmpBuf &= Mask;\r
+          // Is the destination still in 'erased' state?\r
+          if ((Tmp & Mask) != Mask) {\r
+            // Check to see if we are only changing bits to zero.\r
+            if ((Tmp ^ TmpBuf) & TmpBuf) {\r
+              DoErase = 1;\r
+              break;\r
+            }\r
+          }\r
+          // Merge old and new data. Write merged word to NOR\r
+          WordToWrite = (Tmp & ~Mask) | TmpBuf;\r
+          CurOffset += BytesToWrite;\r
+          BytesToWrite = 0;\r
+        }\r
+      } else {\r
+        // Do multiple words, but starting unaligned.\r
+        if (BytesToWrite > (4 - (CurOffset & 0x3))) {\r
+          Mask = ~((~0) << ((CurOffset & 0x3) * 8));\r
+          // Mask out the bytes we want.\r
+          TmpBuf = (TmpBuf << ((CurOffset & 0x3) * 8)) & Mask;\r
+          // Is the destination still in 'erased' state?\r
+          if ((Tmp & Mask) != Mask) {\r
+            // Check to see if we are only changing bits to zero.\r
+            if ((Tmp ^ TmpBuf) & TmpBuf) {\r
+              DoErase = 1;\r
+              break;\r
+            }\r
+          }\r
+          // Merge old and new data. Write merged word to NOR\r
+          WordToWrite = (Tmp & ~Mask) | TmpBuf;\r
+          BytesToWrite -= (4 - (CurOffset & 0x3));\r
+          CurOffset += (4 - (CurOffset & 0x3));\r
+        } else {\r
+          // Unaligned and fits in one word.\r
+          Mask = (~((~0) << (BytesToWrite * 8))) << ((CurOffset & 0x3) * 8);\r
+          // Mask out the bytes we want.\r
+          TmpBuf = (TmpBuf << ((CurOffset & 0x3) * 8)) & Mask;\r
+          // Is the destination still in 'erased' state?\r
+          if ((Tmp & Mask) != Mask) {\r
+            // Check to see if we are only changing bits to zero.\r
+            if ((Tmp ^ TmpBuf) & TmpBuf) {\r
+              DoErase = 1;\r
+              break;\r
+            }\r
+          }\r
+          // Merge old and new data. Write merged word to NOR\r
+          WordToWrite = (Tmp & ~Mask) | TmpBuf;\r
+          CurOffset += BytesToWrite;\r
+          BytesToWrite = 0;\r
+        }\r
+      }\r
+\r
+      //\r
+      // Write the word to NOR.\r
+      //\r
+\r
+      BlockAddress = GET_NOR_BLOCK_ADDRESS (Instance->RegionBaseAddress, Lba, BlockSize);\r
+      if (BlockAddress != PrevBlockAddress) {\r
+        TempStatus = NorFlashUnlockSingleBlockIfNecessary (Instance, BlockAddress);\r
+        if (EFI_ERROR (TempStatus)) {\r
+          return EFI_DEVICE_ERROR;\r
+        }\r
+        PrevBlockAddress = BlockAddress;\r
+      }\r
+      TempStatus = NorFlashWriteSingleWord (Instance, WordAddr, WordToWrite);\r
+      if (EFI_ERROR (TempStatus)) {\r
+        return EFI_DEVICE_ERROR;\r
+      }\r
+    }\r
+    // Exit if we got here and could write all the data. Otherwise do the\r
+    // Erase-Write cycle.\r
+    if (!DoErase) {\r
+      return EFI_SUCCESS;\r
+    }\r
+  }\r
+\r
+  // Check we did get some memory. Buffer is BlockSize.\r
   if (Instance->FvbBuffer == NULL) {\r
     DEBUG ((EFI_D_ERROR, "FvbWrite: ERROR - Buffer not ready\n"));\r
     return EFI_DEVICE_ERROR;\r
@@ -598,7 +725,7 @@ FvbWrite (
     return EFI_DEVICE_ERROR;\r
   }\r
 \r
-  return Status;\r
+  return EFI_SUCCESS;\r
 }\r
 \r
 /**\r
@@ -745,6 +872,25 @@ EXIT:
   return Status;\r
 }\r
 \r
+/**\r
+  Fixup internal data so that EFI can be call in virtual mode.\r
+  Call the passed in Child Notify event and convert any pointers in\r
+  lib to virtual mode.\r
+\r
+  @param[in]    Event   The Event that is being processed\r
+  @param[in]    Context Event Context\r
+**/\r
+VOID\r
+EFIAPI\r
+FvbVirtualNotifyEvent (\r
+  IN EFI_EVENT        Event,\r
+  IN VOID             *Context\r
+  )\r
+{\r
+  EfiConvertPointer (0x0, (VOID**)&mFlashNvStorageVariableBase);\r
+  return;\r
+}\r
+\r
 EFI_STATUS\r
 EFIAPI\r
 NorFlashFvbInitialize (\r
@@ -754,10 +900,12 @@ NorFlashFvbInitialize (
   EFI_STATUS  Status;\r
   UINT32      FvbNumLba;\r
   EFI_BOOT_MODE BootMode;\r
+  UINTN       RuntimeMmioRegionSize;\r
 \r
   DEBUG((DEBUG_BLKIO,"NorFlashFvbInitialize\n"));\r
 \r
   Instance->Initialized = TRUE;\r
+  mFlashNvStorageVariableBase = FixedPcdGet32 (PcdFlashNvStorageVariableBase);\r
 \r
   // Set the index of the first LBA for the FVB\r
   Instance->StartLba = (PcdGet32 (PcdFlashNvStorageVariableBase) - Instance->RegionBaseAddress) / Instance->Media.BlockSize;\r
@@ -789,5 +937,41 @@ NorFlashFvbInitialize (
       return Status;\r
     }\r
   }\r
+\r
+  //\r
+  // Declare the Non-Volatile storage as EFI_MEMORY_RUNTIME\r
+  //\r
+\r
+  // Note: all the NOR Flash region needs to be reserved into the UEFI Runtime memory;\r
+  //       even if we only use the small block region at the top of the NOR Flash.\r
+  //       The reason is when the NOR Flash memory is set into program mode, the command\r
+  //       is written as the base of the flash region (ie: Instance->DeviceBaseAddress)\r
+  RuntimeMmioRegionSize = (Instance->RegionBaseAddress - Instance->DeviceBaseAddress) + Instance->Size;\r
+\r
+  Status = gDS->AddMemorySpace (\r
+      EfiGcdMemoryTypeMemoryMappedIo,\r
+      Instance->DeviceBaseAddress, RuntimeMmioRegionSize,\r
+      EFI_MEMORY_UC | EFI_MEMORY_RUNTIME\r
+      );\r
+  ASSERT_EFI_ERROR (Status);\r
+\r
+  Status = gDS->SetMemorySpaceAttributes (\r
+      Instance->DeviceBaseAddress, RuntimeMmioRegionSize,\r
+      EFI_MEMORY_UC | EFI_MEMORY_RUNTIME);\r
+  ASSERT_EFI_ERROR (Status);\r
+\r
+  //\r
+  // Register for the virtual address change event\r
+  //\r
+  Status = gBS->CreateEventEx (\r
+                  EVT_NOTIFY_SIGNAL,\r
+                  TPL_NOTIFY,\r
+                  FvbVirtualNotifyEvent,\r
+                  NULL,\r
+                  &gEfiEventVirtualAddressChangeGuid,\r
+                  &mFvbVirtualAddrChangeEvent\r
+                  );\r
+  ASSERT_EFI_ERROR (Status);\r
+\r
   return Status;\r
 }\r