1 /******************************************************************************
2 *
3 * Module Name: tbprint - Table output utilities
4 *
5 *****************************************************************************/
6
7 /******************************************************************************
8 *
9 * 1. Copyright Notice
10 *
11 * Some or all of this work - Copyright (c) 1999 - 2023, Intel Corp.
12 * All rights reserved.
13 *
14 * 2. License
15 *
16 * 2.1. This is your license from Intel Corp. under its intellectual property
17 * rights. You may have additional license terms from the party that provided
18 * you this software, covering your right to use that party's intellectual
19 * property rights.
20 *
21 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
22 * copy of the source code appearing in this file ("Covered Code") an
23 * irrevocable, perpetual, worldwide license under Intel's copyrights in the
24 * base code distributed originally by Intel ("Original Intel Code") to copy,
25 * make derivatives, distribute, use and display any portion of the Covered
26 * Code in any form, with the right to sublicense such rights; and
27 *
28 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
29 * license (with the right to sublicense), under only those claims of Intel
30 * patents that are infringed by the Original Intel Code, to make, use, sell,
31 * offer to sell, and import the Covered Code and derivative works thereof
32 * solely to the minimum extent necessary to exercise the above copyright
33 * license, and in no event shall the patent license extend to any additions
34 * to or modifications of the Original Intel Code. No other license or right
35 * is granted directly or by implication, estoppel or otherwise;
36 *
37 * The above copyright and patent license is granted only if the following
38 * conditions are met:
39 *
40 * 3. Conditions
41 *
42 * 3.1. Redistribution of Source with Rights to Further Distribute Source.
43 * Redistribution of source code of any substantial portion of the Covered
44 * Code or modification with rights to further distribute source must include
45 * the above Copyright Notice, the above License, this list of Conditions,
46 * and the following Disclaimer and Export Compliance provision. In addition,
47 * Licensee must cause all Covered Code to which Licensee contributes to
48 * contain a file documenting the changes Licensee made to create that Covered
49 * Code and the date of any change. Licensee must include in that file the
50 * documentation of any changes made by any predecessor Licensee. Licensee
51 * must include a prominent statement that the modification is derived,
52 * directly or indirectly, from Original Intel Code.
53 *
54 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
55 * Redistribution of source code of any substantial portion of the Covered
56 * Code or modification without rights to further distribute source must
57 * include the following Disclaimer and Export Compliance provision in the
58 * documentation and/or other materials provided with distribution. In
59 * addition, Licensee may not authorize further sublicense of source of any
60 * portion of the Covered Code, and must include terms to the effect that the
61 * license from Licensee to its licensee is limited to the intellectual
62 * property embodied in the software Licensee provides to its licensee, and
63 * not to intellectual property embodied in modifications its licensee may
64 * make.
65 *
66 * 3.3. Redistribution of Executable. Redistribution in executable form of any
67 * substantial portion of the Covered Code or modification must reproduce the
68 * above Copyright Notice, and the following Disclaimer and Export Compliance
69 * provision in the documentation and/or other materials provided with the
70 * distribution.
71 *
72 * 3.4. Intel retains all right, title, and interest in and to the Original
73 * Intel Code.
74 *
75 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
76 * Intel shall be used in advertising or otherwise to promote the sale, use or
77 * other dealings in products derived from or relating to the Covered Code
78 * without prior written authorization from Intel.
79 *
80 * 4. Disclaimer and Export Compliance
81 *
82 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
83 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
84 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
85 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
86 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
87 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
88 * PARTICULAR PURPOSE.
89 *
90 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
91 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
92 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
93 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
94 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
95 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
96 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
97 * LIMITED REMEDY.
98 *
99 * 4.3. Licensee shall not export, either directly or indirectly, any of this
100 * software or system incorporating such software without first obtaining any
101 * required license or other approval from the U. S. Department of Commerce or
102 * any other agency or department of the United States Government. In the
103 * event Licensee exports any such software from the United States or
104 * re-exports any such software from a foreign destination, Licensee shall
105 * ensure that the distribution and export/re-export of the software is in
106 * compliance with all laws, regulations, orders, or other restrictions of the
107 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
108 * any of its subsidiaries will export/re-export any technical data, process,
109 * software, or service, directly or indirectly, to any country for which the
110 * United States government or any agency thereof requires an export license,
111 * other governmental approval, or letter of assurance, without first obtaining
112 * such license, approval or letter.
113 *
114 *****************************************************************************
115 *
116 * Alternatively, you may choose to be licensed under the terms of the
117 * following license:
118 *
119 * Redistribution and use in source and binary forms, with or without
120 * modification, are permitted provided that the following conditions
121 * are met:
122 * 1. Redistributions of source code must retain the above copyright
123 * notice, this list of conditions, and the following disclaimer,
124 * without modification.
125 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
126 * substantially similar to the "NO WARRANTY" disclaimer below
127 * ("Disclaimer") and any redistribution must be conditioned upon
128 * including a substantially similar Disclaimer requirement for further
129 * binary redistribution.
130 * 3. Neither the names of the above-listed copyright holders nor the names
131 * of any contributors may be used to endorse or promote products derived
132 * from this software without specific prior written permission.
133 *
134 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
135 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
136 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
137 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
138 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
139 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
140 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
141 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
142 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
143 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
144 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
145 *
146 * Alternatively, you may choose to be licensed under the terms of the
147 * GNU General Public License ("GPL") version 2 as published by the Free
148 * Software Foundation.
149 *
150 *****************************************************************************/
151
152 #include "acpi.h"
153 #include "accommon.h"
154 #include "actables.h"
155 #include "acdisasm.h"
156 #include "acutils.h"
157
158 #define _COMPONENT ACPI_TABLES
159 ACPI_MODULE_NAME ("tbprint")
160
161
162 /* Local prototypes */
163
164 static void
165 AcpiTbFixString (
166 char *String,
167 ACPI_SIZE Length);
168
169 static void
170 AcpiTbCleanupTableHeader (
171 ACPI_TABLE_HEADER *OutHeader,
172 ACPI_TABLE_HEADER *Header);
173
174
175 /*******************************************************************************
176 *
177 * FUNCTION: AcpiTbFixString
178 *
179 * PARAMETERS: String - String to be repaired
180 * Length - Maximum length
181 *
182 * RETURN: None
183 *
184 * DESCRIPTION: Replace every non-printable or non-ascii byte in the string
185 * with a question mark '?'.
186 *
187 ******************************************************************************/
188
189 static void
AcpiTbFixString(char * String,ACPI_SIZE Length)190 AcpiTbFixString (
191 char *String,
192 ACPI_SIZE Length)
193 {
194
195 while (Length && *String)
196 {
197 if (!isprint ((int) (UINT8) *String))
198 {
199 *String = '?';
200 }
201
202 String++;
203 Length--;
204 }
205 }
206
207
208 /*******************************************************************************
209 *
210 * FUNCTION: AcpiTbCleanupTableHeader
211 *
212 * PARAMETERS: OutHeader - Where the cleaned header is returned
213 * Header - Input ACPI table header
214 *
215 * RETURN: Returns the cleaned header in OutHeader
216 *
217 * DESCRIPTION: Copy the table header and ensure that all "string" fields in
218 * the header consist of printable characters.
219 *
220 ******************************************************************************/
221
222 static void
AcpiTbCleanupTableHeader(ACPI_TABLE_HEADER * OutHeader,ACPI_TABLE_HEADER * Header)223 AcpiTbCleanupTableHeader (
224 ACPI_TABLE_HEADER *OutHeader,
225 ACPI_TABLE_HEADER *Header)
226 {
227
228 memcpy (OutHeader, Header, sizeof (ACPI_TABLE_HEADER));
229
230 AcpiTbFixString (OutHeader->Signature, ACPI_NAMESEG_SIZE);
231 AcpiTbFixString (OutHeader->OemId, ACPI_OEM_ID_SIZE);
232 AcpiTbFixString (OutHeader->OemTableId, ACPI_OEM_TABLE_ID_SIZE);
233 AcpiTbFixString (OutHeader->AslCompilerId, ACPI_NAMESEG_SIZE);
234 }
235
236
237 /*******************************************************************************
238 *
239 * FUNCTION: AcpiTbPrintTableHeader
240 *
241 * PARAMETERS: Address - Table physical address
242 * Header - Table header
243 *
244 * RETURN: None
245 *
246 * DESCRIPTION: Print an ACPI table header. Special cases for FACS and RSDP.
247 *
248 ******************************************************************************/
249
250 void
AcpiTbPrintTableHeader(ACPI_PHYSICAL_ADDRESS Address,ACPI_TABLE_HEADER * Header)251 AcpiTbPrintTableHeader (
252 ACPI_PHYSICAL_ADDRESS Address,
253 ACPI_TABLE_HEADER *Header)
254 {
255 ACPI_TABLE_HEADER LocalHeader;
256
257
258 if (ACPI_COMPARE_NAMESEG (Header->Signature, ACPI_SIG_FACS))
259 {
260 /* FACS only has signature and length fields */
261
262 ACPI_INFO (("%-4.4s 0x%8.8X%8.8X %06X",
263 Header->Signature, ACPI_FORMAT_UINT64 (Address),
264 Header->Length));
265 }
266 else if (ACPI_VALIDATE_RSDP_SIG (ACPI_CAST_PTR (ACPI_TABLE_RSDP,
267 Header)->Signature))
268 {
269 /* RSDP has no common fields */
270
271 memcpy (LocalHeader.OemId, ACPI_CAST_PTR (ACPI_TABLE_RSDP,
272 Header)->OemId, ACPI_OEM_ID_SIZE);
273 AcpiTbFixString (LocalHeader.OemId, ACPI_OEM_ID_SIZE);
274
275 ACPI_INFO (("RSDP 0x%8.8X%8.8X %06X (v%.2d %-6.6s)",
276 ACPI_FORMAT_UINT64 (Address),
277 (ACPI_CAST_PTR (ACPI_TABLE_RSDP, Header)->Revision > 0) ?
278 ACPI_CAST_PTR (ACPI_TABLE_RSDP, Header)->Length : 20,
279 ACPI_CAST_PTR (ACPI_TABLE_RSDP, Header)->Revision,
280 LocalHeader.OemId));
281 }
282 else
283 {
284 /* Standard ACPI table with full common header */
285
286 AcpiTbCleanupTableHeader (&LocalHeader, Header);
287
288 ACPI_INFO ((
289 "%-4.4s 0x%8.8X%8.8X"
290 " %06X (v%.2d %-6.6s %-8.8s %08X %-4.4s %08X)",
291 LocalHeader.Signature, ACPI_FORMAT_UINT64 (Address),
292 LocalHeader.Length, LocalHeader.Revision, LocalHeader.OemId,
293 LocalHeader.OemTableId, LocalHeader.OemRevision,
294 LocalHeader.AslCompilerId, LocalHeader.AslCompilerRevision));
295 }
296 }
297
