drivers/acpi/tables/tbutils.c

   1 /******************************************************************************
   2  *
   3  * Module Name: tbutils - Table manipulation utilities
   4  *
   5  *****************************************************************************/
   6
   7 /*
   8  * Copyright (C) 2000 - 2005, 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("tbutils")
  49
  50 /* Local prototypes */
  51 #ifdef ACPI_OBSOLETE_FUNCTIONS
  52 acpi_status
  53 acpi_tb_handle_to_object(u16 table_id, struct acpi_table_desc **table_desc);
  54 #endif
  55
  56 /*******************************************************************************
  57  *
  58  * FUNCTION:    acpi_tb_is_table_installed
  59  *
  60  * PARAMETERS:  new_table_desc      - Descriptor for new table being installed
  61  *
  62  * RETURN:      Status - AE_ALREADY_EXISTS if the table is already installed
  63  *
  64  * DESCRIPTION: Determine if an ACPI table is already installed
  65  *
  66  * MUTEX:       Table data structures should be locked
  67  *
  68  ******************************************************************************/
  69
  70 acpi_status acpi_tb_is_table_installed(struct acpi_table_desc *new_table_desc)
  71 {
  72         struct acpi_table_desc *table_desc;
  73
  74         ACPI_FUNCTION_TRACE("tb_is_table_installed");
  75
  76         /* Get the list descriptor and first table descriptor */
  77
  78         table_desc = acpi_gbl_table_lists[new_table_desc->type].next;
  79
  80         /* Examine all installed tables of this type */
  81
  82         while (table_desc) {
  83                 /*
  84                  * If the table lengths match, perform a full bytewise compare. This
  85                  * means that we will allow tables with duplicate oem_table_id(s), as
  86                  * long as the tables are different in some way.
  87                  *
  88                  * Checking if the table has been loaded into the namespace means that
  89                  * we don't check for duplicate tables during the initial installation
  90                  * of tables within the RSDT/XSDT.
  91                  */
  92                 if ((table_desc->loaded_into_namespace) &&
  93                     (table_desc->pointer->length ==
  94                      new_table_desc->pointer->length)
  95                     &&
  96                     (!ACPI_MEMCMP
  97                      (table_desc->pointer, new_table_desc->pointer,
  98                       new_table_desc->pointer->length))) {
  99                         /* Match: this table is already installed */
 100
 101                         ACPI_DEBUG_PRINT((ACPI_DB_TABLES,
 102                                           "Table [%4.4s] already installed: Rev %X oem_table_id [%8.8s]\n",
 103                                           new_table_desc->pointer->signature,
 104                                           new_table_desc->pointer->revision,
 105                                           new_table_desc->pointer->
 106                                           oem_table_id));
 107
 108                         new_table_desc->owner_id = table_desc->owner_id;
 109                         new_table_desc->installed_desc = table_desc;
 110
 111                         return_ACPI_STATUS(AE_ALREADY_EXISTS);
 112                 }
 113
 114                 /* Get next table on the list */
 115
 116                 table_desc = table_desc->next;
 117         }
 118
 119         return_ACPI_STATUS(AE_OK);
 120 }
 121
 122 /*******************************************************************************
 123  *
 124  * FUNCTION:    acpi_tb_validate_table_header
 125  *
 126  * PARAMETERS:  table_header        - Logical pointer to the table
 127  *
 128  * RETURN:      Status
 129  *
 130  * DESCRIPTION: Check an ACPI table header for validity
 131  *
 132  * NOTE:  Table pointers are validated as follows:
 133  *          1) Table pointer must point to valid physical memory
 134  *          2) Signature must be 4 ASCII chars, even if we don't recognize the
 135  *             name
 136  *          3) Table must be readable for length specified in the header
 137  *          4) Table checksum must be valid (with the exception of the FACS
 138  *              which has no checksum because it contains variable fields)
 139  *
 140  ******************************************************************************/
 141
 142 acpi_status
 143 acpi_tb_validate_table_header(struct acpi_table_header *table_header)
 144 {
 145         acpi_name signature;
 146
 147         ACPI_FUNCTION_NAME("tb_validate_table_header");
 148
 149         /* Verify that this is a valid address */
 150
 151         if (!acpi_os_readable(table_header, sizeof(struct acpi_table_header))) {
 152                 ACPI_DEBUG_PRINT((ACPI_DB_ERROR,
 153                                   "Cannot read table header at %p\n",
 154                                   table_header));
 155
 156                 return (AE_BAD_ADDRESS);
 157         }
 158
 159         /* Ensure that the signature is 4 ASCII characters */
 160
 161         ACPI_MOVE_32_TO_32(&signature, table_header->signature);
 162         if (!acpi_ut_valid_acpi_name(signature)) {
 163                 ACPI_DEBUG_PRINT((ACPI_DB_ERROR,
 164                                   "Table signature at %p [%p] has invalid characters\n",
 165                                   table_header, &signature));
 166
 167                 ACPI_REPORT_WARNING(("Invalid table signature found: [%4.4s]\n",
 168                                      (char *)&signature));
 169
 170                 ACPI_DUMP_BUFFER(table_header,
 171                                  sizeof(struct acpi_table_header));
 172                 return (AE_BAD_SIGNATURE);
 173         }
 174
 175         /* Validate the table length */
 176
 177         if (table_header->length < sizeof(struct acpi_table_header)) {
 178                 ACPI_DEBUG_PRINT((ACPI_DB_ERROR,
 179                                   "Invalid length in table header %p name %4.4s\n",
 180                                   table_header, (char *)&signature));
 181
 182                 ACPI_REPORT_WARNING(("Invalid table header length (0x%X) found\n", (u32) table_header->length));
 183
 184                 ACPI_DUMP_BUFFER(table_header,
 185                                  sizeof(struct acpi_table_header));
 186                 return (AE_BAD_HEADER);
 187         }
 188
 189         return (AE_OK);
 190 }
 191
 192 /*******************************************************************************
 193  *
 194  * FUNCTION:    acpi_tb_verify_table_checksum
 195  *
 196  * PARAMETERS:  *table_header           - ACPI table to verify
 197  *
 198  * RETURN:      8 bit checksum of table
 199  *
 200  * DESCRIPTION: Does an 8 bit checksum of table and returns status.  A correct
 201  *              table should have a checksum of 0.
 202  *
 203  ******************************************************************************/
 204
 205 acpi_status
 206 acpi_tb_verify_table_checksum(struct acpi_table_header * table_header)
 207 {
 208         u8 checksum;
 209         acpi_status status = AE_OK;
 210
 211         ACPI_FUNCTION_TRACE("tb_verify_table_checksum");
 212
 213         /* Compute the checksum on the table */
 214
 215         checksum =
 216             acpi_tb_generate_checksum(table_header, table_header->length);
 217
 218         /* Return the appropriate exception */
 219
 220         if (checksum) {
 221                 ACPI_REPORT_WARNING(("Invalid checksum in table [%4.4s] (%02X, sum %02X is not zero)\n", table_header->signature, (u32) table_header->checksum, (u32) checksum));
 222
 223                 status = AE_BAD_CHECKSUM;
 224         }
 225         return_ACPI_STATUS(status);
 226 }
 227
 228 /*******************************************************************************
 229  *
 230  * FUNCTION:    acpi_tb_generate_checksum
 231  *
 232  * PARAMETERS:  Buffer              - Buffer to checksum
 233  *              Length              - Size of the buffer
 234  *
 235  * RETURN:      8 bit checksum of buffer
 236  *
 237  * DESCRIPTION: Computes an 8 bit checksum of the buffer(length) and returns it.
 238  *
 239  ******************************************************************************/
 240
 241 u8 acpi_tb_generate_checksum(void *buffer, u32 length)
 242 {
 243         u8 *end_buffer;
 244         u8 *rover;
 245         u8 sum = 0;
 246
 247         if (buffer && length) {
 248                 /*  Buffer and Length are valid   */
 249
 250                 end_buffer = ACPI_ADD_PTR(u8, buffer, length);
 251
 252                 for (rover = buffer; rover < end_buffer; rover++) {
 253                         sum = (u8) (sum + *rover);
 254                 }
 255         }
 256         return (sum);
 257 }
 258
 259 #ifdef ACPI_OBSOLETE_FUNCTIONS
 260 /*******************************************************************************
 261  *
 262  * FUNCTION:    acpi_tb_handle_to_object
 263  *
 264  * PARAMETERS:  table_id            - Id for which the function is searching
 265  *              table_desc          - Pointer to return the matching table
 266  *                                      descriptor.
 267  *
 268  * RETURN:      Search the tables to find one with a matching table_id and
 269  *              return a pointer to that table descriptor.
 270  *
 271  ******************************************************************************/
 272
 273 acpi_status
 274 acpi_tb_handle_to_object(u16 table_id,
 275                          struct acpi_table_desc ** return_table_desc)
 276 {
 277         u32 i;
 278         struct acpi_table_desc *table_desc;
 279
 280         ACPI_FUNCTION_NAME("tb_handle_to_object");
 281
 282         for (i = 0; i < ACPI_TABLE_MAX; i++) {
 283                 table_desc = acpi_gbl_table_lists[i].next;
 284                 while (table_desc) {
 285                         if (table_desc->table_id == table_id) {
 286                                 *return_table_desc = table_desc;
 287                                 return (AE_OK);
 288                         }
 289
 290                         table_desc = table_desc->next;
 291                 }
 292         }
 293
 294         ACPI_DEBUG_PRINT((ACPI_DB_ERROR, "table_id=%X does not exist\n",
 295                           table_id));
 296         return (AE_BAD_PARAMETER);
 297 }
 298 #endif