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

/** @file\r
  Main file for OpenInfo shell Driver1 function.\r
\r
  (C) Copyright 2015 Hewlett-Packard Development Company, L.P.<BR>\r
  Copyright (c) 2010 - 2018, 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 CHAR16 StringHandProt[]  = L"HandProt ";\r
STATIC CONST CHAR16 StringGetProt[]   = L"GetProt  ";\r
STATIC CONST CHAR16 StringTestProt[]  = L"TestProt ";\r
STATIC CONST CHAR16 StringChild[]     = L"Child    ";\r
STATIC CONST CHAR16 StringDriver[]    = L"Driver   ";\r
STATIC CONST CHAR16 StringExclusive[] = L"Exclusive";\r
STATIC CONST CHAR16 StringDriverEx[]  = L"DriverEx ";\r
STATIC CONST CHAR16 StringUnknown[]   = L"Unknown  ";\r
\r
/**\r
  Open the database and print out all the info about TheHandle.\r
\r
  @param[in] TheHandle      The handle to print info on.\r
\r
  @retval EFI_SUCCESS           The operation was successful.\r
  @retval EFI_INVALID_PARAMETER TheHandle was NULL.\r
**/\r
EFI_STATUS\r
TraverseHandleDatabase (\r
  IN CONST EFI_HANDLE TheHandle\r
  )\r
{\r
  EFI_STATUS                          Status;\r
  EFI_GUID                            **ProtocolGuidArray;\r
  UINTN                               ArrayCount;\r
  UINTN                               ProtocolIndex;\r
  EFI_OPEN_PROTOCOL_INFORMATION_ENTRY *OpenInfo;\r
  UINTN                               OpenInfoCount;\r
  UINTN                               OpenInfoIndex;\r
  CONST CHAR16                        *OpenTypeString;\r
  CHAR16                              *TempString;\r
  UINTN                               HandleIndex;\r
  CONST CHAR16                        *Name;\r
  UINTN                               ControllerIndex;\r
\r
  if (TheHandle == NULL) {\r
    return (EFI_INVALID_PARAMETER);\r
  }\r
\r
  //\r
  // Retrieve the list of all the protocols on the handle\r
  //\r
  Status = gBS->ProtocolsPerHandle (\r
                TheHandle,\r
                &ProtocolGuidArray,\r
                &ArrayCount\r
               );\r
  ASSERT_EFI_ERROR(Status);\r
  if (!EFI_ERROR (Status)) {\r
\r
    for (ProtocolIndex = 0; ProtocolIndex < ArrayCount; ProtocolIndex++) {\r
      //\r
      // print out the human readable name for this one.\r
      //\r
      TempString = GetStringNameFromGuid(ProtocolGuidArray[ProtocolIndex], NULL);\r
      if (TempString == NULL) {\r
        continue;\r
      }\r
      ShellPrintEx(-1, -1, L"%H%s%N\r\n", TempString);\r
      FreePool(TempString);\r
\r
      //\r
      // Retrieve the list of agents that have opened each protocol\r
      //\r
      Status = gBS->OpenProtocolInformation (\r
                    TheHandle,\r
                    ProtocolGuidArray[ProtocolIndex],\r
                    &OpenInfo,\r
                    &OpenInfoCount\r
                   );\r
      ASSERT_EFI_ERROR(Status);\r
      if (!EFI_ERROR (Status)) {\r
        for (OpenInfoIndex = 0; OpenInfoIndex < OpenInfoCount; OpenInfoIndex++) {\r
          switch (OpenInfo[OpenInfoIndex].Attributes) {\r
            case EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL:  OpenTypeString = StringHandProt;  break;\r
            case EFI_OPEN_PROTOCOL_GET_PROTOCOL:        OpenTypeString = StringGetProt;   break;\r
            case EFI_OPEN_PROTOCOL_TEST_PROTOCOL:       OpenTypeString = StringTestProt;  break;\r
            case EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER: OpenTypeString = StringChild;     break;\r
            case EFI_OPEN_PROTOCOL_BY_DRIVER:           OpenTypeString = StringDriver;    break;\r
            case EFI_OPEN_PROTOCOL_EXCLUSIVE:           OpenTypeString = StringExclusive; break;\r
            case EFI_OPEN_PROTOCOL_BY_DRIVER|EFI_OPEN_PROTOCOL_EXCLUSIVE:\r
                                                        OpenTypeString = StringDriverEx;  break;\r
            default:                                    OpenTypeString = StringUnknown;   break;\r
          }\r
          HandleIndex     = ConvertHandleToHandleIndex(OpenInfo[OpenInfoIndex].AgentHandle);\r
          Name            = GetStringNameFromHandle(OpenInfo[OpenInfoIndex].AgentHandle, NULL);\r
          ControllerIndex = ConvertHandleToHandleIndex(OpenInfo[OpenInfoIndex].ControllerHandle);\r
          if (ControllerIndex != 0) {\r
            ShellPrintHiiEx(\r
              -1,\r
              -1,\r
              NULL,\r
              STRING_TOKEN(STR_OPENINFO_LINE),\r
              gShellDriver1HiiHandle,\r
              HandleIndex,\r
              ControllerIndex,\r
              OpenInfo[OpenInfoIndex].OpenCount,\r
              OpenTypeString,\r
              Name\r
             );\r
          } else {\r
            ShellPrintHiiEx(\r
              -1,\r
              -1,\r
              NULL,\r
              STRING_TOKEN(STR_OPENINFO_MIN_LINE),\r
              gShellDriver1HiiHandle,\r
              HandleIndex,\r
              OpenInfo[OpenInfoIndex].OpenCount,\r
              OpenTypeString,\r
              Name\r
             );\r
          }\r
        }\r
        FreePool (OpenInfo);\r
      }\r
    }\r
    FreePool (ProtocolGuidArray);\r
  }\r
\r
  return Status;\r
}\r
\r
/**\r
  Function for 'openinfo' 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
ShellCommandRunOpenInfo (\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
  UINT64              Intermediate;\r
\r
  ShellStatus         = SHELL_SUCCESS;\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 (EmptyParamList, &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, L"openinfo", 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, L"openinfo");\r
      ShellStatus = SHELL_INVALID_PARAMETER;\r
    } else if (ShellCommandLineGetCount(Package) == 0) {\r
      ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_TOO_FEW), gShellDriver1HiiHandle, L"openinfo");\r
      ShellStatus = SHELL_INVALID_PARAMETER;\r
    } else {\r
      Param1 = ShellCommandLineGetRawValue(Package, 1);\r
      Status = ShellConvertStringToUint64(Param1, &Intermediate, TRUE, FALSE);\r
      if (EFI_ERROR(Status) || Param1 == NULL || ConvertHandleIndexToHandle((UINTN)Intermediate) == NULL){\r
        ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_INV_HANDLE), gShellDriver1HiiHandle, L"openinfo", Param1);\r
        ShellStatus = SHELL_INVALID_PARAMETER;\r
      } else {\r
        TheHandle = ConvertHandleIndexToHandle((UINTN)Intermediate);\r
        ASSERT(TheHandle != NULL);\r
        ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_OPENINFO_HEADER_LINE), gShellDriver1HiiHandle, (UINTN)Intermediate, TheHandle);\r
\r
        Status = TraverseHandleDatabase (TheHandle);\r
        if (!EFI_ERROR(Status)) {\r
        } else {\r
          ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_INV_HANDLE), gShellDriver1HiiHandle, L"openinfo", Param1);\r
          ShellStatus = SHELL_NOT_FOUND;\r
        }\r
      }\r
    }\r
  }\r
  return (ShellStatus);\r
}\r
Commit	Line	Data
4ba49616	1	/** @file\r
	2	Main file for OpenInfo shell Driver1 function.\r
	3	\r
c011b6c9	4	(C) Copyright 2015 Hewlett-Packard Development Company, L.P.<BR>\r
ba0014b9	5	Copyright (c) 2010 - 2018, Intel Corporation. All rights reserved.<BR>\r
4ba49616	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 "UefiShellDriver1CommandsLib.h"\r
	17	\r
	18	STATIC CONST CHAR16 StringHandProt[] = L"HandProt ";\r
	19	STATIC CONST CHAR16 StringGetProt[] = L"GetProt ";\r
	20	STATIC CONST CHAR16 StringTestProt[] = L"TestProt ";\r
	21	STATIC CONST CHAR16 StringChild[] = L"Child ";\r
	22	STATIC CONST CHAR16 StringDriver[] = L"Driver ";\r
	23	STATIC CONST CHAR16 StringExclusive[] = L"Exclusive";\r
	24	STATIC CONST CHAR16 StringDriverEx[] = L"DriverEx ";\r
	25	STATIC CONST CHAR16 StringUnknown[] = L"Unknown ";\r
	26	\r
361a8267	27	/**\r
	28	Open the database and print out all the info about TheHandle.\r
	29	\r
	30	@param[in] TheHandle The handle to print info on.\r
	31	\r
	32	@retval EFI_SUCCESS The operation was successful.\r
	33	@retval EFI_INVALID_PARAMETER TheHandle was NULL.\r
	34	**/\r
