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

/** @file\r
  Main file for DevTree shell Driver1 function.\r
\r
  Copyright (c) 2010 - 2012, 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
STATIC CONST SHELL_PARAM_ITEM ParamList[] = {\r
  {L"-d", TypeFlag},\r
  {L"-l", TypeValue},\r
  {NULL, TypeMax}\r
  };\r
\r
/**\r
  Display a tree starting from this handle.\r
\r
  @param[in] TheHandle      The handle to start with.\r
  @param[in] Lang           Optionally, a UEFI defined language code.\r
  @param[in] UseDevPaths    TRUE to display info from DevPath as identifiers.\r
                            FALSE will use component name protocol instead.\r
  @param[in] IndentCharCount   How many characters to indent (allows for recursion).\r
  @param[in] HiiString      The string from HII to use for output.\r
\r
  @retval SHELL_SUCCESS     The operation was successful.\r
**/\r
SHELL_STATUS\r
EFIAPI\r
DoDevTreeForHandle(\r
  IN CONST EFI_HANDLE TheHandle,\r
  IN CONST CHAR8      *Lang OPTIONAL,\r
  IN CONST BOOLEAN    UseDevPaths,\r
  IN CONST UINTN      IndentCharCount,\r
  IN CONST CHAR16     *HiiString\r
  )\r
{\r
  SHELL_STATUS        ShellStatus;\r
  EFI_STATUS          Status;\r
  CHAR16              *FormatString;\r
  CHAR16              *Name;\r
  EFI_HANDLE          *ChildHandleBuffer;\r
  UINTN               ChildCount;\r
  UINTN               LoopVar;\r
\r
  Status              = EFI_SUCCESS;\r
  ShellStatus         = SHELL_SUCCESS;\r
  Name                = NULL;\r
  ChildHandleBuffer   = NULL;\r
  ChildCount          = 0;\r
\r
  ASSERT(TheHandle    != NULL);\r
  //\r
  // We want controller handles.  they will not have LoadedImage or DriverBinding (or others...)\r
  //\r
  Status = gBS->OpenProtocol (\r
                TheHandle,\r
                &gEfiDriverBindingProtocolGuid,\r
                NULL,\r
                NULL,\r
                NULL,\r
                EFI_OPEN_PROTOCOL_TEST_PROTOCOL\r
               );\r
  if (!EFI_ERROR (Status)) {\r
    return SHELL_SUCCESS;\r
  }\r
\r
  Status = gBS->OpenProtocol (\r
                TheHandle,\r
                &gEfiLoadedImageProtocolGuid,\r
                NULL,\r
                NULL,\r
                NULL,\r
                EFI_OPEN_PROTOCOL_TEST_PROTOCOL\r
               );\r
  if (!EFI_ERROR (Status)) {\r
    return SHELL_SUCCESS;\r
  }\r
\r
  FormatString        = AllocateZeroPool(StrSize(HiiString) + (10)*sizeof(FormatString[0]));\r
\r
  ASSERT(HiiString    != NULL);\r
  ASSERT(FormatString != NULL);\r
\r
  //\r
  // we generate the format string on the fly so that we can control the\r
  // number of space characters that the first (empty) string has.  this\r
  // handles the indenting.\r
  //\r
\r
  UnicodeSPrint(FormatString, StrSize(HiiString) + (10)*sizeof(FormatString[0]), L"%%%ds %s", IndentCharCount, HiiString);\r
  gEfiShellProtocol->GetDeviceName((EFI_HANDLE)TheHandle, !UseDevPaths?EFI_DEVICE_NAME_USE_COMPONENT_NAME|EFI_DEVICE_NAME_USE_DEVICE_PATH:EFI_DEVICE_NAME_USE_DEVICE_PATH, (CHAR8*)Lang, &Name);\r
  //\r
  // print out the information for ourselves\r
  //\r
  ShellPrintEx(\r
    -1,\r
    -1,\r
    FormatString,\r
    L"",\r
    ConvertHandleToHandleIndex(TheHandle),\r
    Name==NULL?L"Unknown":Name);\r
\r
  FreePool(FormatString);\r
  if (Name != NULL) {\r
    FreePool(Name);\r
  }\r
\r
  //\r
  // recurse on each child handle with IndentCharCount + 2\r
  //\r
  ParseHandleDatabaseForChildControllers(TheHandle, &ChildCount, &ChildHandleBuffer);\r
  for (LoopVar = 0 ; LoopVar < ChildCount && ShellStatus == SHELL_SUCCESS; LoopVar++){\r
    ShellStatus = DoDevTreeForHandle(ChildHandleBuffer[LoopVar], Lang, UseDevPaths, IndentCharCount+2, HiiString);\r
  }\r
\r
  if (ChildHandleBuffer != NULL) {\r
    FreePool(ChildHandleBuffer);\r
  }\r
\r
  return (ShellStatus);\r
}\r
\r
/**\r
  Function for 'devtree' 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
ShellCommandRunDevTree (\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
  CHAR8               *Language;\r
  CONST CHAR16        *Lang;\r
  CHAR16              *HiiString;\r
  UINTN               LoopVar;\r
  EFI_HANDLE          TheHandle;\r
  BOOLEAN             FlagD;\r
  UINT64              Intermediate;\r
  UINTN               ParentControllerHandleCount;\r
  EFI_HANDLE          *ParentControllerHandleBuffer;\r
\r
  ShellStatus         = SHELL_SUCCESS;\r
  Status              = EFI_SUCCESS;\r
  Language                = 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
  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), gShellDriver1HiiHandle, 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_MANY), gShellDriver1HiiHandle);\r
      ShellCommandLineFreeVarList (Package);\r
      return (SHELL_INVALID_PARAMETER);\r
    }\r
    Lang = ShellCommandLineGetValue(Package, L"-l");\r
    if (Lang != NULL) {\r
      Language = AllocateZeroPool(StrSize(Lang));\r
      AsciiSPrint(Language, StrSize(Lang), "%S", Lang);\r
    } else if (!ShellCommandLineGetFlag(Package, L"-l")){\r
      ASSERT(Language == NULL);\r
//      Language = AllocateZeroPool(10);\r
//      AsciiSPrint(Language, 10, "en-us");\r
    } else {\r
      ASSERT(Language == NULL);\r
      ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_NO_VALUE), gShellDriver1HiiHandle, L"-l");\r
      ShellCommandLineFreeVarList (Package);\r
      return (SHELL_INVALID_PARAMETER);\r
    }\r
    FlagD = ShellCommandLineGetFlag(Package, L"-d");\r
\r
    Lang = ShellCommandLineGetRawValue(Package, 1);\r
    HiiString = HiiGetString(gShellDriver1HiiHandle, STRING_TOKEN (STR_DEV_TREE_OUTPUT), Language);\r
\r
    if (Lang == NULL) {\r
      for (LoopVar = 1 ; ; LoopVar++){\r
        TheHandle = ConvertHandleIndexToHandle(LoopVar);\r
        if (TheHandle == NULL){\r
          break;\r
        }\r
\r
        //\r
        // Skip handles that do not have device path protocol\r
        //\r
        Status = gBS->OpenProtocol (\r
                      TheHandle,\r
                      &gEfiDevicePathProtocolGuid,\r
                      NULL,\r
                      NULL,\r
                      NULL,\r
                      EFI_OPEN_PROTOCOL_TEST_PROTOCOL\r
                     );\r
        if (EFI_ERROR (Status)) {\r
          continue;\r
        }\r
\r
        //\r
        // Skip handles that do have parents\r
        //\r
        ParentControllerHandleBuffer = NULL;\r
        Status = PARSE_HANDLE_DATABASE_PARENTS (\r
                   TheHandle,\r
                   &ParentControllerHandleCount,\r
                   &ParentControllerHandleBuffer\r
                   );\r
        SHELL_FREE_NON_NULL (ParentControllerHandleBuffer);\r
        if (ParentControllerHandleCount > 0) {\r
          continue;\r
        }\r
\r
        //\r
        // Start a devtree from TheHandle that has a device path and no parents\r
        //\r
        ShellStatus = DoDevTreeForHandle(TheHandle, Language, FlagD, 0, HiiString);\r
      }\r
    } else {\r
      Status = ShellConvertStringToUint64(Lang, &Intermediate, TRUE, FALSE);\r
      if (EFI_ERROR(Status) || ConvertHandleIndexToHandle((UINTN)Intermediate) == NULL) {\r
        ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_INV_HANDLE), gShellDriver1HiiHandle, Lang);\r
        ShellStatus = SHELL_INVALID_PARAMETER;\r
      } else {\r
        ShellStatus = DoDevTreeForHandle(ConvertHandleIndexToHandle((UINTN)Intermediate), Language, FlagD, 0, HiiString);\r
      }\r
    }\r
\r
    if (HiiString != NULL) {\r
      FreePool(HiiString);\r
    }\r
    SHELL_FREE_NON_NULL(Language);\r
    ShellCommandLineFreeVarList (Package);\r
  }\r
\r
  return (ShellStatus);\r
}\r
Commit	Line	Data
4ba49616	1	/** @file\r
	2	Main file for DevTree shell Driver1 function.\r
	3	\r
f330ff35	4	Copyright (c) 2010 - 2012, 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	STATIC CONST SHELL_PARAM_ITEM ParamList[] = {\r
	18	{L"-d", TypeFlag},\r
	19	{L"-l", TypeValue},\r
	20	{NULL, TypeMax}\r
	21	};\r
	22	\r
361a8267	23	/**\r
	24	Display a tree starting from this handle.\r
	25	\r
	26	@param[in] TheHandle The handle to start with.\r
	27	@param[in] Lang Optionally, a UEFI defined language code.\r
	28	@param[in] UseDevPaths TRUE to display info from DevPath as identifiers.\r
	29	FALSE will use component name protocol instead.\r
	30	@param[in] IndentCharCount How many characters to indent (allows for recursion).\r
	31	@param[in] HiiString The string from HII to use for output.\r
	32	\r
	33	@retval SHELL_SUCCESS The operation was successful.\r
	34	**/\r
