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