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