]> git.proxmox.com Git - mirror_edk2.git/blame - ShellPkg/Library/UefiShellDebug1CommandsLib/HexEdit/MemImage.h
ShellPkg: Clean up source files
[mirror_edk2.git] / ShellPkg / Library / UefiShellDebug1CommandsLib / HexEdit / MemImage.h
CommitLineData
632820d1 1/** @file\r
ba0014b9 2 Defines MemImage - the view of the file that is visible at any point,\r
632820d1 3 as well as the event handlers for editing the file\r
ba0014b9
LG
4\r
5 Copyright (c) 2005 - 2018, Intel Corporation. All rights reserved. <BR>\r
632820d1 6 This program and the accompanying materials\r
7 are licensed and made available under the terms and conditions of the BSD License\r
8 which accompanies this distribution. The full text of the license may be found at\r
9 http://opensource.org/licenses/bsd-license.php\r
10\r
11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
13\r
14**/\r
15\r
16#ifndef _LIB_MEM_IMAGE_H_\r
17#define _LIB_MEM_IMAGE_H_\r
18\r
19#include "HexEditor.h"\r
20\r
a1d4bfcc 21/**\r
22 Initialization function for HDiskImage.\r
23\r
24 @retval EFI_SUCCESS The operation was successful.\r
25 @retval EFI_LOAD_ERROR A load error occured.\r
26**/\r
632820d1 27EFI_STATUS\r
28HMemImageInit (\r
29 VOID\r
30 );\r
a1d4bfcc 31\r
32/**\r
ba0014b9 33 Backup function for HDiskImage. Only a few fields need to be backup.\r
a1d4bfcc 34 This is for making the Disk buffer refresh as few as possible.\r
35\r
36 @retval EFI_SUCCESS The operation was successful.\r
37**/\r
632820d1 38EFI_STATUS\r
39HMemImageBackup (\r
40 VOID\r
41 );\r
42\r
a1d4bfcc 43/**\r
44 Set FileName field in HFileImage.\r
45\r
46 @param[in] Offset The offset.\r
47 @param[in] Size The size.\r
48\r
49 @retval EFI_SUCCESS The operation was successful.\r
50 @retval EFI_OUT_OF_RESOURCES A memory allocation failed.\r
51**/\r
632820d1 52EFI_STATUS\r
53HMemImageSetMemOffsetSize (\r
a1d4bfcc 54 IN UINTN Offset,\r
55 IN UINTN Size\r
632820d1 56 );\r
57\r
a1d4bfcc 58/**\r
59 Read a disk from disk into HBufferImage.\r
60\r
61 @param[in] Offset The offset.\r
62 @param[in] Size The size.\r
63 @param[in] Recover if is for recover, no information print.\r
64\r
65 @retval EFI_LOAD_ERROR A load error occured.\r
66 @retval EFI_SUCCESS The operation was successful.\r
67 @retval EFI_OUT_OF_RESOURCES A memory allocation failed.\r
68**/\r
632820d1 69EFI_STATUS\r
70HMemImageRead (\r
a1d4bfcc 71 IN UINTN Offset,\r
72 IN UINTN Size,\r
73 IN BOOLEAN Recover\r
632820d1 74 );\r
a1d4bfcc 75\r
76/**\r
77 Save lines in HBufferImage to disk.\r
78\r
79 @param[in] Offset The offset.\r
80 @param[in] Size The size.\r
81\r
82 @retval EFI_LOAD_ERROR A load error occured.\r
83 @retval EFI_SUCCESS The operation was successful.\r
84 @retval EFI_OUT_OF_RESOURCES A memory allocation failed.\r
85**/\r
632820d1 86EFI_STATUS\r
87HMemImageSave (\r
a1d4bfcc 88 IN UINTN Offset,\r
89 IN UINTN Size\r
632820d1 90 );\r
91\r
92#endif\r