[mirror_edk2.git] / ShellPkg / Library / UefiShellAcpiViewCommandLib / Parsers / Dbg2 / Dbg2Parser.c

/** @file\r
  DBG2 table parser\r
\r
  Copyright (c) 2016 - 2018, ARM Limited. All rights reserved.\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
  @par Reference(s):\r
    - Microsoft Debug Port Table 2 (DBG2) Specification - December 10, 2015.\r
**/\r
\r
#include <IndustryStandard/DebugPort2Table.h>\r
#include <Library/UefiLib.h>\r
#include "AcpiParser.h"\r
#include "AcpiTableParser.h"\r
\r
// Local variables pointing to the table fields\r
STATIC CONST UINT32* OffsetDbgDeviceInfo;\r
STATIC CONST UINT32* NumberDbgDeviceInfo;\r
STATIC CONST UINT16* DbgDevInfoLen;\r
STATIC CONST UINT8*  GasCount;\r
STATIC CONST UINT16* NameSpaceStringLength;\r
STATIC CONST UINT16* NameSpaceStringOffset;\r
STATIC CONST UINT16* OEMDataLength;\r
STATIC CONST UINT16* OEMDataOffset;\r
STATIC CONST UINT16* BaseAddrRegOffset;\r
STATIC CONST UINT16* AddrSizeOffset;\r
STATIC ACPI_DESCRIPTION_HEADER_INFO AcpiHdrInfo;\r
\r
/**\r
  This function Validates the NameSpace string length.\r
\r
  @param [in] Ptr     Pointer to the start of the buffer.\r
  @param [in] Context Pointer to context specific information e.g. this\r
                      could be a pointer to the ACPI table header.\r
**/\r
STATIC\r
VOID\r
EFIAPI\r
ValidateNameSpaceStrLen (\r
  IN  UINT8* Ptr,\r
  IN  VOID*  Context\r
  );\r
\r
/**\r
  This function parses the debug device information structure.\r
\r
  @param [in]  Ptr     Pointer to the start of the buffer.\r
  @param [out] Length  Pointer in which the length of the debug\r
                       device information is returned.\r
**/\r
STATIC\r
VOID\r
EFIAPI\r
DumpDbgDeviceInfo (\r
  IN  UINT8*  Ptr,\r
  OUT UINT32* Length\r
  );\r
