tbutils.c revision 77424
1/****************************************************************************** 2 * 3 * Module Name: tbutils - Table manipulation utilities 4 * $Revision: 37 $ 5 * 6 *****************************************************************************/ 7 8/****************************************************************************** 9 * 10 * 1. Copyright Notice 11 * 12 * Some or all of this work - Copyright (c) 1999, 2000, 2001, Intel Corp. 13 * All rights reserved. 14 * 15 * 2. License 16 * 17 * 2.1. This is your license from Intel Corp. under its intellectual property 18 * rights. You may have additional license terms from the party that provided 19 * you this software, covering your right to use that party's intellectual 20 * property rights. 21 * 22 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a 23 * copy of the source code appearing in this file ("Covered Code") an 24 * irrevocable, perpetual, worldwide license under Intel's copyrights in the 25 * base code distributed originally by Intel ("Original Intel Code") to copy, 26 * make derivatives, distribute, use and display any portion of the Covered 27 * Code in any form, with the right to sublicense such rights; and 28 * 29 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent 30 * license (with the right to sublicense), under only those claims of Intel 31 * patents that are infringed by the Original Intel Code, to make, use, sell, 32 * offer to sell, and import the Covered Code and derivative works thereof 33 * solely to the minimum extent necessary to exercise the above copyright 34 * license, and in no event shall the patent license extend to any additions 35 * to or modifications of the Original Intel Code. No other license or right 36 * is granted directly or by implication, estoppel or otherwise; 37 * 38 * The above copyright and patent license is granted only if the following 39 * conditions are met: 40 * 41 * 3. Conditions 42 * 43 * 3.1. Redistribution of Source with Rights to Further Distribute Source. 44 * Redistribution of source code of any substantial portion of the Covered 45 * Code or modification with rights to further distribute source must include 46 * the above Copyright Notice, the above License, this list of Conditions, 47 * and the following Disclaimer and Export Compliance provision. In addition, 48 * Licensee must cause all Covered Code to which Licensee contributes to 49 * contain a file documenting the changes Licensee made to create that Covered 50 * Code and the date of any change. Licensee must include in that file the 51 * documentation of any changes made by any predecessor Licensee. Licensee 52 * must include a prominent statement that the modification is derived, 53 * directly or indirectly, from Original Intel Code. 54 * 55 * 3.2. Redistribution of Source with no Rights to Further Distribute Source. 56 * Redistribution of source code of any substantial portion of the Covered 57 * Code or modification without rights to further distribute source must 58 * include the following Disclaimer and Export Compliance provision in the 59 * documentation and/or other materials provided with distribution. In 60 * addition, Licensee may not authorize further sublicense of source of any 61 * portion of the Covered Code, and must include terms to the effect that the 62 * license from Licensee to its licensee is limited to the intellectual 63 * property embodied in the software Licensee provides to its licensee, and 64 * not to intellectual property embodied in modifications its licensee may 65 * make. 66 * 67 * 3.3. Redistribution of Executable. Redistribution in executable form of any 68 * substantial portion of the Covered Code or modification must reproduce the 69 * above Copyright Notice, and the following Disclaimer and Export Compliance 70 * provision in the documentation and/or other materials provided with the 71 * distribution. 72 * 73 * 3.4. Intel retains all right, title, and interest in and to the Original 74 * Intel Code. 75 * 76 * 3.5. Neither the name Intel nor any other trademark owned or controlled by 77 * Intel shall be used in advertising or otherwise to promote the sale, use or 78 * other dealings in products derived from or relating to the Covered Code 79 * without prior written authorization from Intel. 80 * 81 * 4. Disclaimer and Export Compliance 82 * 83 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED 84 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE 85 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE, 86 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY 87 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY 88 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A 89 * PARTICULAR PURPOSE. 90 * 91 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES 92 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR 93 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT, 94 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY 95 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL 96 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS 97 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY 98 * LIMITED REMEDY. 99 * 100 * 4.3. Licensee shall not export, either directly or indirectly, any of this 101 * software or system incorporating such software without first obtaining any 102 * required license or other approval from the U. S. Department of Commerce or 103 * any other agency or department of the United States Government. In the 104 * event Licensee exports any such software from the United States or 105 * re-exports any such software from a foreign destination, Licensee shall 106 * ensure that the distribution and export/re-export of the software is in 107 * compliance with all laws, regulations, orders, or other restrictions of the 108 * U.S. Export Administration Regulations. Licensee agrees that neither it nor 109 * any of its subsidiaries will export/re-export any technical data, process, 110 * software, or service, directly or indirectly, to any country for which the 111 * United States government or any agency thereof requires an export license, 112 * other governmental approval, or letter of assurance, without first obtaining 113 * such license, approval or letter. 114 * 115 *****************************************************************************/ 116 117#define __TBUTILS_C__ 118 119#include "acpi.h" 120#include "actables.h" 121#include "acinterp.h" 122 123 124#define _COMPONENT ACPI_TABLES 125 MODULE_NAME ("tbutils") 126 127 128/******************************************************************************* 129 * 130 * FUNCTION: AcpiTbHandleToObject 131 * 132 * PARAMETERS: TableId - Id for which the function is searching 133 * TableDesc - Pointer to return the matching table 134 * descriptor. 135 * 136 * RETURN: Search the tables to find one with a matching TableId and 137 * return a pointer to that table descriptor. 138 * 139 ******************************************************************************/ 140 141ACPI_STATUS 142AcpiTbHandleToObject ( 143 UINT16 TableId, 144 ACPI_TABLE_DESC **TableDesc) 145{ 146 UINT32 i; 147 ACPI_TABLE_DESC *ListHead; 148 149 150 for (i = 0; i < ACPI_TABLE_MAX; i++) 151 { 152 ListHead = &AcpiGbl_AcpiTables[i]; 153 do 154 { 155 if (ListHead->TableId == TableId) 156 { 157 *TableDesc = ListHead; 158 return (AE_OK); 159 } 160 161 ListHead = ListHead->Next; 162 163 } while (ListHead != &AcpiGbl_AcpiTables[i]); 164 } 165 166 167 DEBUG_PRINT (ACPI_ERROR, ("TableId=%X does not exist\n", TableId)); 168 return (AE_BAD_PARAMETER); 169} 170 171 172/******************************************************************************* 173 * 174 * FUNCTION: AcpiTbSystemTablePointer 175 * 176 * PARAMETERS: *Where - Pointer to be examined 177 * 178 * RETURN: TRUE if Where is within the AML stream (in one of the ACPI 179 * system tables such as the DSDT or an SSDT.) 180 * FALSE otherwise 181 * 182 ******************************************************************************/ 183 184BOOLEAN 185AcpiTbSystemTablePointer ( 186 void *Where) 187{ 188 UINT32 i; 189 ACPI_TABLE_DESC *TableDesc; 190 ACPI_TABLE_HEADER *Table; 191 192 193 /* No function trace, called too often! */ 194 195 196 /* Ignore null pointer */ 197 198 if (!Where) 199 { 200 return (FALSE); 201 } 202 203 204 /* Check for a pointer within the DSDT */ 205 206 if ((AcpiGbl_DSDT) && 207 (IS_IN_ACPI_TABLE (Where, AcpiGbl_DSDT))) 208 { 209 return (TRUE); 210 } 211 212 213 /* Check each of the loaded SSDTs (if any)*/ 214 215 TableDesc = &AcpiGbl_AcpiTables[ACPI_TABLE_SSDT]; 216 217 for (i = 0; i < AcpiGbl_AcpiTables[ACPI_TABLE_SSDT].Count; i++) 218 { 219 Table = TableDesc->Pointer; 220 221 if (IS_IN_ACPI_TABLE (Where, Table)) 222 { 223 return (TRUE); 224 } 225 226 TableDesc = TableDesc->Next; 227 } 228 229 230 /* Check each of the loaded PSDTs (if any)*/ 231 232 TableDesc = &AcpiGbl_AcpiTables[ACPI_TABLE_PSDT]; 233 234 for (i = 0; i < AcpiGbl_AcpiTables[ACPI_TABLE_PSDT].Count; i++) 235 { 236 Table = TableDesc->Pointer; 237 238 if (IS_IN_ACPI_TABLE (Where, Table)) 239 { 240 return (TRUE); 241 } 242 243 TableDesc = TableDesc->Next; 244 } 245 246 247 /* Pointer does not point into any system table */ 248 249 return (FALSE); 250} 251 252 253/******************************************************************************* 254 * 255 * FUNCTION: AcpiTbValidateTableHeader 256 * 257 * PARAMETERS: TableHeader - Logical pointer to the table 258 * 259 * RETURN: Status 260 * 261 * DESCRIPTION: Check an ACPI table header for validity 262 * 263 * NOTE: Table pointers are validated as follows: 264 * 1) Table pointer must point to valid physical memory 265 * 2) Signature must be 4 ASCII chars, even if we don't recognize the 266 * name 267 * 3) Table must be readable for length specified in the header 268 * 4) Table checksum must be valid (with the exception of the FACS 269 * which has no checksum for some odd reason) 270 * 271 ******************************************************************************/ 272 273ACPI_STATUS 274AcpiTbValidateTableHeader ( 275 ACPI_TABLE_HEADER *TableHeader) 276{ 277 ACPI_NAME Signature; 278 279 280 PROC_NAME ("TbValidateTableHeader"); 281 282 283 /* Verify that this is a valid address */ 284 285 if (!AcpiOsReadable (TableHeader, sizeof (ACPI_TABLE_HEADER))) 286 { 287 DEBUG_PRINTP (ACPI_ERROR, 288 ("Cannot read table header at %p\n", TableHeader)); 289 return (AE_BAD_ADDRESS); 290 } 291 292 293 /* Ensure that the signature is 4 ASCII characters */ 294 295 MOVE_UNALIGNED32_TO_32 (&Signature, &TableHeader->Signature); 296 if (!AcpiUtValidAcpiName (Signature)) 297 { 298 DEBUG_PRINTP (ACPI_ERROR, 299 ("Table signature at %p [%X] has invalid characters\n", 300 TableHeader, &Signature)); 301 302 REPORT_WARNING (("Invalid table signature %4.4s found\n", &Signature)); 303 DUMP_BUFFER (TableHeader, sizeof (ACPI_TABLE_HEADER)); 304 return (AE_BAD_SIGNATURE); 305 } 306 307 308 /* Validate the table length */ 309 310 if (TableHeader->Length < sizeof (ACPI_TABLE_HEADER)) 311 { 312 DEBUG_PRINTP (ACPI_ERROR, 313 ("Invalid length in table header %p name %4.4s\n", 314 TableHeader, &Signature)); 315 316 REPORT_WARNING (("Invalid table header length found\n")); 317 DUMP_BUFFER (TableHeader, sizeof (ACPI_TABLE_HEADER)); 318 return (AE_BAD_HEADER); 319 } 320 321 return (AE_OK); 322} 323 324 325/******************************************************************************* 326 * 327 * FUNCTION: AcpiTbMapAcpiTable 328 * 329 * PARAMETERS: PhysicalAddress - Physical address of table to map 330 * *Size - Size of the table. If zero, the size 331 * from the table header is used. 332 * Actual size is returned here. 333 * **LogicalAddress - Logical address of mapped table 334 * 335 * RETURN: Logical address of the mapped table. 336 * 337 * DESCRIPTION: Maps the physical address of table into a logical address 338 * 339 ******************************************************************************/ 340 341ACPI_STATUS 342AcpiTbMapAcpiTable ( 343 ACPI_PHYSICAL_ADDRESS PhysicalAddress, 344 UINT32 *Size, 345 void **LogicalAddress) 346{ 347 ACPI_TABLE_HEADER *Table; 348 UINT32 TableSize = *Size; 349 ACPI_STATUS Status = AE_OK; 350 351 352 /* If size is zero, look at the table header to get the actual size */ 353 354 if ((*Size) == 0) 355 { 356 /* Get the table header so we can extract the table length */ 357 358 Status = AcpiOsMapMemory (PhysicalAddress, sizeof (ACPI_TABLE_HEADER), 359 (void **) &Table); 360 if (ACPI_FAILURE (Status)) 361 { 362 return (Status); 363 } 364 365 /* Extract the full table length before we delete the mapping */ 366 367 TableSize = Table->Length; 368 369 /* 370 * Validate the header and delete the mapping. 371 * We will create a mapping for the full table below. 372 */ 373 374 Status = AcpiTbValidateTableHeader (Table); 375 376 /* Always unmap the memory for the header */ 377 378 AcpiOsUnmapMemory (Table, sizeof (ACPI_TABLE_HEADER)); 379 380 /* Exit if header invalid */ 381 382 if (ACPI_FAILURE (Status)) 383 { 384 return (Status); 385 } 386 } 387 388 389 /* Map the physical memory for the correct length */ 390 391 Status = AcpiOsMapMemory (PhysicalAddress, TableSize, (void **) &Table); 392 if (ACPI_FAILURE (Status)) 393 { 394 return (Status); 395 } 396 397 DEBUG_PRINT (ACPI_INFO, 398 ("Mapped memory for ACPI table, length=%d(%X) at %p\n", 399 TableSize, TableSize, Table)); 400 401 *Size = TableSize; 402 *LogicalAddress = Table; 403 404 return (Status); 405} 406 407 408/******************************************************************************* 409 * 410 * FUNCTION: AcpiTbVerifyTableChecksum 411 * 412 * PARAMETERS: *TableHeader - ACPI table to verify 413 * 414 * RETURN: 8 bit checksum of table 415 * 416 * DESCRIPTION: Does an 8 bit checksum of table and returns status. A correct 417 * table should have a checksum of 0. 418 * 419 ******************************************************************************/ 420 421ACPI_STATUS 422AcpiTbVerifyTableChecksum ( 423 ACPI_TABLE_HEADER *TableHeader) 424{ 425 UINT8 Checksum; 426 ACPI_STATUS Status = AE_OK; 427 428 429 FUNCTION_TRACE ("TbVerifyTableChecksum"); 430 431 432 /* Compute the checksum on the table */ 433 434 Checksum = AcpiTbChecksum (TableHeader, TableHeader->Length); 435 436 /* Return the appropriate exception */ 437 438 if (Checksum) 439 { 440 REPORT_WARNING (("Invalid checksum (%X) in table %4.4s\n", 441 Checksum, &TableHeader->Signature)); 442 443 Status = AE_BAD_CHECKSUM; 444 } 445 446 447 return_ACPI_STATUS (Status); 448} 449 450 451/******************************************************************************* 452 * 453 * FUNCTION: AcpiTbChecksum 454 * 455 * PARAMETERS: Buffer - Buffer to checksum 456 * Length - Size of the buffer 457 * 458 * RETURNS 8 bit checksum of buffer 459 * 460 * DESCRIPTION: Computes an 8 bit checksum of the buffer(length) and returns it. 461 * 462 ******************************************************************************/ 463 464UINT8 465AcpiTbChecksum ( 466 void *Buffer, 467 UINT32 Length) 468{ 469 UINT8 *limit; 470 UINT8 *rover; 471 UINT8 sum = 0; 472 473 474 if (Buffer && Length) 475 { 476 /* Buffer and Length are valid */ 477 478 limit = (UINT8 *) Buffer + Length; 479 480 for (rover = Buffer; rover < limit; rover++) 481 { 482 sum = (UINT8) (sum + *rover); 483 } 484 } 485 486 return (sum); 487} 488 489 490