drivers/acpi/executer/excreate.c

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