\r
/// An ACPI_PARSER array describing the ACPI DBG2 table.\r
STATIC CONST ACPI_PARSER Dbg2Parser[] = {\r
  PARSE_ACPI_HEADER (&AcpiHdrInfo),\r
  {L"OffsetDbgDeviceInfo", 4, 36, L"0x%x", NULL,\r
   (VOID**)&OffsetDbgDeviceInfo, NULL, NULL},\r
  {L"NumberDbgDeviceInfo", 4, 40, L"%d", NULL,\r
   (VOID**)&NumberDbgDeviceInfo, NULL, NULL}\r
};\r
\r
/// An ACPI_PARSER array describing the debug device information.\r
STATIC CONST ACPI_PARSER DbgDevInfoParser[] = {\r
  {L"Revision", 1, 0, L"0x%x", NULL, NULL, NULL, NULL},\r
  {L"Length", 2, 1, L"%d", NULL, (VOID**)&DbgDevInfoLen, NULL, NULL},\r
\r
  {L"Generic Address Registers Count", 1, 3, L"0x%x", NULL,\r
   (VOID**)&GasCount, NULL, NULL},\r
  {L"NameSpace String Length", 2, 4, L"%d", NULL,\r
   (VOID**)&NameSpaceStringLength, ValidateNameSpaceStrLen, NULL},\r
  {L"NameSpace String Offset", 2, 6, L"0x%x", NULL,\r
   (VOID**)&NameSpaceStringOffset, NULL, NULL},\r
  {L"OEM Data Length", 2, 8, L"%d", NULL, (VOID**)&OEMDataLength,\r
   NULL, NULL},\r
  {L"OEM Data Offset", 2, 10, L"0x%x", NULL, (VOID**)&OEMDataOffset,\r
   NULL, NULL},\r
\r
  {L"Port Type", 2, 12, L"0x%x", NULL, NULL, NULL, NULL},\r
  {L"Port SubType", 2, 14, L"0x%x", NULL, NULL, NULL, NULL},\r
  {L"Reserved", 2, 16, L"%x", NULL, NULL, NULL, NULL},\r
\r
  {L"Base Address Register Offset", 2, 18, L"0x%x", NULL,\r
   (VOID**)&BaseAddrRegOffset, NULL, NULL},\r
  {L"Address Size Offset", 2, 20, L"0x%x", NULL,\r
   (VOID**)&AddrSizeOffset, NULL, NULL}\r
};\r
\r
/**\r
  This function validates the NameSpace string length.\r
\r
  @param [in] Ptr     Pointer to the start of the buffer.\r
  @param [in] Context Pointer to context specific information e.g. this\r
                      could be a pointer to the ACPI table header.\r
**/\r
STATIC\r
VOID\r
EFIAPI\r
ValidateNameSpaceStrLen (\r
  IN UINT8* Ptr,\r
  IN VOID*  Context\r
  )\r
{\r
  UINT16 NameSpaceStrLen = *(UINT16*)Ptr;\r
  if (NameSpaceStrLen < 2) {\r
    IncrementErrorCount ();\r
    Print (\r
      L"\nERROR: NamespaceString Length = %d. If no Namespace device exists,\n"\r
       "    then NamespaceString[] must contain a period '.'",\r
      NameSpaceStrLen\r
      );\r
  }\r
}\r
\r
/**\r
  This function parses the debug device information structure.\r
\r
  @param [in]  Ptr     Pointer to the start of the buffer.\r
  @param [out] Length  Pointer in which the length of the debug\r
                       device information is returned.\r
**/\r
STATIC\r
VOID\r
EFIAPI\r
DumpDbgDeviceInfo (\r
  IN  UINT8*  Ptr,\r
  OUT UINT32* Length\r
  )\r
{\r
  UINT16  Index;\r
  UINT8*  DataPtr;\r
  UINT32* AddrSize;\r
\r
  // Parse the debug device info to get the Length\r
  ParseAcpi (\r
    FALSE,\r
    0,\r
    "Debug Device Info",\r
    Ptr,\r
    3,  // Length is 2 bytes starting at offset 1\r
    PARSER_PARAMS (DbgDevInfoParser)\r
    );\r
\r
  ParseAcpi (\r
    TRUE,\r
    2,\r
    "Debug Device Info",\r
    Ptr,\r
    *DbgDevInfoLen,\r
    PARSER_PARAMS (DbgDevInfoParser)\r
    );\r
\r
  // GAS and Address Size\r
  Index = 0;\r
  DataPtr = Ptr + (*BaseAddrRegOffset);\r
  AddrSize = (UINT32*)(Ptr + (*AddrSizeOffset));\r
  while (Index < (*GasCount)) {\r
    PrintFieldName (4, L"BaseAddressRegister");\r
    DumpGasStruct (DataPtr, 4);\r
    PrintFieldName (4, L"Address Size");\r
    Print (L"0x%x\n", AddrSize[Index]);\r
    DataPtr += GAS_LENGTH;\r
    Index++;\r
  }\r
\r
  // NameSpace String\r
  Index = 0;\r
  DataPtr = Ptr + (*NameSpaceStringOffset);\r
  PrintFieldName (4, L"NameSpace String");\r
  while (Index < (*NameSpaceStringLength)) {\r
    Print (L"%c", DataPtr[Index++]);\r
  }\r
  Print (L"\n");\r
\r
  // OEM Data\r
  Index = 0;\r
  DataPtr = Ptr + (*OEMDataOffset);\r
  PrintFieldName (4, L"OEM Data");\r
  while (Index < (*OEMDataLength)) {\r
    Print (L"%x ", DataPtr[Index++]);\r
    if ((Index & 7) == 0) {\r
      Print (L"\n%-*s   ", OUTPUT_FIELD_COLUMN_WIDTH, L"");\r
    }\r
  }\r
\r
  *Length = *DbgDevInfoLen;\r
}\r
\r
/**\r
  This function parses the ACPI DBG2 table.\r
  When trace is enabled this function parses the DBG2 table and\r
  traces the ACPI table fields.\r
\r
  This function also performs validation of the ACPI table fields.\r
\r
  @param [in] Trace              If TRUE, trace the ACPI fields.\r
  @param [in] Ptr                Pointer to the start of the buffer.\r
  @param [in] AcpiTableLength    Length of the ACPI table.\r
  @param [in] AcpiTableRevision  Revision of the ACPI table.\r
**/\r
VOID\r
EFIAPI\r
ParseAcpiDbg2 (\r
  IN BOOLEAN Trace,\r
  IN UINT8*  Ptr,\r
  IN UINT32  AcpiTableLength,\r
  IN UINT8   AcpiTableRevision\r
  )\r
{\r
  UINT32 Offset;\r
  UINT32 DbgDeviceInfoLength;\r
  UINT8* DevInfoPtr;\r
\r
  if (!Trace) {\r
    return;\r
  }\r
\r
  Offset = ParseAcpi (\r
             TRUE,\r
             0,\r
             "DBG2",\r
             Ptr,\r
             AcpiTableLength,\r
             PARSER_PARAMS (Dbg2Parser)\r
             );\r
  DevInfoPtr = Ptr + Offset;\r
\r
  while (Offset < AcpiTableLength) {\r
    DumpDbgDeviceInfo (\r
      DevInfoPtr,\r
      &DbgDeviceInfoLength\r
      );\r
    Offset += DbgDeviceInfoLength;\r
    DevInfoPtr += DbgDeviceInfoLength;\r
  }\r
}\r
Commit	Line	Data
a6eaba4d	1	/** @file\r
ee4dc24f RN	2	DBG2 table parser\r
	3	\r
	4	Copyright (c) 2016 - 2018, ARM Limited. All rights reserved.\r
	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	@par Reference(s):\r
	14	- Microsoft Debug Port Table 2 (DBG2) Specification - December 10, 2015.\r
	15	**/\r
	16	\r
	17	#include <IndustryStandard/DebugPort2Table.h>\r
	18	#include <Library/UefiLib.h>\r
	19	#include "AcpiParser.h"\r
	20	#include "AcpiTableParser.h"\r
	21	\r
	22	// Local variables pointing to the table fields\r
	23	STATIC CONST UINT32* OffsetDbgDeviceInfo;\r
	24	STATIC CONST UINT32* NumberDbgDeviceInfo;\r
	25	STATIC CONST UINT16* DbgDevInfoLen;\r
	26	STATIC CONST UINT8* GasCount;\r
	27	STATIC CONST UINT16* NameSpaceStringLength;\r
	28	STATIC CONST UINT16* NameSpaceStringOffset;\r
	29	STATIC CONST UINT16* OEMDataLength;\r
	30	STATIC CONST UINT16* OEMDataOffset;\r
	31	STATIC CONST UINT16* BaseAddrRegOffset;\r
	32	STATIC CONST UINT16* AddrSizeOffset;\r
	33	STATIC ACPI_DESCRIPTION_HEADER_INFO AcpiHdrInfo;\r
	34	\r
