ShellPkg/Library/UefiShellDebug1CommandsLib/Dblk.c

   1 /** @file
   2   Main file for Dblk shell Debug1 function.
   3
   4   (C) Copyright 2015 Hewlett-Packard Development Company, L.P.<BR>
   5   Copyright (c) 2005 - 2018, Intel Corporation. All rights reserved.<BR>
   6   SPDX-License-Identifier: BSD-2-Clause-Patent
   7
   8 **/
   9
  10 #include "UefiShellDebug1CommandsLib.h"
  11 #include <Protocol/BlockIo.h>
  12
  13 /**
  14   Display blocks to the screen.
  15
  16   @param[in] DevPath      The device path to get the blocks from.
  17   @param[in] Lba          The Lba number to start from.
  18   @param[in] BlockCount   How many blocks to display.
  19
  20   @retval SHELL_SUCCESS   The display was successful.
  21 **/
  22 SHELL_STATUS
  23 DisplayTheBlocks (
  24   IN CONST EFI_DEVICE_PATH_PROTOCOL  *DevPath,
  25   IN CONST UINT64                    Lba,
  26   IN CONST UINT8                     BlockCount
  27   )
  28 {
  29   EFI_BLOCK_IO_PROTOCOL  *BlockIo;
  30   EFI_HANDLE             BlockIoHandle;
  31   EFI_STATUS             Status;
  32   SHELL_STATUS           ShellStatus;
  33   UINT8                  *Buffer;
  34   UINT8                  *OriginalBuffer;
  35   UINTN                  BufferSize;
  36
  37   ShellStatus = SHELL_SUCCESS;
  38
  39   Status = gBS->LocateDevicePath (&gEfiBlockIoProtocolGuid, (EFI_DEVICE_PATH_PROTOCOL **)&DevPath, &BlockIoHandle);
  40   if (EFI_ERROR (Status)) {
  41     return (SHELL_NOT_FOUND);
  42   }
  43
  44   Status = gBS->OpenProtocol (BlockIoHandle, &gEfiBlockIoProtocolGuid, (VOID **)&BlockIo, gImageHandle, NULL, EFI_OPEN_PROTOCOL_GET_PROTOCOL);
  45   if (EFI_ERROR (Status)) {
  46     return (SHELL_NOT_FOUND);
  47   }
  48
  49   BufferSize = BlockIo->Media->BlockSize * BlockCount;
  50   if (BlockIo->Media->IoAlign == 0) {
  51     BlockIo->Media->IoAlign = 1;
  52   }
  53
  54   if (BufferSize > 0) {
  55     OriginalBuffer = AllocateZeroPool (BufferSize + BlockIo->Media->IoAlign);
  56     Buffer         = ALIGN_POINTER (OriginalBuffer, BlockIo->Media->IoAlign);
  57   } else {
  58     ShellPrintEx (-1, -1, L"  BlockSize: 0x%08x, BlockCount: 0x%08x\r\n", BlockIo->Media->BlockSize, BlockCount);
  59     OriginalBuffer = NULL;
  60     Buffer         = NULL;
  61   }
  62
  63   Status = BlockIo->ReadBlocks (BlockIo, BlockIo->Media->MediaId, Lba, BufferSize, Buffer);
  64   if (!EFI_ERROR (Status) && (Buffer != NULL)) {
  65     ShellPrintHiiEx (
  66       -1,
  67       -1,
  68       NULL,
  69       STRING_TOKEN (STR_DBLK_HEADER),
  70       gShellDebug1HiiHandle,
  71       Lba,
  72       BufferSize,
  73       BlockIo
  74       );
  75
  76     DumpHex (2, 0, BufferSize, Buffer);
  77   } else {
  78     ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_FILE_READ_FAIL), gShellDebug1HiiHandle, L"dblk", L"BlockIo");
  79     ShellStatus = SHELL_DEVICE_ERROR;
  80   }
  81
  82   if (OriginalBuffer != NULL) {
  83     FreePool (OriginalBuffer);
  84   }
  85
  86   gBS->CloseProtocol (BlockIoHandle, &gEfiBlockIoProtocolGuid, gImageHandle, NULL);
  87   return (ShellStatus);
  88 }
  89
  90 /**
  91   Function for 'dblk' command.
  92
  93   @param[in] ImageHandle  Handle to the Image (NULL if Internal).
  94   @param[in] SystemTable  Pointer to the System Table (NULL if Internal).
  95 **/
  96 SHELL_STATUS
  97 EFIAPI
  98 ShellCommandRunDblk (
  99   IN EFI_HANDLE        ImageHandle,
 100   IN EFI_SYSTEM_TABLE  *SystemTable
 101   )
 102 {
 103   EFI_STATUS                Status;
 104   LIST_ENTRY                *Package;
 105   CHAR16                    *ProblemParam;
 106   SHELL_STATUS              ShellStatus;
 107   CONST CHAR16              *BlockName;
 108   CONST CHAR16              *LbaString;
 109   CONST CHAR16              *BlockCountString;
 110   UINT64                    Lba;
 111   UINT64                    BlockCount;
 112   EFI_DEVICE_PATH_PROTOCOL  *DevPath;
 113
 114   ShellStatus = SHELL_SUCCESS;
 115   Status      = EFI_SUCCESS;
 116
 117   //
 118   // initialize the shell lib (we must be in non-auto-init...)
 119   //
 120   Status = ShellInitialize ();
 121   ASSERT_EFI_ERROR (Status);
 122
 123   Status = CommandInit ();
 124   ASSERT_EFI_ERROR (Status);
 125
 126   //
 127   // parse the command line
 128   //
 129   Status = ShellCommandLineParse (EmptyParamList, &Package, &ProblemParam, TRUE);
 130   if (EFI_ERROR (Status)) {
 131     if ((Status == EFI_VOLUME_CORRUPTED) && (ProblemParam != NULL)) {
 132       ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_GEN_PROBLEM), gShellDebug1HiiHandle, L"dblk", ProblemParam);
 133       FreePool (ProblemParam);
 134       ShellStatus = SHELL_INVALID_PARAMETER;
 135     } else {
 136       ASSERT (FALSE);
 137     }
 138   } else {
 139     if (ShellCommandLineGetCount (Package) > 4) {
 140       ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_GEN_TOO_MANY), gShellDebug1HiiHandle, L"dblk");
 141       ShellStatus = SHELL_INVALID_PARAMETER;
 142     } else if (ShellCommandLineGetCount (Package) < 2) {
 143       ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_GEN_TOO_FEW), gShellDebug1HiiHandle, L"dblk");
 144       ShellStatus = SHELL_INVALID_PARAMETER;
 145     } else {
 146       //
 147       // Parse the params
 148       //
 149       BlockName        = ShellCommandLineGetRawValue (Package, 1);
 150       LbaString        = ShellCommandLineGetRawValue (Package, 2);
 151       BlockCountString = ShellCommandLineGetRawValue (Package, 3);
 152
 153       if (LbaString == NULL) {
 154         Lba = 0;
 155       } else {
 156         if (!ShellIsHexOrDecimalNumber (LbaString, TRUE, FALSE)) {
 157           ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_GEN_PARAM_INV), gShellDebug1HiiHandle, L"dblk", LbaString);
 158           ShellStatus = SHELL_INVALID_PARAMETER;
 159         }
 160
 161         ShellConvertStringToUint64 (LbaString, &Lba, TRUE, FALSE);
 162       }
 163
 164       if (BlockCountString == NULL) {
 165         BlockCount = 1;
 166       } else {
 167         if (!ShellIsHexOrDecimalNumber (BlockCountString, TRUE, FALSE)) {
 168           ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_GEN_PARAM_INV), gShellDebug1HiiHandle, L"dblk", BlockCountString);
 169           ShellStatus = SHELL_INVALID_PARAMETER;
 170         }
 171
 172         ShellConvertStringToUint64 (BlockCountString, &BlockCount, TRUE, FALSE);
 173         if (BlockCount > 0x10) {
 174           BlockCount = 0x10;
 175         } else if (BlockCount == 0) {
 176           ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_GEN_PARAM_INV), gShellDebug1HiiHandle, L"dblk", BlockCountString);
 177           ShellStatus = SHELL_INVALID_PARAMETER;
 178         }
 179       }
 180
 181       if (ShellStatus == SHELL_SUCCESS) {
 182         //
 183         // do the work if we have a valid block identifier
 184         //
 185         if (gEfiShellProtocol->GetDevicePathFromMap (BlockName) == NULL) {
 186           ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_GEN_PARAM_INV), gShellDebug1HiiHandle, L"dblk", BlockName);
 187           ShellStatus = SHELL_INVALID_PARAMETER;
 188         } else {
 189           DevPath = (EFI_DEVICE_PATH_PROTOCOL *)gEfiShellProtocol->GetDevicePathFromMap (BlockName);
 190           if (gBS->LocateDevicePath (&gEfiBlockIoProtocolGuid, &DevPath, NULL) == EFI_NOT_FOUND) {
 191             ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_GEN_MAP_PROTOCOL), gShellDebug1HiiHandle, L"dblk", BlockName, L"BlockIo");
 192             ShellStatus = SHELL_INVALID_PARAMETER;
 193           } else {
 194             ShellStatus = DisplayTheBlocks (gEfiShellProtocol->GetDevicePathFromMap (BlockName), Lba, (UINT8)BlockCount);
 195           }
 196         }
 197       }
 198     }
 199
 200     ShellCommandLineFreeVarList (Package);
 201   }
 202
 203   return (ShellStatus);
 204 }