[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
    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
\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;\r
              break;\r
            case EFI_OPEN_PROTOCOL_GET_PROTOCOL:        OpenTypeString = StringGetProt;\r
              break;\r
            case EFI_OPEN_PROTOCOL_TEST_PROTOCOL:       OpenTypeString = StringTestProt;\r
              break;\r
            case EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER: OpenTypeString = StringChild;\r
              break;\r
            case EFI_OPEN_PROTOCOL_BY_DRIVER:           OpenTypeString = StringDriver;\r
              break;\r
            case EFI_OPEN_PROTOCOL_EXCLUSIVE:           OpenTypeString = StringExclusive;\r
              break;\r
            case EFI_OPEN_PROTOCOL_BY_DRIVER|EFI_OPEN_PROTOCOL_EXCLUSIVE:\r
              OpenTypeString = StringDriverEx;\r
              break;\r
            default:                                    OpenTypeString = StringUnknown;\r
              break;\r
          }\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
\r
        FreePool (OpenInfo);\r
      }\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
\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
47d20b54 MK	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
4ba49616	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
47d20b54	31	IN CONST EFI_HANDLE TheHandle\r
4ba49616	32	)\r
4ba49616	33	{\r
47d20b54 MK	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
	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
47d20b54 MK	55	TheHandle,\r
	56	&ProtocolGuidArray,\r
	57	&ArrayCount\r
	58	);\r
	59	ASSERT_EFI_ERROR (Status);\r
