tbxface.c revision 249112
1259698Sdim/****************************************************************************** 2259698Sdim * 3259698Sdim * Module Name: tbxface - ACPI table-oriented external interfaces 4259698Sdim * 5259698Sdim *****************************************************************************/ 6259698Sdim 7259698Sdim/* 8259698Sdim * Copyright (C) 2000 - 2013, Intel Corp. 9259698Sdim * All rights reserved. 10259698Sdim * 11259698Sdim * Redistribution and use in source and binary forms, with or without 12259698Sdim * modification, are permitted provided that the following conditions 13259698Sdim * are met: 14259698Sdim * 1. Redistributions of source code must retain the above copyright 15259698Sdim * notice, this list of conditions, and the following disclaimer, 16259698Sdim * without modification. 17259698Sdim * 2. Redistributions in binary form must reproduce at minimum a disclaimer 18259698Sdim * substantially similar to the "NO WARRANTY" disclaimer below 19259698Sdim * ("Disclaimer") and any redistribution must be conditioned upon 20259698Sdim * including a substantially similar Disclaimer requirement for further 21259698Sdim * binary redistribution. 22259698Sdim * 3. Neither the names of the above-listed copyright holders nor the names 23259698Sdim * of any contributors may be used to endorse or promote products derived 24259698Sdim * from this software without specific prior written permission. 25259698Sdim * 26259698Sdim * Alternatively, this software may be distributed under the terms of the 27259698Sdim * GNU General Public License ("GPL") version 2 as published by the Free 28259698Sdim * Software Foundation. 29259698Sdim * 30259698Sdim * NO WARRANTY 31259698Sdim * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 32259698Sdim * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 33259698Sdim * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR 34259698Sdim * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 35259698Sdim * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 36259698Sdim * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 37261991Sdim * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 38259698Sdim * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 39259698Sdim * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 40259698Sdim * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 41259698Sdim * POSSIBILITY OF SUCH DAMAGES. 42259698Sdim */ 43259698Sdim 44259698Sdim#define __TBXFACE_C__ 45259698Sdim 46259698Sdim#include <contrib/dev/acpica/include/acpi.h> 47259698Sdim#include <contrib/dev/acpica/include/accommon.h> 48259698Sdim#include <contrib/dev/acpica/include/actables.h> 49259698Sdim 50259698Sdim#define _COMPONENT ACPI_TABLES 51259698Sdim ACPI_MODULE_NAME ("tbxface") 52259698Sdim 53259698Sdim 54259698Sdim/******************************************************************************* 55259698Sdim * 56259698Sdim * FUNCTION: AcpiAllocateRootTable 57259698Sdim * 58259698Sdim * PARAMETERS: InitialTableCount - Size of InitialTableArray, in number of 59259698Sdim * ACPI_TABLE_DESC structures 60259698Sdim * 61259698Sdim * RETURN: Status 62259698Sdim * 63259698Sdim * DESCRIPTION: Allocate a root table array. Used by iASL compiler and 64259698Sdim * AcpiInitializeTables. 65259698Sdim * 66259698Sdim ******************************************************************************/ 67259698Sdim 68259698SdimACPI_STATUS 69259698SdimAcpiAllocateRootTable ( 70259698Sdim UINT32 InitialTableCount) 71259698Sdim{ 72259698Sdim 73259698Sdim AcpiGbl_RootTableList.MaxTableCount = InitialTableCount; 74259698Sdim AcpiGbl_RootTableList.Flags = ACPI_ROOT_ALLOW_RESIZE; 75259698Sdim 76259698Sdim return (AcpiTbResizeRootTableList ()); 77259698Sdim} 78259698Sdim 79259698Sdim 80259698Sdim/******************************************************************************* 81259698Sdim * 82259698Sdim * FUNCTION: AcpiInitializeTables 83259698Sdim * 84259698Sdim * PARAMETERS: InitialTableArray - Pointer to an array of pre-allocated 85259698Sdim * ACPI_TABLE_DESC structures. If NULL, the 86259698Sdim * array is dynamically allocated. 87259698Sdim * InitialTableCount - Size of InitialTableArray, in number of 88259698Sdim * ACPI_TABLE_DESC structures 89259698Sdim * AllowResize - Flag to tell Table Manager if resize of 90259698Sdim * pre-allocated array is allowed. Ignored 91259698Sdim * if InitialTableArray is NULL. 92259698Sdim * 93259698Sdim * RETURN: Status 94259698Sdim * 95259698Sdim * DESCRIPTION: Initialize the table manager, get the RSDP and RSDT/XSDT. 96259698Sdim * 97259698Sdim * NOTE: Allows static allocation of the initial table array in order 98259698Sdim * to avoid the use of dynamic memory in confined environments 99259698Sdim * such as the kernel boot sequence where it may not be available. 100259698Sdim * 101259698Sdim * If the host OS memory managers are initialized, use NULL for 102259698Sdim * InitialTableArray, and the table will be dynamically allocated. 103259698Sdim * 104259698Sdim ******************************************************************************/ 105259698Sdim 106259698SdimACPI_STATUS 107259698SdimAcpiInitializeTables ( 108259698Sdim ACPI_TABLE_DESC *InitialTableArray, 109259698Sdim UINT32 InitialTableCount, 110259698Sdim BOOLEAN AllowResize) 111259698Sdim{ 112259698Sdim ACPI_PHYSICAL_ADDRESS RsdpAddress; 113259698Sdim ACPI_STATUS Status; 114259698Sdim 115259698Sdim 116259698Sdim ACPI_FUNCTION_TRACE (AcpiInitializeTables); 117259698Sdim 118259698Sdim 119259698Sdim /* 120259698Sdim * Setup the Root Table Array and allocate the table array 121259698Sdim * if requested 122259698Sdim */ 123259698Sdim if (!InitialTableArray) 124259698Sdim { 125259698Sdim Status = AcpiAllocateRootTable (InitialTableCount); 126259698Sdim if (ACPI_FAILURE (Status)) 127259698Sdim { 128259698Sdim return_ACPI_STATUS (Status); 129259698Sdim } 130259698Sdim } 131259698Sdim else 132259698Sdim { 133259698Sdim /* Root Table Array has been statically allocated by the host */ 134259698Sdim 135259698Sdim ACPI_MEMSET (InitialTableArray, 0, 136259698Sdim (ACPI_SIZE) InitialTableCount * sizeof (ACPI_TABLE_DESC)); 137259698Sdim 138259698Sdim AcpiGbl_RootTableList.Tables = InitialTableArray; 139259698Sdim AcpiGbl_RootTableList.MaxTableCount = InitialTableCount; 140259698Sdim AcpiGbl_RootTableList.Flags = ACPI_ROOT_ORIGIN_UNKNOWN; 141259698Sdim if (AllowResize) 142259698Sdim { 143259698Sdim AcpiGbl_RootTableList.Flags |= ACPI_ROOT_ALLOW_RESIZE; 144259698Sdim } 145259698Sdim } 146259698Sdim 147259698Sdim /* Get the address of the RSDP */ 148259698Sdim 149259698Sdim RsdpAddress = AcpiOsGetRootPointer (); 150259698Sdim if (!RsdpAddress) 151259698Sdim { 152259698Sdim return_ACPI_STATUS (AE_NOT_FOUND); 153259698Sdim } 154259698Sdim 155259698Sdim /* 156259698Sdim * Get the root table (RSDT or XSDT) and extract all entries to the local 157259698Sdim * Root Table Array. This array contains the information of the RSDT/XSDT 158259698Sdim * in a common, more useable format. 159259698Sdim */ 160259698Sdim Status = AcpiTbParseRootTable (RsdpAddress); 161259698Sdim return_ACPI_STATUS (Status); 162259698Sdim} 163259698Sdim 164259698SdimACPI_EXPORT_SYMBOL (AcpiInitializeTables) 165259698Sdim 166259698Sdim 167259698Sdim/******************************************************************************* 168259698Sdim * 169259698Sdim * FUNCTION: AcpiReallocateRootTable 170259698Sdim * 171259698Sdim * PARAMETERS: None 172259698Sdim * 173259698Sdim * RETURN: Status 174259698Sdim * 175259698Sdim * DESCRIPTION: Reallocate Root Table List into dynamic memory. Copies the 176259698Sdim * root list from the previously provided scratch area. Should 177259698Sdim * be called once dynamic memory allocation is available in the 178259698Sdim * kernel. 179259698Sdim * 180259698Sdim ******************************************************************************/ 181259698Sdim 182259698SdimACPI_STATUS 183259698SdimAcpiReallocateRootTable ( 184259698Sdim void) 185259698Sdim{ 186259698Sdim ACPI_STATUS Status; 187259698Sdim 188259698Sdim 189259698Sdim ACPI_FUNCTION_TRACE (AcpiReallocateRootTable); 190259698Sdim 191259698Sdim 192259698Sdim /* 193259698Sdim * Only reallocate the root table if the host provided a static buffer 194259698Sdim * for the table array in the call to AcpiInitializeTables. 195259698Sdim */ 196259698Sdim if (AcpiGbl_RootTableList.Flags & ACPI_ROOT_ORIGIN_ALLOCATED) 197259698Sdim { 198259698Sdim return_ACPI_STATUS (AE_SUPPORT); 199259698Sdim } 200259698Sdim 201259698Sdim AcpiGbl_RootTableList.Flags |= ACPI_ROOT_ALLOW_RESIZE; 202259698Sdim 203259698Sdim Status = AcpiTbResizeRootTableList (); 204259698Sdim return_ACPI_STATUS (Status); 205259698Sdim} 206259698Sdim 207259698SdimACPI_EXPORT_SYMBOL (AcpiReallocateRootTable) 208259698Sdim 209259698Sdim 210259698Sdim/******************************************************************************* 211259698Sdim * 212259698Sdim * FUNCTION: AcpiGetTableHeader 213259698Sdim * 214259698Sdim * PARAMETERS: Signature - ACPI signature of needed table 215259698Sdim * Instance - Which instance (for SSDTs) 216259698Sdim * OutTableHeader - The pointer to the table header to fill 217259698Sdim * 218259698Sdim * RETURN: Status and pointer to mapped table header 219259698Sdim * 220259698Sdim * DESCRIPTION: Finds an ACPI table header. 221259698Sdim * 222259698Sdim * NOTE: Caller is responsible in unmapping the header with 223259698Sdim * AcpiOsUnmapMemory 224259698Sdim * 225259698Sdim ******************************************************************************/ 226259698Sdim 227259698SdimACPI_STATUS 228259698SdimAcpiGetTableHeader ( 229259698Sdim char *Signature, 230259698Sdim UINT32 Instance, 231259698Sdim ACPI_TABLE_HEADER *OutTableHeader) 232259698Sdim{ 233259698Sdim UINT32 i; 234259698Sdim UINT32 j; 235259698Sdim ACPI_TABLE_HEADER *Header; 236259698Sdim 237259698Sdim 238259698Sdim /* Parameter validation */ 239259698Sdim 240259698Sdim if (!Signature || !OutTableHeader) 241259698Sdim { 242259698Sdim return (AE_BAD_PARAMETER); 243259698Sdim } 244259698Sdim 245259698Sdim /* Walk the root table list */ 246259698Sdim 247259698Sdim for (i = 0, j = 0; i < AcpiGbl_RootTableList.CurrentTableCount; i++) 248259698Sdim { 249259698Sdim if (!ACPI_COMPARE_NAME (&(AcpiGbl_RootTableList.Tables[i].Signature), 250259698Sdim Signature)) 251259698Sdim { 252259698Sdim continue; 253259698Sdim } 254259698Sdim 255259698Sdim if (++j < Instance) 256259698Sdim { 257259698Sdim continue; 258259698Sdim } 259259698Sdim 260259698Sdim if (!AcpiGbl_RootTableList.Tables[i].Pointer) 261259698Sdim { 262259698Sdim if ((AcpiGbl_RootTableList.Tables[i].Flags & 263259698Sdim ACPI_TABLE_ORIGIN_MASK) == 264259698Sdim ACPI_TABLE_ORIGIN_MAPPED) 265259698Sdim { 266259698Sdim Header = AcpiOsMapMemory ( 267259698Sdim AcpiGbl_RootTableList.Tables[i].Address, 268259698Sdim sizeof (ACPI_TABLE_HEADER)); 269259698Sdim if (!Header) 270259698Sdim { 271259698Sdim return (AE_NO_MEMORY); 272259698Sdim } 273259698Sdim 274259698Sdim ACPI_MEMCPY (OutTableHeader, Header, 275259698Sdim sizeof (ACPI_TABLE_HEADER)); 276259698Sdim AcpiOsUnmapMemory (Header, sizeof (ACPI_TABLE_HEADER)); 277259698Sdim } 278259698Sdim else 279259698Sdim { 280259698Sdim return (AE_NOT_FOUND); 281259698Sdim } 282259698Sdim } 283 else 284 { 285 ACPI_MEMCPY (OutTableHeader, 286 AcpiGbl_RootTableList.Tables[i].Pointer, 287 sizeof (ACPI_TABLE_HEADER)); 288 } 289 290 return (AE_OK); 291 } 292 293 return (AE_NOT_FOUND); 294} 295 296ACPI_EXPORT_SYMBOL (AcpiGetTableHeader) 297 298 299/******************************************************************************* 300 * 301 * FUNCTION: AcpiGetTable 302 * 303 * PARAMETERS: Signature - ACPI signature of needed table 304 * Instance - Which instance (for SSDTs) 305 * OutTable - Where the pointer to the table is returned 306 * 307 * RETURN: Status and pointer to the requested table 308 * 309 * DESCRIPTION: Finds and verifies an ACPI table. Table must be in the 310 * RSDT/XSDT. 311 * 312 ******************************************************************************/ 313 314ACPI_STATUS 315AcpiGetTable ( 316 char *Signature, 317 UINT32 Instance, 318 ACPI_TABLE_HEADER **OutTable) 319{ 320 UINT32 i; 321 UINT32 j; 322 ACPI_STATUS Status; 323 324 325 /* Parameter validation */ 326 327 if (!Signature || !OutTable) 328 { 329 return (AE_BAD_PARAMETER); 330 } 331 332 /* Walk the root table list */ 333 334 for (i = 0, j = 0; i < AcpiGbl_RootTableList.CurrentTableCount; i++) 335 { 336 if (!ACPI_COMPARE_NAME (&(AcpiGbl_RootTableList.Tables[i].Signature), 337 Signature)) 338 { 339 continue; 340 } 341 342 if (++j < Instance) 343 { 344 continue; 345 } 346 347 Status = AcpiTbVerifyTable (&AcpiGbl_RootTableList.Tables[i]); 348 if (ACPI_SUCCESS (Status)) 349 { 350 *OutTable = AcpiGbl_RootTableList.Tables[i].Pointer; 351 } 352 353 return (Status); 354 } 355 356 return (AE_NOT_FOUND); 357} 358 359ACPI_EXPORT_SYMBOL (AcpiGetTable) 360 361 362/******************************************************************************* 363 * 364 * FUNCTION: AcpiGetTableByIndex 365 * 366 * PARAMETERS: TableIndex - Table index 367 * Table - Where the pointer to the table is returned 368 * 369 * RETURN: Status and pointer to the requested table 370 * 371 * DESCRIPTION: Obtain a table by an index into the global table list. Used 372 * internally also. 373 * 374 ******************************************************************************/ 375 376ACPI_STATUS 377AcpiGetTableByIndex ( 378 UINT32 TableIndex, 379 ACPI_TABLE_HEADER **Table) 380{ 381 ACPI_STATUS Status; 382 383 384 ACPI_FUNCTION_TRACE (AcpiGetTableByIndex); 385 386 387 /* Parameter validation */ 388 389 if (!Table) 390 { 391 return_ACPI_STATUS (AE_BAD_PARAMETER); 392 } 393 394 (void) AcpiUtAcquireMutex (ACPI_MTX_TABLES); 395 396 /* Validate index */ 397 398 if (TableIndex >= AcpiGbl_RootTableList.CurrentTableCount) 399 { 400 (void) AcpiUtReleaseMutex (ACPI_MTX_TABLES); 401 return_ACPI_STATUS (AE_BAD_PARAMETER); 402 } 403 404 if (!AcpiGbl_RootTableList.Tables[TableIndex].Pointer) 405 { 406 /* Table is not mapped, map it */ 407 408 Status = AcpiTbVerifyTable (&AcpiGbl_RootTableList.Tables[TableIndex]); 409 if (ACPI_FAILURE (Status)) 410 { 411 (void) AcpiUtReleaseMutex (ACPI_MTX_TABLES); 412 return_ACPI_STATUS (Status); 413 } 414 } 415 416 *Table = AcpiGbl_RootTableList.Tables[TableIndex].Pointer; 417 (void) AcpiUtReleaseMutex (ACPI_MTX_TABLES); 418 return_ACPI_STATUS (AE_OK); 419} 420 421ACPI_EXPORT_SYMBOL (AcpiGetTableByIndex) 422 423 424/******************************************************************************* 425 * 426 * FUNCTION: AcpiInstallTableHandler 427 * 428 * PARAMETERS: Handler - Table event handler 429 * Context - Value passed to the handler on each event 430 * 431 * RETURN: Status 432 * 433 * DESCRIPTION: Install a global table event handler. 434 * 435 ******************************************************************************/ 436 437ACPI_STATUS 438AcpiInstallTableHandler ( 439 ACPI_TABLE_HANDLER Handler, 440 void *Context) 441{ 442 ACPI_STATUS Status; 443 444 445 ACPI_FUNCTION_TRACE (AcpiInstallTableHandler); 446 447 448 if (!Handler) 449 { 450 return_ACPI_STATUS (AE_BAD_PARAMETER); 451 } 452 453 Status = AcpiUtAcquireMutex (ACPI_MTX_EVENTS); 454 if (ACPI_FAILURE (Status)) 455 { 456 return_ACPI_STATUS (Status); 457 } 458 459 /* Don't allow more than one handler */ 460 461 if (AcpiGbl_TableHandler) 462 { 463 Status = AE_ALREADY_EXISTS; 464 goto Cleanup; 465 } 466 467 /* Install the handler */ 468 469 AcpiGbl_TableHandler = Handler; 470 AcpiGbl_TableHandlerContext = Context; 471 472Cleanup: 473 (void) AcpiUtReleaseMutex (ACPI_MTX_EVENTS); 474 return_ACPI_STATUS (Status); 475} 476 477ACPI_EXPORT_SYMBOL (AcpiInstallTableHandler) 478 479 480/******************************************************************************* 481 * 482 * FUNCTION: AcpiRemoveTableHandler 483 * 484 * PARAMETERS: Handler - Table event handler that was installed 485 * previously. 486 * 487 * RETURN: Status 488 * 489 * DESCRIPTION: Remove a table event handler 490 * 491 ******************************************************************************/ 492 493ACPI_STATUS 494AcpiRemoveTableHandler ( 495 ACPI_TABLE_HANDLER Handler) 496{ 497 ACPI_STATUS Status; 498 499 500 ACPI_FUNCTION_TRACE (AcpiRemoveTableHandler); 501 502 503 Status = AcpiUtAcquireMutex (ACPI_MTX_EVENTS); 504 if (ACPI_FAILURE (Status)) 505 { 506 return_ACPI_STATUS (Status); 507 } 508 509 /* Make sure that the installed handler is the same */ 510 511 if (!Handler || 512 Handler != AcpiGbl_TableHandler) 513 { 514 Status = AE_BAD_PARAMETER; 515 goto Cleanup; 516 } 517 518 /* Remove the handler */ 519 520 AcpiGbl_TableHandler = NULL; 521 522Cleanup: 523 (void) AcpiUtReleaseMutex (ACPI_MTX_EVENTS); 524 return_ACPI_STATUS (Status); 525} 526 527ACPI_EXPORT_SYMBOL (AcpiRemoveTableHandler) 528