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

/** @file\r
  Main file for DevTree 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
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
  //\r
  // If we are at the begining then we want root handles they have no parents and do have device path.\r
  //\r
  if (IndentCharCount == 0) {\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
      return SHELL_SUCCESS;\r
    }\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
\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
        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
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	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
	87	//\r
	88	// If we are at the begining then we want root handles they have no parents and do have device path.\r
	89	//\r
	90	if (IndentCharCount == 0) {\r
	91	Status = gBS->OpenProtocol (\r
	92	TheHandle,\r
	93	&gEfiDevicePathProtocolGuid,\r
	94	NULL,\r
	95	NULL,\r
	96	NULL,\r
	97	EFI_OPEN_PROTOCOL_TEST_PROTOCOL\r
	98	);\r
99	if (EFI_ERROR (Status)) {\r
100	return SHELL_SUCCESS;\r
101	}\r
102	}\r
103	\r
104	FormatString = AllocateZeroPool(StrSize(HiiString) + (10)*sizeof(FormatString[0]));\r
105	\r
106	ASSERT(HiiString != NULL);\r
107	ASSERT(FormatString != NULL);\r
108	\r
109	//\r
110	// we generate the format string on the fly so that we can control the\r
111	// number of space characters that the first (empty) string has. this\r
112	// handles the indenting.\r
113	//\r
114	\r
115	UnicodeSPrint(FormatString, StrSize(HiiString) + (10)*sizeof(FormatString[0]), L"%%%ds %s", IndentCharCount, HiiString);\r
116	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
117	//\r
118	// print out the information for ourselves\r
119	//\r
120	ShellPrintEx(\r
121	-1,\r
122	-1,\r
123	FormatString,\r
124	L"",\r
125	ConvertHandleToHandleIndex(TheHandle),\r
126	Name==NULL?L"Unknown":Name);\r
127	\r
128	FreePool(FormatString);\r
129	if (Name != NULL) {\r
130	FreePool(Name);\r
131	}\r
132	\r
133	//\r
134	// recurse on each child handle with IndentCharCount + 2\r
135	//\r
136	ParseHandleDatabaseForChildControllers(TheHandle, &ChildCount, &ChildHandleBuffer);\r
137	for (LoopVar = 0 ; LoopVar < ChildCount && ShellStatus == SHELL_SUCCESS; LoopVar++){\r
138	ShellStatus = DoDevTreeForHandle(ChildHandleBuffer[LoopVar], Lang, UseDevPaths, IndentCharCount+2, HiiString);\r
139	}\r
140	\r
141	if (ChildHandleBuffer != NULL) {\r
142	FreePool(ChildHandleBuffer);\r
143	}\r
144	\r
145	return (ShellStatus);\r
146	}\r
147	\r
148	/**\r
149	Function for 'devtree' command.\r
150	\r
151	@param[in] ImageHandle Handle to the Image (NULL if Internal).\r
152	@param[in] SystemTable Pointer to the System Table (NULL if Internal).\r
153	**/\r
154	SHELL_STATUS\r
155	EFIAPI\r
156	ShellCommandRunDevTree (\r
157	IN EFI_HANDLE ImageHandle,\r
158	IN EFI_SYSTEM_TABLE *SystemTable\r
159	)\r
160	{\r
161	EFI_STATUS Status;\r
162	LIST_ENTRY *Package;\r
163	CHAR16 *ProblemParam;\r
164	SHELL_STATUS ShellStatus;\r
165	CHAR8 *Language;\r
166	CONST CHAR16 *Lang;\r
167	CHAR16 *HiiString;\r
168	UINTN LoopVar;\r
169	EFI_HANDLE TheHandle;\r
170	BOOLEAN FlagD;\r
361a8267	171	UINT64 Intermediate;\r
4ba49616	172	\r
	173	ShellStatus = SHELL_SUCCESS;\r
	174	Status = EFI_SUCCESS;\r
	175	Language = NULL;\r
	176	\r
	177	//\r
	178	// initialize the shell lib (we must be in non-auto-init...)\r
	179	//\r
	180	Status = ShellInitialize();\r
	181	ASSERT_EFI_ERROR(Status);\r
	182	\r
	183	Status = CommandInit();\r
	184	ASSERT_EFI_ERROR(Status);\r
	185	\r
	186	//\r
	187	// parse the command line\r
	188	//\r
	189	Status = ShellCommandLineParse (ParamList, &Package, &ProblemParam, TRUE);\r
	190	if (EFI_ERROR(Status)) {\r
	191	if (Status == EFI_VOLUME_CORRUPTED && ProblemParam != NULL) {\r
	192	ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_PROBLEM), gShellDriver1HiiHandle, ProblemParam);\r
	193	FreePool(ProblemParam);\r
	194	ShellStatus = SHELL_INVALID_PARAMETER;\r
	195	} else {\r
	196	ASSERT(FALSE);\r
	197	}\r
	198	} else {\r
	199	if (ShellCommandLineGetCount(Package) > 2) {\r
	200	ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_TOO_MANY), gShellDriver1HiiHandle);\r
	201	ShellCommandLineFreeVarList (Package);\r
	202	return (SHELL_INVALID_PARAMETER);\r
	203	}\r
	204	Lang = ShellCommandLineGetValue(Package, L"-l");\r
	205	if (Lang != NULL) {\r
	206	Language = AllocateZeroPool(StrSize(Lang));\r
	207	AsciiSPrint(Language, StrSize(Lang), "%S", Lang);\r
	208	} else if (!ShellCommandLineGetFlag(Package, L"-l")){\r
	209	ASSERT(Language == NULL);\r
	210	// Language = AllocateZeroPool(10);\r
	211	// AsciiSPrint(Language, 10, "en-us");\r
	212	} else {\r
	213	ASSERT(Language == NULL);\r
	214	ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_NO_VALUE), gShellDriver1HiiHandle, L"-l");\r
	215	ShellCommandLineFreeVarList (Package);\r
	216	return (SHELL_INVALID_PARAMETER);\r
	217	}\r
	218	FlagD = ShellCommandLineGetFlag(Package, L"-d");\r
	219	\r
	220	Lang = ShellCommandLineGetRawValue(Package, 1);\r
	221	HiiString = HiiGetString(gShellDriver1HiiHandle, STRING_TOKEN (STR_DEV_TREE_OUTPUT), Language);\r
	222	\r
	223	if (Lang == NULL) {\r
	224	for (LoopVar = 1 ; ; LoopVar++){\r
	225	TheHandle = ConvertHandleIndexToHandle(LoopVar);\r
	226	if (TheHandle == NULL){\r
	227	break;\r
	228	}\r
	229	ShellStatus = DoDevTreeForHandle(TheHandle, Language, FlagD, 0, HiiString);\r
	230	}\r
	231	} else {\r
361a8267	232	Status = ShellConvertStringToUint64(Lang, &Intermediate, TRUE, FALSE);\r
361a8267	233	if (EFI_ERROR(Status) \|\| ConvertHandleIndexToHandle((UINTN)Intermediate) == NULL) {\r
4ba49616	234	ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_INV_HANDLE), gShellDriver1HiiHandle, Lang);\r
	235	ShellStatus = SHELL_INVALID_PARAMETER;\r
	236	} else {\r
361a8267	237	ShellStatus = DoDevTreeForHandle(ConvertHandleIndexToHandle((UINTN)Intermediate), Language, FlagD, 0, HiiString);\r
4ba49616	238	}\r
	239	}\r
	240	\r
	241	if (HiiString != NULL) {\r
	242	FreePool(HiiString);\r
	243	}\r
	244	SHELL_FREE_NON_NULL(Language);\r
	245	ShellCommandLineFreeVarList (Package);\r
	246	}\r
	247	\r
	248	return (ShellStatus);\r
	249	}\r