]>
Commit | Line | Data |
---|---|---|
a6eaba4d | 1 | /** @file\r |
ee4dc24f RN |
2 | Main file for 'acpiview' Shell command function.\r |
3 | \r | |
d4d2fdf2 | 4 | Copyright (c) 2016 - 2019, ARM Limited. All rights reserved.<BR>\r |
56ba3746 | 5 | SPDX-License-Identifier: BSD-2-Clause-Patent\r |
ee4dc24f RN |
6 | **/\r |
7 | \r | |
8 | #include <Guid/ShellLibHiiGuid.h>\r | |
9 | #include <IndustryStandard/Acpi.h>\r | |
10 | #include <Library/HiiLib.h>\r | |
11 | #include <Library/ShellCommandLib.h>\r | |
12 | #include <Library/UefiLib.h>\r | |
13 | #include <Library/UefiBootServicesTableLib.h>\r | |
14 | #include <Uefi.h>\r | |
15 | #include "AcpiParser.h"\r | |
16 | #include "AcpiTableParser.h"\r | |
17 | #include "AcpiView.h"\r | |
18 | #include "UefiShellAcpiViewCommandLib.h"\r | |
19 | \r | |
20 | CONST CHAR16 gShellAcpiViewFileName[] = L"ShellCommand";\r | |
21 | \r | |
22 | /**\r | |
23 | A list of available table parsers.\r | |
24 | */\r | |
25 | STATIC\r | |
26 | CONST\r | |
27 | ACPI_TABLE_PARSER ParserList[] = {\r | |
28 | {EFI_ACPI_6_2_BOOT_GRAPHICS_RESOURCE_TABLE_SIGNATURE, ParseAcpiBgrt},\r | |
29 | {EFI_ACPI_6_2_DEBUG_PORT_2_TABLE_SIGNATURE, ParseAcpiDbg2},\r | |
30 | {EFI_ACPI_6_2_DIFFERENTIATED_SYSTEM_DESCRIPTION_TABLE_SIGNATURE,\r | |
31 | ParseAcpiDsdt},\r | |
32 | {EFI_ACPI_6_2_FIXED_ACPI_DESCRIPTION_TABLE_SIGNATURE, ParseAcpiFadt},\r | |
33 | {EFI_ACPI_6_2_GENERIC_TIMER_DESCRIPTION_TABLE_SIGNATURE, ParseAcpiGtdt},\r | |
34 | {EFI_ACPI_6_2_IO_REMAPPING_TABLE_SIGNATURE, ParseAcpiIort},\r | |
35 | {EFI_ACPI_6_2_MULTIPLE_APIC_DESCRIPTION_TABLE_SIGNATURE, ParseAcpiMadt},\r | |
36 | {EFI_ACPI_6_2_PCI_EXPRESS_MEMORY_MAPPED_CONFIGURATION_SPACE_BASE_ADDRESS_DESCRIPTION_TABLE_SIGNATURE,\r | |
37 | ParseAcpiMcfg},\r | |
d4d2fdf2 KK |
38 | {EFI_ACPI_6_2_PROCESSOR_PROPERTIES_TOPOLOGY_TABLE_STRUCTURE_SIGNATURE,\r |
39 | ParseAcpiPptt},\r | |
ee4dc24f RN |
40 | {RSDP_TABLE_INFO, ParseAcpiRsdp},\r |
41 | {EFI_ACPI_6_2_SYSTEM_LOCALITY_INFORMATION_TABLE_SIGNATURE, ParseAcpiSlit},\r | |
42 | {EFI_ACPI_6_2_SERIAL_PORT_CONSOLE_REDIRECTION_TABLE_SIGNATURE, ParseAcpiSpcr},\r | |
43 | {EFI_ACPI_6_2_SYSTEM_RESOURCE_AFFINITY_TABLE_SIGNATURE, ParseAcpiSrat},\r | |
44 | {EFI_ACPI_6_2_SECONDARY_SYSTEM_DESCRIPTION_TABLE_SIGNATURE, ParseAcpiSsdt},\r | |
45 | {EFI_ACPI_6_2_EXTENDED_SYSTEM_DESCRIPTION_TABLE_SIGNATURE, ParseAcpiXsdt}\r | |
46 | };\r | |
47 | \r | |
a6eaba4d DB |
48 | /**\r |
49 | This function registers all the available table parsers.\r | |
ee4dc24f RN |
50 | \r |
51 | @retval EFI_SUCCESS The parser is registered.\r | |
52 | @retval EFI_ALREADY_STARTED The parser for the ACPI Table\r | |
53 | was already registered.\r | |
54 | @retval EFI_INVALID_PARAMETER A parameter is invalid.\r | |
55 | @retval EFI_OUT_OF_RESOURCES No space to register the\r | |
56 | parser.\r | |
a6eaba4d | 57 | **/\r |
ee4dc24f RN |
58 | EFI_STATUS\r |
59 | RegisterAllParsers (\r | |
60 | )\r | |
61 | {\r | |
62 | EFI_STATUS Status;\r | |
f75c7478 DB |
63 | UINTN Count;\r |
64 | \r | |
7343bc80 | 65 | Status = EFI_SUCCESS;\r |
f75c7478 DB |
66 | Count = sizeof (ParserList) / sizeof (ParserList[0]);\r |
67 | \r | |
ee4dc24f RN |
68 | while (Count-- != 0) {\r |
69 | Status = RegisterParser (\r | |
70 | ParserList[Count].Signature,\r | |
71 | ParserList[Count].Parser\r | |
72 | );\r | |
73 | if (EFI_ERROR (Status)) {\r | |
74 | return Status;\r | |
75 | }\r | |
76 | }\r | |
77 | return Status;\r | |
78 | }\r | |
79 | \r | |
80 | /**\r | |
81 | Return the file name of the help text file if not using HII.\r | |
82 | \r | |
83 | @return The string pointer to the file name.\r | |
a6eaba4d | 84 | **/\r |
ee4dc24f RN |
85 | CONST CHAR16*\r |
86 | EFIAPI\r | |
87 | ShellCommandGetManFileNameAcpiView (\r | |
88 | VOID\r | |
89 | )\r | |
90 | {\r | |
91 | return gShellAcpiViewFileName;\r | |
92 | }\r | |
93 | \r | |
94 | /**\r | |
95 | Constructor for the Shell AcpiView Command library.\r | |
96 | \r | |
97 | Install the handlers for acpiview UEFI Shell command.\r | |
98 | \r | |
99 | @param ImageHandle The image handle of the process.\r | |
100 | @param SystemTable The EFI System Table pointer.\r | |
101 | \r | |
102 | @retval EFI_SUCCESS The Shell command handlers were installed\r | |
103 | successfully.\r | |
104 | @retval EFI_DEVICE_ERROR Hii package failed to install.\r | |
a6eaba4d | 105 | **/\r |
ee4dc24f RN |
106 | EFI_STATUS\r |
107 | EFIAPI\r | |
108 | UefiShellAcpiViewCommandLibConstructor (\r | |
109 | IN EFI_HANDLE ImageHandle,\r | |
110 | IN EFI_SYSTEM_TABLE *SystemTable\r | |
111 | )\r | |
112 | {\r | |
113 | EFI_STATUS Status;\r | |
114 | gShellAcpiViewHiiHandle = NULL;\r | |
115 | \r | |
116 | // Check Shell Profile Debug1 bit of the profiles mask\r | |
81038d50 | 117 | if ((PcdGet8 (PcdShellProfileMask) & BIT1) == 0) {\r |
ee4dc24f RN |
118 | return EFI_SUCCESS;\r |
119 | }\r | |
120 | \r | |
121 | Status = RegisterAllParsers ();\r | |
122 | if (EFI_ERROR (Status)) {\r | |
123 | Print (L"acpiview: Error failed to register parser.\n");\r | |
124 | return Status;\r | |
125 | }\r | |
126 | \r | |
127 | gShellAcpiViewHiiHandle = HiiAddPackages (\r | |
128 | &gShellAcpiViewHiiGuid,\r | |
129 | gImageHandle,\r | |
130 | UefiShellAcpiViewCommandLibStrings,\r | |
131 | NULL\r | |
132 | );\r | |
133 | if (gShellAcpiViewHiiHandle == NULL) {\r | |
134 | return EFI_DEVICE_ERROR;\r | |
135 | }\r | |
136 | // Install our Shell command handler\r | |
137 | ShellCommandRegisterCommandName (\r | |
138 | L"acpiview",\r | |
139 | ShellCommandRunAcpiView,\r | |
140 | ShellCommandGetManFileNameAcpiView,\r | |
141 | 0,\r | |
142 | L"acpiview",\r | |
143 | TRUE,\r | |
144 | gShellAcpiViewHiiHandle,\r | |
145 | STRING_TOKEN (STR_GET_HELP_ACPIVIEW)\r | |
146 | );\r | |
147 | \r | |
148 | return EFI_SUCCESS;\r | |
149 | }\r | |
150 | \r | |
151 | /**\r | |
152 | Destructor for the library. free any resources.\r | |
153 | \r | |
154 | @param ImageHandle The image handle of the process.\r | |
155 | @param SystemTable The EFI System Table pointer.\r | |
a6eaba4d | 156 | **/\r |
ee4dc24f RN |
157 | EFI_STATUS\r |
158 | EFIAPI\r | |
159 | UefiShellAcpiViewCommandLibDestructor (\r | |
160 | IN EFI_HANDLE ImageHandle,\r | |
161 | IN EFI_SYSTEM_TABLE *SystemTable\r | |
162 | )\r | |
163 | {\r | |
164 | if (gShellAcpiViewHiiHandle != NULL) {\r | |
165 | HiiRemovePackages (gShellAcpiViewHiiHandle);\r | |
166 | }\r | |
167 | return EFI_SUCCESS;\r | |
168 | }\r |