add comments to function declarations and definitions and updated to match coding...

[mirror_edk2.git] / ShellPkg / Library / UefiShellDebug1CommandsLib / HexEdit / MemImage.c

/** @file\r
  Functions to deal with Mem buffer\r
  \r
  Copyright (c) 2005 - 2011, Intel Corporation. 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
#include "HexEditor.h"\r
\r
extern EFI_HANDLE                 HImageHandleBackup;\r
\r
extern HEFI_EDITOR_BUFFER_IMAGE   HBufferImage;\r
\r
extern BOOLEAN                    HBufferImageNeedRefresh;\r
extern BOOLEAN                    HBufferImageOnlyLineNeedRefresh;\r
extern BOOLEAN                    HBufferImageMouseNeedRefresh;\r
\r
extern HEFI_EDITOR_GLOBAL_EDITOR  HMainEditor;\r
\r
HEFI_EDITOR_MEM_IMAGE             HMemImage;\r
HEFI_EDITOR_MEM_IMAGE             HMemImageBackupVar;\r
\r
EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL   DummyPciRootBridgeIo;\r
\r
//\r
// for basic initialization of HDiskImage\r
//\r
HEFI_EDITOR_MEM_IMAGE             HMemImageConst = {\r
  NULL,\r
  0,\r
  0\r
};\r
\r
/**\r
  Empty function.  always returns the same.\r
\r
  @param[in] This       Ignored.\r
  @param[in] Width      Ignored.\r
  @param[in] Address    Ignored.\r
  @param[in] Count      Ignored.\r
  @param[in,out] Buffer Ignored.\r
\r
  @retval EFI_UNSUPPORTED.\r
**/\r
EFI_STATUS\r
DummyMemRead (\r
  IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL              * This,\r
  IN     EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_WIDTH    Width,\r
  IN     UINT64                                   Address,\r
  IN     UINTN                                    Count,\r
  IN OUT VOID                                     *Buffer\r
  )\r
{\r
  return EFI_UNSUPPORTED;\r
}\r
\r
/**\r
  Empty function.  always returns the same.\r
\r
  @param[in] This       Ignored.\r
  @param[in] Width      Ignored.\r
  @param[in] Address    Ignored.\r
  @param[in] Count      Ignored.\r
  @param[in,out] Buffer Ignored.\r
\r
  @retval EFI_UNSUPPORTED.\r
**/\r
EFI_STATUS\r
DummyMemWrite (\r
  IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL              * This,\r
  IN     EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_WIDTH    Width,\r
  IN     UINT64                                   Address,\r
  IN     UINTN                                    Count,\r
  IN OUT VOID                                     *Buffer\r
  )\r
{\r
  return EFI_UNSUPPORTED;\r
}\r
\r
/**\r
  Initialization function for HDiskImage.\r
\r
  @retval EFI_SUCCESS       The operation was successful.\r
  @retval EFI_LOAD_ERROR    A load error occured.\r
**/\r
EFI_STATUS\r
HMemImageInit (\r
  VOID\r
  )\r
{\r
  EFI_STATUS  Status;\r
\r
  //\r
  // basically initialize the HMemImage\r
  //\r
  CopyMem (&HMemImage, &HMemImageConst, sizeof (HMemImage));\r
\r
  Status = gBS->LocateProtocol (\r
                &gEfiPciRootBridgeIoProtocolGuid,\r
                NULL,\r
                (VOID**)&HMemImage.IoFncs\r
                );\r
  if (Status == EFI_NOT_FOUND) {\r
    //\r
    // For NT32, no EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL is available\r
    // Use Dummy PciRootBridgeIo for memory access\r
    //\r
    ZeroMem (&DummyPciRootBridgeIo, sizeof (EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL));\r
    DummyPciRootBridgeIo.Mem.Read  = DummyMemRead;\r
    DummyPciRootBridgeIo.Mem.Write = DummyMemWrite;\r
    HMemImage.IoFncs = &DummyPciRootBridgeIo;\r
    Status = EFI_SUCCESS;\r
  }\r
  if (!EFI_ERROR (Status)) {\r
    return EFI_SUCCESS;\r
  } else {\r
    return EFI_LOAD_ERROR;\r
  }\r
}\r
\r
/**\r
  Backup function for HDiskImage. Only a few fields need to be backup. \r
  This is for making the Disk buffer refresh as few as possible.\r
\r
  @retval EFI_SUCCESS       The operation was successful.\r
**/\r
EFI_STATUS\r
HMemImageBackup (\r
  VOID\r
  )\r
{\r
  HMemImageBackupVar.Offset = HMemImage.Offset;\r
  HMemImageBackupVar.Size   = HMemImage.Size;\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Set FileName field in HFileImage.\r
\r
  @param[in] Offset   The offset.\r
  @param[in] Size     The size.\r
\r
  @retval EFI_SUCCESS           The operation was successful.\r
  @retval EFI_OUT_OF_RESOURCES  A memory allocation failed.\r
**/\r
EFI_STATUS\r
HMemImageSetMemOffsetSize (\r
  IN UINTN Offset,\r
  IN UINTN Size\r
  )\r
{\r
\r
  HMemImage.Offset  = Offset;\r
  HMemImage.Size    = Size;\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Read a disk from disk into HBufferImage.\r
\r
  @param[in] Offset   The offset.\r
  @param[in] Size     The size.\r
  @param[in] Recover  if is for recover, no information print.\r
\r
  @retval EFI_LOAD_ERROR        A load error occured.\r
  @retval EFI_SUCCESS           The operation was successful.\r
  @retval EFI_OUT_OF_RESOURCES  A memory allocation failed.\r
**/\r
EFI_STATUS\r
HMemImageRead (\r
  IN UINTN     Offset,\r
  IN UINTN     Size,\r
  IN BOOLEAN   Recover\r
  )\r
{\r
\r
  EFI_STATUS                      Status;\r
  void                            *Buffer;\r
  CHAR16                          *Str;\r
  HEFI_EDITOR_LINE                *Line;\r
\r
  EDIT_FILE_TYPE                  BufferTypeBackup;\r
\r
  BufferTypeBackup        = HBufferImage.BufferType;\r
  HBufferImage.BufferType = FileTypeMemBuffer;\r
\r
  Buffer                  = AllocateZeroPool (Size);\r
  if (Buffer == NULL) {\r
    StatusBarSetStatusString (L"Read Memory Failed");\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
\r
  Status = HMemImage.IoFncs->Mem.Read (\r
                                  HMemImage.IoFncs,\r
                                  EfiPciWidthUint8,\r
                                  Offset,\r
                                  Size,\r
                                  Buffer\r
                                  );\r
\r
  if (EFI_ERROR (Status)) {\r
    FreePool (Buffer);\r
    StatusBarSetStatusString (L"Memory Specified Not Accessible");\r
    return EFI_LOAD_ERROR;\r
  }\r
\r
  HBufferImageFree ();\r
\r
  Status = HBufferImageBufferToList (Buffer, Size);\r
  FreePool (Buffer);\r
\r
  if (EFI_ERROR (Status)) {\r
    StatusBarSetStatusString (L"Read Memory Failed");\r
    return Status;\r
  }\r
\r
  Status  = HMemImageSetMemOffsetSize (Offset, Size);\r
\r
  HBufferImage.DisplayPosition.Row    = 2;\r
  HBufferImage.DisplayPosition.Column = 10;\r
\r
  HBufferImage.MousePosition.Row      = 2;\r
  HBufferImage.MousePosition.Column   = 10;\r
\r
  HBufferImage.LowVisibleRow          = 1;\r
  HBufferImage.HighBits               = TRUE;\r
\r
  HBufferImage.BufferPosition.Row     = 1;\r
  HBufferImage.BufferPosition.Column  = 1;\r
\r
  if (!Recover) {\r
    Str = CatSPrint(NULL, L"%d Lines Read", HBufferImage.NumLines);\r
    if (Str == NULL) {\r
      StatusBarSetStatusString (L"Read Memory Failed");\r
      return EFI_OUT_OF_RESOURCES;\r
    }\r
\r
    StatusBarSetStatusString (Str);\r
    SHELL_FREE_NON_NULL (Str);\r
\r
    HMainEditor.SelectStart = 0;\r
    HMainEditor.SelectEnd   = 0;\r
\r
  }\r
\r
  //\r
  // has line\r
  //\r
  if (HBufferImage.Lines != NULL) {\r
    HBufferImage.CurrentLine = CR (HBufferImage.ListHead->ForwardLink, HEFI_EDITOR_LINE, Link, EFI_EDITOR_LINE_LIST);\r
  } else {\r
    //\r
    // create a dummy line\r
    //\r
    Line = HBufferImageCreateLine ();\r
    if (Line == NULL) {\r
      StatusBarSetStatusString (L"Read Memory Failed");\r
      return EFI_OUT_OF_RESOURCES;\r
    }\r
\r
    HBufferImage.CurrentLine = Line;\r
  }\r
\r
  HBufferImage.Modified           = FALSE;\r
  HBufferImageNeedRefresh         = TRUE;\r
  HBufferImageOnlyLineNeedRefresh = FALSE;\r
  HBufferImageMouseNeedRefresh    = TRUE;\r
\r
  return EFI_SUCCESS;\r
\r
}\r
\r
/**\r
  Save lines in HBufferImage to disk.\r
\r
  @param[in] Offset   The offset.\r
  @param[in] Size     The size.\r
\r
  @retval EFI_LOAD_ERROR        A load error occured.\r
  @retval EFI_SUCCESS           The operation was successful.\r
  @retval EFI_OUT_OF_RESOURCES  A memory allocation failed.\r
**/\r
EFI_STATUS\r
HMemImageSave (\r
  IN UINTN Offset,\r
  IN UINTN Size\r
  )\r
{\r
\r
  EFI_STATUS                      Status;\r
  VOID                            *Buffer;\r
\r
  EDIT_FILE_TYPE                  BufferTypeBackup;\r
\r
  //\r
  // not modified, so directly return\r
  //\r
  if (HBufferImage.Modified == FALSE) {\r
    return EFI_SUCCESS;\r
  }\r
\r
  BufferTypeBackup        = HBufferImage.BufferType;\r
  HBufferImage.BufferType = FileTypeMemBuffer;\r
\r
  Buffer                  = AllocateZeroPool (Size);\r
\r
  if (Buffer == NULL) {\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
\r
  Status = HBufferImageListToBuffer (Buffer, Size);\r
  if (EFI_ERROR (Status)) {\r
    FreePool (Buffer);\r
    return Status;\r
  }\r
  //\r
  // write back to memory\r
  //\r
  Status = HMemImage.IoFncs->Mem.Write (\r
                                  HMemImage.IoFncs,\r
                                  EfiPciWidthUint8,\r
                                  Offset,\r
                                  Size,\r
                                  Buffer\r
                                  );\r
\r
  FreePool (Buffer);\r
\r
  if (EFI_ERROR (Status)) {\r
    return EFI_LOAD_ERROR;\r
  }\r
  //\r
  // now not modified\r
  //\r
  HBufferImage.Modified = FALSE;\r
\r
  return EFI_SUCCESS;\r
}\r
\r
\r