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

/** @file\r
  Main file for OpenInfo 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 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
EFIAPI\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
\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
          if (OpenInfo[OpenInfoIndex].ControllerHandle!=NULL) {\r
            ShellPrintHiiEx(\r
              -1,\r
              -1,\r
              NULL,\r
              STRING_TOKEN(STR_OPENINFO_LINE),\r
              gShellDriver1HiiHandle,\r
              HandleIndex,\r
              ConvertHandleToHandleIndex(OpenInfo[OpenInfoIndex].ControllerHandle),\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, 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);\r
      ShellStatus = SHELL_INVALID_PARAMETER;\r
    } else if (ShellCommandLineGetCount(Package) == 0) {\r
      ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_TOO_FEW), gShellDriver1HiiHandle);\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, 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, 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
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 CHAR16 StringHandProt[] = L"HandProt ";\r
	18	STATIC CONST CHAR16 StringGetProt[] = L"GetProt ";\r
	19	STATIC CONST CHAR16 StringTestProt[] = L"TestProt ";\r
	20	STATIC CONST CHAR16 StringChild[] = L"Child ";\r
	21	STATIC CONST CHAR16 StringDriver[] = L"Driver ";\r
	22	STATIC CONST CHAR16 StringExclusive[] = L"Exclusive";\r
	23	STATIC CONST CHAR16 StringDriverEx[] = L"DriverEx ";\r
	24	STATIC CONST CHAR16 StringUnknown[] = L"Unknown ";\r
	25	\r
361a8267	26	/**\r
	27	Open the database and print out all the info about TheHandle.\r
	28	\r
	29	@param[in] TheHandle The handle to print info on.\r
	30	\r
	31	@retval EFI_SUCCESS The operation was successful.\r
	32	@retval EFI_INVALID_PARAMETER TheHandle was NULL.\r
	33	**/\r
4ba49616	34	EFI_STATUS\r
	35	EFIAPI\r
	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
	51	\r
361a8267	52	if (TheHandle == NULL) {\r
	53	return (EFI_INVALID_PARAMETER);\r
	54	}\r
