[mirror_edk2.git] / ShellPkg / Library / UefiShellDriver1CommandsLib / Unload.c

/** @file\r
  Main file for Unload shell Driver1 function.\r
\r
  Copyright (c) 2010 - 2011, 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 "UefiShellDriver1CommandsLib.h"\r
\r
/**\r
  Function to translate the EFI_MEMORY_TYPE into a string.\r
\r
  @param[in] Memory     The memory type.\r
\r
  @retval               A string representation of the type allocated from BS Pool.\r
**/\r
CHAR16*\r
EFIAPI\r
ConvertMemoryType (\r
  IN CONST EFI_MEMORY_TYPE Memory\r
  )\r
{\r
  CHAR16 *RetVal;\r
  RetVal = NULL;\r
\r
  switch (Memory) {\r
  case EfiReservedMemoryType:       StrnCatGrow(&RetVal, NULL, L"EfiReservedMemoryType", 0);        break;\r
  case EfiLoaderCode:               StrnCatGrow(&RetVal, NULL, L"EfiLoaderCode", 0);                break;\r
  case EfiLoaderData:               StrnCatGrow(&RetVal, NULL, L"EfiLoaderData", 0);                break;\r
  case EfiBootServicesCode:         StrnCatGrow(&RetVal, NULL, L"EfiBootServicesCode", 0);          break;\r
  case EfiBootServicesData:         StrnCatGrow(&RetVal, NULL, L"EfiBootServicesData", 0);          break;\r
  case EfiRuntimeServicesCode:      StrnCatGrow(&RetVal, NULL, L"EfiRuntimeServicesCode", 0);       break;\r
  case EfiRuntimeServicesData:      StrnCatGrow(&RetVal, NULL, L"EfiRuntimeServicesData", 0);       break;\r
  case EfiConventionalMemory:       StrnCatGrow(&RetVal, NULL, L"EfiConventionalMemory", 0);        break;\r
  case EfiUnusableMemory:           StrnCatGrow(&RetVal, NULL, L"EfiUnusableMemory", 0);            break;\r
  case EfiACPIReclaimMemory:        StrnCatGrow(&RetVal, NULL, L"EfiACPIReclaimMemory", 0);         break;\r
  case EfiACPIMemoryNVS:            StrnCatGrow(&RetVal, NULL, L"EfiACPIMemoryNVS", 0);             break;\r
  case EfiMemoryMappedIO:           StrnCatGrow(&RetVal, NULL, L"EfiMemoryMappedIO", 0);            break;\r
  case EfiMemoryMappedIOPortSpace:  StrnCatGrow(&RetVal, NULL, L"EfiMemoryMappedIOPortSpace", 0);   break;\r
  case EfiPalCode:                  StrnCatGrow(&RetVal, NULL, L"EfiPalCode", 0);                   break;\r
  case EfiMaxMemoryType:            StrnCatGrow(&RetVal, NULL, L"EfiMaxMemoryType", 0);             break;\r
  default: ASSERT(FALSE);\r
  }\r
  return (RetVal);\r
}\r
\r
/**\r
  Function to dump LoadedImage info from TheHandle.\r
\r
  @param[in] TheHandle              The handle to dump info from.\r
\r
  @retval EFI_SUCCESS               The info was dumped.\r
  @retval EFI_INVALID_PARAMETER     The handle did not have LoadedImage\r
**/\r
EFI_STATUS\r
EFIAPI\r
DumpLoadedImageProtocolInfo (\r
  IN EFI_HANDLE   TheHandle\r
  )\r
{\r
  EFI_LOADED_IMAGE_PROTOCOL         *Image;\r
  EFI_STATUS                        Status;\r
  EFI_DEVICE_PATH_TO_TEXT_PROTOCOL  *DevicePathToText;\r
  CHAR16                            *DevicePathText;\r
  CHAR16                            *CodeTypeText;\r
  CHAR16                            *DataTypeText;\r
  CHAR8                             *PdbPointer;\r
\r
  Image = NULL;\r
\r
  Status = gBS->OpenProtocol(TheHandle, &gEfiLoadedImageProtocolGuid, (VOID**)&Image, gImageHandle, NULL, EFI_OPEN_PROTOCOL_GET_PROTOCOL);\r
  if (EFI_ERROR(Status)) {\r
    return (EFI_INVALID_PARAMETER);\r
  }\r
\r
  Status = gBS->LocateProtocol(\r
    &gEfiDevicePathToTextProtocolGuid,\r
    NULL,\r
    (VOID**)&DevicePathToText);\r
  //\r
  // we now have the device path to text protocol\r
  //\r
  if (!EFI_ERROR(Status)) {\r
    DevicePathText = DevicePathToText->ConvertDevicePathToText(Image->FilePath, TRUE, TRUE);\r
  } else {\r
    DevicePathText = NULL;\r
  }\r
\r
  CodeTypeText = ConvertMemoryType(Image->ImageCodeType);\r
  DataTypeText = ConvertMemoryType(Image->ImageDataType);\r
  PdbPointer = (CHAR8*)PeCoffLoaderGetPdbPointer(Image->ImageBase);\r
  ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_UNLOAD_VERBOSE), gShellDriver1HiiHandle,\r
    ConvertHandleToHandleIndex(TheHandle),\r
    TheHandle,\r
    Image,\r
    Image->ParentHandle,\r
    Image->SystemTable,\r
    Image->DeviceHandle,\r
    DevicePathText,\r
    PdbPointer,\r
    Image->ImageBase,\r
    Image->ImageSize,\r
    CodeTypeText,\r
    DataTypeText\r
    );\r
