[mirror_edk2.git] / ShellPkg / Library / UefiShellDebug1CommandsLib / SetVar.c

/** @file\r
  Main file for SetVar shell Debug1 function.\r
\r
  (C) Copyright 2015 Hewlett-Packard Development Company, L.P.<BR>\r
  Copyright (c) 2010 - 2017, Intel Corporation. All rights reserved.<BR>\r
  This program and the accompanying materials\r
  are licensed and made available under the terms and conditions of the BSD License\r
  which accompanies this distribution.  The full text of the license may be found at\r
  http://opensource.org/licenses/bsd-license.php\r
\r
  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
**/\r
\r
#include "UefiShellDebug1CommandsLib.h"\r
\r
STATIC CONST SHELL_PARAM_ITEM ParamList[] = {\r
  {L"-guid", TypeValue},\r
  {L"-bs", TypeFlag},\r
  {L"-rt", TypeFlag},\r
  {L"-nv", TypeFlag},\r
  {NULL, TypeMax}\r
  };\r
\r
typedef enum {\r
  DataTypeHexNumber   = 0,\r
  DataTypeHexArray    = 1,\r
  DataTypeAscii       = 2,\r
  DataTypeUnicode     = 3,\r
  DataTypeDevicePath  = 4,\r
  DataTypeUnKnow      = 5\r
} DATA_TYPE;\r
\r
typedef union {\r
  UINT8     HexNumber8;\r
  UINT16    HexNumber16;\r
  UINT32    HexNumber32;\r
  UINT64    HexNumber64;\r
} HEX_NUMBER;\r
\r
/**\r
  Check if the input is a (potentially empty) string of hexadecimal nibbles.\r
\r
  @param[in] String  The CHAR16 string to check.\r
\r
  @retval FALSE  A character has been found in String for which\r
                 ShellIsHexaDecimalDigitCharacter() returned FALSE.\r
\r
  @retval TRUE   Otherwise. (Note that this covers the case when String is\r
                 empty.)\r
**/\r
BOOLEAN\r
IsStringOfHexNibbles (\r
  IN CONST CHAR16  *String\r
  )\r
{\r
  CONST CHAR16 *Pos;\r
\r
  for (Pos = String; *Pos != L'\0'; ++Pos) {\r
    if (!ShellIsHexaDecimalDigitCharacter (*Pos)) {\r
      return FALSE;\r
    }\r
  }\r
  return TRUE;\r
}\r
\r
/**\r
  Function to check the TYPE of Data.\r
\r
  @param[in]    Data          The Data to be check.\r
\r
  @retval       DATA_TYPE     The TYPE of Data.\r
**/\r
DATA_TYPE\r
TestDataType (\r
  IN CONST CHAR16  *Data\r
  )\r
{\r
  if (Data[0] == L'0' && (Data[1] == L'x' || Data[1] == L'X')) {\r
    if (IsStringOfHexNibbles (Data+2) && StrLen (Data + 2) <= 16) {\r
      return DataTypeHexNumber;\r
    } else {\r
      return DataTypeUnKnow;\r
    }\r
  } else if (Data[0] == L'H') {\r
    if (IsStringOfHexNibbles (Data + 1) && StrLen (Data + 1) % 2 == 0) {\r
      return DataTypeHexArray;\r
    } else {\r
      return DataTypeUnKnow;\r
    }\r
  } else if (Data[0] == L'S') {\r
    return DataTypeAscii;\r
  } else if (Data[0] == L'L') {\r
    return DataTypeUnicode;\r
  } else if (Data[0] == L'P' || StrnCmp (Data, L"--", 2) == 0) {\r
    return DataTypeDevicePath;\r
  }\r
\r
  if (IsStringOfHexNibbles (Data) && StrLen (Data) % 2 == 0) {\r
    return DataTypeHexArray;\r
  }\r
\r
  return DataTypeAscii;\r
}\r
\r
/**\r
  Function to parse the Data by the type of Data, and save in the Buffer.\r
\r
  @param[in]      Data                A pointer to a buffer to be parsed.\r
  @param[out]     Buffer              A pointer to a buffer to hold the return data.\r
  @param[in,out]  BufferSize          On input, indicates the size of Buffer in bytes.\r
                                      On output,indicates the size of data return in Buffer.\r
                                      Or the size in bytes of the buffer needed to obtain.\r
\r
  @retval   EFI_INVALID_PARAMETER     The Buffer or BufferSize is NULL.\r
  @retval   EFI_BUFFER_TOO_SMALL      The Buffer is too small to hold the data.\r
  @retval   EFI_OUT_OF_RESOURCES      A memory allcation failed.\r
  @retval   EFI_SUCCESS               The Data parsed successful and save in the Buffer.\r
**/\r
EFI_STATUS\r
ParseParameterData (\r
  IN CONST CHAR16   *Data,\r
  OUT VOID          *Buffer,\r
  IN OUT UINTN      *BufferSize\r
  )\r
{\r
  UINT64                    HexNumber;\r
  UINTN                     HexNumberLen;\r
  UINTN                     Size;\r
  CHAR8                     *AsciiBuffer;\r
  DATA_TYPE                 DataType;\r
  EFI_DEVICE_PATH_PROTOCOL  *DevPath;\r
  EFI_STATUS                Status;\r
\r
  HexNumber                 = 0;\r
  HexNumberLen              = 0;\r
  Size                      = 0;\r
  AsciiBuffer               = NULL;\r
  DevPath                   = NULL;\r
  Status                    = EFI_SUCCESS;\r
\r
  if (Data == NULL || BufferSize == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  DataType = TestDataType (Data);\r
  if (DataType == DataTypeHexNumber) {\r
    //\r
    // hex number\r
    //\r
    StrHexToUint64S (Data + 2, NULL, &HexNumber);\r
    HexNumberLen = StrLen (Data + 2);\r
    if (HexNumberLen >= 1 && HexNumberLen <= 2) {\r
      Size = 1;\r
    } else if (HexNumberLen >= 3 && HexNumberLen <= 4) {\r
      Size = 2;\r
    } else if (HexNumberLen >= 5 && HexNumberLen <= 8) {\r
      Size = 4;\r
    } else if (HexNumberLen >= 9 && HexNumberLen <= 16) {\r
      Size = 8;\r
    }\r
    if (Buffer != NULL && *BufferSize >= Size) {\r
      CopyMem(Buffer, (VOID *)&HexNumber, Size);\r
    } else {\r
      Status = EFI_BUFFER_TOO_SMALL;\r
    }\r
    *BufferSize = Size;\r
  } else if (DataType == DataTypeHexArray) {\r
    //\r
    // hex array\r
    //\r
    if (*Data == L'H') {\r
      Data = Data + 1;\r
    }\r
\r
    Size = StrLen (Data) / 2;\r
    if (Buffer != NULL && *BufferSize >= Size) {\r
      StrHexToBytes(Data, StrLen  (Data), (UINT8 *)Buffer, Size);\r
    } else {\r
      Status = EFI_BUFFER_TOO_SMALL;\r
    }\r
    *BufferSize = Size;\r
  } else if (DataType == DataTypeAscii) {\r
    //\r
    // ascii text\r
    //\r
    if (*Data == L'S') {\r
      Data = Data + 1;\r
    }\r
    AsciiBuffer = AllocateZeroPool (StrSize (Data) / 2);\r
    if (AsciiBuffer == NULL) {\r
      Status = EFI_OUT_OF_RESOURCES;\r
    } else {\r
      AsciiSPrint (AsciiBuffer, StrSize (Data) / 2, "%s", (CHAR8 *)Data);\r
\r
      Size = StrSize (Data) / 2 - 1;\r
      if (Buffer != NULL && *BufferSize >= Size) {\r
        CopyMem (Buffer, AsciiBuffer, Size);\r
      } else {\r
        Status = EFI_BUFFER_TOO_SMALL;\r
      }\r
      *BufferSize = Size;\r
    }\r
    SHELL_FREE_NON_NULL (AsciiBuffer);\r
  } else if (DataType == DataTypeUnicode) {\r
    //\r
    // unicode text\r
    //\r
    if (*Data == L'L') {\r
      Data = Data + 1;\r
    }\r
    Size = StrSize (Data) - sizeof (CHAR16);\r
    if (Buffer != NULL && *BufferSize >= Size) {\r
      CopyMem (Buffer, Data, Size);\r
    } else {\r
      Status = EFI_BUFFER_TOO_SMALL;\r
    }\r
    *BufferSize = Size;\r
  } else if (DataType == DataTypeDevicePath) {\r
    if (*Data == L'P') {\r
      Data = Data + 1;\r
    } else if (StrnCmp (Data, L"--", 2) == 0) {\r
      Data = Data + 2;\r
    }\r
    DevPath = ConvertTextToDevicePath (Data);\r
    if (DevPath == NULL) {\r
      ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_SETVAR_ERROR_DPFT), gShellDebug1HiiHandle, L"setvar");\r
      Status = EFI_INVALID_PARAMETER;\r
    } else {\r
      Size = GetDevicePathSize (DevPath);\r
      if (Buffer != NULL && *BufferSize >= Size) {\r
        CopyMem (Buffer, DevPath, Size);\r
      } else {\r
        Status = EFI_BUFFER_TOO_SMALL;\r
      }\r
      *BufferSize = Size;\r
    }\r
    SHELL_FREE_NON_NULL (DevPath);\r
  } else {\r
    Status = EFI_INVALID_PARAMETER;\r
  }\r
