1*de5d74c2SJerry Jelinek /******************************************************************************
2*de5d74c2SJerry Jelinek *
3*de5d74c2SJerry Jelinek * Module Name: tbprint - Table output utilities
4*de5d74c2SJerry Jelinek *
5*de5d74c2SJerry Jelinek *****************************************************************************/
6*de5d74c2SJerry Jelinek
7*de5d74c2SJerry Jelinek /*
8*de5d74c2SJerry Jelinek * Copyright (C) 2000 - 2016, Intel Corp.
9*de5d74c2SJerry Jelinek * All rights reserved.
10*de5d74c2SJerry Jelinek *
11*de5d74c2SJerry Jelinek * Redistribution and use in source and binary forms, with or without
12*de5d74c2SJerry Jelinek * modification, are permitted provided that the following conditions
13*de5d74c2SJerry Jelinek * are met:
14*de5d74c2SJerry Jelinek * 1. Redistributions of source code must retain the above copyright
15*de5d74c2SJerry Jelinek * notice, this list of conditions, and the following disclaimer,
16*de5d74c2SJerry Jelinek * without modification.
17*de5d74c2SJerry Jelinek * 2. Redistributions in binary form must reproduce at minimum a disclaimer
18*de5d74c2SJerry Jelinek * substantially similar to the "NO WARRANTY" disclaimer below
19*de5d74c2SJerry Jelinek * ("Disclaimer") and any redistribution must be conditioned upon
20*de5d74c2SJerry Jelinek * including a substantially similar Disclaimer requirement for further
21*de5d74c2SJerry Jelinek * binary redistribution.
22*de5d74c2SJerry Jelinek * 3. Neither the names of the above-listed copyright holders nor the names
23*de5d74c2SJerry Jelinek * of any contributors may be used to endorse or promote products derived
24*de5d74c2SJerry Jelinek * from this software without specific prior written permission.
25*de5d74c2SJerry Jelinek *
26*de5d74c2SJerry Jelinek * Alternatively, this software may be distributed under the terms of the
27*de5d74c2SJerry Jelinek * GNU General Public License ("GPL") version 2 as published by the Free
28*de5d74c2SJerry Jelinek * Software Foundation.
29*de5d74c2SJerry Jelinek *
30*de5d74c2SJerry Jelinek * NO WARRANTY
31*de5d74c2SJerry Jelinek * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32*de5d74c2SJerry Jelinek * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33*de5d74c2SJerry Jelinek * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
34*de5d74c2SJerry Jelinek * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35*de5d74c2SJerry Jelinek * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36*de5d74c2SJerry Jelinek * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37*de5d74c2SJerry Jelinek * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38*de5d74c2SJerry Jelinek * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39*de5d74c2SJerry Jelinek * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
40*de5d74c2SJerry Jelinek * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41*de5d74c2SJerry Jelinek * POSSIBILITY OF SUCH DAMAGES.
42*de5d74c2SJerry Jelinek */
43*de5d74c2SJerry Jelinek
44*de5d74c2SJerry Jelinek #include "acpi.h"
45*de5d74c2SJerry Jelinek #include "accommon.h"
46*de5d74c2SJerry Jelinek #include "actables.h"
47*de5d74c2SJerry Jelinek
48*de5d74c2SJerry Jelinek #define _COMPONENT ACPI_TABLES
49*de5d74c2SJerry Jelinek ACPI_MODULE_NAME ("tbprint")
50*de5d74c2SJerry Jelinek
51*de5d74c2SJerry Jelinek
52*de5d74c2SJerry Jelinek /* Local prototypes */
53*de5d74c2SJerry Jelinek
54*de5d74c2SJerry Jelinek static void
55*de5d74c2SJerry Jelinek AcpiTbFixString (
56*de5d74c2SJerry Jelinek char *String,
57*de5d74c2SJerry Jelinek ACPI_SIZE Length);
58*de5d74c2SJerry Jelinek
59*de5d74c2SJerry Jelinek static void
60*de5d74c2SJerry Jelinek AcpiTbCleanupTableHeader (
61*de5d74c2SJerry Jelinek ACPI_TABLE_HEADER *OutHeader,
62*de5d74c2SJerry Jelinek ACPI_TABLE_HEADER *Header);
63*de5d74c2SJerry Jelinek
64*de5d74c2SJerry Jelinek
65*de5d74c2SJerry Jelinek /*******************************************************************************
66*de5d74c2SJerry Jelinek *
67*de5d74c2SJerry Jelinek * FUNCTION: AcpiTbFixString
68*de5d74c2SJerry Jelinek *
69*de5d74c2SJerry Jelinek * PARAMETERS: String - String to be repaired
70*de5d74c2SJerry Jelinek * Length - Maximum length
71*de5d74c2SJerry Jelinek *
72*de5d74c2SJerry Jelinek * RETURN: None
73*de5d74c2SJerry Jelinek *
74*de5d74c2SJerry Jelinek * DESCRIPTION: Replace every non-printable or non-ascii byte in the string
75*de5d74c2SJerry Jelinek * with a question mark '?'.
76*de5d74c2SJerry Jelinek *
77*de5d74c2SJerry Jelinek ******************************************************************************/
78*de5d74c2SJerry Jelinek
79*de5d74c2SJerry Jelinek static void
AcpiTbFixString(char * String,ACPI_SIZE Length)80*de5d74c2SJerry Jelinek AcpiTbFixString (
81*de5d74c2SJerry Jelinek char *String,
82*de5d74c2SJerry Jelinek ACPI_SIZE Length)
83*de5d74c2SJerry Jelinek {
84*de5d74c2SJerry Jelinek
85*de5d74c2SJerry Jelinek while (Length && *String)
86*de5d74c2SJerry Jelinek {
87*de5d74c2SJerry Jelinek if (!isprint ((int) *String))
88*de5d74c2SJerry Jelinek {
89*de5d74c2SJerry Jelinek *String = '?';
90*de5d74c2SJerry Jelinek }
91*de5d74c2SJerry Jelinek
92*de5d74c2SJerry Jelinek String++;
93*de5d74c2SJerry Jelinek Length--;
94*de5d74c2SJerry Jelinek }
95*de5d74c2SJerry Jelinek }
96*de5d74c2SJerry Jelinek
97*de5d74c2SJerry Jelinek
98*de5d74c2SJerry Jelinek /*******************************************************************************
99*de5d74c2SJerry Jelinek *
100*de5d74c2SJerry Jelinek * FUNCTION: AcpiTbCleanupTableHeader
101*de5d74c2SJerry Jelinek *
102*de5d74c2SJerry Jelinek * PARAMETERS: OutHeader - Where the cleaned header is returned
103*de5d74c2SJerry Jelinek * Header - Input ACPI table header
104*de5d74c2SJerry Jelinek *
105*de5d74c2SJerry Jelinek * RETURN: Returns the cleaned header in OutHeader
106*de5d74c2SJerry Jelinek *
107*de5d74c2SJerry Jelinek * DESCRIPTION: Copy the table header and ensure that all "string" fields in
108*de5d74c2SJerry Jelinek * the header consist of printable characters.
109*de5d74c2SJerry Jelinek *
110*de5d74c2SJerry Jelinek ******************************************************************************/
111*de5d74c2SJerry Jelinek
112*de5d74c2SJerry Jelinek static void
AcpiTbCleanupTableHeader(ACPI_TABLE_HEADER * OutHeader,ACPI_TABLE_HEADER * Header)113*de5d74c2SJerry Jelinek AcpiTbCleanupTableHeader (
114*de5d74c2SJerry Jelinek ACPI_TABLE_HEADER *OutHeader,
115*de5d74c2SJerry Jelinek ACPI_TABLE_HEADER *Header)
116*de5d74c2SJerry Jelinek {
117*de5d74c2SJerry Jelinek
118*de5d74c2SJerry Jelinek memcpy (OutHeader, Header, sizeof (ACPI_TABLE_HEADER));
119*de5d74c2SJerry Jelinek
120*de5d74c2SJerry Jelinek AcpiTbFixString (OutHeader->Signature, ACPI_NAME_SIZE);
121*de5d74c2SJerry Jelinek AcpiTbFixString (OutHeader->OemId, ACPI_OEM_ID_SIZE);
122*de5d74c2SJerry Jelinek AcpiTbFixString (OutHeader->OemTableId, ACPI_OEM_TABLE_ID_SIZE);
123*de5d74c2SJerry Jelinek AcpiTbFixString (OutHeader->AslCompilerId, ACPI_NAME_SIZE);
124*de5d74c2SJerry Jelinek }
125*de5d74c2SJerry Jelinek
126*de5d74c2SJerry Jelinek
127*de5d74c2SJerry Jelinek /*******************************************************************************
128*de5d74c2SJerry Jelinek *
129*de5d74c2SJerry Jelinek * FUNCTION: AcpiTbPrintTableHeader
130*de5d74c2SJerry Jelinek *
131*de5d74c2SJerry Jelinek * PARAMETERS: Address - Table physical address
132*de5d74c2SJerry Jelinek * Header - Table header
133*de5d74c2SJerry Jelinek *
134*de5d74c2SJerry Jelinek * RETURN: None
135*de5d74c2SJerry Jelinek *
136*de5d74c2SJerry Jelinek * DESCRIPTION: Print an ACPI table header. Special cases for FACS and RSDP.
137*de5d74c2SJerry Jelinek *
138*de5d74c2SJerry Jelinek ******************************************************************************/
139*de5d74c2SJerry Jelinek
140*de5d74c2SJerry Jelinek void
AcpiTbPrintTableHeader(ACPI_PHYSICAL_ADDRESS Address,ACPI_TABLE_HEADER * Header)141*de5d74c2SJerry Jelinek AcpiTbPrintTableHeader (
142*de5d74c2SJerry Jelinek ACPI_PHYSICAL_ADDRESS Address,
143*de5d74c2SJerry Jelinek ACPI_TABLE_HEADER *Header)
144*de5d74c2SJerry Jelinek {
145*de5d74c2SJerry Jelinek ACPI_TABLE_HEADER LocalHeader;
146*de5d74c2SJerry Jelinek
147*de5d74c2SJerry Jelinek
148*de5d74c2SJerry Jelinek if (ACPI_COMPARE_NAME (Header->Signature, ACPI_SIG_FACS))
149*de5d74c2SJerry Jelinek {
150*de5d74c2SJerry Jelinek /* FACS only has signature and length fields */
151*de5d74c2SJerry Jelinek
152*de5d74c2SJerry Jelinek ACPI_INFO (("%-4.4s 0x%8.8X%8.8X %06X",
153*de5d74c2SJerry Jelinek Header->Signature, ACPI_FORMAT_UINT64 (Address),
154*de5d74c2SJerry Jelinek Header->Length));
155*de5d74c2SJerry Jelinek }
156*de5d74c2SJerry Jelinek else if (ACPI_VALIDATE_RSDP_SIG (Header->Signature))
157*de5d74c2SJerry Jelinek {
158*de5d74c2SJerry Jelinek /* RSDP has no common fields */
159*de5d74c2SJerry Jelinek
160*de5d74c2SJerry Jelinek memcpy (LocalHeader.OemId, ACPI_CAST_PTR (ACPI_TABLE_RSDP,
161*de5d74c2SJerry Jelinek Header)->OemId, ACPI_OEM_ID_SIZE);
162*de5d74c2SJerry Jelinek AcpiTbFixString (LocalHeader.OemId, ACPI_OEM_ID_SIZE);
163*de5d74c2SJerry Jelinek
164*de5d74c2SJerry Jelinek ACPI_INFO (("RSDP 0x%8.8X%8.8X %06X (v%.2d %-6.6s)",
165*de5d74c2SJerry Jelinek ACPI_FORMAT_UINT64 (Address),
166*de5d74c2SJerry Jelinek (ACPI_CAST_PTR (ACPI_TABLE_RSDP, Header)->Revision > 0) ?
167*de5d74c2SJerry Jelinek ACPI_CAST_PTR (ACPI_TABLE_RSDP, Header)->Length : 20,
168*de5d74c2SJerry Jelinek ACPI_CAST_PTR (ACPI_TABLE_RSDP, Header)->Revision,
169*de5d74c2SJerry Jelinek LocalHeader.OemId));
170*de5d74c2SJerry Jelinek }
171*de5d74c2SJerry Jelinek else
172*de5d74c2SJerry Jelinek {
173*de5d74c2SJerry Jelinek /* Standard ACPI table with full common header */
174*de5d74c2SJerry Jelinek
175*de5d74c2SJerry Jelinek AcpiTbCleanupTableHeader (&LocalHeader, Header);
176*de5d74c2SJerry Jelinek
177*de5d74c2SJerry Jelinek ACPI_INFO ((
178*de5d74c2SJerry Jelinek "%-4.4s 0x%8.8X%8.8X"
179*de5d74c2SJerry Jelinek " %06X (v%.2d %-6.6s %-8.8s %08X %-4.4s %08X)",
180*de5d74c2SJerry Jelinek LocalHeader.Signature, ACPI_FORMAT_UINT64 (Address),
181*de5d74c2SJerry Jelinek LocalHeader.Length, LocalHeader.Revision, LocalHeader.OemId,
182*de5d74c2SJerry Jelinek LocalHeader.OemTableId, LocalHeader.OemRevision,
183*de5d74c2SJerry Jelinek LocalHeader.AslCompilerId, LocalHeader.AslCompilerRevision));
184*de5d74c2SJerry Jelinek }
185*de5d74c2SJerry Jelinek }
186*de5d74c2SJerry Jelinek
187*de5d74c2SJerry Jelinek
188*de5d74c2SJerry Jelinek /*******************************************************************************
189*de5d74c2SJerry Jelinek *
190*de5d74c2SJerry Jelinek * FUNCTION: AcpiTbValidateChecksum
191*de5d74c2SJerry Jelinek *
192*de5d74c2SJerry Jelinek * PARAMETERS: Table - ACPI table to verify
193*de5d74c2SJerry Jelinek * Length - Length of entire table
194*de5d74c2SJerry Jelinek *
195*de5d74c2SJerry Jelinek * RETURN: Status
196*de5d74c2SJerry Jelinek *
197*de5d74c2SJerry Jelinek * DESCRIPTION: Verifies that the table checksums to zero. Optionally returns
198*de5d74c2SJerry Jelinek * exception on bad checksum.
199*de5d74c2SJerry Jelinek *
200*de5d74c2SJerry Jelinek ******************************************************************************/
201*de5d74c2SJerry Jelinek
202*de5d74c2SJerry Jelinek ACPI_STATUS
AcpiTbVerifyChecksum(ACPI_TABLE_HEADER * Table,UINT32 Length)203*de5d74c2SJerry Jelinek AcpiTbVerifyChecksum (
204*de5d74c2SJerry Jelinek ACPI_TABLE_HEADER *Table,
205*de5d74c2SJerry Jelinek UINT32 Length)
206*de5d74c2SJerry Jelinek {
207*de5d74c2SJerry Jelinek UINT8 Checksum;
208*de5d74c2SJerry Jelinek
209*de5d74c2SJerry Jelinek
210*de5d74c2SJerry Jelinek /*
211*de5d74c2SJerry Jelinek * FACS/S3PT:
212*de5d74c2SJerry Jelinek * They are the odd tables, have no standard ACPI header and no checksum
213*de5d74c2SJerry Jelinek */
214*de5d74c2SJerry Jelinek
215*de5d74c2SJerry Jelinek if (ACPI_COMPARE_NAME (Table->Signature, ACPI_SIG_S3PT) ||
216*de5d74c2SJerry Jelinek ACPI_COMPARE_NAME (Table->Signature, ACPI_SIG_FACS))
217*de5d74c2SJerry Jelinek {
218*de5d74c2SJerry Jelinek return (AE_OK);
219*de5d74c2SJerry Jelinek }
220*de5d74c2SJerry Jelinek
221*de5d74c2SJerry Jelinek /* Compute the checksum on the table */
222*de5d74c2SJerry Jelinek
223*de5d74c2SJerry Jelinek Checksum = AcpiTbChecksum (ACPI_CAST_PTR (UINT8, Table), Length);
224*de5d74c2SJerry Jelinek
225*de5d74c2SJerry Jelinek /* Checksum ok? (should be zero) */
226*de5d74c2SJerry Jelinek
227*de5d74c2SJerry Jelinek if (Checksum)
228*de5d74c2SJerry Jelinek {
229*de5d74c2SJerry Jelinek ACPI_BIOS_WARNING ((AE_INFO,
230*de5d74c2SJerry Jelinek "Incorrect checksum in table [%4.4s] - 0x%2.2X, "
231*de5d74c2SJerry Jelinek "should be 0x%2.2X",
232*de5d74c2SJerry Jelinek Table->Signature, Table->Checksum,
233*de5d74c2SJerry Jelinek (UINT8) (Table->Checksum - Checksum)));
234*de5d74c2SJerry Jelinek
235*de5d74c2SJerry Jelinek #if (ACPI_CHECKSUM_ABORT)
236*de5d74c2SJerry Jelinek return (AE_BAD_CHECKSUM);
237*de5d74c2SJerry Jelinek #endif
238*de5d74c2SJerry Jelinek }
239*de5d74c2SJerry Jelinek
240*de5d74c2SJerry Jelinek return (AE_OK);
241*de5d74c2SJerry Jelinek }
242*de5d74c2SJerry Jelinek
243*de5d74c2SJerry Jelinek
244*de5d74c2SJerry Jelinek /*******************************************************************************
245*de5d74c2SJerry Jelinek *
246*de5d74c2SJerry Jelinek * FUNCTION: AcpiTbChecksum
247*de5d74c2SJerry Jelinek *
248*de5d74c2SJerry Jelinek * PARAMETERS: Buffer - Pointer to memory region to be checked
249*de5d74c2SJerry Jelinek * Length - Length of this memory region
250*de5d74c2SJerry Jelinek *
251*de5d74c2SJerry Jelinek * RETURN: Checksum (UINT8)
252*de5d74c2SJerry Jelinek *
253*de5d74c2SJerry Jelinek * DESCRIPTION: Calculates circular checksum of memory region.
254*de5d74c2SJerry Jelinek *
255*de5d74c2SJerry Jelinek ******************************************************************************/
256*de5d74c2SJerry Jelinek
257*de5d74c2SJerry Jelinek UINT8
AcpiTbChecksum(UINT8 * Buffer,UINT32 Length)258*de5d74c2SJerry Jelinek AcpiTbChecksum (
259*de5d74c2SJerry Jelinek UINT8 *Buffer,
260*de5d74c2SJerry Jelinek UINT32 Length)
261*de5d74c2SJerry Jelinek {
262*de5d74c2SJerry Jelinek UINT8 Sum = 0;
263*de5d74c2SJerry Jelinek UINT8 *End = Buffer + Length;
264*de5d74c2SJerry Jelinek
265*de5d74c2SJerry Jelinek
266*de5d74c2SJerry Jelinek while (Buffer < End)
267*de5d74c2SJerry Jelinek {
268*de5d74c2SJerry Jelinek Sum = (UINT8) (Sum + *(Buffer++));
269*de5d74c2SJerry Jelinek }
270*de5d74c2SJerry Jelinek
271*de5d74c2SJerry Jelinek return (Sum);
272*de5d74c2SJerry Jelinek }
273