4ba49616	60	if (!EFI_ERROR (Status)) {\r
4ba49616	61	for (ProtocolIndex = 0; ProtocolIndex < ArrayCount; ProtocolIndex++) {\r
	62	//\r
	63	// print out the human readable name for this one.\r
	64	//\r
47d20b54	65	TempString = GetStringNameFromGuid (ProtocolGuidArray[ProtocolIndex], NULL);\r
4ba49616	66	if (TempString == NULL) {\r
	67	continue;\r
	68	}\r
47d20b54 MK	69	\r
	70	ShellPrintEx (-1, -1, L"%H%s%N\r\n", TempString);\r
	71	FreePool (TempString);\r
4ba49616	72	\r
	73	//\r
	74	// Retrieve the list of agents that have opened each protocol\r
	75	//\r
	76	Status = gBS->OpenProtocolInformation (\r
47d20b54 MK	77	TheHandle,\r
	78	ProtocolGuidArray[ProtocolIndex],\r
	79	&OpenInfo,\r
	80	&OpenInfoCount\r
	81	);\r
	82	ASSERT_EFI_ERROR (Status);\r
4ba49616	83	if (!EFI_ERROR (Status)) {\r
	84	for (OpenInfoIndex = 0; OpenInfoIndex < OpenInfoCount; OpenInfoIndex++) {\r
	85	switch (OpenInfo[OpenInfoIndex].Attributes) {\r
47d20b54 MK	86	case EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL: OpenTypeString = StringHandProt;\r
	87	break;\r
	88	case EFI_OPEN_PROTOCOL_GET_PROTOCOL: OpenTypeString = StringGetProt;\r
	89	break;\r
	90	case EFI_OPEN_PROTOCOL_TEST_PROTOCOL: OpenTypeString = StringTestProt;\r
	91	break;\r
	92	case EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER: OpenTypeString = StringChild;\r
	93	break;\r
	94	case EFI_OPEN_PROTOCOL_BY_DRIVER: OpenTypeString = StringDriver;\r
	95	break;\r
	96	case EFI_OPEN_PROTOCOL_EXCLUSIVE: OpenTypeString = StringExclusive;\r
	97	break;\r
4ba49616	98	case EFI_OPEN_PROTOCOL_BY_DRIVER\|EFI_OPEN_PROTOCOL_EXCLUSIVE:\r
47d20b54 MK	99	OpenTypeString = StringDriverEx;\r
	100	break;\r
	101	default: OpenTypeString = StringUnknown;\r
	102	break;\r
4ba49616	103	}\r
47d20b54 MK	104	\r
	105	HandleIndex = ConvertHandleToHandleIndex (OpenInfo[OpenInfoIndex].AgentHandle);\r
	106	Name = GetStringNameFromHandle (OpenInfo[OpenInfoIndex].AgentHandle, NULL);\r
	107	ControllerIndex = ConvertHandleToHandleIndex (OpenInfo[OpenInfoIndex].ControllerHandle);\r
f330ff35	108	if (ControllerIndex != 0) {\r
47d20b54	109	ShellPrintHiiEx (\r
4ba49616	110	-1,\r
	111	-1,\r
	112	NULL,\r
47d20b54	113	STRING_TOKEN (STR_OPENINFO_LINE),\r
4ba49616	114	gShellDriver1HiiHandle,\r
4ba49616	115	HandleIndex,\r
f330ff35	116	ControllerIndex,\r
4ba49616	117	OpenInfo[OpenInfoIndex].OpenCount,\r
	118	OpenTypeString,\r
	119	Name\r
47d20b54	120	);\r
4ba49616	121	} else {\r
47d20b54	122	ShellPrintHiiEx (\r
4ba49616	123	-1,\r
	124	-1,\r
	125	NULL,\r
47d20b54	126	STRING_TOKEN (STR_OPENINFO_MIN_LINE),\r
4ba49616	127	gShellDriver1HiiHandle,\r
	128	HandleIndex,\r
	129	OpenInfo[OpenInfoIndex].OpenCount,\r
	130	OpenTypeString,\r
	131	Name\r
47d20b54	132	);\r
4ba49616	133	}\r
4ba49616	134	}\r
47d20b54	135	\r
4ba49616	136	FreePool (OpenInfo);\r
	137	}\r
	138	}\r
47d20b54	139	\r
4ba49616	140	FreePool (ProtocolGuidArray);\r
	141	}\r
	142	\r
	143	return Status;\r
	144	}\r
	145	\r
	146	/**\r
	147	Function for 'openinfo' command.\r
	148	\r
	149	@param[in] ImageHandle Handle to the Image (NULL if Internal).\r
	150	@param[in] SystemTable Pointer to the System Table (NULL if Internal).\r
	151	**/\r
	152	SHELL_STATUS\r
	153	EFIAPI\r
	154	ShellCommandRunOpenInfo (\r
	155	IN EFI_HANDLE ImageHandle,\r
	156	IN EFI_SYSTEM_TABLE *SystemTable\r
	157	)\r
	158	{\r
47d20b54 MK	159	EFI_STATUS Status;\r
	160	LIST_ENTRY *Package;\r
	161	CHAR16 *ProblemParam;\r
	162	SHELL_STATUS ShellStatus;\r
	163	EFI_HANDLE TheHandle;\r
	164	CONST CHAR16 *Param1;\r
	165	UINT64 Intermediate;\r
4ba49616	166	\r
47d20b54	167	ShellStatus = SHELL_SUCCESS;\r
4ba49616	168	\r
	169	//\r
	170	// initialize the shell lib (we must be in non-auto-init...)\r
	171	//\r
47d20b54 MK	172	Status = ShellInitialize ();\r
47d20b54 MK	173	ASSERT_EFI_ERROR (Status);\r
4ba49616	174	\r
47d20b54 MK	175	Status = CommandInit ();\r
47d20b54 MK	176	ASSERT_EFI_ERROR (Status);\r
4ba49616	177	\r
	178	//\r
	179	// parse the command line\r
	180	//\r
	181	Status = ShellCommandLineParse (EmptyParamList, &Package, &ProblemParam, TRUE);\r
47d20b54 MK	182	if (EFI_ERROR (Status)) {\r
	183	if ((Status == EFI_VOLUME_CORRUPTED) && (ProblemParam != NULL)) {\r
	184	ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_GEN_PROBLEM), gShellDriver1HiiHandle, L"openinfo", ProblemParam);\r
	185	FreePool (ProblemParam);\r
4ba49616	186	ShellStatus = SHELL_INVALID_PARAMETER;\r
4ba49616	187	} else {\r
47d20b54	188	ASSERT (FALSE);\r
4ba49616	189	}\r
4ba49616	190	} else {\r
47d20b54	191	if (ShellCommandLineGetCount (Package) > 2) {\r
4ba49616	192	//\r
	193	// error for too many parameters\r
	194	//\r
47d20b54	195	ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_GEN_TOO_MANY), gShellDriver1HiiHandle, L"openinfo");\r
4ba49616	196	ShellStatus = SHELL_INVALID_PARAMETER;\r
47d20b54 MK	197	} else if (ShellCommandLineGetCount (Package) == 0) {\r
47d20b54 MK	198	ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_GEN_TOO_FEW), gShellDriver1HiiHandle, L"openinfo");\r
4ba49616	199	ShellStatus = SHELL_INVALID_PARAMETER;\r
4ba49616	200	} else {\r
47d20b54 MK	201	Param1 = ShellCommandLineGetRawValue (Package, 1);\r
	202	Status = ShellConvertStringToUint64 (Param1, &Intermediate, TRUE, FALSE);\r
	203	if (EFI_ERROR (Status) \|\| (Param1 == NULL) \|\| (ConvertHandleIndexToHandle ((UINTN)Intermediate) == NULL)) {\r
	204	ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_GEN_INV_HANDLE), gShellDriver1HiiHandle, L"openinfo", Param1);\r
4ba49616	205	ShellStatus = SHELL_INVALID_PARAMETER;\r
4ba49616	206	} else {\r
47d20b54 MK	207	TheHandle = ConvertHandleIndexToHandle ((UINTN)Intermediate);\r
	208	ASSERT (TheHandle != NULL);\r
	209	ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_OPENINFO_HEADER_LINE), gShellDriver1HiiHandle, (UINTN)Intermediate, TheHandle);\r
4ba49616	210	\r
4ba49616	211	Status = TraverseHandleDatabase (TheHandle);\r
47d20b54	212	if (!EFI_ERROR (Status)) {\r
4ba49616	213	} else {\r
47d20b54	214	ShellPrintHiiEx (-1, -1, NULL, STRING_TOKEN (STR_GEN_INV_HANDLE), gShellDriver1HiiHandle, L"openinfo", Param1);\r
4ba49616	215	ShellStatus = SHELL_NOT_FOUND;\r
	216	}\r
	217	}\r
	218	}\r
	219	}\r
47d20b54	220	\r
4ba49616	221	return (ShellStatus);\r
4ba49616	222	}\r