\r
  return Status;\r
}\r
\r
/**\r
  Function to get each data from parameters.\r
\r
  @param[in]    Pacakge               The package of checked values.\r
  @param[out]   Buffer                A pointer to a buffer to hold the return data.\r
  @param[out]   BufferSize            Indicates the size of data in bytes return in Buffer.\r
\r
  @retval   EFI_INVALID_PARAMETER     Buffer or BufferSize is NULL.\r
  @retval   EFI_OUT_OF_RESOURCES      A memory allcation failed.\r
  @retval   EFI_SUCCESS               Get each parameter data was successful.\r
**/\r
EFI_STATUS\r
GetVariableDataFromParameter (\r
  IN CONST LIST_ENTRY *Package,\r
  OUT UINT8           **Buffer,\r
  OUT UINTN           *BufferSize\r
  )\r
{\r
  CONST CHAR16    *TempData;\r
  UINTN           Index;\r
  UINTN           TotalSize;\r
  UINTN           Size;\r
  UINT8           *BufferWalker;\r
  EFI_STATUS      Status;\r
\r
  TotalSize       = 0;\r
  Size            = 0;\r
  Status          = EFI_SUCCESS;\r
\r
  if (BufferSize == NULL || Buffer == NULL || ShellCommandLineGetCount (Package) < 3) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  for (Index = 2; Index < ShellCommandLineGetCount (Package); Index++) {\r
    TempData = ShellCommandLineGetRawValue (Package, Index);\r
\r
    if (TempData[0] != L'=') {\r
      ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_GEN_PARAM_INV), gShellDebug1HiiHandle, L"setvar", TempData);\r
      return EFI_INVALID_PARAMETER;\r
    }\r
