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