4ba49616	35	EFI_STATUS\r
4ba49616	36	TraverseHandleDatabase (\r
	37	IN CONST EFI_HANDLE TheHandle\r
	38	)\r
	39	{\r
	40	EFI_STATUS Status;\r
	41	EFI_GUID **ProtocolGuidArray;\r
	42	UINTN ArrayCount;\r
	43	UINTN ProtocolIndex;\r
	44	EFI_OPEN_PROTOCOL_INFORMATION_ENTRY *OpenInfo;\r
	45	UINTN OpenInfoCount;\r
	46	UINTN OpenInfoIndex;\r
	47	CONST CHAR16 *OpenTypeString;\r
	48	CHAR16 *TempString;\r
	49	UINTN HandleIndex;\r
	50	CONST CHAR16 *Name;\r
f330ff35	51	UINTN ControllerIndex;\r
4ba49616	52	\r
361a8267	53	if (TheHandle == NULL) {\r
	54	return (EFI_INVALID_PARAMETER);\r
	55	}\r
4ba49616	56	\r
	57	//\r
	58	// Retrieve the list of all the protocols on the handle\r
	59	//\r
	60	Status = gBS->ProtocolsPerHandle (\r
	61	TheHandle,\r
	62	&ProtocolGuidArray,\r
	63	&ArrayCount\r
	64	);\r
	65	ASSERT_EFI_ERROR(Status);\r
	66	if (!EFI_ERROR (Status)) {\r
	67	\r
	68	for (ProtocolIndex = 0; ProtocolIndex < ArrayCount; ProtocolIndex++) {\r
	69	//\r
	70	// print out the human readable name for this one.\r
	71	//\r
	72	TempString = GetStringNameFromGuid(ProtocolGuidArray[ProtocolIndex], NULL);\r
	73	if (TempString == NULL) {\r
	74	continue;\r
	75	}\r
	76	ShellPrintEx(-1, -1, L"%H%s%N\r\n", TempString);\r
	77	FreePool(TempString);\r
	78	\r
	79	//\r
	80	// Retrieve the list of agents that have opened each protocol\r
	81	//\r
	82	Status = gBS->OpenProtocolInformation (\r
	83	TheHandle,\r
	84	ProtocolGuidArray[ProtocolIndex],\r
	85	&OpenInfo,\r
	86	&OpenInfoCount\r
	87	);\r
	88	ASSERT_EFI_ERROR(Status);\r
	89	if (!EFI_ERROR (Status)) {\r
	90	for (OpenInfoIndex = 0; OpenInfoIndex < OpenInfoCount; OpenInfoIndex++) {\r
	91	switch (OpenInfo[OpenInfoIndex].Attributes) {\r
	92	case EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL: OpenTypeString = StringHandProt; break;\r
	93	case EFI_OPEN_PROTOCOL_GET_PROTOCOL: OpenTypeString = StringGetProt; break;\r
	94	case EFI_OPEN_PROTOCOL_TEST_PROTOCOL: OpenTypeString = StringTestProt; break;\r
	95	case EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER: OpenTypeString = StringChild; break;\r
	96	case EFI_OPEN_PROTOCOL_BY_DRIVER: OpenTypeString = StringDriver; break;\r
	97	case EFI_OPEN_PROTOCOL_EXCLUSIVE: OpenTypeString = StringExclusive; break;\r
	98	case EFI_OPEN_PROTOCOL_BY_DRIVER\|EFI_OPEN_PROTOCOL_EXCLUSIVE:\r
	99	OpenTypeString = StringDriverEx; break;\r
	100	default: OpenTypeString = StringUnknown; break;\r
	101	}\r
f330ff35	102	HandleIndex = ConvertHandleToHandleIndex(OpenInfo[OpenInfoIndex].AgentHandle);\r
	103	Name = GetStringNameFromHandle(OpenInfo[OpenInfoIndex].AgentHandle, NULL);\r
	104	ControllerIndex = ConvertHandleToHandleIndex(OpenInfo[OpenInfoIndex].ControllerHandle);\r
	105	if (ControllerIndex != 0) {\r
4ba49616	106	ShellPrintHiiEx(\r
	107	-1,\r
	108	-1,\r
	109	NULL,\r
	110	STRING_TOKEN(STR_OPENINFO_LINE),\r
	111	gShellDriver1HiiHandle,\r
	112	HandleIndex,\r
f330ff35	113	ControllerIndex,\r
4ba49616	114	OpenInfo[OpenInfoIndex].OpenCount,\r
	115	OpenTypeString,\r
	116	Name\r
	117	);\r
	118	} else {\r
	119	ShellPrintHiiEx(\r
	120	-1,\r
	121	-1,\r
	122	NULL,\r
	123	STRING_TOKEN(STR_OPENINFO_MIN_LINE),\r
	124	gShellDriver1HiiHandle,\r
	125	HandleIndex,\r
	126	OpenInfo[OpenInfoIndex].OpenCount,\r
	127	OpenTypeString,\r
	128	Name\r
ba0014b9	129	);\r
4ba49616	130	}\r
	131	}\r
	132	FreePool (OpenInfo);\r
	133	}\r
	134	}\r
	135	FreePool (ProtocolGuidArray);\r
	136	}\r
	137	\r
	138	return Status;\r
	139	}\r
	140	\r
	141	/**\r
	142	Function for 'openinfo' command.\r
	143	\r
	144	@param[in] ImageHandle Handle to the Image (NULL if Internal).\r
	145	@param[in] SystemTable Pointer to the System Table (NULL if Internal).\r
	146	**/\r
	147	SHELL_STATUS\r
	148	EFIAPI\r
	149	ShellCommandRunOpenInfo (\r
	150	IN EFI_HANDLE ImageHandle,\r
	151	IN EFI_SYSTEM_TABLE *SystemTable\r
	152	)\r
	153	{\r
	154	EFI_STATUS Status;\r
	155	LIST_ENTRY *Package;\r
	156	CHAR16 *ProblemParam;\r
	157	SHELL_STATUS ShellStatus;\r
	158	EFI_HANDLE TheHandle;\r
	159	CONST CHAR16 *Param1;\r
361a8267	160	UINT64 Intermediate;\r
4ba49616	161	\r
	162	ShellStatus = SHELL_SUCCESS;\r
	163	\r
	164	//\r
	165	// initialize the shell lib (we must be in non-auto-init...)\r
	166	//\r
	167	Status = ShellInitialize();\r
	168	ASSERT_EFI_ERROR(Status);\r
	169	\r
	170	Status = CommandInit();\r
	171	ASSERT_EFI_ERROR(Status);\r
	172	\r
	173	//\r
	174	// parse the command line\r
	175	//\r
	176	Status = ShellCommandLineParse (EmptyParamList, &Package, &ProblemParam, TRUE);\r
	177	if (EFI_ERROR(Status)) {\r
	178	if (Status == EFI_VOLUME_CORRUPTED && ProblemParam != NULL) {\r
ba0014b9	179	ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_PROBLEM), gShellDriver1HiiHandle, L"openinfo", ProblemParam);\r
4ba49616	180	FreePool(ProblemParam);\r
	181	ShellStatus = SHELL_INVALID_PARAMETER;\r
	182	} else {\r
	183	ASSERT(FALSE);\r
	184	}\r
	185	} else {\r
	186	if (ShellCommandLineGetCount(Package) > 2){\r
	187	//\r
	188	// error for too many parameters\r
	189	//\r
ba0014b9	190	ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_TOO_MANY), gShellDriver1HiiHandle, L"openinfo");\r
4ba49616	191	ShellStatus = SHELL_INVALID_PARAMETER;\r
4ba49616	192	} else if (ShellCommandLineGetCount(Package) == 0) {\r
ba0014b9	193	ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_TOO_FEW), gShellDriver1HiiHandle, L"openinfo");\r
4ba49616	194	ShellStatus = SHELL_INVALID_PARAMETER;\r
	195	} else {\r
	196	Param1 = ShellCommandLineGetRawValue(Package, 1);\r
361a8267	197	Status = ShellConvertStringToUint64(Param1, &Intermediate, TRUE, FALSE);\r
361a8267	198	if (EFI_ERROR(Status) \|\| Param1 == NULL \|\| ConvertHandleIndexToHandle((UINTN)Intermediate) == NULL){\r
ba0014b9	199	ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_INV_HANDLE), gShellDriver1HiiHandle, L"openinfo", Param1);\r
4ba49616	200	ShellStatus = SHELL_INVALID_PARAMETER;\r
4ba49616	201	} else {\r
361a8267	202	TheHandle = ConvertHandleIndexToHandle((UINTN)Intermediate);\r
4ba49616	203	ASSERT(TheHandle != NULL);\r
361a8267	204	ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_OPENINFO_HEADER_LINE), gShellDriver1HiiHandle, (UINTN)Intermediate, TheHandle);\r
4ba49616	205	\r
	206	Status = TraverseHandleDatabase (TheHandle);\r
	207	if (!EFI_ERROR(Status)) {\r
	208	} else {\r
ba0014b9	209	ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_INV_HANDLE), gShellDriver1HiiHandle, L"openinfo", Param1);\r
4ba49616	210	ShellStatus = SHELL_NOT_FOUND;\r
	211	}\r
	212	}\r
	213	}\r
	214	}\r
	215	return (ShellStatus);\r
	216	}\r