ShellPkg: Add acpiview tool to dump ACPI tables
[mirror_edk2.git] / ShellPkg / Library / UefiShellAcpiViewCommandLib / Parsers / Mcfg / McfgParser.c
1 /**\r
2   MCFG 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     - PCI Firmware Specification - Revision 3.2, January 26, 2015.\r
15 **/\r
16 \r
17 #include <IndustryStandard/Acpi.h>\r
18 #include <Library/UefiLib.h>\r
19 #include "AcpiParser.h"\r
20 #include "AcpiTableParser.h"\r
21 \r
22 // Local variables\r
23 STATIC ACPI_DESCRIPTION_HEADER_INFO AcpiHdrInfo;\r
24 \r
25 /** An ACPI_PARSER array describing the ACPI MCFG Table.\r
26 */\r
27 STATIC CONST ACPI_PARSER McfgParser[] = {\r
28   PARSE_ACPI_HEADER (&AcpiHdrInfo),\r
29   {L"Reserved", 8, 36, L"0x%lx", NULL, NULL, NULL, NULL},\r
30 };\r
31 \r
32 /** An ACPI_PARSER array describing the PCI configuration Space\r
33     Base Address structure.\r
34 */\r
35 STATIC CONST ACPI_PARSER PciCfgSpaceBaseAddrParser[] = {\r
36   {L"Base Address", 8, 0, L"0x%lx", NULL, NULL, NULL, NULL},\r
37   {L"PCI Segment Group No.", 2, 8, L"0x%x", NULL, NULL, NULL, NULL},\r
38   {L"Start Bus No.", 1, 10, L"0x%x", NULL, NULL, NULL, NULL},\r
39   {L"End Bus No.", 1, 11, L"0x%x", NULL, NULL, NULL, NULL},\r
40   {L"Reserved", 4, 12, L"0x%x", NULL, NULL, NULL, NULL}\r
41 };\r
42 \r
43 /** This function parses the ACPI MCFG table.\r
44   When trace is enabled this function parses the MCFG table and\r
45   traces the ACPI table fields.\r
46 \r
47   This function also performs validation of the ACPI table fields.\r
48 \r
49   @param [in] Trace              If TRUE, trace the ACPI fields.\r
50   @param [in] Ptr                Pointer to the start of the buffer.\r
51   @param [in] AcpiTableLength    Length of the ACPI table.\r
52   @param [in] AcpiTableRevision  Revision of the ACPI table.\r
53 */\r
54 VOID\r
55 EFIAPI\r
56 ParseAcpiMcfg (\r
57   IN BOOLEAN Trace,\r
58   IN UINT8*  Ptr,\r
59   IN UINT32  AcpiTableLength,\r
60   IN UINT8   AcpiTableRevision\r
61   )\r
62 {\r
63   UINT32 Offset;\r
64   UINT32 PciCfgOffset;\r
65   UINT8* PciCfgSpacePtr;\r
66 \r
67   if (!Trace) {\r
68     return;\r
69   }\r
70 \r
71   Offset = ParseAcpi (\r
72              TRUE,\r
73              0,\r
74              "MCFG",\r
75              Ptr,\r
76              AcpiTableLength,\r
77              PARSER_PARAMS (McfgParser)\r
78              );\r
79 \r
80   PciCfgSpacePtr = Ptr + Offset;\r
81 \r
82   while (Offset < AcpiTableLength) {\r
83     PciCfgOffset = ParseAcpi (\r
84                      TRUE,\r
85                      2,\r
86                      "PCI Configuration Space",\r
87                      PciCfgSpacePtr,\r
88                      (AcpiTableLength - Offset),\r
89                      PARSER_PARAMS (PciCfgSpaceBaseAddrParser)\r
90                      );\r
91     PciCfgSpacePtr += PciCfgOffset;\r
92     Offset += PciCfgOffset;\r
93   }\r
94 }\r