\r
  SHELL_FREE_NON_NULL(DevicePathText);\r
  SHELL_FREE_NON_NULL(CodeTypeText);\r
  SHELL_FREE_NON_NULL(DataTypeText);\r
\r
  return (EFI_SUCCESS);\r
}\r
\r
STATIC CONST SHELL_PARAM_ITEM ParamList[] = {\r
  {L"-n", TypeFlag},\r
  {L"-v", TypeFlag},\r
  {L"-verbose", TypeFlag},\r
  {NULL, TypeMax}\r
  };\r
\r
/**\r
  Function for 'unload' 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
ShellCommandRunUnload (\r
  IN EFI_HANDLE        ImageHandle,\r
  IN EFI_SYSTEM_TABLE  *SystemTable\r
  )\r
{\r
  EFI_STATUS            Status;\r
  LIST_ENTRY            *Package;\r
  CHAR16                *ProblemParam;\r
  SHELL_STATUS          ShellStatus;\r
  EFI_HANDLE            TheHandle;\r
  CONST CHAR16          *Param1;\r
  SHELL_PROMPT_RESPONSE *Resp;\r
  UINT64                Value;\r
\r
  ShellStatus         = SHELL_SUCCESS;\r
  Package             = NULL;\r
  Resp                = NULL;\r
  Value               = 0;\r
  TheHandle           = NULL;\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
  //\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), gShellDriver1HiiHandle, ProblemParam);\r
      FreePool(ProblemParam);\r
      ShellStatus = SHELL_INVALID_PARAMETER;\r
    } else {\r
      ASSERT(FALSE);\r
    }\r
  } else {\r
    if (ShellCommandLineGetCount(Package) > 2){\r
      //\r
      // error for too many parameters\r
      //\r
      ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_TOO_MANY), gShellDriver1HiiHandle);\r
      ShellStatus = SHELL_INVALID_PARAMETER;\r
    } else if (ShellCommandLineGetCount(Package) < 2) {\r
      ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_TOO_FEW), gShellDriver1HiiHandle);\r
      ShellStatus = SHELL_INVALID_PARAMETER;\r
    } else {\r
      Param1    = ShellCommandLineGetRawValue(Package, 1);\r
      if (Param1 != NULL) {\r
        Status    = ShellConvertStringToUint64(Param1, &Value, TRUE, FALSE);\r
        TheHandle = ConvertHandleIndexToHandle((UINTN)Value);\r
      }\r
\r
      if (EFI_ERROR(Status) || Param1 == NULL || TheHandle == NULL){\r
        ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_INV_HANDLE), gShellDriver1HiiHandle, Param1);\r
        ShellStatus = SHELL_INVALID_PARAMETER;\r
      } else {\r
        ASSERT(TheHandle != NULL);\r
        if (ShellCommandLineGetFlag(Package, L"-v") || ShellCommandLineGetFlag(Package, L"-verbose")) {\r
          DumpLoadedImageProtocolInfo(TheHandle);\r
        }\r
        \r
        if (!ShellCommandLineGetFlag(Package, L"-n")) {\r
          Status = ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN(STR_UNLOAD_CONF), gShellDriver1HiiHandle, (UINTN)TheHandle);\r
          Status = ShellPromptForResponse(ShellPromptResponseTypeYesNo, NULL, (VOID**)&Resp);\r
        }\r
        if (ShellCommandLineGetFlag(Package, L"-n") || (Resp != NULL && *Resp == ShellPromptResponseYes)) {\r
          Status = gBS->UnloadImage(TheHandle);\r
          ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_HANDLE_RESULT), gShellDriver1HiiHandle, L"Unload", (UINTN)TheHandle, Status);\r
        }\r
        SHELL_FREE_NON_NULL(Resp);\r
      }\r
    }\r
  }\r
  if (ShellStatus == SHELL_SUCCESS) {\r
    if (Status == EFI_SECURITY_VIOLATION) {\r
      ShellStatus = SHELL_SECURITY_VIOLATION;\r
    } else if (Status == EFI_INVALID_PARAMETER) {\r
      ShellStatus = SHELL_INVALID_PARAMETER;\r
    } else if (EFI_ERROR(Status)) {\r
      ShellStatus = SHELL_NOT_FOUND;\r
    }\r
  }\r
\r
  if (Package != NULL) {\r
    ShellCommandLineFreeVarList(Package);\r
  }\r
\r
  return (ShellStatus);\r
}\r
Commit	Line	Data
4ba49616	1	/** @file\r
	2	Main file for Unload shell Driver1 function.\r
	3	\r
361a8267	4	Copyright (c) 2010 - 2011, Intel Corporation. All rights reserved.<BR>\r
4ba49616	5	This program and the accompanying materials\r
	6	are licensed and made available under the terms and conditions of the BSD License\r
	7	which accompanies this distribution. The full text of the license may be found at\r
	8	http://opensource.org/licenses/bsd-license.php\r
	9	\r
	10	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
	11	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
	12	\r
	13	**/\r
	14	\r
	15	#include "UefiShellDriver1CommandsLib.h"\r
	16	\r
	17	/**\r
	18	Function to translate the EFI_MEMORY_TYPE into a string.\r
	19	\r
	20	@param[in] Memory The memory type.\r
	21	\r
	22	@retval A string representation of the type allocated from BS Pool.\r
	23	**/\r
	24	CHAR16*\r
	25	EFIAPI\r
	26	ConvertMemoryType (\r
	27	IN CONST EFI_MEMORY_TYPE Memory\r
	28	)\r
	29	{\r
	30	CHAR16 *RetVal;\r
	31	RetVal = NULL;\r
	32	\r
	33	switch (Memory) {\r
	34	case EfiReservedMemoryType: StrnCatGrow(&RetVal, NULL, L"EfiReservedMemoryType", 0); break;\r
	35	case EfiLoaderCode: StrnCatGrow(&RetVal, NULL, L"EfiLoaderCode", 0); break;\r
	36	case EfiLoaderData: StrnCatGrow(&RetVal, NULL, L"EfiLoaderData", 0); break;\r
	37	case EfiBootServicesCode: StrnCatGrow(&RetVal, NULL, L"EfiBootServicesCode", 0); break;\r
	38	case EfiBootServicesData: StrnCatGrow(&RetVal, NULL, L"EfiBootServicesData", 0); break;\r
	39	case EfiRuntimeServicesCode: StrnCatGrow(&RetVal, NULL, L"EfiRuntimeServicesCode", 0); break;\r
	40	case EfiRuntimeServicesData: StrnCatGrow(&RetVal, NULL, L"EfiRuntimeServicesData", 0); break;\r
	41	case EfiConventionalMemory: StrnCatGrow(&RetVal, NULL, L"EfiConventionalMemory", 0); break;\r
	42	case EfiUnusableMemory: StrnCatGrow(&RetVal, NULL, L"EfiUnusableMemory", 0); break;\r
	43	case EfiACPIReclaimMemory: StrnCatGrow(&RetVal, NULL, L"EfiACPIReclaimMemory", 0); break;\r
	44	case EfiACPIMemoryNVS: StrnCatGrow(&RetVal, NULL, L"EfiACPIMemoryNVS", 0); break;\r
	45	case EfiMemoryMappedIO: StrnCatGrow(&RetVal, NULL, L"EfiMemoryMappedIO", 0); break;\r
	46	case EfiMemoryMappedIOPortSpace: StrnCatGrow(&RetVal, NULL, L"EfiMemoryMappedIOPortSpace", 0); break;\r
	47	case EfiPalCode: StrnCatGrow(&RetVal, NULL, L"EfiPalCode", 0); break;\r
	48	case EfiMaxMemoryType: StrnCatGrow(&RetVal, NULL, L"EfiMaxMemoryType", 0); break;\r
	49	default: ASSERT(FALSE);\r
	50	}\r
	51	return (RetVal);\r
	52	}\r
	53	\r
	54	/**\r
	55	Function to dump LoadedImage info from TheHandle.\r
	56	\r
	57	@param[in] TheHandle The handle to dump info from.\r
	58	\r
	59	@retval EFI_SUCCESS The info was dumped.\r
	60	@retval EFI_INVALID_PARAMETER The handle did not have LoadedImage\r
	61	**/\r
	62	EFI_STATUS\r
	63	EFIAPI\r
	64	DumpLoadedImageProtocolInfo (\r
	65	IN EFI_HANDLE TheHandle\r
	66	)\r
	67	{\r
	68	EFI_LOADED_IMAGE_PROTOCOL *Image;\r
69	EFI_STATUS Status;\r
70	EFI_DEVICE_PATH_TO_TEXT_PROTOCOL *DevicePathToText;\r
71	CHAR16 *DevicePathText;\r
72	CHAR16 *CodeTypeText;\r
73	CHAR16 *DataTypeText;\r
74	CHAR8 *PdbPointer;\r
75	\r
76	Image = NULL;\r
77	\r
78	Status = gBS->OpenProtocol(TheHandle, &gEfiLoadedImageProtocolGuid, (VOID**)&Image, gImageHandle, NULL, EFI_OPEN_PROTOCOL_GET_PROTOCOL);\r
79	if (EFI_ERROR(Status)) {\r
80	return (EFI_INVALID_PARAMETER);\r
81	}\r
82	\r
83	Status = gBS->LocateProtocol(\r
84	&gEfiDevicePathToTextProtocolGuid,\r
85	NULL,\r
86	(VOID**)&DevicePathToText);\r
87	//\r
88	// we now have the device path to text protocol\r
89	//\r
90	if (!EFI_ERROR(Status)) {\r
91	DevicePathText = DevicePathToText->ConvertDevicePathToText(Image->FilePath, TRUE, TRUE);\r
92	} else {\r
93	DevicePathText = NULL;\r
94	}\r
95	\r
96	CodeTypeText = ConvertMemoryType(Image->ImageCodeType);\r
97	DataTypeText = ConvertMemoryType(Image->ImageDataType);\r
98	PdbPointer = (CHAR8*)PeCoffLoaderGetPdbPointer(Image->ImageBase);\r
99	ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_UNLOAD_VERBOSE), gShellDriver1HiiHandle,\r
100	ConvertHandleToHandleIndex(TheHandle),\r
101	TheHandle,\r
102	Image,\r
103	Image->ParentHandle,\r
104	Image->SystemTable,\r
105	Image->DeviceHandle,\r
106	DevicePathText,\r
107	PdbPointer,\r
108	Image->ImageBase,\r
109	Image->ImageSize,\r
110	CodeTypeText,\r
111	DataTypeText\r
112	);\r
113	\r
114	SHELL_FREE_NON_NULL(DevicePathText);\r
115	SHELL_FREE_NON_NULL(CodeTypeText);\r
116	SHELL_FREE_NON_NULL(DataTypeText);\r
117	\r
118	return (EFI_SUCCESS);\r
119	}\r
120	\r
121	STATIC CONST SHELL_PARAM_ITEM ParamList[] = {\r
122	{L"-n", TypeFlag},\r
123	{L"-v", TypeFlag},\r
124	{L"-verbose", TypeFlag},\r
125	{NULL, TypeMax}\r
126	};\r
127	\r
128	/**\r
129	Function for 'unload' command.\r
130	\r
131	@param[in] ImageHandle Handle to the Image (NULL if Internal).\r
132	@param[in] SystemTable Pointer to the System Table (NULL if Internal).\r
133	**/\r
134	SHELL_STATUS\r
135	EFIAPI\r
136	ShellCommandRunUnload (\r
137	IN EFI_HANDLE ImageHandle,\r
138	IN EFI_SYSTEM_TABLE *SystemTable\r
139	)\r
140	{\r
141	EFI_STATUS Status;\r
142	LIST_ENTRY *Package;\r
143	CHAR16 *ProblemParam;\r
144	SHELL_STATUS ShellStatus;\r
145	EFI_HANDLE TheHandle;\r
146	CONST CHAR16 *Param1;\r
147	SHELL_PROMPT_RESPONSE *Resp;\r
361a8267	148	UINT64 Value;\r
4ba49616	149	\r
	150	ShellStatus = SHELL_SUCCESS;\r
	151	Package = NULL;\r
	152	Resp = NULL;\r
361a8267	153	Value = 0;\r
361a8267	154	TheHandle = NULL;\r
4ba49616	155	\r
	156	//\r
	157	// initialize the shell lib (we must be in non-auto-init...)\r
	158	//\r
	159	Status = ShellInitialize();\r
	160	ASSERT_EFI_ERROR(Status);\r
	161	\r
	162	//\r
	163	// parse the command line\r
	164	//\r
	165	Status = ShellCommandLineParse (ParamList, &Package, &ProblemParam, TRUE);\r
	166	if (EFI_ERROR(Status)) {\r
	167	if (Status == EFI_VOLUME_CORRUPTED && ProblemParam != NULL) {\r
	168	ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_PROBLEM), gShellDriver1HiiHandle, ProblemParam);\r
	169	FreePool(ProblemParam);\r
	170	ShellStatus = SHELL_INVALID_PARAMETER;\r
	171	} else {\r
	172	ASSERT(FALSE);\r
	173	}\r
	174	} else {\r
	175	if (ShellCommandLineGetCount(Package) > 2){\r
	176	//\r
	177	// error for too many parameters\r
	178	//\r
	179	ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_TOO_MANY), gShellDriver1HiiHandle);\r
	180	ShellStatus = SHELL_INVALID_PARAMETER;\r
	181	} else if (ShellCommandLineGetCount(Package) < 2) {\r
	182	ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_TOO_FEW), gShellDriver1HiiHandle);\r
	183	ShellStatus = SHELL_INVALID_PARAMETER;\r
	184	} else {\r
361a8267	185	Param1 = ShellCommandLineGetRawValue(Package, 1);\r
	186	if (Param1 != NULL) {\r
	187	Status = ShellConvertStringToUint64(Param1, &Value, TRUE, FALSE);\r
	188	TheHandle = ConvertHandleIndexToHandle((UINTN)Value);\r
	189	}\r
	190	\r
	191	if (EFI_ERROR(Status) \|\| Param1 == NULL \|\| TheHandle == NULL){\r
4ba49616	192	ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_INV_HANDLE), gShellDriver1HiiHandle, Param1);\r
	193	ShellStatus = SHELL_INVALID_PARAMETER;\r
	194	} else {\r
4ba49616	195	ASSERT(TheHandle != NULL);\r
	196	if (ShellCommandLineGetFlag(Package, L"-v") \|\| ShellCommandLineGetFlag(Package, L"-verbose")) {\r
	197	DumpLoadedImageProtocolInfo(TheHandle);\r
	198	}\r
	199	\r
	200	if (!ShellCommandLineGetFlag(Package, L"-n")) {\r
361a8267	201	Status = ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN(STR_UNLOAD_CONF), gShellDriver1HiiHandle, (UINTN)TheHandle);\r
4ba49616	202	Status = ShellPromptForResponse(ShellPromptResponseTypeYesNo, NULL, (VOID**)&Resp);\r
	203	}\r
	204	if (ShellCommandLineGetFlag(Package, L"-n") \|\| (Resp != NULL && *Resp == ShellPromptResponseYes)) {\r
	205	Status = gBS->UnloadImage(TheHandle);\r
361a8267	206	ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_HANDLE_RESULT), gShellDriver1HiiHandle, L"Unload", (UINTN)TheHandle, Status);\r
4ba49616	207	}\r
	208	SHELL_FREE_NON_NULL(Resp);\r
	209	}\r
	210	}\r
	211	}\r
	212	if (ShellStatus == SHELL_SUCCESS) {\r
	213	if (Status == EFI_SECURITY_VIOLATION) {\r
	214	ShellStatus = SHELL_SECURITY_VIOLATION;\r
	215	} else if (Status == EFI_INVALID_PARAMETER) {\r
	216	ShellStatus = SHELL_INVALID_PARAMETER;\r
	217	} else if (EFI_ERROR(Status)) {\r
	218	ShellStatus = SHELL_NOT_FOUND;\r
	219	}\r
	220	}\r
	221	\r
	222	if (Package != NULL) {\r
	223	ShellCommandLineFreeVarList(Package);\r
	224	}\r
	225	\r
	226	return (ShellStatus);\r
	227	}\r