\r
    TempData = TempData + 1;\r
    Size = 0;\r
    Status = ParseParameterData (TempData, NULL, &Size);\r
    if (EFI_ERROR (Status)) {\r
      if (Status == EFI_BUFFER_TOO_SMALL) {\r
        //\r
        // We expect return EFI_BUFFER_TOO_SMALL when pass 'NULL' as second parameter to the function ParseParameterData.\r
        //\r
        TotalSize += Size;\r
      } else {\r
        if (Status == EFI_INVALID_PARAMETER) {\r
          ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_GEN_PARAM_INV), gShellDebug1HiiHandle, L"setvar", TempData);\r
        } else if (Status == EFI_NOT_FOUND) {\r
          ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_SETVAR_ERROR_DPFT), gShellDebug1HiiHandle, L"setvar");\r
        }\r
        return Status;\r
      }\r
    }\r
  }\r
\r
  *BufferSize = TotalSize;\r
  *Buffer = AllocateZeroPool (TotalSize);\r
\r
  if (*Buffer == NULL) {\r
    Status = EFI_OUT_OF_RESOURCES;\r
  } else {\r
    BufferWalker = *Buffer;\r
    for (Index = 2; Index < ShellCommandLineGetCount (Package); Index++) {\r
      TempData = ShellCommandLineGetRawValue (Package, Index);\r
      TempData = TempData + 1;\r
\r
      Size = TotalSize;\r
      Status = ParseParameterData (TempData, (VOID *)BufferWalker, &Size);\r
      if (!EFI_ERROR (Status)) {\r
        BufferWalker = BufferWalker + Size;\r
        TotalSize = TotalSize - Size;\r
      } else {\r
        return Status;\r
      }\r
    }\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Function for 'setvar' command.\r
\r
  @param[in] ImageHandle  Handle to the Image (NULL if Internal).\r
  @param[in] SystemTable  Pointer to the System Table (NULL if Internal).\r
**/\r
SHELL_STATUS\r
EFIAPI\r
ShellCommandRunSetVar (\r
  IN EFI_HANDLE        ImageHandle,\r
  IN EFI_SYSTEM_TABLE  *SystemTable\r
  )\r
{\r
  EFI_STATUS          Status;\r
  RETURN_STATUS       RStatus;\r
  LIST_ENTRY          *Package;\r
  CHAR16              *ProblemParam;\r
  SHELL_STATUS        ShellStatus;\r
  CONST CHAR16        *VariableName;\r
  EFI_GUID            Guid;\r
  CONST CHAR16        *StringGuid;\r
  UINT32              Attributes;\r
  VOID                *Buffer;\r
  UINTN               Size;\r
  UINTN               LoopVar;\r
\r
  ShellStatus         = SHELL_SUCCESS;\r
  Status              = EFI_SUCCESS;\r
  Buffer              = NULL;\r
  Size                = 0;\r
  Attributes          = 0;\r
\r
  //\r
  // initialize the shell lib (we must be in non-auto-init...)\r
  //\r
  Status = ShellInitialize();\r
  ASSERT_EFI_ERROR(Status);\r
\r
  Status = CommandInit();\r
  ASSERT_EFI_ERROR(Status);\r
\r
  //\r
  // parse the command line\r
  //\r
  Status = ShellCommandLineParse (ParamList, &Package, &ProblemParam, TRUE);\r
  if (EFI_ERROR(Status)) {\r
    if (Status == EFI_VOLUME_CORRUPTED && ProblemParam != NULL) {\r
      ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_PROBLEM), gShellDebug1HiiHandle, L"setvar", ProblemParam);  \r
      FreePool(ProblemParam);\r
      ShellStatus = SHELL_INVALID_PARAMETER;\r
    } else {\r
      ASSERT(FALSE);\r
    }\r
  } else {\r
    if (ShellCommandLineGetCount(Package) < 2) {\r
      ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_TOO_FEW), gShellDebug1HiiHandle, L"setvar");  \r
      ShellStatus = SHELL_INVALID_PARAMETER;\r
    } else {\r
      VariableName  = ShellCommandLineGetRawValue(Package, 1);\r
      if (!ShellCommandLineGetFlag(Package, L"-guid")){\r
        CopyGuid(&Guid, &gEfiGlobalVariableGuid);\r
      } else {\r
        StringGuid = ShellCommandLineGetValue(Package, L"-guid");\r
        RStatus = StrToGuid (StringGuid, &Guid);\r
        if (RETURN_ERROR (RStatus) || (StringGuid[GUID_STRING_LENGTH] != L'\0')) {\r
          ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_PARAM_INV), gShellDebug1HiiHandle, L"setvar", StringGuid);  \r
          ShellStatus = SHELL_INVALID_PARAMETER;\r
        }\r
      }\r
