drivers/acpi/acpica/excreate.c

   1 /******************************************************************************
   2  *
   3  * Module Name: excreate - Named object creation
   4  *
   5  *****************************************************************************/
   6
   7 /*
   8  * Copyright (C) 2000 - 2012, Intel Corp.
   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 "accommon.h"
  46 #include "acinterp.h"
  47 #include "amlcode.h"
  48 #include "acnamesp.h"
  49
  50 #define _COMPONENT          ACPI_EXECUTER
  51 ACPI_MODULE_NAME("excreate")
  52 #ifndef ACPI_NO_METHOD_EXECUTION
  53 /*******************************************************************************
  54  *
  55  * FUNCTION:    acpi_ex_create_alias
  56  *
  57  * PARAMETERS:  walk_state           - Current state, contains operands
  58  *
  59  * RETURN:      Status
  60  *
  61  * DESCRIPTION: Create a new named alias
  62  *
  63  ******************************************************************************/
  64 acpi_status acpi_ex_create_alias(struct acpi_walk_state *walk_state)
  65 {
  66         struct acpi_namespace_node *target_node;
  67         struct acpi_namespace_node *alias_node;
  68         acpi_status status = AE_OK;
  69
  70         ACPI_FUNCTION_TRACE(ex_create_alias);
  71
  72         /* Get the source/alias operands (both namespace nodes) */
  73
  74         alias_node = (struct acpi_namespace_node *)walk_state->operands[0];
  75         target_node = (struct acpi_namespace_node *)walk_state->operands[1];
  76
  77         if ((target_node->type == ACPI_TYPE_LOCAL_ALIAS) ||
  78             (target_node->type == ACPI_TYPE_LOCAL_METHOD_ALIAS)) {
  79                 /*
  80                  * Dereference an existing alias so that we don't create a chain
  81                  * of aliases. With this code, we guarantee that an alias is
  82                  * always exactly one level of indirection away from the
  83                  * actual aliased name.
  84                  */
  85                 target_node =
  86                     ACPI_CAST_PTR(struct acpi_namespace_node,
  87                                   target_node->object);
  88         }
  89
  90         /*
  91          * For objects that can never change (i.e., the NS node will
  92          * permanently point to the same object), we can simply attach
  93          * the object to the new NS node. For other objects (such as
  94          * Integers, buffers, etc.), we have to point the Alias node
  95          * to the original Node.
  96          */
  97         switch (target_node->type) {
  98
  99                 /* For these types, the sub-object can change dynamically via a Store */
 100
 101         case ACPI_TYPE_INTEGER:
 102         case ACPI_TYPE_STRING:
 103         case ACPI_TYPE_BUFFER:
 104         case ACPI_TYPE_PACKAGE:
 105         case ACPI_TYPE_BUFFER_FIELD:
 106
 107                 /*
 108                  * These types open a new scope, so we need the NS node in order to access
 109                  * any children.
 110                  */
 111         case ACPI_TYPE_DEVICE:
 112         case ACPI_TYPE_POWER:
 113         case ACPI_TYPE_PROCESSOR:
 114         case ACPI_TYPE_THERMAL:
 115         case ACPI_TYPE_LOCAL_SCOPE:
 116
 117                 /*
 118                  * The new alias has the type ALIAS and points to the original
 119                  * NS node, not the object itself.
 120                  */
 121                 alias_node->type = ACPI_TYPE_LOCAL_ALIAS;
 122                 alias_node->object =
 123                     ACPI_CAST_PTR(union acpi_operand_object, target_node);
 124                 break;
 125
 126         case ACPI_TYPE_METHOD:
 127
 128                 /*
 129                  * Control method aliases need to be differentiated
 130                  */
 131                 alias_node->type = ACPI_TYPE_LOCAL_METHOD_ALIAS;
 132                 alias_node->object =
 133                     ACPI_CAST_PTR(union acpi_operand_object, target_node);
 134                 break;
 135
 136         default:
 137
 138                 /* Attach the original source object to the new Alias Node */
 139
 140                 /*
 141                  * The new alias assumes the type of the target, and it points
 142                  * to the same object. The reference count of the object has an
 143                  * additional reference to prevent deletion out from under either the
 144                  * target node or the alias Node
 145                  */
 146                 status = acpi_ns_attach_object(alias_node,
 147                                                acpi_ns_get_attached_object
 148                                                (target_node),
 149                                                target_node->type);
 150                 break;
 151         }
 152
 153         /* Since both operands are Nodes, we don't need to delete them */
 154
 155         return_ACPI_STATUS(status);
 156 }
 157
 158 /*******************************************************************************
 159  *
 160  * FUNCTION:    acpi_ex_create_event
 161  *
 162  * PARAMETERS:  walk_state          - Current state
 163  *
 164  * RETURN:      Status
 165  *
 166  * DESCRIPTION: Create a new event object
 167  *
 168  ******************************************************************************/
 169
 170 acpi_status acpi_ex_create_event(struct acpi_walk_state *walk_state)
 171 {
 172         acpi_status status;
 173         union acpi_operand_object *obj_desc;
 174
 175         ACPI_FUNCTION_TRACE(ex_create_event);
 176
 177         obj_desc = acpi_ut_create_internal_object(ACPI_TYPE_EVENT);
 178         if (!obj_desc) {
 179                 status = AE_NO_MEMORY;
 180                 goto cleanup;
 181         }
 182
 183         /*
 184          * Create the actual OS semaphore, with zero initial units -- meaning
 185          * that the event is created in an unsignalled state
 186          */
 187         status = acpi_os_create_semaphore(ACPI_NO_UNIT_LIMIT, 0,
 188                                           &obj_desc->event.os_semaphore);
 189         if (ACPI_FAILURE(status)) {
 190                 goto cleanup;
 191         }
 192
 193         /* Attach object to the Node */
 194
 195         status =
 196             acpi_ns_attach_object((struct acpi_namespace_node *)walk_state->
 197                                   operands[0], obj_desc, ACPI_TYPE_EVENT);
 198
 199       cleanup:
 200         /*
 201          * Remove local reference to the object (on error, will cause deletion
 202          * of both object and semaphore if present.)
 203          */
 204         acpi_ut_remove_reference(obj_desc);
 205         return_ACPI_STATUS(status);
 206 }
 207
 208 /*******************************************************************************
 209  *
 210  * FUNCTION:    acpi_ex_create_mutex
 211  *
 212  * PARAMETERS:  walk_state          - Current state
 213  *
 214  * RETURN:      Status
 215  *
 216  * DESCRIPTION: Create a new mutex object
 217  *
 218  *              Mutex (Name[0], sync_level[1])
 219  *
 220  ******************************************************************************/
 221
 222 acpi_status acpi_ex_create_mutex(struct acpi_walk_state *walk_state)
 223 {
 224         acpi_status status = AE_OK;
 225         union acpi_operand_object *obj_desc;
 226
 227         ACPI_FUNCTION_TRACE_PTR(ex_create_mutex, ACPI_WALK_OPERANDS);
 228
 229         /* Create the new mutex object */
 230
 231         obj_desc = acpi_ut_create_internal_object(ACPI_TYPE_MUTEX);
 232         if (!obj_desc) {
 233                 status = AE_NO_MEMORY;
 234                 goto cleanup;
 235         }
 236
 237         /* Create the actual OS Mutex */
 238
 239         status = acpi_os_create_mutex(&obj_desc->mutex.os_mutex);
 240         if (ACPI_FAILURE(status)) {
 241                 goto cleanup;
 242         }
 243
 244         /* Init object and attach to NS node */
 245
 246         obj_desc->mutex.sync_level = (u8)walk_state->operands[1]->integer.value;
 247         obj_desc->mutex.node =
 248             (struct acpi_namespace_node *)walk_state->operands[0];
 249
 250         status =
 251             acpi_ns_attach_object(obj_desc->mutex.node, obj_desc,
 252                                   ACPI_TYPE_MUTEX);
 253
 254       cleanup:
 255         /*
 256          * Remove local reference to the object (on error, will cause deletion
 257          * of both object and semaphore if present.)
 258          */
 259         acpi_ut_remove_reference(obj_desc);
 260         return_ACPI_STATUS(status);
 261 }
 262
 263 /*******************************************************************************
 264  *
 265  * FUNCTION:    acpi_ex_create_region
 266  *
 267  * PARAMETERS:  aml_start           - Pointer to the region declaration AML
 268  *              aml_length          - Max length of the declaration AML
 269  *              space_id            - Address space ID for the region
 270  *              walk_state          - Current state
 271  *
 272  * RETURN:      Status
 273  *
 274  * DESCRIPTION: Create a new operation region object
 275  *
 276  ******************************************************************************/
 277
 278 acpi_status
 279 acpi_ex_create_region(u8 * aml_start,
 280                       u32 aml_length,
 281                       u8 space_id, struct acpi_walk_state *walk_state)
 282 {
 283         acpi_status status;
 284         union acpi_operand_object *obj_desc;
 285         struct acpi_namespace_node *node;
 286         union acpi_operand_object *region_obj2;
 287
 288         ACPI_FUNCTION_TRACE(ex_create_region);
 289
 290         /* Get the Namespace Node */
 291
 292         node = walk_state->op->common.node;
 293
 294         /*
 295          * If the region object is already attached to this node,
 296          * just return
 297          */
 298         if (acpi_ns_get_attached_object(node)) {
 299                 return_ACPI_STATUS(AE_OK);
 300         }
 301
 302         /*
 303          * Space ID must be one of the predefined IDs, or in the user-defined
 304          * range
 305          */
 306         if (!acpi_is_valid_space_id(space_id)) {
 307                 /*
 308                  * Print an error message, but continue. We don't want to abort
 309                  * a table load for this exception. Instead, if the region is
 310                  * actually used at runtime, abort the executing method.
 311                  */
 312                 ACPI_ERROR((AE_INFO,
 313                             "Invalid/unknown Address Space ID: 0x%2.2X",
 314                             space_id));
 315         }
 316
 317         ACPI_DEBUG_PRINT((ACPI_DB_LOAD, "Region Type - %s (0x%X)\n",
 318                           acpi_ut_get_region_name(space_id), space_id));
 319
 320         /* Create the region descriptor */
 321
 322         obj_desc = acpi_ut_create_internal_object(ACPI_TYPE_REGION);
 323         if (!obj_desc) {
 324                 status = AE_NO_MEMORY;
 325                 goto cleanup;
 326         }
 327
 328         /*
 329          * Remember location in AML stream of address & length
 330          * operands since they need to be evaluated at run time.
 331          */
 332         region_obj2 = obj_desc->common.next_object;
 333         region_obj2->extra.aml_start = aml_start;
 334         region_obj2->extra.aml_length = aml_length;
 335         if (walk_state->scope_info) {
 336                 region_obj2->extra.scope_node =
 337                     walk_state->scope_info->scope.node;
 338         } else {
 339                 region_obj2->extra.scope_node = node;
 340         }
 341
 342         /* Init the region from the operands */
 343
 344         obj_desc->region.space_id = space_id;
 345         obj_desc->region.address = 0;
 346         obj_desc->region.length = 0;
 347         obj_desc->region.node = node;
 348
 349         /* Install the new region object in the parent Node */
 350
 351         status = acpi_ns_attach_object(node, obj_desc, ACPI_TYPE_REGION);
 352
 353       cleanup:
 354
 355         /* Remove local reference to the object */
 356
 357         acpi_ut_remove_reference(obj_desc);
 358         return_ACPI_STATUS(status);
 359 }
 360
 361 /*******************************************************************************
 362  *
 363  * FUNCTION:    acpi_ex_create_processor
 364  *
 365  * PARAMETERS:  walk_state          - Current state
 366  *
 367  * RETURN:      Status
 368  *
 369  * DESCRIPTION: Create a new processor object and populate the fields
 370  *
 371  *              Processor (Name[0], cpu_ID[1], pblock_addr[2], pblock_length[3])
 372  *
 373  ******************************************************************************/
 374
 375 acpi_status acpi_ex_create_processor(struct acpi_walk_state *walk_state)
 376 {
 377         union acpi_operand_object **operand = &walk_state->operands[0];
 378         union acpi_operand_object *obj_desc;
 379         acpi_status status;
 380
 381         ACPI_FUNCTION_TRACE_PTR(ex_create_processor, walk_state);
 382
 383         /* Create the processor object */
 384
 385         obj_desc = acpi_ut_create_internal_object(ACPI_TYPE_PROCESSOR);
 386         if (!obj_desc) {
 387                 return_ACPI_STATUS(AE_NO_MEMORY);
 388         }
 389
 390         /* Initialize the processor object from the operands */
 391
 392         obj_desc->processor.proc_id = (u8) operand[1]->integer.value;
 393         obj_desc->processor.length = (u8) operand[3]->integer.value;
 394         obj_desc->processor.address =
 395             (acpi_io_address) operand[2]->integer.value;
 396
 397         /* Install the processor object in the parent Node */
 398
 399         status = acpi_ns_attach_object((struct acpi_namespace_node *)operand[0],
 400                                        obj_desc, ACPI_TYPE_PROCESSOR);
 401
 402         /* Remove local reference to the object */
 403
 404         acpi_ut_remove_reference(obj_desc);
 405         return_ACPI_STATUS(status);
 406 }
 407
 408 /*******************************************************************************
 409  *
 410  * FUNCTION:    acpi_ex_create_power_resource
 411  *
 412  * PARAMETERS:  walk_state          - Current state
 413  *
 414  * RETURN:      Status
 415  *
 416  * DESCRIPTION: Create a new power_resource object and populate the fields
 417  *
 418  *              power_resource (Name[0], system_level[1], resource_order[2])
 419  *
 420  ******************************************************************************/
 421
 422 acpi_status acpi_ex_create_power_resource(struct acpi_walk_state *walk_state)
 423 {
 424         union acpi_operand_object **operand = &walk_state->operands[0];
 425         acpi_status status;
 426         union acpi_operand_object *obj_desc;
 427
 428         ACPI_FUNCTION_TRACE_PTR(ex_create_power_resource, walk_state);
 429
 430         /* Create the power resource object */
 431
 432         obj_desc = acpi_ut_create_internal_object(ACPI_TYPE_POWER);
 433         if (!obj_desc) {
 434                 return_ACPI_STATUS(AE_NO_MEMORY);
 435         }
 436
 437         /* Initialize the power object from the operands */
 438
 439         obj_desc->power_resource.system_level = (u8) operand[1]->integer.value;
 440         obj_desc->power_resource.resource_order =
 441             (u16) operand[2]->integer.value;
 442
 443         /* Install the  power resource object in the parent Node */
 444
 445         status = acpi_ns_attach_object((struct acpi_namespace_node *)operand[0],
 446                                        obj_desc, ACPI_TYPE_POWER);
 447
 448         /* Remove local reference to the object */
 449
 450         acpi_ut_remove_reference(obj_desc);
 451         return_ACPI_STATUS(status);
 452 }
 453 #endif
 454
 455 /*******************************************************************************
 456  *
 457  * FUNCTION:    acpi_ex_create_method
 458  *
 459  * PARAMETERS:  aml_start       - First byte of the method's AML
 460  *              aml_length      - AML byte count for this method
 461  *              walk_state      - Current state
 462  *
 463  * RETURN:      Status
 464  *
 465  * DESCRIPTION: Create a new method object
 466  *
 467  ******************************************************************************/
 468
 469 acpi_status
 470 acpi_ex_create_method(u8 * aml_start,
 471                       u32 aml_length, struct acpi_walk_state *walk_state)
 472 {
 473         union acpi_operand_object **operand = &walk_state->operands[0];
 474         union acpi_operand_object *obj_desc;
 475         acpi_status status;
 476         u8 method_flags;
 477
 478         ACPI_FUNCTION_TRACE_PTR(ex_create_method, walk_state);
 479
 480         /* Create a new method object */
 481
 482         obj_desc = acpi_ut_create_internal_object(ACPI_TYPE_METHOD);
 483         if (!obj_desc) {
 484                 status = AE_NO_MEMORY;
 485                 goto exit;
 486         }
 487
 488         /* Save the method's AML pointer and length  */
 489
 490         obj_desc->method.aml_start = aml_start;
 491         obj_desc->method.aml_length = aml_length;
 492
 493         /*
 494          * Disassemble the method flags. Split off the arg_count, Serialized
 495          * flag, and sync_level for efficiency.
 496          */
 497         method_flags = (u8) operand[1]->integer.value;
 498
 499         obj_desc->method.param_count =
 500             (u8) (method_flags & AML_METHOD_ARG_COUNT);
 501
 502         /*
 503          * Get the sync_level. If method is serialized, a mutex will be
 504          * created for this method when it is parsed.
 505          */
 506         if (method_flags & AML_METHOD_SERIALIZED) {
 507                 obj_desc->method.info_flags = ACPI_METHOD_SERIALIZED;
 508
 509                 /*
 510                  * ACPI 1.0: sync_level = 0
 511                  * ACPI 2.0: sync_level = sync_level in method declaration
 512                  */
 513                 obj_desc->method.sync_level = (u8)
 514                     ((method_flags & AML_METHOD_SYNC_LEVEL) >> 4);
 515         }
 516
 517         /* Attach the new object to the method Node */
 518
 519         status = acpi_ns_attach_object((struct acpi_namespace_node *)operand[0],
 520                                        obj_desc, ACPI_TYPE_METHOD);
 521
 522         /* Remove local reference to the object */
 523
 524         acpi_ut_remove_reference(obj_desc);
 525
 526       exit:
 527         /* Remove a reference to the operand */
 528
 529         acpi_ut_remove_reference(operand[1]);
 530         return_ACPI_STATUS(status);
 531 }