4ba49616	55	\r
	56	//\r
	57	// Retrieve the list of all the protocols on the handle\r
	58	//\r
	59	Status = gBS->ProtocolsPerHandle (\r
	60	TheHandle,\r
	61	&ProtocolGuidArray,\r
	62	&ArrayCount\r
	63	);\r
	64	ASSERT_EFI_ERROR(Status);\r
	65	if (!EFI_ERROR (Status)) {\r
	66	\r
	67	for (ProtocolIndex = 0; ProtocolIndex < ArrayCount; ProtocolIndex++) {\r
	68	//\r
	69	// print out the human readable name for this one.\r
	70	//\r
	71	TempString = GetStringNameFromGuid(ProtocolGuidArray[ProtocolIndex], NULL);\r
	72	if (TempString == NULL) {\r
	73	continue;\r
	74	}\r
	75	ShellPrintEx(-1, -1, L"%H%s%N\r\n", TempString);\r
	76	FreePool(TempString);\r
	77	\r
	78	//\r
	79	// Retrieve the list of agents that have opened each protocol\r
	80	//\r
	81	Status = gBS->OpenProtocolInformation (\r
	82	TheHandle,\r
	83	ProtocolGuidArray[ProtocolIndex],\r
	84	&OpenInfo,\r
	85	&OpenInfoCount\r
	86	);\r
	87	ASSERT_EFI_ERROR(Status);\r
	88	if (!EFI_ERROR (Status)) {\r
	89	for (OpenInfoIndex = 0; OpenInfoIndex < OpenInfoCount; OpenInfoIndex++) {\r
	90	switch (OpenInfo[OpenInfoIndex].Attributes) {\r
	91	case EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL: OpenTypeString = StringHandProt; break;\r
	92	case EFI_OPEN_PROTOCOL_GET_PROTOCOL: OpenTypeString = StringGetProt; break;\r
	93	case EFI_OPEN_PROTOCOL_TEST_PROTOCOL: OpenTypeString = StringTestProt; break;\r
	94	case EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER: OpenTypeString = StringChild; break;\r
	95	case EFI_OPEN_PROTOCOL_BY_DRIVER: OpenTypeString = StringDriver; break;\r
	96	case EFI_OPEN_PROTOCOL_EXCLUSIVE: OpenTypeString = StringExclusive; break;\r
	97	case EFI_OPEN_PROTOCOL_BY_DRIVER\|EFI_OPEN_PROTOCOL_EXCLUSIVE:\r
	98	OpenTypeString = StringDriverEx; break;\r
	99	default: OpenTypeString = StringUnknown; break;\r
	100	}\r
	101	HandleIndex = ConvertHandleToHandleIndex(OpenInfo[OpenInfoIndex].AgentHandle);\r
36384ceb	102	Name = GetStringNameFromHandle(OpenInfo[OpenInfoIndex].AgentHandle, NULL);\r
4ba49616	103	if (OpenInfo[OpenInfoIndex].ControllerHandle!=NULL) {\r
	104	ShellPrintHiiEx(\r
	105	-1,\r
	106	-1,\r
	107	NULL,\r
	108	STRING_TOKEN(STR_OPENINFO_LINE),\r
	109	gShellDriver1HiiHandle,\r
	110	HandleIndex,\r
	111	ConvertHandleToHandleIndex(OpenInfo[OpenInfoIndex].ControllerHandle),\r
	112	OpenInfo[OpenInfoIndex].OpenCount,\r
	113	OpenTypeString,\r
	114	Name\r
	115	);\r
	116	} else {\r
	117	ShellPrintHiiEx(\r
	118	-1,\r
	119	-1,\r
	120	NULL,\r
	121	STRING_TOKEN(STR_OPENINFO_MIN_LINE),\r
	122	gShellDriver1HiiHandle,\r
	123	HandleIndex,\r
	124	OpenInfo[OpenInfoIndex].OpenCount,\r
	125	OpenTypeString,\r
	126	Name\r
	127	); \r
	128	}\r
	129	}\r
	130	FreePool (OpenInfo);\r
	131	}\r
	132	}\r
	133	FreePool (ProtocolGuidArray);\r
	134	}\r
	135	\r
	136	return Status;\r
	137	}\r
	138	\r
	139	/**\r
	140	Function for 'openinfo' command.\r
	141	\r
	142	@param[in] ImageHandle Handle to the Image (NULL if Internal).\r
	143	@param[in] SystemTable Pointer to the System Table (NULL if Internal).\r
	144	**/\r
	145	SHELL_STATUS\r
	146	EFIAPI\r
	147	ShellCommandRunOpenInfo (\r
	148	IN EFI_HANDLE ImageHandle,\r
	149	IN EFI_SYSTEM_TABLE *SystemTable\r
	150	)\r
	151	{\r
	152	EFI_STATUS Status;\r
	153	LIST_ENTRY *Package;\r
	154	CHAR16 *ProblemParam;\r
	155	SHELL_STATUS ShellStatus;\r
	156	EFI_HANDLE TheHandle;\r
	157	CONST CHAR16 *Param1;\r
361a8267	158	UINT64 Intermediate;\r
4ba49616	159	\r
	160	ShellStatus = SHELL_SUCCESS;\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 (EmptyParamList, &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	//\r
	186	// error for too many parameters\r
	187	//\r
	188	ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_TOO_MANY), gShellDriver1HiiHandle);\r
	189	ShellStatus = SHELL_INVALID_PARAMETER;\r
	190	} else if (ShellCommandLineGetCount(Package) == 0) {\r
	191	ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_TOO_FEW), gShellDriver1HiiHandle);\r
	192	ShellStatus = SHELL_INVALID_PARAMETER;\r
	193	} else {\r
	194	Param1 = ShellCommandLineGetRawValue(Package, 1);\r
361a8267	195	Status = ShellConvertStringToUint64(Param1, &Intermediate, TRUE, FALSE);\r
361a8267	196	if (EFI_ERROR(Status) \|\| Param1 == NULL \|\| ConvertHandleIndexToHandle((UINTN)Intermediate) == NULL){\r
4ba49616	197	ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_INV_HANDLE), gShellDriver1HiiHandle, Param1);\r
	198	ShellStatus = SHELL_INVALID_PARAMETER;\r
	199	} else {\r
361a8267	200	TheHandle = ConvertHandleIndexToHandle((UINTN)Intermediate);\r
4ba49616	201	ASSERT(TheHandle != NULL);\r
361a8267	202	ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_OPENINFO_HEADER_LINE), gShellDriver1HiiHandle, (UINTN)Intermediate, TheHandle);\r
4ba49616	203	\r
	204	Status = TraverseHandleDatabase (TheHandle);\r
	205	if (!EFI_ERROR(Status)) {\r
	206	} else {\r
	207	ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_INV_HANDLE), gShellDriver1HiiHandle, Param1);\r
	208	ShellStatus = SHELL_NOT_FOUND;\r
	209	}\r
	210	}\r
	211	}\r
	212	}\r
	213	return (ShellStatus);\r
	214	}\r