\r
      if (ShellCommandLineGetCount(Package) == 2) {\r
        //\r
        // Display\r
        //\r
        Status = gRT->GetVariable((CHAR16*)VariableName, &Guid, &Attributes, &Size, Buffer);\r
        if (Status == EFI_BUFFER_TOO_SMALL) {\r
          Buffer = AllocateZeroPool(Size);\r
          Status = gRT->GetVariable((CHAR16*)VariableName, &Guid, &Attributes, &Size, Buffer);\r
        }\r
        if (!EFI_ERROR(Status) && Buffer != NULL) {\r
          ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN(STR_SETVAR_PRINT), gShellDebug1HiiHandle, &Guid, VariableName, Size);\r
          for (LoopVar = 0; LoopVar < Size; LoopVar++) {\r
            ShellPrintEx(-1, -1, L"%02x ", ((UINT8*)Buffer)[LoopVar]);\r
          }\r
          ShellPrintEx(-1, -1, L"\r\n");\r
        } else {\r
          ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_SETVAR_ERROR_GET), gShellDebug1HiiHandle, L"setvar", &Guid, VariableName);\r
          ShellStatus = SHELL_ACCESS_DENIED;\r
        }\r
      } else {\r
        //\r
        // Create, Delete or Modify.\r
        //\r
        Status = gRT->GetVariable((CHAR16*)VariableName, &Guid, &Attributes, &Size, Buffer);\r
        if (Status == EFI_BUFFER_TOO_SMALL) {\r
          Buffer = AllocateZeroPool(Size);\r
          Status = gRT->GetVariable((CHAR16*)VariableName, &Guid, &Attributes, &Size, Buffer);\r
        }\r
        if (EFI_ERROR(Status) || Buffer == NULL) {\r
          //\r
          // Creating a new variable.  determine attributes from command line.\r
          //\r
          Attributes = 0;\r
          if (ShellCommandLineGetFlag(Package, L"-bs")) {\r
            Attributes |= EFI_VARIABLE_BOOTSERVICE_ACCESS;\r
          }\r
          if (ShellCommandLineGetFlag(Package, L"-rt")) {\r
            Attributes |= EFI_VARIABLE_RUNTIME_ACCESS |\r
                          EFI_VARIABLE_BOOTSERVICE_ACCESS;\r
          }\r
          if (ShellCommandLineGetFlag(Package, L"-nv")) {\r
            Attributes |= EFI_VARIABLE_NON_VOLATILE;\r
          }\r
        }\r
        SHELL_FREE_NON_NULL(Buffer);\r
\r
        Size = 0;\r
        Status = GetVariableDataFromParameter(Package, (UINT8 **)&Buffer, &Size);\r
        if (!EFI_ERROR(Status)) {\r
          Status = gRT->SetVariable((CHAR16*)VariableName, &Guid, Attributes, Size, Buffer);\r
        }\r
        if (EFI_ERROR(Status)) {\r
          ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN(STR_SETVAR_ERROR_SET), gShellDebug1HiiHandle, L"setvar", &Guid, VariableName);\r
          ShellStatus = SHELL_ACCESS_DENIED;\r
        } else {\r
          ASSERT(ShellStatus == SHELL_SUCCESS);\r
        }\r
      }\r
    }\r
    ShellCommandLineFreeVarList (Package);\r
  }\r
\r
  if (Buffer != NULL) {\r
    FreePool(Buffer);\r
  }\r
\r
  return (ShellStatus);\r
}\r
Commit	Line	Data
47454e23	1	/** @file\r
5d73d92f	2	Main file for SetVar shell Debug1 function.\r
5d73d92f	3	\r
c011b6c9	4	(C) Copyright 2015 Hewlett-Packard Development Company, L.P.<BR>\r
7f6511ee	5	Copyright (c) 2010 - 2017, Intel Corporation. All rights reserved.<BR>\r
5d73d92f	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	#include "UefiShellDebug1CommandsLib.h"\r
	17	\r
	18	STATIC CONST SHELL_PARAM_ITEM ParamList[] = {\r
	19	{L"-guid", TypeValue},\r
	20	{L"-bs", TypeFlag},\r
	21	{L"-rt", TypeFlag},\r
	22	{L"-nv", TypeFlag},\r
	23	{NULL, TypeMax}\r
	24	};\r
	25	\r
47454e23 CC	26	typedef enum {\r
	27	DataTypeHexNumber = 0,\r
	28	DataTypeHexArray = 1,\r
	29	DataTypeAscii = 2,\r
	30	DataTypeUnicode = 3,\r
	31	DataTypeDevicePath = 4,\r
	32	DataTypeUnKnow = 5\r
	33	} DATA_TYPE;\r
	34	\r
	35	typedef union {\r
	36	UINT8 HexNumber8;\r
	37	UINT16 HexNumber16;\r
	38	UINT32 HexNumber32;\r
	39	UINT64 HexNumber64;\r
	40	} HEX_NUMBER;\r
bbf57d4f LE	41	\r
	42	/**\r
	43	Check if the input is a (potentially empty) string of hexadecimal nibbles.\r
	44	\r
	45	@param[in] String The CHAR16 string to check.\r
	46	\r
	47	@retval FALSE A character has been found in String for which\r
	48	ShellIsHexaDecimalDigitCharacter() returned FALSE.\r
	49	\r
	50	@retval TRUE Otherwise. (Note that this covers the case when String is\r
	51	empty.)\r
	52	**/\r
	53	BOOLEAN\r