a6eaba4d DB	35	/**\r
a6eaba4d DB	36	This function Validates the NameSpace string length.\r
ee4dc24f RN	37	\r
	38	@param [in] Ptr Pointer to the start of the buffer.\r
	39	@param [in] Context Pointer to context specific information e.g. this\r
	40	could be a pointer to the ACPI table header.\r
a6eaba4d	41	**/\r
ee4dc24f RN	42	STATIC\r
	43	VOID\r
	44	EFIAPI\r
	45	ValidateNameSpaceStrLen (\r
	46	IN UINT8* Ptr,\r
	47	IN VOID* Context\r
	48	);\r
	49	\r
a6eaba4d DB	50	/**\r
a6eaba4d DB	51	This function parses the debug device information structure.\r
ee4dc24f RN	52	\r
	53	@param [in] Ptr Pointer to the start of the buffer.\r
	54	@param [out] Length Pointer in which the length of the debug\r
	55	device information is returned.\r
a6eaba4d	56	**/\r
ee4dc24f RN	57	STATIC\r
	58	VOID\r
	59	EFIAPI\r
	60	DumpDbgDeviceInfo (\r
	61	IN UINT8* Ptr,\r
	62	OUT UINT32* Length\r
	63	);\r
	64	\r
	65	/// An ACPI_PARSER array describing the ACPI DBG2 table.\r
	66	STATIC CONST ACPI_PARSER Dbg2Parser[] = {\r
	67	PARSE_ACPI_HEADER (&AcpiHdrInfo),\r
	68	{L"OffsetDbgDeviceInfo", 4, 36, L"0x%x", NULL,\r
	69	(VOID**)&OffsetDbgDeviceInfo, NULL, NULL},\r
	70	{L"NumberDbgDeviceInfo", 4, 40, L"%d", NULL,\r
	71	(VOID**)&NumberDbgDeviceInfo, NULL, NULL}\r
	72	};\r
	73	\r
	74	/// An ACPI_PARSER array describing the debug device information.\r
	75	STATIC CONST ACPI_PARSER DbgDevInfoParser[] = {\r
	76	{L"Revision", 1, 0, L"0x%x", NULL, NULL, NULL, NULL},\r
	77	{L"Length", 2, 1, L"%d", NULL, (VOID**)&DbgDevInfoLen, NULL, NULL},\r
	78	\r
	79	{L"Generic Address Registers Count", 1, 3, L"0x%x", NULL,\r
	80	(VOID**)&GasCount, NULL, NULL},\r
	81	{L"NameSpace String Length", 2, 4, L"%d", NULL,\r
	82	(VOID**)&NameSpaceStringLength, ValidateNameSpaceStrLen, NULL},\r
	83	{L"NameSpace String Offset", 2, 6, L"0x%x", NULL,\r
	84	(VOID**)&NameSpaceStringOffset, NULL, NULL},\r
	85	{L"OEM Data Length", 2, 8, L"%d", NULL, (VOID**)&OEMDataLength,\r
	86	NULL, NULL},\r
	87	{L"OEM Data Offset", 2, 10, L"0x%x", NULL, (VOID**)&OEMDataOffset,\r
	88	NULL, NULL},\r
	89	\r
	90	{L"Port Type", 2, 12, L"0x%x", NULL, NULL, NULL, NULL},\r
	91	{L"Port SubType", 2, 14, L"0x%x", NULL, NULL, NULL, NULL},\r
	92	{L"Reserved", 2, 16, L"%x", NULL, NULL, NULL, NULL},\r
	93	\r
	94	{L"Base Address Register Offset", 2, 18, L"0x%x", NULL,\r
	95	(VOID**)&BaseAddrRegOffset, NULL, NULL},\r
	96	{L"Address Size Offset", 2, 20, L"0x%x", NULL,\r
	97	(VOID**)&AddrSizeOffset, NULL, NULL}\r
	98	};\r
	99	\r
