drivers/acpi/executer/excreate.c

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