bbf57d4f LE	54	IsStringOfHexNibbles (\r
	55	IN CONST CHAR16 *String\r
	56	)\r
	57	{\r
	58	CONST CHAR16 *Pos;\r
	59	\r
	60	for (Pos = String; *Pos != L'\0'; ++Pos) {\r
	61	if (!ShellIsHexaDecimalDigitCharacter (*Pos)) {\r
	62	return FALSE;\r
	63	}\r
	64	}\r
	65	return TRUE;\r
	66	}\r
	67	\r
47454e23 CC	68	/**\r
	69	Function to check the TYPE of Data.\r
	70	\r
	71	@param[in] Data The Data to be check.\r
	72	\r
	73	@retval DATA_TYPE The TYPE of Data.\r
	74	**/\r
	75	DATA_TYPE\r
	76	TestDataType (\r
	77	IN CONST CHAR16 *Data\r
	78	)\r
	79	{\r
	80	if (Data[0] == L'0' && (Data[1] == L'x' \|\| Data[1] == L'X')) {\r
	81	if (IsStringOfHexNibbles (Data+2) && StrLen (Data + 2) <= 16) {\r
	82	return DataTypeHexNumber;\r
	83	} else {\r
	84	return DataTypeUnKnow;\r
	85	}\r
	86	} else if (Data[0] == L'H') {\r
	87	if (IsStringOfHexNibbles (Data + 1) && StrLen (Data + 1) % 2 == 0) {\r
	88	return DataTypeHexArray;\r
	89	} else {\r
	90	return DataTypeUnKnow;\r
	91	}\r
	92	} else if (Data[0] == L'S') {\r
	93	return DataTypeAscii;\r
	94	} else if (Data[0] == L'L') {\r
	95	return DataTypeUnicode;\r
	96	} else if (Data[0] == L'P' \|\| StrnCmp (Data, L"--", 2) == 0) {\r
	97	return DataTypeDevicePath;\r
	98	}\r
	99	\r
	100	if (IsStringOfHexNibbles (Data) && StrLen (Data) % 2 == 0) {\r
	101	return DataTypeHexArray;\r
	102	}\r
	103	\r
	104	return DataTypeAscii;\r
	105	}\r
	106	\r
	107	/**\r
	108	Function to parse the Data by the type of Data, and save in the Buffer.\r
	109	\r
	110	@param[in] Data A pointer to a buffer to be parsed.\r
	111	@param[out] Buffer A pointer to a buffer to hold the return data.\r
	112	@param[in,out] BufferSize On input, indicates the size of Buffer in bytes.\r
	113	On output,indicates the size of data return in Buffer.\r
	114	Or the size in bytes of the buffer needed to obtain.\r
	115	\r
	116	@retval EFI_INVALID_PARAMETER The Buffer or BufferSize is NULL.\r
	117	@retval EFI_BUFFER_TOO_SMALL The Buffer is too small to hold the data.\r
	118	@retval EFI_OUT_OF_RESOURCES A memory allcation failed.\r
	119	@retval EFI_SUCCESS The Data parsed successful and save in the Buffer.\r
	120	**/\r
	121	EFI_STATUS\r
	122	ParseParameterData (\r
	123	IN CONST CHAR16 *Data,\r
	124	OUT VOID *Buffer,\r
	125	IN OUT UINTN *BufferSize\r
	126	)\r
	127	{\r
	128	UINT64 HexNumber;\r
	129	UINTN HexNumberLen;\r
	130	UINTN Size;\r
	131	CHAR8 *AsciiBuffer;\r
132	DATA_TYPE DataType;\r
133	EFI_DEVICE_PATH_PROTOCOL *DevPath;\r
134	EFI_STATUS Status;\r
135	\r
136	HexNumber = 0;\r
137	HexNumberLen = 0;\r
138	Size = 0;\r
139	AsciiBuffer = NULL;\r
140	DevPath = NULL;\r
141	Status = EFI_SUCCESS;\r
142	\r
143	if (Data == NULL \|\| BufferSize == NULL) {\r
144	return EFI_INVALID_PARAMETER;\r
145	}\r
146	\r
147	DataType = TestDataType (Data);\r
148	if (DataType == DataTypeHexNumber) {\r
149	//\r
150	// hex number\r
151	//\r
152	StrHexToUint64S (Data + 2, NULL, &HexNumber);\r
153	HexNumberLen = StrLen (Data + 2);\r
154	if (HexNumberLen >= 1 && HexNumberLen <= 2) {\r
155	Size = 1;\r
156	} else if (HexNumberLen >= 3 && HexNumberLen <= 4) {\r
157	Size = 2;\r
158	} else if (HexNumberLen >= 5 && HexNumberLen <= 8) {\r
159	Size = 4;\r
160	} else if (HexNumberLen >= 9 && HexNumberLen <= 16) {\r
161	Size = 8;\r
162	}\r
163	if (Buffer != NULL && *BufferSize >= Size) {\r
164	CopyMem(Buffer, (VOID *)&HexNumber, Size);\r
165	} else {\r
166	Status = EFI_BUFFER_TOO_SMALL;\r
167	}\r
168	*BufferSize = Size;\r
169	} else if (DataType == DataTypeHexArray) {\r
170	//\r
171	// hex array\r
172	//\r
173	if (*Data == L'H') {\r
174	Data = Data + 1;\r
175	}\r
176	\r
177	Size = StrLen (Data) / 2;\r
178	if (Buffer != NULL && *BufferSize >= Size) {\r
179	StrHexToBytes(Data, StrLen (Data), (UINT8 *)Buffer, Size);\r
180	} else {\r
181	Status = EFI_BUFFER_TOO_SMALL;\r
182	}\r
183	*BufferSize = Size;\r
184	} else if (DataType == DataTypeAscii) {\r
185	//\r
186	// ascii text\r
187	//\r
188	if (*Data == L'S') {\r
189	Data = Data + 1;\r
190	}\r
191	AsciiBuffer = AllocateZeroPool (StrSize (Data) / 2);\r
192	if (AsciiBuffer == NULL) {\r
193	Status = EFI_OUT_OF_RESOURCES;\r
194	} else {\r
195	AsciiSPrint (AsciiBuffer, StrSize (Data) / 2, "%s", (CHAR8 *)Data);\r
196	\r
197	Size = StrSize (Data) / 2 - 1;\r
198	if (Buffer != NULL && *BufferSize >= Size) {\r
199	CopyMem (Buffer, AsciiBuffer, Size);\r
200	} else {\r
201	Status = EFI_BUFFER_TOO_SMALL;\r
202	}\r
203	*BufferSize = Size;\r
204	}\r
205	SHELL_FREE_NON_NULL (AsciiBuffer);\r
206	} else if (DataType == DataTypeUnicode) {\r
207	//\r
208	// unicode text\r
209	//\r
210	if (*Data == L'L') {\r
211	Data = Data + 1;\r
212	}\r
213	Size = StrSize (Data) - sizeof (CHAR16);\r
214	if (Buffer != NULL && *BufferSize >= Size) {\r
215	CopyMem (Buffer, Data, Size);\r
216	} else {\r
217	Status = EFI_BUFFER_TOO_SMALL;\r
218	}\r
219	*BufferSize = Size;\r
220	} else if (DataType == DataTypeDevicePath) {\r
221	if (*Data == L'P') {\r
222	Data = Data + 1;\r
223	} else if (StrnCmp (Data, L"--", 2) == 0) {\r
224	Data = Data + 2;\r
225	}\r
226	DevPath = ConvertTextToDevicePath (Data);\r
227	if (DevPath == NULL) {\r
228	ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_SETVAR_ERROR_DPFT), gShellDebug1HiiHandle, L"setvar");\r
229	Status = EFI_INVALID_PARAMETER;\r
230	} else {\r
231	Size = GetDevicePathSize (DevPath);\r
232	if (Buffer != NULL && *BufferSize >= Size) {\r
233	CopyMem (Buffer, DevPath, Size);\r
234	} else {\r
235	Status = EFI_BUFFER_TOO_SMALL;\r
236	}\r
237	*BufferSize = Size;\r
238	}\r
239	SHELL_FREE_NON_NULL (DevPath);\r
240	} else {\r
241	Status = EFI_INVALID_PARAMETER;\r
242	}\r
243	\r
244	return Status;\r
245	}\r
246	\r
247	/**\r
248	Function to get each data from parameters.\r
249	\r
250	@param[in] Pacakge The package of checked values.\r
251	@param[out] Buffer A pointer to a buffer to hold the return data.\r
252	@param[out] BufferSize Indicates the size of data in bytes return in Buffer.\r
253	\r
254	@retval EFI_INVALID_PARAMETER Buffer or BufferSize is NULL.\r
255	@retval EFI_OUT_OF_RESOURCES A memory allcation failed.\r
256	@retval EFI_SUCCESS Get each parameter data was successful.\r
257	**/\r
258	EFI_STATUS\r
259	GetVariableDataFromParameter (\r
260	IN CONST LIST_ENTRY *Package,\r
261	OUT UINT8 **Buffer,\r
262	OUT UINTN *BufferSize\r
263	)\r
264	{\r
265	CONST CHAR16 *TempData;\r
266	UINTN Index;\r
267	UINTN TotalSize;\r
268	UINTN Size;\r
269	UINT8 *BufferWalker;\r
270	EFI_STATUS Status;\r
271	\r
272	TotalSize = 0;\r
273	Size = 0;\r
274	Status = EFI_SUCCESS;\r
275	\r
276	if (BufferSize == NULL \|\| Buffer == NULL \|\| ShellCommandLineGetCount (Package) < 3) {\r
277	return EFI_INVALID_PARAMETER;\r
278	}\r
279	\r
280	for (Index = 2; Index < ShellCommandLineGetCount (Package); Index++) {\r
281	TempData = ShellCommandLineGetRawValue (Package, Index);\r
282	\r
283	if (TempData[0] != L'=') {\r
284	ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_GEN_PARAM_INV), gShellDebug1HiiHandle, L"setvar", TempData);\r
285	return EFI_INVALID_PARAMETER;\r
286	}\r
287	\r
288	TempData = TempData + 1;\r
289	Size = 0;\r
290	Status = ParseParameterData (TempData, NULL, &Size);\r
291	if (EFI_ERROR (Status)) {\r
292	if (Status == EFI_BUFFER_TOO_SMALL) {\r
293	//\r
294	// We expect return EFI_BUFFER_TOO_SMALL when pass 'NULL' as second parameter to the function ParseParameterData.\r
295	//\r
296	TotalSize += Size;\r
297	} else {\r
298	if (Status == EFI_INVALID_PARAMETER) {\r
299	ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_GEN_PARAM_INV), gShellDebug1HiiHandle, L"setvar", TempData);\r
300	} else if (Status == EFI_NOT_FOUND) {\r
301	ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_SETVAR_ERROR_DPFT), gShellDebug1HiiHandle, L"setvar");\r
302	}\r
303	return Status;\r
304	}\r
305	}\r
306	}\r
307	\r
308	*BufferSize = TotalSize;\r
309	*Buffer = AllocateZeroPool (TotalSize);\r
310	\r
311	if (*Buffer == NULL) {\r
312	Status = EFI_OUT_OF_RESOURCES;\r
313	} else {\r
314	BufferWalker = *Buffer;\r
315	for (Index = 2; Index < ShellCommandLineGetCount (Package); Index++) {\r
316	TempData = ShellCommandLineGetRawValue (Package, Index);\r
317	TempData = TempData + 1;\r
318	\r
319	Size = TotalSize;\r
320	Status = ParseParameterData (TempData, (VOID *)BufferWalker, &Size);\r
321	if (!EFI_ERROR (Status)) {\r
322	BufferWalker = BufferWalker + Size;\r
323	TotalSize = TotalSize - Size;\r
324	} else {\r
325	return Status;\r
326	}\r
327	}\r
328	}\r
329	\r
330	return EFI_SUCCESS;\r
331	}\r
bbf57d4f	332	\r
3737ac2b	333	/**\r
	334	Function for 'setvar' command.\r
	335	\r
	336	@param[in] ImageHandle Handle to the Image (NULL if Internal).\r
	337	@param[in] SystemTable Pointer to the System Table (NULL if Internal).\r
	338	**/\r