a6eaba4d DB	100	/**\r
a6eaba4d DB	101	This function validates the NameSpace string length.\r
ee4dc24f RN	102	\r
	103	@param [in] Ptr Pointer to the start of the buffer.\r
	104	@param [in] Context Pointer to context specific information e.g. this\r
	105	could be a pointer to the ACPI table header.\r
a6eaba4d	106	**/\r
ee4dc24f RN	107	STATIC\r
	108	VOID\r
	109	EFIAPI\r
	110	ValidateNameSpaceStrLen (\r
	111	IN UINT8* Ptr,\r
	112	IN VOID* Context\r
	113	)\r
	114	{\r
	115	UINT16 NameSpaceStrLen = (UINT16)Ptr;\r
	116	if (NameSpaceStrLen < 2) {\r
	117	IncrementErrorCount ();\r
	118	Print (\r
	119	L"\nERROR: NamespaceString Length = %d. If no Namespace device exists,\n"\r
	120	" then NamespaceString[] must contain a period '.'",\r
	121	NameSpaceStrLen\r
	122	);\r
	123	}\r
	124	}\r
	125	\r
a6eaba4d DB	126	/**\r
a6eaba4d DB	127	This function parses the debug device information structure.\r
ee4dc24f RN	128	\r
ee4dc24f RN	129	@param [in] Ptr Pointer to the start of the buffer.\r
a6eaba4d	130	@param [out] Length Pointer in which the length of the debug\r
ee4dc24f	131	device information is returned.\r
a6eaba4d	132	**/\r
ee4dc24f RN	133	STATIC\r
	134	VOID\r
	135	EFIAPI\r
	136	DumpDbgDeviceInfo (\r
	137	IN UINT8* Ptr,\r
	138	OUT UINT32* Length\r
	139	)\r
	140	{\r
	141	UINT16 Index;\r
	142	UINT8* DataPtr;\r
	143	UINT32* AddrSize;\r
	144	\r
	145	// Parse the debug device info to get the Length\r
	146	ParseAcpi (\r
	147	FALSE,\r
	148	0,\r
	149	"Debug Device Info",\r
	150	Ptr,\r
	151	3, // Length is 2 bytes starting at offset 1\r
	152	PARSER_PARAMS (DbgDevInfoParser)\r
	153	);\r
	154	\r
	155	ParseAcpi (\r
	156	TRUE,\r
	157	2,\r
	158	"Debug Device Info",\r
	159	Ptr,\r
	160	*DbgDevInfoLen,\r
	161	PARSER_PARAMS (DbgDevInfoParser)\r
	162	);\r
	163	\r
	164	// GAS and Address Size\r
	165	Index = 0;\r
	166	DataPtr = Ptr + (*BaseAddrRegOffset);\r
	167	AddrSize = (UINT32)(Ptr + (AddrSizeOffset));\r
	168	while (Index < (*GasCount)) {\r
	169	PrintFieldName (4, L"BaseAddressRegister");\r
	170	DumpGasStruct (DataPtr, 4);\r
	171	PrintFieldName (4, L"Address Size");\r
	172	Print (L"0x%x\n", AddrSize[Index]);\r
	173	DataPtr += GAS_LENGTH;\r
	174	Index++;\r
	175	}\r
	176	\r
	177	// NameSpace String\r
	178	Index = 0;\r
	179	DataPtr = Ptr + (*NameSpaceStringOffset);\r
	180	PrintFieldName (4, L"NameSpace String");\r
	181	while (Index < (*NameSpaceStringLength)) {\r
	182	Print (L"%c", DataPtr[Index++]);\r
	183	}\r
	184	Print (L"\n");\r
	185	\r
	186	// OEM Data\r
	187	Index = 0;\r
	188	DataPtr = Ptr + (*OEMDataOffset);\r
	189	PrintFieldName (4, L"OEM Data");\r
	190	while (Index < (*OEMDataLength)) {\r
	191	Print (L"%x ", DataPtr[Index++]);\r
	192	if ((Index & 7) == 0) {\r
	193	Print (L"\n%-*s ", OUTPUT_FIELD_COLUMN_WIDTH, L"");\r
	194	}\r
	195	}\r
	196	\r
197	Length = DbgDevInfoLen;\r
198	}\r
199	\r
a6eaba4d DB	200	/**\r
a6eaba4d DB	201	This function parses the ACPI DBG2 table.\r
ee4dc24f RN	202	When trace is enabled this function parses the DBG2 table and\r
	203	traces the ACPI table fields.\r
	204	\r
	205	This function also performs validation of the ACPI table fields.\r
	206	\r
	207	@param [in] Trace If TRUE, trace the ACPI fields.\r
	208	@param [in] Ptr Pointer to the start of the buffer.\r
	209	@param [in] AcpiTableLength Length of the ACPI table.\r
	210	@param [in] AcpiTableRevision Revision of the ACPI table.\r
a6eaba4d	211	**/\r
ee4dc24f RN	212	VOID\r
	213	EFIAPI\r
	214	ParseAcpiDbg2 (\r
	215	IN BOOLEAN Trace,\r
	216	IN UINT8* Ptr,\r
	217	IN UINT32 AcpiTableLength,\r
	218	IN UINT8 AcpiTableRevision\r
	219	)\r
	220	{\r
	221	UINT32 Offset;\r
	222	UINT32 DbgDeviceInfoLength;\r
	223	UINT8* DevInfoPtr;\r
	224	\r
	225	if (!Trace) {\r
	226	return;\r
	227	}\r
	228	\r
	229	Offset = ParseAcpi (\r
	230	TRUE,\r
	231	0,\r
	232	"DBG2",\r
	233	Ptr,\r
	234	AcpiTableLength,\r
	235	PARSER_PARAMS (Dbg2Parser)\r
	236	);\r
	237	DevInfoPtr = Ptr + Offset;\r
	238	\r
	239	while (Offset < AcpiTableLength) {\r
	240	DumpDbgDeviceInfo (\r
	241	DevInfoPtr,\r
	242	&DbgDeviceInfoLength\r
	243	);\r
	244	Offset += DbgDeviceInfoLength;\r
	245	DevInfoPtr += DbgDeviceInfoLength;\r
	246	}\r
	247	}\r