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 - 2016, 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 #include "acpi.h" 117 #include "accommon.h" 118 #include "actables.h" 119 120 #define _COMPONENT ACPI_TABLES 121 ACPI_MODULE_NAME ("tbprint") 122 123 124 /* Local prototypes */ 125 126 static void 127 AcpiTbFixString ( 128 char *String, 129 ACPI_SIZE Length); 130 131 static void 132 AcpiTbCleanupTableHeader ( 133 ACPI_TABLE_HEADER *OutHeader, 134 ACPI_TABLE_HEADER *Header); 135 136 137 /******************************************************************************* 138 * 139 * FUNCTION: AcpiTbFixString 140 * 141 * PARAMETERS: String - String to be repaired 142 * Length - Maximum length 143 * 144 * RETURN: None 145 * 146 * DESCRIPTION: Replace every non-printable or non-ascii byte in the string 147 * with a question mark '?'. 148 * 149 ******************************************************************************/ 150 151 static void 152 AcpiTbFixString ( 153 char *String, 154 ACPI_SIZE Length) 155 { 156 157 while (Length && *String) 158 { 159 if (!isprint ((int) *String)) 160 { 161 *String = '?'; 162 } 163 164 String++; 165 Length--; 166 } 167 } 168 169 170 /******************************************************************************* 171 * 172 * FUNCTION: AcpiTbCleanupTableHeader 173 * 174 * PARAMETERS: OutHeader - Where the cleaned header is returned 175 * Header - Input ACPI table header 176 * 177 * RETURN: Returns the cleaned header in OutHeader 178 * 179 * DESCRIPTION: Copy the table header and ensure that all "string" fields in 180 * the header consist of printable characters. 181 * 182 ******************************************************************************/ 183 184 static void 185 AcpiTbCleanupTableHeader ( 186 ACPI_TABLE_HEADER *OutHeader, 187 ACPI_TABLE_HEADER *Header) 188 { 189 190 memcpy (OutHeader, Header, sizeof (ACPI_TABLE_HEADER)); 191 192 AcpiTbFixString (OutHeader->Signature, ACPI_NAME_SIZE); 193 AcpiTbFixString (OutHeader->OemId, ACPI_OEM_ID_SIZE); 194 AcpiTbFixString (OutHeader->OemTableId, ACPI_OEM_TABLE_ID_SIZE); 195 AcpiTbFixString (OutHeader->AslCompilerId, ACPI_NAME_SIZE); 196 } 197 198 199 /******************************************************************************* 200 * 201 * FUNCTION: AcpiTbPrintTableHeader 202 * 203 * PARAMETERS: Address - Table physical address 204 * Header - Table header 205 * 206 * RETURN: None 207 * 208 * DESCRIPTION: Print an ACPI table header. Special cases for FACS and RSDP. 209 * 210 ******************************************************************************/ 211 212 void 213 AcpiTbPrintTableHeader ( 214 ACPI_PHYSICAL_ADDRESS Address, 215 ACPI_TABLE_HEADER *Header) 216 { 217 ACPI_TABLE_HEADER LocalHeader; 218 219 220 if (ACPI_COMPARE_NAME (Header->Signature, ACPI_SIG_FACS)) 221 { 222 /* FACS only has signature and length fields */ 223 224 ACPI_INFO ((AE_INFO, "%-4.4s 0x%8.8X%8.8X %06X", 225 Header->Signature, ACPI_FORMAT_UINT64 (Address), 226 Header->Length)); 227 } 228 else if (ACPI_VALIDATE_RSDP_SIG (Header->Signature)) 229 { 230 /* RSDP has no common fields */ 231 232 memcpy (LocalHeader.OemId, ACPI_CAST_PTR (ACPI_TABLE_RSDP, 233 Header)->OemId, ACPI_OEM_ID_SIZE); 234 AcpiTbFixString (LocalHeader.OemId, ACPI_OEM_ID_SIZE); 235 236 ACPI_INFO ((AE_INFO, "RSDP 0x%8.8X%8.8X %06X (v%.2d %-6.6s)", 237 ACPI_FORMAT_UINT64 (Address), 238 (ACPI_CAST_PTR (ACPI_TABLE_RSDP, Header)->Revision > 0) ? 239 ACPI_CAST_PTR (ACPI_TABLE_RSDP, Header)->Length : 20, 240 ACPI_CAST_PTR (ACPI_TABLE_RSDP, Header)->Revision, 241 LocalHeader.OemId)); 242 } 243 else 244 { 245 /* Standard ACPI table with full common header */ 246 247 AcpiTbCleanupTableHeader (&LocalHeader, Header); 248 249 ACPI_INFO ((AE_INFO, 250 "%-4.4s 0x%8.8X%8.8X" 251 " %06X (v%.2d %-6.6s %-8.8s %08X %-4.4s %08X)", 252 LocalHeader.Signature, ACPI_FORMAT_UINT64 (Address), 253 LocalHeader.Length, LocalHeader.Revision, LocalHeader.OemId, 254 LocalHeader.OemTableId, LocalHeader.OemRevision, 255 LocalHeader.AslCompilerId, LocalHeader.AslCompilerRevision)); 256 } 257 } 258 259 260 /******************************************************************************* 261 * 262 * FUNCTION: AcpiTbValidateChecksum 263 * 264 * PARAMETERS: Table - ACPI table to verify 265 * Length - Length of entire table 266 * 267 * RETURN: Status 268 * 269 * DESCRIPTION: Verifies that the table checksums to zero. Optionally returns 270 * exception on bad checksum. 271 * 272 ******************************************************************************/ 273 274 ACPI_STATUS 275 AcpiTbVerifyChecksum ( 276 ACPI_TABLE_HEADER *Table, 277 UINT32 Length) 278 { 279 UINT8 Checksum; 280 281 282 /* 283 * FACS/S3PT: 284 * They are the odd tables, have no standard ACPI header and no checksum 285 */ 286 287 if (ACPI_COMPARE_NAME (Table->Signature, ACPI_SIG_S3PT) || 288 ACPI_COMPARE_NAME (Table->Signature, ACPI_SIG_FACS)) 289 { 290 return (AE_OK); 291 } 292 293 /* Compute the checksum on the table */ 294 295 Checksum = AcpiTbChecksum (ACPI_CAST_PTR (UINT8, Table), Length); 296 297 /* Checksum ok? (should be zero) */ 298 299 if (Checksum) 300 { 301 ACPI_BIOS_WARNING ((AE_INFO, 302 "Incorrect checksum in table [%4.4s] - 0x%2.2X, " 303 "should be 0x%2.2X", 304 Table->Signature, Table->Checksum, 305 (UINT8) (Table->Checksum - Checksum))); 306 307 #if (ACPI_CHECKSUM_ABORT) 308 return (AE_BAD_CHECKSUM); 309 #endif 310 } 311 312 return (AE_OK); 313 } 314 315 316 /******************************************************************************* 317 * 318 * FUNCTION: AcpiTbChecksum 319 * 320 * PARAMETERS: Buffer - Pointer to memory region to be checked 321 * Length - Length of this memory region 322 * 323 * RETURN: Checksum (UINT8) 324 * 325 * DESCRIPTION: Calculates circular checksum of memory region. 326 * 327 ******************************************************************************/ 328 329 UINT8 330 AcpiTbChecksum ( 331 UINT8 *Buffer, 332 UINT32 Length) 333 { 334 UINT8 Sum = 0; 335 UINT8 *End = Buffer + Length; 336 337 338 while (Buffer < End) 339 { 340 Sum = (UINT8) (Sum + *(Buffer++)); 341 } 342 343 return (Sum); 344 } 345