projects / mirror_edk2.git / blame
| Commit | Line | Data |
|---|---|---|
| 632820d1 | 1 | /** @file\r |
| ba0014b9 | 2 | Defines DiskImage - 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 | |
| 56ba3746 | 6 | SPDX-License-Identifier: BSD-2-Clause-Patent\r |
| 632820d1 | 7 | \r |
| 8 | **/\r | |
| 9 | \r | |
| 10 | #ifndef _LIB_DISK_IMAGE_H_\r | |
| 11 | #define _LIB_DISK_IMAGE_H_\r | |
| 12 | \r | |
| 13 | #include "HexEditor.h"\r | |
| 14 | \r | |
| a1d4bfcc | 15 | /**\r |
| 16 | Initialization function for HDiskImage.\r | |
| ba0014b9 | 17 | \r |
| a1d4bfcc | 18 | @retval EFI_SUCCESS The operation was successful.\r |
| a048af3c | 19 | @retval EFI_LOAD_ERROR A load error occurred.\r |
| a1d4bfcc | 20 | **/\r |
| 632820d1 | 21 | EFI_STATUS\r |
| 22 | HDiskImageInit (\r | |
| 23 | VOID\r | |
| 24 | );\r | |
| a1d4bfcc | 25 | \r |
| 26 | /**\r | |
| 27 | Cleanup function for HDiskImage.\r | |
| 28 | \r | |
| 29 | @retval EFI_SUCCESS The operation was successful.\r | |
| 30 | **/\r | |
| 632820d1 | 31 | EFI_STATUS\r |
| 32 | HDiskImageCleanup (\r | |
| 33 | VOID\r | |
| 34 | );\r | |
| a1d4bfcc | 35 | \r |
| 36 | /**\r | |
| ba0014b9 | 37 | Backup function for HDiskImage. Only a few fields need to be backup.\r |
| a1d4bfcc | 38 | This is for making the Disk buffer refresh as few as possible.\r |
| 39 | \r | |
| 40 | @retval EFI_SUCCESS The operation was successful.\r | |
| 41 | @retval EFI_OUT_OF_RESOURCES gST->ConOut of resources.\r | |
| 42 | **/\r | |
| 632820d1 | 43 | EFI_STATUS\r |
| 44 | HDiskImageBackup (\r | |
| 45 | VOID\r | |
| 46 | );\r | |
| 47 | \r | |
| a1d4bfcc | 48 | /**\r |
| 49 | Read a disk from disk into HBufferImage.\r | |
| 50 | \r | |
| 51 | @param[in] DeviceName filename to read.\r | |
| 52 | @param[in] Offset The offset.\r | |
| 53 | @param[in] Size The size.\r | |
| 54 | @param[in] Recover if is for recover, no information print.\r | |
| 55 | \r | |
| 56 | @retval EFI_SUCCESS The operation was successful.\r | |
| 57 | @retval EFI_OUT_OF_RESOURCES A memory allocation failed.\r | |
| a048af3c | 58 | @retval EFI_LOAD_ERROR A load error occurred.\r |
| ba0014b9 | 59 | @retval EFI_INVALID_PARAMETER A parameter was invalid.\r |
| a1d4bfcc | 60 | **/\r |
| 632820d1 | 61 | EFI_STATUS\r |
| 62 | HDiskImageRead (\r | |
| 47d20b54 MK |
63 | IN CONST CHAR16 *DeviceName,\r |
| 64 | IN UINTN Offset,\r | |
| 65 | IN UINTN Size,\r | |
| 66 | IN BOOLEAN Recover\r | |
| 632820d1 | 67 | );\r |
| a1d4bfcc | 68 | \r |
| 69 | /**\r | |
| 70 | Save lines in HBufferImage to disk.\r | |
| 71 | NOT ALLOW TO WRITE TO ANOTHER DISK!!!!!!!!!\r | |
| 72 | \r | |
| 73 | @param[in] DeviceName The device name.\r | |
| 74 | @param[in] Offset The offset.\r | |
| 75 | @param[in] Size The size.\r | |
| 76 | \r | |
| 77 | @retval EFI_SUCCESS The operation was successful.\r | |
| 78 | @retval EFI_OUT_OF_RESOURCES A memory allocation failed.\r | |
| a048af3c | 79 | @retval EFI_LOAD_ERROR A load error occurred.\r |
| ba0014b9 | 80 | @retval EFI_INVALID_PARAMETER A parameter was invalid.\r |
| a1d4bfcc | 81 | **/\r |
| 632820d1 | 82 | EFI_STATUS\r |
| 83 | HDiskImageSave (\r | |
| 47d20b54 MK |
84 | IN CHAR16 *DeviceName,\r |
| 85 | IN UINTN Offset,\r | |
| 86 | IN UINTN Size\r | |
| 632820d1 | 87 | );\r |
| 88 | \r | |
| 89 | #endif\r |