1 /****************************************************************************** 2 * 3 * Module Name: excreate - Named object creation 4 * 5 *****************************************************************************/ 6 7 /* 8 * Copyright (C) 2000 - 2017, 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 /* Ensure that the target node is valid */ 91 if (!target_node) { 92 return_ACPI_STATUS(AE_NULL_OBJECT); 93 } 94 95 /* 96 * For objects that can never change (i.e., the NS node will 97 * permanently point to the same object), we can simply attach 98 * the object to the new NS node. For other objects (such as 99 * Integers, buffers, etc.), we have to point the Alias node 100 * to the original Node. 101 */ 102 switch (target_node->type) { 103 104 /* For these types, the sub-object can change dynamically via a Store */ 105 106 case ACPI_TYPE_INTEGER: 107 case ACPI_TYPE_STRING: 108 case ACPI_TYPE_BUFFER: 109 case ACPI_TYPE_PACKAGE: 110 case ACPI_TYPE_BUFFER_FIELD: 111 /* 112 * These types open a new scope, so we need the NS node in order to access 113 * any children. 114 */ 115 case ACPI_TYPE_DEVICE: 116 case ACPI_TYPE_POWER: 117 case ACPI_TYPE_PROCESSOR: 118 case ACPI_TYPE_THERMAL: 119 case ACPI_TYPE_LOCAL_SCOPE: 120 /* 121 * The new alias has the type ALIAS and points to the original 122 * NS node, not the object itself. 123 */ 124 alias_node->type = ACPI_TYPE_LOCAL_ALIAS; 125 alias_node->object = 126 ACPI_CAST_PTR(union acpi_operand_object, target_node); 127 break; 128 129 case ACPI_TYPE_METHOD: 130 /* 131 * Control method aliases need to be differentiated 132 */ 133 alias_node->type = ACPI_TYPE_LOCAL_METHOD_ALIAS; 134 alias_node->object = 135 ACPI_CAST_PTR(union acpi_operand_object, target_node); 136 break; 137 138 default: 139 140 /* Attach the original source object to the new Alias Node */ 141 142 /* 143 * The new alias assumes the type of the target, and it points 144 * to the same object. The reference count of the object has an 145 * additional reference to prevent deletion out from under either the 146 * target node or the alias Node 147 */ 148 status = acpi_ns_attach_object(alias_node, 149 acpi_ns_get_attached_object 150 (target_node), 151 target_node->type); 152 break; 153 } 154 155 /* Since both operands are Nodes, we don't need to delete them */ 156 157 return_ACPI_STATUS(status); 158 } 159 160 /******************************************************************************* 161 * 162 * FUNCTION: acpi_ex_create_event 163 * 164 * PARAMETERS: walk_state - Current state 165 * 166 * RETURN: Status 167 * 168 * DESCRIPTION: Create a new event object 169 * 170 ******************************************************************************/ 171 172 acpi_status acpi_ex_create_event(struct acpi_walk_state *walk_state) 173 { 174 acpi_status status; 175 union acpi_operand_object *obj_desc; 176 177 ACPI_FUNCTION_TRACE(ex_create_event); 178 179 obj_desc = acpi_ut_create_internal_object(ACPI_TYPE_EVENT); 180 if (!obj_desc) { 181 status = AE_NO_MEMORY; 182 goto cleanup; 183 } 184 185 /* 186 * Create the actual OS semaphore, with zero initial units -- meaning 187 * that the event is created in an unsignalled state 188 */ 189 status = acpi_os_create_semaphore(ACPI_NO_UNIT_LIMIT, 0, 190 &obj_desc->event.os_semaphore); 191 if (ACPI_FAILURE(status)) { 192 goto cleanup; 193 } 194 195 /* Attach object to the Node */ 196 197 status = acpi_ns_attach_object((struct acpi_namespace_node *) 198 walk_state->operands[0], obj_desc, 199 ACPI_TYPE_EVENT); 200 201 cleanup: 202 /* 203 * Remove local reference to the object (on error, will cause deletion 204 * of both object and semaphore if present.) 205 */ 206 acpi_ut_remove_reference(obj_desc); 207 return_ACPI_STATUS(status); 208 } 209 210 /******************************************************************************* 211 * 212 * FUNCTION: acpi_ex_create_mutex 213 * 214 * PARAMETERS: walk_state - Current state 215 * 216 * RETURN: Status 217 * 218 * DESCRIPTION: Create a new mutex object 219 * 220 * Mutex (Name[0], sync_level[1]) 221 * 222 ******************************************************************************/ 223 224 acpi_status acpi_ex_create_mutex(struct acpi_walk_state *walk_state) 225 { 226 acpi_status status = AE_OK; 227 union acpi_operand_object *obj_desc; 228 229 ACPI_FUNCTION_TRACE_PTR(ex_create_mutex, ACPI_WALK_OPERANDS); 230 231 /* Create the new mutex object */ 232 233 obj_desc = acpi_ut_create_internal_object(ACPI_TYPE_MUTEX); 234 if (!obj_desc) { 235 status = AE_NO_MEMORY; 236 goto cleanup; 237 } 238 239 /* Create the actual OS Mutex */ 240 241 status = acpi_os_create_mutex(&obj_desc->mutex.os_mutex); 242 if (ACPI_FAILURE(status)) { 243 goto cleanup; 244 } 245 246 /* Init object and attach to NS node */ 247 248 obj_desc->mutex.sync_level = (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 * space_id - Address 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 space_id, 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 (!acpi_is_valid_space_id(space_id)) { 309 /* 310 * Print an error message, but continue. We don't want to abort 311 * a table load for this exception. Instead, if the region is 312 * actually used at runtime, abort the executing method. 313 */ 314 ACPI_ERROR((AE_INFO, 315 "Invalid/unknown Address Space ID: 0x%2.2X", 316 space_id)); 317 } 318 319 ACPI_DEBUG_PRINT((ACPI_DB_LOAD, "Region Type - %s (0x%X)\n", 320 acpi_ut_get_region_name(space_id), space_id)); 321 322 /* Create the region descriptor */ 323 324 obj_desc = acpi_ut_create_internal_object(ACPI_TYPE_REGION); 325 if (!obj_desc) { 326 status = AE_NO_MEMORY; 327 goto cleanup; 328 } 329 330 /* 331 * Remember location in AML stream of address & length 332 * operands since they need to be evaluated at run time. 333 */ 334 region_obj2 = acpi_ns_get_secondary_object(obj_desc); 335 region_obj2->extra.aml_start = aml_start; 336 region_obj2->extra.aml_length = aml_length; 337 region_obj2->extra.method_REG = NULL; 338 if (walk_state->scope_info) { 339 region_obj2->extra.scope_node = 340 walk_state->scope_info->scope.node; 341 } else { 342 region_obj2->extra.scope_node = node; 343 } 344 345 /* Init the region from the operands */ 346 347 obj_desc->region.space_id = space_id; 348 obj_desc->region.address = 0; 349 obj_desc->region.length = 0; 350 obj_desc->region.node = node; 351 obj_desc->region.handler = NULL; 352 obj_desc->common.flags &= 353 ~(AOPOBJ_SETUP_COMPLETE | AOPOBJ_REG_CONNECTED | 354 AOPOBJ_OBJECT_INITIALIZED); 355 356 /* Install the new region object in the parent Node */ 357 358 status = acpi_ns_attach_object(node, obj_desc, ACPI_TYPE_REGION); 359 360 cleanup: 361 362 /* Remove local reference to the object */ 363 364 acpi_ut_remove_reference(obj_desc); 365 return_ACPI_STATUS(status); 366 } 367 368 /******************************************************************************* 369 * 370 * FUNCTION: acpi_ex_create_processor 371 * 372 * PARAMETERS: walk_state - Current state 373 * 374 * RETURN: Status 375 * 376 * DESCRIPTION: Create a new processor object and populate the fields 377 * 378 * Processor (Name[0], cpu_ID[1], pblock_addr[2], pblock_length[3]) 379 * 380 ******************************************************************************/ 381 382 acpi_status acpi_ex_create_processor(struct acpi_walk_state *walk_state) 383 { 384 union acpi_operand_object **operand = &walk_state->operands[0]; 385 union acpi_operand_object *obj_desc; 386 acpi_status status; 387 388 ACPI_FUNCTION_TRACE_PTR(ex_create_processor, walk_state); 389 390 /* Create the processor object */ 391 392 obj_desc = acpi_ut_create_internal_object(ACPI_TYPE_PROCESSOR); 393 if (!obj_desc) { 394 return_ACPI_STATUS(AE_NO_MEMORY); 395 } 396 397 /* Initialize the processor object from the operands */ 398 399 obj_desc->processor.proc_id = (u8) operand[1]->integer.value; 400 obj_desc->processor.length = (u8) operand[3]->integer.value; 401 obj_desc->processor.address = 402 (acpi_io_address)operand[2]->integer.value; 403 404 /* Install the processor object in the parent Node */ 405 406 status = acpi_ns_attach_object((struct acpi_namespace_node *)operand[0], 407 obj_desc, ACPI_TYPE_PROCESSOR); 408 409 /* Remove local reference to the object */ 410 411 acpi_ut_remove_reference(obj_desc); 412 return_ACPI_STATUS(status); 413 } 414 415 /******************************************************************************* 416 * 417 * FUNCTION: acpi_ex_create_power_resource 418 * 419 * PARAMETERS: walk_state - Current state 420 * 421 * RETURN: Status 422 * 423 * DESCRIPTION: Create a new power_resource object and populate the fields 424 * 425 * power_resource (Name[0], system_level[1], resource_order[2]) 426 * 427 ******************************************************************************/ 428 429 acpi_status acpi_ex_create_power_resource(struct acpi_walk_state *walk_state) 430 { 431 union acpi_operand_object **operand = &walk_state->operands[0]; 432 acpi_status status; 433 union acpi_operand_object *obj_desc; 434 435 ACPI_FUNCTION_TRACE_PTR(ex_create_power_resource, walk_state); 436 437 /* Create the power resource object */ 438 439 obj_desc = acpi_ut_create_internal_object(ACPI_TYPE_POWER); 440 if (!obj_desc) { 441 return_ACPI_STATUS(AE_NO_MEMORY); 442 } 443 444 /* Initialize the power object from the operands */ 445 446 obj_desc->power_resource.system_level = (u8) operand[1]->integer.value; 447 obj_desc->power_resource.resource_order = 448 (u16) operand[2]->integer.value; 449 450 /* Install the power resource object in the parent Node */ 451 452 status = acpi_ns_attach_object((struct acpi_namespace_node *)operand[0], 453 obj_desc, ACPI_TYPE_POWER); 454 455 /* Remove local reference to the object */ 456 457 acpi_ut_remove_reference(obj_desc); 458 return_ACPI_STATUS(status); 459 } 460 #endif 461 462 /******************************************************************************* 463 * 464 * FUNCTION: acpi_ex_create_method 465 * 466 * PARAMETERS: aml_start - First byte of the method's AML 467 * aml_length - AML byte count for this method 468 * walk_state - Current state 469 * 470 * RETURN: Status 471 * 472 * DESCRIPTION: Create a new method object 473 * 474 ******************************************************************************/ 475 476 acpi_status 477 acpi_ex_create_method(u8 * aml_start, 478 u32 aml_length, struct acpi_walk_state *walk_state) 479 { 480 union acpi_operand_object **operand = &walk_state->operands[0]; 481 union acpi_operand_object *obj_desc; 482 acpi_status status; 483 u8 method_flags; 484 485 ACPI_FUNCTION_TRACE_PTR(ex_create_method, walk_state); 486 487 /* Create a new method object */ 488 489 obj_desc = acpi_ut_create_internal_object(ACPI_TYPE_METHOD); 490 if (!obj_desc) { 491 status = AE_NO_MEMORY; 492 goto exit; 493 } 494 495 /* Save the method's AML pointer and length */ 496 497 obj_desc->method.aml_start = aml_start; 498 obj_desc->method.aml_length = aml_length; 499 obj_desc->method.node = operand[0]; 500 501 /* 502 * Disassemble the method flags. Split off the arg_count, Serialized 503 * flag, and sync_level for efficiency. 504 */ 505 method_flags = (u8)operand[1]->integer.value; 506 obj_desc->method.param_count = (u8) 507 (method_flags & AML_METHOD_ARG_COUNT); 508 509 /* 510 * Get the sync_level. If method is serialized, a mutex will be 511 * created for this method when it is parsed. 512 */ 513 if (method_flags & AML_METHOD_SERIALIZED) { 514 obj_desc->method.info_flags = ACPI_METHOD_SERIALIZED; 515 516 /* 517 * ACPI 1.0: sync_level = 0 518 * ACPI 2.0: sync_level = sync_level in method declaration 519 */ 520 obj_desc->method.sync_level = (u8) 521 ((method_flags & AML_METHOD_SYNC_LEVEL) >> 4); 522 } 523 524 /* Attach the new object to the method Node */ 525 526 status = acpi_ns_attach_object((struct acpi_namespace_node *)operand[0], 527 obj_desc, ACPI_TYPE_METHOD); 528 529 /* Remove local reference to the object */ 530 531 acpi_ut_remove_reference(obj_desc); 532 533 exit: 534 /* Remove a reference to the operand */ 535 536 acpi_ut_remove_reference(operand[1]); 537 return_ACPI_STATUS(status); 538 } 539