Add a tempate for a RealView FVB for the variable services.
authorandrewfish <andrewfish@6f19259b-4bc3-4df7-8a09-765794883524>
Thu, 8 Jul 2010 00:39:11 +0000 (00:39 +0000)
committerandrewfish <andrewfish@6f19259b-4bc3-4df7-8a09-765794883524>
Thu, 8 Jul 2010 00:39:11 +0000 (00:39 +0000)
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@10638 6f19259b-4bc3-4df7-8a09-765794883524

ArmRealViewEbPkg/ArmRealViewEbPkg.dsc
ArmRealViewEbPkg/FvbDxe/FvbDxe.c [new file with mode: 0755]
ArmRealViewEbPkg/FvbDxe/FvbDxe.inf [new file with mode: 0755]

index 0ffb819..e8f3ed8 100755 (executable)
@@ -376,6 +376,7 @@ MdeModulePkg/Core/DxeIplPeim/DxeIpl.inf
   EmbeddedPkg/RealTimeClockRuntimeDxe/RealTimeClockRuntimeDxe.inf\r
   EmbeddedPkg/MetronomeDxe/MetronomeDxe.inf\r
 \r
+  ArmRealViewEbPkg/FvbDxe/FvbDxe.inf\r
   ArmRealViewEbPkg/InterruptDxe/InterruptDxe.inf\r
   ArmRealViewEbPkg/TimerDxe/TimerDxe.inf\r
 \r
