add comments to function declarations and definitions and updated to match coding style document.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@11505 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
@ -18,35 +18,75 @@
|
||||
|
||||
#include "HexEditor.h"
|
||||
|
||||
/**
|
||||
Initialization function for HDiskImage.
|
||||
|
||||
@retval EFI_SUCCESS The operation was successful.
|
||||
@retval EFI_LOAD_ERROR A load error occured.
|
||||
**/
|
||||
EFI_STATUS
|
||||
HMemImageInit (
|
||||
VOID
|
||||
);
|
||||
EFI_STATUS
|
||||
HMemImageCleanup (
|
||||
VOID
|
||||
);
|
||||
|
||||
/**
|
||||
Backup function for HDiskImage. Only a few fields need to be backup.
|
||||
This is for making the Disk buffer refresh as few as possible.
|
||||
|
||||
@retval EFI_SUCCESS The operation was successful.
|
||||
**/
|
||||
EFI_STATUS
|
||||
HMemImageBackup (
|
||||
VOID
|
||||
);
|
||||
|
||||
/**
|
||||
Set FileName field in HFileImage.
|
||||
|
||||
@param[in] Offset The offset.
|
||||
@param[in] Size The size.
|
||||
|
||||
@retval EFI_SUCCESS The operation was successful.
|
||||
@retval EFI_OUT_OF_RESOURCES A memory allocation failed.
|
||||
**/
|
||||
EFI_STATUS
|
||||
HMemImageSetMemOffsetSize (
|
||||
IN UINTN,
|
||||
IN UINTN
|
||||
IN UINTN Offset,
|
||||
IN UINTN Size
|
||||
);
|
||||
|
||||
/**
|
||||
Read a disk from disk into HBufferImage.
|
||||
|
||||
@param[in] Offset The offset.
|
||||
@param[in] Size The size.
|
||||
@param[in] Recover if is for recover, no information print.
|
||||
|
||||
@retval EFI_LOAD_ERROR A load error occured.
|
||||
@retval EFI_SUCCESS The operation was successful.
|
||||
@retval EFI_OUT_OF_RESOURCES A memory allocation failed.
|
||||
**/
|
||||
EFI_STATUS
|
||||
HMemImageRead (
|
||||
IN UINTN,
|
||||
IN UINTN,
|
||||
IN BOOLEAN
|
||||
IN UINTN Offset,
|
||||
IN UINTN Size,
|
||||
IN BOOLEAN Recover
|
||||
);
|
||||
|
||||
/**
|
||||
Save lines in HBufferImage to disk.
|
||||
|
||||
@param[in] Offset The offset.
|
||||
@param[in] Size The size.
|
||||
|
||||
@retval EFI_LOAD_ERROR A load error occured.
|
||||
@retval EFI_SUCCESS The operation was successful.
|
||||
@retval EFI_OUT_OF_RESOURCES A memory allocation failed.
|
||||
**/
|
||||
EFI_STATUS
|
||||
HMemImageSave (
|
||||
IN UINTN,
|
||||
IN UINTN
|
||||
IN UINTN Offset,
|
||||
IN UINTN Size
|
||||
);
|
||||
|
||||
#endif
|
||||
|
Reference in New Issue
Block a user