4ba49616	35	SHELL_STATUS\r
	36	EFIAPI\r
	37	DoDevTreeForHandle(\r
	38	IN CONST EFI_HANDLE TheHandle,\r
	39	IN CONST CHAR8 *Lang OPTIONAL,\r
	40	IN CONST BOOLEAN UseDevPaths,\r
	41	IN CONST UINTN IndentCharCount,\r
	42	IN CONST CHAR16 *HiiString\r
	43	)\r
	44	{\r
	45	SHELL_STATUS ShellStatus;\r
	46	EFI_STATUS Status;\r
	47	CHAR16 *FormatString;\r
	48	CHAR16 *Name;\r
	49	EFI_HANDLE *ChildHandleBuffer;\r
	50	UINTN ChildCount;\r
	51	UINTN LoopVar;\r
	52	\r
	53	Status = EFI_SUCCESS;\r
	54	ShellStatus = SHELL_SUCCESS;\r
	55	Name = NULL;\r
	56	ChildHandleBuffer = NULL;\r
	57	ChildCount = 0;\r
	58	\r
	59	ASSERT(TheHandle != NULL);\r
	60	//\r
	61	// We want controller handles. they will not have LoadedImage or DriverBinding (or others...)\r
	62	//\r
	63	Status = gBS->OpenProtocol (\r
	64	TheHandle,\r
	65	&gEfiDriverBindingProtocolGuid,\r
	66	NULL,\r
	67	NULL,\r
	68	NULL,\r
	69	EFI_OPEN_PROTOCOL_TEST_PROTOCOL\r
	70	);\r
	71	if (!EFI_ERROR (Status)) {\r
	72	return SHELL_SUCCESS;\r
	73	}\r
	74	\r
	75	Status = gBS->OpenProtocol (\r
	76	TheHandle,\r
	77	&gEfiLoadedImageProtocolGuid,\r
	78	NULL,\r
	79	NULL,\r
	80	NULL,\r
	81	EFI_OPEN_PROTOCOL_TEST_PROTOCOL\r
	82	);\r
	83	if (!EFI_ERROR (Status)) {\r
	84	return SHELL_SUCCESS;\r
	85	}\r
	86	\r
4ba49616	87	FormatString = AllocateZeroPool(StrSize(HiiString) + (10)*sizeof(FormatString[0]));\r
	88	\r
	89	ASSERT(HiiString != NULL);\r
	90	ASSERT(FormatString != NULL);\r
	91	\r
	92	//\r
	93	// we generate the format string on the fly so that we can control the\r
	94	// number of space characters that the first (empty) string has. this\r
	95	// handles the indenting.\r
	96	//\r
	97	\r
	98	UnicodeSPrint(FormatString, StrSize(HiiString) + (10)*sizeof(FormatString[0]), L"%%%ds %s", IndentCharCount, HiiString);\r
	99	gEfiShellProtocol->GetDeviceName((EFI_HANDLE)TheHandle, !UseDevPaths?EFI_DEVICE_NAME_USE_COMPONENT_NAME\|EFI_DEVICE_NAME_USE_DEVICE_PATH:EFI_DEVICE_NAME_USE_DEVICE_PATH, (CHAR8*)Lang, &Name);\r
	100	//\r
	101	// print out the information for ourselves\r
	102	//\r
	103	ShellPrintEx(\r
	104	-1,\r
	105	-1,\r
	106	FormatString,\r
	107	L"",\r
	108	ConvertHandleToHandleIndex(TheHandle),\r
	109	Name==NULL?L"Unknown":Name);\r
	110	\r
	111	FreePool(FormatString);\r
	112	if (Name != NULL) {\r
	113	FreePool(Name);\r
	114	}\r
	115	\r
	116	//\r
	117	// recurse on each child handle with IndentCharCount + 2\r
	118	//\r
	119	ParseHandleDatabaseForChildControllers(TheHandle, &ChildCount, &ChildHandleBuffer);\r
	120	for (LoopVar = 0 ; LoopVar < ChildCount && ShellStatus == SHELL_SUCCESS; LoopVar++){\r
	121	ShellStatus = DoDevTreeForHandle(ChildHandleBuffer[LoopVar], Lang, UseDevPaths, IndentCharCount+2, HiiString);\r
	122	}\r
	123	\r
	124	if (ChildHandleBuffer != NULL) {\r
	125	FreePool(ChildHandleBuffer);\r
	126	}\r
	127	\r
	128	return (ShellStatus);\r
	129	}\r
	130	\r
	131	/**\r
	132	Function for 'devtree' command.\r
	133	\r
	134	@param[in] ImageHandle Handle to the Image (NULL if Internal).\r
	135	@param[in] SystemTable Pointer to the System Table (NULL if Internal).\r
	136	**/\r
	137	SHELL_STATUS\r
	138	EFIAPI\r
	139	ShellCommandRunDevTree (\r
	140	IN EFI_HANDLE ImageHandle,\r
	141	IN EFI_SYSTEM_TABLE *SystemTable\r
	142	)\r
	143	{\r
	144	EFI_STATUS Status;\r
	145	LIST_ENTRY *Package;\r
	146	CHAR16 *ProblemParam;\r
	147	SHELL_STATUS ShellStatus;\r
	148	CHAR8 *Language;\r
	149	CONST CHAR16 *Lang;\r
	150	CHAR16 *HiiString;\r
151	UINTN LoopVar;\r
152	EFI_HANDLE TheHandle;\r
153	BOOLEAN FlagD;\r
361a8267	154	UINT64 Intermediate;\r
f330ff35	155	UINTN ParentControllerHandleCount;\r
f330ff35	156	EFI_HANDLE *ParentControllerHandleBuffer;\r
4ba49616	157	\r
	158	ShellStatus = SHELL_SUCCESS;\r
	159	Status = EFI_SUCCESS;\r
	160	Language = NULL;\r
	161	\r
	162	//\r
	163	// initialize the shell lib (we must be in non-auto-init...)\r
	164	//\r
	165	Status = ShellInitialize();\r
	166	ASSERT_EFI_ERROR(Status);\r
	167	\r
	168	Status = CommandInit();\r
	169	ASSERT_EFI_ERROR(Status);\r
	170	\r
	171	//\r
	172	// parse the command line\r
	173	//\r
	174	Status = ShellCommandLineParse (ParamList, &Package, &ProblemParam, TRUE);\r
	175	if (EFI_ERROR(Status)) {\r
	176	if (Status == EFI_VOLUME_CORRUPTED && ProblemParam != NULL) {\r
	177	ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_PROBLEM), gShellDriver1HiiHandle, ProblemParam);\r
	178	FreePool(ProblemParam);\r
	179	ShellStatus = SHELL_INVALID_PARAMETER;\r
	180	} else {\r
	181	ASSERT(FALSE);\r
	182	}\r
	183	} else {\r
	184	if (ShellCommandLineGetCount(Package) > 2) {\r
	185	ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_TOO_MANY), gShellDriver1HiiHandle);\r
	186	ShellCommandLineFreeVarList (Package);\r
	187	return (SHELL_INVALID_PARAMETER);\r
	188	}\r
	189	Lang = ShellCommandLineGetValue(Package, L"-l");\r
	190	if (Lang != NULL) {\r
	191	Language = AllocateZeroPool(StrSize(Lang));\r
	192	AsciiSPrint(Language, StrSize(Lang), "%S", Lang);\r
	193	} else if (!ShellCommandLineGetFlag(Package, L"-l")){\r
	194	ASSERT(Language == NULL);\r
	195	// Language = AllocateZeroPool(10);\r
	196	// AsciiSPrint(Language, 10, "en-us");\r
	197	} else {\r
	198	ASSERT(Language == NULL);\r
	199	ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_NO_VALUE), gShellDriver1HiiHandle, L"-l");\r
	200	ShellCommandLineFreeVarList (Package);\r
	201	return (SHELL_INVALID_PARAMETER);\r
	202	}\r
	203	FlagD = ShellCommandLineGetFlag(Package, L"-d");\r
	204	\r
	205	Lang = ShellCommandLineGetRawValue(Package, 1);\r
	206	HiiString = HiiGetString(gShellDriver1HiiHandle, STRING_TOKEN (STR_DEV_TREE_OUTPUT), Language);\r
	207	\r
	208	if (Lang == NULL) {\r
	209	for (LoopVar = 1 ; ; LoopVar++){\r
	210	TheHandle = ConvertHandleIndexToHandle(LoopVar);\r
	211	if (TheHandle == NULL){\r
	212	break;\r
	213	}\r
f330ff35	214	\r
	215	//\r
	216	// Skip handles that do not have device path protocol\r
	217	//\r
	218	Status = gBS->OpenProtocol (\r
	219	TheHandle,\r
	220	&gEfiDevicePathProtocolGuid,\r
	221	NULL,\r
	222	NULL,\r
	223	NULL,\r
	224	EFI_OPEN_PROTOCOL_TEST_PROTOCOL\r
	225	);\r
	226	if (EFI_ERROR (Status)) {\r
	227	continue;\r
	228	}\r
	229	\r
	230	//\r
	231	// Skip handles that do have parents\r
	232	//\r
	233	ParentControllerHandleBuffer = NULL;\r
	234	Status = PARSE_HANDLE_DATABASE_PARENTS (\r
	235	TheHandle,\r
	236	&ParentControllerHandleCount,\r
	237	&ParentControllerHandleBuffer\r
	238	);\r
	239	SHELL_FREE_NON_NULL (ParentControllerHandleBuffer);\r
	240	if (ParentControllerHandleCount > 0) {\r
	241	continue;\r
	242	}\r
	243	\r
	244	//\r
	245	// Start a devtree from TheHandle that has a device path and no parents\r
	246	//\r
4ba49616	247	ShellStatus = DoDevTreeForHandle(TheHandle, Language, FlagD, 0, HiiString);\r
	248	}\r
	249	} else {\r
361a8267	250	Status = ShellConvertStringToUint64(Lang, &Intermediate, TRUE, FALSE);\r
361a8267	251	if (EFI_ERROR(Status) \|\| ConvertHandleIndexToHandle((UINTN)Intermediate) == NULL) {\r
4ba49616	252	ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_INV_HANDLE), gShellDriver1HiiHandle, Lang);\r
	253	ShellStatus = SHELL_INVALID_PARAMETER;\r
	254	} else {\r
361a8267	255	ShellStatus = DoDevTreeForHandle(ConvertHandleIndexToHandle((UINTN)Intermediate), Language, FlagD, 0, HiiString);\r
4ba49616	256	}\r
	257	}\r
	258	\r
	259	if (HiiString != NULL) {\r
	260	FreePool(HiiString);\r
	261	}\r
	262	SHELL_FREE_NON_NULL(Language);\r
	263	ShellCommandLineFreeVarList (Package);\r
	264	}\r
	265	\r
	266	return (ShellStatus);\r
	267	}\r