ShellPkg/for: Fix potential null pointer deference

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

diff --git a/ShellPkg/Library/UefiShellDebug1CommandsLib/HexEdit/MemImage.h b/ShellPkg/Library/UefiShellDebug1CommandsLib/HexEdit/MemImage.h
index 8805c0d75d3d0c27255dc98bd124fcc16c14191a..54fe517858d96710d0ab657f014666e5d79f4c23 100644 (file)
--- a/ShellPkg/Library/UefiShellDebug1CommandsLib/HexEdit/MemImage.h
+++ b/ShellPkg/Library/UefiShellDebug1CommandsLib/HexEdit/MemImage.h
@@ -18,35 +18,75 @@
 \r
 #include "HexEditor.h"\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
-EFI_STATUS\r
-HMemImageCleanup (\r
-  VOID\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
+/**\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,\r
-  IN UINTN\r
+  IN UINTN Offset,\r
+  IN UINTN Size\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,\r
-  IN UINTN,\r
-  IN BOOLEAN\r
+  IN UINTN     Offset,\r
+  IN UINTN     Size,\r
+  IN BOOLEAN   Recover\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,\r
-  IN UINTN\r
+  IN UINTN Offset,\r
+  IN UINTN Size\r
   );\r
 \r
 #endif\r