5d73d92f	339	SHELL_STATUS\r
	340	EFIAPI\r
	341	ShellCommandRunSetVar (\r
	342	IN EFI_HANDLE ImageHandle,\r
	343	IN EFI_SYSTEM_TABLE *SystemTable\r
	344	)\r
	345	{\r
	346	EFI_STATUS Status;\r
7f6511ee	347	RETURN_STATUS RStatus;\r
5d73d92f	348	LIST_ENTRY *Package;\r
	349	CHAR16 *ProblemParam;\r
	350	SHELL_STATUS ShellStatus;\r
	351	CONST CHAR16 *VariableName;\r
5d73d92f	352	EFI_GUID Guid;\r
	353	CONST CHAR16 *StringGuid;\r
	354	UINT32 Attributes;\r
	355	VOID *Buffer;\r
	356	UINTN Size;\r
	357	UINTN LoopVar;\r
5d73d92f	358	\r
	359	ShellStatus = SHELL_SUCCESS;\r
	360	Status = EFI_SUCCESS;\r
	361	Buffer = NULL;\r
	362	Size = 0;\r
	363	Attributes = 0;\r
5d73d92f	364	\r
	365	//\r
	366	// initialize the shell lib (we must be in non-auto-init...)\r
	367	//\r
	368	Status = ShellInitialize();\r
	369	ASSERT_EFI_ERROR(Status);\r
	370	\r
	371	Status = CommandInit();\r
	372	ASSERT_EFI_ERROR(Status);\r
	373	\r
	374	//\r
	375	// parse the command line\r
	376	//\r
	377	Status = ShellCommandLineParse (ParamList, &Package, &ProblemParam, TRUE);\r
	378	if (EFI_ERROR(Status)) {\r
	379	if (Status == EFI_VOLUME_CORRUPTED && ProblemParam != NULL) {\r
4092a8f6	380	ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_PROBLEM), gShellDebug1HiiHandle, L"setvar", ProblemParam); \r
5d73d92f	381	FreePool(ProblemParam);\r
	382	ShellStatus = SHELL_INVALID_PARAMETER;\r
	383	} else {\r
	384	ASSERT(FALSE);\r
	385	}\r
	386	} else {\r
	387	if (ShellCommandLineGetCount(Package) < 2) {\r
4092a8f6	388	ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_TOO_FEW), gShellDebug1HiiHandle, L"setvar"); \r
5d73d92f	389	ShellStatus = SHELL_INVALID_PARAMETER;\r
5d73d92f	390	} else {\r
5d73d92f	391	VariableName = ShellCommandLineGetRawValue(Package, 1);\r
5d73d92f	392	if (!ShellCommandLineGetFlag(Package, L"-guid")){\r
	393	CopyGuid(&Guid, &gEfiGlobalVariableGuid);\r
	394	} else {\r
	395	StringGuid = ShellCommandLineGetValue(Package, L"-guid");\r
7f6511ee RN	396	RStatus = StrToGuid (StringGuid, &Guid);\r
7f6511ee RN	397	if (RETURN_ERROR (RStatus) \|\| (StringGuid[GUID_STRING_LENGTH] != L'\0')) {\r
4092a8f6	398	ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_PARAM_INV), gShellDebug1HiiHandle, L"setvar", StringGuid); \r
3737ac2b	399	ShellStatus = SHELL_INVALID_PARAMETER;\r
5d73d92f	400	}\r
5d73d92f	401	}\r
47454e23 CC	402	\r
47454e23 CC	403	if (ShellCommandLineGetCount(Package) == 2) {\r
5d73d92f	404	//\r
47454e23	405	// Display\r
5d73d92f	406	//\r
	407	Status = gRT->GetVariable((CHAR16*)VariableName, &Guid, &Attributes, &Size, Buffer);\r
	408	if (Status == EFI_BUFFER_TOO_SMALL) {\r
3737ac2b	409	Buffer = AllocateZeroPool(Size);\r
5d73d92f	410	Status = gRT->GetVariable((CHAR16*)VariableName, &Guid, &Attributes, &Size, Buffer);\r
5d73d92f	411	}\r
47454e23 CC	412	if (!EFI_ERROR(Status) && Buffer != NULL) {\r
	413	ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN(STR_SETVAR_PRINT), gShellDebug1HiiHandle, &Guid, VariableName, Size);\r
	414	for (LoopVar = 0; LoopVar < Size; LoopVar++) {\r
5d73d92f	415	ShellPrintEx(-1, -1, L"%02x ", ((UINT8*)Buffer)[LoopVar]);\r
	416	}\r
	417	ShellPrintEx(-1, -1, L"\r\n");\r
	418	} else {\r
47454e23	419	ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_SETVAR_ERROR_GET), gShellDebug1HiiHandle, L"setvar", &Guid, VariableName);\r
5d73d92f	420	ShellStatus = SHELL_ACCESS_DENIED;\r
5d73d92f	421	}\r
5d73d92f	422	} else {\r
5d73d92f	423	//\r
47454e23	424	// Create, Delete or Modify.\r
475387e9 JC	425	//\r
	426	Status = gRT->GetVariable((CHAR16*)VariableName, &Guid, &Attributes, &Size, Buffer);\r
	427	if (Status == EFI_BUFFER_TOO_SMALL) {\r
	428	Buffer = AllocateZeroPool(Size);\r
	429	Status = gRT->GetVariable((CHAR16*)VariableName, &Guid, &Attributes, &Size, Buffer);\r
5d73d92f	430	}\r
475387e9 JC	431	if (EFI_ERROR(Status) \|\| Buffer == NULL) {\r
	432	//\r
	433	// Creating a new variable. determine attributes from command line.\r
	434	//\r
	435	Attributes = 0;\r
	436	if (ShellCommandLineGetFlag(Package, L"-bs")) {\r
	437	Attributes \|= EFI_VARIABLE_BOOTSERVICE_ACCESS;\r
	438	}\r
	439	if (ShellCommandLineGetFlag(Package, L"-rt")) {\r
	440	Attributes \|= EFI_VARIABLE_RUNTIME_ACCESS \|\r
	441	EFI_VARIABLE_BOOTSERVICE_ACCESS;\r
	442	}\r
	443	if (ShellCommandLineGetFlag(Package, L"-nv")) {\r
	444	Attributes \|= EFI_VARIABLE_NON_VOLATILE;\r
	445	}\r
5d73d92f	446	}\r
475387e9 JC	447	SHELL_FREE_NON_NULL(Buffer);\r
475387e9 JC	448	\r
47454e23 CC	449	Size = 0;\r
	450	Status = GetVariableDataFromParameter(Package, (UINT8 **)&Buffer, &Size);\r
	451	if (!EFI_ERROR(Status)) {\r
	452	Status = gRT->SetVariable((CHAR16*)VariableName, &Guid, Attributes, Size, Buffer);\r
	453	}\r
	454	if (EFI_ERROR(Status)) {\r
	455	ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN(STR_SETVAR_ERROR_SET), gShellDebug1HiiHandle, L"setvar", &Guid, VariableName);\r
	456	ShellStatus = SHELL_ACCESS_DENIED;\r
5d73d92f	457	} else {\r
47454e23	458	ASSERT(ShellStatus == SHELL_SUCCESS);\r
5d73d92f	459	}\r
	460	}\r
	461	}\r
	462	ShellCommandLineFreeVarList (Package);\r
	463	}\r
	464	\r
	465	if (Buffer != NULL) {\r
	466	FreePool(Buffer);\r
	467	}\r
	468	\r
5d73d92f	469	return (ShellStatus);\r
5d73d92f	470	}\r