drivers/acpi/tables/tbrsdt.c

   1 /******************************************************************************
   2  *
   3  * Module Name: tbrsdt - ACPI RSDT table utilities
   4  *
   5  *****************************************************************************/
   6
   7 /*
   8  * Copyright (C) 2000 - 2006, R. Byron Moore
   9  * All rights reserved.
  10  *
  11  * Redistribution and use in source and binary forms, with or without
  12  * modification, are permitted provided that the following conditions
  13  * are met:
  14  * 1. Redistributions of source code must retain the above copyright
  15  *    notice, this list of conditions, and the following disclaimer,
  16  *    without modification.
  17  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
  18  *    substantially similar to the "NO WARRANTY" disclaimer below
  19  *    ("Disclaimer") and any redistribution must be conditioned upon
  20  *    including a substantially similar Disclaimer requirement for further
  21  *    binary redistribution.
  22  * 3. Neither the names of the above-listed copyright holders nor the names
  23  *    of any contributors may be used to endorse or promote products derived
  24  *    from this software without specific prior written permission.
  25  *
  26  * Alternatively, this software may be distributed under the terms of the
  27  * GNU General Public License ("GPL") version 2 as published by the Free
  28  * Software Foundation.
  29  *
  30  * NO WARRANTY
  31  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  32  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  33  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
  34  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  35  * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  36  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  37  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  38  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  39  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
  40  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  41  * POSSIBILITY OF SUCH DAMAGES.
  42  */
  43
  44 #include <acpi/acpi.h>
  45 #include <acpi/actables.h>
  46
  47 #define _COMPONENT          ACPI_TABLES
  48 ACPI_MODULE_NAME("tbrsdt")
  49
  50 /*******************************************************************************
  51  *
  52  * FUNCTION:    acpi_tb_verify_rsdp
  53  *
  54  * PARAMETERS:  Address         - RSDP (Pointer to RSDT)
  55  *
  56  * RETURN:      Status
  57  *
  58  * DESCRIPTION: Load and validate the RSDP (ptr) and RSDT (table)
  59  *
  60  ******************************************************************************/
  61 acpi_status acpi_tb_verify_rsdp(struct acpi_pointer *address)
  62 {
  63         struct acpi_table_desc table_info;
  64         acpi_status status;
  65         struct rsdp_descriptor *rsdp;
  66
  67         ACPI_FUNCTION_TRACE(tb_verify_rsdp);
  68
  69         switch (address->pointer_type) {
  70         case ACPI_LOGICAL_POINTER:
  71
  72                 rsdp = address->pointer.logical;
  73                 break;
  74
  75         case ACPI_PHYSICAL_POINTER:
  76                 /*
  77                  * Obtain access to the RSDP structure
  78                  */
  79                 status = acpi_os_map_memory(address->pointer.physical,
  80                                             sizeof(struct rsdp_descriptor),
  81                                             (void *)&rsdp);
  82                 if (ACPI_FAILURE(status)) {
  83                         return_ACPI_STATUS(status);
  84                 }
  85                 break;
  86
  87         default:
  88                 return_ACPI_STATUS(AE_BAD_PARAMETER);
  89         }
  90
  91         /* Verify RSDP signature and checksum */
  92
  93         status = acpi_tb_validate_rsdp(rsdp);
  94         if (ACPI_FAILURE(status)) {
  95                 goto cleanup;
  96         }
  97
  98         /* The RSDP supplied is OK */
  99
 100         table_info.pointer = ACPI_CAST_PTR(struct acpi_table_header, rsdp);
 101         table_info.length = sizeof(struct rsdp_descriptor);
 102         table_info.allocation = ACPI_MEM_MAPPED;
 103
 104         /* Save the table pointers and allocation info */
 105
 106         status = acpi_tb_init_table_descriptor(ACPI_TABLE_ID_RSDP, &table_info);
 107         if (ACPI_FAILURE(status)) {
 108                 goto cleanup;
 109         }
 110
 111         /* Save the RSDP in a global for easy access */
 112
 113         acpi_gbl_RSDP =
 114             ACPI_CAST_PTR(struct rsdp_descriptor, table_info.pointer);
 115         return_ACPI_STATUS(status);
 116
 117         /* Error exit */
 118       cleanup:
 119
 120         if (acpi_gbl_table_flags & ACPI_PHYSICAL_POINTER) {
 121                 acpi_os_unmap_memory(rsdp, sizeof(struct rsdp_descriptor));
 122         }
 123         return_ACPI_STATUS(status);
 124 }
 125
 126 /*******************************************************************************
 127  *
 128  * FUNCTION:    acpi_tb_get_rsdt_address
 129  *
 130  * PARAMETERS:  out_address         - Where the address is returned
 131  *
 132  * RETURN:      None, Address
 133  *
 134  * DESCRIPTION: Extract the address of either the RSDT or XSDT, depending on the
 135  *              version of the RSDP and whether the XSDT pointer is valid
 136  *
 137  ******************************************************************************/
 138
 139 void acpi_tb_get_rsdt_address(struct acpi_pointer *out_address)
 140 {
 141
 142         ACPI_FUNCTION_ENTRY();
 143
 144         out_address->pointer_type =
 145             acpi_gbl_table_flags | ACPI_LOGICAL_ADDRESSING;
 146
 147         /* Use XSDT if it is present */
 148
 149         if ((acpi_gbl_RSDP->revision >= 2) &&
 150             acpi_gbl_RSDP->xsdt_physical_address) {
 151                 out_address->pointer.value =
 152                     acpi_gbl_RSDP->xsdt_physical_address;
 153                 acpi_gbl_root_table_type = ACPI_TABLE_TYPE_XSDT;
 154         } else {
 155                 /* No XSDT, use the RSDT */
 156
 157                 out_address->pointer.value =
 158                     acpi_gbl_RSDP->rsdt_physical_address;
 159                 acpi_gbl_root_table_type = ACPI_TABLE_TYPE_RSDT;
 160         }
 161 }
 162
 163 /*******************************************************************************
 164  *
 165  * FUNCTION:    acpi_tb_validate_rsdt
 166  *
 167  * PARAMETERS:  table_ptr       - Addressable pointer to the RSDT.
 168  *
 169  * RETURN:      Status
 170  *
 171  * DESCRIPTION: Validate signature for the RSDT or XSDT
 172  *
 173  ******************************************************************************/
 174
 175 acpi_status acpi_tb_validate_rsdt(struct acpi_table_header *table_ptr)
 176 {
 177         char *signature;
 178
 179         ACPI_FUNCTION_ENTRY();
 180
 181         /* Search for appropriate signature, RSDT or XSDT */
 182
 183         if (acpi_gbl_root_table_type == ACPI_TABLE_TYPE_RSDT) {
 184                 signature = RSDT_SIG;
 185         } else {
 186                 signature = XSDT_SIG;
 187         }
 188
 189         if (!ACPI_COMPARE_NAME(table_ptr->signature, signature)) {
 190
 191                 /* Invalid RSDT or XSDT signature */
 192
 193                 ACPI_ERROR((AE_INFO,
 194                             "Invalid signature where RSDP indicates RSDT/XSDT should be located. RSDP:"));
 195
 196                 ACPI_DUMP_BUFFER(acpi_gbl_RSDP, 20);
 197
 198                 ACPI_ERROR((AE_INFO,
 199                             "RSDT/XSDT signature at %X (%p) is invalid",
 200                             acpi_gbl_RSDP->rsdt_physical_address,
 201                             (void *)(acpi_native_uint) acpi_gbl_RSDP->
 202                             rsdt_physical_address));
 203
 204                 if (acpi_gbl_root_table_type == ACPI_TABLE_TYPE_RSDT) {
 205                         ACPI_ERROR((AE_INFO, "Looking for RSDT"));
 206                 } else {
 207                         ACPI_ERROR((AE_INFO, "Looking for XSDT"));
 208                 }
 209
 210                 ACPI_DUMP_BUFFER((char *)table_ptr, 48);
 211                 return (AE_BAD_SIGNATURE);
 212         }
 213
 214         return (AE_OK);
 215 }
 216
 217 /*******************************************************************************
 218  *
 219  * FUNCTION:    acpi_tb_get_table_rsdt
 220  *
 221  * PARAMETERS:  None
 222  *
 223  * RETURN:      Status
 224  *
 225  * DESCRIPTION: Load and validate the RSDP (ptr) and RSDT (table)
 226  *
 227  ******************************************************************************/
 228
 229 acpi_status acpi_tb_get_table_rsdt(void)
 230 {
 231         struct acpi_table_desc table_info;
 232         acpi_status status;
 233         struct acpi_pointer address;
 234
 235         ACPI_FUNCTION_TRACE(tb_get_table_rsdt);
 236
 237         /* Get the RSDT/XSDT via the RSDP */
 238
 239         acpi_tb_get_rsdt_address(&address);
 240
 241         table_info.type = ACPI_TABLE_ID_XSDT;
 242         status = acpi_tb_get_table(&address, &table_info);
 243         if (ACPI_FAILURE(status)) {
 244                 ACPI_EXCEPTION((AE_INFO, status,
 245                                 "Could not get the RSDT/XSDT"));
 246                 return_ACPI_STATUS(status);
 247         }
 248
 249         ACPI_DEBUG_PRINT((ACPI_DB_INFO,
 250                           "RSDP located at %p, points to RSDT physical=%8.8X%8.8X\n",
 251                           acpi_gbl_RSDP,
 252                           ACPI_FORMAT_UINT64(address.pointer.value)));
 253
 254         /* Check the RSDT or XSDT signature */
 255
 256         status = acpi_tb_validate_rsdt(table_info.pointer);
 257         if (ACPI_FAILURE(status)) {
 258                 return_ACPI_STATUS(status);
 259         }
 260
 261         /* Get the number of tables defined in the RSDT or XSDT */
 262
 263         acpi_gbl_rsdt_table_count = acpi_tb_get_table_count(acpi_gbl_RSDP,
 264                                                             table_info.pointer);
 265
 266         /* Convert and/or copy to an XSDT structure */
 267
 268         status = acpi_tb_convert_to_xsdt(&table_info);
 269         if (ACPI_FAILURE(status)) {
 270                 return_ACPI_STATUS(status);
 271         }
 272
 273         /* Save the table pointers and allocation info */
 274
 275         status = acpi_tb_init_table_descriptor(ACPI_TABLE_ID_XSDT, &table_info);
 276         if (ACPI_FAILURE(status)) {
 277                 return_ACPI_STATUS(status);
 278         }
 279
 280         acpi_gbl_XSDT =
 281             ACPI_CAST_PTR(struct xsdt_descriptor, table_info.pointer);
 282
 283         ACPI_DEBUG_PRINT((ACPI_DB_INFO, "XSDT located at %p\n", acpi_gbl_XSDT));
 284         return_ACPI_STATUS(status);
 285 }