diff --git a/ArmRealViewEbPkg/FvbDxe/FvbDxe.c b/ArmRealViewEbPkg/FvbDxe/FvbDxe.c
new file mode 100755 (executable)
index 0000000..38bd2ed
--- /dev/null
@@ -0,0 +1,417 @@
+/*++\r
+RealView EB FVB DXE Driver\r
+\r
+Copyright (c) 2010, Apple Inc. All rights reserved.<BR>                                                         \r
+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
+\r
+--*/\r
+\r
+#include <PiDxe.h>\r
+\r
+#include <Library/BaseLib.h>\r
+#include <Library/DebugLib.h>\r
+#include <Library/BaseMemoryLib.h>\r
+#include <Library/UefiBootServicesTableLib.h>\r
+#include <Library/UefiLib.h>\r
+#include <Library/PcdLib.h>\r
+\r
+#include <Protocol/FirmwareVolumeBlock.h>\r
+\r
+\r
+\r
+/**\r
+  The GetAttributes() function retrieves the attributes and\r
+  current settings of the block.\r
+\r
+  @param This       Indicates the EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL instance.\r
+\r
+  @param Attributes Pointer to EFI_FVB_ATTRIBUTES_2 in which the\r
+                    attributes and current settings are\r
+                    returned. Type EFI_FVB_ATTRIBUTES_2 is defined\r
+                    in EFI_FIRMWARE_VOLUME_HEADER.\r
+\r
+  @retval EFI_SUCCESS The firmware volume attributes were\r
+                      returned.\r
+\r
+**/\r
+\r
+EFI_STATUS\r
+EFIAPI\r
+FvbGetAttributes (\r
+  IN CONST  EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL *This,\r
+  OUT       EFI_FVB_ATTRIBUTES_2                *Attributes\r
+  )\r
+{\r
+  return EFI_UNSUPPORTED;\r
+}\r
+\r
+\r
+/**\r
+  The SetAttributes() function sets configurable firmware volume\r
+  attributes and returns the new settings of the firmware volume.\r
+  \r
+\r
+  @param This         Indicates the EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL instance.\r
+\r
+  @param Attributes   On input, Attributes is a pointer to\r
+                      EFI_FVB_ATTRIBUTES_2 that contains the\r
+                      desired firmware volume settings. On\r
+                      successful return, it contains the new\r
+                      settings of the firmware volume. Type\r
+                      EFI_FVB_ATTRIBUTES_2 is defined in\r
+                      EFI_FIRMWARE_VOLUME_HEADER.\r
+  \r
+  @retval EFI_SUCCESS           The firmware volume attributes were returned.\r
+\r
+  @retval EFI_INVALID_PARAMETER The attributes requested are in\r
+                                conflict with the capabilities\r
+                                as declared in the firmware\r
+                                volume header.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+FvbSetAttributes (\r
+  IN CONST  EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL *This,\r
+  IN OUT    EFI_FVB_ATTRIBUTES_2                *Attributes\r
+  )\r
+{\r
+  return EFI_UNSUPPORTED;\r
+}\r
+\r
+\r
+/**\r
+  The GetPhysicalAddress() function retrieves the base address of\r
+  a memory-mapped firmware volume. This function should be called\r
+  only for memory-mapped firmware volumes.\r
+\r
+  @param This     Indicates the EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL instance.\r
+  \r
+  @param Address  Pointer to a caller-allocated\r
+                  EFI_PHYSICAL_ADDRESS that, on successful\r
+                  return from GetPhysicalAddress(), contains the\r
+                  base address of the firmware volume.\r
+  \r
+  @retval EFI_SUCCESS       The firmware volume base address was returned.\r
+  \r
+  @retval EFI_NOT_SUPPORTED The firmware volume is not memory mapped.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+FvbGetPhysicalAddress (\r
+  IN CONST  EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL *This,\r
+  OUT       EFI_PHYSICAL_ADDRESS                *Address\r
+  )\r
+{\r
+  return EFI_UNSUPPORTED;\r
+}\r
+\r
+\r
+/**\r
+  The GetBlockSize() function retrieves the size of the requested\r
+  block. It also returns the number of additional blocks with\r
+  the identical size. The GetBlockSize() function is used to\r
+  retrieve the block map (see EFI_FIRMWARE_VOLUME_HEADER).\r
+\r
+\r
+  @param This           Indicates the EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL instance.\r
+\r
+  @param Lba            Indicates the block for which to return the size.\r
+\r
+  @param BlockSize      Pointer to a caller-allocated UINTN in which\r
+                        the size of the block is returned.\r
+\r
+  @param NumberOfBlocks Pointer to a caller-allocated UINTN in\r
+                        which the number of consecutive blocks,\r
+                        starting with Lba, is returned. All\r
+                        blocks in this range have a size of\r
+                        BlockSize.\r
+\r
+  \r
+  @retval EFI_SUCCESS             The firmware volume base address was returned.\r
+  \r
+  @retval EFI_INVALID_PARAMETER   The requested LBA is out of range.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+FvbGetBlockSize (\r
+  IN CONST  EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL *This,\r
+  IN        EFI_LBA                             Lba,\r
+  OUT       UINTN                               *BlockSize,\r
+  OUT       UINTN                               *NumberOfBlocks\r
+  )\r
+{\r
+  return EFI_UNSUPPORTED;\r
+}\r
+\r
+\r
+\r
+/**\r
+  Reads the specified number of bytes into a buffer from the specified block.\r
+\r
+  The Read() function reads the requested number of bytes from the\r
+  requested block and stores them in the provided buffer.\r
+  Implementations should be mindful that the firmware volume\r
+  might be in the ReadDisabled state. If it is in this state,\r
+  the Read() function must return the status code\r
+  EFI_ACCESS_DENIED without modifying the contents of the\r
+  buffer. The Read() function must also prevent spanning block\r
+  boundaries. If a read is requested that would span a block\r
+  boundary, the read must read up to the boundary but not\r
+  beyond. The output parameter NumBytes must be set to correctly\r
+  indicate the number of bytes actually read. The caller must be\r
+  aware that a read may be partially completed.\r
+\r
+  @param This     Indicates the EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL instance.\r
+  \r
+  @param Lba      The starting logical block index\r
+                  from which to read.\r
+\r
+  @param Offset   Offset into the block at which to begin reading.\r
+\r
+  @param NumBytes Pointer to a UINTN. At entry, *NumBytes\r
+                  contains the total size of the buffer. At\r
+                  exit, *NumBytes contains the total number of\r
+                  bytes read.\r
+\r
+  @param Buffer   Pointer to a caller-allocated buffer that will\r
+                  be used to hold the data that is read.\r
+\r
+  @retval EFI_SUCCESS         The firmware volume was read successfully,\r
+                              and contents are in Buffer.\r
+  \r
+  @retval EFI_BAD_BUFFER_SIZE Read attempted across an LBA\r
+                              boundary. On output, NumBytes\r
+                              contains the total number of bytes\r
+                              returned in Buffer.\r
+  \r
+  @retval EFI_ACCESS_DENIED   The firmware volume is in the\r
+                              ReadDisabled state.\r
+  \r
+  @retval EFI_DEVICE_ERROR    The block device is not\r
+                              functioning correctly and could\r
+                              not be read.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+FvbRead (\r
+  IN CONST  EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL *This,\r
+  IN        EFI_LBA                             Lba,\r
+  IN        UINTN                               Offset,\r
+  IN OUT    UINTN                               *NumBytes,\r
+  IN OUT    UINT8                               *Buffer\r
+  )\r
+{\r
+  return EFI_UNSUPPORTED;\r
+}\r
+\r
+\r
+/**\r
+  Writes the specified number of bytes from the input buffer to the block.\r
+\r
+  The Write() function writes the specified number of bytes from\r
+  the provided buffer to the specified block and offset. If the\r
+  firmware volume is sticky write, the caller must ensure that\r
+  all the bits of the specified range to write are in the\r
+  EFI_FVB_ERASE_POLARITY state before calling the Write()\r
+  function, or else the result will be unpredictable. This\r
+  unpredictability arises because, for a sticky-write firmware\r
+  volume, a write may negate a bit in the EFI_FVB_ERASE_POLARITY\r
+  state but cannot flip it back again.  Before calling the\r
+  Write() function,  it is recommended for the caller to first call \r
+  the EraseBlocks() function to erase the specified block to\r
+  write. A block erase cycle will transition bits from the\r
+  (NOT)EFI_FVB_ERASE_POLARITY state back to the\r
+  EFI_FVB_ERASE_POLARITY state. Implementations should be\r
+  mindful that the firmware volume might be in the WriteDisabled\r
+  state. If it is in this state, the Write() function must\r
+  return the status code EFI_ACCESS_DENIED without modifying the\r
+  contents of the firmware volume. The Write() function must\r
+  also prevent spanning block boundaries. If a write is\r
+  requested that spans a block boundary, the write must store up\r
+  to the boundary but not beyond. The output parameter NumBytes\r
+  must be set to correctly indicate the number of bytes actually\r
+  written. The caller must be aware that a write may be\r
+  partially completed. All writes, partial or otherwise, must be\r
+  fully flushed to the hardware before the Write() service\r
+  returns.\r
+\r
+  @param This     Indicates the EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL instance.\r
+  \r
+  @param Lba      The starting logical block index to write to.\r
+  \r
+  @param Offset   Offset into the block at which to begin writing.\r
+  \r
+  @param NumBytes The pointer to a UINTN. At entry, *NumBytes\r
+                  contains the total size of the buffer. At\r
+                  exit, *NumBytes contains the total number of\r
+                  bytes actually written.\r
+  \r
+  @param Buffer   The pointer to a caller-allocated buffer that\r
+                  contains the source for the write.\r
+  \r
+  @retval EFI_SUCCESS         The firmware volume was written successfully.\r
+  \r
+  @retval EFI_BAD_BUFFER_SIZE The write was attempted across an\r
+                              LBA boundary. On output, NumBytes\r
+                              contains the total number of bytes\r
+                              actually written.\r
+  \r
+  @retval EFI_ACCESS_DENIED   The firmware volume is in the\r
+                              WriteDisabled state.\r
+  \r
+  @retval EFI_DEVICE_ERROR    The block device is malfunctioning\r
+                              and could not be written.\r
+\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+FvbWrite (\r
+  IN CONST  EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL *This,\r
+  IN        EFI_LBA                             Lba,\r
+  IN        UINTN                               Offset,\r
+  IN OUT    UINTN                               *NumBytes,\r
+  IN        UINT8                               *Buffer\r
+  )\r
+{\r
+  return EFI_UNSUPPORTED;\r
+}\r
+\r
+\r
+/**\r
+  Erases and initializes a firmware volume block.\r
+\r
+  The EraseBlocks() function erases one or more blocks as denoted\r
+  by the variable argument list. The entire parameter list of\r
+  blocks must be verified before erasing any blocks. If a block is\r
+  requested that does not exist within the associated firmware\r
+  volume (it has a larger index than the last block of the\r
+  firmware volume), the EraseBlocks() function must return the\r
+  status code EFI_INVALID_PARAMETER without modifying the contents\r
+  of the firmware volume. Implementations should be mindful that\r
+  the firmware volume might be in the WriteDisabled state. If it\r
+  is in this state, the EraseBlocks() function must return the\r
+  status code EFI_ACCESS_DENIED without modifying the contents of\r
+  the firmware volume. All calls to EraseBlocks() must be fully\r
+  flushed to the hardware before the EraseBlocks() service\r
+  returns.\r
+\r
+  @param This   Indicates the EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL\r
+                instance.\r
+\r
+  @param ...    The variable argument list is a list of tuples.\r
+                Each tuple describes a range of LBAs to erase\r
+                and consists of the following:\r
+                - An EFI_LBA that indicates the starting LBA\r
+                - A UINTN that indicates the number of blocks to\r
+                  erase.\r
+\r
+                The list is terminated with an\r
+                EFI_LBA_LIST_TERMINATOR. For example, the\r
+                following indicates that two ranges of blocks\r
+                (5-7 and 10-11) are to be erased: EraseBlocks\r
+                (This, 5, 3, 10, 2, EFI_LBA_LIST_TERMINATOR);\r
+\r
+  @retval EFI_SUCCESS The erase request successfully\r
+                      completed.\r
+  \r
+  @retval EFI_ACCESS_DENIED   The firmware volume is in the\r
+                              WriteDisabled state.\r
+  @retval EFI_DEVICE_ERROR  The block device is not functioning\r
+                            correctly and could not be written.\r
+                            The firmware device may have been\r
+                            partially erased.\r
+  @retval EFI_INVALID_PARAMETER One or more of the LBAs listed\r
+                                in the variable argument list do\r
+                                not exist in the firmware volume.  \r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+FvbEraseBlocks (\r
+  IN CONST  EFI_FIRMWARE_VOLUME_BLOCK2_PROTOCOL *This,\r
+  ...\r
+  )\r
+{\r
+  return EFI_UNSUPPORTED;\r
+}\r
+\r
+\r
+//\r
+// Making this global saves a few bytes in image size\r
+//\r
+EFI_HANDLE  gFvbHandle = NULL;\r
+\r
+\r
+///\r
+/// The Firmware Volume Block Protocol is the low-level interface\r
+/// to a firmware volume. File-level access to a firmware volume\r
+/// should not be done using the Firmware Volume Block Protocol.\r
+/// Normal access to a firmware volume must use the Firmware\r
+/// Volume Protocol. Typically, only the file system driver that\r
+/// produces the Firmware Volume Protocol will bind to the\r
+/// Firmware Volume Block Protocol.\r
+///\r
+EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL gFvbProtocol = {\r
+  FvbGetAttributes,\r
+  FvbSetAttributes,\r
+  FvbGetPhysicalAddress,\r
+  FvbGetBlockSize,\r
+  FvbRead,\r
+  FvbWrite,\r
+  FvbEraseBlocks,\r
+  ///\r
+  /// The handle of the parent firmware volume.\r
+  ///  \r
+  NULL\r
+};\r
+\r
+//     NvStorageVariableBase = (EFI_PHYSICAL_ADDRESS) FixedPcdGet32 (PcdFlashNvStorageVariableBase);\r
+\r
+\r
+/**\r
+  Initialize the state information for the CPU Architectural Protocol\r
+\r
+  @param  ImageHandle   of the loaded driver\r
+  @param  SystemTable   Pointer to the System Table\r
+\r
+  @retval EFI_SUCCESS           Protocol registered\r
+  @retval EFI_OUT_OF_RESOURCES  Cannot allocate protocol data structure\r
+  @retval EFI_DEVICE_ERROR      Hardware problems\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+FvbDxeInitialize (\r
+  IN EFI_HANDLE         ImageHandle,\r
+  IN EFI_SYSTEM_TABLE   *SystemTable\r
+  )\r
+{\r
+  EFI_STATUS  Status;\r
+\r
+  \r
+  Status = gBS->InstallMultipleProtocolInterfaces (\r
+                  &gFvbHandle,\r
+                  &gEfiFirmwareVolumeBlockProtocolGuid,   &gFvbProtocol,\r
+                  NULL\r
+                  );\r
+  ASSERT_EFI_ERROR (Status);\r
+  \r
+  // SetVertAddressEvent ()\r
+  \r
+  // GCD Map NAND as RT\r
+  \r
+  return Status;\r
+}\r
+\r
diff --git a/ArmRealViewEbPkg/FvbDxe/FvbDxe.inf b/ArmRealViewEbPkg/FvbDxe/FvbDxe.inf
new file mode 100755 (executable)
index 0000000..96cc5d3
--- /dev/null
@@ -0,0 +1,53 @@
+#/** @file\r
+#  \r
+#  Copyright (c) 2008 - 2010, Apple Inc. All rights reserved.<BR>\r
+#  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
+#**/\r
+\r
+[Defines]\r
+  INF_VERSION                    = 0x00010005\r
+  BASE_NAME                      = FvbDxe\r
+  FILE_GUID                      = 43ECE281-D9E2-4DD0-B304-E6A5689256F4\r
+  MODULE_TYPE                    = DXE_RUNTIME_DRIVER\r
+  VERSION_STRING                 = 1.0\r
+\r
+  ENTRY_POINT                    = FvbDxeInitialize\r
+\r
+\r
+[Sources.common]\r
+  FvbDxe.c\r
+\r
+[Packages]\r
+  MdePkg/MdePkg.dec\r
+  MdeModulePkg/MdeModulePkg.dec\r
+  EmbeddedPkg/EmbeddedPkg.dec\r
+  ArmRealViewEbPkg/ArmRealViewEbPkg.dec\r
+\r
+[LibraryClasses]\r
+  BaseLib\r
+  UefiLib\r
+  UefiBootServicesTableLib\r
+  DebugLib\r
+  PrintLib\r
+  UefiDriverEntryPoint\r
+  IoLib\r
+\r
+[Guids]\r
+  \r
+\r
+[Protocols]\r
+  gEfiFirmwareVolumeBlockProtocolGuid\r
+\r
+[FixedPcd.common]\r
+  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageVariableSize\r
+  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageVariableBase\r
+\r
+[depex]\r
+  TRUE\r